beamable-sdk / api / groupUsersGetAvailabilityByObjectId
Function: groupUsersGetAvailabilityByObjectId()¶
groupUsersGetAvailabilityByObjectId(
requester,objectId,type,name?,subGroup?,tag?,gamertag?):Promise<HttpResponse<AvailabilityResponse>>
Defined in: src/__generated__/apis/GroupUsersApi.ts:37
Parameters¶
requester¶
The HttpRequester type to use for the API request.
objectId¶
Gamertag of the player.Underlying objectId type is integer in format int64.
string | bigint
type¶
The type parameter to include in the API request.
name?¶
string
The name parameter to include in the API request.
subGroup?¶
boolean
The subGroup parameter to include in the API request.
tag?¶
string
The tag 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<AvailabilityResponse>>
Remarks¶
Authentication:
This method requires a valid bearer token in the Authorization header.