public abstract class UsherCodeEntity
extends java.lang.Object
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).| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_MINIMUM_USHER_CODE_LENGTH
Default minimum MicroStrategy Badge code length.
|
static java.lang.String |
TOTP_CODE_INVALID
Default value if TOTP is invalid.
|
static java.lang.String |
TOTP_CODE_NOT_SUPPORTED
Default value if TOTP is not supported.
|
static java.lang.String |
USHER_CODE_INVALID
Default value if MicroStrategy Badge code is invalid.
|
static java.lang.String |
USHER_QR_CODE_INVALID
Default value if MicroStrategy Badge QR code is invalid.
|
| Modifier and Type | Method and Description |
|---|---|
abstract java.lang.String |
qrCode()
Returns a String of the QR code content.
|
abstract boolean |
supportTotpCode()
Returns a boolean that represents whether or not server configuration supports the
time-based one-time password (TOTP).
|
abstract java.lang.String |
totpCode()
Returns a String of the time-based one-time password (TOTP).
|
abstract int |
totpCodeDuration()
Returns an int of the duration in seconds a time-based one-time password (TOTP) will last
before expiring.
|
abstract int |
totpCodeLeftTime()
Returns an int of the duration in seconds a time-based one-time password (TOTP) will last
before expiring.
|
abstract java.lang.String |
usherCode()
Returns a String of the MicroStrategy Badge code.
|
abstract int |
usherCodeDuration()
Returns an int of the duration in seconds an MicroStrategy Badge code will last before
expiring.
|
abstract int |
usherCodeLeftTime()
Returns an int of the number of seconds left an MicroStrategy Badge code will last before
expiring.
|
public static final int DEFAULT_MINIMUM_USHER_CODE_LENGTH
public static final java.lang.String TOTP_CODE_NOT_SUPPORTED
public static final java.lang.String TOTP_CODE_INVALID
public static final java.lang.String USHER_CODE_INVALID
public static final java.lang.String USHER_QR_CODE_INVALID
public abstract boolean supportTotpCode()
true if the server configuration supports the time-based one-time password
(TOTP);
false otherwise.public abstract java.lang.String usherCode()
public abstract java.lang.String totpCode()
public abstract java.lang.String qrCode()
public abstract int totpCodeDuration()
public abstract int usherCodeDuration()
public abstract int totpCodeLeftTime()
public abstract int usherCodeLeftTime()