com.idevicesinc.sweetblue

Class BleNotify

java.lang.Object

com.idevicesinc.sweetblue.BleOp<T>

com.idevicesinc.sweetblue.BleDescriptorOp<BleNotify>

com.idevicesinc.sweetblue.BleNotify

public class BleNotify
extends BleDescriptorOp<BleNotify>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BleNotify.Builder Builder class to build out a list (or array) of BleNotify instances.

Constructor Summary

Constructors

Constructor and Description
BleNotify()
BleNotify(BleNotify notify) Constructor which creates a new BleNotify from the one given.
BleNotify(java.util.UUID characteristicUuid)
BleNotify(java.util.UUID serviceUuid, java.util.UUID characteristicUuid)

Method Summary

Modifier and Type	Method and Description
Interval	getForceReadTimeout() Get the forced read timeout set in this BleNotify.
NotificationListener	getNotificationListener() Get the NotificationListener set in this instance of BleNotify.
boolean	isValid() Returns true if the minimum values have been set for this operation
BleNotify	setForceReadTimeout(Interval timeout) This allows you to set a forced read, simulating a notification.
BleNotify	setNotificationListener(NotificationListener listener) Set a NotificationListener for this BleNotify.

Methods inherited from class com.idevicesinc.sweetblue.BleDescriptorOp

setDescriptorUUID

Methods inherited from class com.idevicesinc.sweetblue.BleOp

getCharacteristicUuid, getData, getDescriptorFilter, getDescriptorUuid, getReadWriteListener, getServiceUuid, isCharUuidValid, isNotify, isRead, isServiceUuidValid, isWrite, setCharacteristicUUID, setData, setDescriptorFilter, setReadWriteListener, setServiceUUID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BleNotify

public BleNotify()

BleNotify

public BleNotify(java.util.UUID serviceUuid,
                 java.util.UUID characteristicUuid)

BleNotify

public BleNotify(java.util.UUID characteristicUuid)

BleNotify

public BleNotify(BleNotify notify)

Constructor which creates a new BleNotify from the one given. Note that this only copies over the service, and characteristic UUIDs, and the forceReadTimeout value. No interfaces or filters are copied over.

Method Detail

isValid

public final boolean isValid()

Description copied from class: BleOp

Returns true if the minimum values have been set for this operation

Overrides:

isValid in class BleDescriptorOp<BleNotify>

setForceReadTimeout

public final BleNotify setForceReadTimeout(Interval timeout)

This allows you to set a forced read, simulating a notification. This can be useful if you want data back from a characteristic on a consistent schedule. If the interval given here is passed before another notification is received, a read will be performed.

getForceReadTimeout

public final Interval getForceReadTimeout()

Get the forced read timeout set in this BleNotify.

setNotificationListener

public final BleNotify setNotificationListener(NotificationListener listener)

Set a NotificationListener for this BleNotify. This listener will only be called when toggling notifications/indications on/off. Use BleDevice.setListener_Notification(NotificationListener) to listen for incoming notifications.

getNotificationListener

public final NotificationListener getNotificationListener()

Get the NotificationListener set in this instance of BleNotify.