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

    接口 SubmitLeaderboardEntryPayload

    cloud.leaderboard.submit 的提交参数。

    同一个小程序、榜单和当前用户最多保留一条记录。该对象只接受 key、score、extra; 额外字段(包括调用方提供的用户 ID、rank 或 order)会以 INVALID_PARAMS 拒绝。当前用户 与小程序 identity 由 Host 和平台注入。

    interface SubmitLeaderboardEntryPayload {
        extra?: Record<string, unknown>;
        key?: string;
        score: number;
    }
    索引

    属性

    extra?: Record<string, unknown>

    随被保留分数一起保存的公开展示附加信息。

    必须是非 null、非数组且可 JSON 序列化的对象。完整 JSON(含属性名、引号、转义和 结构字符)按 UTF-8 计算最多 2048 bytes;超限、循环引用或 BigInt 会以 INVALID_PARAMS 拒绝。函数、Symbol 等不能通过 iframe structured clone 的成员可能在 请求到达 Runtime 前触发 DataCloneError。应只传普通 JSON 数据。

    首次提交省略 extra 时平台保存并返回 {}。已有记录收到更优分数时,省略此字段会 保留旧 extra,显式传 {} 才会清空;分数同分或更差时,即使传入新 extra 也不会更新。 extra 会随 getList() 返回给其他读取者,不要放入 token、邮箱、外部账号、设备标识 或其他非必要敏感信息。

    key?: string

    排行榜 key;省略时使用当前小程序已创建的 default 榜单。

    必须匹配 /^[A-Za-z0-9_-]{1,64}$/,即 1 至 64 位 ASCII 字母、数字、下划线或 连字符。空字符串、空格、中文、点号、路径分隔符或超长 key 会在读取 Host 登录态和 发起网络请求前以 INVALID_PARAMS 拒绝。default 榜单也必须预先创建。

    score: number

    本次提交分数;没有默认值。

    必须是有限 number,且绝对值不超过 Number.MAX_SAFE_INTEGER。负数、0 和小数均 可用;数字字符串、NaN、正负 Infinity 或超出安全精度范围的值会以 INVALID_PARAMS 拒绝。分数是唯一排名字段,extra 不参与比较。