Class ARRequestClient

ARRequestClient is a helper class to:

authenticate to Axioroute API
send requests to Axioroute API
listen to request status via subscriptions (with polling under the hood)

Constructors

`Private` constructor

new ARRequestClient(tokenData?): ARRequestClient
Parameters
- Optional tokenData: AuthTokenData
Returns ARRequestClient
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:111

Properties

`Private` _authToken

_authToken: undefined | string

`Private` _expires_at

_expires_at: undefined | number

`Private` _handlers

_handlers: {
[status: string]: ARRequestHandler[];
}

Type declaration

[status: string]: ARRequestHandler[]

`Private` _pending_token_response

_pending_token_response: undefined | boolean

`Private` _refreshToken

_refreshToken: undefined | string

`Private` _refresh_expires_at

_refresh_expires_at: undefined | number

`Private` _requests

_requests: {
[requestId: string]: ARRequest;
}

Type declaration

[requestId: string]: ARRequest

`Static` `Private` _apiBaseUrl

_apiBaseUrl: undefined | string

`Static` `Private` _apiEnv

_apiEnv: string = DEFAULT_API_ENV

`Static` `Private` _apiKey

_apiKey: undefined | string

`Static` `Private` _authUrl

_authUrl: undefined | string

`Static` `Private` _instance

_instance: ARRequestClient

Methods

auth

auth(username, password): Promise<AuthTokenData>
Parameters
- username: string
- password: string
Returns Promise<AuthTokenData>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:425

getCoordinatesInfo

getCoordinatesInfo(position): Promise<ARCartoReverseGeocodingResponse>
Parameters
- position: ARCoordinates
Returns Promise<ARCartoReverseGeocodingResponse>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:474

getPolygon

getPolygon(point, type?): Promise<ARCartoPolygonResponse>
Parameters
- point: ARCoordinates
- Optional type: PolygonType
Returns Promise<ARCartoPolygonResponse>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:490

getToken

getToken(): undefined | string
Returns undefined | string
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:235

getTokenData

getTokenData(): Promise<AuthTokenData>
Returns Promise<AuthTokenData>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:240

isRefreshTokenExpired

isRefreshTokenExpired(inSeconds?): boolean
Parameters
- inSeconds: number = 0
Returns boolean
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:375

isTokenExpired

isTokenExpired(inSeconds?): boolean
Parameters
- inSeconds: number = 0
Returns boolean
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:361

sendMCIProblem

sendMCIProblem(problem): Promise<MCIJob>
Send a MCI problem
Parameters
- problem: MCIProblem
Returns Promise<MCIJob>
MCI Job
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:551

sendMPTProblem

sendMPTProblem(problem): Promise<MPTJob>
/**
- Send a MPT problem
Parameters
- problem: MPTProblem
Returns Promise<MPTJob>
MPT Problem Response (not the final solution)
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:514

setTokenData

setTokenData(tokenData): void
Parameters
- tokenData: AuthTokenData
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:457

shouldTokenRefresh

shouldTokenRefresh(): boolean
Returns boolean
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:339

subscribe(status, handler): (() => void)
Parameters
- status: ARRequestStatus
- handler: ARRequestHandler
Returns (() => void)
- - (): void
  - Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:251

unSubscribe

unSubscribe(status, handler): void
Parameters
- status: ARRequestStatus
- handler: ARRequestHandler
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:259

`Private` update

update(): void
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:389

`Private` updateAvailable

updateAvailable(request): Promise<void>
Parameters
- request: ARRequest
Returns Promise<void>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:296

`Private` updateLoading

updateLoading(request): Promise<void>
Parameters
- request: ARRequest
Returns Promise<void>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:268

updateTokenData

updateTokenData(): Promise<void>
Returns Promise<void>
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:201

`Static` getApiBaseUrl

getApiBaseUrl(): string
Get the api base url

Returns string
the api base url
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:160

`Static` getApiEnv

getApiEnv(): string
Returns string
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:131

`Static` getApiKey

getApiKey(): string
Returns string
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:139

`Static` getAuthUrl

getAuthUrl(): string
Get the auth url

Returns string
the auth url
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:181

`Static` instance

instance(): ARRequestClient
Returns ARRequestClient
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:191

`Static` setApiBaseUrl

setApiBaseUrl(apiBaseUrl): void
Set the api base url
Parameters
- apiBaseUrl: string
  the api base url
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:152

`Static` setApiEnv

setApiEnv(apiEnv): void
Parameters
- apiEnv: string
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:126

`Static` setApiKey

setApiKey(apiKey): void
Parameters
- apiKey: string
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:135

`Static` setAuthUrl

setAuthUrl(authUrl): void
Set the auth url
Parameters
- authUrl: string
  the auth url
Returns void
- Defined in packages/axioroute-sdk/src/lib/requests/requests.ts:173

Class ARRequestClient

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

Optional tokenData: AuthTokenData

Returns ARRequestClient

Properties

Private _authToken

Private _expires_at

Private _handlers

Type declaration

[status: string]: ARRequestHandler[]

Private _pending_token_response

Private _refreshToken

Private _refresh_expires_at

Private _requests

Type declaration

[requestId: string]: ARRequest

Static Private _apiBaseUrl

Static Private _apiEnv

Static Private _apiKey

Static Private _authUrl

Static Private _instance

Methods

auth

Parameters

username: string

password: string

Returns Promise<AuthTokenData>

getCoordinatesInfo

Parameters

position: ARCoordinates

Returns Promise<ARCartoReverseGeocodingResponse>

getPolygon

Parameters

point: ARCoordinates

Optional type: PolygonType

Returns Promise<ARCartoPolygonResponse>

getToken

Returns undefined | string

getTokenData

Returns Promise<AuthTokenData>

isRefreshTokenExpired

Parameters

inSeconds: number = 0

Returns boolean

isTokenExpired

Parameters

inSeconds: number = 0

Returns boolean

listen

Returns void

refreshToken

Returns Promise<AuthTokenData>

removeToken

Returns void

sendMCIProblem

Parameters

problem: MCIProblem

Returns Promise<MCIJob>

sendMPTProblem

Parameters

problem: MPTProblem

Returns Promise<MPTJob>

setTokenData

Parameters

tokenData: AuthTokenData

Returns void

shouldTokenRefresh

Returns boolean

subscribe

Parameters

status: ARRequestStatus

handler: ARRequestHandler

Returns (() => void)

Returns void

`Private` constructor

`Optional` tokenData: AuthTokenData

`Private` _authToken

`Private` _expires_at

`Private` _handlers

`Private` _pending_token_response

`Private` _refreshToken

`Private` _refresh_expires_at

`Private` _requests

`Static` `Private` _apiBaseUrl

`Static` `Private` _apiEnv

`Static` `Private` _apiKey

`Static` `Private` _authUrl

`Static` `Private` _instance

`Optional` type: PolygonType

`Private` update

`Private` updateAvailable

`Private` updateLoading

`Static` getApiBaseUrl

`Static` getApiEnv

`Static` getApiKey

`Static` getAuthUrl

`Static` instance

`Static` setApiBaseUrl

`Static` setApiEnv

`Static` setApiKey

`Static` setAuthUrl