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()
The number of milliseconds, as a timestamp, for the most recent user activity
string getProperty(string)
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)
Checks the browsing ACL to determine whether a URL would be blocked
bool isSessionActive()
Detects if there is a KioWare user session active
void beginSession()
Starts a KioWare user session, or extends the current session
void endSession()
Ends the KioWare user session
void restartKioware()
Causes the KioWare process to exit and restart
void startKeyboard()
Runs the configured virtual keyboard
void closeKeyboard(int)
Closes the virtual keyboard
void isKeyboardShowing()
Detects if the virtual keyboard is showing or not
void logInfo(string)
Logs an informational message to the system logs
void logWarn(string)
Logs a warning message to the system logs
void logErr(string)
Logs an error message to the system logs
void logDiag(string)
Logs a diagnostics message to the system logs
string doUrlSubstitution(string, int)
Performs URL substitutions on the provided URL
void exit()
Bypasses configured exit patterns and exits KioWare without prompting for a passcode
bool exitPrompt()
Bypasses configured exit patterns and displays the exit passcode prompt
bool exitActionHandler(string)
Executes the exit action handler identified by password
string createAppLog(string, string)
Creates an app log entry on KioWare Server
string addAppLogData(string, string, string)
Adds data to an app log entry on KioWare Server
string addAppLogDataInt64(string, string, long)
Adds integer data to an app log entry on KioWare Server
string addAppLogDataDouble(string, string, double)
Adds double data to an app log entry on KioWare Server
string addAppLogDataBool(string, string, bool)
Adds boolean data to an app log entry on KioWare Server
string addAppLogDataDate(string, string, string, int)
Adds date data to an app log entry on KioWare Server
DockedUIToolbar getToolbarSettings()
Gets the settings for the calling toolbar browser
bool isOutOfService()
Checks whether out of service mode is enabled
void setOutOfServiceMode(bool)
Enables or disables out of service mode

Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.