Class BluetoothDeviceImpl

Bluetooth Device class

Hierarchy

EventDispatcher<BluetoothDeviceEvents>
- BluetoothDeviceImpl

Implements

BluetoothDevice

Index

Constructors

constructor

new BluetoothDeviceImpl(
init: Partial<BluetoothDeviceImpl>,
forgetFn: () => void,
): BluetoothDeviceImpl
Device constructor
Parameters
- init: Partial<BluetoothDeviceImpl>
  A partial class to initialise values
- forgetFn: () => void
Returns BluetoothDeviceImpl
Overrides EventDispatcher<BluetoothDeviceEvents>.constructor
- Defined in src/device.ts:171

Properties

`Protected`emitter

emitter: EventEmitter<DefaultEventMap> = ...

`Readonly`gatt

gatt: BluetoothRemoteGATTServer = undefined

The gatt server of the device

`Readonly`id

id: string = undefined

The unique identifier of the device

`Readonly`name

name: string = undefined

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
Returns void
Implementation of BluetoothDevice.onadvertisementreceived
- Defined in src/device.ts:156

oncharacteristicvaluechanged

set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.oncharacteristicvaluechanged
- Defined in src/device.ts:96

ongattserverdisconnected

set ongattserverdisconnected(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.ongattserverdisconnected
- Defined in src/device.ts:144

onserviceadded

set onserviceadded(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onserviceadded
- Defined in src/device.ts:108

onservicechanged

set onservicechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onservicechanged
- Defined in src/device.ts:120

onserviceremoved

set onserviceremoved(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onserviceremoved
- Defined in src/device.ts:132

Methods

addEventListener

addEventListener<K extends keyof BluetoothDeviceEvents>(
type: K,
listener: (this: this, ev: BluetoothDeviceEvents[K]) => void,
): void
Type Parameters
- K extends keyof BluetoothDeviceEvents
Parameters
- type: K
- listener: (this: this, ev: BluetoothDeviceEvents[K]) => void
Returns void
Implementation of BluetoothDevice.addEventListener
Inherited from EventDispatcher.addEventListener
- Defined in src/events.ts:37
addEventListener<K extends keyof BluetoothDeviceEvents>(
type: K,
listener: EventListener,
): void
Type Parameters
- K extends keyof BluetoothDeviceEvents
Parameters
- type: K
- listener: EventListener
Returns void
Implementation of BluetoothDevice.addEventListener
Inherited from EventDispatcher.addEventListener
- Defined in src/events.ts:38

dispatchEvent

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

forget

forget(): Promise<void>
Forget this device

Returns Promise<void>
Implementation of BluetoothDevice.forget
- Defined in src/device.ts:204

removeEventListener

removeEventListener<K extends keyof BluetoothDeviceEvents>(
type: K,
callback: (this: this, ev: BluetoothDeviceEvents[K]) => void,
): void
Type Parameters
- K extends keyof BluetoothDeviceEvents
Parameters
- type: K
- callback: (this: this, ev: BluetoothDeviceEvents[K]) => void
Returns void
Implementation of BluetoothDevice.removeEventListener
Inherited from EventDispatcher.removeEventListener
- Defined in src/events.ts:46
removeEventListener<K extends keyof BluetoothDeviceEvents>(
type: K,
callback: EventListener,
): void
Type Parameters
- K extends keyof BluetoothDeviceEvents
Parameters
- type: K
- callback: EventListener
Returns void
Implementation of BluetoothDevice.removeEventListener
Inherited from EventDispatcher.removeEventListener
- Defined in src/events.ts:47

unwatchAdvertisements

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

Returns Promise<void>
- Defined in src/device.ts:197

watchAdvertisements

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

Returns Promise<void>
Implementation of BluetoothDevice.watchAdvertisements
- Defined in src/device.ts:190

Class BluetoothDeviceImpl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BluetoothDeviceImpl

Properties

Protectedemitter

Readonlygatt

Readonlyid

Readonlyname

ReadonlywatchingAdvertisements

Accessors

onadvertisementreceived

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

dispatchEvent

Parameters

Returns boolean

forget

Returns Promise<void>

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

unwatchAdvertisements

Returns Promise<void>

watchAdvertisements

Returns Promise<void>

Settings

On This Page

`Protected`emitter

`Readonly`gatt

`Readonly`id

`Readonly`name

`Readonly`watchingAdvertisements