SubscribeRequest | @here/olp-sdk-ts
Class SubscribeRequest
Hierarchy
- SubscribeRequest
Index
Constructors
constructor
Returns SubscribeRequest
Methods
get
Gets the consumer id for the request.
Returns undefined | string
The consumer id.
get
Gets the subscription mode for the request.
Returns undefined | "serial" | "parallel"
The subscription mode.
get
Gets the subscription id for the request.
Returns undefined | string
The subscription id.
get
Gets the subscriptionProperties for the request - consumer properties to use for this subscription.
Returns undefined | ConsumerProperties
The subscriptionProperties.
with
A setter for the provided consumer id.
Parameters
id: string
The consumer id.
Returns SubscribeRequest
The SubscribeRequest instance that you can use to chain methods.
with
A setter for the provided subscription mode.
Parameters
mode: "serial" | "parallel"
The subscription mode.
Returns SubscribeRequest
The SubscribeRequest instance that you can use to chain methods.
with
A setter for the provided subscription id.
Parameters
id: string
The subscription id.
Returns SubscribeRequest
The SubscribeRequest instance that you can use to chain methods.
with
A setter for the provided subscription properties.
Parameters
props: ConsumerProperties
The subscriptionProperties - consumer properties to use for this subscription. For more information, see the [subscription properties] (https://developer.here.com/documentation/data-api/data_dev_guide/rest/getting-data-stream.html#subscription-properties)
Returns SubscribeRequest
The SubscribeRequest instance that you can use to chain methods.
Generated using TypeDoc
Prepares information for calls to the platform Stream Service.