# SiteCafeClient Object The SiteCafeClient object provides SiteCafe client functionality. Members Table The following table lists the members provided by the SiteCafeClient object.
Members
Objects | Description
Chat | Provides chat functionality.
Script | Controls the SiteCafe script.
Properties | Description
AccountCreated | Creation date of the account.
AccountIndex | Index number of the account.
Balance | Current balance.
BonusActivated | Whether bonus is active (surfmiles).
BonusAmount | Contains the bonus amount.
BonusLimit | Contains the bonus limit.
ComputerName | Name of the computer.
Connected | Whether the terminal is connected to the server.
CurrentBonus | Spending that is relevant for the next bonus.
DisableDevices | Whether devices are disabled.
Duration | Remaining/spent surftime (depends on mode).
EnableCodes | Whether code login is enabled.
EnableMoney | Whether money mode is enabled.
EnableTime | Whether time mode is enabled.
EnableUsers | Whether username/password login is enabled.
ExpireDuration | Expiry duration after a logout.
ExpiryDate | Date of expiration.
FirstLogin | First login date.
LastLogin | Last login date.
Mode | Payment mode.
PersistentAccount | Whether the account is persistent.
SessionIndex | Index number of the session.
SessionRunning | Whether a session is currently running.
UserIndex | Index number of the user.
Username | Name of the user.
ValidDuration | Duration the account will be valid after the activation.
Methods | Description
ChangePassword | Changes the current password.
CreateUser | Creates a new user.
Credit | Increases the credit.
Debit | Decreases the credit.
EncodeFile | Encodes a file.
GetProperties | Requests a list of user properties.
GetProperty | Requests a user property.
LoginCode | Login using a code.
LoginUser | Login using username and password.
Logout | Logout.
MergeCodeAccount | Merges the account using a code.
MergeUserAccount | Merges the account using username and password.
SendCustomMessage | Sends a message to the server.
SendJavascriptReturnValue | Sends a Javascript return value to the server.
SetProperties | Sets a list of user properties.
SetProperty | Sets a user property.
Events | Description
OnAccountMerged | Fires when an account has been merged.
OnBeginSession | Fires when a session begins.
OnBonusGranted | Fires when bonus has been granted (surfmiles).
OnComputerNameChanged | Fires when the computer name changed.
OnConnect | Fires when a connection has been established.
OnCreateUser | Fires when a user has been created.
OnCustomMessage | Fires when a message has been received.
OnDisconnect | Fires when the terminal has been disconnected.
OnEndSession | Fires when a session ends.
OnExecuteJavascript | Fires when a Javascript has been executed.
OnLogonFailed | Fires when an error occured during logon.
OnLogonSuccess | Fires when a logon succeeded.
OnLogout | Fires when a logout succeeded.
OnPropertyReceived | Fires when a requested property has been received.
Remarks This object is available through the collection Devices. Use the SiteCafeClient object to interact with the SiteCafe server. This device can be activated in the SiteKiosk configuration. Use the SiteCafe main object within the SiteCafe Manager for server functionality. 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 displays the computer name.
    <SCRIPT TYPE="text/javascript">
    window.external.InitScriptInterface();
    SiteCafe = SiteKiosk.Plugins("SiteCash").Devices("SiteCafeClient");
    alert(SiteCafe.ComputerName);
    </SCRIPT>
Applies to SiteKiosk v6.2 (and later versions). Back to top