@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...

    接口 MiniProgramScreenshotOptions

    截图分享配置。

    该配置只暴露截图、保存相册与水印主题字段，不暴露宿主内部上传、回调或其他样式扩展能力。 所有字段均可省略；省略整个配置等同于传入空配置，并在调用时截取当前可见窗口。 JavaScript 调用在运行时传入 null 也会按空配置处理，但 TypeScript 调用方应直接省略参数。

    share.screenshot

    interface MiniProgramScreenshotOptions {
        delay?: number;
        post?: MiniProgramSharePostOptions | null;
        rect?: MiniProgramScreenshotRect;
        saveToAlbum?: boolean;
        watermarkTheme?: "light" | "dark";
    }
    索引

    属性

    delay? post? rect? saveToAlbum? watermarkTheme?

    属性

    delay?: number

    Host 开始截图前的延迟，单位毫秒；TypeScript 调用应传 number，Runtime 用 Number(...) 转换后要求有限且大于等于 0。

    Runtime 不要求整数，也不设置上限。省略时不会下发 delay，由当前 Host 使用默认值； Host 仍可按平台能力拒绝过大的值。

    可选post

    post?: MiniProgramSharePostOptions | null

    转发到社区时使用的分区与话题预置；null 或省略表示不预置。

    截图分享支持多个分区。topicIds 中的正安全整数会转成字符串，字符串会 trim， 再按首次出现顺序去重；topics 会 trim、拒绝首尾 #，再按首次出现顺序去重。 预置必须至少保留一个有效的 topicIds 或 topics 项。

    开发 Runtime 遇到任一无效项会以 INVALID_PARAMS 拒绝，生产 Runtime 则过滤无效项， 将剩余有效项交给客户端；没有有效项时省略整个 post，但继续截图。预置只填充 客户端发帖页，用户仍可修改或取消，不会直接发布内容。 当前小程序来源由 Runtime 使用 Host 确认的 canonical identity 自动关联，调用方不能 也无需传入小程序 ID 或其他来源字段。

    rect?: MiniProgramScreenshotRect

    指定截图区域；省略时截取调用时的整个可见窗口。

    字段单位、有效范围和窗口边界要求见 MiniProgramScreenshotRect。Runtime 不会 自动按设备像素比换算，也不会裁正越界矩形。

    saveToAlbum?: boolean

    是否在客户端截图分享流程中提供保存到系统相册的能力。

    true 明确请求提供，false 明确关闭。省略时不会下发该开关，由当前 Host 决定 默认行为；该字段本身不表示图片已经保存成功。

    watermarkTheme?: "light" | "dark"

    按截图背景选择水印主题：light 用于浅色背景，显示黑色胶囊与 40% 黑色说明文字； dark 用于深色背景，显示白色胶囊与 40% 白色说明文字。省略时默认为 dark， 保持现有白色水印效果；不会自动跟随 App 或系统主题。其他值会以 INVALID_PARAMS 拒绝。

    仅影响水印配色，不改变小程序页面主题；底部仍需预留至少 57 个逻辑像素。

    显示设置

    成员可见性

    目录

    属性