Skip to content

beamable-sdk / api / announcementsGetByObjectId

Function: announcementsGetByObjectId()

announcementsGetByObjectId(requester, objectId, include_deleted?, gamertag?): Promise<HttpResponse<AnnouncementQueryResponse>>

Defined in: src/__generated__/apis/AnnouncementsApi.ts:276

Parameters

requester

HttpRequester

The HttpRequester type to use for the API request.

objectId

Gamertag of the player.Underlying objectId type is integer in format int64.

string | bigint

include_deleted?

boolean

The include_deleted 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<AnnouncementQueryResponse>>

Remarks

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