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