Class MeshAPI

Hierarchy

APIBase
- MeshAPI

Index

Constructors

Properties

apiClient options

Methods

getFirmwareById getMap listFirmwares listMessages setApiUrl

Constructors

constructor

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

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getFirmwareById

getFirmwareById(firmwareId: number): Promise<MeshFirmware>
Parameters
- firmwareId: number
Returns Promise<MeshFirmware>
- Defined in api/MeshAPI.ts:13

getMap

getMap(levelId: number): Promise<MeshMap>
Parameters
- levelId: number
Returns Promise<MeshMap>
- Defined in api/MeshAPI.ts:19

listFirmwares

listFirmwares(
limit?: number,
offset?: number,
): Promise<MeshListResponse<MeshFirmware>>
Parameters
- Optionallimit: number
- Optionaloffset: number
Returns Promise<MeshListResponse<MeshFirmware>>
- Defined in api/MeshAPI.ts:25

listMessages

listMessages(
limit?: number,
offset?: number,
): Promise<MeshListResponse<MeshMessage>>
Parameters
- Optionallimit: number
- Optionaloffset: number
Returns Promise<MeshListResponse<MeshMessage>>
- Defined in api/MeshAPI.ts:40

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