Class PositioningAPI

Hierarchy

APIBase
- PositioningAPI

Index

Constructors

Properties

apiClient options

Methods

locate locateTest setApiUrl

Constructors

constructor

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

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

locate

locate(payload: PositioningLocateRequest): Promise<PositioningLocateResponse>
Parameters
- payload: PositioningLocateRequest
Returns Promise<PositioningLocateResponse>
- Defined in api/PositioningAPI.ts:13

locateTest

locateTest(): Promise<PositioningLocateResponse>
Returns Promise<PositioningLocateResponse>
- Defined in api/PositioningAPI.ts:19

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