com.idevicesinc.sweetblue

Class BondRetryFilter.RetryEvent

java.lang.Object

com.idevicesinc.sweetblue.utils.Event

com.idevicesinc.sweetblue.BondRetryFilter.RetryEvent

Enclosing interface:

BondRetryFilter

public static final class BondRetryFilter.RetryEvent
extends Event

Event class which holds an instance of the device that a bond has failed on, and the failure code.

Method Summary

Modifier and Type	Method and Description
BleDevice	device() Returns the BleDevice that failed to bond.
int	failCode() Returns the failure code the native stack returned as the reason that bonding failed.
boolean	isDirect() Returns whether this bond attempt was from a direct bond call, from calling BleDevice.bond(BondListener), or BleDevice.bond().
boolean	possibleRetry() This is a best guess on our part.
int	retryAttempts() Returns how many times SweetBlue has retried bonding on the device().
BondRetryFilter.Status	status() Returns the BondRetryFilter.Status of the bond attempt.
boolean	wasUserPrompted() Returns whether this bond request attempt prompted the user or not.

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, toString, wait, wait, wait

Method Detail

device

public final BleDevice device()

Returns the BleDevice that failed to bond.

status

public final BondRetryFilter.Status status()

Returns the BondRetryFilter.Status of the bond attempt. While BondRetryFilter.Status.SUCCESS exists, if the BondRetryFilter is invoked, it is implied that the attempt was not successful. This is just an enum containing the bond failure codes contained in BleStatuses to make the errors more readable.

failCode

public final int failCode()

Returns the failure code the native stack returned as the reason that bonding failed.

retryAttempts

public final int retryAttempts()

Returns how many times SweetBlue has retried bonding on the device().

isDirect

public final boolean isDirect()

Returns whether this bond attempt was from a direct bond call, from calling BleDevice.bond(BondListener), or BleDevice.bond().

wasUserPrompted

public final boolean wasUserPrompted()

Returns whether this bond request attempt prompted the user or not. NOTE: This only means the OS has "prompted" the user for bonding, in the case that the device requires a pin/password. This can either mean a notification was put into the drawer, OR the dialog was shown to the user. However, if you set BleDeviceConfig.forceBondDialog, then there's a very high chance that the dialog was shown.

possibleRetry

public final boolean possibleRetry()

This is a best guess on our part. Basically, this will return true if wasUserPrompted() returns false, or the BondRetryFilter.Status does not equal BondRetryFilter.Status.AUTH_FAILED, BondRetryFilter.Status.AUTH_REJECTED, BondRetryFilter.Status.REPEATED_ATTEMPTS, or BondRetryFilter.Status.SUCCESS (which should never happen here, but it's left just in case).