Essential Functions

Essential functions to implement the basic functionality of Invox Dictation SDK.

Init

Initialize SDK configuration before calling Login.

Parameters:

config: Object with the following properties. All values are provided by Invox Medical for your integration; do not invent your own.

• organizationId: String — required. Identifier of your organization in Invox Medical. Use the exact value provided by Invox Medical.
• appId: String — optional. Identifier of the application that integrates the SDK. Provide it when Invox Medical has issued application credentials for your integration.
• apiKey: String — optional. API key associated with appId. Provide it together with appId.
• transcriptionServiceUrl: String — optional. URL of the Remote Dictation Service (speech recognition). Defaults to wss://debug.invoxmedical.com, which is a debug environment. Provide a value whenever you connect to any other environment (for example, UAT or production) or to a dedicated Dictation Service; use the URL provided by Invox Medical.
• adminServiceUrl: String — optional. URL of the Corporate Server used for authentication and user data. Defaults to https://debug.invoxmedical.com/INVOX/, which is a debug environment. Provide a value whenever you connect to any other environment (for example, UAT or production) or to your organization's own Corporate Server; use the URL provided by Invox Medical.

import INVOX, { InitializationConfigType } from "@invox-medical-npm/invox-dictation";

const config: InitializationConfigType = {
    organizationId: "provided_organization_id",
    appId: "provided_app_id",
    apiKey: "provided_api_key",
    transcriptionServiceUrl: "provided_transcription_service_url",
    adminServiceUrl: "provided_admin_service_url",
};

INVOX.init(config);

Login

Allows you to login a user into Invox Dictation SDK using a username and password. This function also establishes communication with the Dictation Service.

Before calling Login, initialize the SDK connection context with INVOX.init(...).

Parameters:

• credentials: Object
  • user: String — the user's login name.
  • password: String — the user's password.

Returns: Promise<void> — The promise indicates successful connection, not successful login.

import INVOX, { InitializationConfigType, LoginCredentialsType } from "@invox-medical-npm/invox-dictation";

const config: InitializationConfigType = {
    organizationId: "provided_organization_id",
};

INVOX.init(config);

const credentials = {
    user: "example",
    password: "example",
};

const typedCredentials: LoginCredentialsType = credentials;

try {
  await INVOX.Login(typedCredentials);
} catch (e) {
  console.error(e);
}

Logout

try {
  await INVOX.Logout();
} catch (e) {
  console.error(e);
}

SwitchDictation

INVOX.SwitchDictation();

SetTextWriter

Parameters:

• writer: Object — an instance of a TextWriter. Use INVOX.TextAreaTextWriter for standard HTML TextAreas, or a custom writer for other editors.

// For standard HTML TextArea
INVOX.SetTextWriter(INVOX.TextAreaTextWriter);

// For a custom writer
INVOX.SetTextWriter(myCustomWriter);

SetWriterTarget

const textareaElement = document.getElementById("invox-textarea-1");
INVOX.SetWriterTarget(textareaElement);

GetWriterTarget

const currentTarget = INVOX.GetWriterTarget();

ShowHelp

INVOX.ShowHelp();