BadgeDetailAttributeModel

java.lang.Object
- com.microstrategy.usher.BadgeDetailAttributeModel

```
public abstract class BadgeDetailAttributeModel
extends java.lang.Object
```
The BadgeDetailAttributeModel abstract class identifies the properties related to attributes on the Badge Detail View.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTRIBUTE_ID_BADGE_ID` Badge ID.
`static int`	`ATTRIBUTE_ID_BADGE_NAME` Badge name.
`static int`	`ATTRIBUTE_ID_BLUETOOTH` Bluetooth.
`static int`	`ATTRIBUTE_ID_DATE_ISSUED` Badge issue date.
`static int`	`ATTRIBUTE_ID_EMAIL` The email address linked to the badge.
`static int`	`ATTRIBUTE_ID_ENROLLED_WITH` Mobile phone number linked to the badge with country code prepended.
`static int`	`ATTRIBUTE_ID_EXTRA_ATTRIBUTE` Any additional attribute not captured by the other types.
`static int`	`ATTRIBUTE_ID_LOCATION_SERVICE` Location Services.
`static int`	`ATTRIBUTE_ID_ORG` Organization name.
`static int`	`ATTRIBUTE_ID_PASSCODE` Passcode.
`static int`	`ATTRIBUTE_ID_PRIVACY_POLICY` Privacy policy.
`static int`	`ATTRIBUTE_ID_REMOVE_BADGE` "Delete Badge" button.
`static int`	`ATTRIBUTE_ID_TERM_OF_USE` Terms of use.
`static int`	`ATTRIBUTE_ID_TOTP_CODE` Time-based one-time password (TOTP).
`static int`	`ATTRIBUTE_ID_USER_VALIDATION` User validation.
`static int`	`ATTRIBUTE_ID_USHER_CODE` MicroStrategy Badge (Usher) code.
`static java.lang.String`	`DUMMY_VALUE` Dummy value.
`static int`	`ITEM_VIEW_TYPE_DEFAULT` The default view.
`static int`	`ITEM_VIEW_TYPE_DELETE` The view for the "Delete Badge" button.
`static int`	`ITEM_VIEW_TYPE_EXPANDABLE` An expandable view for content that is greater than 30 characters.
`static int`	`ITEM_VIEW_TYPE_PRIVACY_POLICY_OR_TERM_OF_USE` The view for the privacy policy/terms of use.
`static int`	`ITEM_VIEW_TYPE_TOTP_CODE` The view for the time-based one-time password (TOTP).
`static int`	`ITEM_VIEW_TYPE_USER_VALIDATION` The view for user validation.
`static int`	`ITEM_VIEW_TYPE_USHER_CODE` The view for the MicroStrategy Badge (Usher) code.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract int`	`attributeId()` Returns an int of the identification number of the attribute.
`abstract java.lang.String`	`extraAttributeKey()` Returns a String of the alternate attribute name.
`abstract int`	`itemViewType()` Returns an int of the item view type.
`abstract int`	`max()` Returns an int of the maximum value for the progress bar.
`abstract int`	`progress()` Returns an int of the percent completion of the progress bar.
`abstract java.lang.String`	`qrCode()` Returns a String of the QR code content.
`abstract java.lang.String`	`value()` Returns a String of the value of the item.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ITEM_VIEW_TYPE_DEFAULT
```
public static final int ITEM_VIEW_TYPE_DEFAULT
```
    The default view. This encompasses all views that are not captured by the other types. View type is 0.
    
    See Also:
    
    Constant Field Values
  - ITEM_VIEW_TYPE_USER_VALIDATION
```
public static final int ITEM_VIEW_TYPE_USER_VALIDATION
```
    The view for user validation. Clicking on the user validation view will allow the user to enter a MicroStrategy Badge (Usher) code to validate a user. View type is 1.
    
    See Also:
    
    Constant Field Values
  - ITEM_VIEW_TYPE_TOTP_CODE
```
public static final int ITEM_VIEW_TYPE_TOTP_CODE
```
    The view for the time-based one-time password (TOTP). Will display the TOTP and a progress bar signalling expiration. View type is 2.
    
    See Also:
    
    Constant Field Values
  - ITEM_VIEW_TYPE_USHER_CODE
```
public static final int ITEM_VIEW_TYPE_USHER_CODE
```
    The view for the MicroStrategy Badge (Usher) code. View type is 3.
    
    See Also:
    
    Constant Field Values
  - ITEM_VIEW_TYPE_PRIVACY_POLICY_OR_TERM_OF_USE
```
public static final int ITEM_VIEW_TYPE_PRIVACY_POLICY_OR_TERM_OF_USE
```
    The view for the privacy policy/terms of use. Clicking on this view will bring the user to download and view the privacy policy/terms of use. View type is 4.
    
    See Also:
    
    Constant Field Values
  - ITEM_VIEW_TYPE_DELETE
```
public static final int ITEM_VIEW_TYPE_DELETE
```
    The view for the "Delete Badge" button. Clicking on this button will delete the current badge from the current device. A deleted badge can be recovered via badge recovery. View type is 5.
    
    See Also:
    
    Constant Field Values
  - ITEM_VIEW_TYPE_EXPANDABLE
```
public static final int ITEM_VIEW_TYPE_EXPANDABLE
```
    An expandable view for content that is greater than 30 characters. Will expand and collapse upon clicking. View type is 6.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_BADGE_ID
```
public static final int ATTRIBUTE_ID_BADGE_ID
```
    Badge ID. Attribute ID is 0.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_ORG
```
public static final int ATTRIBUTE_ID_ORG
```
    Organization name. Attribute ID is 1.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_BADGE_NAME
```
public static final int ATTRIBUTE_ID_BADGE_NAME
```
    Badge name. Attribute ID is 2.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_DATE_ISSUED
```
public static final int ATTRIBUTE_ID_DATE_ISSUED
```
    Badge issue date. Attribute ID is 3.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_EMAIL
```
public static final int ATTRIBUTE_ID_EMAIL
```
    The email address linked to the badge. Attribute ID is 4.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_EXTRA_ATTRIBUTE
```
public static final int ATTRIBUTE_ID_EXTRA_ATTRIBUTE
```
    Any additional attribute not captured by the other types. Attribute ID is 5.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_USER_VALIDATION
```
public static final int ATTRIBUTE_ID_USER_VALIDATION
```
    User validation. Attribute ID is 6.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_TOTP_CODE
```
public static final int ATTRIBUTE_ID_TOTP_CODE
```
    Time-based one-time password (TOTP). Attribute ID is 7.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_USHER_CODE
```
public static final int ATTRIBUTE_ID_USHER_CODE
```
    MicroStrategy Badge (Usher) code. Attribute ID is 8.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_PASSCODE
```
public static final int ATTRIBUTE_ID_PASSCODE
```
    Passcode. Attribute ID is 9.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_LOCATION_SERVICE
```
public static final int ATTRIBUTE_ID_LOCATION_SERVICE
```
    Location Services. Attribute ID is 10.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_BLUETOOTH
```
public static final int ATTRIBUTE_ID_BLUETOOTH
```
    Bluetooth. Attribute ID is 11.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_PRIVACY_POLICY
```
public static final int ATTRIBUTE_ID_PRIVACY_POLICY
```
    Privacy policy. Attribute ID is 12.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_TERM_OF_USE
```
public static final int ATTRIBUTE_ID_TERM_OF_USE
```
    Terms of use. Attribute ID is 13.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_ENROLLED_WITH
```
public static final int ATTRIBUTE_ID_ENROLLED_WITH
```
    Mobile phone number linked to the badge with country code prepended. Attribute ID is 14.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ID_REMOVE_BADGE
```
public static final int ATTRIBUTE_ID_REMOVE_BADGE
```
    "Delete Badge" button. Attribute ID is 15.
    
    See Also:
    
    Constant Field Values
  - DUMMY_VALUE
```
public static final java.lang.String DUMMY_VALUE
```
    Dummy value.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - attributeId
```
public abstract int attributeId()
```
    Returns an int of the identification number of the attribute.
    Returns:
    the identification number of the attribute. These include:
    
    ATTRIBUTE_ID_BADGE_ID = 0
    
    ATTRIBUTE_ID_ORG = 1
    
    ATTRIBUTE_ID_BADGE_NAME = 2
    
    ATTRIBUTE_ID_DATE_ISSUED = 3
    
    ATTRIBUTE_ID_EMAIL = 4
    
    ATTRIBUTE_ID_EXTRA_ATTRIBUTE = 5
    
    ATTRIBUTE_ID_USER_VALIDATION = 6
    
    ATTRIBUTE_ID_TOTP_CODE = 7
    
    ATTRIBUTE_ID_USHER_CODE = 8
    
    ATTRIBUTE_ID_PASSCODE = 9
    
    ATTRIBUTE_ID_LOCATION_SERVICE = 10
    
    ATTRIBUTE_ID_BLUETOOTH = 11
    
    ATTRIBUTE_ID_PRIVACY_POLICY = 12
    
    ATTRIBUTE_ID_TERM_OF_USE = 13
    
    ATTRIBUTE_ID_ENROLLED_WITH = 14
    
    ATTRIBUTE_ID_REMOVE_BADGE = 15
  - itemViewType
```
public abstract int itemViewType()
```
    Returns an int of the item view type. An item view type is the specific type of view that an attribute has while displayed in the Badge Detail View.
    Returns:
    the item view type. These include:
    
    ITEM_VIEW_TYPE_DEFAULT = 0
    
    ITEM_VIEW_TYPE_USER_VALIDATION = 1
    
    ITEM_VIEW_TYPE_TOTP_CODE = 2
    
    ITEM_VIEW_TYPE_USHER_CODE = 3
    
    ITEM_VIEW_TYPE_PRIVACY_POLICY_OR_TERM_OF_USE = 4
    
    ITEM_VIEW_TYPE_DELETE = 5
    
    ITEM_VIEW_TYPE_EXPANDABLE = 6
  - progress
```
public abstract int progress()
```
    Returns an int of the percent completion of the progress bar.
    
    Returns:
    
    the percent completion of the progress bar.
  - max
```
public abstract int max()
```
    Returns an int of the maximum value for the progress bar.
    
    Returns:
    
    the maximum value of the progress bar.
  - value
```
public abstract java.lang.String value()
```
    Returns a String of the value of the item.
    Returns:
    the value of the item. There is a dummy value of:
    
    DUMMY_VALUE = ""
  - extraAttributeKey
```
@Nullable
public abstract java.lang.String extraAttributeKey()
```
    Returns a String of the alternate attribute name. May be null.
    
    Returns:
    
    the alternate attribute name.
  - qrCode
```
@Nullable
public abstract java.lang.String qrCode()
```
    Returns a String of the QR code content. May be null.
    
    Returns:
    
    the QR code content.

Class BadgeDetailAttributeModel

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ITEM_VIEW_TYPE_DEFAULT

ITEM_VIEW_TYPE_USER_VALIDATION

ITEM_VIEW_TYPE_TOTP_CODE

ITEM_VIEW_TYPE_USHER_CODE

ITEM_VIEW_TYPE_PRIVACY_POLICY_OR_TERM_OF_USE

ITEM_VIEW_TYPE_DELETE

ITEM_VIEW_TYPE_EXPANDABLE

ATTRIBUTE_ID_BADGE_ID

ATTRIBUTE_ID_ORG

ATTRIBUTE_ID_BADGE_NAME

ATTRIBUTE_ID_DATE_ISSUED

ATTRIBUTE_ID_EMAIL

ATTRIBUTE_ID_EXTRA_ATTRIBUTE

ATTRIBUTE_ID_USER_VALIDATION

ATTRIBUTE_ID_TOTP_CODE

ATTRIBUTE_ID_USHER_CODE

ATTRIBUTE_ID_PASSCODE

ATTRIBUTE_ID_LOCATION_SERVICE

ATTRIBUTE_ID_BLUETOOTH

ATTRIBUTE_ID_PRIVACY_POLICY

ATTRIBUTE_ID_TERM_OF_USE

ATTRIBUTE_ID_ENROLLED_WITH

ATTRIBUTE_ID_REMOVE_BADGE

DUMMY_VALUE

Method Detail

attributeId

itemViewType

progress

max

value

extraAttributeKey

qrCode