# Class: Leaderboard
• Leaderboard()
排行榜信息
# Properties
# Readonly playerRankInfos
• playerRankInfos: PlayerRankInfo[]
(排行榜内)玩家列表
Returns: PlayerRankInfo[]
# total
• total: number
排行榜总人数
Returns: number
# Readonly type
• type: number
排行榜类型
Returns: number
# 事件监听
# offLoadMore
▸ offLoadMore(handler?: LeaderboardLoadMoreEventHandler): void
取消注册 当前排行榜加载更多 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler? | LeaderboardLoadMoreEventHandler |
# 返回值:
void
# offRefresh
▸ offRefresh(handler?: LeaderboardRefreshEventHandler): void
取消注册 当前排行榜刷新 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler? | LeaderboardRefreshEventHandler |
# 返回值:
void
# onLoadMore
▸ onLoadMore(handler: LeaderboardLoadMoreEventHandler): void
注册 当前排行榜加载更多 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler | LeaderboardLoadMoreEventHandler |
# 返回值:
void
# onRefresh
▸ onRefresh(handler: LeaderboardRefreshEventHandler): void
注册 当前排行榜刷新 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler | LeaderboardRefreshEventHandler |
# 返回值:
void
# 操作触发
# getSelfRankInfo
▸ getSelfRankInfo(params?: Omit‹GetSelfRankInfoParams, "type"›): Promise‹GetSelfRankInfoRes›
获取当前用户在该排行榜内的信息
throws {@link MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params? | Omit‹GetSelfRankInfoParams, "type"› |
# 返回值:
Promise‹GetSelfRankInfoRes›
# loadMore
▸ loadMore(params?: LoadMoreParams): Promise‹LoadMoreRes›
加载更多排行榜数据
# 参数:
| 属性 | 类型 |
|---|---|
params? | LoadMoreParams |
LoadMoreParams
| 属性 | 类型 | 描述 |
|---|---|---|
amount? | number | 拉取数量 |
complete? | Method | 操作完成时(成功或失败)，均会调用该回调函数 |
fail? | Method | 操作失败时，调用该回调函数 |
success? | Method | 操作成功时，调用该回调函数 |
# 返回值:
Promise‹LoadMoreRes›
# refresh
▸ refresh(params?: RefreshParams): Promise‹RefreshRes›
(全量)刷新排行榜
# 参数:
| 属性 | 类型 |
|---|---|
params? | RefreshParams |
RefreshParams
| 属性 | 类型 | 描述 |
|---|---|---|
amount? | number | 拉取数量 |
complete? | Method | 操作完成时(成功或失败)，均会调用该回调函数 |
fail? | Method | 操作失败时，调用该回调函数 |
success? | Method | 操作成功时，调用该回调函数 |
# 返回值:
Promise‹RefreshRes›
# uploadRankValue
▸ uploadRankValue(params: Omit‹UploadRankValueParams, "type"›): Promise‹UploadRankValueRes›
上报排行榜数值
description 可以用于上报"分数"等可用于比对排行的数值。如果需要上报时同时上报给平台，需要在 MOGS.json 中配置上报到游戏平台排行榜相关配置
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹UploadRankValueParams, "type"› |
# 返回值:
Promise‹UploadRankValueRes›