tt.onShareAppMessage

tt.onShareAppMessage(function callback)

监听用户点击右上角菜单的“转发”按钮时触发的事件

输入

callback function

监听事件的回调函数, 该函数接收一个对象参数, 同时该回调需返回一个对象,定义本次分享的行为。

回调函数接收的参数

属性 类型 是否必填 说明
channel string 转发内容类型

channel

说明
- 默认为卡片链接, channel 为空字符串或者不传
article 发布图文内容,抖音不支持
video 发布视频内容
token 口令分享,生成一串特定的字符串文本,仅头条APP支持

返回对象

属性 类型 是否必填 说明
title string 转发标题,不传则默认使用当前小游戏的名称。
imageUrl string 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径,显示图片长宽比推荐 5:4
query string 查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 tt.getLaunchOptionSync()tt.onShow() 获取启动参数中的 query。
extra object 附加信息

extra

属性 类型 默认值 说明
videoPath string 视频地址
videoTopics Array<string> 视频话题(只在抖音可用)
createChallenge boolean false 是否分享为挑战视频(头条支持)

代码示例

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)
    }

  }
});