com.idevicesinc.sweetblue

Enum NotificationListener.Status

java.lang.Object

java.lang.Enum<NotificationListener.Status>

com.idevicesinc.sweetblue.NotificationListener.Status

All Implemented Interfaces:

UsesCustomNull, java.io.Serializable, java.lang.Comparable<NotificationListener.Status>

Enclosing interface:

NotificationListener

public static enum NotificationListener.Status
extends java.lang.Enum<NotificationListener.Status>
implements UsesCustomNull

A value returned to GenericListener_Void.onEvent(Event) by way of NotificationListener.NotificationEvent.status() that indicates success of the operation or the reason for its failure. This enum is not meant to match up with BluetoothGatt.GATT_* values in any way.

See Also:

NotificationListener.NotificationEvent.status()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANDROID_VERSION_NOT_SUPPORTED The android api level doesn't support the lower level API call in the native stack.
CANCELLED_FROM_BLE_TURNING_OFF The operation was cancelled because BleManager went BleManagerState.TURNING_OFF and/or BleManagerState.OFF.
CANCELLED_FROM_DISCONNECT The operation was cancelled by the device becoming BleDeviceState.BLE_DISCONNECTED.
EMPTY_DATA Used either when ReadWriteListener.ReadWriteEvent.type() ReadWriteListener.Type.isRead() and the operation was "successful" but returned a zero-length array for ReadWriteListener.ReadWriteEvent.data(), or BleDevice.write(UUID, byte[]) (or overload(s) ) was called with a non-null but zero-length data parameter.
FAILED_TO_TOGGLE_NOTIFICATION BluetoothGatt.setCharacteristicNotification(BluetoothGattCharacteristic, boolean) returned false for an unknown reason.
INVALID_DATA For now only used when giving a negative or zero value to BleDevice.negotiateMtu(int, ReadWriteListener).
NO_MATCHING_TARGET Couldn't find a matching ReadWriteListener.ReadWriteEvent.target() for the ReadWriteListener.ReadWriteEvent.charUuid() (or ReadWriteListener.ReadWriteEvent.descUuid() if ReadWriteListener.ReadWriteEvent.target() is ReadWriteListener.Target.DESCRIPTOR) which was given to BleDevice.read(UUID, ReadWriteListener), BleDevice.write(UUID, byte[]), etc.
NOT_CONNECTED Device is not BleDeviceState.BLE_CONNECTED.
NULL As of now, not used.
NULL_DATA Used either when ReadWriteListener.ReadWriteEvent.type() ReadWriteListener.Type.isRead() and the stack returned a null value for BluetoothGattCharacteristic.getValue() despite the operation being otherwise "successful", or BleDevice.write(UUID, byte[]) (or overload(s) ) were called with a null data parameter.
NULL_DEVICE BleDevice.read(UUID, ReadWriteListener), BleDevice.write(UUID, byte[]), BleDevice.enableNotify(UUID, ReadWriteListener), etc.
OPERATION_NOT_SUPPORTED You tried to do a read on a characteristic that is write-only, or vice-versa, or tried to read a notify-only characteristic, or etc., etc.
REMOTE_GATT_FAILURE The operation failed in a "normal" fashion, at least relative to all the other strange ways an operation can fail.
SUCCESS This is used to indicate that toggling a notification/indication was successful.
UNKNOWN_ERROR This is a generic error state which means something went wrong, and we're not sure why.

Method Summary

Modifier and Type	Method and Description
static NotificationListener.Status	fromReadWriteStatus(ReadWriteListener.Status status)
boolean	isNull() Returns true if the object's state represents what would otherwise be Java's built-in null.
static NotificationListener.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NotificationListener.Status[]	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

NULL

public static final NotificationListener.Status NULL

As of now, not used.

SUCCESS

public static final NotificationListener.Status SUCCESS

This is used to indicate that toggling a notification/indication was successful.

NULL_DEVICE

public static final NotificationListener.Status NULL_DEVICE

BleDevice.read(UUID, ReadWriteListener), BleDevice.write(UUID, byte[]), BleDevice.enableNotify(UUID, ReadWriteListener), etc. was called on BleDevice.NULL.

NOT_CONNECTED

public static final NotificationListener.Status NOT_CONNECTED

Device is not BleDeviceState.BLE_CONNECTED.

NO_MATCHING_TARGET

public static final NotificationListener.Status NO_MATCHING_TARGET

Couldn't find a matching ReadWriteListener.ReadWriteEvent.target() for the ReadWriteListener.ReadWriteEvent.charUuid() (or ReadWriteListener.ReadWriteEvent.descUuid() if ReadWriteListener.ReadWriteEvent.target() is ReadWriteListener.Target.DESCRIPTOR) which was given to BleDevice.read(UUID, ReadWriteListener), BleDevice.write(UUID, byte[]), etc. This most likely means that the internal call to BluetoothGatt.discoverServices() didn't find any BluetoothGattService that contained a BluetoothGattCharacteristic for ReadWriteListener.ReadWriteEvent.charUuid(). This can also happen if the internal call to get a BluetoothService(s) causes an exception (seen on some phones).

OPERATION_NOT_SUPPORTED

public static final NotificationListener.Status OPERATION_NOT_SUPPORTED

You tried to do a read on a characteristic that is write-only, or vice-versa, or tried to read a notify-only characteristic, or etc., etc.

ANDROID_VERSION_NOT_SUPPORTED

public static final NotificationListener.Status ANDROID_VERSION_NOT_SUPPORTED

The android api level doesn't support the lower level API call in the native stack. For example if you try to use BleDevice.negotiateMtu(int, ReadWriteListener), which requires API level 21, and you are at level 18.

CANCELLED_FROM_DISCONNECT

public static final NotificationListener.Status CANCELLED_FROM_DISCONNECT

The operation was cancelled by the device becoming BleDeviceState.BLE_DISCONNECTED.

CANCELLED_FROM_BLE_TURNING_OFF

public static final NotificationListener.Status CANCELLED_FROM_BLE_TURNING_OFF

The operation was cancelled because BleManager went BleManagerState.TURNING_OFF and/or BleManagerState.OFF. Note that if the user turns off BLE from their OS settings (airplane mode, etc.) then ReadWriteListener.ReadWriteEvent.status() could potentially be CANCELLED_FROM_DISCONNECT because SweetBlue might get the disconnect callback before the turning off callback. Basic testing has revealed that this is *not* the case, but you never know.

Either way, the device was or will be disconnected.

NULL_DATA

public static final NotificationListener.Status NULL_DATA

Used either when ReadWriteListener.ReadWriteEvent.type() ReadWriteListener.Type.isRead() and the stack returned a null value for BluetoothGattCharacteristic.getValue() despite the operation being otherwise "successful", or BleDevice.write(UUID, byte[]) (or overload(s) ) were called with a null data parameter. For the read case, the library will throw an UhOhListener.UhOh.READ_RETURNED_NULL, but hopefully it was just a temporary glitch. If the problem persists try BleManager.reset().

EMPTY_DATA

public static final NotificationListener.Status EMPTY_DATA

Used either when ReadWriteListener.ReadWriteEvent.type() ReadWriteListener.Type.isRead() and the operation was "successful" but returned a zero-length array for ReadWriteListener.ReadWriteEvent.data(), or BleDevice.write(UUID, byte[]) (or overload(s) ) was called with a non-null but zero-length data parameter. Note that ReadWriteListener.ReadWriteEvent.data() will be a zero-length array for all other error statuses as well, for example NO_MATCHING_TARGET, NOT_CONNECTED, etc. In other words it's never null.

INVALID_DATA

public static final NotificationListener.Status INVALID_DATA

For now only used when giving a negative or zero value to BleDevice.negotiateMtu(int, ReadWriteListener).

FAILED_TO_TOGGLE_NOTIFICATION

public static final NotificationListener.Status FAILED_TO_TOGGLE_NOTIFICATION

BluetoothGatt.setCharacteristicNotification(BluetoothGattCharacteristic, boolean) returned false for an unknown reason.

REMOTE_GATT_FAILURE

public static final NotificationListener.Status REMOTE_GATT_FAILURE

The operation failed in a "normal" fashion, at least relative to all the other strange ways an operation can fail. This means for example that BluetoothGattCallback.onCharacteristicRead(BluetoothGatt, BluetoothGattCharacteristic, int) returned a status code that was not zero. This could mean the device went out of range, was turned off, signal was disrupted, whatever. Often this means that the device is about to become BleDeviceState.BLE_DISCONNECTED. ReadWriteListener.ReadWriteEvent.gattStatus() will most likely be non-zero, and you can check against the static fields in BleStatuses for more information.

See Also:

ReadWriteListener.ReadWriteEvent.gattStatus()

UNKNOWN_ERROR

public static final NotificationListener.Status UNKNOWN_ERROR

This is a generic error state which means something went wrong, and we're not sure why. In theory, this should never be the status of a Notification/Indication. If you DO see this status, please let us know at SweetBlue@idevicesinc.com know how you produce it.

Method Detail

values

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

Returns:

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

valueOf

public static NotificationListener.Status 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

isNull

public boolean isNull()

Description copied from interface: UsesCustomNull

Returns true if the object's state represents what would otherwise be Java's built-in null.

Specified by:

isNull in interface UsesCustomNull

fromReadWriteStatus

public static NotificationListener.Status fromReadWriteStatus(ReadWriteListener.Status status)