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 function which, upon success, will be called with a PaginatedResult object containing an array of PushChannelSubscription objects. Upon failure, the function will be called with information about 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 function which, upon success, will be called with a PaginatedResult object containing an array of channel names. Upon failure, the function will be called with information about the error.
Unsubscribes a device, or a group of devices sharing the same clientId
from receiving push notifications on a channel.
A PushChannelSubscription object.
Optional
callback: errorCallback
A function which will be called upon completion of the operation. If the operation succeeded, then the function will be called with null
. If it failed, the function will be called with information about the error.
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
.
Optional
callback: errorCallback
A function which will be called upon completion of the operation. If the operation succeeded, then the function will be called with null
. If it failed, the function will be called with information about the error.
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.
Optional
callback: StandardCallback<PushChannelSubscription>
A function which, upon success, will be called with a PushChannelSubscription object describing the new or updated subscriptions. Upon failure, the function will be called with information about the error.
Generated using TypeDoc
Enables device push channel subscriptions.