tt.onShareAppMessage
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个同步方法。
本API为被动分享监听操作:监听用户点击平台提供的分享入口时触发的事件(如右上角更多面板中的分享、排行榜中的分享),以指定用户的分享内容。
主动分享调用(游戏内主动拉起发布器、好友邀请、录屏分享等)详见 tt.shareAppMessage
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 |
|
相关教程 | 无 |
语法
tt.onShareAppMessage(callback)
参数说明
callback
类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
function | | 是 | 1.0.0 |
callback 是一个回调函数,接收和返回的参数都是 object 类型的参数,属性详见 ShareParam
- •接收参数使用说明:
- ◦可通过
channel 判断用户即将触发什么类型的分享,值含义说明详见 ShareParam- ◦可通过
res.extra.position 判断用户触发分享的点位:top 表示为右上角更多面板中的分享。返回值
无
错误码
errNo | errMsg | 说明 | 最低支持版本 |
20000 | internal error | 1.0.0 | |
20001 | invalid param | 参数错误 | 1.0.0 |
代码示例
示例一:
tt.onShareAppMessage(function (res) { console.log(res.channel); // do something const shareData = { success() { console.log("分享成功"); }, fail(e) { console.log("分享失败", e); }, }; const r = Object.assign({ channel: res.channel }, shareData); //channel值无法修改,并会在调用tt.shareAppMessage时自动带上 switch (res.channel) { case "video": r.extra = { videoTopics: ["test1 videoTopics", "test2 videoTopics"], // 抖音小视频话题列表 videoPath: "videotest.mp4", // 如果为抖音或者头条小视频,可以直接传本地视频路径 //以抖音为例,使用videoPath后,用户点击拍抖音时会去分享开发者指定的视频。 }; break; default: if (res.extra.position === "top") { // 为用户点击右上角更多面板中的分享 r.templateId = "", // 替换为审核通过的templateId } else { // 为用户点击游戏内平台拉起的分享,如排行榜中的分享 r.templateId = "", // 替换为审核通过的templateId } break; } return r; });
