com.microstrategy.usher

Class BadgeManager

java.lang.Object

com.microstrategy.usher.BadgeManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

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

The BadgeManager class collects all of the use cases related to badge management. Badge management includes retrieving BadgeEntity or BadgeModel objects from any source and deleting badges. All badges processes will be performed on the current device on the current server, unless otherwise stated. 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 acknowledgeLegalAgreement(int, boolean, boolean, SingleCallback), which is used to acknowledge the terms of use/privacy policy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	acknowledgeLegalAgreement(int badgeId, boolean resolvePrivacyPolicy, boolean resolveTermOfUse, SingleCallback<java.lang.Boolean> callback) Returns a boolean that represents whether or not the legal agreement acknowledgement was successful.
void	delete(int badgeId, CompleteCallback callback) Returns a CompleteCallback after deleting a badge.
void	delete(java.util.List<java.lang.Integer> badgeIdList, CompleteCallback callback) Returns a CompleteCallback after deleting a List of badges.
void	get(int badgeId, boolean forceRefresh, SingleCallback<BadgeEntity> callback) Returns a BadgeEntity object for the given badge ID.
void	get(int badgeId, SingleCallback<BadgeEntity> callback) Returns a BadgeEntity object for the given badge ID.
void	getBadgeModel(int badgeId, boolean forceRefresh, SingleCallback<BadgeModel> callback) Returns a BadgeModel object for a given badge ID.
void	getBadgeModel(int badgeId, SingleCallback<BadgeModel> callback) Returns a BadgeModel object for a given badge ID.
java.util.List<BadgeIdOrgIdEntity>	list() Returns a List of BadgeIdOrgIdEntity objects.
void	list(boolean forceRefresh, SingleCallback<java.util.List<BadgeModel>> callback) Returns a List of BadgeModel objects.
void	list(SingleCallback<java.util.List<BadgeModel>> callback) Returns a List of BadgeModel objects.
void	listBadgeExceedLimitEntity(SingleCallback<java.util.List<BadgeExceedLimitEntity>> callback) returns a List of BadgeExceedLimitEntity objects after checking to see if any badges have exceeded the maximum limit of badge installations on devices defined on Network Manager.
void	observe(int badgeId, ObserverCallback<BadgeDetailModel> callback) Returns a BadgeDetailModel object that is used in the Badge Detail View.

Methods inherited from class java.lang.Object

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

Constructor Detail

BadgeManager

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

Constructor for an BadgeManager object with the lifecycle set.

Parameters:

lifecycle - See Lifecycle

BadgeManager

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

Constructor for an BadgeManager object with the lifecycle set.

Parameters:

appCompatActivity - See AppCompatActivity

BadgeManager

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

Constructor for an BadgeManager object with the lifecycle set.

Parameters:

fragment - See Fragment

Method Detail

acknowledgeLegalAgreement

public void acknowledgeLegalAgreement(int badgeId,
                                      boolean resolvePrivacyPolicy,
                                      boolean resolveTermOfUse,
                                      SingleCallback<java.lang.Boolean> callback)

Returns a boolean that represents whether or not the legal agreement acknowledgement was successful.

Parameters:

badgeId - the identification number of the badge

resolvePrivacyPolicy - true if the privacy policy has been acknowledged; false otherwise

resolveTermOfUse - true if the terms of use have been acknowledged; false otherwise

callback - the callback to receive the boolean result: true if the legal agreement acknowledgement was successful; false otherwise

delete

public void delete(int badgeId,
                   CompleteCallback callback)

Returns a CompleteCallback after deleting a badge.

Parameters:

badgeId - the identification number of the badge

callback - the callback to receive the result of deleting a badge

delete

public void delete(java.util.List<java.lang.Integer> badgeIdList,
                   CompleteCallback callback)

Returns a CompleteCallback after deleting a List of badges.

Parameters:

badgeIdList - the List of badge IDs

callback - the callback to receive the result of deleting a List of badges

get

public void get(int badgeId,
                SingleCallback<BadgeEntity> callback)

Returns a BadgeEntity object for the given badge ID.

Parameters:

badgeId - the identification number of the badge

callback - the callback to receive the BadgeEntity object for the given badge ID

get

public void get(int badgeId,
                boolean forceRefresh,
                SingleCallback<BadgeEntity> callback)

Returns a BadgeEntity object for the given badge ID.

Parameters:

badgeId - the identification number of the badge

forceRefresh - if the BadgeEntity object should be fetched from the server; false if the BadgeEntity object should be retrieved from the cache

callback - the callback to receive the BadgeEntity object for the given badge ID

getBadgeModel

public void getBadgeModel(int badgeId,
                          SingleCallback<BadgeModel> callback)

Returns a BadgeModel object for a given badge ID. Will be retrieved from the cache.

Parameters:

badgeId - the identification number of the badge

callback - the callback to receive the BadgeModel object for a given badge ID

getBadgeModel

public void getBadgeModel(int badgeId,
                          boolean forceRefresh,
                          SingleCallback<BadgeModel> callback)

Returns a BadgeModel object for a given badge ID. May be retrieved from the server or from the cache.

Parameters:

badgeId - the identification number of the badge

forceRefresh - true if the BadgeModel object should be fetched from the server; false if the BadgeModel object should be retrieved from the cache

callback - the callback to receive the BadgeModel object for a given badge ID

list

public java.util.List<BadgeIdOrgIdEntity> list()

Returns a List of BadgeIdOrgIdEntity objects.

Returns:

the List of BadgeIdOrgIdEntity objects.

list

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

Returns a List of BadgeModel objects. Will be retrieved from the cache.

Parameters:

callback - the callback to receive the List of BadgeModel objects

list

public void list(boolean forceRefresh,
                 SingleCallback<java.util.List<BadgeModel>> callback)

Returns a List of BadgeModel objects. May be retrieved from the server or from the cache.

Parameters:

forceRefresh - true if the List of BadgeModel objects should be fetched from the server; false if the List of BadgeModel objects should be retrieved from the cache

callback - the callback to receive the List of BadgeModel objects

listBadgeExceedLimitEntity

public void listBadgeExceedLimitEntity(SingleCallback<java.util.List<BadgeExceedLimitEntity>> callback)

returns a List of BadgeExceedLimitEntity objects after checking to see if any badges have exceeded the maximum limit of badge installations on devices defined on Network Manager.

Parameters:

callback - the callback to receive the List of BadgeExceedLimitEntity objects after checking to see if any badges have exceeded the maximum limit of badge installations on devices defined on Network Manager

observe

public void observe(int badgeId,
                    ObserverCallback<BadgeDetailModel> callback)

Returns a BadgeDetailModel object that is used in the Badge Detail View. The Badge Detail View is composed of a header, the BadgeDetailHeadViewModel, and a dynamic list of attributes, the BadgeDetailAttributeModel.

Parameters:

badgeId - the identification number of the badge

callback - the callback to receive the corresponding BadgeDetailModel object