Essential Functions

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

Login

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

Parameters:

• credentials: Object
  • user: String — the user's login name.
  • password: String — the user's password.
• connectionConfig: Object
  • host: String — sets the host.
  • port: String — sets the port.
  • useDictationService: Boolean — true for Remote Dictation Service, false for Local Dictation Service.

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

const credentials = {
    user: "example",
    password: "example",
}
const connectionConfig = {
    host: "example.cloud.net",
    port: "8443",
    useDictationService: true
}

INVOX.Login(credentials, connectionConfig)
    .then(() => alert("Successful connection!"))
    .catch((e) => console.error(e));

Logout

INVOX.Logout()
    .then(() => console.log("Logged out successfully"))
    .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();