Skip to content

beamable-sdk / api / leaderboardsGetAssignmentBasic

Function: leaderboardsGetAssignmentBasic()

leaderboardsGetAssignmentBasic(requester, boardId, joinBoard?, gamertag?): Promise<HttpResponse<LeaderboardAssignmentInfo>>

Defined in: src/__generated__/apis/LeaderboardsApi.ts:100

Parameters

requester

HttpRequester

The HttpRequester type to use for the API request.

boardId

string

The boardId parameter to include in the API request.

joinBoard?

boolean

The joinBoard 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<LeaderboardAssignmentInfo>>

Remarks

Authentication: This method requires a valid bearer token in the Authorization header.