Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BluetoothRemoteGATTCharacteristic

Bluetooth Remote GATT Characteristic class

Hierarchy

  • TypedDispatcher<BluetoothRemoteGATTCharacteristicEvents, this>
    • 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 = ...

The unique identifier of the characteristic

Accessors

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
  • Parameters

    • fn: (ev: Event) => void
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    Returns void

value

  • get value(): DataView

Methods

addEventListener

  • addEventListener<K>(type: K, listener: (event: BluetoothRemoteGATTCharacteristicEvents[K]) => void): void
  • addEventListener<E>(type: E, listener: (event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void): void
  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • type: K
    • listener: (event: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (event: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • event: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: E
    • listener: (event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void
        • (event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): void
        • Parameters

          • event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

          Returns void

    Returns void

addListener

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • listener: (data: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (data: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • data: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void
        • (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): void
        • Parameters

          • data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

dispatchEvent

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

    • K: "characteristicvaluechanged"

    Parameters

    • event: BluetoothRemoteGATTCharacteristicEvents[K]

    Returns boolean

emit

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

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • data: BluetoothRemoteGATTCharacteristicEvents[K]

    Returns boolean

eventNames

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

    • K: "characteristicvaluechanged"

    • E: keyof EventListeners<T>

    Returns (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<BluetoothRemoteGATTDescriptor[]>

    Promise containing an array of descriptors

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

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

    • K: "characteristicvaluechanged"

    Parameters

    • type: K

    Returns number

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

    Returns number

listeners

  • listeners<K>(event: K): Function[]
  • listeners<E>(event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): Function[]
  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K

    Returns Function[]

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

    Returns Function[]

on

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • listener: (data: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (data: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • data: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void
        • (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): void
        • Parameters

          • data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

once

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • listener: (data: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (data: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • data: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void
        • (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): void
        • Parameters

          • data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

prependListener

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • listener: (data: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (data: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • data: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

prependOnceListener

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • listener: (data: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (data: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • data: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

readValue

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

    Returns Promise<DataView>

    Promise containing the value

removeAllListeners

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • Optional event: K

    Returns BluetoothRemoteGATTCharacteristic

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • Optional event: E

    Returns BluetoothRemoteGATTCharacteristic

removeEventListener

  • removeEventListener<K>(type: K, callback: (event: BluetoothRemoteGATTCharacteristicEvents[K]) => void): void
  • removeEventListener<E>(type: E, callback: (event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void): void
  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • type: K
    • callback: (event: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (event: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • event: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: E
    • callback: (event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void
        • (event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): void
        • Parameters

          • event: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

          Returns void

    Returns void

removeListener

  • Type parameters

    • K: "characteristicvaluechanged"

    Parameters

    • event: K
    • listener: (data: BluetoothRemoteGATTCharacteristicEvents[K]) => void
        • (data: BluetoothRemoteGATTCharacteristicEvents[K]): void
        • Parameters

          • data: BluetoothRemoteGATTCharacteristicEvents[K]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]) => void
        • (data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]): void
        • Parameters

          • data: EventListeners<BluetoothRemoteGATTCharacteristicEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTCharacteristic

setMaxListeners

startNotifications

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

    Returns Promise<BluetoothRemoteGATTCharacteristic>

    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>