Class CDFHttpClient

Hierarchy

RetryableHttpClient
- CDFHttpClient

Index

Constructors

constructor

Methods

Constructors

constructor

new CDFHttpClient(baseUrl: string, retryValidator: RetryValidator): CDFHttpClient

Overrides RetryableHttpClient.constructor
- Defined in packages/core/src/httpClient/cdfHttpClient.ts:56
Parameters
- baseUrl: string
- retryValidator: RetryValidator
Returns CDFHttpClient

Methods

addOneTimeHeader

addOneTimeHeader(name: string, value: string): this

- Defined in packages/core/src/httpClient/cdfHttpClient.ts:62
Parameters
- name: string
- value: string
Returns this

delete

delete<ResponseType>(path: string, options?: RetryableHttpRequestOptions): Promise<HttpResponse<ResponseType>>

Inherited from RetryableHttpClient.delete

Overrides BasicHttpClient.delete
- Defined in packages/core/src/httpClient/retryableHttpClient.ts:45
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: RetryableHttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

get

get<ResponseType>(path: string, options?: RetryableHttpRequestOptions): Promise<HttpResponse<ResponseType>>

Inherited from RetryableHttpClient.get

Overrides BasicHttpClient.get
- Defined in packages/core/src/httpClient/retryableHttpClient.ts:24
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: RetryableHttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

getBaseUrl

getBaseUrl(): string

Inherited from BasicHttpClient.getBaseUrl
- Defined in packages/core/src/httpClient/basicHttpClient.ts:104
Returns string

getDefaultHeaders

getDefaultHeaders(): HttpHeaders

Inherited from BasicHttpClient.getDefaultHeaders
- Defined in packages/core/src/httpClient/basicHttpClient.ts:96
Returns HttpHeaders

patch

patch<ResponseType>(path: string, options?: RetryableHttpRequestOptions): Promise<HttpResponse<ResponseType>>

Inherited from RetryableHttpClient.patch

Overrides BasicHttpClient.patch
- Defined in packages/core/src/httpClient/retryableHttpClient.ts:52
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: RetryableHttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

post

post<ResponseType>(path: string, options?: RetryableHttpRequestOptions): Promise<HttpResponse<ResponseType>>

Inherited from RetryableHttpClient.post

Overrides BasicHttpClient.post
- Defined in packages/core/src/httpClient/retryableHttpClient.ts:31
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: RetryableHttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

put

put<ResponseType>(path: string, options?: RetryableHttpRequestOptions): Promise<HttpResponse<ResponseType>>

Inherited from RetryableHttpClient.put

Overrides BasicHttpClient.put
- Defined in packages/core/src/httpClient/retryableHttpClient.ts:38
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: RetryableHttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

set401ResponseHandler

set401ResponseHandler(handler: Response401Handler): void

- Defined in packages/core/src/httpClient/cdfHttpClient.ts:71
Parameters
- handler: Response401Handler
Returns void

setBaseUrl

setBaseUrl(baseUrl: string): void

Inherited from BasicHttpClient.setBaseUrl
- Defined in packages/core/src/httpClient/basicHttpClient.ts:100
Parameters
- baseUrl: string
Returns void

setBearerToken

setBearerToken(token: string): void

- Defined in packages/core/src/httpClient/cdfHttpClient.ts:67
Parameters
- token: string
Returns void

setCluster

setCluster(cluster: string): void

Inherited from BasicHttpClient.setCluster
- Defined in packages/core/src/httpClient/basicHttpClient.ts:108
Parameters
- cluster: string
Returns void

setDefaultHeader

setDefaultHeader(name: string, value: string): this

Inherited from BasicHttpClient.setDefaultHeader
- Defined in packages/core/src/httpClient/basicHttpClient.ts:91
Parameters
- name: string
- value: string
Returns this