beamable-sdk / api / leaderboardsGetListBasic
Function: leaderboardsGetListBasic()¶
leaderboardsGetListBasic(
requester,includePartitions?,limit?,prefix?,skip?,gamertag?):Promise<HttpResponse<LeaderboardListResponse>>
Defined in: src/__generated__/apis/LeaderboardsApi.ts:44
Parameters¶
requester¶
The HttpRequester type to use for the API request.
includePartitions?¶
boolean
The includePartitions parameter to include in the API request.
limit?¶
number
The limit parameter to include in the API request.
prefix?¶
string
The prefix parameter to include in the API request.
skip?¶
number
The skip parameter to include in the API request.
gamertag?¶
string
Override the Gamer Tag of the player. This is generally inferred by the auth token.
Returns¶
Promise<HttpResponse<LeaderboardListResponse>>
Remarks¶
Authentication:
This method requires a valid bearer token in the Authorization header.