SDK对接文档

主题

WARNING

💡 模块名:GameHelper.Share

描述 ​

本模块集成各个小游戏平台的分享接口。

接入说明 ​

目前已支持的微信、字节平台支持自定义分享标题和分享图片；

分享标题和分享图片采用两种配置方式：在线参数后台可动态配置和本地默认配置（未获取到服务器配置的分享信息时使用）；

当玩法 KEY 配置了多个分享内容时，每次调用分享接口时会显示其中一个分享内容，显示顺序为配置的先后顺序;

准备工作 ​

接入前请准备好分享配置内容，包括玩法 KEY、游戏相关的分享标题、分享图片；

初始化 ​

在初始化 SDK 时传入默认分享配置进行模块初始化；

javascript
GameHelper.init({
    ...
    shareInfo:{
        main: "MYKEY",
        MYKEY:{
            title: "分享文案",
            imageUrl:"远程分享图片地址",
        },
        MYKEY2:[
            {
                title: "分享文案2",
                imageUrl: "远程分享图片地址",
            },
            {
                title: "分享文案3",
                imageUrl: "远程分享图片地址",
            }
        ]
    }
})

配置说明：

  • main 参数必须配置，为默认主配置，当调用分享接口不传值时，会使用 main 参数后的 KEY 对应的分享内容进行分享；
  • shareInfo 内可同时配置多个玩法 KEY，每个玩法 KEY 可配置单个或多个分享信息，配置多个时必须配置成数组。

系统分享 ​

显示当前小游戏页面的转发按钮并设置分享图

javascript
/* 示例1，不传参，会使用main属性后的KEY值分享内容分享 */
GameHelper.Share.onSystemShare();

/** 示例2，传入KEY值： */
GameHelper.Share.onSystemShare("MYKEY2");

普通分享 ​

拉起分享页面

javascript
/* 示例1，不传参，使用main属性后的KEY值分享内容分享 */
GameHelper.Share.shareGameMsg();

/* 示例2，传参，使用main属性后的KEY值分享内容分享 */
GameHelper.Share.shareGameMsg("MYKEY");

/* 示例3，传入一个对象 */
GameHelper.Share.shareGameMsg({
  key: "MYKEY",
  // 查询字符串，必须是 key1=val1&key2=val2 的格式从这条转发消息进入后，
  // 可通过小游戏官方平台提供的getLaunchOptionsSync和onShow接口获取启动参数中的 query。
  query: "tag=1&sign=2",
});

接口索引 ​

方法 ​

​

显示当前小游戏页面的转发按钮并设置分享图

参数类型默认值是否必填说明
keystring/否玩法 Key，默认使用配置中的 main 属性配置的 key 值

​

拉起聊天界面选择好友/群进行分享

参数类型默认值是否必填说明
optstring /shareParams/否使用指定的玩法 key 进行分享

shareParams

参数类型默认值是否必填说明
keystring/否使用指定的玩法 key 进行分享
titlestring/否自定义分享标题
imageUrlstring/否自定义分享图片
querystring/否分享参数，示例："tag=1&sign=2"，按 key=v&key2=v2...配置
点我快速对接