SiteCafe Object

---

 
Main object of the SiteCafe Manager object model.

Members Table

The following table lists the members provided by the SiteCafe object.

Members

Objects	Description
Config	IXMLDOMNode object of the SiteCafe configuration.
LocaleManager	Provides locale information.
MainWindow	Represents the main window of the SiteCafe Manager.
Server	SiteCafe server functionality.
UserInterface	Provides creating user interface elements.
Properties	Description
ModulePath	Path of the SiteCafe module.
OSMajorVersion	Operating System major version number.
OSMinorVersion	Operating System minor version number.
Methods	Description
ConfigureDatabase	Shows the database configuration dialog.
CreateCurrencyFormatter	Creates an object providing currency functionality.
CreateDateTimeFormatter	Creates an object providing date/time functionality.
CreateScript	Creates a new script object.
PumpMessages	Peeks and dispatches messages.
Quit	Quits the SiteCafe Manager.
SaveConfig	Saves the configuration.
Events	Description
OnEndSession	Fires when a session ends.
OnTrayIcon	Fires when the tray icon is displayed.
OnTrayPopup	Fires when the tray icon's shortcut menu is displayed.

Remarks

This object is available in the form of scripts when you are using the SiteCafe Manager. Use the SiteCafe object to manage user accounts. The SiteCafe object can be referenced directly.

Before you can use the SiteCafe objects you need to call the function window.external.InitScriptInterface() to initialize the script interface.

Use the SiteKiosk.Plugins("SiteCash").Devices("SiteCafeClient") object for client functionality.

Note that this object is only available in the SiteCafe Manager.

Examples

The following example displays the SiteCafe module path.

<SCRIPT TYPE="text/javascript"> window.external.InitScriptInterface(); alert(SiteCafe.ModulePath); </SCRIPT>

Applies to

SiteKiosk v6.2 (and later versions).

---

Back to top