Jump to Content

GetBatchRequest | @here/olp-sdk-ts

GetBatchRequest | @here/olp-sdk-ts

Class GetBatchRequest

Gets publication details.

Hierarchy

GetBatchRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new GetBatchRequest(): GetBatchRequest

Returns GetBatchRequest

Methods

getBillingTag

getBillingTag(): undefined | string

- Defined in @here/olp-sdk-dataservice-write/lib/client/GetBatchRequest.ts:66
Gets the billing tag (if it was set).

Returns undefined | string
The billing tag or undefined if it was not set.

getPublicationId

getPublicationId(): undefined | string

- Defined in @here/olp-sdk-dataservice-write/lib/client/GetBatchRequest.ts:57
Gets the ID of the publication to retrieve the publication details.

Returns undefined | string
The ID of the publication details of which you want to retrieve.

withBillingTag

withBillingTag(tag: string): GetBatchRequest

- Defined in @here/olp-sdk-dataservice-write/lib/client/GetBatchRequest.ts:47
Sets the billing tag.

Parameters
- tag: string
  
  The 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].
Returns GetBatchRequest
A reference to this object.

withPublicationId

withPublicationId(id: string): GetBatchRequest

- Defined in @here/olp-sdk-dataservice-write/lib/client/GetBatchRequest.ts:34
Sets the ID of the publication to retrieve the publication details.

Parameters
- id: string
  
  The ID of the publication details of which you want to retrieve.
Returns GetBatchRequest
A reference to this object.

Generated using TypeDoc