Package com.microstrategy.usher

Interface Summary

Interface	Description
CompleteCallback	The CompleteCallback interface represents an asynchronous callback without any value.
MaybeCallback<T>	The MaybeCallback interface represents an asynchronous callback that may or may not occur.
ObserverCallback<T>	The ObserverCallback interface represents an asynchronous callback returning multiple values.
ScannerManager.Callback	An object that wraps the callback for ScannerManager.
SingleCallback<T>	The SingleCallback interface represents an asynchronous callback returning a single values.
Usher.Configuration.Callback	Callback to receive the result of the server configuration attempt.

Class Summary

Class	Description
AccessResourceResult	The AccessResourceResult object wraps the logical and physical access request result.
BadgeCondition	The BadgeCondition abstract class wraps all the attributes related to conditions that are restricting the badge from use.
BadgeCondition.Config	The BadgeCondition.Config abstract class wraps the properties related to badge condition configurations on Network Manager.
BadgeCondition.Config.Builder	The BadgeCondition.Config.Builder abstract class allows the user to create and return a BadgeCondition.Config object.
BadgeDetailAttributeModel	The BadgeDetailAttributeModel abstract class identifies the properties related to attributes on the Badge Detail View.
BadgeDetailHeadViewModel	The BadgeDetailHeadViewModel abstract class identifies the properties related to information displayed in the header in the Badge Detail View.
BadgeDetailModel	The BadgeDetailModel abstract class identifies the properties related to the Badge Detail View.
BadgeEntity	The BadgeEntity abstract class wraps the core attributes pertaining to the badge.
BadgeExceedLimitEntity	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.
BadgeIdOrgIdEntity	The BadgeIdOrgIdEntity abstract class wraps a badge ID with an organization ID, along with certain other attributes pertaining to an organization.
BadgeLoginParam	The BadgeLoginParam abstract class wraps fields related to a badge login request.
BadgeLoginParam.Builder	The BadgeLoginParam.Builder abstract class allows the user to create and return a BadgeLoginParam object.
BadgeManager	The BadgeManager class collects all of the use cases related to badge management.
BadgeMiniModel	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	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.
BadgeRecoveryManager	The BadgeRecoveryManager class collects all of the use cases related to badge recovery.
BadgeRestrictionModel	The BadgeRestrictionModel abstract class identifies the properties related to badge enablement location and time restrictions.
BadgeStatusEntity	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	The BadgeUIEntity abstract class wraps various attributes about the presentation of a badge, including organization name, employee name, and employee title, among others.
BeaconEntity	The BeaconEntity abstract class wraps various attributes related to a beacon.
BeaconEntity.Action	The BeaconEntity.Action abstract class wraps information related to action items, including ID, type, and a message.
CountryEntity	The CountryEntity abstract class identifies the properties related to a country that will be parsed from the JSON String returned from the server.
CppManager
CurrentLocationActivity
DeviceBadgeItem	The DeviceBadgeItem abstract class wraps the core attributes related to the badge on the current device.
DeviceBadgeModel	The DeviceBadgeModel abstract class wraps the various attributes related to the badge on the current device.
DeviceEntity	The DeviceEntity abstract class wraps the core attributes related to the device.
DeviceManager	The DeviceManager class takes care of the responsibilities of managing badges across all devices.
DeviceModel	The DeviceModel abstract class contains the mapping of the current DeviceEntity object with the List of DeviceBadgeModel objects.
DeviceProvisioningManager	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.
FingerprintVerificationResultEntity	The FingerprintVerificationResultEntity abstract class wraps the attributes related to the result of fingerprint verification.
GroupKeyEntity	The GroupKeyEntity abstract class wraps the grouped key items defined on Network Manager.
GroupKeyItemEntity	The GroupKeyItemEntity abstract class wraps various attributes related to the keys found in a group key.
InboxEntity	The InboxEntity abstract class wraps various attributes related to the inbox, including notification ID, sender name, sender title, and message, among others.
InboxEntity.SenderEntity	The InboxEntity.SenderEntity abstract class wraps various properties related to the sender of an InboxEntity, including badge ID, name, and title, among others.
InboxManager	The InboxManager class collects all of the APIs related to the inbox.
KeyEntity	The KeyEntity abstract class wraps various attributes related to a key.
KeyManager	The KeyManager class collects all of the use cases related to key management.
KeyModel	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.
KeyParam	The KeyParam abstract class wraps fields related to keys.
LegalConsentEntity	The LegalConsentEntity abstract class wraps various attributes related to the terms of service.
LocationRestrictionModel	The LocationRestrictionModel abstract class identifies the properties related to badge enablement location restrictions.
MetaDataEntity	The MetaDataEntity abstract class wraps various attributes related to the metadata, including supported version names, and support phone numbers, among others.
NotificationUtil
OrgBasicEntity	The OrgBasicEntity abstract class wraps various attributes about the organization.
OrgConfigEntity	The OrgConfigEntity abstract class wraps the attributes pertaining to the badge condition stored in the cache.
OrgConfigEntity.LocationConditionEntity	The OrgConfigEntity.LocationConditionEntity abstract class includes various attributes about the badge enablement geo-fences associated with the badge.
OrgConfigEntity.TimeRestrictionEntity	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	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.
OrgUIEntity	The OrgUIEntity abstract class wraps various attributes about the organization and its configuration for MicroStrategy Badge, including organization ID and organization name, among others.
PairEntity<F,S>	Container to ease passing around a tuple of two objects.
PushNotificationEntity	The PushNotificationEntity abstract class wraps various properties related to push notifications, including the type, organization ID, client name, server URL, among others.
PushNotificationModel
PushNotificationModel.Builder
RegionEntity	The RegionEntity abstract class includes various attributes about the telemetry collection geo-fences associated with the badge.
ScannerData	The ScannerData abstract class wraps the properties related to scanned data, including type, content, and badge ID, among others.
ScannerData.Builder	The ScannerData.Builder abstract class allows the user to create and return a ScannerData object.
ScannerLogEntity	The ScannerLogEntity abstract class wraps the core attributes pertaining to the scanner log entries.
ScannerLogModel	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	The ScannerManager class is responsible for handling the scanned QR code or barcode data that is passed via a ScannerData object.
ScannerResultEntity	The ScannerResultEntity abstract class wraps various attributes pertaining to result of scans.
ScannerResultEntity.Item	The ScannerResultEntity.Item abstract class wraps various attributes pertaining to the result of a scan.
ServerModel	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	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	The ServerModel.PreConfig.Builder abstract class allows the user to create and return a ServerModel.PreConfig object.
TimeRestrictionModel	The TimeRestrictionModel abstract class identifies the properties related to badge enablement time restrictions.
TimeRestrictionModel.Item	The TimeRestrictionModel.Item abstract class identifies the properties related to badge enablement time restrictions, such as when they start and end.
Usher	The Usher class is the entrance to the MicroStrategy Badge SDK.
Usher.Configuration	The Usher.Configuration abstract class offers a highly customizable object to configure the SDK with.
Usher.Configuration.Builder	The Usher.Configuration.Builder abstract class allows the user to create and return a Usher.Configuration object.
UsherCodeEntity	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).
UsherCodeManager	The UsherCodeManager class collects all of the use cases related to the MicroStrategy Badge code, including request and validation.
UsherSdkIntentContracts	The UsherSdkIntentContracts class houses constants that the MicroStrategy Badge SDK exposes as contracts for SDK consumers.
UsherSettingModel	The UsherSettingModel abstract class includes various attributes related to the MicroStrategy Badge settings, including device model, MetaDataEntity, and action required count, among others.

Enum Summary

Enum	Description
AccessResourceResult.ResultType	The types of results for accessing a physical or logical resource.
BadgeEntity.Status	The various enumerations for Status.
DeviceBadgeItem.Status	Enumerations for the DeviceBadgeItem.Status of the badge
OrgUIEntity.LocationTrackingConfig	The enumerations for OrgUIEntity.LocationTrackingConfig.

Exception Summary

Exception	Description
BadgeConditionException	The BadgeConditionException class is thrown when a BadgeCondition prevents the badge from being used.
DomainException
NeedToRecoveryBadgeException	The NeedToRecoveryBadgeException class is thrown when a badge is otherwise expected for a process (e.g.