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

    接口 GetLeaderboardListPayload

    cloud.leaderboard.getList 的分页参数。

    只接受 key、limit 与 cursor;额外字段会以 INVALID_PARAMS 拒绝。排序方向与列表名次 范围由榜单创建配置决定,不能通过此对象传入 order、rankLimit 或用户身份。

    interface GetLeaderboardListPayload {
        cursor?: string;
        key?: string;
        limit?: number;
    }
    索引

    属性

    cursor?: string

    上一页返回的不透明分页游标;首屏省略。

    传入时必须是字符串。只能把同一榜单上一页返回的值原样传回,不能解析、修改、构造、 持久化为页码或跨榜单复用;续页时应保持相同的 key 和 limit。

    key?: string

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

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

    limit?: number

    本页最多请求的记录数,默认 20。

    必须是 1 至 100(含边界)的有限整数;0、负数、小数、NaN、Infinity 和 超过 100 的值会以 INVALID_PARAMS 拒绝。实际 entries.length 可能因到达末页或 榜单 rankLimit 展示边界而小于 limit,不能据此推断是否还有下一页。