com.amazonaws.mobile.client

Class DeviceOperations

java.lang.Object

com.amazonaws.mobile.client.DeviceOperations

public class DeviceOperations
extends Object

Method Summary

Modifier and Type	Method and Description
void	forget() Forget the current device.
void	forget(Callback<Void> callback) Forget the current device.
void	forget(String deviceKey) Forget the device identified by the deviceKey.
void	forget(String deviceKey, Callback<Void> callback) Forget the device identified by the deviceKey.
Device	get() Retrieves the device information for this device.
void	get(Callback<Device> callback) Retrieves the device information for this device.
Device	get(String deviceId) Retrieves the device information for the device id provided.
void	get(String deviceId, Callback<Device> callback) Retrieves the device information for the device id provided.
ListDevicesResult	list() Lists the devices attached to the user's account.
void	list(Callback<ListDevicesResult> callback) Lists the devices attached to the user's account.
ListDevicesResult	list(Integer limit, String paginationToken) Lists the devices attached to the user's account.
void	list(Integer limit, String paginationToken, Callback<ListDevicesResult> callback) Lists the devices attached to the user's account.
void	updateStatus(boolean rememberDevice) Update this device status to be remembered or not remembered
void	updateStatus(boolean rememberDevice, Callback<Void> callback) Update this device status to be remembered or not remembered
void	updateStatus(String deviceKey, boolean rememberDevice) Update the device status to be remembered or not remembered
void	updateStatus(String deviceKey, boolean rememberDevice, Callback<Void> callback)

Methods inherited from class java.lang.Object

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

Method Detail

get

public Device get()
           throws Exception

Retrieves the device information for this device.

Returns:

device details

Throws:

Exception

get

public void get(Callback<Device> callback)

Retrieves the device information for this device.

get

public Device get(String deviceId)
           throws Exception

Retrieves the device information for the device id provided.

Returns:

device details

Throws:

Exception

get

public void get(String deviceId,
                Callback<Device> callback)

Retrieves the device information for the device id provided.

list

public ListDevicesResult list()
                       throws Exception

Lists the devices attached to the user's account.

Returns:

a device list with a pagination token to retrieve more if applicable

Throws:

Exception

list

public void list(Callback<ListDevicesResult> callback)

Lists the devices attached to the user's account.

list

public ListDevicesResult list(Integer limit,
                              String paginationToken)
                       throws Exception

Lists the devices attached to the user's account.

Parameters:

limit - the number of devices to return per page. Max allows by service is 60.

paginationToken - the string returned by a previous list call to fetched the next page of results.

Returns:

Throws:

Exception

list

public void list(Integer limit,
                 String paginationToken,
                 Callback<ListDevicesResult> callback)

Lists the devices attached to the user's account.

Parameters:

limit - the number of devices to return per page. Max allows by service is 60.

paginationToken - the string returned by a previous list call to fetched the next page of results.

updateStatus

public void updateStatus(boolean rememberDevice)
                  throws Exception

Update this device status to be remembered or not remembered

Parameters:

rememberDevice - true to set the device as remembered, false otherwise

Throws:

Exception

updateStatus

public void updateStatus(boolean rememberDevice,
                         Callback<Void> callback)

Update this device status to be remembered or not remembered

Parameters:

rememberDevice - true to set the device as remembered, false otherwise

Throws:

Exception

updateStatus

public void updateStatus(String deviceKey,
                         boolean rememberDevice)
                  throws Exception

Update the device status to be remembered or not remembered

Parameters:

rememberDevice - true to set the device as remembered, false otherwise

Throws:

Exception

updateStatus

public void updateStatus(String deviceKey,
                         boolean rememberDevice,
                         Callback<Void> callback)

forget

public void forget()
            throws Exception

Forget the current device. The device will no longer be tracked. Note: Calling updateStatus(boolean) after forget() will fail. The user needs to sign-out and sign-in again to be able to update the device status.

Throws:

Exception

forget

public void forget(Callback<Void> callback)

Forget the current device. The device will no longer be tracked. Note: Calling updateStatus(boolean) after forget() will fail. The user needs to sign-out and sign-in again to be able to update the device status.

forget

public void forget(String deviceKey)
            throws Exception

Forget the device identified by the deviceKey. The device will no longer be tracked. Note: Calling updateStatus(boolean) after forget() will fail. The user needs to sign-out and sign-in again to be able to update the device status.

Parameters:

deviceKey - the device identifier

Throws:

Exception

forget

public void forget(String deviceKey,
                   Callback<Void> callback)

Forget the device identified by the deviceKey. The device will no longer be tracked. Note: Calling updateStatus(boolean) after forget() will fail. The user needs to sign-out and sign-in again to be able to update the device status.

Parameters:

deviceKey - the device identifier