Interface IApi

Main Jabra API object. Returned after SDK initialization (see init).

Provides an entry point to reflecting and changing the state of Jabra devices.

interface IApi {
    _config?: IConfig;
    _readyEvents: Observable<any>;
    _transport: ITransport;
    deviceAdded: Observable<IDevice>;
    deviceList: Observable<IDevice[]>;
    deviceRemoved: Observable<IDevice>;
    transportContext: TransportContext;
    getChromeExtensionVersion(): Promise<null | string>;
    getChromehostVersion(): Promise<null | string>;
    getCurrentDevices(): IDevice[];
    getVersion(): string;
}

Methods

getChromeExtensionVersion getChromehostVersion getCurrentDevices getVersion

Properties

_config? _readyEvents _transport deviceAdded deviceList deviceRemoved transportContext

Methods

getChromeExtensionVersion

  • getChromeExtensionVersion(): Promise<null | string>

  • Get the Jabra Chrome Extension version

    In node context, the Chrome Extension is unnecessary and will always return null.

    In browser context, the Chrome Extension is a required component that needs to be installed separately from this npm-package - unless the library is configured to use WebHID-transport, see IConfig.transport.

    Returns Promise<null | string>

    The version number or null if not installed.

getChromehostVersion

  • getChromehostVersion(): Promise<null | string>

  • Get the version of the Jabra Device Connector, previously known as Chromehost.

    The Jabra Device Connector is the native console application communicating with the USB-layer.

    In node context, the Jabra Device Connector will be embedded in the jabra-js stack, and not something to be concerned with as an SDK-user.

    In browser context, the Jabra Device Connector is a required application that needs to be installed separately from this npm-package - unless the library is configured to use WebHID-transport, see IConfig.transport.

    Returns Promise<null | string>

    The version number or null if not installed.

getCurrentDevices

  • getCurrentDevices(): IDevice[]

  • Get a collection of the currently available Jabra devices.

    Returns IDevice[]

getVersion

  • getVersion(): string

  • Returns the Jabra SDK version

    Returns string

Properties

Optional_config

_config?: IConfig

The configuration that was used to initialize the SDK.

_readyEvents

_readyEvents: Observable<any>

Emits when the SDK has initialized and is ready for operation. The observable will replay on new subscriptions.

_transport

_transport: ITransport

Internal use only. Acts as a bridge between the SDK and the object which communicates with the OS and the Jabra device.

deviceAdded

deviceAdded: Observable<IDevice>

An observable which emits newly discovered Jabra devices. The emitted device object can be consumed by the third party developer. See IDevice for more information.

deviceList

deviceList: Observable<IDevice[]>

A list of connected physical Jabra devices. Each device object can be consumed by the third party developer. See IDevice for more information.

deviceRemoved

deviceRemoved: Observable<IDevice>

An observable which emits disconnected Jabra devices. The emitted device object represents the device that has been disconnected. See IDevice for more information.

transportContext

transportContext: TransportContext

Get the underlying transport context. Especially relevant when running in the browser to distinguish between WebHID and Chrome Extension/Host See enum TransportContext

Settings

Member Visibility

On This Page

Methods
Properties