Class LevelListAPI

A Level is a Location – so if it is visible, you can use its ID in the Location API as well.

Hierarchy

APIBase
- LevelListAPI

Index

Constructors

Properties

apiClient options

Methods

getDetail getList setApiUrl

Constructors

constructor

new LevelListAPI(apiClient: APIClient, options: ClientOptions): LevelListAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns LevelListAPI
Overrides APIBase.constructor
- Defined in api/LevelListAPI.ts:12

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getDetail

getDetail(id: number, options?: LevelListOptions): Promise<Level>
Parameters
- id: number
- Optionaloptions: LevelListOptions
Returns Promise<Level>
- Defined in api/LevelListAPI.ts:16

getList

getList(options?: LevelListOptions): Promise<Level[]>
Parameters
- Optionaloptions: LevelListOptions
Returns Promise<Level[]>
- Defined in api/LevelListAPI.ts:22

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:18