ShareParam

channel

string

否

转发内容类型

templateId

string

否

分享素材模板 id，指定通过平台审核的 templateId 来选择分享内容，需在平台设置且通过审核。参考小程序相关说明

desc

string

否

分享文案，不传则默认使用后台配置内容或游戏简介。

title

string

否

转发标题，不传则默认使用后台配置或当前小游戏的名称。

imageUrl

string

否

转发显示图片的链接，可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径，显示图片长宽比推荐 5:4，不传则默认使用小游戏icon

query

string

否

查询字符串，必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后，可通过 tt.getLaunchOptionsSync 或 tt.onShow 获取启动参数中的 query用来实现信息透传

extra

object

否

附加信息（仅channel == video时生效）

success

Function

否

分享成功后执行的回调函数

fail

Function

否

分享失败或者用户取消发布器后执行的回调函数

complete

Function

否

分享完成（无论成功与否）后执行的回调函数

-

默认分享方式, channel 为空字符串或者不传

invite

拉起邀请面板分享游戏给好友，仅抖音20.6及以上版本支持

video

发布视频内容

token

口令分享，生成一串特定的字符串文本，仅头条 APP 支持

article

发布图文内容，仅头条 APP 支持

withVideoId

boolean

是否支持跳转到播放页， 以及支持获取视频信息等接口 （为 true 时会在 success 回调中带上 videoId）

videoPath

string

视频地址 ，分享一个本地视频

videoTopics

array

视频话题(仅抖音支持) ，目前由 hashtag_list 代替，为保证兼容性，建议同时填写两个。

createChallenge

boolean

false

是否分享为挑战视频 ( 仅头条支持 )

video_title

string

""

生成输入的默认文案

hashtag_list

array

视频话题(仅抖音支持)

videoTag

string

分享视频的标签，可以结合获取抖音视频排行榜使用

defaultBgm

string

抖音 pgc 音乐的短链(仅抖音支持，需要基础库版本大于 1.90) 。形如https://v.douyin.com/JmcxWo8/， 参考 抖音小游戏录屏带配乐能力

cutTemplateId

string

抖音上可用的剪映模板 ID， 参考 录屏添加剪映视频模板能力

abortWhenCutTemplateUnavailable

booelan

false

剪映模板不可用或者剪映模板 ID 无效的时候是否直接回调失败。