Options
All
  • Public
  • Public/Protected
  • All
Menu

API Reference — SDK for Node.js 3.6

Overview

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

DeviceTypeEvents

DeviceTypeEvents: "btnPress" | "busyLightChange" | "downloadFirmwareProgress" | "onBTParingListChange" | "onGNPBtnEvent" | "onDevLogEvent" | "onDiagLogEvent" | "onBatteryStatusUpdate" | "onRemoteMmiEvent" | "onxpressConnectionStatusEvent" | "onUploadProgress" | "onDectInfoEvent" | "onCameraStatusEvent" | "onBluetoothLinkQualityChangeEvent" | "onNetworkStatusChangedEvent"

JabraError

JabraError: Error & { code?: undefined | number }

The type of error returned from rejected Jabra API promises.

JabraTypeEvents

JabraTypeEvents: "attach" | "detach" | "firstScanDone"

_EventEmitter

_EventEmitter: EventEmitter

Variables

Const DeviceEventsList

DeviceEventsList: DeviceTypeEvents[] = ['btnPress', 'busyLightChange', 'downloadFirmwareProgress', 'onBTParingListChange', 'onGNPBtnEvent', 'onDevLogEvent', 'onDiagLogEvent', 'onBatteryStatusUpdate', 'onRemoteMmiEvent', 'onxpressConnectionStatusEvent', 'onUploadProgress', 'onDectInfoEvent', 'onCameraStatusEvent', 'onBluetoothLinkQualityChangeEvent', 'onNetworkStatusChangedEvent']

Const JabraEventsList

JabraEventsList: JabraTypeEvents[] = ['attach', 'detach', 'firstScanDone']

Let cachedClassesMeta

cachedClassesMeta: ClassEntry[] | null = null

Holds copy of last read meta information file.

Let cachedLogConfig

cachedLogConfig: NativeAddonLogConfig | undefined = undefined

Cached native log configuration.

Const invalidRefKey

invalidRefKey: number = -1

Functions

createJabraApplication

  • createJabraApplication(appID: string, configCloudParams?: ConfigParamsCloud, nonJabraDeviceDectection?: boolean): Promise<JabraType>

  • This function should be called to create/get the main JabraType (application) instance.

    Parameters

    • appID: string

      The user should first register the app on Jabra developer site to get application id.

    • Default value configCloudParams: ConfigParamsCloud = {}

      Optional configuration parameters for the sdk.

    • Default value nonJabraDeviceDectection: boolean = false

      If true non Jabra and Jabra devices will be detected, false by default.

    Returns Promise<JabraType>

mapLogValue

  • mapLogValue(value: any): string | Error

  • Parameters

    • value: any

    Returns string | Error

This API Reference is provided by Jabra Developer Zone.