Bluetooth Remote GATT Characteristic class

Type parameters

  • T

Hierarchy

  • TypedDispatcher
    • BluetoothRemoteGATTCharacteristic

Implements

  • W3CBluetoothRemoteGATTCharacteristic

Index

Constructors

constructor

Properties

Readonly properties

properties: BluetoothCharacteristicProperties

The properties of the characteristic

Readonly service

The service the characteristic is related to

Readonly uuid

uuid: any = null

The unique identifier of the characteristic

Accessors

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn: function): void
  • Parameters

    • fn: function
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    Returns void

value

  • get value(): DataView
  • The value of the characteristic

    Returns DataView

Methods

addEventListener

  • addEventListener<K>(type: K, listener: function): void
  • Type parameters

    • K: keyof T

    Parameters

    • type: K
    • listener: function
        • (this: this, event: T[K]): void
        • Parameters

          • this: this
          • event: T[K]

          Returns void

    Returns void

  • addEventListener<E>(type: E, listener: function): void
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: E
    • listener: function
        • (this: this, event: EventListeners<T>[E]): void
        • Parameters

          • this: this
          • event: EventListeners<T>[E]

          Returns void

    Returns void

addListener

  • addListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • addListener<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

dispatchEvent

  • dispatchEvent<K>(event: T[K]): boolean
  • Type parameters

    • K: keyof T

    Parameters

    • event: T[K]

    Returns boolean

emit

  • emit<K>(event: K, data: T[K]): boolean
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • data: T[K]

    Returns boolean

eventNames

  • eventNames<K, E>(): Array<K | E>
  • Type parameters

    • K: keyof T

    • E: keyof EventListeners<T>

    Returns Array<K | E>

getDescriptor

  • Gets a single characteristic descriptor

    Parameters

    • descriptor: string | number

      descriptor UUID

    Returns Promise<BluetoothRemoteGATTDescriptor>

    Promise containing the descriptor

getDescriptors

  • Gets a list of the characteristic's descriptors

    Parameters

    • Optional descriptor: string | number

      descriptor UUID

    Returns Promise<Array<BluetoothRemoteGATTDescriptor>>

    Promise containing an array of descriptors

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount<K>(type: K): number
  • Type parameters

    • K: keyof T

    Parameters

    • type: K

    Returns number

  • listenerCount<E>(type: EventListeners<T>[E]): number
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: EventListeners<T>[E]

    Returns number

listeners

  • listeners<K>(event: K): Array<Function>
  • Type parameters

    • K: keyof T

    Parameters

    • event: K

    Returns Array<Function>

  • listeners<E>(event: EventListeners<T>[E]): Array<Function>
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: EventListeners<T>[E]

    Returns Array<Function>

on

  • on<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • on<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

once

  • once<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • once<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

prependListener

  • prependListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

readValue

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

    Returns Promise<DataView>

    Promise containing the value

removeAllListeners

  • removeAllListeners<K>(event?: K): this
  • Type parameters

    • K: keyof T

    Parameters

    • Optional event: K

    Returns this

  • removeAllListeners<E>(event?: E): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • Optional event: E

    Returns this

removeEventListener

  • removeEventListener<K>(type: K, callback: function): void
  • Type parameters

    • K: keyof T

    Parameters

    • type: K
    • callback: function
        • (this: this, event: T[K]): void
        • Parameters

          • this: this
          • event: T[K]

          Returns void

    Returns void

  • removeEventListener<E>(type: E, callback: function): void
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: E
    • callback: function
        • (this: this, event: EventListeners<T>[E]): void
        • Parameters

          • this: this
          • event: EventListeners<T>[E]

          Returns void

    Returns void

removeListener

  • removeListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • removeListener<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

startNotifications

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

    Returns Promise<W3CBluetoothRemoteGATTCharacteristic>

    Promise containing the characteristic

stopNotifications

writeValue

  • writeValue(value: ArrayBuffer | ArrayBufferView): Promise<void>
  • Updates the value of the characteristic

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

    Returns Promise<void>

writeValueWithResponse

  • writeValueWithResponse(value: ArrayBuffer | ArrayBufferView): Promise<void>
  • Updates the value of the characteristic and waits for a response

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

    Returns Promise<void>

writeValueWithoutResponse

  • writeValueWithoutResponse(value: ArrayBuffer | ArrayBufferView): Promise<void>
  • Updates the value of the characteristic without waiting for a response

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

    Returns Promise<void>