HLOApiClient | HeroLab Online API Client

Client class for the Hero Lab Online API.

Hierarchy

HLOApiClient

Index

Constructors

constructor

Methods

Constructors

constructor

new HLOApiClient(options: string | APIConfiguration, fetchInstance?: (input?: string | Request, init?: RequestInit) => Promise<Response>): HLOApiClient

- Defined in src/api.ts:142
Create a new API instance.

Parameters
- options: string | APIConfiguration
- Optional fetchInstance: (input?: string | Request, init?: RequestInit) => Promise<Response>
  
  Fetch implementation to be used by this API instance.
  - - (input?: string | Request, init?: RequestInit): Promise<Response>
    - Parameters
      - Optional input: string | Request
      - Optional init: RequestInit
      Returns Promise<Response>
Returns HLOApiClient

Methods

acquireAccessToken

acquireAccessToken(request?: AcquireAccessTokenRequest, setAccessToken?: boolean): Promise<AcquireAccessTokenResponse>

- Defined in src/api.ts:215
Acquire an access token.

Parameters
- Optional request: AcquireAccessTokenRequest
  
  Request data.
- setAccessToken: boolean = true
  
  Set the new access token for this API instance if the request was successful.
Returns Promise<AcquireAccessTokenResponse>

Response data.

getCharacter

getCharacter(request: string | GetCharacterRequest): Promise<GetCharacterResponse>

- Defined in src/api.ts:278
Read a single character.

Parameters
- request: string | GetCharacterRequest
  
  Element token or full request.
Returns Promise<GetCharacterResponse>

Response data with character information.

getCharacters

getCharacters(request: GetCharacterBulkRequest | string[]): Promise<GetCharacterBulkResponse>

- Defined in src/api.ts:293
Read multiple characters in bulk.

Parameters
- request: GetCharacterBulkRequest | string[]
  
  Array of element tokens or full request.
Returns Promise<GetCharacterBulkResponse>

Response data with character information.

getPlayerCharacters

getPlayerCharacters(request: string | GetCastListRequest): Promise<GetCastListResponse>

- Defined in src/api.ts:361
Obtain the player characters that currently reside on a campaign's stage.

Parameters
- request: string | GetCastListRequest
  
  Campaign token or full request.
Returns Promise<GetCastListResponse>

Response containing cast list.

getStage

getStage(request: string | GetCastListRequest): Promise<GetCastListResponse>

- Defined in src/api.ts:351
Obtain the cast members that currently reside on a campaign's stage.

Parameters
- request: string | GetCastListRequest
  
  Campaign token or full request.
Returns Promise<GetCastListResponse>

Response containing cast list.

setAccessToken

setAccessToken(accessToken: string): HLOApiClient

- Defined in src/api.ts:252
Set the access token directly.

Parameters
- accessToken: string
  
  Access token for the HeroLab Online API.
Returns HLOApiClient

This API instance for method chaining.

verifyAccessToken

verifyAccessToken(request?: HLOApiRequest): Promise<HLOApiResponse>

- Defined in src/api.ts:263
Verify that the access token is still valid.

Parameters
- Optional request: HLOApiRequest
  
  Request data.
Returns Promise<HLOApiResponse>

Response data.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

options: string | APIConfiguration

Optional fetchInstance: (input?: string | Request, init?: RequestInit) => Promise<Response>

Parameters

Optional input: string | Request

Optional init: RequestInit

Returns Promise<Response>

Returns HLOApiClient

Methods

acquireAccessToken

Parameters

Optional request: AcquireAccessTokenRequest

setAccessToken: boolean = true

Returns Promise<AcquireAccessTokenResponse>

getCharacter

Parameters

request: string | GetCharacterRequest

Returns Promise<GetCharacterResponse>

getCharacters

Parameters

request: GetCharacterBulkRequest | string[]

Returns Promise<GetCharacterBulkResponse>

getPlayerCharacters

Parameters

request: string | GetCastListRequest

Returns Promise<GetCastListResponse>

getStage

Parameters

request: string | GetCastListRequest

Returns Promise<GetCastListResponse>

setAccessToken

Parameters

accessToken: string

Returns HLOApiClient

verifyAccessToken

Parameters

Optional request: HLOApiRequest

Returns Promise<HLOApiResponse>