public abstract class BadgeEntity
extends java.lang.Object
BadgeEntity abstract class wraps the core attributes pertaining to the badge.
These attributes are derived from the bean and are further broken down into the more dynamic
BadgeModel.| Modifier and Type | Class and Description |
|---|---|
static class |
BadgeEntity.Status
The various enumerations for Status.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
activated(long nowInSeconds)
Returns a boolean that represents whether or not the badge has been activated.
|
abstract java.util.List<com.microstrategy.usher.BadgeAdditionInfoItem> |
badgeAdditionInfoItemList()
Returns the
List of BadgeAdditionInfoItem objects that wrap core attribute
items related to the badge for use as a key/value pair. |
abstract int |
badgeId()
Returns an int of the identification number of the badge.
|
abstract BadgeStatusEntity |
badgeStatusEntity()
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. |
abstract BadgeUIEntity |
badgeUIEntity()
Returns a
BadgeUIEntity object that includes various attributes about the
presentation of a badge, including organization name, employee name, and employee title,
among others. |
abstract OrgConfigEntity |
orgConfigEntity()
Returns a
OrgConfigEntity object that includes various attributes about the
badge condition stored in the cache. |
abstract OrgUIEntity |
orgUIEntity()
Returns a
OrgUIEntity object that includes various attributes about the
organization and its configuration for Usher, including organization ID and organization
name, among others. |
abstract BadgeEntity.Status |
status()
Returns a
BadgeEntity.Status enumeration that represents the current status of the badge in
relation to logging in and being ready to use. |
abstract java.util.List<RegionEntity> |
telemetryConditionItemList()
Returns the
List of RegionEntity objects that includes various attributes
about the region restrictions (i.e. |
java.lang.String |
toString()
Returns a String of the badge ID and the name of the badge.
|
public abstract int badgeId()
public abstract BadgeStatusEntity badgeStatusEntity()
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 of the badge.public abstract BadgeUIEntity badgeUIEntity()
BadgeUIEntity object that includes various attributes about the
presentation of a badge, including organization name, employee name, and employee title,
among others.BadgeUIEntity of the badge.public abstract OrgConfigEntity orgConfigEntity()
OrgConfigEntity object that includes various attributes about the
badge condition stored in the cache. This includes various restrictions needed to be
fulfilled before the badge is able to be used.OrgConfigEntity of the badge.public abstract OrgUIEntity orgUIEntity()
OrgUIEntity object that includes various attributes about the
organization and its configuration for Usher, including organization ID and organization
name, among others.OrgUIEntity of the badge.public abstract java.util.List<RegionEntity> telemetryConditionItemList()
List of RegionEntity objects that includes various attributes
about the region restrictions (i.e. geofences) associated with the badge. This includes
various properties such as latitude, longitude, and radius of a geofence.List of RegionEntity objects of the badge.public abstract BadgeEntity.Status status()
BadgeEntity.Status enumeration that represents the current status of the badge in
relation to logging in and being ready to use.BadgeEntity.Status of the badge. BadgeEntity.Status enumerations include:ACTIVATEDPENDING_LOGINPENDING_PHONE_NUMBER_ENROLLMENTPENDING_PHONE_NUMBER_VERIFICATIONPENDING_PROFILE_PHOTOPENDING_TYPE_PRIVACY_POLICYPENDING_TYPE_TERM_OF_USEREVOKEDpublic boolean activated(long nowInSeconds)
BadgeEntity.Status.ACTIVATED option achieved by
enrolling and verifying a mobile phone number for a device or being within the grace period
of mobile phone number enrollment defined on Network Manager.nowInSeconds - the current time in seconds, used to calculate whether or not the device
is within the grace period of mobile phone number enrollment.true if the status is equal to BadgeEntity.Status.ACTIVATED or
if the device is within the grace period of mobile phone number enrollment defined
on Network Manager;
false otherwise.@Nullable public abstract java.util.List<com.microstrategy.usher.BadgeAdditionInfoItem> badgeAdditionInfoItemList()
List of BadgeAdditionInfoItem objects that wrap core attribute
items related to the badge for use as a key/value pair.List of BadgeAdditionInfoItem objectspublic java.lang.String toString()
toString in class java.lang.Object