Class GameOnApiClient

Hierarchy

  • ApiClient
    • GameOnApiClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected apiConfiguration

apiConfiguration: ApiConfiguration

ApiConfiguration instance to provide dependencies for this service client

Methods

addAttempts

addPlayerTournament

authPlayer

claimPrizeList

enterMatch

enterPlayerTournament

enterTournament

fulfillPrizeList

getMatchDetails

  • getMatchDetails(matchId: string, sessionId: string, xApiKey: string, playerAttributes?: undefined | string): Promise<GetMatchDetailsResponse>

getMatchLeaderboard

  • getMatchLeaderboard(matchId: string, xApiKey: string, sessionId?: undefined | string, limit?: undefined | string, currentPlayerNeighbors?: undefined | string, cursor?: undefined | string): Promise<GetMatchLeaderboardResponse>

getMatchList

  • getMatchList(xApiKey: string, sessionId: string, matchType?: undefined | string, limit?: undefined | string, playerAttributes?: undefined | string, period?: undefined | string, filterBy?: undefined | string): Promise<GetMatchListResponse>

getPlayerTournamentDetails

getPlayerTournamentList

  • getPlayerTournamentList(xApiKey: string, sessionId: string, queryBy?: undefined | string, limit?: undefined | string, cursor?: undefined | string, streamingPlatform?: undefined | string, period?: undefined | string, filterBy?: undefined | string): Promise<GetPlayerTournamentListResponse>

getPrizeDetails

getTeamDetails

getTournamentDetails

  • getTournamentDetails(sessionId: string, tournamentId: string, xApiKey: string, playerAttributes?: undefined | string): Promise<GetTournamentDetailsResponse>

getTournamentList

  • getTournamentList(xApiKey: string, sessionId: string, limit?: undefined | string, participantType?: undefined | string, playerAttributes?: undefined | string, period?: undefined | string, filterBy?: undefined | string): Promise<GetTournamentListResponse>

Protected invoke

  • invoke(method: string, endpoint: string, path: string, pathParams: Map<string, string>, queryParams: Map<string, string>, headerParams: Array<object>, bodyParam: any, errors: Map<number, string>): Promise<any>

  • Invocation wrapper to implement service operations in generated classes

    Parameters

    • method: string

      HTTP method, such as 'POST', 'GET', 'DELETE', etc.

    • endpoint: string

      base API url

    • path: string

      the path pattern with possible placeholders for path parameters in form {paramName}

    • pathParams: Map<string, string>

      path parameters collection

    • queryParams: Map<string, string>

      query parameters collection

    • headerParams: Array<object>

      headers collection

    • bodyParam: any

      if body parameter is present it is provided here, otherwise null or undefined

    • errors: Map<number, string>

      maps recognized status codes to messages

    Returns Promise<any>

matchesMatchIdAttemptsOptions

  • matchesMatchIdAttemptsOptions(): Promise<void>

matchesMatchIdEnterOptions

  • matchesMatchIdEnterOptions(): Promise<void>

matchesMatchIdLeaderboardOptions

  • matchesMatchIdLeaderboardOptions(): Promise<void>

matchesMatchIdOptions

  • matchesMatchIdOptions(): Promise<void>

matchesMatchIdScoreOptions

  • matchesMatchIdScoreOptions(): Promise<void>

matchesOptions

  • matchesOptions(): Promise<void>

playerTournamentsOptions

  • playerTournamentsOptions(): Promise<void>

playerTournamentsTournamentIdEnterOptions

  • playerTournamentsTournamentIdEnterOptions(): Promise<void>

playerTournamentsTournamentIdOptions

  • playerTournamentsTournamentIdOptions(): Promise<void>

playersAuthOptions

  • playersAuthOptions(): Promise<void>

playersOptions

  • playersOptions(): Promise<void>

playersPatch

  • playersPatch(xApiKey: string, sessionId?: undefined | string): Promise<void>

playersPut

  • playersPut(sessionId: string, xApiKey: string): Promise<void>

playersRegisterOptions

  • playersRegisterOptions(): Promise<void>

playersStreamingPlatformAccountLinkingCodeOptions

  • playersStreamingPlatformAccountLinkingCodeOptions(): Promise<void>

prizesClaimOptions

  • prizesClaimOptions(): Promise<void>

prizesFulfillOptions

  • prizesFulfillOptions(): Promise<void>

prizesPrizeIdOptions

  • prizesPrizeIdOptions(): Promise<void>

registerPlayer

submitScore

  • submitScore(matchId: string, sessionId: string, xApiKey: string, submitScoreRequest: SubmitScoreRequest): Promise<void>

teamsTeamIdOptions

  • teamsTeamIdOptions(): Promise<void>

tournamentsOptions

  • tournamentsOptions(): Promise<void>

tournamentsTournamentIdEnterOptions

  • tournamentsTournamentIdEnterOptions(): Promise<void>

tournamentsTournamentIdOptions

  • tournamentsTournamentIdOptions(): Promise<void>

updatePlayerTournament

updatePlayerTournament_0

useStreamingPlatformAccountLinkingCode

Brought to you with ❤ by the Alexa Games team at Amazon. © 2019, Amazon.com, Inc. or its affiliates. All Rights Reserved.