Class MeshRestClient

MeshRestClient that can be used to make requests to the mesh backend.

Hierarchy

MeshRestClient

Properties

Private publicMeshCookieUserStore

publicMeshCookieUserStore: any

Static Private CHILDREN_ENDPOINT

CHILDREN_ENDPOINT: string

Static Private NAVIGATION_ENDPOINT

NAVIGATION_ENDPOINT: string

Static Private NODES_ENDPOINT

NODES_ENDPOINT: string

Static Private TAG_FAMILIES_ENDPOINT

TAG_FAMILIES_ENDPOINT: string

Methods

getChildren

getChildren<T>(req: IMeshRequest, uuid: string, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNodeListResponse<IMeshNode<T>>>>

- Defined in lib/meshRestClient.ts:157
Type parameters
- T
Parameters
- req: IMeshRequest
- uuid: string
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNodeListResponse<IMeshNode<T>>>>

getMeshNode

getMeshNode<T>(req: IMeshRequest, uuid: string, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNode<T>>>

- Defined in lib/meshRestClient.ts:147
Type parameters
- T
Parameters
- req: IMeshRequest
- uuid: string
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNode<T>>>

getNavigationByPath

getNavigationByPath(req: IMeshRequest, path: string, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNav>>

- Defined in lib/meshRestClient.ts:112
Parameters
- req: IMeshRequest
- path: string
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNav>>

getNavigationByUUID

getNavigationByUUID(req: IMeshRequest, uuid: string, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNav>>

- Defined in lib/meshRestClient.ts:121
Parameters
- req: IMeshRequest
- uuid: string
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNav>>

getTagFamilies

getTagFamilies(req: IMeshRequest, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNodeListResponse<IMeshTagFamily>>>

- Defined in lib/meshRestClient.ts:176
Parameters
- req: IMeshRequest
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNodeListResponse<IMeshTagFamily>>>

getTagsOfTagFamily

getTagsOfTagFamily(req: IMeshRequest, uuid: string, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNodeListResponse<IMeshTag>>>

- Defined in lib/meshRestClient.ts:181
Parameters
- req: IMeshRequest
- uuid: string
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNodeListResponse<IMeshTag>>>

getWebrootNode

getWebrootNode<T>(req: IMeshRequest, params?: MeshQueryParams): Promise<MeshRestResponse<IMeshNode<T>>>

- Defined in lib/meshRestClient.ts:130
Type parameters
- T
Parameters
- req: IMeshRequest
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<IMeshNode<T>>>

login

login(req: IMeshRequest, username: string, password: string): Promise<boolean>

- Defined in lib/meshRestClient.ts:186
Parameters
- req: IMeshRequest
- username: string
- password: string
Returns Promise<boolean>

logout

logout(req: IMeshRequest): Promise<boolean>

- Defined in lib/meshRestClient.ts:203
Parameters
- req: IMeshRequest
Returns Promise<boolean>

Private makeMeshRequest

makeMeshRequest(requestOptions: MeshRequestOptions): Promise<MeshRestResponse<any>>

- Defined in lib/meshRestClient.ts:260
Parameters
- requestOptions: MeshRequestOptions
Returns Promise<MeshRestResponse<any>>

meshPOST

meshPOST(requestOptions: MeshRequestOptions, data?: any): Promise<MeshRestResponse<any>>

- Defined in lib/meshRestClient.ts:239
Parameters
- requestOptions: MeshRequestOptions
- Optional data: any
Returns Promise<MeshRestResponse<any>>

meshSearch

meshSearch<T>(req: IMeshRequest, query: IMeshSearchQuery, params?: IMeshNodeListQueryParams): Promise<MeshRestResponse<IMeshNodeListResponse<T>>>

- Defined in lib/meshRestClient.ts:162
Type parameters
- T
Parameters
- req: IMeshRequest
- query: IMeshSearchQuery
- Optional params: IMeshNodeListQueryParams
Returns Promise<MeshRestResponse<IMeshNodeListResponse<T>>>

meshSimpleGET

meshSimpleGET<T>(req: IMeshRequest, url: string, params?: MeshQueryParams): Promise<MeshRestResponse<T>>

- Defined in lib/meshRestClient.ts:213
Type parameters
- T
Parameters
- req: IMeshRequest
- url: string
- Optional params: MeshQueryParams
Returns Promise<MeshRestResponse<T>>

meshSimpleRequest

meshSimpleRequest<T>(method: string, req: IMeshRequest, url: string, params?: MeshQueryParams, data?: any): Promise<MeshRestResponse<T>>

- Defined in lib/meshRestClient.ts:217
Type parameters
- T
Parameters
- method: string
- req: IMeshRequest
- url: string
- Optional params: MeshQueryParams
- Optional data: any
Returns Promise<MeshRestResponse<T>>

Private queryStringFromParams

queryStringFromParams(queryParams: IMeshNodeListQueryParams): string

- Defined in lib/meshRestClient.ts:248
Convert a queryParams object into a URL-encoded string.

Parameters
- queryParams: IMeshNodeListQueryParams
Returns string

Generated using TypeDoc