Class BluetoothImpl

Bluetooth class

Hierarchy

EventDispatcher<BluetoothEvents>
- BluetoothImpl

Implements

Bluetooth

Index

Constructors

constructor

new BluetoothImpl(options?: BluetoothOptions): BluetoothImpl
Bluetooth constructor
Parameters
- options: BluetoothOptions = {}
  Bluetooth initialisation options
Returns BluetoothImpl
Overrides EventDispatcher<BluetoothEvents>.constructor
- Defined in src/bluetooth.ts:89

Properties

`Protected`emitter

emitter: EventEmitter<DefaultEventMap> = ...

`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
Returns void
Implementation of Bluetooth.onadvertisementreceived
- Defined in src/bluetooth.ts:167

onavailabilitychanged

set onavailabilitychanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of Bluetooth.onavailabilitychanged
- Defined in src/bluetooth.ts:179

oncharacteristicvaluechanged

set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of Bluetooth.oncharacteristicvaluechanged
- Defined in src/bluetooth.ts:107

ongattserverdisconnected

set ongattserverdisconnected(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of Bluetooth.ongattserverdisconnected
- Defined in src/bluetooth.ts:155

onserviceadded

set onserviceadded(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of Bluetooth.onserviceadded
- Defined in src/bluetooth.ts:119

onservicechanged

set onservicechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of Bluetooth.onservicechanged
- Defined in src/bluetooth.ts:131

onserviceremoved

set onserviceremoved(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of Bluetooth.onserviceremoved
- Defined in src/bluetooth.ts:143

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
Implementation of Bluetooth.addEventListener
Inherited from EventDispatcher.addEventListener
- Defined in src/events.ts:37
addEventListener<K extends keyof BluetoothEvents>(
type: K,
listener: EventListener,
): void
Type Parameters
- K extends keyof BluetoothEvents
Parameters
- type: K
- listener: EventListener
Returns void
Implementation of Bluetooth.addEventListener
Inherited from EventDispatcher.addEventListener
- Defined in src/events.ts:38

cancelRequest

cancelRequest(): void
Cancels the scan for devices

Returns void
- Defined in src/bluetooth.ts:401

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Implementation of Bluetooth.dispatchEvent
Inherited from EventDispatcher.dispatchEvent
- Defined in src/events.ts:55

getAvailability

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

Returns Promise<boolean>
Promise containing a flag indicating bluetooth availability
Implementation of Bluetooth.getAvailability
- Defined in src/bluetooth.ts:247

getDevices

getDevices(): Promise<BluetoothDevice[]>
Get all bluetooth devices

Returns Promise<BluetoothDevice[]>
Implementation of Bluetooth.getDevices
- Defined in src/bluetooth.ts:371

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
Implementation of Bluetooth.removeEventListener
Inherited from EventDispatcher.removeEventListener
- Defined in src/events.ts:46
removeEventListener<K extends keyof BluetoothEvents>(
type: K,
callback: EventListener,
): void
Type Parameters
- K extends keyof BluetoothEvents
Parameters
- type: K
- callback: EventListener
Returns void
Implementation of Bluetooth.removeEventListener
Inherited from EventDispatcher.removeEventListener
- Defined in src/events.ts:47

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
Implementation of Bluetooth.requestDevice
- Defined in src/bluetooth.ts:256

Class BluetoothImpl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BluetoothImpl

Properties

Protectedemitter

Optional ReadonlyreferringDevice

Accessors

onadvertisementreceived

Parameters

Returns void

onavailabilitychanged

Parameters

Returns void

oncharacteristicvaluechanged

Parameters

Returns void

ongattserverdisconnected

Parameters

Returns void

onserviceadded

Parameters

Returns void

onservicechanged

Parameters

Returns void

onserviceremoved

Parameters

Returns void

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

cancelRequest

Returns void

dispatchEvent

Parameters

Returns boolean

getAvailability

Returns Promise<boolean>

getDevices

Returns Promise<BluetoothDevice[]>

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

requestDevice

Parameters

Returns Promise<BluetoothDevice>

Settings

On This Page

`Protected`emitter

`Optional` `Readonly`referringDevice