KioApp Class
This class provides support for calling application-level functions in KioWare. Methods in this class can provide or alter application state, such as detecting whether a session is active, forcing a session to end or begin, and getting KioWare process information.
Most functions run synchronously, unless noted.
Methods
Type | Signature |
int |
GetLastUserActivityTime()
Returns the number of milliseconds that represents a timestamp for when the last user activity such as mouse movement or keyboard input occurred. |
int |
GetRev()
Gets the KioWare revision number. |
string |
GetProperty(string name)
Gets a KioWare property by name. |
int64 |
GetProcessUptime()
Gets the KioWare process uptime in system ticks. |
int64 |
GetProcessUptimeMs()
Gets the KioWare process uptime in milliseconds. |
bool |
IsUrlBlocked(string url, bool notifyBlock = false)
Checks the browsing ACL to determine if a URL would be blocked or not. |
bool |
InjectJavaScript(string, string, bool, KioBrowserWndType, KioBrowserType)
Injects JavaScript into the selected browsers. |
string |
GetToolbarSettings()
Gets JSON encoded settings for the calling toolbar browser. |
bool |
IsSessionActive()
Detects if there is a KioWare user session or not. |
void |
BeginSession()
Starts a KioWare user session, or extends the current session. |
void |
EndSession()
Ends the KioWare user session. |
void |
RestartKioware(bool)
Causes the KioWare process to exit and restart. |
void |
StartKeyboard(string url = '', string elTagName = '', string elType = '', bool keepUpIfEl = false, string elId = '', string elName = '')
Runs the configured virtual keyboard. |
void |
CloseKeyboard(int delayMs = 0)
Closes the virtual keyboard. |
void |
IsKeyboardShowing()
Detects if the virtual keyboard is showing or not. |
void |
LogInfo(string msg)
Logs an informational log to the KW Platform event log. |
void |
LogWarn(string msg)
Logs a warning log to the KW Platform event log. |
void |
LogErr(string msg)
Logs an error log to the KW Platform event log. |
void |
LogDiag(string msg)
Logs a diagnostics log to the KW Platform event log. |
string |
CreateAppLog(string groupName = null, string msg = null)
Creates a KioWare app log entry. |
string |
CreateAppLog(string groupName = null, string msg = null)
Creates a KioWare app log entry. |
string |
AddAppLogData(string appLogId, string name = null, string value = null)
Adds more data to an existing app log entry. |
string |
DoUrlSubstitution(string url, int replacementMode = 2)
Performs URL substitutions on the provided URL. |
void |
Exit()
Exits KioWare without prompting. |
bool |
ExitPrompt()
Prompts for exit. |
bool |
ExitActionHandler(string password)
Executes the exit action handler identified by password. |
KioBrowserWndType |
GetKioBrowserWndType()
Returns the KioWare window type of the calling browser. |
int |
SetDockedElementsVisible(bool visible = null, string name = null, ElementType elTypeMask = 0xFFFFFFFF, KioBrowserWndType wndTypeMask = 0xFFFFFFFF)
Controls the visibility of docked elements such as toolbars and docked browsers. |
bool |
StartScreenReader()
Starts a configured screen reader, and returns true if successful. |
void |
StopScreenReader()
Stops the screen reader. |
bool |
IsScreenReaderRunning()
Indicates the running state of the screen reader. |
Related Types
Type | Signature |
Enum |
KioBrowserWndType
A list of browser window types in KioWare. |
Enum |
KioBrowserType
A list of browser types in KioWare. |