Invox Dictation SDK Version:

Other Functions


Functions related to getting session information and other utilities.

GetUserInfo

FunctionDescriptionParametersReturns
INVOX.GetUserInfo()Returns information about the currently logged-in user.—Object
const user = INVOX.GetUserInfo();
console.log(user.Name);

GetCurrentSession

FunctionDescriptionParametersReturns
INVOX.GetCurrentSession()Returns information about the current session.—Object
const session = INVOX.GetCurrentSession();

GetSpecialtyDictionary

FunctionDescriptionParametersReturns
INVOX.GetSpecialtyDictionary()Returns the specialty dictionary repository.—Object
const dict = INVOX.GetSpecialtyDictionary();

GetSpecialtyTemplateRepository

FunctionDescriptionParametersReturns
INVOX.GetSpecialtyTemplateRepository()Returns the specialty template repository.—Object
const templates = INVOX.GetSpecialtyTemplateRepository();

ShowHelp

FunctionDescriptionParametersReturns
INVOX.ShowHelp()Opens the Invox Dictation help viewer.—void
INVOX.ShowHelp();

Help URLs and handler

FunctionDescriptionParametersReturns
INVOX.GetUserGuideHelpUrl()Returns the configured User Guide URL, if available.—String
INVOX.GetSupportUrl()Returns the configured support URL, if available.—String
INVOX.OnClickHelp(callback)Registers the callback executed when the user requests help.Functionvoid
const userGuideUrl = INVOX.GetUserGuideHelpUrl();
const supportUrl = INVOX.GetSupportUrl();

INVOX.OnClickHelp(() => {
  window.open(userGuideUrl || supportUrl, "_blank", "noopener");
});