beamable-sdk / api / groupUsersGetSearchByObjectId
Function: groupUsersGetSearchByObjectId()¶
groupUsersGetSearchByObjectId(
requester,objectId,type,enrollmentTypes?,hasSlots?,limit?,name?,offset?,scoreMax?,scoreMin?,sortField?,sortValue?,subGroup?,userScore?,gamertag?):Promise<HttpResponse<GroupSearchResponse>>
Defined in: src/__generated__/apis/GroupUsersApi.ts:176
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.
enrollmentTypes?¶
string
The enrollmentTypes parameter to include in the API request.
hasSlots?¶
boolean
The hasSlots parameter to include in the API request.
limit?¶
number
The limit parameter to include in the API request.
name?¶
string
The name parameter to include in the API request.
offset?¶
number
The offset parameter to include in the API request.
scoreMax?¶
The scoreMax parameter to include in the API request.
string | bigint
scoreMin?¶
The scoreMin parameter to include in the API request.
string | bigint
sortField?¶
string
The sortField parameter to include in the API request.
sortValue?¶
number
The sortValue parameter to include in the API request.
subGroup?¶
boolean
The subGroup parameter to include in the API request.
userScore?¶
The userScore 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<GroupSearchResponse>>
Remarks¶
Authentication:
This method requires a valid bearer token in the Authorization header.