Class: default

client/apis/GamesAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• canSelfInviteUserToVIPServer
• createVIPServer
• getGameFavoriteCount
• getGameGamePasses
• getGameRecommendationsByAlgorithm
• getGameRecommendationsByGame
• getGameServersByType
• getGameSorts
• getGames
• getGamesProductInfo
• getGamesVotes
• getMultiGamesPlayabilityStatus
• getMultiPlaces
• getSelfGameVote
• getVIPServer
• isGameFavorited
• listGames
• request
• setSelfGameVote
• toggleGameFavorite
• updateVIPServer
• updateVIPServerPermissions
• updateVIPServerSubscription

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/GamesAPI.ts:265

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

canSelfInviteUserToVIPServer

▸ canSelfInviteUserToVIPServer(options: CanSelfInviteUserToVIPServerOptions): Promise<CanSelfInviteUserToVIPServer>

Parameters:

Name	Type
options	CanSelfInviteUserToVIPServerOptions

Returns: Promise<CanSelfInviteUserToVIPServer>

Defined in: client/apis/GamesAPI.ts:494

---

createVIPServer

▸ createVIPServer(options: CreateVIPServerOptions): Promise<GameServer>

Parameters:

Name	Type
options	CreateVIPServerOptions

Returns: Promise<GameServer>

Defined in: client/apis/GamesAPI.ts:530

---

getGameFavoriteCount

▸ getGameFavoriteCount(options: GetGameFavoriteCountOptions): Promise<GetGameFavoriteCount>

Parameters:

Name	Type
options	GetGameFavoriteCountOptions

Returns: Promise<GetGameFavoriteCount>

Defined in: client/apis/GamesAPI.ts:433

---

getGameGamePasses

▸ getGameGamePasses(options: GetGameGamePassesOptions): Promise<GetGameGamePasses>

Parameters:

Name	Type
options	GetGameGamePassesOptions

Returns: Promise<GetGameGamePasses>

Defined in: client/apis/GamesAPI.ts:444

---

getGameRecommendationsByAlgorithm

▸ getGameRecommendationsByAlgorithm(options: GetGameRecommendationsByAlgorithmOptions): Promise<GetGameRecommendationsByAlgorithm>

Parameters:

Name	Type
options	GetGameRecommendationsByAlgorithmOptions

Returns: Promise<GetGameRecommendationsByAlgorithm>

Defined in: client/apis/GamesAPI.ts:363

---

getGameRecommendationsByGame

▸ getGameRecommendationsByGame(options: GetGameRecommendationsByGameOptions): Promise<GetGameRecommendationsByAlgorithm>

Parameters:

Name	Type
options	GetGameRecommendationsByGameOptions

Returns: Promise<GetGameRecommendationsByAlgorithm>

Defined in: client/apis/GamesAPI.ts:378

---

getGameServersByType

▸ getGameServersByType(options: GetGameServersByTypeOptions): Promise<GetGameServersByType>

Parameters:

Name	Type
options	GetGameServersByTypeOptions

Returns: Promise<GetGameServersByType>

Defined in: client/apis/GamesAPI.ts:285

---

getGameSorts

▸ getGameSorts(options: GetGameSortsOptions): Promise<GetGameSorts>

Parameters:

Name	Type
options	GetGameSortsOptions

Returns: Promise<GetGameSorts>

Defined in: client/apis/GamesAPI.ts:393

---

getGames

▸ getGames(options: GetGameUniversesOptions): Promise<GetGameUniverses>

Parameters:

Name	Type
options	GetGameUniversesOptions

Returns: Promise<GetGameUniverses>

Defined in: client/apis/GamesAPI.ts:273

---

getGamesProductInfo

▸ getGamesProductInfo(options: GetGamesProductInfoOptions): Promise<GameGamesProductInfo>

Parameters:

Name	Type
options	GetGamesProductInfoOptions

Returns: Promise<GameGamesProductInfo>

Defined in: client/apis/GamesAPI.ts:297

---

getGamesVotes

▸ getGamesVotes(options: GetGamesVotesOptions): Promise<GetGamesVotes>

Parameters:

Name	Type
options	GetGamesVotesOptions

Returns: Promise<GetGamesVotes>

Defined in: client/apis/GamesAPI.ts:467

---

getMultiGamesPlayabilityStatus

▸ getMultiGamesPlayabilityStatus(options: MultiGetGameUniversesPlayabilityOptions): Promise<MultiGetGameUniversesPlayability>

Parameters:

Name	Type
options	MultiGetGameUniversesPlayabilityOptions

Returns: Promise<MultiGetGameUniversesPlayability>

Defined in: client/apis/GamesAPI.ts:351

---

getMultiPlaces

▸ getMultiPlaces(options: MultiGetPlacesOptions): Promise<MultiGetPlaces>

Parameters:

Name	Type
options	MultiGetPlacesOptions

Returns: Promise<MultiGetPlaces>

Defined in: client/apis/GamesAPI.ts:338

---

getSelfGameVote

▸ getSelfGameVote(options: GetSelfUniverseVoteStatusOptions): Promise<GetSelfUniverseVoteStatus>

Parameters:

Name	Type
options	GetSelfUniverseVoteStatusOptions

Returns: Promise<GetSelfUniverseVoteStatus>

Defined in: client/apis/GamesAPI.ts:456

---

getVIPServer

▸ getVIPServer(options: GetVIPServerOptions): Promise<VIPServerOptions>

Parameters:

Name	Type
options	GetVIPServerOptions

Returns: Promise<VIPServerOptions>

Defined in: client/apis/GamesAPI.ts:505

---

isGameFavorited

▸ isGameFavorited(options: IsGameFavoritedOptions): Promise<IsGameFavorited>

Parameters:

Name	Type
options	IsGameFavoritedOptions

Returns: Promise<IsGameFavorited>

Defined in: client/apis/GamesAPI.ts:407

---

listGames

▸ listGames(options: ListGamesOptions): Promise<ListGames>

Parameters:

Name	Type
options	ListGamesOptions

Returns: Promise<ListGames>

Defined in: client/apis/GamesAPI.ts:309

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

setSelfGameVote

▸ setSelfGameVote(options: SetSelfGameVoteOptions): Promise<unknown>

Parameters:

Name	Type
options	SetSelfGameVoteOptions

Returns: Promise<unknown>

Defined in: client/apis/GamesAPI.ts:479

---

toggleGameFavorite

▸ toggleGameFavorite(options: ToggleGameFavoriteOptions): Promise<unknown>

Parameters:

Name	Type
options	ToggleGameFavoriteOptions

Returns: Promise<unknown>

Defined in: client/apis/GamesAPI.ts:418

---

updateVIPServer

▸ updateVIPServer(options: UpdateVIPServerOptions): Promise<VIPServerOptions>

Parameters:

Name	Type
options	UpdateVIPServerOptions

Returns: Promise<VIPServerOptions>

Defined in: client/apis/GamesAPI.ts:517

---

updateVIPServerPermissions

▸ updateVIPServerPermissions(options: UpdateVIPServerPermissionsOptions): Promise<UpdateVIPServerPermissions>

Parameters:

Name	Type
options	UpdateVIPServerPermissionsOptions

Returns: Promise<UpdateVIPServerPermissions>

Defined in: client/apis/GamesAPI.ts:543

---

updateVIPServerSubscription

▸ updateVIPServerSubscription(options: UpdateVIPServerSubscriptionOptions): Promise<UpdateVIPServerSubscription>

Parameters:

Name	Type
options	UpdateVIPServerSubscriptionOptions

Returns: Promise<UpdateVIPServerSubscription>

Defined in: client/apis/GamesAPI.ts:556