Interface PushChannel

Enables devices to subscribe to push notifications for a channel.

Hierarchy

PushChannel

Index

Methods

listSubscriptions subscribeClient subscribeDevice unsubscribeClient unsubscribeDevice

Methods

listSubscriptions

listSubscriptions(params?): Promise<PaginatedResult<PushChannelSubscription>>
Retrieves all push subscriptions for the channel. Subscriptions can be filtered using a params object.
Parameters
- Optional params: Record<string, string>
  
  An object containing key-value pairs to filter subscriptions by. Can contain clientId, deviceId or a combination of both, and a limit on the number of subscriptions returned, up to 1,000.
Returns Promise<PaginatedResult<PushChannelSubscription>>

a PaginatedResult object containing an array of PushChannelSubscription objects.
- Defined in ably.d.ts:2249

subscribeClient

subscribeClient(): Promise<void>
Subscribes all devices associated with the current device's clientId to push notifications for the channel.

Returns Promise<void>
- Defined in ably.d.ts:2236

subscribeDevice

subscribeDevice(): Promise<void>
Subscribes the device to push notifications for the channel.

Returns Promise<void>
- Defined in ably.d.ts:2226

unsubscribeClient

unsubscribeClient(): Promise<void>
Unsubscribes all devices associated with the current device's clientId from receiving push notifications for the channel.

Returns Promise<void>
- Defined in ably.d.ts:2241

unsubscribeDevice

unsubscribeDevice(): Promise<void>
Unsubscribes the device from receiving push notifications for the channel.

Returns Promise<void>
- Defined in ably.d.ts:2231

Generated using TypeDoc