Class Api

This is a base class for communication with an arbitrary Nextspace API.

Hierarchy

AbstractApi
- Api

Index

Constructors

Properties

Cache baseUrl env

Methods

DELETE GET GetBaseUrl GetCacheItem GetSessionHeader GetSessionId POST SetBaseUrl SetCacheItem SetSessionHeader SetSessionId UPLOAD delete get post put setBaseUrl upload

Constructors

constructor

new Api(params): GuardianApi.Api
Parameters
- params: {
  env?: string;
  }
  - Optional env?: string
Returns GuardianApi.Api
Overrides AbstractApi.constructor
- Defined in api/guardian-api.ts:13

Properties

Cache

Cache: CacheControl<any>

`Protected` baseUrl

baseUrl: string = ""

`Private` env

env: string

Methods

DELETE

DELETE(url, params?): Promise<any>
Performs an HTTP DELETE request. This will prepend the base url to the url.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/guardian-api.ts:88

GET

GET(url, params?): Promise<any>
Performs an HTTP GET request. This will prepend the base url to the url.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/guardian-api.ts:77

GetBaseUrl

GetBaseUrl(): string
Gets the base url for this api.

Returns string
Overrides AbstractApi.GetBaseUrl
- Defined in api/guardian-api.ts:55

GetCacheItem

GetCacheItem(key, reqParams?): {
data: any;
found: boolean;
}
Returns a cache item matching the provided key. If the reqParams specify that caching is disabled, null is returned.
Parameters
- key: string
- Optional reqParams: IReqParams
Returns {
data: any;
found: boolean;
}
- data: any
- found: boolean
Inherited from AbstractApi.GetCacheItem
- Defined in api/abstract-api.ts:76

GetSessionHeader

GetSessionHeader(): string
Returns the session header.

Returns string
Inherited from AbstractApi.GetSessionHeader
- Defined in api/abstract-api.ts:138

GetSessionId

GetSessionId(): string
Returns the session ID.

Returns string
Inherited from AbstractApi.GetSessionId
- Defined in api/abstract-api.ts:122

POST

POST(url, data, params?): Promise<any>
Performs an HTTP POST request. This will prepend the base url to the url.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
- Defined in api/guardian-api.ts:100

SetBaseUrl

SetBaseUrl(url): void
Sets the base url for this api.
Parameters
- url: string
Returns void
Overrides AbstractApi.SetBaseUrl
- Defined in api/guardian-api.ts:63

SetCacheItem

SetCacheItem(params): void
Sets a cache item matching the provided key. If the reqParams specify that caching is disabled, then no action is taken.
Parameters
- params: {
      duration?: number;
      key: string;
      req?: IReqParams;
      value: any;
  }
  - Optional duration?: number
  - key: string
  - Optional req?: IReqParams
  - value: any
Returns void
Inherited from AbstractApi.SetCacheItem
- Defined in api/abstract-api.ts:93

SetSessionHeader

SetSessionHeader(value): void
Sets the session header.
Parameters
- value: string
Returns void
Inherited from AbstractApi.SetSessionHeader
- Defined in api/abstract-api.ts:146

SetSessionId

SetSessionId(value): void
Sets the session ID.
Parameters
- value: string
Returns void
Inherited from AbstractApi.SetSessionId
- Defined in api/abstract-api.ts:130

UPLOAD

UPLOAD(url, blob, params?): Promise<any>
Performs a file upload request (HTTP POST). This will prepend the base url to the url.
Parameters
- url: string
- blob: Blob
- Optional params: IUploadReqParams
Returns Promise<any>
- Defined in api/guardian-api.ts:112

delete

delete(url, params?): Promise<any>
Performs a DELETE request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.delete
- Defined in api/abstract-api.ts:182

get

get(url, params?): Promise<any>
Performs a GET request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.get
- Defined in api/abstract-api.ts:157

post

post(url, data, params?): Promise<any>
Performs a POST request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.post
- Defined in api/abstract-api.ts:209

put

put(url, data, params?): Promise<any>
Performs a PUT request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- data: any
- Optional params: IReqParams
Returns Promise<any>
Inherited from AbstractApi.put
- Defined in api/abstract-api.ts:243

`Private` setBaseUrl

setBaseUrl(): void
Sets the base url for this api.

Returns void
- Defined in api/guardian-api.ts:29

upload

upload(url, blob, params?): Promise<any>
Performs a file upload (POST) request. This will NOT prepend the base URL to the provided URL.
Parameters
- url: string
- blob: Blob
- Optional params: IUploadReqParams
Returns Promise<any>
Inherited from AbstractApi.upload
- Defined in api/abstract-api.ts:277

Generated using TypeDoc