Class HttpClient

Http Interface class for making api calls to backend

Hierarchy

HttpClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HttpClient(): HttpClient

Returns HttpClient

Properties

Static apiNetworkPerformance

apiNetworkPerformance: ApiNetworkPerformance

Static circuitBreaker

circuitBreaker: CircuitBreakerPolicy = ...

Static logger

logger: Logger = ...

Methods

Static delete

delete(url: string, request: HttpRequestInit): Promise<HttpResponse>

Parameters
- url: string
  
  url for the delete api
- request: HttpRequestInit
  
  request object associated with the api
Returns Promise<HttpResponse>
returns http response from the delete api
```
@example
delete('https://nice.dev.cxone.com/getUsers', {body: 'api_request_body'})
```

Static get

get(url: string, request: HttpRequestInit, includeForMeasuringLatency?: boolean): Promise<HttpResponse>

Parameters
- url: string
  
  url for the api
- request: HttpRequestInit
  
  request object associated with the api
- Optional includeForMeasuringLatency: boolean
  
  boolean to enable measuring api latency
Returns Promise<HttpResponse>
returns http response from the get api
```
@example
get('https://nice.dev.cxone.com/getUsers', {body: 'api_request_body'}, true)
```

Static getBlob

getBlob(url: string, request: HttpRequestInit): Promise<HttpResponse>

Gets blob data from given url
example
```
getBlob(attachment.securedPermanentUrl, reqInit)
```
Parameters
- url: string
  
  url for the api
- request: HttpRequestInit
  
  request object associated with the api
Returns Promise<HttpResponse>
returns response from the get api

Static Private handleRequestWithCircuitBreaker

handleRequestWithCircuitBreaker(url: string, httpRequest: HttpRequest, includeForMeasuringLatency?: boolean): Promise<any>

Used to handle the request via circuit breaker
example
```
this.handleRequestWithCircuitBreaker(url, httpRequest, true);
```
Parameters
- url: string
  
  url for the api
- httpRequest: HttpRequest
- includeForMeasuringLatency: boolean = false
  
  boolean to enable measuring api latency
Returns Promise<any>

Static handleResponse

handleResponse(response$: Observable<Response>, retryOptions?: RetryOptions): Observable<any>

Parameters
- response$: Observable<Response>
  
  Http response object
- Optional retryOptions: RetryOptions
  
  retry mechanism for failure scenarios
Returns Observable<any>
- handled response after api processing
```
@example
const resp = this.handleResponse({status: 200, statusText: 'OK'}, {maxRetryAttempts: 3, retryInterval: 1000});
```

Static patch

patch(url: string, request: HttpRequestInit): Promise<HttpResponse>

Parameters
- url: string
  
  url for the patch api
- request: HttpRequestInit
  
  request object associated with the api
Returns Promise<HttpResponse>
returns http response from the patch api to update data
```
@example
patch('https://nice.dev.cxone.com/getUsers', {body: 'api_request_body'})
```

Static post

post(url: string, request: HttpRequestInit): Promise<HttpResponse>

Parameters
- url: string
  
  url for the post api
- request: HttpRequestInit
  
  request object associated with the api
Returns Promise<HttpResponse>
returns http response from the post api
```
@example
get('https://nice.dev.cxone.com/getUsers', {body: 'api_request_body'})
```

Static put

put(url: string, request: HttpRequestInit): Promise<HttpResponse>

Parameters
- url: string
  
  url for the put api
- request: HttpRequestInit
  
  request object associated with the api
Returns Promise<HttpResponse>
returns http response from the put api
```
@example
put('https://nice.dev.cxone.com/getUsers', {body: 'api_request_body'})
```

Generated using TypeDoc