Documentation

使用范围：Native

Static Methods

class cordova-plugin-x-socialsharing (cordova-plugin-x-socialsharing)

社交分享插件

Constructor Top

Static Methods Top

void	available (Function callback)
void	canShareVia (String via, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)
void	canShareViaEmail (Function successCallback, Function errorCallback)
void	iPadPopupCoordinates ()
void	saveToPhotoAlbum (Array fileOrFileArray, Function successCallback, Function errorCallback)
void	setIPadPopupCoordinates (String coords)
void	share (String message, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)
void	shareVia (String via, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)
void	shareViaEmail (String message, String subject, Array toArray, Array ccArray, Array bccArray, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)
void	shareViaFacebook (String message, String fileOrFileArray, String url, Function successCallback, Function errorCallback)
void	shareViaFacebookWithPasteMessageHint (String message, String fileOrFileArray, String url, String pasteMessageHint, Function successCallback, Function errorCallback)
void	shareViaSMS (String options, String phonenumbers, Function successCallback, Function errorCallback)
void	shareViaTwitter (String message, String file, String url, Function successCallback, Function errorCallback)
void	shareViaWhatsApp (String message, String fileOrFileArray, String url, Function successCallback, Function errorCallback)

Constructor details Top

public cordova-plugin-x-socialsharing ()

社交分享插件

Static Methods Detail Top

static public void available (Function callback)

检查插件是否支持IOS5

Parameters

Function

callback

,回调函数，回调函数给出参数isAvailable，取值范围"true"，"false"，在IOS6一下，只返回false

Return Value

void

static public void canShareVia (String via, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

判断分享是否有效

Parameters

String	via 应用程序的包名或类名
String	subject 主题
Array	fileOrFileArray 文件数组
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数分享成功的回调，在IOS回调返回boolean值
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void canShareViaEmail (Function successCallback, Function errorCallback)

检查email客户端的配置

Parameters

Function	successCallback 请求成功的返回
Function	errorCallback 请求失败的回调

Return Value

void

static public void iPadPopupCoordinates ()

重写此方法用于在ipad中指定弹出箭头出现的位置

Return Value

void

static public void saveToPhotoAlbum (Array fileOrFileArray, Function successCallback, Function errorCallback)

保存图片到相册

Parameters

Array	fileOrFileArray 文件数组
Function	successCallback 保存成功的回调
Function	errorCallback 保存失败的回调

Return Value

void

static public void setIPadPopupCoordinates (String coords)

在wkwebview polyfill的ipadpopupcoordinates不生效的时候调用的替代方法。分享前的弹出位置

Parameters

String

coords

位置参数，参数结构："-1,-1,-1,-1"// left,top,width,height

Return Value

void

String	message 文本信息，允许超链接，缺省为null
String	subject 主题，在WP8中用于电子邮件主题或标题，缺省为null
Array	fileOrFileArray 分享资源，支持路径:www文件路径：www/manual.pdf，网络路径：https://ima.ge/img.gif，本地路径：file:///Users/.../img.gif，缺省为null
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数分享成功的回调，在IOS回调返回boolean值
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void shareVia (String via, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

启动应用程序

Parameters

String	via 应用程序的包名或类名
String	subject 主题
Array	fileOrFileArray 文件数组
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数执行成功的回调
Function	errorCallback 可选参数执行失败的回调

Return Value

void

static public void shareViaEmail (String message, String subject, Array toArray, Array ccArray, Array bccArray, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

Email分享

Parameters

String	message 文本信息，允许超链接，缺省为null
String	subject 主题，在WP8中用于电子邮件主题或标题，缺省为null
Array	toArray TO字段的邮箱地址数组
Array	ccArray CC字段的邮箱地址数组
Array	bccArray BCC字段的邮箱地址数组
Array	fileOrFileArray 文件
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数分享成功的回调，在IOS回调返回boolean值
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void shareViaFacebook (String message, String fileOrFileArray, String url, Function successCallback, Function errorCallback)

Facebook分享

Parameters

String	message 文本信息，允许超链接，缺省为null
String	fileOrFileArray 文件，缺省为null
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数分享成功的回调
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void shareViaFacebookWithPasteMessageHint (String message, String fileOrFileArray, String url, String pasteMessageHint, Function successCallback, Function errorCallback)

Facebook分享，带粘贴信息提示，适用于4.3.4之后的版本

Parameters

String	message 文本信息，允许超链接，缺省为null
String	fileOrFileArray 文件，缺省为null
String	url url链接，自己定义，缺省为null
String	pasteMessageHint 粘贴信息提示
Function	successCallback 可选参数分享成功的回调
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void shareViaSMS (String options, String phonenumbers, Function successCallback, Function errorCallback)

SMS分享

Parameters

String	options 选项参数结构如下
String	phonenumbers 分享的手机号，多个手机号用，分隔
Function	successCallback 可选参数分享成功的回调
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void shareViaTwitter (String message, String file, String url, Function successCallback, Function errorCallback)

Twitter分享

Parameters

String	message 文本信息，允许超链接，缺省为null
String	file 文件，缺省为null
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数分享成功的回调
Function	errorCallback 可选参数分享失败的回调

Return Value

void

static public void shareViaWhatsApp (String message, String fileOrFileArray, String url, Function successCallback, Function errorCallback)

WhatsApp分享

Parameters

String	message 文本信息，允许超链接，缺省为null
String	fileOrFileArray 文件，缺省为null
String	url url链接，自己定义，缺省为null
Function	successCallback 可选参数分享成功的回调
Function	errorCallback 可选参数分享失败的回调

Return Value

void

Contents

Constructor Top

Static Methods Top

Constructor details Top

public cordova-plugin-x-socialsharing ()

Static Methods Detail Top

static public void available (Function callback)

Parameters

Return Value

static public void canShareVia (String via, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void canShareViaEmail (Function successCallback, Function errorCallback)

Parameters

Return Value

static public void iPadPopupCoordinates ()

Return Value

static public void saveToPhotoAlbum (Array fileOrFileArray, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void setIPadPopupCoordinates (String coords)

Parameters

Return Value

static public void share (String message, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareVia (String via, String subject, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareViaEmail (String message, String subject, Array toArray, Array ccArray, Array bccArray, Array fileOrFileArray, String url, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareViaFacebook (String message, String fileOrFileArray, String url, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareViaFacebookWithPasteMessageHint (String message, String fileOrFileArray, String url, String pasteMessageHint, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareViaSMS (String options, String phonenumbers, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareViaTwitter (String message, String file, String url, Function successCallback, Function errorCallback)

Parameters

Return Value

static public void shareViaWhatsApp (String message, String fileOrFileArray, String url, Function successCallback, Function errorCallback)

Parameters

Return Value