Skip to content

Module: client/apis/GamesAPI

Table of contents

Classes

Type aliases

Type aliases

CanSelfInviteUserToVIPServer

Ƭ CanSelfInviteUserToVIPServer: object

Type declaration:

Name Type
canInvite boolean

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

CanSelfInviteUserToVIPServerOptions

Ƭ CanSelfInviteUserToVIPServerOptions: object

Type declaration:

Name Type
userId number

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

CreateVIPServer

Ƭ CreateVIPServer: GameServer

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

CreateVIPServerOptions

Ƭ CreateVIPServerOptions: object

Type declaration:

Name Type
expectedPrice number
name string
universeId number

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

GameGamesProductInfo

Ƭ GameGamesProductInfo: object

Type declaration:

Name Type
data { isForSale: boolean ; price: number ; productId: number ; sellerId: number ; universeId: number }[]

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

GameServer

Ƭ GameServer: object

Type declaration:

Name Type
accessCode string
fps number
id string
maxPlayers number
name string
ping number
playing number
vipServerId number

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

GetGameFavoriteCount

Ƭ GetGameFavoriteCount: object

Type declaration:

Name Type
favoritesCount number

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

GetGameFavoriteCountOptions

Ƭ GetGameFavoriteCountOptions: object

Type declaration:

Name Type
universeId number

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

GetGameGamePasses

Ƭ GetGameGamePasses: object

Type declaration:

Name Type
data { displayName: string ; id: number ; name: string ; price: number ; productId: number }[]
nextPageCursor string
previousPageCursor string

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

GetGameGamePassesOptions

Ƭ GetGameGamePassesOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
universeId number

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

GetGameRecommendationsByAlgorithm

Ƭ GetGameRecommendationsByAlgorithm: object

Type declaration:

Name Type
games ListGames[games]
nextPaginationKey string | null

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

GetGameRecommendationsByAlgorithmOptions

Ƭ GetGameRecommendationsByAlgorithmOptions: object

Type declaration:

Name Type
algorithmName string
maxRows? number
paginationKey? string

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

GetGameRecommendationsByGame

Ƭ GetGameRecommendationsByGame: GetGameRecommendationsByAlgorithm

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

GetGameRecommendationsByGameOptions

Ƭ GetGameRecommendationsByGameOptions: object

Type declaration:

Name Type
maxRows? number
paginationKey? string
universeId number

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

GetGameServersByType

Ƭ GetGameServersByType: object

Type declaration:

Name Type
data GameServer[]
nextPageCursor string
previousPageCursor string

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

GetGameServersByTypeOptions

Ƭ GetGameServersByTypeOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
placeId number
serverType Public | Friend | VIP
sortOrder? Asc | Desc

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

GetGameSorts

Ƭ GetGameSorts: object

Type declaration:

Name Type
genreFilters { name: string ; token: string ; tokenExpiryInSeconds: number }[]
pageContext object
pageContext.isSeeAllPage boolean
pageContext.pageId string
sorts { contextCountryRegionId: number ; contextUniverseId: null ; displayName: string ; gameSetTargetId: null ; genreOptionsAvailable: boolean ; isDefaultSort: boolean ; name: string ; numberOfGames: null ; numberOfRows: number ; timeOptionsAvailable: boolean ; token: string ; tokenExpiryInSeconds: number }[]
timeFilters { name: string ; token: string ; tokenExpiryInSeconds: number }[]

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

GetGameSortsOptions

Ƭ GetGameSortsOptions: object

Type declaration:

Name Type
gameSortsContext? GamesDefaultSorts | GamesAllSorts | HomeSorts | ChatSorts | UnifiedHomeSorts | GamesPageAbTestSorts1 | GamesPageAbTestSorts2

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

GetGameUniverses

Ƭ GetGameUniverses: GameUniverseOptions[]

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

GetGameUniversesOptions

Ƭ GetGameUniversesOptions: object

Type declaration:

Name Type
universeIds number[]

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

GetGamesProductInfoOptions

Ƭ GetGamesProductInfoOptions: object

Type declaration:

Name Type
universeIds number[]

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

GetGamesVotes

Ƭ GetGamesVotes: object

Type declaration:

Name Type
data { downVotes: number ; number: PartialGameUniverse ; upVotes: number }[]

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

GetGamesVotesOptions

Ƭ GetGamesVotesOptions: object

Type declaration:

Name Type
universeIds number[]

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

GetSelfUniverseVoteStatus

Ƭ GetSelfUniverseVoteStatus: object

Type declaration:

Name Type
canVote boolean
reasonForNotVoteable string
userVote boolean

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

GetSelfUniverseVoteStatusOptions

Ƭ GetSelfUniverseVoteStatusOptions: object

Type declaration:

Name Type
universeId number

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

GetVIPServer

Ƭ GetVIPServer: VIPServerOptions

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

GetVIPServerOptions

Ƭ GetVIPServerOptions: object

Type declaration:

Name Type
id number

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

IsGameFavorited

Ƭ IsGameFavorited: object

Type declaration:

Name Type
isFavorited boolean

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

IsGameFavoritedOptions

Ƭ IsGameFavoritedOptions: object

Type declaration:

Name Type
universeId number

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

ListGames

Ƭ ListGames: object

Type declaration:

Name Type
algorithm string
algorithmQueryType string
correctedKeyword string
cutOffIndex number
emphasis boolean
featuredSearchUniverseId number
filteredKeyword string
games { analyticsIdentifier: string ; creatorId: number ; creatorName: string ; creatorType: User | Group | string ; downVotes: number ; imageToken: string ; isSponsored: boolean ; nativeAdData: string ; placeId: number ; playerCount: number ; price: number ; universeId: number ; upVotes: number ; users: { gameId: string ; userId: number }[] }[]
hasMoreRows boolean
nextPageExclusiveStartId number
suggestedKeyword string
suggestionAlgorithm string

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

ListGamesOptions

Ƭ ListGamesOptions: object

Type declaration:

Name Type
contextCountryRegionId? number
contextUniverseId? number
exclusiveStartId? number
gameFilter? string
gameSetTargetId? number
genreFilter? string
isKeywordSuggestionEnabled? boolean
keyword? string
maxRows? number
pageContextPageId? number
pageContextSeeAll? boolean
sortOrder? string
sortPosition? number
sortToken? string
startRows? number
timeFilter? string

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

MultiGetGameUniversesPlayability

Ƭ MultiGetGameUniversesPlayability: { isPlayable: boolean ; playabilityStatus: UnplayableOtherReason | string ; universeId: number }[]

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

MultiGetGameUniversesPlayabilityOptions

Ƭ MultiGetGameUniversesPlayabilityOptions: object

Type declaration:

Name Type
universeIds number[]

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

MultiGetPlaces

Ƭ MultiGetPlaces: PlaceOptions[]

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

MultiGetPlacesOptions

Ƭ MultiGetPlacesOptions: object

Type declaration:

Name Type
placeIds number[]

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

SetSelfGameVote

Ƭ SetSelfGameVote: unknown

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

SetSelfGameVoteOptions

Ƭ SetSelfGameVoteOptions: object

Type declaration:

Name Type
universeId number
vote boolean

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

ToggleGameFavorite

Ƭ ToggleGameFavorite: unknown

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

ToggleGameFavoriteOptions

Ƭ ToggleGameFavoriteOptions: object

Type declaration:

Name Type
favorite boolean
universeId number

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

UpdateVIPServer

Ƭ UpdateVIPServer: VIPServerOptions

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

UpdateVIPServerOptions

Ƭ UpdateVIPServerOptions: object

Type declaration:

Name Type
active boolean
id number
name string
newJoinCode boolean

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

UpdateVIPServerPermissions

Ƭ UpdateVIPServerPermissions: object

Type declaration:

Name Type
clanAllowed boolean
enemyClanId number
friendsAllowed boolean
users { displayName: string ; id: number ; name: string }[]

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

UpdateVIPServerPermissionsOptions

Ƭ UpdateVIPServerPermissionsOptions: object

Type declaration:

Name Type
clanAllowed boolean
enemyClanId number
friendsAllowed boolean
id number
usersToAdd number[]
usersToRemove number[]

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

UpdateVIPServerSubscription

Ƭ UpdateVIPServerSubscription: object

Type declaration:

Name Type
active boolean
expirationDate string
expired boolean
price number

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

UpdateVIPServerSubscriptionOptions

Ƭ UpdateVIPServerSubscriptionOptions: object

Type declaration:

Name Type
active boolean
id number
price number

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