# 分享

# 启用分享按钮（被动分享）

用于启用游戏右上角•••菜单中的分享按钮，并同步设置其点击时的分享参数；建议在SDK初始化完成后立即调用此接口进行设置。

sdkInstance.setShare(options);

参数说明如下表所示：

选项	类型	必填	默认值	说明
title	string	否	--	分享时显示的标题，不填时默认使用当前游戏的名称
desc	string	否	--	分享时显示的描述文案，不填时默认使用当前游戏的简介
imageUrl	string	否	--	分享时显示的图片链接，可以是网络图片路径，或本地图片文件路径，亦或相对代码包根目录的图片文件路径，建议长宽比为 `5:4`，不填时默认使用当前游戏的ICON图标
query	object	否	--	分享时携带的额外参数；点击分享消息进入游戏后，可通过 `sdkInstance.launchOptions.query` 或调用抖音原生方法 tt.getLaunchOptionsSync() 获取该信息

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

sdkInstance.setShare({
  title: "分享标题，可填写游戏名称",
  desc: "分享描述文案，可填写游戏简介",
  imageUrl: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  }
});

用于主动拉起抖音发布器进行分享，亦或邀请好友、分享录屏等。

sdkInstance.share(options);

参数说明如下表所示：

选项	类型	必填	默认值	说明
title	string	否	--	分享时显示的标题
desc	string	否	--	分享时显示的描述文案
imageUrl	string	否	--	分享时显示的图片链接，当 `channel` 为 `video` 或 `picture` 时，该选项不生效
query	object	否	--	分享时携带的额外参数；点击分享消息进入游戏后，可通过 `sdkInstance.launchOptions.query` 或调用抖音原生方法 tt.getLaunchOptionsSync() 获取该信息
channel	string	否	--	转发内容类型，为空字符串或者不传时，使用默认分享方式；详情请参考 ShareParam 说明 `invite` - 拉起邀请面板分享游戏给好友 `video` - 分享视频内容 `picture` - 发布图文内容，内容由接口参数直接传入 `article` - 发布图文内容 `token` - 口令分享，生成一串特定的字符串文本
extra	object	否	--	附加信息，仅当 `channel` 为 `video` 或 `picture` 时有效；详情请参考 ShareParam 说明
templateId	string	否	--	分享素材模板ID，指定通过抖音开放平台审核通过的 `templateId` 来选择分享内容；详情请参考拍摄视频并发布至抖音
success	function	否	--	分享成功的回调函数
fail	function	否	--	分享失败的回调函数
complete	function	否	--	分享完成的回调函数，成功或失败均会调用

当 channel 为 video 时，可以通过 extra 设置以下附加信息：

选项	类型	必填	默认值	说明
withVideoId	boolean	否	--	是否支持跳转到播放页，以及支持获取视频信息等接口；为 `true` 时会在 `success` 回调中带上 `videoId`
videoPath	string	否	--	视频地址，用于分享一个本地视频；如果不传入 `videoPath`，则会拉起摄像头拍摄界面
videoTopics	array	否	--	视频话题（仅抖音支持），目前由 `hashtag_list` 代替，即将废弃；为保证兼容性，建议同时设置 `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无效的时候是否直接回调失败

当 channel 为 picture 时，可以通过 extra 设置以下附加信息：

选项	类型	必填	默认值	说明
picturePath	string[]	是	--	发布的图片地址，仅支持本地图片路径（即游戏包内路径和 `ttfile://` 路径）
contentTitle	string	否	--	作品标题
contentDescription	string	否	--	作品描述信息
hashtag_list	array	否	--	视频话题，字符串中间包含空格会取第一个空格前内容作为话题（仅抖音支持）

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

sdkInstance.share({
  title: "分享标题，可填写游戏名称",
  desc: "分享描述文案，可填写游戏简介",
  imageUrl: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  }
});