Class Bluetooth

Bluetooth class

Hierarchy

  • EventDispatcher<BluetoothEvents>
    • Bluetooth

Implements

  • Bluetooth

Constructors

constructor

Properties

emitter referringDevice?

Accessors

onadvertisementreceived onavailabilitychanged oncharacteristicvaluechanged ongattserverdisconnected onserviceadded onservicechanged onserviceremoved

Methods

addEventListener cancelRequest dispatchEvent getAvailability getDevices removeEventListener requestDevice

Constructors

constructor

Properties

Protected emitter

emitter: EventEmitter<DefaultEventMap> = ...

Optional Readonly referringDevice

referringDevice?: BluetoothDevice

Referring device for the bluetooth instance

Accessors

onadvertisementreceived

  • set onadvertisementreceived(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

onavailabilitychanged

  • set onavailabilitychanged(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

ongattserverdisconnected

  • set ongattserverdisconnected(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceadded

  • set onserviceadded(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

onservicechanged

  • set onservicechanged(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceremoved

  • set onserviceremoved(fn): void

  • Parameters

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

        • Parameters

          • ev: Event

          Returns void

    Returns void

Methods

addEventListener

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

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: ((this, ev) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothEvents[K]

          Returns void

    Returns void

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

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: EventListener

    Returns void

cancelRequest

  • cancelRequest(): void

  • Cancels the scan for devices

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

getAvailability

  • getAvailability(): Promise<boolean>

  • Gets the availability of a bluetooth adapter

    Returns Promise<boolean>

    Promise containing a flag indicating bluetooth availability

getDevices

  • getDevices(): Promise<BluetoothDevice[]>

  • Get all bluetooth devices

    Returns Promise<BluetoothDevice[]>

removeEventListener

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

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: ((this, ev) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothEvents[K]

          Returns void

    Returns void

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

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: EventListener

    Returns void

requestDevice

  • requestDevice(options?): Promise<BluetoothDevice>

  • Scans for a device matching optional filters

    Parameters

    • options: RequestDeviceOptions = ...

      The options to use when scanning

    Returns Promise<BluetoothDevice>

    Promise containing a device which matches the options

Settings

Member Visibility

Theme

On This Page

constructoremitterreferringDeviceonadvertisementreceivedonavailabilitychangedoncharacteristicvaluechangedongattserverdisconnectedonserviceaddedonservicechangedonserviceremovedaddEventListenercancelRequestdispatchEventgetAvailabilitygetDevicesremoveEventListenerrequestDevice