# 分享

# 启用分享按钮(被动分享)

# 接口说明

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

sdkInstance.setShare(options);

# 参数说明

参数说明如下表所示:

选项 类型 必填 默认值 说明
title string -- 分享时显示的标题,不填时默认使用当前游戏的名称
desc string -- 分享时显示的描述文案
imageUrl string -- 分享时显示的图片链接,可以是网络图片路径(暂不支持非B站图片服务器资源地址),或本地图片文件路径,亦或相对代码包根目录的图片文件路径,建议图片分辨率 750*750
biliContent string -- 用于分享到B站动态,模拟用户发布时手动填写的输入框内容(支持创建标签话题,eg: biliContent: "标题内容 #话题 xxx# 标题内容")
biliMessageTitle string -- 用于分享到B站私信,小游戏卡片的标题,为空时使用 title 字段
query object -- 分享时携带的额外参数;点击分享消息进入游戏后,可通过 sdkInstance.launchOptions.query 或调用B站原生方法 bl.getLaunchOptionsSync() 获取该信息

# 示例代码

注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!

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

# 主动分享

# 接口说明

用于主动唤起B站分享面板进行分享。

sdkInstance.share(options);

最低基础库版本要求

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

# 参数说明

参数说明如下表所示:

选项 类型 必填 默认值 说明
title string -- 分享时显示的标题,不填时默认使用当前游戏的名称
desc string -- 分享时显示的描述文案
imageUrl string -- 分享时显示的图片链接,可以是网络图片路径(暂不支持非B站图片服务器资源地址),或本地图片文件路径,亦或相对代码包根目录的图片文件路径,建议图片分辨率 750*750
biliContent string -- 用于分享到B站动态,模拟用户发布时手动填写的输入框内容(支持创建标签话题,eg: biliContent: "标题内容 #话题 xxx# 标题内容")
biliMessageTitle string -- 用于分享到B站私信,小游戏卡片的标题,为空时使用 title 字段
query object -- 分享时携带的额外参数;点击分享消息进入游戏后,可通过 sdkInstance.launchOptions.query 或调用B站原生方法 bl.getLaunchOptionsSync() 获取该信息
success function -- 分享成功的回调函数
fail function -- 分享失败的回调函数
complete function -- 分享完成的回调函数,成功或失败均会调用

# 示例代码

注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!

// 当用户的客户端基础库版本过低时,调用此接口将中断用户当前操作并弹出升级提示,不会报错!
sdkInstance.share({
  title: "分享标题,可填写游戏名称",
  desc: "分享描述文案,可填写游戏简介",
  imageUrl: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
  complete: function() {
    // do something here...
  }
});
Last Updated: 2026/4/27 16:36:20