Chat Essentials Home

Chat Essentials Forum
 

Home Online Manual Remote Administration Guide GlassRoom Applet Parameters
Applet parameter Type Meaning
nick String User's preferred nickname
realName String User's real username
gender (male/female/_) User's gender
iconNo number User's default icon number
country String User's country
age number User's age
theme String Theme name (default is "default")
ban_enabled (true/false) Show/hide ban button
send_file_enabled (true/false) Show/hide send file button
password_enabled (true/false) User can enter password in login process
voice_enabled (true/false) Is voice enabled ?
private_voice_enabled (true/false) Show/hide private voice chat button
flood_time number (seconds) Time for flood control
flood_counter number Number of messages that if sent in flood_time, make the user exited
defaultRoom String Default user room
icon_rows number Number of icon table's rows. between 1 and 30 (default is 3)
icon_cols number Number of icon table's columns. between 1 and 30 (default is 6)
logofile String URL of top logo image file
register_url String URL of your registration form. Don't set this parameter to disable this feature. ( note: password_enabled parameter must be set to true )
forgot_password_url String URL of your "forgot password" form. Don't set this parameter to disable this feature. ( note: password_enabled parameter must be set to true )
edit_profile_url String URL of your "edit profile" form. Don't set this parameter to disable this feature. ( note: password_enabled parameter must be set to true )
extra_link_N_caption String Caption of your N'th extra link ( note: password_enabled parameter must be set to true) 

You can add some links in login page through this parameter. N is number of the current link and starts from 1 to number of links

extra_link_N_url String URL of your N'th extra link ( note: password_enabled parameter must be set to true )
direct_port number Server's direct  port
servlet_port number Servlet port
in_frame (true/false) Is applet shown in separate window ?  "false" value means that applet must be embedded in page.
use_parameter_nick_only (true/false) User can not change nickname and can not enter/edit nickname in login page. Nickname must be defined by applet parameters only.
guest_login_visible (true/false) Show/hide "Guest login" checkbox. This option disappears the button,  but the guest login functionality must be prevented from server.
toolbar_at_right (true/false) Move the toolbars to right side of chat page. You must use a vertical image for "logofile" in this case.
list_frame_ditachable (true/false) User can detach the lists frame.
user_pane_icons_cols number Number of icons columns below the users list. (Usually 2 or 3 or 6)
one_time_press_talk_button (true/false) No need to hold the T or F9 key while speaking.
title_font_name String Name of messages' title font face. You can choose one of these values :
Serif, SansSerif, Monospaced, Dialog, and DialogInput.
title_font_style String Style of messages' title font :
"B" stands for bold
"I" stands for italic
"BI" stands for bold-italic
title_font_size number Size of messages' title font
message_font_name String Name of messages' font face. You can choose one of these values :
Serif, SansSerif, Monospaced, Dialog, and DialogInput.
message_font_style String Style of messages' font :
"B" stands for bold
"I" stands for italic
"BI" stands for bold-italic
message_font_size number Size of messages' font
screen_font_name String Name of screen font face. You can choose one of these values :
Serif, SansSerif, Monospaced, Dialog, and DialogInput.
screen_font_style String Style of screen font :
"B" stands for bold
"I" stands for italic
"BI" stands for bold-italic
screen_font_size number Size of screen font
show_all_disabled (true/false) Disables "Show all users" button.
auto_start_voice (true/false) Enables voice control when user logins.
user_extra_link_N_url String URL of your N'th user extra link 

You can add some links in user list pane through this parameter. N is the number of the current link and starts from 1 to number of links

GlassRoom sends these parameters through GET method to the specified URL :

user:   Current user
target:  Target user ( Empty if no user selected in user list pane)
serverIP: IP address of server
sp: Servlet port ( for communicating to GlassRoom server )
dp: Direct port
vp: Voice Port
sessionID: session id for this user.
serverName: Internal name of server.

Note : Each button must have a URL.

user_extra_link_N_image String Image name of your N'th user extra link 

You must include this image for each theme. Indeed, If your image name is x.gif and your current theme is blue, It will map to themes/blue/but/x.gif

user_extra_link_N_caption_id String Caption of your N'th user extra link 

You must define this ID in each language file. For example if you set this parameter to USER_EXTRA_BUTTON_CAPTION_MAIL , you must also define this line in english.cfg file :

USER_EXTRA_BUTTON_CAPTION_MAIL="mail to user"

NOTE : This parameter is not appear in screen, It is reserved for future use.

user_extra_link_N_help_id String Help message of your N'th user extra link 

You must define this ID in each language file. For example if you set this parameter to USER_EXTRA_BUTTON_HELP_MAIL , you must also define this line in english.cfg file and other language files :

USER_EXTRA_BUTTON_HELP_MAIL="Use this button to send email to this user"

remove_lists_pane (true/false) Removes all the lists : Users, Rooms, and buddies.
buddies_enabled (true/false) Removes the buddy list and it's buttons

 

Example HTML tag :
<applet

	code=Nayebi.IRC2.class

	archive="icons.zip"

	name="GlassRoom Chat" MAYSCRIPT

	width=100%

	height=100%

	>

<param name=theme value="simple" >

<param name=direct_port value="7100" >

<param name=servlet_port value="8100" >

<param name=icon_rows value=8 >

<param name=icon_cols value=2 >

<param name=edit_profile_url value="http://127.0.0.1:8100/servlet/grs.GlassRoomServlet?page=selfProfile" >

<param name=register_url value="http://127.0.0.1:8100/servlet/grs.GlassRoomServlet?page=register" >

<param name=extra_link_1_caption value="Rules">

<param name=extra_link_1_url value="http://www.yourCompany.com/glassroom/rules.html">

<param name=extra_link_2_caption value="Help">

<param name=extra_link_2_url value="http://www.yourCompany.com/chat/help.html">

<param name=enabled_voice value=true >

</applet>