Class RoutingAPI

Hierarchy

APIBase
- RoutingAPI

Index

Constructors

Properties

apiClient options

Methods

getById getList getOptions getOptionsForm postRoute setApiUrl setOptions

Constructors

constructor

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

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getById

getById(id: number): Promise<Routing>
Parameters
- id: number
  The id to get
Returns Promise<Routing>
- Defined in api/RoutingAPI.ts:16

getList

getList(): Promise<Routing[]>
Returns Promise<Routing[]>
- Defined in api/RoutingAPI.ts:22

getOptions

getOptions(): Promise<RoutingOptions>
Returns Promise<RoutingOptions>
- Defined in api/RoutingAPI.ts:28

getOptionsForm

getOptionsForm(): Promise<RoutingOptionsFormItem[]>
Returns Promise<RoutingOptionsFormItem[]>
- Defined in api/RoutingAPI.ts:34

postRoute

postRoute(request: RoutingRequest): Promise<Routing>
Parameters
- request: RoutingRequest
Returns Promise<Routing>
- Defined in api/RoutingAPI.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

setOptions

setOptions(options: Partial<RoutingOptions>): Promise<RoutingOptions>
Parameters
- options: Partial<RoutingOptions>
Returns Promise<RoutingOptions>
- Defined in api/RoutingAPI.ts:46