com.microstrategy.usher

Class DeviceManager

java.lang.Object

com.microstrategy.usher.DeviceManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

public class DeviceManager
extends java.lang.Object
implements android.arch.lifecycle.LifecycleObserver

The DeviceManager class takes care of the responsibilities of managing badges across all devices. Device management includes processes such as listing all badges on the current device, listing all devices that have a specific badge installed, and revoking a badge on a device. All of these methods will be executed on a background thread and return the result on the main thread. To receive the result, you are expected to pass a corresponding SingleCallback or CompleteCallback.

To list all devices that have a specific badge installed, call list(int, SingleCallback). With the List of DeviceBadgeItem objects, you can revoke a badge on a device by specifying the BadgeEntity.badgeId() and the device UUID found in the DeviceBadgeItem.deviceEntity()}.

To list all devices that have installed any badge on the current device, call list(SingleCallback). The result will be encapsulated in a List of DeviceModel objects. With this list of devices, you can revoke the badge on a specific device through revoke(int, String, CompleteCallback). If the badge requires mobile phone number verification before being revoked, CompleteCallback.onError(DomainException) will be called with the error code DomainException.DEVICE_PROVISION_REQUIRED. Then, the phone registered with the mobile phone number will automatically receive the device provisioning code for deactivation. With the code, you can resume revoking the badge by calling revoke(int, String, String, CompleteCallback).

This class also includes clear(CompleteCallback), which is used to delete all badge information on the device from both the server and the cache. Once this is performed, badge recovery will be required to use the badge on the current device.

Constructor Summary

Constructors

Constructor and Description
DeviceManager(android.support.v7.app.AppCompatActivity appCompatActivity) Constructor for an DeviceManager object with the lifecycle set.
DeviceManager(android.support.v4.app.Fragment fragment) Constructor for an DeviceManager object with the lifecycle set.
DeviceManager(android.arch.lifecycle.Lifecycle lifecycle) Constructor for an DeviceManager object with the lifecycle set.

Method Summary

Modifier and Type	Method and Description
void	clear(CompleteCallback callback) Returns a CompleteCallback after clearing all of the badges on the current device from both the server and cache.
void	get(java.lang.String deviceUuid, SingleCallback<DeviceModel> callback) Returns the DeviceModel object that contains the DeviceBadgeItem.deviceEntity() object and the List of DeviceBadgeModel objects on the given device.
void	list(int badgeId, SingleCallback<java.util.List<DeviceBadgeItem>> callback) Returns the List of DeviceBadgeItem objects that have a specific badge installed.
void	list(SingleCallback<java.util.List<DeviceModel>> callback) Returns the List of DeviceModel objects that have installed any of the badges on the current device.
void	request(int badgeId, CompleteCallback callback) Returns a CompleteCallback after requesting a 6-digit verification code to be sent to the mobile phone number associated with the badge ID, found at BadgeUIEntity.defaultEnrolledPhoneNumber().
void	revoke(int badgeId, java.lang.String deviceUuid, CompleteCallback callback) Returns a CompleteCallback after revoking a badge on a specific device, given the device UUID from DeviceBadgeItem.deviceEntity()}.
void	revoke(int badgeId, java.lang.String deviceUuid, java.lang.String code, CompleteCallback callback) Returns a CompleteCallback after revoking a badge that requires mobile phone number verification on a specific device, given the device UUID from DeviceBadgeItem.deviceEntity()} and the device provisioning deactivation code sent to the phone.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceManager

public DeviceManager(android.arch.lifecycle.Lifecycle lifecycle)

Constructor for an DeviceManager object with the lifecycle set.

Parameters:

lifecycle - See Lifecycle

DeviceManager

public DeviceManager(android.support.v7.app.AppCompatActivity appCompatActivity)

Constructor for an DeviceManager object with the lifecycle set.

Parameters:

appCompatActivity - See AppCompatActivity

DeviceManager

public DeviceManager(android.support.v4.app.Fragment fragment)

Constructor for an DeviceManager object with the lifecycle set.

Parameters:

fragment - See Fragment

Method Detail

clear

public void clear(CompleteCallback callback)

Returns a CompleteCallback after clearing all of the badges on the current device from both the server and cache. Badge recovery is required to access the badge again.

Parameters:

callback - the callback to receive the result of clearing all of the badges on the current device

get

public void get(@Nullable
                java.lang.String deviceUuid,
                SingleCallback<DeviceModel> callback)

Returns the DeviceModel object that contains the DeviceBadgeItem.deviceEntity() object and the List of DeviceBadgeModel objects on the given device.

Parameters:

deviceUuid - the universally unique identifier (UUID) of the device. May be null if you want to get the current device

callback - the callback to receive the DeviceModel object

list

public void list(SingleCallback<java.util.List<DeviceModel>> callback)

Returns the List of DeviceModel objects that have installed any of the badges on the current device.

Parameters:

callback - the callback to receive a list of DeviceModel objects

See Also:

list(int, SingleCallback)

list

public void list(int badgeId,
                 SingleCallback<java.util.List<DeviceBadgeItem>> callback)

Returns the List of DeviceBadgeItem objects that have a specific badge installed.

Parameters:

badgeId - the identification number of the badge to be queried

callback - the callback to receive a list of DeviceBadgeItem objects

See Also:

list(SingleCallback)

request

public void request(int badgeId,
                    CompleteCallback callback)

Returns a CompleteCallback after requesting a 6-digit verification code to be sent to the mobile phone number associated with the badge ID, found at BadgeUIEntity.defaultEnrolledPhoneNumber(). After the code is sent, you can deactivate the badge with the code by calling revoke(int, String, String, CompleteCallback). This is only required for badges that require device provisioning.

Parameters:

badgeId - the identification number of the badge

callback - the callback after requesting a 6-digit verification code to be sent to the mobile phone number associated with the badge ID

See Also:

to remove a badge with device provisioning, to remove a badge without device provisioning

revoke

public void revoke(int badgeId,
                   java.lang.String deviceUuid,
                   CompleteCallback callback)

Returns a CompleteCallback after revoking a badge on a specific device, given the device UUID from DeviceBadgeItem.deviceEntity()}. You can get the List of DeviceBadgeItem objects that have a specific badge installed by calling list(int, SingleCallback).

Parameters:

badgeId - the identification number of the badge

deviceUuid - the universally unique identifier (UUID) of the device

callback - the callback to receive the result of revoking a badge on the given device

See Also:

revoke(int, String, String, CompleteCallback)

revoke

public void revoke(int badgeId,
                   java.lang.String deviceUuid,
                   java.lang.String code,
                   CompleteCallback callback)

Returns a CompleteCallback after revoking a badge that requires mobile phone number verification on a specific device, given the device UUID from DeviceBadgeItem.deviceEntity()} and the device provisioning deactivation code sent to the phone.

Parameters:

badgeId - the identification number of the badge

deviceUuid - the universally unique identifier (UUID) of the device

code - the device provisioning deactivation code sent to the mobile phone number enrolled with the badge

callback - the callback to receive the result of revoking a badge that requires mobile phone number verification on a specific device

See Also:

revoke(int, String, CompleteCallback)