All properties
- adminMessageHeader
- The html text displayed in front of an Administrator message in the main chat area.
- autoConnect
- Enable/disable the Connector's "auto-connect" feature.
- autoHide
- Hide the LoginBox control before connection to SmartFoxServer and after a successful login.
- banButton
- A reference to the "ban" Button control.
- banButtonText
- The label of the "ban" button.
- banMessage
- The message sent to a user when being banned by the Moderator.
- buttonText
- The label of the "login" button.
- cancelButton
- A reference to the "cancel" Button control.
- chatTextArea
- A reference to the chat TextArea control.
- CLEAR_CLICK public static constant property
- clearButton
- A reference to the "clear" Button control.
- colorPicker
- A reference to the ColorPicker control.
- configPath
- The path to the client configuration xml file.
- connectedMessage
- The message displayed by the Connector after a successful connection to SmartFoxServer.
- connectingMessage
- The message displayed by the Connector while attempting to connect to SmartFoxServer.
- connection
- A reference to the SmartFoxClient class instance.
- connectionFailedMessage
- The message displayed by the Connector if the connection attempt failed.
- connectionLostMessage
- The message displayed by the Connector if the connection with SmartFoxServer was lost.
- customLoginPage
- The custom server-side page url for access credentials validation.
- debug
- Enable/disable the Connector's debugging feature.
- defaultRoom
- The default room to be joined after a successful login.
- enablePrivateChat
- Enable/disable private chat and moderation features.
- errorsDisplayTime
- The number of seconds that error messages must remain visible for.
- errorTextField LoginBox
- A reference to the "error" UITextField component.
- errorTextField RoomList
- A reference to the "error" UITextField component.
- formLayout
- The layout of the login form controls.
- groupByRoomType
- groupMessages
- Group messages per sender.
- iconFunction RoomList
- A reference to a custom method to be invoked when instantiating the room icon.
- iconFunction UserList
- A reference to a custom method to be invoked when instantiating the user icon.
- initialMessage
- The initial message to be displayed inside the message input field.
- inputLabelText
- The text of the label located above the message input field.
- isConnected
- A flag stating if the connection to SmartFoxServer is available.
- joinButton
- A reference to the "join/play" Button control.
- joinButtonText
- The label of the "join" button.
- kickButton
- A reference to the "kick" Button control.
- kickButtonText
- The label of the "kick" button.
- kickMessage
- The message sent to a user when being kicked by the Moderator.
- LABEL_PLACEMENT_LEFT public static constant property
- Status label placement to the left of the icon.
- LABEL_PLACEMENT_RIGHT public static constant property
- Status label placement to the right of the icon.
- labelFunction RoomList
- A reference to a custom method to be invoked when rendering the room labels, to set their text.
- labelFunction UserList
- A reference to a custom method to be invoked when rendering the user labels, to set their text.
- labelPlacement
- The orientation of the status label in relation to the icon.
- LAYOUT_COLUMN_CENTER public static constant property
- Login form layout: input fields, labels and button draw up in column, center aligned.
- LAYOUT_COLUMN_LEFT public static constant property
- Login form layout: input fields, labels and button draw up in column, left aligned.
- LAYOUT_COLUMN_RIGHT public static constant property
- Login form layout: input fields, labels and button draw up in column, right aligned.
- LAYOUT_ROW public static constant property
- Login form layout: input fields and button in a row with labels above the input fields, left aligned.
- LAYOUT_SIDE_BOTTOM public static constant property
- Login form layout: input fields and labels draw up in column, left aligned; login button on their right side, aligned to the password input field.
- LAYOUT_SIDE_MIDDLE public static constant property
- Login form layout: input fields and labels draw up in column, left aligned; login button on their right side, centered between the input fields.
- LAYOUT_SIDE_TOP public static constant property
- Login form layout: input fields and labels draw up in column, left aligned; login button on their right side, aligned to the username input field.
- list RoomList
- A reference to the inner List control.
- list UserList
- A reference to the inner List control.
- loginButton
- A reference to the "login" Button control.
- messageHeader
- The html text displayed in front of a message in the main chat area.
- messageLabel
- A reference to the message input Label control.
- messageQueue
- The queue of sent and received messages.
- messageTextInput
- A reference to the message TextInput control.
- moderateLabel
- A reference to the "moderation module" Label control.
- moderateLabelText
- The text of the label located above the moderation buttons.
- moderatorMessageHeader
- The html text displayed in front of an Moderator message in the main chat area.
- newPrivateMsgLabelColor
- The color of the user label when a private message is received.
- noGuestLoginMsg
- The error message to be displayed in case of guest login attempt.
- notConnectedMessage
- The message displayed by the Connector before attempting to connect to SmartFoxServer.
- params
- An Object containing the event's parameters.
- passwordLabel LoginBox
- A reference to the "password" Label control.
- passwordLabel RoomList
- A reference to the "password" Label control.
- passwordLabelText LoginBox
- The text of the label located above the password text input.
- passwordLabelText RoomList
- The text of the label located above the password input field.
- passwordTextInput LoginBox
- A reference to the "password" TextInput control.
- passwordTextInput RoomList
- A reference to the "password" TextInput control.
- playButtonText
- The label of the "play" button.
- privateChatBox
- A reference to the "private chat" ChatBox control.
- privateChatLabel
- A reference to the "private chat module" Label control.
- privateChatLabelText
- The text of the label located above the private chat module.
- privateChatMode
- Enable/disable the "private chat" mode.
- privateChatUserId
- The SmartFoxServer ID of the user that the ChatBox is listeng to in "private chat" mode.
- restrict ChatBox
- The set of characters that a user may or may not enter into the message input field.
- restrict LoginBox
- The set of characters that a user may or may not enter into the username and password text inputs.
- ROOM_CHANGE public static constant property
- Dispatched by the RoomList component when the selected room is changed.
- roomJoinAlert
- The html text displayed in the main chat area when the current user joins the chat room.
- rowHeight RoomList
- The height of the list items.
- rowHeight UserList
- The height of the list items.
- sendButton
- A reference to the "send" Button control.
- sendButtonText
- The label of the "send" button.
- serverIpAddress
- The IP address of the server on which the SmartFoxServer instance is running.
- serverPort
- The TCP port of the server on which the SmartFoxServer instance is running.
- showChatRooms
- Show/hide the chat rooms inside the list.
- showClearButton
- Show/hide the "clear" button.
- showColorPicker
- Show/hide the color picker tool.
- showGameRooms
- Show/hide the game rooms inside the list.
- showIcons RoomList
- Show/hide the room icons.
- showIcons UserList
- Show/hide the user icons.
- showLimboRooms
- Show/hide the limbo rooms inside the list.
- showPassword
- Show/hide the password text input and label.
- showPrivateRooms
- Show/hide the private rooms (independently of their type).
- smartFox Connector public static property
- sortOrder RoomList
- The rooms' sorting order.
- sortOrder UserList
- The users' sorting order.
- status
- The current connection status.
- STATUS_CONNECTED public static constant property
- Connection to SmartFoxServer was established successfully.
- STATUS_CONNECTING public static constant property
- Connection to SmartFoxServer is in progress.
- STATUS_CONNECTION_FAILED public static constant property
- Connection to SmartFoxServer failed (server can't be reached).
- STATUS_CONNECTION_LOST public static constant property
- Connection to SmartFoxServer was lost (due to idle time limit exceeded, user kicked or banned, etc).
- STATUS_NOT_CONNECTED public static constant property
- Connection to SmartFoxServer not yet established.
- statusLabel
- A reference to the Connector's status Label control.
- systemAlertsColor
- The default color of system messages in the main chat area.
- USER_CHANGE public static constant property
- Dispatched by the UserList component when the selected user is changed.
- userEnterRoomAlert
- The html text displayed in the main chat area whenever a user enters the current chat room.
- userLeaveRoomAlert
- The html text displayed in the main chat area whenever a user leaves the current chat room.
- usernameLabel
- A reference to the "username" Label control.
- usernameLabelText
- The text of the label located above the username text input.
- usernameTextInput
- A reference to the "username" TextInput control.
- VERSION ChatBox public static constant property
- Version string for this class.
- VERSION Connector public static constant property
- Version string for this class.
- VERSION LoginBox public static constant property
- Version string for this class.
- VERSION RoomList public static constant property
- Version string for this class.
- VERSION UserList public static constant property
- Version string for this class.
- watchButton
- A reference to the "watch" Button control.
- watchButtonText
- The label of the "watch" button.
- zone
- The SmartFoxServer zone (application) to log in to.