com.idevicesinc.sweetblue

Enum DiscoveryListener.LifeCycle

java.lang.Object

java.lang.Enum<DiscoveryListener.LifeCycle>

com.idevicesinc.sweetblue.DiscoveryListener.LifeCycle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DiscoveryListener.LifeCycle>

Enclosing interface:

DiscoveryListener

public static enum DiscoveryListener.LifeCycle
extends java.lang.Enum<DiscoveryListener.LifeCycle>

Enumerates changes in the "discovered" state of a device. Used at DiscoveryListener.DiscoveryEvent.lifeCycle().

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCOVERED Used when a device is discovered for the first time after calling BleManager.startScan() (or its overloads) or BleManager.startPeriodicScan(Interval, Interval).
REDISCOVERED Used when a device is rediscovered after already being discovered at least once.
UNDISCOVERED Used when a device is "undiscovered" after being discovered at least once.

Method Summary

Modifier and Type	Method and Description
static DiscoveryListener.LifeCycle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DiscoveryListener.LifeCycle[]	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

DISCOVERED

public static final DiscoveryListener.LifeCycle DISCOVERED

Used when a device is discovered for the first time after calling BleManager.startScan() (or its overloads) or BleManager.startPeriodicScan(Interval, Interval).

REDISCOVERED

public static final DiscoveryListener.LifeCycle REDISCOVERED

Used when a device is rediscovered after already being discovered at least once.

UNDISCOVERED

public static final DiscoveryListener.LifeCycle UNDISCOVERED

Used when a device is "undiscovered" after being discovered at least once. There is no native equivalent for this callback. Undiscovery is approximated with a timeout based on the last time we discovered a device, configured by BleDeviceConfig.undiscoveryKeepAlive. This option is disabled by default. If set, you should expect that the undiscovery callback will take some amount of time to receive after an advertising device is turned off or goes out of range or what have you. It's generally not as fast as other state changes like BleDeviceState.BLE_DISCONNECTED or getting BleDeviceState.DISCOVERED in the first place.

See Also:

BleDeviceConfig.minScanTimeNeededForUndiscovery, BleDeviceConfig.undiscoveryKeepAlive

Method Detail

values

public static DiscoveryListener.LifeCycle[] 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 (DiscoveryListener.LifeCycle c : DiscoveryListener.LifeCycle.values())
    System.out.println(c);

Returns:

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

valueOf

public static DiscoveryListener.LifeCycle 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