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

    接口 LeaderboardEntry

    平台托管的排行榜记录。

    一个用户在一个榜单中最多对应一条记录。rank 只有在 ranked 为 true 时才是可展示的名次;否则必须把记录视为“已保存但当前没有精确名次”。

    interface LeaderboardEntry {
        appUserId: string;
        createdAt: number;
        extra: Record<string, unknown>;
        rank: number;
        ranked: boolean;
        score: number;
        updatedAt: number;
    }
    索引

    属性

    appUserId: string

    当前小程序内稳定且隔离的用户标识,由平台注入,前端不能传入或推断。

    createdAt: number

    服务端返回的记录创建时间戳;当前公开合同不承诺单位或时钟来源。

    extra: Record<string, unknown>

    展示附加信息;会随列表返回给有权读取该榜单的用户,不参与排序和查询。

    rank: number

    排名;未进入展示范围或超出当前用户排名计算上限时为 0。

    ranked: boolean

    是否同时进入榜单展示范围并位于当前用户排名计算上限内。

    score: number

    分数;排行榜唯一排序字段,extra 不参与排序。

    updatedAt: number

    服务端返回的记录更新时间戳;当前公开合同不承诺单位或时钟来源。