tt.onShareAppMessage
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个同步方法。
监听用户点击右上角菜单中的“转发”按钮时触发的事件。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 相关教程 | 无 |
语法
tt.onShareAppMessage(callback)
参数说明
callback
| 类型 | 默认值 | 必填 | 说明 | 最低支持版 本 |
|---|---|---|---|---|
| function | 是 | 监听触发“转发”的函数。函数可以返回 ShareParam 对象，该返回对象可以用来自定义分享的内容。 | 1.0.0 |
callback 是一个回调函数，接收 object 类型的参数，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| channel | string | 转发内容类型，有 article、video | 1.0.0 |
channel 参数说明
不同转发内容类型含义如下：
类型 | 含义 |
article | 在头条内用户点击「发头条 - 发图文」时 |
video | 在头条内用户点击「发头条 - 发视频」时 |
undefined | 其它场景均为 undefined |
返回值
无
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 20000 | internal error | 小游戏框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 20001 | invalid param | 参数错误 | 1.0.0 |
代码示例
示例一：
tt.onShareAppMessage(function (res) { //当监听到用户点击了分享或者拍抖音等按钮后，会执行该函数 console.log(res.channel); // do something return { //执行函数后，这里是需要该函数返回的对象 title: "分享标题", imageUrl: "https://example.com/test.png", query: "k1=v1&k2=v2", success() { console.log("分享成功"); }, fail(e) { console.log("分享失败", e); }, }; //返回的对象会传入tt.shareAppMessage进行最终分享 });
示例二：
tt.onShareAppMessage(function (res) { console.log(res.channel); // do something const shareData = { title: "分享标题", imageUrl: "https://example.com/test.png", query: "k1=v1&k2=v2", 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; case "article": default: break; } return r; });
