# SiteKiosk Object Main object of the SiteKiosk object model. Members Table The following table lists the members provided by the SiteKiosk object.
Members
Objects | Description
CDRecording | Provides CD recording functionality.
Clipboard | Controls the clipboard.
Config | Represents the SiteKiosk configuration.
Dialup | Controls the dial-up connection.
Effects | Provides slide effects.
Email | To send E-Mails.
Favorites | Current favorites settings.
GeoLocation | Provides geolocation settings.
Keyboard | Handles the touch screen keyboard.
LocaleManager | Manages the system language.
Logfile | Creates log file entries.
Multimedia | Controls the soundcard settings.
Network | Provides network functionality and information.
Printer | Handles existing printers and print jobs.
RootApp | SiteKiosk RootApp object.
Scheduler | Manages timed events.
ScreenSaver | Controls the screensaver.
ScriptDispatch | Represents the configured browser script.
SecondMonitorBrowser | Controls the player on the 2nd monitor.
Security | Information about the restricted user account.
SiteKioskUI | Handles SiteKiosk dialogs and tooltips.
SiteSkin | Provides information about the current browser skin.
StartSettings | Controls the SiteKiosk start settings.
URLs | Contains predefined URLs.
Version | Provides information about SiteKiosk.
WindowList | Controls all opened SiteKiosk windows.
XML | Provides read and write access to xml files.
Collections | Description
ExternalApps | Information about external applications.
Plugins | Provides access to SiteKiosk plugins.
Properties | Description
ComputerGUID | The computer's globally unique identifier (GUID).
ComputerName | Name of the computer.
ProcessID | Process ID of SiteKiosk.
ShutdownMode | SiteKiosk shutdown mode.
SiteKioskDirectory | Main directory of the application.
Methods | Description
AttachScriptInterfaces | Attaches the SiteKiosk objects to a browser.
DeleteTempInternetFiles | Deletes temporary internet files.
DeleteTempInternetFilesAndCertificates | Deletes temporary internet files and personal certificates.
LoadScript | Loads a script file.
LogoffWindows | Terminates SiteKiosk and logs out the current user.
Logout | Processes the configured logout actions.
Quit | Terminates SiteKiosk.
RebootWindows | Reboots Windows.
Reset | Resets SiteKiosk.
Restart | Restarts SiteKiosk.
SaveLocalConfig | Saves the local configurations of the plugins.
ShowPasswordDialog | Shows the SiteKiosk password dialog.
ShutdownWindows | Terminates SiteKiosk and shuts down Windows.
Events | Description
OnAddPlugin | Fires when a plugin is added.
OnConfigLoaded | Fires when the configuration has been loaded.
OnQuit | Fires while SiteKiosk is terminated.
OnQuit2 | Fires while SiteKiosk is terminated.
OnRemovePlugin | Fires when a plugin is removed.
OnReset | Fires when SiteKiosk has been reset.
Remarks This object is available in the form of scripts when you are using SiteKiosk. Use the SiteKiosk object to examine or modify the running SiteKiosk application. The SiteKiosk object can be referenced directly. Before you can use the SiteKiosk objects in a script you need to call the function window.external.InitScriptInterface() to initialize the script interface. Note that the path of a file using SiteKiosk objects must be allowed in the SiteKiosk configuration (Security -> Access -> URL's With Script Permission) if it is not a browser skin file. Examples The following example ckecks for the browser and shows the ProcessID property if SiteKiosk is used.
    <SCRIPT TYPE="text/javascript">
    function InitSiteKiosk()
    {
       try
       {
          window.external.InitScriptInterface();
       }
       catch(e)
       {
          return false;
       }
       return true;
    }
    if (InitSiteKiosk())
    {
       document.write("ProcessID: " + SiteKiosk.ProcessID);
    }
    else
    {
       document.write("You have to use the SiteKiosk browser");
    }
    </SCRIPT>
Applies to SiteKiosk v5.0 (and later versions). Back to top