BleDevice.BondListener.BondEvent (SweetBlue)

java.lang.Object
- com.idevicesinc.sweetblue.utils.Event
- - com.idevicesinc.sweetblue.BleDevice.BondListener.BondEvent

All Implemented Interfaces:

UsesCustomNull

Enclosing interface:

BleDevice.BondListener
```
public static class BleDevice.BondListener.BondEvent
extends Event
implements UsesCustomNull
```
Struct passed to BleDevice.BondListener.onEvent(BondEvent) to provide more information about a BleDevice.bond() attempt.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BleDevice`	`device()` The `BleDevice` that attempted to `BleDevice.bond()`.
`int`	`failReason()` If `status()` is `BleDevice.BondListener.Status.FAILED_EVENTUALLY`, this integer will be one of the values enumerated in `BluetoothDevice` that start with `UNBOND_REASON` such as `BleStatuses.UNBOND_REASON_AUTH_FAILED`.
`State.ChangeIntent`	`intent()` Tells whether the bond was created through an explicit call through SweetBlue, or otherwise.
`boolean`	`isNull()` Returns `true` if the object's state represents what would otherwise be Java's built-in `null`.
`String`	`macAddress()` Convience to return the mac address of `device()`.
`BleDevice.BondListener.Status`	`status()` The `BleDevice.ConnectionFailListener.Status` associated with this event.
`String`	`toString()`
`boolean`	`wasCancelled()` Forwards `BleDevice.ConnectionFailListener.Status.wasCancelled()`.
`boolean`	`wasSuccess()` Shortcut for checking if `status()` == `BleDevice.BondListener.Status.SUCCESS`.

Methods inherited from class com.idevicesinc.sweetblue.utils.Event
isFor, isForAll, isForAny

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - device
```
public BleDevice device()
```
    The BleDevice that attempted to BleDevice.bond().
  - macAddress
```
public String macAddress()
```
    Convience to return the mac address of device().
  - status
```
public BleDevice.BondListener.Status status()
```
    The BleDevice.ConnectionFailListener.Status associated with this event.
  - failReason
```
public int failReason()
```
    If status() is BleDevice.BondListener.Status.FAILED_EVENTUALLY, this integer will be one of the values enumerated in BluetoothDevice that start with UNBOND_REASON such as BleStatuses.UNBOND_REASON_AUTH_FAILED. Otherwise it will be equal to BleStatuses.BOND_FAIL_REASON_NOT_APPLICABLE. See also a publically accessible list in BleStatuses.
  - intent
```
public State.ChangeIntent intent()
```
    Tells whether the bond was created through an explicit call through SweetBlue, or otherwise. If State.ChangeIntent.INTENTIONAL, then BleDevice.bond() (or overloads) were called. If State.ChangeIntent.UNINTENTIONAL, then the bond was created "spontaneously" as far as SweetBlue is concerned, whether through another app, the OS Bluetooth settings, or maybe from a request by the remote BLE device itself.
  - wasSuccess
```
public boolean wasSuccess()
```
    Shortcut for checking if status() == BleDevice.BondListener.Status.SUCCESS.
  - wasCancelled
```
public boolean wasCancelled()
```
    Forwards BleDevice.ConnectionFailListener.Status.wasCancelled().
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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

Class BleDevice.BondListener.BondEvent

Method Summary

Methods inherited from class com.idevicesinc.sweetblue.utils.Event

Methods inherited from class java.lang.Object

Method Detail

device

macAddress

status

failReason

intent

wasSuccess

wasCancelled

toString

isNull