com.polidea.rxandroidble2

Enum NotificationSetupMode

java.lang.Object

java.lang.Enum<NotificationSetupMode>

com.polidea.rxandroidble2.NotificationSetupMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NotificationSetupMode>

public enum NotificationSetupMode
extends java.lang.Enum<NotificationSetupMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPAT Compatibility mode for devices that do not contain CLIENT_CHARACTERISTIC_CONFIG
DEFAULT Configures notifications according to the standard.
QUICK_SETUP Configures notifications according to the standard but in contrast to the DEFAULT mode the `Observable` is emitted before the CLIENT_CHARACTERISTIC_CONFIG is written.

Method Summary

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

DEFAULT

public static final NotificationSetupMode DEFAULT

Configures notifications according to the standard. The `Observable` is emitted after both the system notification is set and the CLIENT_CHARACTERISTIC_CONFIG descriptor was written so the notification is fully set up. If a device starts to notify right after CLIENT_CHARACTERISTIC_CONFIG is written then some early notifications may be lost — see QUICK_SETUP

COMPAT

public static final NotificationSetupMode COMPAT

Compatibility mode for devices that do not contain CLIENT_CHARACTERISTIC_CONFIG

QUICK_SETUP

public static final NotificationSetupMode QUICK_SETUP

Configures notifications according to the standard but in contrast to the DEFAULT mode the `Observable` is emitted before the CLIENT_CHARACTERISTIC_CONFIG is written. The CLIENT_CHARACTERISTIC_CONFIG is scheduled for write when the emitted `Observable` is subscribed for the first time and any potential error connected with the descriptor write will be emitted on the parent Observable> as in DEFAULT case and `Observable` will complete. This mode may be useful for devices that start to notify right after CLIENT_CHARACTERISTIC_CONFIG write

Method Detail

values

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

Returns:

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

valueOf

public static NotificationSetupMode 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