Class ApiClient

Represents a basic contract for API request execution

export
interface: ApiClient

Hierarchy

ApiClient

Implemented by

DefaultApiClient

Index

Constructors

constructor

Properties

apiConfiguration

Methods

invoke

Constructors

Protected constructor

new ApiClient(apiConfiguration: ApiConfiguration): ApiClient

- Defined in gameon-sdk/src/client/api/apiClient.ts:73
Creates new instance of the ApiClient

Parameters
- apiConfiguration: ApiConfiguration
  
  configuration parameter to provide dependencies to service client instance
Returns ApiClient

Properties

Protected apiConfiguration

apiConfiguration: ApiConfiguration

ApiConfiguration instance to provide dependencies for this service client

Methods

invoke

invoke(request: ApiClientRequest): Promise<ApiClientResponse>

- Defined in gameon-sdk/src/client/http/apiClient.ts:58
Dispatches a request to an API endpoint described in the request. An ApiClient is expected to resolve the Promise in the case an API returns a non-200 HTTP status code. The responsibility of translating a particular response code to an error lies with the caller to invoke.

memberof

ApiClient

Parameters
- request: ApiClientRequest
  
  request to dispatch to the ApiClient
Returns Promise<ApiClientResponse>

Response from the ApiClient

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