com.amazonaws.mobileconnectors.cognitoidentityprovider

Class CognitoDevice

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoDevice

public class CognitoDevice
extends Object

This class is an abstraction for a tracked device. A instance of this class represents one tracked device and encapsulates all details for that device. This class provides methods to access the device details. The device attributes are stored as an object of CognitoUserAttributes.

Constructor Summary

Constructors

Constructor and Description
CognitoDevice(DeviceType device, CognitoUser user, android.content.Context context) Constructs a CognitoDevice object with DeviceType object.
CognitoDevice(String deviceKey, CognitoUserAttributes deviceAttributes, Date createDate, Date lastModifiedDate, Date lastAccessedDate, CognitoUser user, android.content.Context context) Constructs an object of type CognitoDevice with device details.

Method Summary

Modifier and Type	Method and Description
void	doNotRememberThisDevice(GenericHandler callback) Marks this device as not trusted, runs in the current thread.
void	doNotRememberThisDeviceInBackground(GenericHandler callback) Marks this device as not trusted, runs in a background thread.
void	forgetDevice(GenericHandler callback) Stops tracking this device, runs in the current thread.
void	forgetDeviceInBackground(GenericHandler callback) Stops tracking this device, runs in a background thread.
Date	getCreateDate() Returns the date this device was created in the Cognito User Pools, that is the date when the service started tracking this device.
void	getDevice(GenericHandler callback) Fetches device properties, in the current thread.
String	getDeviceAttribute(String attributeName) Returns the value assigned for a specific attribute for this device.
CognitoUserAttributes	getDeviceAttributes() Returns all device attributes as an CognitoUserAttributes object.
void	getDeviceInBackground(GenericHandler callback) Fetches device properties.
String	getDeviceKey() Returns the key of this device.
String	getDeviceName() Returns the name of this device.
Date	getLastAccessedDate() The date when the device details were last read.
Date	getLastModifiedDate() Returns the date when attributes for this device were last modified.
void	rememberThisDevice(GenericHandler callback) Marks this device as trusted, runs in the current thread.
void	rememberThisDeviceInBackground(GenericHandler callback) Marks this device as trusted, runs in a background.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoDevice

public CognitoDevice(String deviceKey,
                     CognitoUserAttributes deviceAttributes,
                     Date createDate,
                     Date lastModifiedDate,
                     Date lastAccessedDate,
                     CognitoUser user,
                     android.content.Context context)

Constructs an object of type CognitoDevice with device details.

Parameters:

deviceKey - REQUIRED: The device key.

deviceAttributes - REQUIRED: All devices attributes, stored as a CognitoUserAttributes object.

createDate - REQUIRED: The date when the device tracking last began.

lastModifiedDate - REQUIRED: The date on which the device attributes were last modified.

lastAccessedDate - REQUIRED: The date this device details were last read.

user - REQUIRED: The CognitoUser this device is linked to.

context - REQUIRED: App context.

CognitoDevice

public CognitoDevice(DeviceType device,
                     CognitoUser user,
                     android.content.Context context)

Constructs a CognitoDevice object with DeviceType object.

Parameters:

device - REQUIRED: A DeviceType object.

user - REQUIRED: The CognitoUser this device is linked to.

context - REQUIRED: App context.

Method Detail

getDeviceKey

public String getDeviceKey()

Returns the key of this device.

Returns:

device key.

getDeviceAttributes

public CognitoUserAttributes getDeviceAttributes()

Returns all device attributes as an CognitoUserAttributes object.

Returns:

device attributes as an CognitoUserAttributes object.

getDeviceAttribute

public String getDeviceAttribute(String attributeName)

Returns the value assigned for a specific attribute for this device. The attribute name is passed as a string. Returns null if this attribute is not set for this device.

Parameters:

attributeName - REQUIRED: The name of the attribute whose value is needed.

Returns:

value associated with the passed attribute name as a string, returns null if the attribute does not have any value set.

getDeviceName

public String getDeviceName()

Returns the name of this device.

Returns:

Name of the device.

getCreateDate

public Date getCreateDate()

Returns the date this device was created in the Cognito User Pools, that is the date when the service started tracking this device.

Returns:

the date when the device tracking began.

getLastModifiedDate

public Date getLastModifiedDate()

Returns the date when attributes for this device were last modified.

Returns:

the date when the device attributes were last modified.

getLastAccessedDate

public Date getLastAccessedDate()

The date when the device details were last read.

Returns:

the date when the device details were last read.

getDeviceInBackground

public void getDeviceInBackground(GenericHandler callback)

Fetches device properties. Call this method to ensure the device properties are current. Reading device properties from this object can return null values.

Parameters:

callback - REQUIRED: GenericHandler callback.

getDevice

public void getDevice(GenericHandler callback)

Fetches device properties, in the current thread. Call this method to ensure the device properties are current. Reading device properties from this object can return null values.

Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.

Parameters:

callback - REQUIRED: GenericHandler callback.

forgetDeviceInBackground

public void forgetDeviceInBackground(GenericHandler callback)

Stops tracking this device, runs in a background thread.

Parameters:

callback - REQUIRED: GenericHandler callback.

forgetDevice

public void forgetDevice(GenericHandler callback)

Stops tracking this device, runs in the current thread.

Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.

Parameters:

callback - REQUIRED: GenericHandler callback.

rememberThisDeviceInBackground

public void rememberThisDeviceInBackground(GenericHandler callback)

Marks this device as trusted, runs in a background.

Parameters:

callback - REQUIRED: GenericHandler callback.

rememberThisDevice

public void rememberThisDevice(GenericHandler callback)

Marks this device as trusted, runs in the current thread.

Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.

Parameters:

callback - REQUIRED: GenericHandler callback.

doNotRememberThisDeviceInBackground

public void doNotRememberThisDeviceInBackground(GenericHandler callback)

Marks this device as not trusted, runs in a background thread.

Parameters:

callback - REQUIRED: GenericHandler callback.

doNotRememberThisDevice

public void doNotRememberThisDevice(GenericHandler callback)

Marks this device as not trusted, runs in the current thread.

Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.

Parameters:

callback - REQUIRED: GenericHandler callback.