Skip navigation links
A B C D E F G H I K L M N O P Q R S T U V W Z 

A

access(KeyParam, SingleCallback<PairEntity<Boolean, String>>) - Method in class com.microstrategy.usher.KeyManager
Returns a PairEntity object that includes the access success result and the name of the key after attempting physical access.
AccessResourceResult - Class in com.microstrategy.usher
The AccessResourceResult object wraps the logical and physical access request result.
AccessResourceResult.ResultType - Enum in com.microstrategy.usher
The types of results for accessing a physical or logical resource.
acknowledgeLegalAgreement(int, boolean, boolean, SingleCallback<Boolean>) - Method in class com.microstrategy.usher.BadgeManager
Returns a boolean that represents whether or not the legal agreement acknowledgement was successful.
ACTION_OBSERVE_BEACON_EVENT - Static variable in class com.microstrategy.usher.UsherSdkIntentContracts
This is exposed to observe the beacon event object.
ACTION_OBSERVE_INBOX_ENTITY - Static variable in class com.microstrategy.usher.UsherSdkIntentContracts
This is exposed to observe the InboxEntity object serialized as a JSON string, sent from the SDK through a BroadcastReceiver.
ACTION_OBSERVE_PUSH_NOTIFICATION_ENTITY - Static variable in class com.microstrategy.usher.UsherSdkIntentContracts
This is exposed to observe the PushNotificationEntity object serialized as a JSON string, sent from the SDK through a BroadcastReceiver.
actionItemType(int) - Method in class com.microstrategy.usher.PushNotificationModel.Builder
 
actionMessage() - Method in class com.microstrategy.usher.BeaconEntity
Returns a String of the button text of a beacon action.
actionRequiredCount() - Method in class com.microstrategy.usher.UsherSettingModel
Returns an int of the number of actions that the user can take involving their badges.
actions() - Method in class com.microstrategy.usher.BeaconEntity
Returns the List of BeaconEntity.Action objects that includes various information related to action items, including ID, type, and a message.
actionType() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns an int of the type of action that was paired with the QR or barcode that was scanned.
activated(long) - Method in class com.microstrategy.usher.BadgeEntity
Returns a boolean that represents whether or not the badge has been activated.
activated() - Method in class com.microstrategy.usher.BadgeModel
Returns a boolean that represents whether or not the badge is activated.
activeBeaconExist() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not the organization has active beacons.
addMainObserver(Observer, String) - Method in class com.microstrategy.usher.CppManager
 
addObserver(Observer, String) - Method in class com.microstrategy.usher.CppManager
 
admin() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not the badge has administrative privileges on Network Manager.
admin() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has administrative rights on Network Manager.
ADMIN_BADGE_REQUIRED - Static variable in exception com.microstrategy.usher.DomainException
 
allFailure() - Method in class com.microstrategy.usher.ScannerResultEntity
Returns a boolean that represents whether or not all the badges on a device unsuccessfully processed the scan.
allSuccess() - Method in class com.microstrategy.usher.ScannerResultEntity
Returns a boolean that represents whether or not all the badges on a device successfully processed the scan.
areContentsTheSame(KeyEntity) - Method in class com.microstrategy.usher.KeyEntity
Returns a boolean that represents whether or not the contents of two keys are the same.
areContentsTheSame(KeyModel) - Method in class com.microstrategy.usher.KeyModel
Returns a boolean that represents whether or not the contents of two keys are the same.
areItemsTheSame(KeyEntity) - Method in class com.microstrategy.usher.KeyEntity
Returns a boolean that represents whether or not the items of two keys are the same.
areItemsTheSame(KeyModel) - Method in class com.microstrategy.usher.KeyModel
Returns a boolean that represents whether or not the items of two keys are the same.
ATTRIBUTE_ID_BADGE_ID - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Badge ID.
ATTRIBUTE_ID_BADGE_NAME - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Badge name.
ATTRIBUTE_ID_BLUETOOTH - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Bluetooth.
ATTRIBUTE_ID_DATE_ISSUED - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Badge issue date.
ATTRIBUTE_ID_EMAIL - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The email address linked to the badge.
ATTRIBUTE_ID_ENROLLED_WITH - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Mobile phone number linked to the badge with country code prepended.
ATTRIBUTE_ID_EXTRA_ATTRIBUTE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Any additional attribute not captured by the other types.
ATTRIBUTE_ID_LOCATION_SERVICE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Location Services.
ATTRIBUTE_ID_ORG - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Organization name.
ATTRIBUTE_ID_PASSCODE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Passcode.
ATTRIBUTE_ID_PRIVACY_POLICY - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Privacy policy.
ATTRIBUTE_ID_REMOVE_BADGE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
"Delete Badge" button.
ATTRIBUTE_ID_TERM_OF_USE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Terms of use.
ATTRIBUTE_ID_TOTP_CODE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Time-based one-time password (TOTP).
ATTRIBUTE_ID_USER_VALIDATION - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
User validation.
ATTRIBUTE_ID_USHER_CODE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
MicroStrategy Badge (Usher) code.
attributeId() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns an int of the identification number of the attribute.
authenticationRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not active directory (i.e.
availableItemList() - Method in class com.microstrategy.usher.TimeRestrictionModel
Returns a List of TimeRestrictionModel.Item objects.
availableSessionDisplayValue() - Method in class com.microstrategy.usher.TimeRestrictionModel
Returns a String of all of the time intervals during which a badge is not subject to a badge enablement time restriction.

B

backgroundColor() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the background color.
backgroundColor() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a String of the background color.
backgroundColor() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns a String of the background color.
backgroundColor() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the background color of badges.
backgroundColor() - Method in class com.microstrategy.usher.ScannerResultEntity.Item
Returns a String of the background color of the scan result.
backgroundImageUrl() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the URL of the background image.
backgroundImageUrl() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the URL of the background image.
backgroundImageUrlCheckSum() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the checksum of the URL of the background image.
backgroundImageUrlCheckSum() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the checksum of the URL of the background image.
BADGE_CONDITION_NOT_MET - Static variable in exception com.microstrategy.usher.DomainException
 
BADGE_NEED_RE_LOGIN - Static variable in exception com.microstrategy.usher.DomainException
 
BADGE_PICKER_REQUIRED - Static variable in exception com.microstrategy.usher.DomainException
 
BADGE_QR_CODE_INVALID - Static variable in exception com.microstrategy.usher.DomainException
 
BADGE_RECOVERY_CODE_NOT_EXIST - Static variable in exception com.microstrategy.usher.DomainException
 
BADGE_REMOVED - Static variable in exception com.microstrategy.usher.DomainException
 
badgeAdditionInfoItemList() - Method in class com.microstrategy.usher.BadgeEntity
Returns the List of BadgeAdditionInfoItem objects that wrap core attribute items related to the badge for use as a key/value pair.
badgeColor() - Method in class com.microstrategy.usher.BadgeRestrictionModel
Returns a String of the badge color.
BadgeCondition - Class in com.microstrategy.usher
The BadgeCondition abstract class wraps all the attributes related to conditions that are restricting the badge from use.
BadgeCondition.Config - Class in com.microstrategy.usher
The BadgeCondition.Config abstract class wraps the properties related to badge condition configurations on Network Manager.
BadgeCondition.Config.Builder - Class in com.microstrategy.usher
The BadgeCondition.Config.Builder abstract class allows the user to create and return a BadgeCondition.Config object.
badgeConditionConfig(BadgeCondition.Config) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
BadgeConditionException - Exception in com.microstrategy.usher
The BadgeConditionException class is thrown when a BadgeCondition prevents the badge from being used.
BadgeConditionException(int, BadgeEntity) - Constructor for exception com.microstrategy.usher.BadgeConditionException
Construct for a BadgeConditionException with the type and badgeEntity set.
badgeCount() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns an int of the number of badges that were involved in the scan.
badgeCount() - Method in class com.microstrategy.usher.ServerModel
Returns an int of the number of badges on the server.
badgeCount() - Method in class com.microstrategy.usher.UsherSettingModel
Returns the total count of badges that have been installed on the current device.
BadgeDetailAttributeModel - Class in com.microstrategy.usher
The BadgeDetailAttributeModel abstract class identifies the properties related to attributes on the Badge Detail View.
badgeDetailAttributeModelList() - Method in class com.microstrategy.usher.BadgeDetailModel
Returns a List of BadgeDetailAttributeModel objects.
BadgeDetailHeadViewModel - Class in com.microstrategy.usher
The BadgeDetailHeadViewModel abstract class identifies the properties related to information displayed in the header in the Badge Detail View.
badgeDetailHeadViewModel() - Method in class com.microstrategy.usher.BadgeDetailModel
Returns a BadgeDetailHeadViewModel object.
BadgeDetailModel - Class in com.microstrategy.usher
The BadgeDetailModel abstract class identifies the properties related to the Badge Detail View.
BadgeEntity - Class in com.microstrategy.usher
The BadgeEntity abstract class wraps the core attributes pertaining to the badge.
badgeEntity() - Method in class com.microstrategy.usher.BadgeModel
Returns a BadgeEntity object that wraps the core attributes pertaining to the badge.
BadgeEntity.Status - Enum in com.microstrategy.usher
The various enumerations for Status.
BadgeExceedLimitEntity - Class in com.microstrategy.usher
The BadgeExceedLimitEntity abstract class wraps the attributes pertaining to a badge that has exceeded the maximum limit of badge installations on devices defined on Network Manager.
badgeId() - Method in class com.microstrategy.usher.BadgeEntity
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.BadgeExceedLimitEntity
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.InboxEntity
Returns an int of the identification number of the badge, which received the notification.
badgeId() - Method in class com.microstrategy.usher.InboxEntity.SenderEntity
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.KeyEntity
Returns an int of the identification number of the badge the key belongs to.
badgeId() - Method in class com.microstrategy.usher.KeyModel
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.KeyParam
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.LegalConsentEntity
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.PushNotificationEntity
Returns an int of the identification number of the badge.
badgeId() - Method in class com.microstrategy.usher.ScannerData
Returns an int of the identification number of the badge.
badgeId(int) - Method in class com.microstrategy.usher.ScannerData.Builder
Returns the ScannerData.Builder for the ScannerData.badgeId() component of the ScannerData object.
badgeId() - Method in class com.microstrategy.usher.ScannerResultEntity.Item
Returns an int of the identification number of the badge.
BadgeIdOrgIdEntity - Class in com.microstrategy.usher
The BadgeIdOrgIdEntity abstract class wraps a badge ID with an organization ID, along with certain other attributes pertaining to an organization.
BadgeLoginParam - Class in com.microstrategy.usher
The BadgeLoginParam abstract class wraps fields related to a badge login request.
BadgeLoginParam.Builder - Class in com.microstrategy.usher
The BadgeLoginParam.Builder abstract class allows the user to create and return a BadgeLoginParam object.
BadgeManager - Class in com.microstrategy.usher
The BadgeManager class collects all of the use cases related to badge management.
BadgeManager(Lifecycle) - Constructor for class com.microstrategy.usher.BadgeManager
Constructor for an BadgeManager object with the lifecycle set.
BadgeManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.BadgeManager
Constructor for an BadgeManager object with the lifecycle set.
BadgeManager(Fragment) - Constructor for class com.microstrategy.usher.BadgeManager
Constructor for an BadgeManager object with the lifecycle set.
BadgeMiniModel - Class in com.microstrategy.usher
The BadgeMiniModel abstract class identifies the properties related to attributes found on the miniature badge models used on the Badge Management View and Badge Deletion View.
BadgeModel - Class in com.microstrategy.usher
The BadgeModel abstract class wraps the core attributes pertaining to the badge found in a BadgeEntity with other more dynamic attributes, such as the list of pending badge conditions required to be satisfied before the badge is able to be used.
badgeName() - Method in class com.microstrategy.usher.BadgeExceedLimitEntity
Returns a String of the name of the badge.
badgeName() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a String of the name of the badge.
badgeName() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns a String of the name of the badge.
badgeName() - Method in class com.microstrategy.usher.KeyModel
Returns a String of the name of the badge.
badgeName() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the name of the badge.
badgeName() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns a String of the name of the badge that performed the scan.
badgeName() - Method in class com.microstrategy.usher.ScannerResultEntity.Item
Returns a String of the name of the badge.
BadgeRecoveryManager - Class in com.microstrategy.usher
The BadgeRecoveryManager class collects all of the use cases related to badge recovery.
BadgeRecoveryManager(Lifecycle) - Constructor for class com.microstrategy.usher.BadgeRecoveryManager
Constructor for an BadgeRecoveryManager object with the lifecycle set.
BadgeRecoveryManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.BadgeRecoveryManager
Constructor for an BadgeRecoveryManager object with the lifecycle set.
BadgeRecoveryManager(Fragment) - Constructor for class com.microstrategy.usher.BadgeRecoveryManager
Constructor for an BadgeRecoveryManager object with the lifecycle set.
badgeReportScannedDataEntityList() - Method in class com.microstrategy.usher.ScannerResultEntity
Returns an ArrayList of ScannerResultEntity.Item objects that wrap various attributes pertaining to the result of a scan.
BadgeRestrictionModel - Class in com.microstrategy.usher
The BadgeRestrictionModel abstract class identifies the properties related to badge enablement location and time restrictions.
badgeStatusEntity() - Method in class com.microstrategy.usher.BadgeEntity
Returns a BadgeStatusEntity object that includes various attributes about the current status of the badge related to logging in and being ready to use, including mobile phone number enrollment and verification and terms of use/privacy policy acknowledgement.
BadgeStatusEntity - Class in com.microstrategy.usher
The BadgeStatusEntity abstract class wraps various attributes about the current status of the badge related to logging in and being ready to use, including mobile phone number enrollment and verification and terms of use/privacy policy acknowledgement.
badgeUIEntity() - Method in class com.microstrategy.usher.BadgeEntity
Returns a BadgeUIEntity object that includes various attributes about the presentation of a badge, including organization name, employee name, and employee title, among others.
BadgeUIEntity - Class in com.microstrategy.usher
The BadgeUIEntity abstract class wraps various attributes about the presentation of a badge, including organization name, employee name, and employee title, among others.
BASIC_COLOR_BLUE - Static variable in class com.microstrategy.usher.OrgUIEntity
Basic blue background color.
BASIC_COLOR_GRAY - Static variable in class com.microstrategy.usher.OrgUIEntity
Basic gray background color.
BASIC_COLOR_GREEN - Static variable in class com.microstrategy.usher.OrgUIEntity
Basic green background color.
BASIC_COLOR_PURPLE - Static variable in class com.microstrategy.usher.OrgUIEntity
Basic purple background color.
BASIC_COLOR_RED - Static variable in class com.microstrategy.usher.OrgUIEntity
Basic red background color.
BeaconEntity - Class in com.microstrategy.usher
The BeaconEntity abstract class wraps various attributes related to a beacon.
BeaconEntity.Action - Class in com.microstrategy.usher
The BeaconEntity.Action abstract class wraps information related to action items, including ID, type, and a message.
beaconName() - Method in class com.microstrategy.usher.BeaconEntity
Returns a String of the name of the beacon.
bluetoothRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not Bluetooth is required before the badge is able to be used.
build() - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
Builds the BadgeCondition.Config object that is used to wrap various properties related to the badge condition configurations on Network Manager.
build() - Method in class com.microstrategy.usher.BadgeLoginParam.Builder
Builds the BadgeLoginParam object that wraps fields related to a badge login request.
build(int, int) - Static method in class com.microstrategy.usher.KeyParam
Constructor for a KeyParam object with the keyId and badgeId set.
build(int, int, String) - Static method in class com.microstrategy.usher.KeyParam
Constructor for a KeyParam object with the keyId, badgeId, and resourceId set.
build() - Method in class com.microstrategy.usher.PushNotificationModel.Builder
 
build() - Method in class com.microstrategy.usher.ScannerData.Builder
Builds the ScannerData object that is used to wrap various properties related to scanned data.
build() - Method in class com.microstrategy.usher.ServerModel.PreConfig.Builder
Builds the ServerModel.PreConfig object that wraps various properties about server configuration.
build() - Method in class com.microstrategy.usher.Usher
Build the generic network Retrofit API request with the configured server, which will handle all authorization requirement and so on.
build(GsonConverterFactory) - Method in class com.microstrategy.usher.Usher
Build the generic network Retrofit API request with the configured server, which will handle all authorization requirement and so on.
build() - Method in class com.microstrategy.usher.Usher.Configuration.Builder
Builds the Usher.Configuration object that wraps fields related to the server configuration.
builder() - Static method in class com.microstrategy.usher.BadgeCondition.Config
Returns the default BadgeCondition.Config.Builder object for the BadgeCondition.Config abstract class.
builder() - Static method in class com.microstrategy.usher.BadgeLoginParam
Returns the BadgeLoginParam.Builder object for the BadgeLoginParam abstract class.
Builder() - Constructor for class com.microstrategy.usher.PushNotificationModel.Builder
 
builder() - Static method in class com.microstrategy.usher.ScannerData
Returns the default ScannerData.Builder object for the ScannerData abstract class.
builder() - Static method in class com.microstrategy.usher.ServerModel.PreConfig
Returns the default ServerModel.PreConfig.Builder object for the ServerModel.PreConfig abstract class.
builder(Application) - Static method in class com.microstrategy.usher.Usher.Configuration
Returns the default Usher.Configuration.Builder object for the Usher.Configuration abstract class.

C

callback(Usher.Configuration.Callback) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
cancelNotification(Notification) - Method in class com.microstrategy.usher.CppManager
 
cancelNotificationByID(int) - Method in class com.microstrategy.usher.CppManager
 
cancelNotificationWithinThisCenter(Notification) - Method in class com.microstrategy.usher.CppManager
This will not call C++ code
certificateEnforced() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a boolean that represents whether or not the certificate is enforced.
clear(CompleteCallback) - Method in class com.microstrategy.usher.DeviceManager
Returns a CompleteCallback after clearing all of the badges on the current device from both the server and cache.
clientName() - Method in class com.microstrategy.usher.PushNotificationEntity
Returns a String of the client name.
codeDisplayType() - Method in class com.microstrategy.usher.OrgUIEntity
Returns an int of the type of code a badge should display.
colNumber() - Method in class com.microstrategy.usher.GroupKeyItemEntity
Returns an int of the column number the key is placed in.
com.microstrategy.usher - package com.microstrategy.usher
 
CompleteCallback - Interface in com.microstrategy.usher
The CompleteCallback interface represents an asynchronous callback without any value.
CONFIG_TYPE_ACTIVE - Static variable in class com.microstrategy.usher.BeaconEntity
Beacon is active.
CONFIG_TYPE_COMBINED - Static variable in class com.microstrategy.usher.BeaconEntity
Beacon has combined functionality (i.e.
CONFIG_TYPE_NONE - Static variable in class com.microstrategy.usher.BeaconEntity
Beacon is not configured.
CONFIG_TYPE_PASSIVE - Static variable in class com.microstrategy.usher.BeaconEntity
Beacon is passive (i.e.
configType() - Method in class com.microstrategy.usher.BeaconEntity
Returns an int of the configuration type of the beacon.
CONNECTOR - Static variable in class com.microstrategy.usher.PushNotificationEntity
Connector to divide the push notification content.
constructIntent(Context) - Static method in class com.microstrategy.usher.CurrentLocationActivity
 
consumeData(ScannerData) - Method in class com.microstrategy.usher.ScannerManager
Consumes the ScannerData object.
content(String) - Method in class com.microstrategy.usher.ScannerData.Builder
Returns the ScannerData.Builder for the ScannerData.content() component of the ScannerData object.
content() - Method in class com.microstrategy.usher.ScannerData
Returns a String of the content of the scanned data.
count(SingleCallback<Integer>) - Method in class com.microstrategy.usher.InboxManager
Returns an int of the number of new InboxEntity objects for all badges on a device.
countryCode() - Method in class com.microstrategy.usher.CountryEntity
Returns a String of the country code that will allow you to call the country from another country.
CountryEntity - Class in com.microstrategy.usher
The CountryEntity abstract class identifies the properties related to a country that will be parsed from the JSON String returned from the server.
countryName() - Method in class com.microstrategy.usher.CountryEntity
Returns a String of the name of the country.
countryShortName() - Method in class com.microstrategy.usher.CountryEntity
Returns a String of the two letter abbreviation for a country.
CppManager - Class in com.microstrategy.usher
 
CppManager.NotificationFromCpp - Class in com.microstrategy.usher
 
create(A, B) - Static method in class com.microstrategy.usher.PairEntity
Returns an appropriately typed PairEntity.
createAt() - Method in class com.microstrategy.usher.PushNotificationEntity
 
createdAt() - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a long of the time in milliseconds at which the badge was created in an organization.
createdAt() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns a long of the time in seconds the scanner log entry was created.
createdTime() - Method in class com.microstrategy.usher.InboxEntity
Returns a long of the time in seconds at which the notification was sent.
credential() - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a String of the credentials associated with the badge within an organization.
current() - Method in class com.microstrategy.usher.DeviceEntity
 
current() - Method in class com.microstrategy.usher.ServerModel
Returns a boolean that represents whether or not the user is currently pointing to the server.
CURRENT_SERVER_COULD_NOT_BE_DELETED_UNTIL_IT_IS_THE_LAST_ONE - Static variable in exception com.microstrategy.usher.DomainException
 
currentDevice() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not this device is the current device.
CurrentLocationActivity - Class in com.microstrategy.usher
 
CurrentLocationActivity() - Constructor for class com.microstrategy.usher.CurrentLocationActivity
 

D

DEFAULT_APP_SCHEME - Static variable in class com.microstrategy.usher.Usher.Configuration
Default supported app scheme.
DEFAULT_BADGE_BACKGROUND_COLOR - Static variable in class com.microstrategy.usher.OrgUIEntity
Default badge background color.
DEFAULT_BADGE_TEXT_COLOR - Static variable in class com.microstrategy.usher.OrgUIEntity
Default badge text color.
DEFAULT_CREATED_AT - Static variable in class com.microstrategy.usher.BadgeIdOrgIdEntity
Default badge creation time in milliseconds.
DEFAULT_MINIMUM_USHER_CODE_LENGTH - Static variable in class com.microstrategy.usher.UsherCodeEntity
Default minimum MicroStrategy Badge code length.
DEFAULT_RECOVERED_AT - Static variable in class com.microstrategy.usher.BadgeIdOrgIdEntity
Default badge recovery time in milliseconds.
DEFAULT_SORT_ORDER - Static variable in class com.microstrategy.usher.BadgeIdOrgIdEntity
Default sort order.
DEFAULT_TOTP_CODE_DURATION - Static variable in class com.microstrategy.usher.OrgUIEntity
Default duration in seconds a time-based one-time password (TOTP) will last before expiring.
DEFAULT_USHER_CODE_OFFLINE_DURATION - Static variable in class com.microstrategy.usher.OrgUIEntity
Default duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network.
DEFAULT_USHER_CODE_ONLINE_DURATION - Static variable in class com.microstrategy.usher.OrgUIEntity
Default duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network.
DEFAULT_USHER_CODE_VERSION - Static variable in class com.microstrategy.usher.OrgUIEntity
Default MicroStrategy Badge code version.
defaultEnrolledPhoneNumber() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the default enrolled mobile phone number.
degreeOfNowInSeconds() - Method in class com.microstrategy.usher.TimeRestrictionModel
Returns a float of the current time in seconds as a function of degrees of a circle.
delete(int, CompleteCallback) - Method in class com.microstrategy.usher.BadgeManager
Returns a CompleteCallback after deleting a badge.
delete(List<Integer>, CompleteCallback) - Method in class com.microstrategy.usher.BadgeManager
Returns a CompleteCallback after deleting a List of badges.
DEVICE_PROVISION_REQUIRED - Static variable in exception com.microstrategy.usher.DomainException
 
DEVICE_TYPE_ANDROID - Static variable in class com.microstrategy.usher.DeviceEntity
Android device
DeviceBadgeItem - Class in com.microstrategy.usher
The DeviceBadgeItem abstract class wraps the core attributes related to the badge on the current device.
DeviceBadgeItem.Status - Enum in com.microstrategy.usher
Enumerations for the DeviceBadgeItem.Status of the badge
DeviceBadgeModel - Class in com.microstrategy.usher
The DeviceBadgeModel abstract class wraps the various attributes related to the badge on the current device.
deviceBadgeModelList() - Method in class com.microstrategy.usher.DeviceModel
Returns the List of DeviceBadgeModel objects, which display the list of badges that have been installed on the current DeviceEntity.
deviceEntity() - Method in class com.microstrategy.usher.DeviceBadgeItem
Returns the DeviceEntity on which the badge has been installed.
DeviceEntity - Class in com.microstrategy.usher
The DeviceEntity abstract class wraps the core attributes related to the device.
deviceEntity() - Method in class com.microstrategy.usher.DeviceModel
Returns the current DeviceEntity object.
DeviceManager - Class in com.microstrategy.usher
The DeviceManager class takes care of the responsibilities of managing badges across all devices.
DeviceManager(Lifecycle) - Constructor for class com.microstrategy.usher.DeviceManager
Constructor for an DeviceManager object with the lifecycle set.
DeviceManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.DeviceManager
Constructor for an DeviceManager object with the lifecycle set.
DeviceManager(Fragment) - Constructor for class com.microstrategy.usher.DeviceManager
Constructor for an DeviceManager object with the lifecycle set.
DeviceModel - Class in com.microstrategy.usher
The DeviceModel abstract class contains the mapping of the current DeviceEntity object with the List of DeviceBadgeModel objects.
deviceName() - Method in class com.microstrategy.usher.DeviceEntity
Returns a String of the name of the device.
deviceOs() - Method in class com.microstrategy.usher.DeviceEntity
Returns a String of the device operation system that the device is running on.
DeviceProvisioningManager - Class in com.microstrategy.usher
The DeviceProvisioningManager class collects all of the use cases related to device provisioning, such as mobile phone number enrollment and verification, in order to increase badge security.
DeviceProvisioningManager(Lifecycle) - Constructor for class com.microstrategy.usher.DeviceProvisioningManager
Constructor for an DeviceProvisioningManager object with the lifecycle set.
DeviceProvisioningManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.DeviceProvisioningManager
Constructor for an DeviceProvisioningManager object with the lifecycle set.
DeviceProvisioningManager(Fragment) - Constructor for class com.microstrategy.usher.DeviceProvisioningManager
Constructor for an DeviceProvisioningManager object with the lifecycle set.
deviceType() - Method in class com.microstrategy.usher.DeviceEntity
Returns a boolean that represents whether or not the device is an Android device.
deviceUuid() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns a String of the universally unique identifier (UUID) of the device.
deviceUuid() - Method in class com.microstrategy.usher.DeviceEntity
Returns a String of the universally unique identifier (UUID) of the device.
displayDistance() - Method in class com.microstrategy.usher.LocationRestrictionModel
Returns a String of the display distance of the badge enablement geo-fence.
displayTime() - Method in class com.microstrategy.usher.ScannerLogModel
Returns a String of the display time in seconds.
distance() - Method in class com.microstrategy.usher.LocationRestrictionModel
Returns an int of the distance of the the badge enablement geo-fence.
distanceInMeters(double, double) - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a double of the distance in meters between the given latitude and longitude parameters and the ones associated with the OrgConfigEntity.LocationConditionEntity object.
distanceInMeters(double, double) - Method in class com.microstrategy.usher.RegionEntity
Returns a double of the distance in meters between the given latitude and longitude parameters and the ones associated with the RegionEntity.
DomainException - Exception in com.microstrategy.usher
 
DomainException(int, String, Throwable) - Constructor for exception com.microstrategy.usher.DomainException
 
DomainException(int, String) - Constructor for exception com.microstrategy.usher.DomainException
 
DomainException(int, Throwable) - Constructor for exception com.microstrategy.usher.DomainException
 
DomainException(int) - Constructor for exception com.microstrategy.usher.DomainException
 
DUMMY_VALUE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
Dummy value.

E

earliestRenewPeriodBeforeExpirationInMilliseconds() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a long of the time in milliseconds of the earliest certificate renewal before it expires.
emailAddress() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a String of the email address.
emailAddress() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the email address of the employee.
employeeFullName() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the full name of the employee.
employeeFullName() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the full name of the employee.
employeeNameInitial() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the initials of the employee.
employeeNameInitial() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the initials of the employee name.
employeeTitle() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the title of the employee.
employeeTitle() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the title of the employee.
EMPTY_CONTENT - Static variable in class com.microstrategy.usher.ScannerLogEntity
Empty content.
enabled() - Method in class com.microstrategy.usher.BeaconEntity
Returns a boolean that represents whether or not the beacon is enabled on Network Manager.
enableLog(boolean) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
endTime() - Method in class com.microstrategy.usher.TimeRestrictionModel.Item
Returns a String of the end time for the badge enablement time restriction.
enroll(int, String, CompleteCallback) - Method in class com.microstrategy.usher.DeviceProvisioningManager
Returns a CompleteCallback after enrolling a mobile phone number with the given badge ID.
equals(Object) - Method in class com.microstrategy.usher.BadgeCondition
Returns a boolean that represents whether or not two badge conditions are equal.
equals(Object) - Method in class com.microstrategy.usher.PairEntity
Returns a boolean that represents whether or not two objects are equal by delegating to their respective Object.equals(Object) methods.
error(DomainException) - Method in interface com.microstrategy.usher.Usher.Configuration.Callback
Server configuration failed.
EXPIRED_REFRESH_TOKEN - Static variable in exception com.microstrategy.usher.DomainException
 
EXTRA_PARAM - Static variable in class com.microstrategy.usher.UsherSdkIntentContracts
The parameter that is attached to the Intent in BroadcastReceiver.onReceive(Context, Intent).
extraAttributeKey() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns a String of the alternate attribute name.

F

fatal() - Method in class com.microstrategy.usher.FingerprintVerificationResultEntity
Returns a boolean that represents whether or not a fatal error occurred during fingerprint verification.
favoriteKey() - Method in class com.microstrategy.usher.KeyEntity
Returns a boolean that represents whether or not the key is a favorite key.
feedbackEmail() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the email used for feedback.
feedbackLabel() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the display name for feedback.
fingerprintEnabled() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a boolean that represents whether or not fingerprint authentication is required.
fingerprintRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not fingerprint enrollment and verification is required before the badge is able to be used.
FingerprintVerificationResultEntity - Class in com.microstrategy.usher
The FingerprintVerificationResultEntity abstract class wraps the attributes related to the result of fingerprint verification.
first - Variable in class com.microstrategy.usher.PairEntity
First element in the tuple of type F
forbidConfigNewServer(boolean) - Method in class com.microstrategy.usher.ServerModel.PreConfig.Builder
forbidConfigNewServer() - Method in class com.microstrategy.usher.ServerModel.PreConfig
Returns a boolean that represents whether or not a new server can be configured.
forbidSwitchNewServer(boolean) - Method in class com.microstrategy.usher.ServerModel.PreConfig.Builder
forbidSwitchNewServer() - Method in class com.microstrategy.usher.ServerModel.PreConfig
Returns a boolean that represents whether or not a user can switch to a new server.
fromJson(String) - Static method in class com.microstrategy.usher.PushNotificationModel
 
fromJsonString(String) - Static method in class com.microstrategy.usher.InboxEntity
Returns an InboxEntity object after parsing a JSON string.
fromJsonString(String) - Static method in class com.microstrategy.usher.PushNotificationEntity
Returns an PushNotificationEntity object after parsing a JSON string.

G

gcmSenderId(String) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
Deprecated.
GENERAL_NETWORK_ERROR - Static variable in exception com.microstrategy.usher.DomainException
 
get(int, SingleCallback<BadgeEntity>) - Method in class com.microstrategy.usher.BadgeManager
Returns a BadgeEntity object for the given badge ID.
get(int, boolean, SingleCallback<BadgeEntity>) - Method in class com.microstrategy.usher.BadgeManager
Returns a BadgeEntity object for the given badge ID.
get(String, SingleCallback<DeviceModel>) - Method in class com.microstrategy.usher.DeviceManager
Returns the DeviceModel object that contains the DeviceBadgeItem.deviceEntity() object and the List of DeviceBadgeModel objects on the given device.
get(boolean, boolean, SingleCallback<List<InboxEntity>>) - Method in class com.microstrategy.usher.InboxManager
Returns a List of InboxEntity objects for all badges on a device.
get() - Static method in class com.microstrategy.usher.Usher
get the singleton of Usher instance.
get(int, SingleCallback<UsherCodeEntity>) - Method in class com.microstrategy.usher.UsherCodeManager
Returns an UsherCodeEntity object that wraps the core attributes pertaining to the Badge code, a dynamic identification number that users can use to validate the identities of others using the MicroStrategy Badge app, or the time-based one-time password (TOTP).
getBadgeEntity() - Method in exception com.microstrategy.usher.BadgeConditionException
Returns a BadgeEntity object that wraps the core attributes pertaining to the badge.
getBadgeModel(int, SingleCallback<BadgeModel>) - Method in class com.microstrategy.usher.BadgeManager
Returns a BadgeModel object for a given badge ID.
getBadgeModel(int, boolean, SingleCallback<BadgeModel>) - Method in class com.microstrategy.usher.BadgeManager
Returns a BadgeModel object for a given badge ID.
getBuilder(Context, String) - Method in class com.microstrategy.usher.NotificationUtil
 
getCode() - Method in exception com.microstrategy.usher.DomainException
 
getDays() - Method in class com.microstrategy.usher.OrgConfigEntity.TimeRestrictionItem
Returns a List of Integer objects of the indices of the days of the week that are affected by that particular badge enablement time restriction.
getDefaultCenter() - Static method in class com.microstrategy.usher.CppManager
 
getEndTime() - Method in class com.microstrategy.usher.OrgConfigEntity.TimeRestrictionItem
Returns a String of the end time of that particular badge enablement time restriction.
getMainObserverByNotificationName(String) - Method in class com.microstrategy.usher.CppManager
 
getNotificationManager() - Method in class com.microstrategy.usher.NotificationUtil
 
getOrgBasicEntity() - Method in exception com.microstrategy.usher.NeedToRecoveryBadgeException
Returns an OrgBasicEntity object that wraps various attributes about an organization.
getOrgId() - Method in exception com.microstrategy.usher.NeedToRecoveryBadgeException
Returns the identification number of the organization.
getStartTime() - Method in class com.microstrategy.usher.OrgConfigEntity.TimeRestrictionItem
Returns a String of the start time of that particular badge enablement time restriction.
getType() - Method in class com.microstrategy.usher.BadgeCondition
Returns an int of the type of badge condition.
getType() - Method in exception com.microstrategy.usher.BadgeConditionException
Returns an int of the BadgeCondition object type.
gracePeriodForCertificateRenewalAfterExpirationInMilliseconds() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a long of the time in milliseconds of the grace period for certificate renewal after it expires.
GroupKeyEntity - Class in com.microstrategy.usher
The GroupKeyEntity abstract class wraps the grouped key items defined on Network Manager.
groupKeyEntity() - Method in class com.microstrategy.usher.KeyEntity
Returns a GroupKeyEntity object related to the key.
GroupKeyItemEntity - Class in com.microstrategy.usher
The GroupKeyItemEntity abstract class wraps various attributes related to the keys found in a group key.
groupKeyItemEntity1() - Method in class com.microstrategy.usher.GroupKeyEntity
Returns the List of GroupKeyItemEntity objects related to group 1 of the the group key.
groupKeyItemEntity2() - Method in class com.microstrategy.usher.GroupKeyEntity
Returns the List of GroupKeyItemEntity objects related to group 2 of the the group key.
groupKeyItemEntity3() - Method in class com.microstrategy.usher.GroupKeyEntity
Returns the List of GroupKeyItemEntity objects related to group 3 of the the group key.

H

hashCode() - Method in class com.microstrategy.usher.BadgeCondition
Returns an int of the hashCode of the type and mustResolved of the badge condition.
hashCode() - Method in class com.microstrategy.usher.PairEntity
Returns an int of the hash code using the hash codes of the underlying objects.
hasKey() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has any keys associated with it.

I

id() - Method in class com.microstrategy.usher.BeaconEntity.Action
Returns an int of the identification number of an action item.
id() - Method in class com.microstrategy.usher.BeaconEntity
Returns an int of the identification number of the beacon assigned by Network Manager.
imageUrl(int) - Static method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the full image URL.
imageUrl() - Method in class com.microstrategy.usher.InboxEntity.SenderEntity
Returns a String of the URL of the profile photo of the sender.
INBOX_ENTITY_NOT_FOUND - Static variable in exception com.microstrategy.usher.DomainException
 
INBOX_NOT_SUPPORTED - Static variable in exception com.microstrategy.usher.DomainException
 
InboxEntity - Class in com.microstrategy.usher
The InboxEntity abstract class wraps various attributes related to the inbox, including notification ID, sender name, sender title, and message, among others.
inboxEntity(InboxEntity) - Method in class com.microstrategy.usher.PushNotificationModel.Builder
 
inboxEntity() - Method in class com.microstrategy.usher.PushNotificationModel
 
InboxEntity.SenderEntity - Class in com.microstrategy.usher
The InboxEntity.SenderEntity abstract class wraps various properties related to the sender of an InboxEntity, including badge ID, name, and title, among others.
InboxManager - Class in com.microstrategy.usher
The InboxManager class collects all of the APIs related to the inbox.
InboxManager(Lifecycle) - Constructor for class com.microstrategy.usher.InboxManager
Constructor for an InboxManager with the lifecycle set.
InboxManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.InboxManager
Constructor for an InboxManager with the lifecycle set.
InboxManager(Fragment) - Constructor for class com.microstrategy.usher.InboxManager
Constructor for an InboxManager with the lifecycle set.
inboxNewMessageCount() - Method in class com.microstrategy.usher.UsherSettingModel
Returns an int of the number of inbox messages.
init(Usher.Configuration) - Static method in class com.microstrategy.usher.Usher
Initialize the SDK with the Application and your own server URL.
init(Application, String) - Static method in class com.microstrategy.usher.Usher
Initialize the SDK with the Application and your own server URL.
initial() - Method in class com.microstrategy.usher.InboxEntity.SenderEntity
Returns a String of the initials of the sender.
INVALID_BADGE_ID - Static variable in class com.microstrategy.usher.BadgeIdOrgIdEntity
Invalid badge ID.
INVALID_BADGE_INVITATION_CODE - Static variable in exception com.microstrategy.usher.DomainException
 
INVALID_CERTIFICATE - Static variable in exception com.microstrategy.usher.DomainException
 
INVALID_NOTIFICATION_ID - Static variable in class com.microstrategy.usher.InboxEntity
Invalid notification ID.
INVALID_OPTION_ID - Static variable in class com.microstrategy.usher.InboxEntity
Invalid option ID.
INVALID_ORG_ID - Static variable in class com.microstrategy.usher.BadgeIdOrgIdEntity
Invalid organization ID.
INVALID_QR_CODE - Static variable in exception com.microstrategy.usher.DomainException
 
isBatchKey() - Method in class com.microstrategy.usher.GroupKeyEntity
Returns a boolean that represents whether or not the GroupKeyEntity is a batch key (i.e.
isDeniedAllDay() - Method in class com.microstrategy.usher.TimeRestrictionModel
Returns a boolean that represents whether or not the badge is restricted for the entire day.
issueDate() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a long that represents the time in milliseconds at which the current badge was issued.
ITEM_VIEW_TYPE_DEFAULT - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The default view.
ITEM_VIEW_TYPE_DELETE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The view for the "Delete Badge" button.
ITEM_VIEW_TYPE_EXPANDABLE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
An expandable view for content that is greater than 30 characters.
ITEM_VIEW_TYPE_PRIVACY_POLICY_OR_TERM_OF_USE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The view for the privacy policy/terms of use.
ITEM_VIEW_TYPE_TOTP_CODE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The view for the time-based one-time password (TOTP).
ITEM_VIEW_TYPE_USER_VALIDATION - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The view for user validation.
ITEM_VIEW_TYPE_USHER_CODE - Static variable in class com.microstrategy.usher.BadgeDetailAttributeModel
The view for the MicroStrategy Badge (Usher) code.
itemViewType() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns an int of the item view type.

K

keyColor() - Method in class com.microstrategy.usher.KeyModel
Returns a String of the color of the key.
KeyEntity - Class in com.microstrategy.usher
The KeyEntity abstract class wraps various attributes related to a key.
keyEntity() - Method in class com.microstrategy.usher.KeyModel
Returns the KeyEntity object that wraps the core attributes pertaining to the key.
keyId() - Method in class com.microstrategy.usher.KeyEntity
Returns an int of the identification number of the key.
keyId() - Method in class com.microstrategy.usher.KeyParam
Returns an int of the identification number of the key.
KeyManager - Class in com.microstrategy.usher
The KeyManager class collects all of the use cases related to key management.
KeyManager(Lifecycle) - Constructor for class com.microstrategy.usher.KeyManager
Constructor for an KeyManager object with the lifecycle set.
KeyManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.KeyManager
Constructor for an KeyManager object with the lifecycle set.
KeyManager(Fragment) - Constructor for class com.microstrategy.usher.KeyManager
Constructor for an KeyManager object with the lifecycle set.
KeyModel - Class in com.microstrategy.usher
The KeyModel abstract class wraps the core attributes pertaining to the key found in a KeyEntity with other more dynamic attributes, such as the organization ID and key color.
keyName() - Method in class com.microstrategy.usher.BeaconEntity
Returns a String of the key associated with the beacon.
keyOrder() - Method in class com.microstrategy.usher.KeyEntity
Returns an int of the sort order of keys.
KeyParam - Class in com.microstrategy.usher
The KeyParam abstract class wraps fields related to keys.

L

latitude() - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a double of the latitudinal coordinate of the badge enablement geo-fence.
latitude() - Method in class com.microstrategy.usher.RegionEntity
Returns a double of the latitudinal coordinate of the telemetry collection geo-fence.
LAYOUT_COL_1 - Static variable in class com.microstrategy.usher.GroupKeyItemEntity
Layout column 1
LAYOUT_COL_2 - Static variable in class com.microstrategy.usher.GroupKeyItemEntity
Layout column 2
LAYOUT_COL_3 - Static variable in class com.microstrategy.usher.GroupKeyItemEntity
Layout column 3
layoutCount() - Method in class com.microstrategy.usher.GroupKeyEntity
Returns an int of the layout count of the key.
LEGACY_CONFIGURATION_SHOW_USHER_CODE - Static variable in class com.microstrategy.usher.OrgUIEntity
Legacy configuration for showing MicroStrategy Badge code.
LegalConsentEntity - Class in com.microstrategy.usher
The LegalConsentEntity abstract class wraps various attributes related to the terms of service.
length() - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns an int of the radius of the badge enablement geo-fence in the alternate unit.
list() - Method in class com.microstrategy.usher.BadgeManager
Returns a List of BadgeIdOrgIdEntity objects.
list(SingleCallback<List<BadgeModel>>) - Method in class com.microstrategy.usher.BadgeManager
Returns a List of BadgeModel objects.
list(boolean, SingleCallback<List<BadgeModel>>) - Method in class com.microstrategy.usher.BadgeManager
Returns a List of BadgeModel objects.
list(SingleCallback<List<DeviceModel>>) - Method in class com.microstrategy.usher.DeviceManager
Returns the List of DeviceModel objects that have installed any of the badges on the current device.
list(int, SingleCallback<List<DeviceBadgeItem>>) - Method in class com.microstrategy.usher.DeviceManager
Returns the List of DeviceBadgeItem objects that have a specific badge installed.
list(int, boolean, SingleCallback<List<KeyEntity>>) - Method in class com.microstrategy.usher.KeyManager
Returns the List of KeyEntity objects for a badge.
list(int, SingleCallback<List<KeyEntity>>) - Method in class com.microstrategy.usher.KeyManager
Returns the List of KeyEntity objects for a badge.
listBadgeExceedLimitEntity(SingleCallback<List<BadgeExceedLimitEntity>>) - Method in class com.microstrategy.usher.BadgeManager
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.
localKeyOrder() - Method in class com.microstrategy.usher.KeyModel
Returns an int of the key sort order on the device.
locationConditionEntityList() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a JSON String that represents the list of location restrictions for the current badge.
LocationRestrictionModel - Class in com.microstrategy.usher
The LocationRestrictionModel abstract class identifies the properties related to badge enablement location restrictions.
locationRestrictionModelList() - Method in class com.microstrategy.usher.BadgeRestrictionModel
Returns a List of LocationRestrictionModel objects that identifies the properties associated with badge enablement location restrictions.
locationTrackingConfig() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a OrgUIEntity.LocationTrackingConfig that represents the requirement for location reporting.
locationTrackingConfig() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a OrgUIEntity.LocationTrackingConfig that represents the requirement for location reporting.
locationTrackingParam() - Method in class com.microstrategy.usher.OrgConfigEntity
internal usage
login(BadgeLoginParam, SingleCallback<BadgeEntity>) - Method in class com.microstrategy.usher.BadgeRecoveryManager
Returns a BadgeEntity object after logging into and refreshing a badge.
longitude() - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a double of the longitudinal coordinate of the badge enablement geo-fence.
longitude() - Method in class com.microstrategy.usher.RegionEntity
Returns a double of the longitudinal coordinate of the telemetry collection geo-fence.

M

major() - Method in class com.microstrategy.usher.BeaconEntity
Returns an int of the major region for the Usher network.
max() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns an int of the maximum value for the progress bar.
MaybeCallback<T> - Interface in com.microstrategy.usher
The MaybeCallback interface represents an asynchronous callback that may or may not occur.
message() - Method in class com.microstrategy.usher.BeaconEntity.Action
Returns a String of additional information related to the action item.
message() - Method in class com.microstrategy.usher.BeaconEntity
Returns a String of the message associated with triggering the beacon.
message() - Method in class com.microstrategy.usher.FingerprintVerificationResultEntity
Returns a String of the message when fingerprint verification is not successful.
message() - Method in class com.microstrategy.usher.InboxEntity
Returns a String of the message.
MetaDataEntity - Class in com.microstrategy.usher
The MetaDataEntity abstract class wraps various attributes related to the metadata, including supported version names, and support phone numbers, among others.
metaDataEntity() - Method in class com.microstrategy.usher.UsherSettingModel
Returns a MetaDataEntity object that wraps various attributes related to the metadata, including supported version names and support phone numbers, among others.
minimumRecommendedVersionName() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the minimum recommended version number of Usher.
minimumSupportedVersionName() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the minimum supported version number of Usher.
minor() - Method in class com.microstrategy.usher.BeaconEntity
Returns an int of the minor region associated with the beacon.

N

name() - Method in class com.microstrategy.usher.InboxEntity.SenderEntity
Returns a String of the name of the sender.
name() - Method in class com.microstrategy.usher.KeyEntity
Returns a String of the name of the key.
name() - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a String of the name of the badge enablement geo-fence.
NEED_TO_CONFIRM_SERVER - Static variable in exception com.microstrategy.usher.DomainException
 
NEED_TO_RESOLVE_BADGE_CONDITION - Static variable in exception com.microstrategy.usher.DomainException
 
NEED_TO_RESOLVE_BADGE_CONDITION_FOR_USHER_DATA_ENTITY - Static variable in exception com.microstrategy.usher.DomainException
 
NEED_TO_SWITCH_SERVER - Static variable in exception com.microstrategy.usher.DomainException
 
needAuthentication() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not the badge needs authentication (i.e.
needProvisionEnrollment() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not the badge needs device provisioning enrollment.
needProvisionVerification() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not the badge needs device provisioning verification.
NeedToRecoveryBadgeException - Exception in com.microstrategy.usher
The NeedToRecoveryBadgeException class is thrown when a badge is otherwise expected for a process (e.g.
NeedToRecoveryBadgeException(int, OrgBasicEntity) - Constructor for exception com.microstrategy.usher.NeedToRecoveryBadgeException
Construct for a NeedToRecoveryBadgeException with the orgId and orgBasicEntity set.
NETWORK_CONNECTION_TIMEOUT - Static variable in exception com.microstrategy.usher.DomainException
 
NETWORK_OFFLINE_OR_VPN_REQUIRED - Static variable in exception com.microstrategy.usher.DomainException
 
NEW_USHER_CODE_VERSION - Static variable in class com.microstrategy.usher.OrgUIEntity
New MicroStrategy Badge code version.
NO_BADGE_CONFIGURED_FOR_SCANNED_DATA - Static variable in exception com.microstrategy.usher.DomainException
 
NO_BADGE_EXISTED - Static variable in exception com.microstrategy.usher.DomainException
 
NO_ELEMENT - Static variable in exception com.microstrategy.usher.DomainException
 
NO_SERVER_CONFIGURATION_SAVED - Static variable in exception com.microstrategy.usher.DomainException
 
notificationId() - Method in class com.microstrategy.usher.InboxEntity
Returns an int of the identification number of the notification.
NotificationUtil - Class in com.microstrategy.usher
 
NotificationUtil(Context, NotificationChannelConfig) - Constructor for class com.microstrategy.usher.NotificationUtil
 
nowInSeconds() - Method in class com.microstrategy.usher.TimeRestrictionModel
Returns a long of the current time in seconds.

O

observe(int, ObserverCallback<BadgeDetailModel>) - Method in class com.microstrategy.usher.BadgeManager
Returns a BadgeDetailModel object that is used in the Badge Detail View.
ObserverCallback<T> - Interface in com.microstrategy.usher
The ObserverCallback interface represents an asynchronous callback returning multiple values.
onAccessDenied(String) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when the scanned data represents physical access or logical access and access has been denied.
onAccessGranted(String) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when the scanned data represents physical access or logical access and access has been granted.
onComplete() - Method in interface com.microstrategy.usher.CompleteCallback
Callback for when the request is successfully executed.
onComplete() - Method in interface com.microstrategy.usher.MaybeCallback
Callback for when the request is executed but not successfully.
onComplete() - Method in interface com.microstrategy.usher.ObserverCallback
Callback for when the request is successfully executed for the last element.
onCreate(Bundle) - Method in class com.microstrategy.usher.CurrentLocationActivity
 
onDestroy() - Method in class com.microstrategy.usher.CurrentLocationActivity
 
onError(DomainException) - Method in interface com.microstrategy.usher.CompleteCallback
Callback for when the request encounters an error.
onError(DomainException) - Method in interface com.microstrategy.usher.MaybeCallback
Callback for when the request encounters an error.
onError(DomainException) - Method in interface com.microstrategy.usher.ObserverCallback
Callback for when the request encounters an error.
onError(DomainException) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Returns a DomainException object when the scanned data is invalid or if there are pending badge conditions to be resolved.
onError(DomainException) - Method in interface com.microstrategy.usher.SingleCallback
Callback for when the request encounters an error.
ONLINE_CONFIGURATION_SHOW_NEITHER_USHER_CODE_OR_TOTP_CODE - Static variable in class com.microstrategy.usher.OrgUIEntity
Server configuration for not showing either MicroStrategy Badge code of time-based one-time password (TOTP).
ONLINE_CONFIGURATION_SHOW_TOTP_CODE - Static variable in class com.microstrategy.usher.OrgUIEntity
Server configuration for showing the time-based one-time password (TOTP).
ONLINE_CONFIGURATION_SHOW_USHER_CODE - Static variable in class com.microstrategy.usher.OrgUIEntity
Server configuration for showing the MicroStrategy Badge code.
onMapReady(GoogleMap) - Method in class com.microstrategy.usher.CurrentLocationActivity
 
onMyLocationButtonClick() - Method in class com.microstrategy.usher.CurrentLocationActivity
 
onMyLocationClick(Location) - Method in class com.microstrategy.usher.CurrentLocationActivity
 
onNext(T) - Method in interface com.microstrategy.usher.ObserverCallback
Callback for when the request is successfully executed and has a proceeding action.
onPermissionRequired(String, String) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when the scanned QR code represents logical access that needs the user's confirmation before logging into the website.
onSuccess(T) - Method in interface com.microstrategy.usher.MaybeCallback
Callback for when the request is successfully executed.
onSuccess(List<BadgeEntity>) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when the QR code is scanned from the badge recovery email.
onSuccess(BadgeEntity) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when the scanned QR code generated by a badge is valid.
onSuccess(ScannerResultEntity) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when the badge is configured to collect third party, generic barcode data.
onSuccess(boolean) - Method in interface com.microstrategy.usher.ScannerManager.Callback
Called when a MicroStrategy Badge Desktop pairing QR code is scanned to initialize the pairing session.
onSuccess(T) - Method in interface com.microstrategy.usher.SingleCallback
Callback for when the request is successfully executed.
option() - Method in class com.microstrategy.usher.InboxEntity
Returns a String of the chosen option.
optionList() - Method in class com.microstrategy.usher.InboxEntity
Returns a List of Strings of options.
ORG_NOT_EXIST - Static variable in exception com.microstrategy.usher.DomainException
 
OrgBasicEntity - Class in com.microstrategy.usher
The OrgBasicEntity abstract class wraps various attributes about the organization.
orgConfigEntity() - Method in class com.microstrategy.usher.BadgeEntity
Returns a OrgConfigEntity object that includes various attributes about the badge condition stored in the cache.
OrgConfigEntity - Class in com.microstrategy.usher
The OrgConfigEntity abstract class wraps the attributes pertaining to the badge condition stored in the cache.
OrgConfigEntity.LocationConditionEntity - Class in com.microstrategy.usher
The OrgConfigEntity.LocationConditionEntity abstract class includes various attributes about the badge enablement geo-fences associated with the badge.
OrgConfigEntity.TimeRestrictionEntity - Class in com.microstrategy.usher
The OrgConfigEntity.TimeRestrictionEntity abstract class identifies the properties related to badge enablement time restrictions on a weekly scale that will be parsed from the JSON String returned from the server.
OrgConfigEntity.TimeRestrictionItem - Class in com.microstrategy.usher
The OrgConfigEntity.TimeRestrictionItem abstract class identifies the properties related to badge enablement time restrictions on a daily scale that will be parsed from the JSON String returned from the server.
orgIconCheckSum() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the checksum of the organization icon.
orgIconUrl() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a String of the URL of the organization icon.
orgIconUrl() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns a String of the URL of the organization icon.
orgIconUrl() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the URL of the organization icon.
orgIconUrl() - Method in class com.microstrategy.usher.ScannerResultEntity.Item
Returns a String of the URL of the organization icon.
orgId() - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns an int of the identification number of the organization.
orgId(int) - Method in class com.microstrategy.usher.BadgeLoginParam.Builder
Returns the BadgeLoginParam.Builder for the BadgeLoginParam.orgId() component of the BadgeLoginParam object.
orgId() - Method in class com.microstrategy.usher.BadgeLoginParam
Returns an int of the identification number of the organization.
orgId() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns an int of the identification number of the organization.
orgId() - Method in class com.microstrategy.usher.BeaconEntity
Returns an int of the identification number of the organization of the beacon.
orgId() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns an int of the identification number of the organization.
orgId() - Method in class com.microstrategy.usher.KeyModel
Returns an int of the identification number of the organization.
orgId() - Method in class com.microstrategy.usher.OrgBasicEntity
Returns an int of the identification number of the organization.
orgId() - Method in class com.microstrategy.usher.OrgUIEntity
Returns an int of the identification number of the organization.
orgId() - Method in class com.microstrategy.usher.PushNotificationEntity
Returns an int of the identification number of the organization.
orgName() - Method in class com.microstrategy.usher.BadgeExceedLimitEntity
Returns a String of the name of the organization or network the badge belongs to.
orgName() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the name of the organization.
orgName() - Method in class com.microstrategy.usher.InboxEntity.SenderEntity
Returns a String of the name of the organization.
orgName() - Method in class com.microstrategy.usher.OrgBasicEntity
Returns a String of the name of the organization.
orgName() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the name of the organization.
orgUIEntity() - Method in class com.microstrategy.usher.BadgeEntity
Returns a OrgUIEntity object that includes various attributes about the organization and its configuration for Usher, including organization ID and organization name, among others.
OrgUIEntity - Class in com.microstrategy.usher
The OrgUIEntity abstract class wraps various attributes about the organization and its configuration for MicroStrategy Badge, including organization ID and organization name, among others.
OrgUIEntity.LocationTrackingConfig - Enum in com.microstrategy.usher

P

PairEntity<F,S> - Class in com.microstrategy.usher
Container to ease passing around a tuple of two objects.
PairEntity(F, S) - Constructor for class com.microstrategy.usher.PairEntity
Constructor for a PairEntity.
passcodeEnabled() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a boolean that represents whether or not a passcode is required.
passcodeRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not passcode usage is enabled and required before the badge is able to be used.
passcodeVerificationInterval() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns an int of the number of seconds that may pass before the passcode is required to be re-verified before the badge is able to be used.
password(String) - Method in class com.microstrategy.usher.BadgeLoginParam.Builder
Returns the BadgeLoginParam.Builder for the BadgeLoginParam.password() component of the BadgeLoginParam object.
password() - Method in class com.microstrategy.usher.BadgeLoginParam
Returns a char array of the password.
passwordAuthenticated() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has authenticated its password.
pendingBadgeConditionList() - Method in class com.microstrategy.usher.BadgeModel
Returns the List of BadgeCondition objects that includes various requirements and restrictions that must be fulfilled before the badge is able to be used.
permissionGranted(boolean) - Method in class com.microstrategy.usher.ScannerData.Builder
Returns the ScannerData.Builder for the ScannerData.permissionGranted() component of the ScannerData object.
permissionGranted() - Method in class com.microstrategy.usher.ScannerData
Returns a boolean that represents whether or not permission was granted for logical access.
permissionGrantedForever(boolean) - Method in class com.microstrategy.usher.ScannerData.Builder
Returns the ScannerData.Builder for the ScannerData.permissionGrantedForever() component of the ScannerData object.
permissionGrantedForever() - Method in class com.microstrategy.usher.ScannerData
Returns a boolean that represents whether or not permission was granted for logical access for this visit and any future visits.
phoneNumber() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a String of the mobile phone number.
phoneNumber() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the phone number for support.
phoneNumberEnrolled() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has enrolled a mobile phone number.
phoneNumberGracePeriod() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a long that represents the time in seconds at which device provisioning is required.
phoneNumberLabel() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the display name of the phone number for support.
phoneNumberRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not mobile phone number enrollment is required before the badge is able to be used.
phoneNumberVerified() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has verified a mobile phone number.
photoAvailable() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has a profile photo.
postNotification(Notification) - Method in class com.microstrategy.usher.CppManager
 
postNotificationAsync(Notification) - Method in class com.microstrategy.usher.CppManager
 
postNotificationV2(Notification) - Method in class com.microstrategy.usher.CppManager
 
postNotificationWithinThisCenter(Notification) - Method in class com.microstrategy.usher.CppManager
This notification will not be posted to C++ code
PRE_CONFIGURED_SERVER_COULD_NOT_BE_DELETED - Static variable in exception com.microstrategy.usher.DomainException
 
preConfiguredServerUrl(String) - Method in class com.microstrategy.usher.ServerModel.PreConfig.Builder
preConfiguredServerUrl() - Method in class com.microstrategy.usher.ServerModel.PreConfig
Returns a String of the pre-configured server URL.
privacyConfigureEntity() - Method in class com.microstrategy.usher.MetaDataEntity
Returns the PrivacyConfigureEntity object that wraps various attributes related to the API requests to the server, restricting the information sent on each request.
privacyPolicyAcknowledged() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has acknowledged the privacy policy.
privacyPolicyLink() - Method in class com.microstrategy.usher.LegalConsentEntity
Returns a String of the URL of the privacy policy.
privacyPolicyLink() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the address of the privacy policy.
privacyPolicyRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not the privacy policy is configured.
privacyPolicyResolved() - Method in class com.microstrategy.usher.LegalConsentEntity
Returns a boolean that represents whether or not the privacy policy has been resolved.
PROFILE_IMAGE_URL - Static variable in class com.microstrategy.usher.BadgeUIEntity
The URL base for the image URL.
profilePhotoChecksum() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the checksum of profile photo.
profilePhotoChecksum() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the checksum of the profile photo.
profilePhotoRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not a profile photo is required before the badge is able to be used.
profilePhotoUrl() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the URL of the profile photo.
profilePhotoUrl() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the URL of the profile photo.
progress() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns an int of the percent completion of the progress bar.
proximityId() - Method in class com.microstrategy.usher.BeaconEntity
Returns a String of the proximity identification number of the beacon.
PushNotificationEntity - Class in com.microstrategy.usher
The PushNotificationEntity abstract class wraps various properties related to push notifications, including the type, organization ID, client name, server URL, among others.
pushNotificationEntity(PushNotificationEntity) - Method in class com.microstrategy.usher.PushNotificationModel.Builder
 
pushNotificationEntity() - Method in class com.microstrategy.usher.PushNotificationModel
 
pushNotificationHandlerActivityClass(Class<? extends Activity>) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
PushNotificationModel - Class in com.microstrategy.usher
 
PushNotificationModel() - Constructor for class com.microstrategy.usher.PushNotificationModel
 
PushNotificationModel.Builder - Class in com.microstrategy.usher
 

Q

qrCode() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns a String of the QR code content.
qrCode() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns a String of the QR code content.

R

radianOfNowInSeconds() - Method in class com.microstrategy.usher.TimeRestrictionModel
Returns a float of the current time in seconds as a function of radians of a circle.
radius() - Method in class com.microstrategy.usher.RegionEntity
Returns a float of the radius of the telemetry collection geo-fence in meters.
radiusInMeter() - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a float of the radius of the badge enablement geo-fence in meters.
reachable() - Method in class com.microstrategy.usher.ServerModel
Returns a boolean that represents whether or not the server is reachable.
recover(String, SingleCallback<List<BadgeEntity>>) - Method in class com.microstrategy.usher.BadgeRecoveryManager
Returns a List of BadgeEntity objects after accessing a Deeplink URL to recover badges.
recover(String, boolean, SingleCallback<List<BadgeEntity>>) - Method in class com.microstrategy.usher.BadgeRecoveryManager
Returns a List of BadgeEntity objects after using the badge recovery code or badge invitation code to recover badges.
RECOVER_BADGE - Static variable in exception com.microstrategy.usher.DomainException
 
recoveredAt() - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a long of the time in milliseconds at which the badge was recovered in an organization.
RegionEntity - Class in com.microstrategy.usher
The RegionEntity abstract class includes various attributes about the telemetry collection geo-fences associated with the badge.
removeNotificationByID(int) - Method in class com.microstrategy.usher.CppManager
 
removeObserver(Observer, String) - Method in class com.microstrategy.usher.CppManager
 
repliedTime() - Method in class com.microstrategy.usher.InboxEntity
Returns a long of the time in seconds at which the notification was replied to.
reportScannedData() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a boolean that represents whether or not scanned data should be reported to the server.
request(String, CompleteCallback) - Method in class com.microstrategy.usher.BadgeRecoveryManager
Returns a CompleteCallback after requesting a badge recovery email for the specified email address.
request(int, CompleteCallback) - Method in class com.microstrategy.usher.DeviceManager
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().
request(int, CompleteCallback) - Method in class com.microstrategy.usher.DeviceProvisioningManager
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().
REQUIRE_BADGE_LOGIN - Static variable in exception com.microstrategy.usher.DomainException
 
REQUIRE_CONFIRMATION_FOR_LEGACY_COMPUTER_LOGIN - Static variable in exception com.microstrategy.usher.DomainException
 
REQUIRE_PASSWORD_UPDATE_FOR_LEGACY_COMPUTER_LOGIN - Static variable in exception com.microstrategy.usher.DomainException
 
requireLogBeaconExitEvent() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a boolean that represents whether or not the server requires logging of the beacon exit event.
requireLogin() - Method in class com.microstrategy.usher.OrgBasicEntity
Returns a boolean that represents whether or not a login is required.
requirePermissionOnUploadScannerData() - Method in class com.microstrategy.usher.UsherSettingModel
Returns a boolean that represents whether or not MicroStrategy Badge should prompt the user for permission to upload scanned data.
resolve(InboxEntity, CompleteCallback) - Method in class com.microstrategy.usher.InboxManager
Returns a CompleteCallback after resolving (i.e.
resourceId() - Method in class com.microstrategy.usher.GroupKeyItemEntity
Returns a String of the identification number of the resource.
resourceId() - Method in class com.microstrategy.usher.KeyParam
Returns a String of the identification number of the resource.
resourceName() - Method in class com.microstrategy.usher.AccessResourceResult
 
resourceName() - Method in class com.microstrategy.usher.GroupKeyItemEntity
Returns a String of the name of the resource.
resourceName() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns a String of the name of the resource that was scanned.
restrictedLocationConditionItem() - Method in class com.microstrategy.usher.LocationRestrictionModel
Returns a OrgConfigEntity.LocationConditionEntity object that includes various attributes about the badge enablement geo-fences associated with the badge.
RESULT_FAILURE - Static variable in class com.microstrategy.usher.ScannerLogEntity
Failure result.
RESULT_OTHER - Static variable in class com.microstrategy.usher.ScannerLogEntity
Mixed result (i.e.
RESULT_SUCCESS - Static variable in class com.microstrategy.usher.ScannerLogEntity
Success result.
resultType() - Method in class com.microstrategy.usher.AccessResourceResult
 
resultType() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns an int of the result of the scan.
retrieveBeaconEvent(Intent) - Static method in class com.microstrategy.usher.UsherSdkIntentContracts
 
revoke(int, String, CompleteCallback) - Method in class com.microstrategy.usher.DeviceManager
Returns a CompleteCallback after revoking a badge on a specific device, given the device UUID from DeviceBadgeItem.deviceEntity()}.
revoke(int, String, String, CompleteCallback) - Method in class com.microstrategy.usher.DeviceManager
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.
revoked() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not the badge has been suspended by an administrator.

S

save(List<KeyEntity>, int, SingleCallback<Boolean>) - Method in class com.microstrategy.usher.KeyManager
Returns a boolean that represents whether or not saving the List of KeyEntity objects to server was successful.
ScannerData - Class in com.microstrategy.usher
The ScannerData abstract class wraps the properties related to scanned data, including type, content, and badge ID, among others.
ScannerData.Builder - Class in com.microstrategy.usher
The ScannerData.Builder abstract class allows the user to create and return a ScannerData object.
ScannerLogEntity - Class in com.microstrategy.usher
The ScannerLogEntity abstract class wraps the core attributes pertaining to the scanner log entries.
scannerLogEntity() - Method in class com.microstrategy.usher.ScannerLogModel
Returns a ScannerLogEntity object that wraps the core attributes pertaining to the scanner log entries.
ScannerLogModel - Class in com.microstrategy.usher
The ScannerLogModel abstract class wraps the core attributes pertaining to the scanner log entries found in a ScannerLogEntity with other more dynamic attributes, such as the display time.
ScannerManager - Class in com.microstrategy.usher
The ScannerManager class is responsible for handling the scanned QR code or barcode data that is passed via a ScannerData object.
ScannerManager(Lifecycle, ScannerManager.Callback) - Constructor for class com.microstrategy.usher.ScannerManager
Constructor for a ScannerManager object with the lifecycle and callback set.
ScannerManager(AppCompatActivity, ScannerManager.Callback) - Constructor for class com.microstrategy.usher.ScannerManager
Constructor for a ScannerManager object with the lifecycle and callback set.
ScannerManager(Fragment, ScannerManager.Callback) - Constructor for class com.microstrategy.usher.ScannerManager
Constructor for a ScannerManager object with the lifecycle and callback set.
ScannerManager.Callback - Interface in com.microstrategy.usher
An object that wraps the callback for ScannerManager.
ScannerResultEntity - Class in com.microstrategy.usher
The ScannerResultEntity abstract class wraps various attributes pertaining to result of scans.
ScannerResultEntity.Item - Class in com.microstrategy.usher
The ScannerResultEntity.Item abstract class wraps various attributes pertaining to the result of a scan.
second - Variable in class com.microstrategy.usher.PairEntity
Second element in the tuple of type S
selected() - Method in class com.microstrategy.usher.BadgeMiniModel
Returns a boolean that represents whether or not the badge has been selected.
selected() - Method in class com.microstrategy.usher.ServerModel
Returns a boolean that represents whether or not the server has been selected.
senderEntity() - Method in class com.microstrategy.usher.InboxEntity
Returns a InboxEntity.SenderEntity object, which provides information about the message sender, including name, title, and badge ID, among others.
SERVER_CONFIGURATION_DISABLED - Static variable in exception com.microstrategy.usher.DomainException
 
SERVER_CONFIGURED - Static variable in exception com.microstrategy.usher.DomainException
 
SERVER_NOT_ALLOWED_TO_BE_DELETED_ONCE_CONFIGURED - Static variable in exception com.microstrategy.usher.DomainException
 
SERVER_NOT_CONFIGURED - Static variable in exception com.microstrategy.usher.DomainException
 
SERVER_SWITCH_DISABLED - Static variable in exception com.microstrategy.usher.DomainException
 
ServerModel - Class in com.microstrategy.usher
The ServerModel abstract class wraps the dynamic attributes pertaining to the server, such as the server URL, server name, and server version, among others.
ServerModel.PreConfig - Class in com.microstrategy.usher
The ServerModel.PreConfig abstract class wraps various properties about server configurations, including whether or not new servers can be configured or switched to, among others.
ServerModel.PreConfig.Builder - Class in com.microstrategy.usher
The ServerModel.PreConfig.Builder abstract class allows the user to create and return a ServerModel.PreConfig object.
serverModelConfig(ServerModel.PreConfig) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
serverName() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the name of the server.
serverName() - Method in class com.microstrategy.usher.ServerModel
Returns a String of the name of the server.
serverUrl() - Method in class com.microstrategy.usher.KeyModel
Returns a String of the URL of the server
serverUrl() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the URL of the server.
serverUrl() - Method in class com.microstrategy.usher.PushNotificationEntity
Returns a String of the URL of the server.
serverUrl() - Method in class com.microstrategy.usher.ServerModel
Returns a String of the URL of the server.
serverVersion() - Method in class com.microstrategy.usher.ServerModel
Returns a String of the version of the server.
serverVersionName() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the version number of the server.
setSDKConfig(JSONObject) - Method in class com.microstrategy.usher.CppManager
 
showGradient() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a boolean that represents whether or not the gradient should be shown on the background.
showGradient() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a boolean that represents whether or not a gradient should be shown on the background color of the badge.
showPrivacyLink() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a boolean that represents whether or not the link to the privacy policy should be shown.
showTermOfUseLink() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a boolean that represents whether or not the link to the terms of use should be shown.
SingleCallback<T> - Interface in com.microstrategy.usher
The SingleCallback interface represents an asynchronous callback returning a single values.
sortOrder() - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a long of the sort order of badges in an organization.
span() - Method in class com.microstrategy.usher.GroupKeyItemEntity
Returns an int of the span (width) of the item.
SPAN_TOTAL - Static variable in class com.microstrategy.usher.GroupKeyItemEntity
The span count (total width of the items)
startTime() - Method in class com.microstrategy.usher.TimeRestrictionModel.Item
Returns a String of the start time for the badge enablement time restriction.
status() - Method in class com.microstrategy.usher.BadgeEntity
Returns a BadgeEntity.Status enumeration that represents the current status of the badge in relation to logging in and being ready to use.
status() - Method in class com.microstrategy.usher.DeviceBadgeItem
Returns a boolean that represents whether or not the badge on the device is activated or not.
status() - Method in class com.microstrategy.usher.DeviceBadgeModel
Returns a boolean that represents whether or not the badge on the device is activated or not.
status() - Method in class com.microstrategy.usher.ScannerResultEntity.Item
Returns an int of the status of the scan.
STATUS_BADGE_CONDITION_ERROR - Static variable in class com.microstrategy.usher.ScannerResultEntity.Item
Unsuccessful scan due to a badge condition.
STATUS_NETWORK_ERROR - Static variable in class com.microstrategy.usher.ScannerResultEntity.Item
Unsuccessful scan due to a network error.
STATUS_REPORT_SCANNED_DATA_NOT_CONFIG - Static variable in class com.microstrategy.usher.ScannerResultEntity.Item
Unsuccessful scan due to Network Manager not configuring server to report scanned data.
STATUS_SUCCESS - Static variable in class com.microstrategy.usher.ScannerResultEntity.Item
Successful scan.
success() - Method in class com.microstrategy.usher.FingerprintVerificationResultEntity
Returns a boolean that represents whether or not the fingerprint verification was successful.
success() - Method in interface com.microstrategy.usher.Usher.Configuration.Callback
Server configuration was successful.
supportBluetooth(boolean) - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
supportEmail() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the email used for support.
supportFcm() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a boolean that represents whether or not the server supports Firebase Cloud Messaging (FCM).
supportFingerprint(boolean) - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
supportInbox() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a boolean that represents whether or not the server supports inbox features.
supportLabel() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the display name for support.
supportLocation(boolean) - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
supportPasscode(boolean) - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
supportProfilePhoto(boolean) - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
supportTimeRestriction(boolean) - Method in class com.microstrategy.usher.BadgeCondition.Config.Builder
supportTotpCode() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns a boolean that represents whether or not server configuration supports the time-based one-time password (TOTP).

T

tagCode() - Method in class com.microstrategy.usher.PushNotificationEntity
Returns a String of the push notification content.
telemetryConditionItemList() - Method in class com.microstrategy.usher.BadgeEntity
Returns the List of RegionEntity objects that includes various attributes about the region restrictions (i.e.
termOfUseAcknowledged() - Method in class com.microstrategy.usher.BadgeStatusEntity
Returns a boolean that represents whether or not the badge has acknowledged the terms of use.
termOfUseLink() - Method in class com.microstrategy.usher.LegalConsentEntity
Returns a String of the URL of the terms of use.
termOfUseLink() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the address of the terms of use.
termOfUseRequired() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a boolean that represents whether or not the terms of use is configured.
termOfUseResolved() - Method in class com.microstrategy.usher.LegalConsentEntity
Returns a boolean that represents whether or not the terms of use has been resolved.
textColor() - Method in class com.microstrategy.usher.BadgeDetailHeadViewModel
Returns a String of the text color.
textColor() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the text color of badges.
timeRestrictionEntity() - Method in class com.microstrategy.usher.OrgConfigEntity
Returns a JSON String that represents the list of time restrictions for the current badge.
timeRestrictionItemList() - Method in class com.microstrategy.usher.OrgConfigEntity.TimeRestrictionEntity
Returns a List of OrgConfigEntity.TimeRestrictionItem objects that identify the properties related to badge enablement time restrictions on a daily scale that will be parsed from the JSON String returned from the server.
timeRestrictionModel() - Method in class com.microstrategy.usher.BadgeRestrictionModel
Returns a TimeRestrictionModel object that identifies the properties associated with badge enablement time restrictions.
TimeRestrictionModel - Class in com.microstrategy.usher
The TimeRestrictionModel abstract class identifies the properties related to badge enablement time restrictions.
TimeRestrictionModel.Item - Class in com.microstrategy.usher
The TimeRestrictionModel.Item abstract class identifies the properties related to badge enablement time restrictions, such as when they start and end.
timeZone() - Method in class com.microstrategy.usher.OrgConfigEntity.TimeRestrictionEntity
Returns a String of the time zone.
title() - Method in class com.microstrategy.usher.InboxEntity.SenderEntity
Returns a String of the title of the sender.
toJsonString(InboxEntity) - Static method in class com.microstrategy.usher.InboxEntity
Returns a JSON String of an InboxEntity object.
toJsonString(PushNotificationEntity) - Static method in class com.microstrategy.usher.PushNotificationEntity
Returns a JSON String of an PushNotificationEntity object.
toString() - Method in class com.microstrategy.usher.BadgeEntity
Returns a String of the badge ID and the name of the badge.
toString() - Method in class com.microstrategy.usher.BadgeUIEntity
Returns a String of the full name of the employee.
toString() - Method in class com.microstrategy.usher.GroupKeyItemEntity
Returns a String of the name of the resource.
toString() - Method in class com.microstrategy.usher.OrgUIEntity
Returns a String of the organization ID and the name of the organization.
toString() - Method in class com.microstrategy.usher.PairEntity
Returns a String of the value of the first object plus the value of the second object.
totalGroupKeyItemEntityList() - Method in class com.microstrategy.usher.GroupKeyEntity
Returns the List of GroupKeyItemEntity objects related to the group key.
TOTP_CODE_INVALID - Static variable in class com.microstrategy.usher.UsherCodeEntity
Default value if TOTP is invalid.
TOTP_CODE_NOT_SUPPORTED - Static variable in class com.microstrategy.usher.UsherCodeEntity
Default value if TOTP is not supported.
totpCode() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns a String of the time-based one-time password (TOTP).
totpCodeDuration() - Method in class com.microstrategy.usher.OrgUIEntity
Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
totpCodeDuration() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
totpCodeLeftTime() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
twoWayServerUrl() - Method in class com.microstrategy.usher.MetaDataEntity
Returns a String of the URL of the two way server.
type() - Method in class com.microstrategy.usher.BeaconEntity.Action
Returns a String of the type of an action item.
type() - Method in class com.microstrategy.usher.PushNotificationEntity
Returns an int of the type of push notification.
type(String) - Method in class com.microstrategy.usher.ScannerData.Builder
Returns the ScannerData.Builder for the ScannerData.type() component of the ScannerData object.
type() - Method in class com.microstrategy.usher.ScannerData
Returns a String of the type of the scanned data.
TYPE_AUTHENTICATION - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires extra authentication by means of inputting the user name/password.
TYPE_BADGE_REVOKED_BY_ADMIN - Static variable in class com.microstrategy.usher.BadgeCondition
The badge installed on the current device has been revoked by a network administrator on Network Manager.
TYPE_BLUETOOTH_SETTINGS_ON - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to turn on Bluetooth settings before continuing use.
TYPE_BLUETOOTH_SUPPORTED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires a device that supports Bluetooth.
TYPE_DEVICE_PROVISION_ENROLLMENT - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to enroll a mobile phone number to bind with the badge.
TYPE_DEVICE_PROVISION_VERIFICATION - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to verify the mobile phone number that has been associated with the badge.
TYPE_FINGER_PRINT_ENROLLMENT_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires prior fingerprint enrollment on the device.
TYPE_FINGER_PRINT_HARDWARE_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires a device that supports fingerprint verification.
TYPE_FINGER_PRINT_VERIFICATION_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to verify the fingerprint before continuing use.
TYPE_LOCATION_PERMISSION_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to grant permission to use location before continuing use.
TYPE_LOCATION_RESTRICTION - Static variable in class com.microstrategy.usher.BadgeCondition
The badge can only be used in certain geo locations that are defined on Network Manager.
TYPE_LOCATION_SETTINGS_ON - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to turn on Location Services before continuing use.
TYPE_PASSCODE_ENROLLMENT_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to enroll an independent app passcode.
TYPE_PASSCODE_OR_FINGERPRINT_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to verify the passcode or fingerprint before continuing use.
TYPE_PASSCODE_VERIFICATION_REQUIRED - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to verify the passcode before before continuing use.
TYPE_PHOTO - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to upload a profile photo before continuing use.
TYPE_PRIVACY_POLICY - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to accept the privacy policy.
TYPE_PUSH_NOTIFICATION_BROADCAST_VPN - Static variable in class com.microstrategy.usher.PushNotificationEntity
Push notification for VPN broadcast.
TYPE_PUSH_NOTIFICATION_BROADCAST_WEB_SSO - Static variable in class com.microstrategy.usher.PushNotificationEntity
Push notification for web SSO.
TYPE_PUSH_NOTIFICATION_DESKTOP_PAIRING_RESULT - Static variable in class com.microstrategy.usher.PushNotificationEntity
Push notification for MicroStrategy Badge Desktop pairing.
TYPE_PUSH_NOTIFICATION_DESKTOP_REQUEST_LOGIN - Static variable in class com.microstrategy.usher.PushNotificationEntity
Push notification for MicroStrategy Badge Desktop login.
TYPE_PUSH_NOTIFICATION_LOGICAL_ACCESS - Static variable in class com.microstrategy.usher.PushNotificationEntity
Push notification for logical access.
TYPE_TERM_OF_USE - Static variable in class com.microstrategy.usher.BadgeCondition
The badge requires the user to accept the terms of use.
TYPE_TIME_RESTRICTION - Static variable in class com.microstrategy.usher.BadgeCondition
The badge can only be used in certain time windows that are defined on Network Manager.

U

UNEXPECTED_ERROR - Static variable in exception com.microstrategy.usher.DomainException
 
unit() - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a String of the alternate unit of the radius of the badge enablement geo-fence.
UNIT_FEET - Static variable in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Feet.
UNIT_KILOMETER - Static variable in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Kilometers.
UNIT_METER - Static variable in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Meters.
UNIT_MILE - Static variable in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Miles.
universalDataScannerResultEntity() - Method in class com.microstrategy.usher.ScannerLogEntity
Returns a ScannerResultEntity object that wraps various attributes pertaining to result of a scan.
UPLOAD_GENERIC_PERMISSION_REQUIRED - Static variable in exception com.microstrategy.usher.DomainException
 
username(String) - Method in class com.microstrategy.usher.BadgeLoginParam.Builder
Returns the BadgeLoginParam.Builder for the BadgeLoginParam.username() component of the BadgeLoginParam object.
username() - Method in class com.microstrategy.usher.BadgeLoginParam
Returns a String of the user name.
Usher - Class in com.microstrategy.usher
The Usher class is the entrance to the MicroStrategy Badge SDK.
Usher.Configuration - Class in com.microstrategy.usher
The Usher.Configuration abstract class offers a highly customizable object to configure the SDK with.
Usher.Configuration.Builder - Class in com.microstrategy.usher
The Usher.Configuration.Builder abstract class allows the user to create and return a Usher.Configuration object.
Usher.Configuration.Callback - Interface in com.microstrategy.usher
Callback to receive the result of the server configuration attempt.
USHER_CODE_INVALID - Static variable in class com.microstrategy.usher.UsherCodeEntity
Default value if MicroStrategy Badge code is invalid.
USHER_QR_CODE_INVALID - Static variable in class com.microstrategy.usher.UsherCodeEntity
Default value if MicroStrategy Badge QR code is invalid.
usherAppScheme(String) - Method in class com.microstrategy.usher.Usher.Configuration.Builder
usherCode() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns a String of the MicroStrategy Badge code.
usherCodeDuration() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns an int of the duration in seconds an MicroStrategy Badge code will last before expiring.
UsherCodeEntity - Class in com.microstrategy.usher
The UsherCodeEntity abstract class wraps the core attributes pertaining to the MicroStrategy Badge code, a dynamic identification number that users can use to validate the identities of others using the MicroStrategy Badge app, or the time-based one-time password (TOTP).
usherCodeLeftTime() - Method in class com.microstrategy.usher.UsherCodeEntity
Returns an int of the number of seconds left an MicroStrategy Badge code will last before expiring.
UsherCodeManager - Class in com.microstrategy.usher
The UsherCodeManager class collects all of the use cases related to the MicroStrategy Badge code, including request and validation.
UsherCodeManager(Lifecycle) - Constructor for class com.microstrategy.usher.UsherCodeManager
Constructor for an UsherCodeManager object with the lifecycle set.
UsherCodeManager(AppCompatActivity) - Constructor for class com.microstrategy.usher.UsherCodeManager
Constructor for an UsherCodeManager object with the lifecycle set.
UsherCodeManager(Fragment) - Constructor for class com.microstrategy.usher.UsherCodeManager
Constructor for an UsherCodeManager object with the lifecycle set.
usherCodeOfflineDuration() - Method in class com.microstrategy.usher.OrgUIEntity
Returns an int of the duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network.
usherCodeOnlineDuration() - Method in class com.microstrategy.usher.OrgUIEntity
Returns an int of the duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network.
usherCodeVersion() - Method in class com.microstrategy.usher.OrgUIEntity
Returns an int of the MicroStrategy Badge code version for badges.
UsherSdkIntentContracts - Class in com.microstrategy.usher
The UsherSdkIntentContracts class houses constants that the MicroStrategy Badge SDK exposes as contracts for SDK consumers.
UsherSettingModel - Class in com.microstrategy.usher
The UsherSettingModel abstract class includes various attributes related to the MicroStrategy Badge settings, including device model, MetaDataEntity, and action required count, among others.
uuid() - Method in class com.microstrategy.usher.BeaconEntity
Returns a String of the universally unique identifier (UUID) of the beacon.

V

validate(String, int, SingleCallback<BadgeEntity>) - Method in class com.microstrategy.usher.UsherCodeManager
Returns a BadgeEntity object after validating a Badge code.
value() - Method in class com.microstrategy.usher.BadgeDetailAttributeModel
Returns a String of the value of the item.
valueOf(String) - Static method in enum com.microstrategy.usher.AccessResourceResult.ResultType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.usher.BadgeEntity.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.usher.DeviceBadgeItem.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.usher.OrgUIEntity.LocationTrackingConfig
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.microstrategy.usher.AccessResourceResult.ResultType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.usher.BadgeEntity.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.usher.DeviceBadgeItem.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.usher.OrgUIEntity.LocationTrackingConfig
Returns an array containing the constants of this enum type, in the order they are declared.
verify(int, String, CompleteCallback) - Method in class com.microstrategy.usher.DeviceProvisioningManager
Returns a CompleteCallback after verifying the 6-digit verification code sent to the mobile phone number enrolled with the badge.

W

withBadgeReportScannedDataEntityList(ArrayList<ScannerResultEntity.Item>) - Method in class com.microstrategy.usher.ScannerResultEntity
Constructor for a ScannerResultEntity object with the badgeReportScannedDataEntityList set.
withCredential(String) - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a BadgeIdOrgIdEntity object with an added BadgeIdOrgIdEntity.credential() attribute.
withFavoriteKey(boolean) - Method in class com.microstrategy.usher.KeyEntity
Constructor for a KeyEntity object with the favoriteKey set.
withInRange(double, double) - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a boolean that represents whether or not a specific latitudinal/longitudinal coordinate is within the range of a badge enablement geo-fence.
withInRange(double) - Method in class com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity
Returns a boolean that represents whether or not a distance is within the bounds of the radius.
withInRange(double, double) - Method in class com.microstrategy.usher.RegionEntity
Returns a boolean that represents whether or not a specific latitudinal/longitudinal coordinate is within the range of a telemetry collection geo-fence.
withInRange(double) - Method in class com.microstrategy.usher.RegionEntity
Returns a boolean that represents whether or not a distance is within the bounds of the radius.
withKeyEntity(KeyEntity) - Method in class com.microstrategy.usher.KeyModel
Constructor for a KeyModel object with the keyEntity set.
withOption(String) - Method in class com.microstrategy.usher.InboxEntity
Constructor for a InboxEntity object with the option set.
withOrgName(String) - Method in class com.microstrategy.usher.OrgUIEntity
Constructor for an OrgUIEntity object with the orgName set.
withRecoveredAt(long) - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a BadgeIdOrgIdEntity object with an added BadgeIdOrgIdEntity.recoveredAt() attribute.
withSelected(boolean) - Method in class com.microstrategy.usher.BadgeMiniModel
Constructor for a BadgeMiniModel object with BadgeMiniModel.selected() set.
withSelected(boolean) - Method in class com.microstrategy.usher.ServerModel
Constructor for a ServerModel object with the selected set.
withSortOrder(long) - Method in class com.microstrategy.usher.BadgeIdOrgIdEntity
Returns a BadgeIdOrgIdEntity object with an added BadgeIdOrgIdEntity.sortOrder() attribute.

Z

ZOOM - Static variable in class com.microstrategy.usher.CurrentLocationActivity
 
zoom() - Method in class com.microstrategy.usher.LocationRestrictionModel
Returns a float of the zoom level.
A B C D E F G H I K L M N O P Q R S T U V W Z 
Skip navigation links