akasha.bluetooth

Class BluetoothRemoteGATTCharacteristic

java.lang.Object

akasha.EventTarget

akasha.bluetooth.BluetoothRemoteGATTCharacteristic

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="BluetoothRemoteGATTCharacteristic")
public class BluetoothRemoteGATTCharacteristic
extends EventTarget

The BluetoothRemoteGattCharacteristic interface of the Web Bluetooth API represents a GATT Characteristic, which is a basic data element that provides further information about a peripheral’s service.

See Also:

BluetoothRemoteGATTCharacteristic - MDN, BluetoothRemoteGATTCharacteristic - Web Bluetooth

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	oncharacteristicvaluechanged

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BluetoothRemoteGATTCharacteristic()

Method Summary

Modifier and Type	Method and Description
void	addCharacteristicvaluechangedListener(ValueEventListener callback)
void	addCharacteristicvaluechangedListener(ValueEventListener callback, AddEventListenerOptions options)
void	addCharacteristicvaluechangedListener(ValueEventListener callback, boolean useCapture)
Promise<BluetoothRemoteGATTDescriptor>	getDescriptor(BluetoothDescriptorUUID descriptor) The BluetoothRemoteGATTCharacteristic.getDescriptor() method returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.
Promise<BluetoothRemoteGATTDescriptor>	getDescriptor(int descriptor) The BluetoothRemoteGATTCharacteristic.getDescriptor() method returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.
Promise<BluetoothRemoteGATTDescriptor>	getDescriptor(java.lang.String descriptor) The BluetoothRemoteGATTCharacteristic.getDescriptor() method returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.
Promise<JsArray<BluetoothRemoteGATTDescriptor>>	getDescriptors() The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.
Promise<JsArray<BluetoothRemoteGATTDescriptor>>	getDescriptors(BluetoothDescriptorUUID descriptor) The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.
Promise<JsArray<BluetoothRemoteGATTDescriptor>>	getDescriptors(int descriptor) The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.
Promise<JsArray<BluetoothRemoteGATTDescriptor>>	getDescriptors(java.lang.String descriptor) The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.
BluetoothCharacteristicProperties	properties() The BluetoothRemoteGATTCharacteristic.properties read-only property returns a BluetoothCharacteristicProperties instance containing the properties of this characteristic.
Promise<DataView>	readValue() The BluetoothRemoteGATTCharacteristic.readValue() method returns a Promise that resolves to a DataView holding a duplicate of the value property if it is available and supported.
void	removeCharacteristicvaluechangedListener(ValueEventListener callback)
void	removeCharacteristicvaluechangedListener(ValueEventListener callback, boolean useCapture)
void	removeCharacteristicvaluechangedListener(ValueEventListener callback, EventListenerOptions options)
BluetoothRemoteGATTService	service() The BluetoothRemoteGATTCharacteristic.service read-only property returns the BluetoothGATTService this characteristic belongs to.
Promise<BluetoothRemoteGATTCharacteristic>	startNotifications() The BluetoothRemoteGATTCharacteristic.startNotifications() method returns a Promise to the BluetoothRemoteGATTCharacteristic instance when there is an active notification on it.
Promise<BluetoothRemoteGATTCharacteristic>	stopNotifications() The BluetoothRemoteGATTCharacteristic.stopNotifications() method returns a Promise to the BluetoothRemoteGATTCharacteristic instance when there is no longer an active notification on it.
java.lang.String	uuid() The BluetoothRemoteGATTCharacteristic.uuid read-only property returns DOMString containing the UUID of the characteristic, for example '00002a37-0000-1000-8000-00805f9b34fb' for the Heart Rate Measurement characteristic.
DataView	value() The BluetoothRemoteGATTCharacteristic.value read-only property returns currently cached characteristic value.
Promise<java.lang.Void>	writeValue(BufferSource value) The BluetoothRemoteGATTCharacteristic.writeValue() method sets the value property to the bytes contained in an ArrayBuffer and returns a Promise.
Promise<java.lang.Void>	writeValueWithoutResponse(BufferSource value)
Promise<java.lang.Void>	writeValueWithResponse(BufferSource value)

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class java.lang.Object

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

Field Detail

oncharacteristicvaluechanged

@Nullable
public EventHandler oncharacteristicvaluechanged

Constructor Detail

BluetoothRemoteGATTCharacteristic

protected BluetoothRemoteGATTCharacteristic()

Method Detail

properties

@JsProperty(name="properties")
 @Nonnull
public BluetoothCharacteristicProperties properties()

The BluetoothRemoteGATTCharacteristic.properties read-only property returns a BluetoothCharacteristicProperties instance containing the properties of this characteristic.

See Also:

BluetoothRemoteGATTCharacteristic.properties - MDN, properties - Web Bluetooth

service

@JsProperty(name="service")
 @Nonnull
public BluetoothRemoteGATTService service()

The BluetoothRemoteGATTCharacteristic.service read-only property returns the BluetoothGATTService this characteristic belongs to.

See Also:

BluetoothRemoteGATTCharacteristic.service - MDN, service - Web Bluetooth

uuid

@JsProperty(name="uuid")
 @Nonnull
public java.lang.String uuid()

The BluetoothRemoteGATTCharacteristic.uuid read-only property returns DOMString containing the UUID of the characteristic, for example '00002a37-0000-1000-8000-00805f9b34fb' for the Heart Rate Measurement characteristic.

See Also:

BluetoothRemoteGATTCharacteristic.uuid - MDN, uuid - Web Bluetooth

value

@JsProperty(name="value")
 @Nullable
public DataView value()

The BluetoothRemoteGATTCharacteristic.value read-only property returns currently cached characteristic value. This value gets updated when the value of the characteristic is read or updated via a notification or indication.

See Also:

BluetoothRemoteGATTCharacteristic.value - MDN, value - Web Bluetooth

getDescriptor

@Nonnull
public Promise<BluetoothRemoteGATTDescriptor> getDescriptor(@Nonnull
                                                                     BluetoothDescriptorUUID descriptor)

The BluetoothRemoteGATTCharacteristic.getDescriptor() method returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptor - MDN, getDescriptor() - Web Bluetooth

getDescriptor

@Nonnull
public Promise<BluetoothRemoteGATTDescriptor> getDescriptor(@Nonnull
                                                                     java.lang.String descriptor)

The BluetoothRemoteGATTCharacteristic.getDescriptor() method returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptor - MDN, getDescriptor() - Web Bluetooth

getDescriptor

@Nonnull
public Promise<BluetoothRemoteGATTDescriptor> getDescriptor(int descriptor)

The BluetoothRemoteGATTCharacteristic.getDescriptor() method returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptor - MDN, getDescriptor() - Web Bluetooth

getDescriptors

@Nonnull
public Promise<JsArray<BluetoothRemoteGATTDescriptor>> getDescriptors(@Nonnull
                                                                               BluetoothDescriptorUUID descriptor)

The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptors - MDN, getDescriptors() - Web Bluetooth

getDescriptors

@Nonnull
public Promise<JsArray<BluetoothRemoteGATTDescriptor>> getDescriptors(@Nonnull
                                                                               java.lang.String descriptor)

The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptors - MDN, getDescriptors() - Web Bluetooth

getDescriptors

@Nonnull
public Promise<JsArray<BluetoothRemoteGATTDescriptor>> getDescriptors(int descriptor)

The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptors - MDN, getDescriptors() - Web Bluetooth

getDescriptors

@Nonnull
public Promise<JsArray<BluetoothRemoteGATTDescriptor>> getDescriptors()

The BluetoothRemoteGATTCharacteristic.getDescriptors() method returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.

See Also:

BluetoothRemoteGATTCharacteristic.getDescriptors - MDN, getDescriptors() - Web Bluetooth

readValue

@Nonnull
public Promise<DataView> readValue()

The BluetoothRemoteGATTCharacteristic.readValue() method returns a Promise that resolves to a DataView holding a duplicate of the value property if it is available and supported. Otherwise it throws an error.

See Also:

BluetoothRemoteGATTCharacteristic.readValue - MDN, readValue() - Web Bluetooth

startNotifications

@Nonnull
public Promise<BluetoothRemoteGATTCharacteristic> startNotifications()

The BluetoothRemoteGATTCharacteristic.startNotifications() method returns a Promise to the BluetoothRemoteGATTCharacteristic instance when there is an active notification on it.

See Also:

BluetoothRemoteGATTCharacteristic.startNotifications - MDN, startNotifications() - Web Bluetooth

stopNotifications

@Nonnull
public Promise<BluetoothRemoteGATTCharacteristic> stopNotifications()

The BluetoothRemoteGATTCharacteristic.stopNotifications() method returns a Promise to the BluetoothRemoteGATTCharacteristic instance when there is no longer an active notification on it.

See Also:

BluetoothRemoteGATTCharacteristic.stopNotifications - MDN, stopNotifications() - Web Bluetooth

writeValue

@Nonnull
public Promise<java.lang.Void> writeValue(@Nonnull
                                                   BufferSource value)

The BluetoothRemoteGATTCharacteristic.writeValue() method sets the value property to the bytes contained in an ArrayBuffer and returns a Promise.

See Also:

BluetoothRemoteGATTCharacteristic.writeValue - MDN, writeValue() - Web Bluetooth

writeValueWithResponse

@Nonnull
public Promise<java.lang.Void> writeValueWithResponse(@Nonnull
                                                               BufferSource value)

writeValueWithoutResponse

@Nonnull
public Promise<java.lang.Void> writeValueWithoutResponse(@Nonnull
                                                                  BufferSource value)

addCharacteristicvaluechangedListener

@JsOverlay
public final void addCharacteristicvaluechangedListener(@Nonnull
                                                                   ValueEventListener callback,
                                                                   @Nonnull
                                                                   AddEventListenerOptions options)

addCharacteristicvaluechangedListener

@JsOverlay
public final void addCharacteristicvaluechangedListener(@Nonnull
                                                                   ValueEventListener callback,
                                                                   boolean useCapture)

addCharacteristicvaluechangedListener

@JsOverlay
public final void addCharacteristicvaluechangedListener(@Nonnull
                                                                   ValueEventListener callback)

removeCharacteristicvaluechangedListener

@JsOverlay
public final void removeCharacteristicvaluechangedListener(@Nonnull
                                                                      ValueEventListener callback,
                                                                      @Nonnull
                                                                      EventListenerOptions options)

removeCharacteristicvaluechangedListener

@JsOverlay
public final void removeCharacteristicvaluechangedListener(@Nonnull
                                                                      ValueEventListener callback,
                                                                      boolean useCapture)

removeCharacteristicvaluechangedListener

@JsOverlay
public final void removeCharacteristicvaluechangedListener(@Nonnull
                                                                      ValueEventListener callback)