com.adobe.cq.screens.device.registration

Interface PendingDevice

public interface PendingDevice

Pending device object that is to be registered.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PendingDevice.State The current state of the registration process.

Method Summary

Modifier and Type	Method and Description
JSONObject	getMetadata() Returns a json object that holds additional metadata which can be used to identify the device in the UI.
java.lang.String	getRegistrationCode() Returns the registration code that was sent by the device.
RegistrationResult	getRegistrationResult() Returns the result of the registration process, once the device is registered.
PendingDevice.State	getState() Returns the current registration state.
java.lang.String	getToken() Retrieves the device token.

Method Detail

getToken

java.lang.String getToken()

Retrieves the device token. This registration token is only used during registration and is not related to the final device id, which is assigned once the device is registered.

Returns:

the device token

getState

PendingDevice.State getState()

Returns the current registration state.

Returns:

the state

getRegistrationCode

java.lang.String getRegistrationCode()

Returns the registration code that was sent by the device.

Returns:

the registration code or null if the device isn't in registration mode yet.

getMetadata

JSONObject getMetadata()

Returns a json object that holds additional metadata which can be used to identify the device in the UI.

Returns:

a metadata object

getRegistrationResult

RegistrationResult getRegistrationResult()

Returns the result of the registration process, once the device is registered.

Returns:

the result or null