Jump to Content

RequestBuilder | @here/olp-sdk-ts

RequestBuilder | @here/olp-sdk-ts

Class RequestBuilder Abstract

Abstract class used for building requests to a REST API.

Hierarchy

RequestBuilder
- DataStoreRequestBuilder

Index

Constructors

constructor

Properties

baseUrl

Methods

Constructors

constructor

new RequestBuilder(baseUrl: string): RequestBuilder

- Defined in @here/olp-sdk-dataservice-api/lib/RequestBuilder.ts:138
Constructs a new RequestBuilder.

Parameters
- baseUrl: string
  
  The base URL of the service.
Returns RequestBuilder

Properties

Readonly baseUrl

baseUrl: string

Methods

Abstract download

download<T>(url: string, init?: RequestOptions): Promise<T>

- Defined in @here/olp-sdk-dataservice-api/lib/RequestBuilder.ts:166
Implement this function to download the given url as JSON object.

Type Parameters
- T
Parameters
- url: string
  
  The URL to download.
- Optional init: RequestOptions
Returns Promise<T>

Abstract downloadBlob

downloadBlob(url: string, init?: RequestOptions): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/RequestBuilder.ts:173
Implement this function to download the given url as Blob object.

Parameters
- url: string
  
  The URL to download.
- Optional init: RequestOptions
Returns Promise<Response>

request

request<T>(urlObj: UrlBuilder, init?: RequestOptions): Promise<T>

- Defined in @here/olp-sdk-dataservice-api/lib/RequestBuilder.ts:145
Helper method to download the resource.

Type Parameters
- T
Parameters
- urlObj: UrlBuilder
  
  the URL to fetch.
- Optional init: RequestOptions
Returns Promise<T>

requestBlob

requestBlob(urlObj: UrlBuilder, init?: RequestOptions): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/RequestBuilder.ts:154
Helper method to download the resource.

Parameters
- urlObj: UrlBuilder
  
  the URL to fetch.
- Optional init: RequestOptions
Returns Promise<Response>

Generated using TypeDoc