io.ably.lib.push

Class PushBase.DeviceRegistrations

java.lang.Object

io.ably.lib.push.PushBase.DeviceRegistrations

Enclosing class:

PushBase

public static class PushBase.DeviceRegistrations
extends java.lang.Object

Enables the management of push notification registrations with Ably.

Method Summary

Modifier and Type	Method and Description
DeviceDetails	get(java.lang.String deviceId) Retrieves the DeviceDetails of a device registered to receive push notifications using its deviceId.
void	getAsync(java.lang.String deviceId, Callback<DeviceDetails> callback) Asynchronously retrieves the DeviceDetails of a device registered to receive push notifications using its deviceId.
protected Http.Request<DeviceDetails>	getImpl(java.lang.String deviceId)
PaginatedResult<DeviceDetails>	list(Param[] params) Retrieves all devices matching the filter params provided.
void	listAsync(Param[] params, Callback<AsyncPaginatedResult<DeviceDetails>> callback) Asynchronously retrieves all devices matching the filter params provided.
protected BasePaginatedQuery.ResultRequest<DeviceDetails>	listImpl(Param[] params)
void	remove(DeviceDetails device) Removes a device registered to receive push notifications from Ably using the id property of a DeviceDetails object.
void	remove(java.lang.String deviceId) Removes a device registered to receive push notifications from Ably using its deviceId.
void	removeAsync(DeviceDetails device, CompletionListener listener) Asynchronously removes a device registered to receive push notifications from Ably using the id property of a DeviceDetails object.
void	removeAsync(java.lang.String deviceId, CompletionListener listener) Asynchronously removes a device registered to receive push notifications from Ably using its deviceId.
protected Http.Request<java.lang.Void>	removeImpl(java.lang.String deviceId)
void	removeWhere(Param[] params) Removes all devices registered to receive push notifications from Ably matching the filter params provided.
void	removeWhereAsync(Param[] params, CompletionListener listener) Removes all devices registered to receive push notifications from Ably matching the filter params provided.
protected Http.Request<java.lang.Void>	removeWhereImpl(Param[] params)
DeviceDetails	save(DeviceDetails device) Registers or updates a DeviceDetails object with Ably.
void	saveAsync(DeviceDetails device, Callback<DeviceDetails> callback) Asynchronously registers or updates a DeviceDetails object with Ably.
protected Http.Request<DeviceDetails>	saveImpl(DeviceDetails device)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

save

public DeviceDetails save(DeviceDetails device)
                   throws AblyException

Registers or updates a DeviceDetails object with Ably. Returns the new, or updated DeviceDetails object.

Spec: RSH1b3

Parameters:

device - The DeviceDetails object to create or update.

Returns:

A DeviceDetails object.

Throws:

AblyException

saveAsync

public void saveAsync(DeviceDetails device,
                      Callback<DeviceDetails> callback)

Asynchronously registers or updates a DeviceDetails object with Ably. Returns the new, or updated DeviceDetails object.

Spec: RSH1b3

Parameters:

device - The DeviceDetails object to create or update.

callback - A callback returning a DeviceDetails object.

saveImpl

protected Http.Request<DeviceDetails> saveImpl(DeviceDetails device)

get

public DeviceDetails get(java.lang.String deviceId)
                  throws AblyException

Retrieves the DeviceDetails of a device registered to receive push notifications using its deviceId.

Spec: RSH1b1

Parameters:

deviceId - The unique ID of the device.

Returns:

A DeviceDetails object.

Throws:

AblyException

getAsync

public void getAsync(java.lang.String deviceId,
                     Callback<DeviceDetails> callback)

Asynchronously retrieves the DeviceDetails of a device registered to receive push notifications using its deviceId.

Spec: RSH1b1

Parameters:

deviceId - The unique ID of the device.

callback - A callback returning a DeviceDetails object.

getImpl

protected Http.Request<DeviceDetails> getImpl(java.lang.String deviceId)

list

public PaginatedResult<DeviceDetails> list(Param[] params)
                                    throws AblyException

Retrieves all devices matching the filter params provided. Returns a PaginatedResult object, containing an array of DeviceDetails objects.

Spec: RSH1b2

Parameters:

params - An object containing key-value pairs to filter devices by. Can contain clientId, deviceId and a limit on the number of devices returned, up to 1,000.

Returns:

A PaginatedResult object containing an array of DeviceDetails objects.

Throws:

AblyException

listAsync

public void listAsync(Param[] params,
                      Callback<AsyncPaginatedResult<DeviceDetails>> callback)

Asynchronously retrieves all devices matching the filter params provided. Returns a AsyncPaginatedResult object, containing an array of DeviceDetails objects.

Spec: RSH1b2

Parameters:

params - An object containing key-value pairs to filter devices by. Can contain clientId, deviceId and a limit on the number of devices returned, up to 1,000.

callback - A callback returning a AsyncPaginatedResult object containing an array of DeviceDetails objects.

listImpl

protected BasePaginatedQuery.ResultRequest<DeviceDetails> listImpl(Param[] params)

remove

public void remove(DeviceDetails device)
            throws AblyException

Removes a device registered to receive push notifications from Ably using the id property of a DeviceDetails object.

Spec: RSH1b4

Parameters:

device - The DeviceDetails object containing the id property of the device.

Throws:

AblyException

removeAsync

public void removeAsync(DeviceDetails device,
                        CompletionListener listener)

Asynchronously removes a device registered to receive push notifications from Ably using the id property of a DeviceDetails object.

Spec: RSH1b4

Parameters:

device - The DeviceDetails object containing the id property of the device.

listener - A listener to be notified of success or failure.

remove

public void remove(java.lang.String deviceId)
            throws AblyException

Removes a device registered to receive push notifications from Ably using its deviceId.

Spec: RSH1b4

Parameters:

deviceId - The unique ID of the device.

Throws:

AblyException

removeAsync

public void removeAsync(java.lang.String deviceId,
                        CompletionListener listener)

Asynchronously removes a device registered to receive push notifications from Ably using its deviceId.

Spec: RSH1b4

Parameters:

deviceId - The unique ID of the device.

listener - A listener to be notified of success or failure.

removeImpl

protected Http.Request<java.lang.Void> removeImpl(java.lang.String deviceId)

removeWhere

public void removeWhere(Param[] params)
                 throws AblyException

Removes all devices registered to receive push notifications from Ably matching the filter params provided.

Spec: RSH1b5

Parameters:

params - An object containing key-value pairs to filter devices by. Can contain clientId and deviceId.

Throws:

AblyException

removeWhereAsync

public void removeWhereAsync(Param[] params,
                             CompletionListener listener)

Removes all devices registered to receive push notifications from Ably matching the filter params provided.

Spec: RSH1b5

Parameters:

params - An object containing key-value pairs to filter devices by. Can contain clientId and deviceId.

listener - A listener to be notified of success or failure.

removeWhereImpl

protected Http.Request<java.lang.Void> removeWhereImpl(Param[] params)