# 分享
拉起对应的 App 进行分享,如微信、微信朋友圈、微博、QQ、QQ空间、饭团等
# 右上角分享按钮(被动分享)
# 接口说明
监听用户点击右上角•••菜单中的分享按钮事件,建议在SDK初始化完成后立即调用此接口进行设置。
sdkInstance.setShare(options);
# 参数说明
参数说明如下表所示:
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| query | object | 否 | -- | 分享时携带的额外参数,点击分享消息进入游戏后,可通过 sdkInstance.launchOptions.query 获取或调用芒果tv原生方法 mgtv.getLaunchOptionsSync() 获取,原生获取后需自行处理 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdkInstance.setShare({
query: {
param1: 1,
param2: 2
}
});
# 主动分享
# 接口说明
用于主动拉起设置的相应 App 进行分享。
sdkInstance.share(options);
# 参数说明
参数说明如下表所示:
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| shareAppType | string / array | 否 | 分享的平台类型,默认
| |
| shareType | string | 否 | link | 分享类型,默认
|
| title | string | 是 | -- | 分享标题 |
| desc | string | 否 | -- | 分享时显示的描述文案 |
| imageUrl | string | 否 | -- | 分享图片,注意:不能使用本地图片 |
| query | object | 否 | -- | 分享时携带的额外参数,点击分享消息进入游戏后,可通过 sdkInstance.launchOptions.query 获取或调用芒果tv原生方法 mgtv.getLaunchOptionsSync() 获取,原生获取后需自行处理 |
| success | function | 否 | -- | 分享成功的回调函数 |
| fail | function | 否 | -- | 分享失败的回调函数 |
| complete | function | 否 | -- | 分享完成的回调函数,成功或失败均会调用 |
# shareType 的合法值:
| 合法值 | 说明 |
|---|---|
| 微信 | |
| wechatMoment | 微信朋友圈 |
| qzone | QQ空间 |
| 微博 | |
| fantuan | 饭团 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 单个分享
sdkInstance.share({
shareAppType: "wechat", // 支持字符串或数组
shareType: "link", // link链接分享,若 imageUrl 存在则使用该图片不存在使用开放后台游戏logo; image图片分享,此时 imageUrl 必填且只分享图不显示标题描述
title: "分享标题,可填写游戏名称",
desc: "分享描述文案,可填写游戏简介",
imageUrl: "xxxxxxxxxx", // 分享图片,不能使用本地图片
query: { key1: "自定义参数1", key2: "自定义参数2" } // 分享时携带的参数,通过 sdkInstance.launchOptions.query 获取
});
// 分享到多个App
sdkInstance.share({
shareAppType: ["wechat", "weibo"], // 支持字符串或数组
shareType: "link", // link链接分享,若 imageUrl 存在则使用该图片不存在使用开放后台游戏logo; image图片分享,此时 imageUrl 必填且只分享图不显示标题描述
title: "分享标题,可填写游戏名称",
desc: "分享描述文案,可填写游戏简介",
imageUrl: "xxxxxxxxxx", // 分享图片,不能使用本地图片
query: { key1: "自定义参数1", key2: "自定义参数2" } // 分享时携带的参数,通过 sdkInstance.launchOptions.query 获取
});