JShare

Method

概述

JShare简介

极光 Share 致力于帮助应用快速具备国内外主流社交平台分享和第三方登录功能，提供新浪微博、QQ、微信、Facebook、twitter 等第三方社会化服务；SDK 包体积小，集成成本低，提供 iOS 和 Android 的 SDK ，并且还提供了统计功能，方便开发者了解应用的分享效果，提高产品推广效率，助力产品获得更多用户。

能与特性：

1.集成简单只需几分钟即可集成 JShare 组件，让您的应用轻松拥有强大的社会化功能。 2.稳定，安装包小不依赖第三方平台的库包，极大的减少 SDK 的体积。 3.社会化统计分析完整的统计和分析后台，帮助开发者了解各项统计指标。 4.一键分享通过组件对新浪微博、QQ、微信、Facebook 等社会化平台一键分享；分享内容包括文字、图片、链接、音视频、文件、表情等。 5.第三方登录使用 QQ、新浪微博、微信、Facebook 等社交平台账号登录APP更快捷。

JShare 插件概述

极光 Share 技术上不依赖原生 SDK 的方式，分享的原理实际上就是两个 APP 之间的相互跳转和通信，使用极光 Share 代替平台 SDK 实现分享。个别平台如新浪微博在不存在目标 app 的情况下则会进入网页分享。

JShare SDK 分享遵循以下步骤：

1.注册 Appkey。 2.配置分享参数。 3.发起分享。 4.等待回调。

插件使用攻略

集成流程：在 Web 控制台上创建应用，得到 Appkey。如果之前已经使用了 JPush，可以直接延用老的 Appkey。接下来去第三方平台申请账号，详情参考极光文档。常见问题

iOS 平台配置

配置白名单：在iOS上需要配置 config.xml 文件，配置方法参考配置可被检测的URL Scheme。配置内容参考极光分享中的配置 ApplicationQueriesSchemes。注意用到哪个就配置哪个，无用的可以不配置。
配置ATS（App Transport Security）：目前 JSHARE 支持不存在新浪微博客户端情况下的网页分享，但是由于新浪微博的 api 尚未针对 https 做优化所以需要针对新浪的做对应的 https 设置。在 JSHARE 中是默认关闭新浪微博的网页端分享的，如需使用这个功能则需要在 JSHARELaunchConfig 类的实例中将 isSupportWebSina 属性设置为 YES。以iOS10 SDK 编译的工程会默认以 SSL 安全协议进行网络传输，即 HTTPS，如果依然使用 HTTP 协议请求网络会报系统异常并中断请求。配置方法参考 iOS 修改 Info.plist 之配置 ATS 。配置内容参考极光分享中的 HPPTS 设置。
配置 entitlements 文件设置 universal link 功能。目前只支持微信平台使用 universal link 分享。APICloud 平台上的开发者，可通过此文件告诉编译服务器开通 Associated Domain 功能。配置方法参考论坛帖子。配置示例如下：
```
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
        <key>com.apple.developer.associated-domains</key>
        <array>
            <string>applinks:bjtest.apicloud.com</string>
        </array>
    </dict>
    </plist>
```
其中 com.apple.developer.associated-domains 对应的值applinks:bjtest.apicloud.com 是配置的你的应用的 Universal Links。详情参考苹果文档。创建苹果证书时需开通 Associated Domains。登录苹果开发者账号，在左侧列表里找到 Identifiers，选中后再找到你的 Bundle ID （包名），选中该包名，配置开启其 Associated Domains 功能。服务器端支持苹果 Universal Links。支持方法参考论坛帖子。最后在微信开放平台创建移动应用，并配置好Universal link，注意sdk配置的 Universal link需要和微信开发平台配置的 Universal link一致。确认App的Universal Links配置成功,参考微信校验指引验证 universal link 配置成功。
配置 config.xml 文件。从第三方平台申请的相关 key 和 secret 等参数需要配置在本文件中。配置完毕，需通过云端编译生效，配置方法如下：

名称：JShare
参数：urlScheme、apiKey、apiSecret
配置示例:

  <feature name="JShare">
    <param name="urlScheme" value="wxd0d84bbf23b4a0e4"/>
    <param name="urlScheme" value="tencent1105864531"/>
    <param name="appKey" value="wxd0d84bbf23b4a0e4"/>
    <param name="WeChatAppId" value="a354f72aa1b4c2b8eaad137ac81434cd"/>
    <param name="universalLink" value="https://bjtest.apicloud.com"/>
  </feature>

字段描述: urlScheme：（必须配置）用于实现 App 间跳转及数据交换，本应用可以启动第三方客户端，也可以从第三方客户端跳回本应用。urlScheme 的 value 值是从第三方平台获取的。各个平台的 urlScheme 说明：

平台	格式	举例
微信	微信 appKey	wxa2ea563906227379
QQ	“tencent” + appID	tencent1105864531
新浪微博	“wb”+ appKey	wb727232518
Facebook	“fb”+FacebookAppID	fb1847959632183996
Twitter	“twitterkit-”+TwitterConsumerKey	twitterkit-4hCeIip1cpTk9oPYeCbYKhVWi
JChatPro	“jchatpro”+appkey	jchatproa7e2ce002d1a071a6ca9f37d

appKey：（必须配置）一个 JIGUANG 应用唯一的标识。请参考 JIGUANG 相关说明文档来获取这个标识。 Android系统在meta-data中配置 channel：（可选项）channel 发布渠道。 Android系统在meta-data中配置 isProduction：（可选项）是否生产环境。默认：false WeChatAppId：（可选项）设置微信的应用标识。 WeChatAppSecret：（可选项）设置微信的应用密匙。 QQAppId：（可选项）设置QQ应用标识。 QQAppKey：（可选项）设置QQ应用Key。 SinaWeiboAppKey：（可选项）设置新浪微博应用标识。 SinaWeiboAppSecret：（可选项）设置新浪微博应用密匙。 SinaRedirectUri：（可选项）设置新浪微博应用回调地址。 isSupportWebSina：（可选项）不存在新浪客户端的情况下，是否支持新浪网页版分享。默认：false 注意：Android系统不支持 FacebookAppID：（可选项）设置Facebook应用标识。 FacebookDisplayName：（可选项）设置Facebook应用名称。 TwitterConsumerKey：（可选项）Twitter consumer key。 TwitterConsumerSecret：（可选项）Twitter consumer secret。 TwitterCallBackUrl：（可选项）Twitter callbackUrl。 JChatProAuth：（可选项）JChatPro Auth。

Android 平台需注意事项

配置 config.xml 文件。从第三方平台申请的相关 key 和 secret 等参数需要配置在本文件中。需要配置meta-data对应feature配置的appKey、channel;

配置方法如下：

参数：JPUSH_CHANNEL、JPUSH_APPKEY
配置示例:


  <meta-data name="JPUSH_CHANNEL"  value="channel"/>
  <meta-data name="JPUSH_APPKEY"  value="appKey"/>

如果需要使用facebook分享，Android平台下还需要在config.xml额外针对facebook配置feature的

名称：JShare
参数：FacebookAuthorities
配置示例:


 <feature name="JShare">
    <param name="FacebookAuthorities" value="com.facebook.app.FacebookContentProvider413313183164990"/>
  </feature>

字段描述:

FacebookAuthorities：（需要时配置）facebook配置,authorities必须为“com.facebook.app.FacebookContentProvider”+APP_ID

¥¥¥¥@@@@

插件接口

config

初始化配置。Android端调用此方法会把config.xml文件中配置的feature相关信息初始化

config()

示例代码

var JShare = api.require('JShare');
JShare.config();

可用性

Android系统

可提供的1.0.0及更高版本

isSinaWeiBoInstalled

判断当前设备是否安装客户端

isSinaWeiBoInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isSinaWeiBoInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isSinaWeiboWebLogined

检查不存在新浪客户端情况下的网页端是否登陆

isSinaWeiboWebLogined(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    isLogined:true      //布尔型；是否登录网页端
}

示例代码

var JShare = api.require('JShare');
JShare.isSinaWeiboWebLogined(function(ret, err) {
    if (ret.isLogined) {
        api.alert("当前已登录");
    } else {
        alert('未登录');
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

sinaWeiboWebLogOut

登出新浪网页端最新帐号

sinaWeiboWebLogOut(callback(ret))

示例代码

var JShare = api.require('JShare');
JShare.sinaWeiboWebLogOut();

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isWeChatInstalled

判断当前设备是否安装客户端

isWeChatInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isWeChatInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isQQInstalled

判断当前设备是否安装客户端

isQQInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isQQInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isFacebookInstalled

检查是否存在 Facebook 客户端

isFacebookInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isFacebookInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isFacebookMessengerInstalled

检查是否存在 Messenger 客户端

isFacebookMessengerInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isFacebookMessengerInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isTwitterInstalled

检查是否存在 Twitter 客户端

isTwitterInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isTwitterInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isJChatProInstalled

检查是否存在JChatPro客户端

isJChatProInstalled(callback(ret))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    installed:true      //布尔型；当前设备是否安装客户端
}

示例代码

var JShare = api.require('JShare');
JShare.isJChatProInstalled(function(ret, err) {
    if (ret.installed) {
        api.alert({msg:"当前设备已安装客户端"});
    } else {
        api.alert({msg:'当前设备未安装客户端'});
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

isPlatformAuth

检查用户授权之后信息是否过期。注意：仅仅检验本地 token 是否在有效期内，假如对应的社交平台用户在社交平台手动取消了授权，即使本地 token 还在有效期内，但是还是失效的。

isPlatformAuth({params},callback(ret))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    isOauth: true   //布尔型；true||false
}

示例代码

var JShare = api.require('JShare');
JShare.isPlatformAuth({
    platform: 'session'
}, function(ret) {
    if (ret.isOauth) {
        alert('已授权');
    } else {
        alert('未授权');
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cancelAuthWithPlatform

删除用户授权本地数据

cancelAuthWithPlatform({params},callback(ret))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
    status: true   //布尔型；是否取消成功 true||false
}

示例代码

var JShare = api.require('JShare');
JShare.cancelAuthWithPlatform({
    platform: 'session'
}, function(ret) {
    if (ret.status) {
        alert('已取消授权');
    } else {
        alert('取消授权失败');
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareText

分享文本到微信

wxShareText({params}, callback(ret, err))

params

text：

类型：字符串
描述：分享文本，不超过10KB

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- timeline：朋友圈
- favourite：收藏

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareText({  
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareImage

分享图片到微信

wxShareImage({params}, callback(ret, err))

params

image：

类型：字符串
描述：分享的图片路径，要求本地图片（fs://、widget://），大小不能超过 10 M。

title：

类型：数组
描述：（可选项）分享内容的标题，最大 512 字符
注意：仅IOS支持

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- timeline：朋友圈
- favourite：收藏

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareImage({ 
    image: 'widget://res/1.png'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareAudio

分享音频到微信

wxShareAudio({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 32k

title：

类型：字符串
描述：（可选项）标题，长度不能超过 512

text：

类型：字符串
描述：（可选项）描述，长度不能超过 1k

mediaDataUrl：

类型：字符串
描述：（可选项）点击播放按钮可直接播放 url ,长度不能超过 10K

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过32k

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- timeline：朋友圈
- favourite：收藏

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareAudio({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareVideo

分享视频到微信

wxShareVideo({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 10k

title：

类型：字符串
描述：（可选项）标题，长度不能超过 512

text：

类型：字符串
描述：（可选项）描述，长度不能超过 1k

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过32k

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- timeline：朋友圈
- favourite：收藏

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareVideo({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareLink

分享链接到微信

wxShareLink({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 10k

title：

类型：字符串
描述：（可选项）标题，长度不能超过 512

text：

类型：字符串
描述：（可选项）描述，长度不能超过 1k

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过32k

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- timeline：朋友圈
- favourite：收藏

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareLink({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareEmoticon

分享表情到微信好友，朋友圈和收藏不支持

wxShareEmoticon({params}, callback(ret, err))

params

emoticonData：

类型：字符串
描述：表情,长度不能超过 10M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareEmoticon({  
    emoticonData:'https://www.apicloud.com'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareFile

分享文件到微信，朋友圈不支持

wxShareFile({params}, callback(ret, err))

params

fileData：

类型：字符串
描述：文件的路径，大小不能超过10M

fileExt：

类型：字符串
描述：文件后缀名，最大 64 字符
注意：仅IOS支持

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- favourite：收藏

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareFile({  
    emoticonData:'https://www.apicloud.com'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wxShareApp

分享 App 到微信

wxShareApp({params}, callback(ret, err))

params

url：

类型：字符串
描述：（可选项）点击跳转页面 url,长度不能超过 10k

title：

类型：字符串
描述：（可选项）标题，长度不能超过 512

text：

类型：字符串
描述：（可选项）描述，长度不能超过 1k

extInfo：

类型：字符串
描述：（可选项）第三方程序自定义的简单数据

fileData：

类型：字符串
描述：对应APP的数据，大小不能超过10M

platform：

类型：字符串
描述：分享的平台
默认：session
取值范围：
- session：好友
- timeline：朋友圈

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareApp({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

wxShareProgram

分享小程序，仅支持分享到微信会话

wxShareProgram({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 10k

title：

类型：字符串
描述：标题，长度不能超过 512

userName：

类型：字符串
描述：小程序名，小程序原始ID获取方法：登录小程序管理后台-设置-基本设置-帐号信息

path：

类型：字符串
描述：小程序页面的路径，小程序被用户点击后所打开的页面路径

image：

类型：字符串
描述：小程序新版本的预览图，最大128k

text：

类型：字符串
描述：（可选项）描述，长度不能超过 1k

miniProgramType：

类型：数字
描述：（可选项）小程序版本类型，
默认：0
取值范围：
- 0正式版
- 1开发版
- 2体验版

withShareTicket：

类型：布尔
描述：（可选项）是否使用带 shareTicket 的转发
默认：false

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wxShareProgram({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QQShareText

分享文本到 QQ

QQShareText({params}, callback(ret, err))

params

text：

类型：字符串
描述：分享文本，最大 1536 字符

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QQShareText({  
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统不支持

可提供的1.0.0及更高版本

QQShareImage

分享图片到 QQ

QQShareImage({params}, callback(ret, err))

params

image：

类型：字符串
描述：分享的图片路径，要求本地图片（fs://、widget://），大小不能超过 5 M。

text：

类型：数组
描述：（可选项）分享内容的描述，最大 512 字符
注意：仅IOS支持

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QQShareImage({ 
    image: 'widget://res/1.png'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QQShareLink

分享链接到 QQ

QQShareLink({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 1024

title：

类型：字符串
描述：（可选项）标题，长度不能超过 128

text：

类型：字符串
描述：（可选项）描述，长度不能超过 512

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过1M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QQShareLink({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QQShareAudio

分享音频到 QQ

QQShareAudio({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 1024

title：

类型：字符串
描述：（可选项）标题，长度不能超过 128

text：

类型：字符串
描述：（可选项）描述，长度不能超过 512

mediaDataUrl：

类型：字符串
描述：（可选项）音乐资源 Url，点击播放按钮可直接播放 url

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过1M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QQShareAudio({
    url:'https://y.qq.com/n/yqq/song/109325260_num.html?ADTAG=h5_playsong&no_redirect=1',
    title: 'QQ音乐',
    text:'apicloud',
    mediaDataUrl:'http://music.huoxing.com/upload/20130330/1364651263157_1085.mp3',
    thumbnail:'/storage/emulated/0/DCIM/1111.png'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    }
    if(err) {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QQShareVideo

分享视频到 QQ

QQShareVideo({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 1024

title：

类型：字符串
描述：（可选项）标题，长度不能超过 128

text：

类型：字符串
描述：（可选项）描述，长度不能超过 512

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过1M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QQShareVideo({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QZoneShareText

分享文本到 QQ 空间

QZoneShareText({params}, callback(ret, err))

params

text：

类型：字符串
描述：分享文本，最大 1536 字符

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QZoneShareText({  
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QZoneShareImage

分享图片到 QQ 空间

QZoneShareImage({params}, callback(ret, err))

params

image：

类型：字符串
描述：分享的图片路径，要求本地图片（fs://、widget://），大小不能超过 5 M。

images：

类型：数组
描述：（可选项）分享多张图片时的本地图片路径组成的数组，图片数量限制为 20 张。若只分享单张图片至 QQ 空间使用 image 字段即可。

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QZoneShareImage({ 
    image: 'widget://res/1.png'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QZoneShareLink

分享链接到 QQ 空间

QZoneShareLink({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 512

title：

类型：字符串
描述：（可选项）标题，长度不能超过 512

text：

类型：字符串
描述：（可选项）描述，长度不能超过 140个中文字符

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过1M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QZoneShareLink({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QZoneShareAudio

分享音频到 QQ 空间

QZoneShareAudio({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 512

title：

类型：字符串
描述：（可选项）标题，长度不能超过 128

text：

类型：字符串
描述：（可选项）描述，长度不能超过 512

mediaDataUrl：

类型：字符串
描述：（可选项）音乐数据url地址，长度不能超过 512

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过1M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QZoneShareAudio({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QZoneShareVideo

分享视频到 QQ 空间

QZoneShareVideo({params}, callback(ret, err))

params

url：

类型：字符串
描述：点击跳转页面 url,长度不能超过 512

title：

类型：字符串
描述：（可选项）标题，长度不能超过 128

text：

类型：字符串
描述：（可选项）描述，长度不能超过 512

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），不超过1M

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QZoneShareVideo({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

QZoneShareLocalVideo

分享本地视频到 QQ 空间

QZoneShareLocalVideo({params}, callback(ret, err))

params

videoURL：

类型：字符串
描述：本地视频 url，注意在iOS端需要传入UIAlbumbrowser等插件返回的未经转换的视频路径

title：

类型：字符串
描述：（可选项）标题，长度不能超过 128

text：

类型：字符串
描述：（可选项）描述，长度不能超过 512

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.QZoneShareLocalVideo({  
    videoURL:'',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wbShareText

分享文本到新浪微博

wbShareText({params}, callback(ret, err))

params

text：

类型：字符串
描述：分享内容，不超过140个中文字符

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wbShareText({ 
    image: 'widget://res/1.png',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wbShareImage

分享图片到新浪微博

wbShareImage({params}, callback(ret, err))

params

image：

类型：字符串
描述：分享的图片路径，要求本地图片（fs://、widget://）大小不能超过 10 M。

text：

类型：字符串
描述：（可选项）分享内容的描述，不超过140个中文字符

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wbShareImage({ 
    image: 'widget://res/1.png',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wbShareLink

分享链接到新浪微博

wbShareLink({params}, callback(ret, err))

params

url：

类型：字符串
描述：分享点击跳转的 url，最大 255 字符。

title：

类型：字符串
描述：（可选项）标题，长度不能超过 1 K，且不为空

text：

类型：字符串
描述：（可选项）描述，长度不能超过 140个中文字符

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），大小小于32k

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wbShareLink({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wbContactShareLink

分享链接到新浪微博私信

wbContactShareLink({params}, callback(ret, err))

params

url：

类型：字符串
描述：分享点击跳转的 url，最大 255 字符。

title：

类型：字符串
描述：（可选项）标题，长度不能超过 1 K，且不为空

text：

类型：字符串
描述：（可选项）描述，长度不能超过 140个中文字符

thumbnail：

类型：字符串
描述：（可选项）缩略图地址，要求本地路径（fs://、widget://），大小小于32k

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.wbContactShareLink({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

fbShareImage

分享图片到脸书

fbShareImage({params}, callback(ret, err))

params

images(仅IOS支持)：

类型：数组
描述：分享多张图片时的本地图片路径组成的数组，最多6张图片，如果分享单张图片，图片大小建议不要超过12M；如果分享多张图片，每张图片大小建议不要超过700K。

image(仅Android支持)：

类型：string
描述：本地图片路径。

text（仅IOS支持）：

类型：字符串
描述：（可选项）文本

platform：

类型：字符串
描述：（可选项）分享平台
默认：facebook
取值范围：
- facebook：
- messenger：

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.fbShareImage({ 
    image: 'widget://res/1.png',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

fbShareVideo

分享视频到脸书

fbShareVideo({params}, callback(ret, err))

params

videoAssetURL：

类型：字符串
描述：视频参数，facebookMessenger 只能识别 ALAsset 的ALAssetPropertyAssetURL

text（仅IOS支持）：

类型：字符串
描述：（可选项）文本，最大 140 个汉字

platform：

类型：字符串
描述：（可选项）分享平台
默认：facebook
取值范围：
- facebook：
- messenger：

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.fbShareVideo({ 
    videoAsetURL: '',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

fbShareLink

分享链接到facebook

fbShareLink({params}, callback(ret, err))

params

url：

类型：字符串
描述：分享点击跳转的 url

text：

类型：字符串
描述：（可选项）描述、引用

platform：

类型：字符串
描述：（可选项）分享平台
默认：facebook
取值范围：
- facebook：
- messenger：

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.fbShareLink({  
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

twShareText

分享文本内容到推特

twShareText({params}, callback(ret, err))

params

text：

类型：字符串
描述：分享的文本，不超过140个中文字符

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.twShareText({ 
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

twShareImage

分享图片到推特

twShareImage({params}, callback(ret, err))

params

image：

类型：字符串
描述：分享单张图片地址，要求本地路径（fs://、widget://），单张图片大小不能超过 5 M

images：

类型：数组
描述：（可选项）分享多张图片时的本地图片路径组成的数组，最多4张图片

text：

类型：字符串
描述：（可选项）文本，最大 140 个汉字

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.twShareImage({ 
    image: 'widget://res/1.png',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

twShareVideo

分享视频到推特

twShareVideo({params}, callback(ret, err))

params

videoData：

类型：数组
描述：分享到 twitter 的视频，大小不应超过15 mb , 时间应该在0.5秒到30秒之间,尺寸应该在32x32和1280x1024之间 , 长宽比应在1：3和3：1之间

text：

类型：字符串
描述：（可选项）文本，最大 140 个汉字

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.twShareVideo({ 
    videoData: 'widget://res/1.mp4',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

twShareLink

分享链接到推特

twShareLink({params}, callback(ret, err))

params

image：

类型：字符串
描述：（可选项）分享单张图片地址，要求本地路径（fs://、widget://），单张图片大小不能超过 5 M
注意：Android不支持

images：

类型：数组
描述：（可选项）分享多张图片时的本地图片路径组成的数组，最多4张图片
注意：Android不支持

videoData：

类型：数组
描述：（可选项）分享到 twitter 的视频，大小不应超过15 mb
注意：Android不支持

url：

类型：字符串
描述：跳转Url，url 和 text 的总长度不能超过280个字节，可以带有图片或视频，但是不能同时带图片和视频。

text：

类型：字符串
描述：（可选项）url 和 text 的总长度不能超过280个字节

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.twShareLink({ 
    videoData: 'widget://res/1.mp4',
    url:'https://www.apicloud.com',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

jcShareText

分享文本内容到极光聊天

jcShareText({params}, callback(ret, err))

params

text：

类型：字符串
描述：分享的文本，不超过4k字节

title：

类型：字符串
描述：（可选项）消息标题
注意：Android不支持

extInfo：

类型：字符串
描述：（可选项）点击消息跳转到第三方应用时带的extra信息

callbackUrl：

类型：字符串
描述：（可选项）当应用内的分享消息被点击时，如果启动的客户端不存在时，回调的url。开发者可以通过这个配置实现本地应用不存在时跳转到他们的官网之类的操作

pkgName：

类型：字符串
描述：（可选项）点击消息时跳转第三方android客户端的包名

className：

类型：字符串
描述：（可选项）点击消息时跳转第三方android客户端的类名

appName：

类型：字符串
描述：（可选项）第三方客户端应用名称

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.jcShareText({ 
    title: 'timeline',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

jcShareImage

分享图片到极光聊天

jcShareImage({params}, callback(ret, err))

params

thumbUrl：

类型：字符串
描述：（可选项）网络缩略图地址
注意：Android不支持

image：

类型：字符串
描述：（可选项）分享单张图片地址，要求本地路径（fs://、widget://），images 且 imageURL 为空时本参数为必填项

images：

类型：数组
描述：（可选项）分享多张图片时的本地图片路径组成的数组，最多9张图片，image 且 imageURL 为空时本参数为必填项

imageURL：

类型：字符串
描述：（可选项）图片网络地址，image且images为空时本参数为必填项

text：

类型：字符串
描述：（可选项）分享的文本，不超过4k字节

title：

类型：字符串
描述：（可选项）消息标题

extInfo：

类型：字符串
描述：（可选项）点击消息跳转到第三方应用时带的extra信息

callbackUrl：

类型：字符串
描述：（可选项）当应用内的分享消息被点击时，如果启动的客户端不存在时，回调的url。开发者可以通过这个配置实现本地应用不存在时跳转到他们的官网之类的操作

pkgName：

类型：字符串
描述：（可选项）点击消息时跳转第三方android客户端的包名

className：

类型：字符串
描述：（可选项）点击消息时跳转第三方android客户端的类名

appName：

类型：字符串
描述：（可选项）第三方客户端应用名称

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.jcShareImage({ 
    title: 'timeline',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

jcShareGraphic

分享图文到极光聊天

jcShareGraphic({params}, callback(ret, err))

params

thumbUrl：

类型：字符串
描述：（可选项）网络缩略图地址
注意：Android不支持

image：

类型：字符串
描述：（可选项）分享单张图片地址，要求本地路径（fs://、widget://）

images：

类型：数组
描述：（可选项）分享多张图片时的本地图片路径组成的数组，最多9张图片

imageURL：

类型：字符串
描述：（可选项）图片网络地址

text：

类型：字符串
描述：（可选项）分享的文本，不超过4k字节

title：

类型：字符串
描述：（可选项）消息标题

extInfo：

类型：字符串
描述：（可选项）点击消息跳转到第三方应用时带的extra信息

url：

类型：字符串
描述：（可选项）点击消息时跳转应用的url

callbackUrl：

类型：字符串
描述：（可选项）当应用内的分享消息被点击时，如果启动的客户端不存在时，回调的url。开发者可以通过这个配置实现本地应用不存在时跳转到他们的官网之类的操作

pkgName：

类型：字符串
描述：（可选项）点击消息时跳转第三方android客户端的包名

className：

类型：字符串
描述：（可选项）点击消息时跳转第三方android客户端的类名

appName：

类型：字符串
描述：（可选项）第三方客户端应用名称

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    state:     //数字型；1成功2失败3取消4Unknown
}

err：

类型：JSON 对象
内部字段：

{
    code: 0     //数字类型；错误码
    msg:        //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.jcShareGraphic({ 
    title: 'timeline',
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.state == 1) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getPlatformList

获取已经正确配置的平台

getPlatformList(callback(ret))

callback

ret：

类型：JSON对象
描述：授权信息
内部字段：

{
    list  //支持的平台集合
}

示例代码

var JShare = api.require('JShare');
JShare.getPlatformList(function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

Android系统，IOS系统不支持

可提供的 1.0.0 及更高版本

getSocialUserInfo

获取登录授权信息。注意：此方法仅IOS支持，Android平台通过authorize和getUserInfo分别获取相关信息

getSocialUserInfo({params},callback(ret,err))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback

ret：

类型：JSON对象
描述：授权信息
内部字段：

{
    status:           //布尔类型；是否获取成功
    name:             //字符串类型；社交平台的用户昵称
    iconurl:          //字符串类型；社交平台的用户头像链接
    gender:           //数字类型；社交平台的用户性别，数值1表示男，数值2表示女。 Twitter平台为空。
    userOriginalResponse://字符串类型；社交平台提供的用户信息原始数据。
    uid:               //字符串类型；对应新浪微博平台的uid，以及QQ与微信平台可能会存在的unionid，Twitter平台对应的userID
    openid:           //字符串类型；对应QQ与微信平台授权提供的openId
    accessToken:      //字符串类型；用户允许授权获取的 token
    expiration:       //数字类型；accessToken有效期的时间戳，单位为秒。Twitter平台为空
    refreshToken:     //字符串类型；refreshToken 用来刷新 accessToken 的有效期。Twitter平台为空token
    oauthOriginalResponse://字符串类型；社交平台提供的授权原始数据
}

err：

类型：JSON对象
描述：授权信息
内部字段：

{
    code:           //数字类型; 错误码
    msg:            //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.getSocialUserInfo({
    platform:'session'
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

iOS 系统，Android 系统不支持

可提供的 1.0.0 及更高版本

isClientValid

判断某平台分享是否有效

isClientValid({params},callback(ret))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback

ret：

类型：JSON对象
描述：授权信息
内部字段：

{
    isValid：//布尔类型 true：有效
}

示例代码

var JShare = api.require('JShare');
JShare.isClientValid({
    platform:'session'
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

仅Android 系统支持

可提供的 1.0.0 及更高版本

isSupportAuthorize

判断某平台是否支持授权

isSupportAuthorize({params},callback(ret))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback

ret：

类型：JSON对象
描述：授权信息
内部字段：

{
    isSupport:           //布尔类型；是否支持
}

示例代码

var JShare = api.require('JShare');
JShare.isSupportAuthorize({
    platform:'session'
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

仅Android 系统支持

可提供的 1.0.0 及更高版本

authorize

授权

authorize({params},callback(ret,err))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback

ret：

类型：JSON对象
描述：授权信息
内部字段：

{
    status:           //布尔类型；是否获取成功
    openid:           //字符串类型；对应QQ与微信平台授权提供的openId
    accessToken:      //字符串类型；用户允许授权获取的 token
    expiration:       //数字类型；accessToken有效期的时间戳，单位为秒。Twitter平台为空
    refreshToken:     //字符串类型；refreshToken 用来刷新 accessToken 的有效期。Twitter平台为空token
    oauthOriginalResponse://字符串类型；社交平台提供的授权原始数据
}

err：

类型：JSON对象
描述：授权信息
内部字段：

{
    code:           //数字类型; 错误码
    msg:            //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.authorize({
    platform:'session'
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

仅Android 系统支持

可提供的 1.0.0 及更高版本

getUserInfo

获取个人信息

getUserInfo({params},callback(ret,err))

params

platform：

类型：字符串
描述：平台
取值范围：
- session：微信好友
- timeline：微信朋友圈
- favourite：微信收藏
- QQ：QQ
- QZone：QQ空间
- sinaWeibo：新浪微博
- sinaWeiboContact：新浪微博私信
- facebook：脸书
- messenger：脸书聊聊
- twitter：推特

callback

ret：

类型：JSON对象
描述：用户信息
内部字段：

{
    status:           //布尔类型；是否获取成功
    name:             //字符串类型；社交平台的用户昵称
    iconurl:          //字符串类型；社交平台的用户头像链接
    gender:           //数字类型；社交平台的用户性别，数值1表示男，数值2表示女。 Twitter平台为空。
    userOriginalResponse://字符串类型；社交平台提供的用户信息原始数据。
}

err：

类型：JSON对象
描述：授权信息
内部字段：

{
    code:           //数字类型; 错误码
    msg:            //字符串类型；错误信息
}

示例代码

var JShare = api.require('JShare');
JShare.getUserInfo({
    platform:'session'
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

仅Android 系统支持

可提供的 1.0.0 及更高版本

是否仍需要帮助？请保持联络！

最后更新于 2024/10/21

API.js

MTL.js

界面布局

设备访问

功能扩展

开放SDK

多端组件

人工智能

直播|音视频

H5组件

物联网

友空间移动中间件