Retrieves the DeviceDetails of a device registered to receive push notifications using its deviceId.
The unique ID of the device.
A promise which, upon success, will be fulfilled with a DeviceDetails object. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Retrieves the DeviceDetails of a device registered to receive push notifications using the id property of a DeviceDetails object.
The DeviceDetails object containing the id property of the device.
A promise which, upon success, will be fulfilled with a DeviceDetails object. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Retrieves all devices matching the filter params provided. Returns a PaginatedResult object, containing an array of DeviceDetails objects.
An object containing key-value pairs to filter devices by.
A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of DeviceDetails objects. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Removes a device registered to receive push notifications from Ably using its deviceId.
The unique ID of the device.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Removes a device registered to receive push notifications from Ably using the id property of a DeviceDetails object.
The DeviceDetails object containing the id property of the device.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Removes all devices registered to receive push notifications from Ably matching the filter params provided.
An object containing key-value pairs to filter devices by. This object’s limit property will be ignored.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Registers or updates a DeviceDetails object with Ably. Returns the new, or updated DeviceDetails object.
The DeviceDetails object to create or update.
A promise which, upon success, will be fulfilled with a DeviceDetails object. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Generated using TypeDoc
Enables the management of push notification registrations with Ably.