Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BluetoothDevice

Bluetooth Device class

Hierarchy

  • TypedDispatcher<BluetoothDeviceEvents, this>
    • BluetoothDevice

Implements

  • W3CBluetoothDevice

Index

Constructors

constructor

  • Device constructor

    Parameters

    Returns BluetoothDevice

Properties

Readonly gatt

The gatt server of the device

Readonly id

id: string = ...

The unique identifier of the device

Readonly name

name: string = ...

The name of the device

Readonly watchingAdvertisements

watchingAdvertisements: boolean = false

Whether adverts are being watched (not implemented)

Accessors

onadvertisementreceived

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

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

          • ev: Event

          Returns void

    Returns void

oncharacteristicvaluechanged

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

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

          • ev: Event

          Returns void

    Returns void

ongattserverdisconnected

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

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

          • ev: Event

          Returns void

    Returns void

onserviceadded

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

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

          • ev: Event

          Returns void

    Returns void

onservicechanged

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

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

          • ev: Event

          Returns void

    Returns void

onserviceremoved

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

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

          • ev: Event

          Returns void

    Returns void

Methods

addEventListener

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

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • event: BluetoothDeviceEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • event: EventListeners<BluetoothDeviceEvents>[E]

          Returns void

    Returns void

addListener

  • addListener<K>(event: K, listener: (data: BluetoothDeviceEvents[K]) => void): BluetoothDevice
  • addListener<E>(event: E, listener: (data: EventListeners<BluetoothDeviceEvents>[E]) => void): BluetoothDevice
  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • data: BluetoothDeviceEvents[K]

          Returns void

    Returns BluetoothDevice

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothDeviceEvents>[E]

          Returns void

    Returns BluetoothDevice

dispatchEvent

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

    • K: keyof BluetoothDeviceEvents

    Parameters

    • event: BluetoothDeviceEvents[K]

    Returns boolean

emit

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

    • K: keyof BluetoothDeviceEvents

    Parameters

    • event: K
    • data: BluetoothDeviceEvents[K]

    Returns boolean

eventNames

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

    • K: keyof BluetoothDeviceEvents

    • E: keyof EventListeners<T>

    Returns (K | E)[]

forget

  • forget(): Promise<void>
  • Forget this device (not implemented)

    Returns Promise<void>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

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

    • K: keyof BluetoothDeviceEvents

    Parameters

    • type: K

    Returns number

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: EventListeners<BluetoothDeviceEvents>[E]

    Returns number

listeners

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

    • K: keyof BluetoothDeviceEvents

    Parameters

    • event: K

    Returns Function[]

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: EventListeners<BluetoothDeviceEvents>[E]

    Returns Function[]

on

  • on<K>(event: K, listener: (data: BluetoothDeviceEvents[K]) => void): BluetoothDevice
  • on<E>(event: E, listener: (data: EventListeners<BluetoothDeviceEvents>[E]) => void): BluetoothDevice
  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • data: BluetoothDeviceEvents[K]

          Returns void

    Returns BluetoothDevice

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothDeviceEvents>[E]

          Returns void

    Returns BluetoothDevice

once

  • once<K>(event: K, listener: (data: BluetoothDeviceEvents[K]) => void): BluetoothDevice
  • once<E>(event: E, listener: (data: EventListeners<BluetoothDeviceEvents>[E]) => void): BluetoothDevice
  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • data: BluetoothDeviceEvents[K]

          Returns void

    Returns BluetoothDevice

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothDeviceEvents>[E]

          Returns void

    Returns BluetoothDevice

prependListener

  • prependListener<K>(event: K, listener: (data: BluetoothDeviceEvents[K]) => void): BluetoothDevice
  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • data: BluetoothDeviceEvents[K]

          Returns void

    Returns BluetoothDevice

prependOnceListener

  • prependOnceListener<K>(event: K, listener: (data: BluetoothDeviceEvents[K]) => void): BluetoothDevice
  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • data: BluetoothDeviceEvents[K]

          Returns void

    Returns BluetoothDevice

removeAllListeners

  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

    • Optional event: K

    Returns BluetoothDevice

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • Optional event: E

    Returns BluetoothDevice

removeEventListener

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

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • event: BluetoothDeviceEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • event: EventListeners<BluetoothDeviceEvents>[E]

          Returns void

    Returns void

removeListener

  • removeListener<K>(event: K, listener: (data: BluetoothDeviceEvents[K]) => void): BluetoothDevice
  • removeListener<E>(event: E, listener: (data: EventListeners<BluetoothDeviceEvents>[E]) => void): BluetoothDevice
  • Type parameters

    • K: keyof BluetoothDeviceEvents

    Parameters

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

          • data: BluetoothDeviceEvents[K]

          Returns void

    Returns BluetoothDevice

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothDeviceEvents>[E]

          Returns void

    Returns BluetoothDevice

setMaxListeners

  • Parameters

    • n: number

    Returns BluetoothDevice

unwatchAdvertisements

  • unwatchAdvertisements(): Promise<void>
  • Stops watching adverts from this device (not implemented)

    Returns Promise<void>

watchAdvertisements

  • watchAdvertisements(): Promise<void>
  • Starts watching adverts from this device (not implemented)

    Returns Promise<void>