Chat Object

---

 
The Chat object provides chat functionality.

Members Table

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

Members

Properties	Description
Enabled	Whether chatting is enabled.
LoggedIn	Whether the user is logged in.
Nickname	Current nickname.
SessionIndex	Session index.
Methods	Description
GetUser	Returns a chat user.
GetUsers	Returns a range of chat users.
SendChatMessage	Sends a message.
Events	Description
OnChatUserConnect	Fires when a user connects.
OnChatUserDisconnect	Fires when a user disconnects.
OnTextMessage	Fires when a message has been received.

Remarks

This object is available through the object Server. Use the Chat object to send or receive messages.

Examples

The following example determines whether chatting is enabled and displays it.

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

Applies to

SiteKiosk v6.2 (and later versions).

---

Back to top