com.idevicesinc.sweetblue

Class BondListener.BondEvent

java.lang.Object

com.idevicesinc.sweetblue.utils.Event

com.idevicesinc.sweetblue.BondListener.BondEvent

All Implemented Interfaces:

UsesCustomNull

Enclosing interface:

BondListener

public static class BondListener.BondEvent
extends Event
implements UsesCustomNull

Struct passed to BondListener.onEvent(BondEvent) to provide more information about a BleDevice.bond() attempt.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BondListener.BondEvent.Type

Method Summary

Modifier and Type	Method and Description
BleDevice	device() The BleDevice that attempted to BleDevice.bond().
int	failReason() If status() is 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.
java.lang.String	macAddress() Convience to return the mac address of device().
BondListener.Status	status() The BondListener.Status associated with this event.
java.lang.String	toString()
BondListener.BondEvent.Type	type() Used to indicate whether this BondListener.BondEvent is for bonding, or unbonding.
boolean	wasCancelled() Forwards BondListener.Status.wasCancelled().
boolean	wasSuccess() Shortcut for checking if status() == 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 final BleDevice device()

The BleDevice that attempted to BleDevice.bond().

macAddress

public final java.lang.String macAddress()

Convience to return the mac address of device().

status

public final BondListener.Status status()

The BondListener.Status associated with this event.

failReason

public final int failReason()

If status() is 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.

type

public final BondListener.BondEvent.Type type()

Used to indicate whether this BondListener.BondEvent is for bonding, or unbonding.

intent

public final 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 final boolean wasSuccess()

Shortcut for checking if status() == BondListener.Status.SUCCESS.

wasCancelled

public final boolean wasCancelled()

Forwards BondListener.Status.wasCancelled().

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

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