Retrieves all push channel subscriptions matching the filter params provided. Returns a PaginatedResult object, containing an array of PushChannelSubscription objects.
An object containing key-value pairs to filter subscriptions by.
A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of PushChannelSubscription objects. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Retrieves all channels with at least one device subscribed to push notifications. Returns a PaginatedResult object, containing an array of channel names.
An object containing key-value pairs to filter channels by.
A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of channel names. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Unsubscribes a device, or a group of devices sharing the same clientId from receiving push notifications on a channel.
A PushChannelSubscription object.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Unsubscribes all devices from receiving push notifications on a channel that match the filter params provided.
An object containing key-value pairs to filter subscriptions by. Can contain channel, and optionally either clientId or deviceId.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Subscribes a device, or a group of devices sharing the same clientId to push notifications on a channel. Returns a PushChannelSubscription object.
A PushChannelSubscription object.
A promise which, upon success, will be fulfilled with a PushChannelSubscription object describing the new or updated subscriptions. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Generated using TypeDoc
Enables device push channel subscriptions.