分享

启用转发或分享按钮（被动分享）

接口说明

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

sdkInstance.setShare(options);

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
title	string	否	--	分享时显示的标题，不填时默认使用当前游戏的名称
imageUrl	string	否	--	分享时显示的图片链接，可以是网络图片路径，或本地图片文件路径，亦或相对代码包根目录的图片文件路径，建议长宽比为 5:4，不填时默认使用当前游戏的ICON图标
imageUrlId	string	否	--	自定义 imageUrl 时，审核通过后其对应的图片编号，详情请查看使用审核通过的转发图片
imagePreviewUrl	string	否	--	朋友圈的预览图链接，不填时默认使用当前游戏的画面截图
imagePreviewUrlId	string	否	--	自定义 imagePreviewUrl 时，审核通过后其对应的图片编号，详情请查看使用审核通过的转发图片
path	string	否	--	独立分包路径，详情请查看小游戏独立分包指南
query	object	否	--	分享时携带的额外参数；点击分享消息进入游戏后，可通过 sdkInstance.launchOptions.query 或调用微信原生方法 wx.getLaunchOptionsSync() 获取该信息

示例代码

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

sdkInstance.setShare({
  title: "分享标题，可填写游戏名称",
  imageUrl: "xxxxxxxxxx",
  imageUrlId: "xxxxxxxxxx",
  imagePreviewUrl: "xxxxxxxxxx",
  imagePreviewUrlId: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  }
});

主动分享

接口说明

用于主动唤起微信通讯录列表选择好友进行分享。

sdkInstance.share(options);

最低基础库版本要求

若传递了 imageUrlId 参数，则要求用户客户端基础库版本不低于 2.4.3；若低于该版本，调用 sdkInstance.share(options) 接口将中断用户当前操作并弹出升级提示，不会报错！

若传递了 toCurrentGroup 或 path 参数，则要求用户客户端基础库版本不低于 2.12.2；若低于该版本，调用 sdkInstance.share(options) 接口将中断用户当前操作并弹出升级提示，不会报错！

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
title	string	否	--	分享时显示的标题，不填时默认使用当前小游戏的名称
imageUrl	string	否	--	分享时显示的图片链接，可以是网络图片路径，或本地图片文件路径，亦或相对代码包根目录的图片文件路径，建议长宽比为 5:4，不填时默认使用当前小游戏的ICON
imageUrlId	string	否	--	自定义 imageUrl 时，审核通过后其对应的图片编号，详情请查看使用审核通过的转发图片
path	string	否	--	独立分包路径，详情请查看小游戏独立分包指南
query	object	否	--	分享时携带的额外参数；点击分享消息进入游戏后，可通过 sdkInstance.launchOptions.query 或调用微信原生方法 wx.getLaunchOptionsSync() 获取该信息

注意事项

如果调用 sdkInstance.share(options) 接口之前已通过 sdkInstance.setShare(options) 接口全局设置了分享标题及图片，则上述示例代码中的所有参数均可不填。

示例代码

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

// 若传递了 imageUrlId 参数，且用户客户端基础库版本低于 2.4.3，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
// 若传递了 toCurrentGroup 或 path 参数，且用户客户端基础库版本低于 2.12.2，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
sdkInstance.share({
  title: "分享标题，可填写游戏名称",
  imageUrl: "xxxxxxxxxx",
  imageUrlId: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  }
});

转发自定义图片

接口说明

用于打开分享图片弹窗，将自定义图片转发给朋友、收藏或保存到相册，可结合用户截屏场景使用。

sdkInstance.showShareImageMenu(options);

最低基础库版本要求

若用户客户端基础库版本低于 2.14.3，调用 sdkInstance.showShareImageMenu(options) 接口将中断用户当前操作并弹出升级提示，不会报错！

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
path	string	是	--	要分享的图片地址，必须为本地路径或临时路径
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

示例代码

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

// 本示例演示分享 canvas 截图
canvas.toTempFilePath({
  success: function(result) {
    // 若用户客户端基础库版本低于 2.14.3，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
    sdkInstance.showShareImageMenu({
      path: result.tempFilePath,
      success: function(response) {
        console.log(response);
      },
      fail: function(error) {
        console.log(error);
      }
    });
  },
  fail: function(error) {
    console.log(error);
  }
});