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

    接口 GetSteamGameListOptions

    Steam 游戏库查询与 offset 分页参数。

    Runtime 会拒绝未知字段和类型不匹配的值,不会把数字字符串或 0 / 1 自动转换为 number / boolean。所有默认值和规范化均在 Host 发出 Steam 请求前完成。

    interface GetSteamGameListOptions {
        includeHidden?: boolean;
        limit?: number;
        offset?: number;
        q?: string;
        sort?: SteamGameListSort;
        steamId?: string;
    }
    索引

    属性

    includeHidden?: boolean

    是否包含当前用户隐藏的游戏,默认 false;只接受 boolean,不接受 0 / 1。

    limit?: number

    单页数量,默认 20;必须是大于等于 1 的整数,大于 100 时按 100 查询。

    offset?: number

    分页偏移量,默认 0;必须是大于等于 0 的整数,不接受数字字符串。

    q?: string

    游戏名称搜索词。Runtime 会先 trim,再保留前 100 个 UTF-16 code unit;trim 后为空时 不向服务端发送 q,等价于不按关键词过滤。

    排序维度,默认 weeks;只接受大小写完全一致的 weeks、all 或 achieved。

    steamId?: string

    要查询的 Steam ID;省略时使用当前小黑盒用户的默认绑定账号。 首尾空白会被移除,trim 后为空会以 INVALID_PARAMS 拒绝。