com.idevicesinc.sweetblue

Enum BleAdvertisingSettings.BleAdvertisingMode

java.lang.Object

java.lang.Enum<BleAdvertisingSettings.BleAdvertisingMode>

com.idevicesinc.sweetblue.BleAdvertisingSettings.BleAdvertisingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BleAdvertisingSettings.BleAdvertisingMode>

Enclosing class:

BleAdvertisingSettings

public static enum BleAdvertisingSettings.BleAdvertisingMode
extends java.lang.Enum<BleAdvertisingSettings.BleAdvertisingMode>

Type-safe parallel of static final int members of AdvertiseSettings. This is only applicable for Android >= 5.0 OS levels.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO This option is recommended and will let SweetBlue automatically choose what advertising mode to use based on whether the app is backgrounded, and if we're doing a continuous, or short-term advertisement
HIGH_FREQUENCY Strict typing for AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY.
LOW_FREQUENCY Strict typing for AdvertiseSettings.ADVERTISE_MODE_LOW_POWER.
MEDIUM_FREQUENCY Strict typing for AdvertiseSettings.ADVERTISE_MODE_BALANCED.

Method Summary

Modifier and Type	Method and Description
static BleAdvertisingSettings.BleAdvertisingMode	fromNative(int nativeMode)
int	getNativeMode() Returns one of the static final int members of AdvertiseSettings, or -1 for AUTO.
static BleAdvertisingSettings.BleAdvertisingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BleAdvertisingSettings.BleAdvertisingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTO

public static final BleAdvertisingSettings.BleAdvertisingMode AUTO

This option is recommended and will let SweetBlue automatically choose what advertising mode to use based on whether the app is backgrounded, and if we're doing a continuous, or short-term advertisement

LOW_FREQUENCY

public static final BleAdvertisingSettings.BleAdvertisingMode LOW_FREQUENCY

Strict typing for AdvertiseSettings.ADVERTISE_MODE_LOW_POWER.

MEDIUM_FREQUENCY

public static final BleAdvertisingSettings.BleAdvertisingMode MEDIUM_FREQUENCY

Strict typing for AdvertiseSettings.ADVERTISE_MODE_BALANCED.

HIGH_FREQUENCY

public static final BleAdvertisingSettings.BleAdvertisingMode HIGH_FREQUENCY

Strict typing for AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY.

Method Detail

values

public static BleAdvertisingSettings.BleAdvertisingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BleAdvertisingSettings.BleAdvertisingMode c : BleAdvertisingSettings.BleAdvertisingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BleAdvertisingSettings.BleAdvertisingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNativeMode

public int getNativeMode()

Returns one of the static final int members of AdvertiseSettings, or -1 for AUTO.

fromNative

public static BleAdvertisingSettings.BleAdvertisingMode fromNative(int nativeMode)