Class AbstractApi

constructor

• new AbstractApi(params): AbstractApi

• Parameters

  • params: {
        cacheId?: string;
        ssidHeader?: string;
    }

    • Optional cacheId?: string

    • Optional ssidHeader?: string

  Returns AbstractApi

Cache

GetBaseUrl

• GetBaseUrl(): string

• Returns the base URL for the API.

  Returns string

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

GetSessionHeader

• GetSessionHeader(): string

• Returns the session header.

  Returns string

GetSessionId

• GetSessionId(): string

• Returns the session ID.

  Returns string

SetBaseUrl

• SetBaseUrl(url): void

• Sets the base URL for the API.

  Parameters

  • url: string

  Returns void

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

SetSessionHeader

• SetSessionHeader(value): void

• Sets the session header.

  Parameters

  • value: string

  Returns void

SetSessionId

• SetSessionId(value): void

• Sets the session ID.

  Parameters

  • value: string

  Returns void

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>

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>

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>

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>

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>