Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BluetoothRemoteGATTService

Bluetooth Remote GATT Service class

Hierarchy

  • TypedDispatcher<BluetoothRemoteGATTServiceEvents, this>
    • BluetoothRemoteGATTService

Implements

  • W3CBluetoothRemoteGATTService

Index

Constructors

constructor

Properties

Readonly device

device: BluetoothDevice = ...

The device the service is related to

Readonly isPrimary

isPrimary: boolean = false

Whether the service is a primary one

Readonly uuid

uuid: string = ...

The unique identifier of the service

Accessors

oncharacteristicvaluechanged

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • event: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • event: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

          Returns void

    Returns void

addListener

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • data: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns BluetoothRemoteGATTService

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTService

dispatchEvent

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

    • event: BluetoothRemoteGATTServiceEvents[K]

    Returns boolean

emit

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

    • event: K
    • data: BluetoothRemoteGATTServiceEvents[K]

    Returns boolean

eventNames

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    • E: keyof EventListeners<T>

    Returns (K | E)[]

getCharacteristic

  • Gets a single characteristic contained in the service

    Parameters

    • characteristic: BluetoothCharacteristicUUID

      characteristic UUID

    Returns Promise<BluetoothRemoteGATTCharacteristic>

    Promise containing the characteristic

getCharacteristics

  • Gets a list of characteristics contained in the service

    Parameters

    • Optional characteristic: BluetoothCharacteristicUUID

      characteristic UUID

    Returns Promise<BluetoothRemoteGATTCharacteristic[]>

    Promise containing an array of characteristics

getIncludedService

  • Gets a single service included in the service

    Parameters

    • service: BluetoothServiceUUID

      service UUID

    Returns Promise<BluetoothRemoteGATTService>

    Promise containing the service

getIncludedServices

  • Gets a list of services included in the service

    Parameters

    • Optional service: BluetoothServiceUUID

      service UUID

    Returns Promise<BluetoothRemoteGATTService[]>

    Promise containing an array of services

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

    • type: K

    Returns number

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

    Returns number

listeners

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

    • event: K

    Returns Function[]

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

    Returns Function[]

on

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • data: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns BluetoothRemoteGATTService

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTService

once

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • data: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns BluetoothRemoteGATTService

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTService

prependListener

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • data: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns BluetoothRemoteGATTService

prependOnceListener

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • data: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns BluetoothRemoteGATTService

removeAllListeners

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

    • Optional event: K

    Returns BluetoothRemoteGATTService

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • Optional event: E

    Returns BluetoothRemoteGATTService

removeEventListener

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

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • event: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns void

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • event: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

          Returns void

    Returns void

removeListener

  • Type parameters

    • K: keyof BluetoothRemoteGATTServiceEvents

    Parameters

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

          • data: BluetoothRemoteGATTServiceEvents[K]

          Returns void

    Returns BluetoothRemoteGATTService

  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

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

          • data: EventListeners<BluetoothRemoteGATTServiceEvents>[E]

          Returns void

    Returns BluetoothRemoteGATTService

setMaxListeners