Jump to Content

SeekRequest | @here/olp-sdk-ts

SeekRequest | @here/olp-sdk-ts

Class SeekRequest

Prepares information for calls to the platform Stream Service.

Hierarchy

SeekRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new SeekRequest(): SeekRequest

Returns SeekRequest

Methods

getMode

getMode(): undefined | "serial" | "parallel"

- Defined in @here/olp-sdk-dataservice-read/lib/client/SeekRequest.ts:35
Gets the subscription mode for the request.

Returns undefined | "serial" | "parallel"
The subscription mode.

getSeekOffsets

getSeekOffsets(): undefined | SeekOffsetsRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/SeekRequest.ts:75
Returns undefined | SeekOffsetsRequest

getSubscriptionId

getSubscriptionId(): undefined | string

- Defined in @here/olp-sdk-dataservice-read/lib/client/SeekRequest.ts:55
Gets the subscription id for the request.

Returns undefined | string
The subscription id.

withMode

withMode(mode: "serial" | "parallel"): SeekRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/SeekRequest.ts:45
A setter for the provided subscription mode.

Parameters
- mode: "serial" | "parallel"
  
  The subscription mode.
Returns SeekRequest
The SeekRequest instance that you can use to chain methods.

withSeekOffsets

withSeekOffsets(offsets: SeekOffsetsRequest): SeekRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/SeekRequest.ts:70
Parameters
- offsets: SeekOffsetsRequest
Returns SeekRequest

withSubscriptionId

withSubscriptionId(id: string): SeekRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/SeekRequest.ts:65
A setter for the provided subscription id.

Parameters
- id: string
  
  The subscription id.
Returns SeekRequest
The SeekRequest instance that you can use to chain methods.

Generated using TypeDoc