DeviceReconnectFilter.Status

java.lang.Object
- java.lang.Enum<DeviceReconnectFilter.Status>
- - com.idevicesinc.sweetblue.DeviceReconnectFilter.Status

All Implemented Interfaces:

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

Enclosing interface:

DeviceReconnectFilter
```
public static enum DeviceReconnectFilter.Status
extends java.lang.Enum<DeviceReconnectFilter.Status>
implements UsesCustomNull
```
The reason for the connection failure.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALREADY_CONNECTING_OR_CONNECTED` A call was made to `BleDevice.connect()` or its overloads but `DeviceReconnectFilter.ConnectFailEvent.device()` is already `BleDeviceState.BLE_CONNECTING` or `BleDeviceState.BLE_CONNECTED`.
`AUTHENTICATION_FAILED` The `BleTransaction` instance passed to `BleDevice.connect(BleTransaction.Auth)` or `BleDevice.connect(BleTransaction.Auth, BleTransaction.Init)` failed through `BleTransaction.fail()`.
`BLE_TURNING_OFF` `BleManager.reset()` or `BleManager.turnOff()` (or overloads) were called sometime during the connection process.
`BONDING_FAILED` `BluetoothDevice.createBond()` either (a) `DeviceReconnectFilter.Timing.IMMEDIATELY` returned `false`, (b) `DeviceReconnectFilter.Timing.EVENTUALLY` returned a bad `DeviceReconnectFilter.ConnectFailEvent.bondFailReason()`, or (c) `DeviceReconnectFilter.Timing.TIMED_OUT`.
`DISCOVERING_SERVICES_FAILED` `BluetoothGatt.discoverServices()` either (a) `DeviceReconnectFilter.Timing.IMMEDIATELY` returned `false`, (b) `DeviceReconnectFilter.Timing.EVENTUALLY` returned a bad `ReconnectFilter.ConnectFailEvent.gattStatus()`, or (c) `DeviceReconnectFilter.Timing.TIMED_OUT`.
`EXPLICIT_DISCONNECT` `BleDevice.disconnect()` was called sometime during the connection process.
`IMPLICIT_DISCONNECT` This status can get set if an implicit disconnect happened -- for example, `BleDevice.unbond()` was called while the device was connected, or the MTU write test failed.
`INITIALIZATION_FAILED` `BleTransaction` instance passed to `BleDevice.connect(BleTransaction.Init)` or `BleDevice.connect(BleTransaction.Auth, BleTransaction.Init)` failed through `BleTransaction.fail()`.
`NATIVE_CONNECTION_FAILED` Couldn't connect through `BluetoothDevice.connectGatt(android.content.Context, boolean, BluetoothGattCallback)` because it (a) `DeviceReconnectFilter.Timing.IMMEDIATELY` returned `null`, (b) `DeviceReconnectFilter.Timing.EVENTUALLY` returned a bad `ReconnectFilter.ConnectFailEvent.gattStatus()`, or (c) `DeviceReconnectFilter.Timing.TIMED_OUT`.
`NULL` Used in place of Java's built-in `null` wherever needed.
`NULL_DEVICE` `BleDevice.connect()` (or various overloads) was called on `BleDevice.NULL`.
`ROGUE_DISCONNECT` Remote peripheral randomly disconnected sometime during the connection process.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowsRetry()` Whether this status honors a `ReconnectFilter.ConnectFailPlease.isRetry()`.
`boolean`	`isNull()` Returns `true` if the object's state represents what would otherwise be Java's built-in `null`.
`boolean`	`shouldBeReportedToUser()` Convenience method that returns whether this status is something that your app user would usually care about.
`static DeviceReconnectFilter.Status`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DeviceReconnectFilter.Status[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`boolean`	`wasCancelled()` Returns true for `EXPLICIT_DISCONNECT` or `BLE_TURNING_OFF`.

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 DeviceReconnectFilter.Status NULL
```
    Used in place of Java's built-in null wherever needed. As of now, the DeviceReconnectFilter.ConnectFailEvent.status() given to ReconnectFilter.onConnectFailed(ReconnectFilter.ConnectFailEvent) will *never* be NULL.
  - ALREADY_CONNECTING_OR_CONNECTED
```
public static final DeviceReconnectFilter.Status ALREADY_CONNECTING_OR_CONNECTED
```
    A call was made to BleDevice.connect() or its overloads but DeviceReconnectFilter.ConnectFailEvent.device() is already BleDeviceState.BLE_CONNECTING or BleDeviceState.BLE_CONNECTED.
  - NULL_DEVICE
```
public static final DeviceReconnectFilter.Status NULL_DEVICE
```
    BleDevice.connect() (or various overloads) was called on BleDevice.NULL.
  - NATIVE_CONNECTION_FAILED
```
public static final DeviceReconnectFilter.Status NATIVE_CONNECTION_FAILED
```
    Couldn't connect through BluetoothDevice.connectGatt(android.content.Context, boolean, BluetoothGattCallback) because it (a) DeviceReconnectFilter.Timing.IMMEDIATELY returned null, (b) DeviceReconnectFilter.Timing.EVENTUALLY returned a bad ReconnectFilter.ConnectFailEvent.gattStatus(), or (c) DeviceReconnectFilter.Timing.TIMED_OUT.
  - DISCOVERING_SERVICES_FAILED
```
public static final DeviceReconnectFilter.Status DISCOVERING_SERVICES_FAILED
```
    BluetoothGatt.discoverServices() either (a) DeviceReconnectFilter.Timing.IMMEDIATELY returned false, (b) DeviceReconnectFilter.Timing.EVENTUALLY returned a bad ReconnectFilter.ConnectFailEvent.gattStatus(), or (c) DeviceReconnectFilter.Timing.TIMED_OUT.
  - BONDING_FAILED
```
public static final DeviceReconnectFilter.Status BONDING_FAILED
```
    BluetoothDevice.createBond() either (a) DeviceReconnectFilter.Timing.IMMEDIATELY returned false, (b) DeviceReconnectFilter.Timing.EVENTUALLY returned a bad DeviceReconnectFilter.ConnectFailEvent.bondFailReason(), or (c) DeviceReconnectFilter.Timing.TIMED_OUT.
    
    NOTE: BleDeviceConfig.bondingFailFailsConnection must be true for this DeviceReconnectFilter.Status to be applicable.
    
    See Also:
    
    BondListener
  - AUTHENTICATION_FAILED
```
public static final DeviceReconnectFilter.Status AUTHENTICATION_FAILED
```
    The BleTransaction instance passed to BleDevice.connect(BleTransaction.Auth) or BleDevice.connect(BleTransaction.Auth, BleTransaction.Init) failed through BleTransaction.fail().
  - INITIALIZATION_FAILED
```
public static final DeviceReconnectFilter.Status INITIALIZATION_FAILED
```
    BleTransaction instance passed to BleDevice.connect(BleTransaction.Init) or BleDevice.connect(BleTransaction.Auth, BleTransaction.Init) failed through BleTransaction.fail().
  - ROGUE_DISCONNECT
```
public static final DeviceReconnectFilter.Status ROGUE_DISCONNECT
```
    Remote peripheral randomly disconnected sometime during the connection process. Similar to NATIVE_CONNECTION_FAILED but only occurs after the device is BleDeviceState.BLE_CONNECTED and we're going through BleDeviceState.DISCOVERING_SERVICES, or BleDeviceState.AUTHENTICATING, or what have you. It might be from the device turning off, or going out of range, or any other random reason.
  - IMPLICIT_DISCONNECT
```
public static final DeviceReconnectFilter.Status IMPLICIT_DISCONNECT
```
    This status can get set if an implicit disconnect happened -- for example, BleDevice.unbond() was called while the device was connected, or the MTU write test failed.
  - EXPLICIT_DISCONNECT
```
public static final DeviceReconnectFilter.Status EXPLICIT_DISCONNECT
```
    BleDevice.disconnect() was called sometime during the connection process.
  - BLE_TURNING_OFF
```
public static final DeviceReconnectFilter.Status BLE_TURNING_OFF
```
    BleManager.reset() or BleManager.turnOff() (or overloads) were called sometime during the connection process. Basic testing reveals that this value will also be used when a user turns off BLE by going through their OS settings, airplane mode, etc., but it's not absolutely *certain* that this behavior is consistent across phones. For example there might be a phone that kills all connections before going through the ble turn-off process, in which case SweetBlue doesn't know the difference and ROGUE_DISCONNECT will be used.
- Method Detail
  - values
```
public static DeviceReconnectFilter.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 (DeviceReconnectFilter.Status c : DeviceReconnectFilter.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 DeviceReconnectFilter.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
  - wasCancelled
```
public final boolean wasCancelled()
```
    Returns true for EXPLICIT_DISCONNECT or BLE_TURNING_OFF.
  - allowsRetry
```
public final boolean allowsRetry()
```
    Whether this status honors a ReconnectFilter.ConnectFailPlease.isRetry(). Returns false if wasCancelled() or this is ALREADY_CONNECTING_OR_CONNECTED.
  - isNull
```
public final 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
  - shouldBeReportedToUser
```
public final boolean shouldBeReportedToUser()
```
    Convenience method that returns whether this status is something that your app user would usually care about. If this returns true then perhaps you should pop up a Toast or something of that nature.

Enum DeviceReconnectFilter.Status

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NULL

ALREADY_CONNECTING_OR_CONNECTED

NULL_DEVICE

NATIVE_CONNECTION_FAILED

DISCOVERING_SERVICES_FAILED

BONDING_FAILED

AUTHENTICATION_FAILED

INITIALIZATION_FAILED

ROGUE_DISCONNECT

IMPLICIT_DISCONNECT

EXPLICIT_DISCONNECT

BLE_TURNING_OFF

Method Detail

values

valueOf

wasCancelled

allowsRetry

isNull

shouldBeReportedToUser