Options
All
  • Public
  • Public/Protected
  • All
Menu

Bluetooth class

Hierarchy

  • TypedDispatcher<BluetoothEvents, this>
    • Bluetooth

Implements

  • W3CBluetooth

Index

Constructors

constructor

  • Bluetooth constructor

    Parameters

    Returns Bluetooth

Events

Static EVENT_AVAILABILITY

EVENT_AVAILABILITY: string = 'availabilitychanged'

Bluetooth Availability Changed event

Properties

Optional Readonly referringDevice

referringDevice: BluetoothDevice

Referring device for the bluetooth instance

Accessors

onadvertisementreceived

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

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

          • ev: Event

          Returns void

    Returns void

onavailabilitychanged

  • set onavailabilitychanged(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: BluetoothEvents[K]) => void): void
  • addEventListener<E>(type: E, listener: (event: EventListeners<BluetoothEvents>[E]) => void): void
  • Type parameters

    • K: keyof BluetoothEvents

    Parameters

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

          • event: BluetoothEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • event: EventListeners<BluetoothEvents>[E]

          Returns void

    Returns void

addListener

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

    • K: keyof BluetoothEvents

    Parameters

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

          • data: BluetoothEvents[K]

          Returns void

    Returns Bluetooth

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothEvents>[E]

          Returns void

    Returns Bluetooth

cancelRequest

  • cancelRequest(): Promise<void>

dispatchEvent

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

    • K: keyof BluetoothEvents

    Parameters

    • event: BluetoothEvents[K]

    Returns boolean

emit

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

    • K: keyof BluetoothEvents

    Parameters

    • event: K
    • data: BluetoothEvents[K]

    Returns boolean

eventNames

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

    • K: keyof BluetoothEvents

    • E: keyof EventListeners<T>

    Returns (K | E)[]

getAvailability

  • getAvailability(): Promise<boolean>
  • Gets the availability of a bluetooth adapter

    Returns Promise<boolean>

    Promise containing a flag indicating bluetooth availability

getDevices

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

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

    • K: keyof BluetoothEvents

    Parameters

    • type: K

    Returns number

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: EventListeners<BluetoothEvents>[E]

    Returns number

listeners

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

    • K: keyof BluetoothEvents

    Parameters

    • event: K

    Returns Function[]

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: EventListeners<BluetoothEvents>[E]

    Returns Function[]

on

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

    • K: keyof BluetoothEvents

    Parameters

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

          • data: BluetoothEvents[K]

          Returns void

    Returns Bluetooth

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothEvents>[E]

          Returns void

    Returns Bluetooth

once

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

    • K: keyof BluetoothEvents

    Parameters

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

          • data: BluetoothEvents[K]

          Returns void

    Returns Bluetooth

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothEvents>[E]

          Returns void

    Returns Bluetooth

prependListener

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

    • K: keyof BluetoothEvents

    Parameters

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

          • data: BluetoothEvents[K]

          Returns void

    Returns Bluetooth

prependOnceListener

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

    • K: keyof BluetoothEvents

    Parameters

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

          • data: BluetoothEvents[K]

          Returns void

    Returns Bluetooth

removeAllListeners

  • Type parameters

    • K: keyof BluetoothEvents

    Parameters

    • Optional event: K

    Returns Bluetooth

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • Optional event: E

    Returns Bluetooth

removeEventListener

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

    • K: keyof BluetoothEvents

    Parameters

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

          • event: BluetoothEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • event: EventListeners<BluetoothEvents>[E]

          Returns void

    Returns void

removeListener

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

    • K: keyof BluetoothEvents

    Parameters

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

          • data: BluetoothEvents[K]

          Returns void

    Returns Bluetooth

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothEvents>[E]

          Returns void

    Returns Bluetooth

requestDevice

  • 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

setMaxListeners

  • Parameters

    • n: number

    Returns Bluetooth