DataRequest | @here/olp-sdk-ts
Class DataRequest
Hierarchy
- DataRequest
Index
Constructors
constructor
Returns DataRequest
Methods
get
Gets a billing tag to group billing records together.
Returns undefined | string
The
BillingTagstring.
get
Gets a data handle for the request.
The data handle identifies a specific blob so that you can get the contents of that blob.
Returns undefined | string
The
DataHandlestring.
get
Gets the fetch option that controls how requests are handled.
The default option is
OnlineIfNotFound. It queries the network if the requested resource is not in the cache.Returns FetchOptions
The fetch option.
get
Gets a partition ID for the request.
Returns undefined | string
The
partitionIDstring.
with
An optional free-form tag that is used for grouping billing records together.
If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
Parameters
tag: string
The
BillingTagstring.
Returns DataRequest
The updated DataRequest instance that you can use to chain methods.
with
Sets the provided data handle.
Parameters
dataHandle: string
The
DataHandlerstring.
Returns DataRequest
The updated DataRequest instance that you can use to chain methods.
with
Sets the fetch option that you can use to set the source from which data should be fetched.
Parameters
option: FetchOptions
The
FetchOptionenum.
Returns DataRequest
A reference to the updated
DataRequestinstance.
with
Sets the provided partition ID.
Parameters
partitionId: string
The
partitionIDstring.
Returns DataRequest
The updated DataRequest instance that you can use to chain methods.
Generated using TypeDoc
Prepares information for calls to get data from the HERE Blob Service.