Jump to Content

UnsubscribeRequest

Prepares information for calls to the platform Stream Service.

Hierarchy

UnsubscribeRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new UnsubscribeRequest(): UnsubscribeRequest

Returns UnsubscribeRequest

Methods

getMode

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

- Defined in @here/olp-sdk-dataservice-read/lib/client/UnsubscribeRequest.ts:32

Gets the subscription mode for the request.

Returns undefined | "serial" | "parallel"

The subscription mode.

getSubscriptionId

getSubscriptionId(): undefined | string

- Defined in @here/olp-sdk-dataservice-read/lib/client/UnsubscribeRequest.ts:52

Gets the subscription id for the request.

Returns undefined | string

The subscription id.

withMode

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

- Defined in @here/olp-sdk-dataservice-read/lib/client/UnsubscribeRequest.ts:42

A setter for the provided subscription mode.

Parameters
- mode: "serial" | "parallel"
  
  The subscription mode.
Returns UnsubscribeRequest

The UnsubscribeRequest instance that you can use to chain methods.

withSubscriptionId

withSubscriptionId(id: string): UnsubscribeRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/UnsubscribeRequest.ts:62

A setter for the provided subscription id.

Parameters
- id: string
  
  The subscription id.
Returns UnsubscribeRequest

The UnsubscribeRequest instance that you can use to chain methods.

olp- sdk- dataservice- read

Unsubscribe Request