com.microstrategy.usher

Class BadgeRecoveryManager

java.lang.Object

com.microstrategy.usher.BadgeRecoveryManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

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

The BadgeRecoveryManager class collects all of the use cases related to badge recovery. Badge recovery includes processes to request a badge recovery email and to recover your badge, either through a badge invitation/recovery code or through a Deeplink URL. All of these methods will be executed on a background thread and will return the result on the main thread. To receive the result, you are expected to pass the corresponding SingleCallback or CompleteCallback.

This class also includes login(BadgeLoginParam, SingleCallback), which takes a BadgeLoginParam that is constructed from the user's credentials (i.e. user name/password) and the organization ID, and returns a BadgeEntity object. This method is only valid for environments that are set up with active directory.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	login(BadgeLoginParam badgeLoginParam, SingleCallback<BadgeEntity> callback) Returns a BadgeEntity object after logging into and refreshing a badge.
void	recover(java.lang.String code, boolean badgeInvitation, SingleCallback<java.util.List<BadgeEntity>> callback) Returns a List of BadgeEntity objects after using the badge recovery code or badge invitation code to recover badges.
void	recover(java.lang.String deeplink, SingleCallback<java.util.List<BadgeEntity>> callback) Returns a List of BadgeEntity objects after accessing a Deeplink URL to recover badges.
void	request(java.lang.String emailAddress, CompleteCallback callback) Returns a CompleteCallback after requesting a badge recovery email for the specified email address.

Methods inherited from class java.lang.Object

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

Constructor Detail

BadgeRecoveryManager

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

Constructor for an BadgeRecoveryManager object with the lifecycle set.

Parameters:

lifecycle - See Lifecycle

BadgeRecoveryManager

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

Constructor for an BadgeRecoveryManager object with the lifecycle set.

Parameters:

appCompatActivity - See AppCompatActivity

BadgeRecoveryManager

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

Constructor for an BadgeRecoveryManager object with the lifecycle set.

Parameters:

fragment - See Fragment

Method Detail

login

public void login(BadgeLoginParam badgeLoginParam,
                  SingleCallback<BadgeEntity> callback)

Returns a BadgeEntity object after logging into and refreshing a badge.

Parameters:

badgeLoginParam - the parameter for performing a badge login request. See BadgeLoginParam

callback - the callback to receive the BadgeEntity object after logging into and refreshing a badge

recover

public void recover(java.lang.String deeplink,
                    SingleCallback<java.util.List<BadgeEntity>> callback)

Returns a List of BadgeEntity objects after accessing a Deeplink URL to recover badges.

Parameters:

deeplink - the Deeplink URL

callback - the callback to receive the List of BadgeEntity objects after accessing a Deeplink URL to recover badges

recover

public void recover(java.lang.String code,
                    boolean badgeInvitation,
                    SingleCallback<java.util.List<BadgeEntity>> callback)

Returns a List of BadgeEntity objects after using the badge recovery code or badge invitation code to recover badges.

Parameters:

code - the specific code to recover the badge.

badgeInvitation - true if it is badge invitation code; false otherwise (i.e. if it is badge recovery code)

callback - the callback to receive the List of BadgeEntity objects after using the badge recovery code or badge invitation code to recover badges

request

public void request(java.lang.String emailAddress,
                    CompleteCallback callback)

Returns a CompleteCallback after requesting a badge recovery email for the specified email address.

Parameters:

emailAddress - the email address to receive the badge recovery email

callback - the callback to receive the result of requesting a badge recovery email