分享

主动分享

接口说明

用于主动拉起淘宝分享组件进行分享。

sdkInstance.share(options);

最低基础库版本要求

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

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
title	string	否	--	分享时显示的标题
desc	string	否	--	分享时显示的描述文案
imageUrl	string	否	--	分享时显示的图片链接
query	object	否	--	分享时携带的额外参数；点击分享消息进入游戏后，可通过 sdkInstance.getShareInfo() 获取该信息
success	function	否	--	分享成功的回调函数
fail	function	否	--	分享失败的回调函数
complete	function	否	--	分享完成的回调函数，成功或失败均会调用

示例代码

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

// 当用户客户端基础库版本过低时，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
sdkInstance.share({
  title: "分享标题，可填写游戏名称",
  desc: "分享描述文案，可填写游戏简介",
  imageUrl: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  }
});

获取分享信息

接口说明

用于被分享者点击分享消息进入游戏时，获取分享信息。

sdkInstance.getShareInfo();

最低基础库版本要求

当用户客户端基础库版本过低时，调用 sdkInstance.getShareInfo() 接口将弹出升级提示，并返回 undefined，需要游戏客户端对返回值做兼容处理！

返回值说明

返回值说明如下表所示：

选项	类型	必填	默认值	说明
query	object	是	--	分享时携带的额外参数

示例代码

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

// 当用户客户端基础库版本过低时，调用此接口将弹出升级提示，并返回 undefined，需要游戏客户端对返回值做兼容处理！
const shareInfo = sdkInstance.getShareInfo();

console.log(shareInfo);