说明

本接口会调用展示平台的消息分享功能

注意

因为不同平台的分享api不一致，比如微信小游戏就不可知分享结果。

本接口的的返回结果，只能当成一个动作完成的通知，并不代表着分享结果的成功与否！

输入

以下参数均可传 undefined

参数	类型	描述
sharetitle	String	转发标题，不传则默认使用后台配置或当前小游戏的名称
sharimg	String	转发显示图片的链接，支持本地沙盒目录（ttfile://）或 相对代码包根目录的图片路径，不支持网络图片路径。显示图片长宽比推荐 5:4，不传或使用网络图片路径则默认使用小游戏 icon 当 channel = video | picture 时，该字段不生效
sharequery	String	分享携带参数
imageUrlId	String	分享素材模板 id，指定通过平台审核的 templateId 来选择分享内容，需在平台设置且通过审核
path	Object	抖音小游戏平台分享参数，path参数 详见下方

path参数说明

参数	类型	描述
channel	String | undefined	转发内容类型,详见下方channel参数说明
extra	Object | undefined	附加信息 (hannel == video | picture 时生效)
desc	String | undefined	分享文案，不传则默认使用后台配置内容或游戏简介

channel 参数说明

参数	描述
invite	拉起邀请面板分享游戏给好友
video	发布视频内容
token	口令分享，生成一串特定的字符串文本
article	发布图文内容
picture	发布图文内容，内容由接口参数直接传入

extra 参数说明

移步传送门，与抖音小游戏官方文档中的extra字段一致 extra参数说明

输出

参数	类型	描述
code	Number	1000-成功 其余失败
msg	String	执行分享的文本结果
data	Array | undefind	仅当入参 options 中 channel='invite' 时返回，包含邀请对象的用户名和用户头像。(当邀请多个好友或群聊时，目前仅会返回一个好友的信息，群聊的信息暂不支持返回)

data 参数说明

参数	类型	描述
name	String	分享对象的用户名
icon	String	分享对象的用户头像

示例代码

let sharetitle = "分享的标题"; //若传undefined，则分享消息内容为小游戏的名称
let sharimg = "要分享的图片url"; // 可传undefined
let sharequery = "roleid=100&rolename=好汉"; //可传undefined
let imageUrlId = undefined; // 审核通过的图片 ID  可undefined
let path = {
    desc:"这是分享描述",
    channel:"invite",//分享类型
};  // 独立分包路径 可undefined
mzfSdk.shareMessage(sharetitle,sharimg,sharequery,imageUrlId,path).then(result=>{
    if(result.code == 1000){
        console.log("分享成功");
        console.log(result.data); // 仅当入参 options 中 channel='invite' 时返回，包含邀请对象的用户名和用户头像。(当邀请多个好友或群聊时，目前仅会返回一个好友的信息，群聊的信息暂不支持返回)
    }else{
        console.log("分享失败");
    }
});