Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JabraType

Main API class return by createJabraApplication.

Hierarchy

  • JabraType

Implements

Index

Properties

Methods

Properties

Optional appID

appID: undefined | string

The application Id used to instantiate the Api.

Nb. Not applicable for client side proxies.

Methods

connectToJabraApplicationAsync

  • connectToJabraApplicationAsync(guid: string, softphoneName: string): Promise<boolean>

  • Integrates softphone app to Jabra applications like Jabra Direct(JD) and Jabra Suite for Mac(JMS).

    Parameters

    • guid: string

      Client unique ID.

    • softphoneName: string

      Name of the application to be shown in JD or JMS.

    Returns Promise<boolean>

    • Resolve boolean if successful otherwise Reject with error.
    • Returns true if softphone app integrates to Jabra application, false otherwise.

disconnectFromJabraApplicationAsync

  • disconnectFromJabraApplicationAsync(): Promise<void>

  • Disconnects connected from Jabra applications.

    Returns Promise<void>

    • Resolve void if successful otherwise Reject with error.

disposeAsync

  • disposeAsync(shutdownServer?: boolean): Promise<void>

  • The user must call this function when finished using the wrapper. Otherwise the node process will not shutdown properly.

    Parameters

    • Default value shutdownServer: boolean = false

      Optional parameter only applicable to electronrendererhelper, where it cause API server shutdown if set. Can safely be ignored otherwise.

    Returns Promise<void>

    • Resolve void if successful otherwise Reject with error.

getAttachedDevices

getErrorStringAsync

  • getErrorStringAsync(errStatusCode: number): Promise<string>

  • Get return error string from a previously returned SDK error status.

    Parameters

    • errStatusCode: number

      Status code of the error from the Jabra Device.

    Returns Promise<string>

    • Resolve Error String string if successful otherwise Reject with error.

getMeta

  • Get meta information about methods, properties etc. that can be used for reflective usage of this class.

    Returns ClassEntry

getSDKVersionAsync

  • getSDKVersionAsync(): Promise<string>

  • Get the SDK version.

    Returns Promise<string>

    • Resolve SDK version string if successful otherwise Reject with error.

isSoftphoneInFocusAsync

  • isSoftphoneInFocusAsync(): Promise<boolean>

  • Indicates whether the softphone is in focus.

    Returns Promise<boolean>

    • Resolve boolean if successful otherwise Reject with error.
    • Returns true if softphone is in focus, false otherwise.

off

  • off(event: "attach", listener: attach): this
  • off(event: "detach", listener: detach): this
  • off(event: "firstScanDone", listener: firstScanDone): this

  • Remove previosly setup event handler for attach device events.

    Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

    Parameters

    • event: "attach"
    • listener: attach

    Returns this

  • Remove previosly setup event handler for detach device events.

    Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

    Parameters

    • event: "detach"
    • listener: detach

    Returns this

  • Remove previosly setup event handler for firstScanDone device events.

    Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

    Parameters

    Returns this

on

  • on(event: "attach", listener: attach): this
  • on(event: "detach", listener: detach): this
  • on(event: "firstScanDone", listener: firstScanDone): this

  • Add event handler for attach device events. The attach event is particulary important, since this callback is where you get a reference to a DeviceType object with detailed API for the device.

    Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

    Parameters

    • event: "attach"
    • listener: attach

    Returns this

  • Add event handler for detach device events.

    Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

    Parameters

    • event: "detach"
    • listener: detach

    Returns this

  • Add event handler for firstScanDone device events.

    Please make sure your callback arguments matches the event type or you will get a misleading typescript error. See also 30843

    Parameters

    Returns this

preloadDeviceInfoAsync

  • preloadDeviceInfoAsync(zipFileName: string): Promise<void>

  • Preloads the resources with the content of the specified archive.

    Parameters

    • zipFileName: string

    Returns Promise<void>

    • if operation failed, reject with JabraError.

scanForDevicesDoneAsync

  • scanForDevicesDoneAsync(): Promise<void>

  • Wait for initial device scan to be done.

    Returns Promise<void>

setSoftphoneReadyAsync

  • setSoftphoneReadyAsync(isReady: boolean): Promise<void>

  • Sets the softphone to Ready. Currently applicable for only Jabra Direct.

    Parameters

    • isReady: boolean

      Sets the softphone readiness state.

    Returns Promise<void>

    • Resolve void if successful otherwise Reject with error.

This API Reference is provided by Jabra Developer Zone.