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

    接口 GetLeaderboardInfoResult

    排行榜创建时确定的基础配置。

    该结果不包含记录、当前用户、记录总数、分页游标或可修改配置。order 与 rankLimit 只能通过平台管理流程配置,不能在运行时查询参数中覆盖。

    interface GetLeaderboardInfoResult {
        key: string;
        order: LeaderboardOrder;
        rankLimit: number;
    }
    索引

    属性

    key: string

    服务端实际解析的榜单 key。省略请求 key 时通常为 default;显式请求时必须与请求值 一致,否则 Runtime 以 INVALID_RESPONSE 拒绝响应。

    排行榜排序与“更优分数”的方向:desc 表示分数越大名次越靠前,submit() 只用更高 分更新记录;asc 表示分数越小越靠前,submit() 只用更低分更新记录。

    rankLimit: number

    getList() 可展示的名次上限,必须是非负整数;0 表示列表不设置名次上限。

    它不是记录数量上限、分页大小或清理策略:超出范围的记录仍保存,getList({ limit }) 的 limit 只控制单页数量,不能突破非零 rankLimit。当前用户记录的 ranked 还同时 受前 5000 名精确排名上限约束;因此 rankLimit: 0 时仍可能得到 ranked: false, rank: 0。