Class BluetoothImpl

Bluetooth class

Hierarchy

  • EventDispatcher<BluetoothEvents>
    • BluetoothImpl

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

Protectedemitter

emitter: EventEmitter<DefaultEventMap> = ...

Optional ReadonlyreferringDevice

referringDevice?: BluetoothDevice

Referring device for the bluetooth instance

Accessors

onadvertisementreceived

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

    Parameters

    • fn: (ev: Event) => void

    Returns void

onavailabilitychanged

  • set onavailabilitychanged(fn: (ev: Event) => void): void

    Parameters

    • fn: (ev: Event) => void

    Returns void

oncharacteristicvaluechanged

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

    Parameters

    • fn: (ev: Event) => void

    Returns void

ongattserverdisconnected

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

    Parameters

    • fn: (ev: Event) => void

    Returns void

onserviceadded

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

    Parameters

    • fn: (ev: Event) => void

    Returns void

onservicechanged

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

    Parameters

    • fn: (ev: Event) => void

    Returns void

onserviceremoved

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

    Parameters

    • fn: (ev: Event) => void

    Returns void

Methods

addEventListener

  • addEventListener<K extends keyof BluetoothEvents>(
        type: K,
        listener: (this: this, ev: BluetoothEvents[K]) => void,
    ): void

    Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

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

    Returns void

  • addEventListener<K extends keyof BluetoothEvents>(
        type: K,
        listener: EventListener,
    ): void

    Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: EventListener

    Returns void

cancelRequest

dispatchEvent

  • dispatchEvent(event: 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 extends keyof BluetoothEvents>(
        type: K,
        callback: (this: this, ev: BluetoothEvents[K]) => void,
    ): void

    Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

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

    Returns void

  • removeEventListener<K extends keyof BluetoothEvents>(
        type: K,
        callback: EventListener,
    ): void

    Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: EventListener

    Returns void

requestDevice

  • requestDevice(options?: RequestDeviceOptions): 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

On This Page

Constructors
Properties
Accessors
Methods