Bluetooth Remote GATT Service class

Type parameters

  • T

Hierarchy

  • TypedDispatcher
    • BluetoothRemoteGATTService

Implements

  • W3CBluetoothRemoteGATTService

Index

Constructors

constructor

Properties

Readonly device

device: BluetoothDevice = null

The device the service is related to

Readonly isPrimary

isPrimary: boolean = false

Whether the service is a primary one

Readonly uuid

uuid: string = null

The unique identifier of the service

Accessors

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn: function): void
  • Parameters

    • fn: function
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceadded

  • set onserviceadded(fn: function): void
  • Parameters

    • fn: function
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    Returns void

onservicechanged

  • set onservicechanged(fn: function): void
  • Parameters

    • fn: function
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceremoved

  • set onserviceremoved(fn: function): void
  • Parameters

    • fn: function
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    Returns void

Methods

addEventListener

  • addEventListener<K>(type: K, listener: function): void
  • Type parameters

    • K: keyof T

    Parameters

    • type: K
    • listener: function
        • (this: this, event: T[K]): void
        • Parameters

          • this: this
          • event: T[K]

          Returns void

    Returns void

  • addEventListener<E>(type: E, listener: function): void
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: E
    • listener: function
        • (this: this, event: EventListeners<T>[E]): void
        • Parameters

          • this: this
          • event: EventListeners<T>[E]

          Returns void

    Returns void

addListener

  • addListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • addListener<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

dispatchEvent

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

    • K: keyof T

    Parameters

    • event: T[K]

    Returns boolean

emit

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

    • K: keyof T

    Parameters

    • event: K
    • data: T[K]

    Returns boolean

eventNames

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

    • K: keyof T

    • E: keyof EventListeners<T>

    Returns Array<K | E>

getCharacteristic

  • Gets a single characteristic contained in the service

    Parameters

    • characteristic: string | number

      characteristic UUID

    Returns Promise<BluetoothRemoteGATTCharacteristic>

    Promise containing the characteristic

getCharacteristics

  • Gets a list of characteristics contained in the service

    Parameters

    • Optional characteristic: string | number

      characteristic UUID

    Returns Promise<Array<BluetoothRemoteGATTCharacteristic>>

    Promise containing an array of characteristics

getIncludedService

  • Gets a single service included in the service

    Parameters

    • service: string | number

      service UUID

    Returns Promise<BluetoothRemoteGATTService>

    Promise containing the service

getIncludedServices

  • Gets a list of services included in the service

    Parameters

    • Optional service: string | number

      service UUID

    Returns Promise<Array<BluetoothRemoteGATTService>>

    Promise containing an array of services

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount<K>(type: K): number
  • Type parameters

    • K: keyof T

    Parameters

    • type: K

    Returns number

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

    • E: keyof EventListeners<T>

    Parameters

    • type: EventListeners<T>[E]

    Returns number

listeners

  • listeners<K>(event: K): Array<Function>
  • Type parameters

    • K: keyof T

    Parameters

    • event: K

    Returns Array<Function>

  • listeners<E>(event: EventListeners<T>[E]): Array<Function>
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: EventListeners<T>[E]

    Returns Array<Function>

on

  • on<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • on<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

once

  • once<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • once<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

prependListener

  • prependListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners<K>(event?: K): this
  • Type parameters

    • K: keyof T

    Parameters

    • Optional event: K

    Returns this

  • removeAllListeners<E>(event?: E): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • Optional event: E

    Returns this

removeEventListener

  • removeEventListener<K>(type: K, callback: function): void
  • Type parameters

    • K: keyof T

    Parameters

    • type: K
    • callback: function
        • (this: this, event: T[K]): void
        • Parameters

          • this: this
          • event: T[K]

          Returns void

    Returns void

  • removeEventListener<E>(type: E, callback: function): void
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • type: E
    • callback: function
        • (this: this, event: EventListeners<T>[E]): void
        • Parameters

          • this: this
          • event: EventListeners<T>[E]

          Returns void

    Returns void

removeListener

  • removeListener<K>(event: K, listener: function): this
  • Type parameters

    • K: keyof T

    Parameters

    • event: K
    • listener: function
        • (data: T[K]): void
        • Parameters

          • data: T[K]

          Returns void

    Returns this

  • removeListener<E>(event: E, listener: function): this
  • Type parameters

    • E: keyof EventListeners<T>

    Parameters

    • event: E
    • listener: function
        • (data: EventListeners<T>[E]): void
        • Parameters

          • data: EventListeners<T>[E]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this