com.microstrategy.usher

Class BeaconEntity

java.lang.Object

com.microstrategy.usher.BeaconEntity

public abstract class BeaconEntity
extends java.lang.Object

The BeaconEntity abstract class wraps various attributes related to a beacon.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeaconEntity.Action The BeaconEntity.Action abstract class wraps information related to action items, including ID, type, and a message.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIG_TYPE_ACTIVE Beacon is active.
static int	CONFIG_TYPE_COMBINED Beacon has combined functionality (i.e.
static int	CONFIG_TYPE_NONE Beacon is not configured.
static int	CONFIG_TYPE_PASSIVE Beacon is passive (i.e.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	actionMessage() Returns a String of the button text of a beacon action.
abstract java.util.List<BeaconEntity.Action>	actions() Returns the List of BeaconEntity.Action objects that includes various information related to action items, including ID, type, and a message.
abstract java.lang.String	beaconName() Returns a String of the name of the beacon.
abstract int	configType() Returns an int of the configuration type of the beacon.
abstract boolean	enabled() Returns a boolean that represents whether or not the beacon is enabled on Network Manager.
abstract int	id() Returns an int of the identification number of the beacon assigned by Network Manager.
abstract java.lang.String	keyName() Returns a String of the key associated with the beacon.
abstract int	major() Returns an int of the major region for the Usher network.
abstract java.lang.String	message() Returns a String of the message associated with triggering the beacon.
abstract int	minor() Returns an int of the minor region associated with the beacon.
abstract int	orgId() Returns an int of the identification number of the organization of the beacon.
abstract java.lang.String	proximityId() Returns a String of the proximity identification number of the beacon.
abstract java.lang.String	uuid() Returns a String of the universally unique identifier (UUID) of the beacon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_TYPE_NONE

public static final int CONFIG_TYPE_NONE

Beacon is not configured. Value is -1.

See Also:

Constant Field Values

CONFIG_TYPE_PASSIVE

public static final int CONFIG_TYPE_PASSIVE

Beacon is passive (i.e. user receives a local notification once in beacon proximity in order to confirm the action).

See Also:

Constant Field Values

CONFIG_TYPE_ACTIVE

public static final int CONFIG_TYPE_ACTIVE

Beacon is active. Not supported by Android.

See Also:

Constant Field Values

CONFIG_TYPE_COMBINED

public static final int CONFIG_TYPE_COMBINED

Beacon has combined functionality (i.e. passive + active). Functionally behaves like CONFIG_TYPE_PASSIVE.

See Also:

Constant Field Values

Method Detail

uuid

public abstract java.lang.String uuid()

Returns a String of the universally unique identifier (UUID) of the beacon. This value is supplied by your third-party beacon provider.

Returns:

the universally unique identifier (UUID) of the beacon.

proximityId

public abstract java.lang.String proximityId()

Returns a String of the proximity identification number of the beacon.

Returns:

the proximity identification number of the beacon.

major

public abstract int major()

Returns an int of the major region for the Usher network.

Returns:

the major region identifier of the Usher network.

minor

public abstract int minor()

Returns an int of the minor region associated with the beacon.

Returns:

the minor region identifier of the beacon.

enabled

public abstract boolean enabled()

Returns a boolean that represents whether or not the beacon is enabled on Network Manager.

Returns:

true if the beacon is enabled on Network Manager; false otherwise.

configType

public abstract int configType()

Returns an int of the configuration type of the beacon. Android does not support CONFIG_TYPE_ACTIVE.

Returns:

the configuration type of the beacon. These include:

• CONFIG_TYPE_PASSIVE = 0 = Notification (on Network Manager)
• CONFIG_TYPE_ACTIVE = 1 = Extension (on Network Manager)
• CONFIG_TYPE_COMBINED = 2 = Notification and Extension (on Network Manager)

actionMessage

@Nullable
public abstract java.lang.String actionMessage()

Returns a String of the button text of a beacon action. May be null.

Returns:

the button text of a beacon action.

keyName

@Nullable
public abstract java.lang.String keyName()

Returns a String of the key associated with the beacon. May be null.

Returns:

the key associated the beacon.

message

@Nullable
public abstract java.lang.String message()

Returns a String of the message associated with triggering the beacon. May be null.

Returns:

the message associated with triggering the beacon.

orgId

public abstract int orgId()

Returns an int of the identification number of the organization of the beacon.

Returns:

the identification number of the organization of the beacon.

id

public abstract int id()

Returns an int of the identification number of the beacon assigned by Network Manager.

Returns:

the identification number of the beacon assigned by Network Manager.

beaconName

public abstract java.lang.String beaconName()

Returns a String of the name of the beacon. May be null.

Returns:

the message associated with triggering a beacon.

actions

@Nullable
public abstract java.util.List<BeaconEntity.Action> actions()

Returns the List of BeaconEntity.Action objects that includes various information related to action items, including ID, type, and a message. May be null.

Returns:

the List of BeaconEntity.Action objects of the badge.