Class default

Index

Constructors

Properties

Methods

delete get post processRoute put request setAuthToken setBaseUrl setCommunityID uploadBlob uploadFile uploadFileInChunks

Constructors

constructor

new default(config): default
Parameters
- config: default
Returns default
- Defined in util/Requests.ts:15

Properties

`Static` `Private` authToken

authToken: string = ""

`Static` `Private` baseUrl

baseUrl: string = ""

`Static` `Private` `Optional` community_id

community_id?: string = ""

`Static` `Private` config

config: default

Methods

`Static` delete

delete<T>(url, params?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- url: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:122

`Static` get

get<T>(url, params?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- url: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:65

`Static` post

post<T>(url, data, params?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- url: string
- data: any
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:86

`Static` processRoute

processRoute<T>(route, data?, routeReplace?, params?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- route: default
- Optional data: object
- Optional routeReplace: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:313

`Static` put

put<T>(url, data, params?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- url: string
- data: any
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:104

`Static` `Private` request

request<T>(method, url, data?, fileData?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- method: "GET" | "POST" | "PUT" | "DELETE"
- url: string
- Optional data: any
- Optional fileData: any
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:31

`Static` setAuthToken

setAuthToken(token): void
Parameters
- token: string
Returns void
- Defined in util/Requests.ts:23

`Static` setBaseUrl

setBaseUrl(url): void
Parameters
- url: string
Returns void
- Defined in util/Requests.ts:19

`Static` setCommunityID

setCommunityID(community_id): void
Parameters
- community_id: undefined | string
Returns void
- Defined in util/Requests.ts:27

`Static` uploadBlob

uploadBlob<T>(url, filename, blob, data?, params?, onUploadProgress?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- url: string
- filename: string
- blob: Blob
- Optional data: any
- Optional params: Record<string, any>
- Optional onUploadProgress: ((progressEvent) => void)
  - - (progressEvent): void
    - Parameters
      progressEvent: AxiosProgressEvent
      Returns void
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:190

`Static` uploadFile

uploadFile<T>(url, filename, file, data?, params?, onUploadProgress?): AxiosPromise<default<T>>
Type Parameters
- T
Parameters
- url: string
- filename: string
- file: File | Blob
- Optional data: any
- Optional params: Record<string, any>
- Optional onUploadProgress: ((progressEvent) => void)
  - - (progressEvent): void
    - Parameters
      progressEvent: AxiosProgressEvent
      Returns void
Returns AxiosPromise<default<T>>
- Defined in util/Requests.ts:138

`Static` uploadFileInChunks

uploadFileInChunks<T>(file, uploadUrl, onProgress?, data?, chunkSize?): Promise<void>
Type Parameters
- T
Parameters
- file: File
- uploadUrl: string
- Optional onProgress: ((totalSize, amountUploaded) => void)
  - - (totalSize, amountUploaded): void
    - Parameters
      totalSize: number
      amountUploaded: number
      Returns void
- Optional data: any
- Optional chunkSize: number
Returns Promise<void>
- Defined in util/Requests.ts:245

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: default

Returns default

Properties

Static Private authToken

Static Private baseUrl

Static Private Optional community_id

Static Private config

Methods

Static delete

Type Parameters

T

Parameters

url: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static get

Type Parameters

T

Parameters

url: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static post

Type Parameters

T

Parameters

url: string

data: any

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static processRoute

Type Parameters

T

Parameters

route: default

Optional data: object

Optional routeReplace: { [key: string]: any; }

[key: string]: any

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static put

Type Parameters

T

Parameters

url: string

data: any

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static Private request

Type Parameters

T

Parameters

method: "GET" | "POST" | "PUT" | "DELETE"

url: string

Optional data: any

Optional fileData: any

Returns AxiosPromise<default<T>>

Static setAuthToken

Parameters

token: string

Returns void

Static setBaseUrl

Parameters

url: string

Returns void

Static setCommunityID

Parameters

community_id: undefined | string

Returns void

Static uploadBlob

Type Parameters

T

`Static` `Private` authToken

`Static` `Private` baseUrl

`Static` `Private` `Optional` community_id

`Static` `Private` config

`Static` delete

`Optional` params: Record<string, any>

`Static` get

`Optional` params: Record<string, any>

`Static` post

`Optional` params: Record<string, any>

`Static` processRoute

`Optional` data: object

`Optional` routeReplace: {
[key: string]: any;
}

`Optional` params: Record<string, any>

`Static` put

`Optional` params: Record<string, any>

`Static` `Private` request

`Optional` data: any

`Optional` fileData: any

`Static` setAuthToken

`Static` setBaseUrl

`Static` setCommunityID

`Static` uploadBlob

`Optional` data: any

`Optional` params: Record<string, any>

`Optional` onUploadProgress: ((progressEvent) => void)

`Static` uploadFile

`Optional` data: any

`Optional` params: Record<string, any>

`Optional` onUploadProgress: ((progressEvent) => void)

`Static` uploadFileInChunks

`Optional` onProgress: ((totalSize, amountUploaded) => void)

`Optional` data: any

`Optional` chunkSize: number