beamable-sdk / api / leaderboardsGetViewByObjectId
Function: leaderboardsGetViewByObjectId()¶
leaderboardsGetViewByObjectId(
requester,objectId,focus?,friends?,from?,guild?,max?,outlier?,gamertag?):Promise<HttpResponse<LeaderBoardViewResponse>>
Defined in: src/__generated__/apis/LeaderboardsApi.ts:511
Parameters¶
requester¶
The HttpRequester type to use for the API request.
objectId¶
string
Gamertag of the player.
focus?¶
The focus parameter to include in the API request.
string | bigint
friends?¶
boolean
The friends parameter to include in the API request.
from?¶
number
The from parameter to include in the API request.
guild?¶
boolean
The guild parameter to include in the API request.
max?¶
number
The max parameter to include in the API request.
outlier?¶
The outlier parameter to include in the API request.
string | bigint
gamertag?¶
string
Override the Gamer Tag of the player. This is generally inferred by the auth token.
Returns¶
Promise<HttpResponse<LeaderBoardViewResponse>>
Remarks¶
Authentication:
This method requires a valid bearer token in the Authorization header.