Class BluetoothRemoteGATTCharacteristicImpl

Bluetooth Remote GATT Characteristic class

Hierarchy

EventDispatcher<CharacteristicEvents>
- BluetoothRemoteGATTCharacteristicImpl

Implements

BluetoothRemoteGATTCharacteristic

Index

Constructors

constructor

new BluetoothRemoteGATTCharacteristicImpl(
init: Partial<BluetoothRemoteGATTCharacteristicImpl>,
): BluetoothRemoteGATTCharacteristicImpl
Characteristic constructor
Parameters
- init: Partial<BluetoothRemoteGATTCharacteristicImpl>
  A partial class to initialise values
Returns BluetoothRemoteGATTCharacteristicImpl
Overrides EventDispatcher<CharacteristicEvents>.constructor
- Defined in src/characteristic.ts:94

Properties

`Protected`emitter

emitter: EventEmitter<DefaultEventMap> = ...

`Readonly`properties

properties: BluetoothCharacteristicProperties

The properties of the characteristic

`Readonly`service

service: BluetoothRemoteGATTServiceImpl = undefined

The service the characteristic is related to

`Readonly`uuid

uuid: string = undefined

The unique identifier of the characteristic

Accessors

oncharacteristicvaluechanged

set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothRemoteGATTCharacteristic.oncharacteristicvaluechanged
- Defined in src/characteristic.ts:79

value

get value(): DataView
The value of the characteristic

Returns DataView
Implementation of BluetoothRemoteGATTCharacteristic.value
- Defined in src/characteristic.ts:68

Methods

addEventListener

addEventListener<K extends "characteristicvaluechanged">(
type: K,
listener: (this: this, ev: CharacteristicEvents[K]) => void,
): void
Type Parameters
- K extends "characteristicvaluechanged"
Parameters
- type: K
- listener: (this: this, ev: CharacteristicEvents[K]) => void
Returns void
Implementation of BluetoothRemoteGATTCharacteristic.addEventListener
Inherited from EventDispatcher.addEventListener
- Defined in src/events.ts:37
addEventListener<K extends "characteristicvaluechanged">(
type: K,
listener: EventListener,
): void
Type Parameters
- K extends "characteristicvaluechanged"
Parameters
- type: K
- listener: EventListener
Returns void
Implementation of BluetoothRemoteGATTCharacteristic.addEventListener
Inherited from EventDispatcher.addEventListener
- Defined in src/events.ts:38

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Implementation of BluetoothRemoteGATTCharacteristic.dispatchEvent
Inherited from EventDispatcher.dispatchEvent
- Defined in src/events.ts:55

getDescriptor

getDescriptor(
descriptor: string | number,
): Promise<BluetoothRemoteGATTDescriptor>
Gets a single characteristic descriptor
Parameters
- descriptor: string | number
  descriptor UUID
Returns Promise<BluetoothRemoteGATTDescriptor>
Promise containing the descriptor
Implementation of BluetoothRemoteGATTCharacteristic.getDescriptor
- Defined in src/characteristic.ts:119

getDescriptors

getDescriptors(
descriptor?: string | number,
): Promise<BluetoothRemoteGATTDescriptor[]>
Gets a list of the characteristic's descriptors
Parameters
- Optionaldescriptor: string | number
  descriptor UUID
Returns Promise<BluetoothRemoteGATTDescriptor[]>
Promise containing an array of descriptors
Implementation of BluetoothRemoteGATTCharacteristic.getDescriptors
- Defined in src/characteristic.ts:141

readValue

readValue(): Promise<DataView<ArrayBufferLike>>
Gets the value of the characteristic

Returns Promise<DataView<ArrayBufferLike>>
Promise containing the value
Implementation of BluetoothRemoteGATTCharacteristic.readValue
- Defined in src/characteristic.ts:172

removeEventListener

removeEventListener<K extends "characteristicvaluechanged">(
type: K,
callback: (this: this, ev: CharacteristicEvents[K]) => void,
): void
Type Parameters
- K extends "characteristicvaluechanged"
Parameters
- type: K
- callback: (this: this, ev: CharacteristicEvents[K]) => void
Returns void
Implementation of BluetoothRemoteGATTCharacteristic.removeEventListener
Inherited from EventDispatcher.removeEventListener
- Defined in src/events.ts:46
removeEventListener<K extends "characteristicvaluechanged">(
type: K,
callback: EventListener,
): void
Type Parameters
- K extends "characteristicvaluechanged"
Parameters
- type: K
- callback: EventListener
Returns void
Implementation of BluetoothRemoteGATTCharacteristic.removeEventListener
Inherited from EventDispatcher.removeEventListener
- Defined in src/events.ts:47

startNotifications

startNotifications(): Promise<BluetoothRemoteGATTCharacteristic>
Start notifications of changes for the characteristic

Returns Promise<BluetoothRemoteGATTCharacteristic>
Promise containing the characteristic
Implementation of BluetoothRemoteGATTCharacteristic.startNotifications
- Defined in src/characteristic.ts:234

stopNotifications

stopNotifications(): Promise<BluetoothRemoteGATTCharacteristic>
Stop notifications of changes for the characteristic

Returns Promise<BluetoothRemoteGATTCharacteristic>
Promise containing the characteristic
Implementation of BluetoothRemoteGATTCharacteristic.stopNotifications
- Defined in src/characteristic.ts:250

writeValue

writeValue(value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>): Promise<void>
Updates the value of the characteristic
Parameters
- value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The value to write
Returns Promise<void>
Implementation of BluetoothRemoteGATTCharacteristic.writeValue
- Defined in src/characteristic.ts:186

writeValueWithoutResponse

writeValueWithoutResponse(
value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<void>
Updates the value of the characteristic without waiting for a response
Parameters
- value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The value to write
Returns Promise<void>
Implementation of BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse
- Defined in src/characteristic.ts:218

writeValueWithResponse

writeValueWithResponse(
value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<void>
Updates the value of the characteristic and waits for a response
Parameters
- value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The value to write
Returns Promise<void>
Implementation of BluetoothRemoteGATTCharacteristic.writeValueWithResponse
- Defined in src/characteristic.ts:202

Class BluetoothRemoteGATTCharacteristicImpl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BluetoothRemoteGATTCharacteristicImpl

Properties

Protectedemitter

Readonlyproperties

Readonlyservice

Readonlyuuid

Accessors

oncharacteristicvaluechanged

Parameters

Returns void

value

Returns DataView

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

getDescriptor

Parameters

Returns Promise<BluetoothRemoteGATTDescriptor>

getDescriptors

Parameters

Returns Promise<BluetoothRemoteGATTDescriptor[]>

readValue

Returns Promise<DataView<ArrayBufferLike>>

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

startNotifications

Returns Promise<BluetoothRemoteGATTCharacteristic>

stopNotifications

Returns Promise<BluetoothRemoteGATTCharacteristic>

writeValue

Parameters

Returns Promise<void>

writeValueWithoutResponse

Parameters

Returns Promise<void>

writeValueWithResponse

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`emitter

`Readonly`properties

`Readonly`service

`Readonly`uuid