Class BluetoothRemoteGATTServiceImpl

Bluetooth Remote GATT Service class

Hierarchy

EventDispatcher<ServiceEvents>
- BluetoothRemoteGATTServiceImpl

Implements

BluetoothRemoteGATTService

Index

Constructors

constructor

new BluetoothRemoteGATTServiceImpl(
init: Partial<BluetoothRemoteGATTServiceImpl>,
): BluetoothRemoteGATTServiceImpl
Service constructor
Parameters
- init: Partial<BluetoothRemoteGATTServiceImpl>
  A partial class to initialise values
Returns BluetoothRemoteGATTServiceImpl
Overrides EventDispatcher<ServiceEvents>.constructor
- Defined in src/service.ts:130

Properties

`Readonly`device

device: BluetoothDeviceImpl = undefined

The device the service is related to

`Protected`emitter

emitter: EventEmitter<DefaultEventMap> = ...

`Readonly`isPrimary

isPrimary: boolean = false

Whether the service is a primary one

`Readonly`uuid

uuid: string = undefined

The unique identifier of the service

Accessors

oncharacteristicvaluechanged

set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothRemoteGATTService.oncharacteristicvaluechanged
- Defined in src/service.ts:79

onserviceadded

set onserviceadded(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothRemoteGATTService.onserviceadded
- Defined in src/service.ts:91

onservicechanged

set onservicechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothRemoteGATTService.onservicechanged
- Defined in src/service.ts:103

onserviceremoved

set onserviceremoved(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothRemoteGATTService.onserviceremoved
- Defined in src/service.ts:115

Methods

addEventListener

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

dispatchEvent

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

getCharacteristic

getCharacteristic(
characteristic: BluetoothCharacteristicUUID,
): Promise<BluetoothRemoteGATTCharacteristic>
Gets a single characteristic contained in the service
Parameters
- characteristic: BluetoothCharacteristicUUID
  characteristic UUID
Returns Promise<BluetoothRemoteGATTCharacteristic>
Promise containing the characteristic
Implementation of BluetoothRemoteGATTService.getCharacteristic
- Defined in src/service.ts:148

getCharacteristics

getCharacteristics(
characteristic?: BluetoothCharacteristicUUID,
): Promise<BluetoothRemoteGATTCharacteristic[]>
Gets a list of characteristics contained in the service
Parameters
- Optionalcharacteristic: BluetoothCharacteristicUUID
  characteristic UUID
Returns Promise<BluetoothRemoteGATTCharacteristic[]>
Promise containing an array of characteristics
Implementation of BluetoothRemoteGATTService.getCharacteristics
- Defined in src/service.ts:170

getIncludedService

getIncludedService(
service: BluetoothServiceUUID,
): Promise<BluetoothRemoteGATTService>
Gets a single service included in the service
Parameters
- service: BluetoothServiceUUID
  service UUID
Returns Promise<BluetoothRemoteGATTService>
Promise containing the service
Implementation of BluetoothRemoteGATTService.getIncludedService
- Defined in src/service.ts:206

getIncludedServices

getIncludedServices(
service?: BluetoothServiceUUID,
): Promise<BluetoothRemoteGATTService[]>
Gets a list of services included in the service
Parameters
- Optionalservice: BluetoothServiceUUID
  service UUID
Returns Promise<BluetoothRemoteGATTService[]>
Promise containing an array of services
Implementation of BluetoothRemoteGATTService.getIncludedServices
- Defined in src/service.ts:228

removeEventListener

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

Class BluetoothRemoteGATTServiceImpl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BluetoothRemoteGATTServiceImpl

Properties

Readonlydevice

Protectedemitter

ReadonlyisPrimary

Readonlyuuid

Accessors

oncharacteristicvaluechanged

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

getCharacteristic

Parameters

Returns Promise<BluetoothRemoteGATTCharacteristic>

getCharacteristics

Parameters

Returns Promise<BluetoothRemoteGATTCharacteristic[]>

getIncludedService

Parameters

Returns Promise<BluetoothRemoteGATTService>

getIncludedServices

Parameters

Returns Promise<BluetoothRemoteGATTService[]>

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

Settings

On This Page

`Readonly`device

`Protected`emitter

`Readonly`isPrimary

`Readonly`uuid