@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...
    • 复制当前小程序的通用分享链接,并返回该链接。

      参数

      • 可选options: MiniProgramCopyLinkOptions

        可选配置;只接受本次链接需要携带的 extra。省略 options 或 options.extra 时生成不带扩展数据的链接。

      返回 Promise<string>

      Host 完成剪贴板写入后 resolve 的完整分享链接;返回字符串与剪贴板内容一致。

      HbMiniProgramSDKError 参数、extra 编码或小程序身份不合法时返回 INVALID_PARAMS;当前运行快照缺少或未启用 share 权限时分别返回 PERMISSION_NOT_IN_SNAPSHOT 或 PERMISSION_DENIED;当前 Host 未开放剪贴板能力时可返回 METHOD_FORBIDDEN 或 REQUEST_UNSUPPORTED。握手、bridge 超时和其他 Host 写入失败会保留 对应错误码。

      该方法生成当前小程序的固定通用落地页,不复制当前页面路径或 hash,也不继承启动 URL 中已有的 extra。显式传入的 extra 会按 MiniProgramShareExtraValue 约束编码为 Base64URL 参数;接收方使用 share.getExtra 还原值。

      该调用需要在 package.json#heybox.permissions 声明并启用 share,但不额外要求 clipboard 权限或可信用户手势。它只写入系统剪贴板,不会打开分享面板或自动显示成功 提示;需要直接打开分享面板时使用 share.showShareMenu。

      import hbSDK from '@heybox/hb-sdk'

      const copiedUrl = await hbSDK.share.copyLink({
      extra: { page: 'ranking', season: 12 },
      })

      console.log('已复制分享链接', copiedUrl)

      0.7.4

      android

      ios

      ohos

      windows

      macos

      android none

      ios none

      ohos none

      windows none

      macos none