AddonChat supports the ability to pass information to the chat client and server directly using the provided link code through the use of Java applet parameters.
Applet parameters can only be used with the embedded link code and should be placed just before the </applet> portion of the link code.
Applet parameters may override your users' own settings, and any cookies stored in a user's browser.
Additional notes are provided after this table regarding special some special parameter requirements and parameter value types.
|
Applet Parameters
| Parameter Name |
Description |
Example |
| autologin |
Automatic Login |
<param name="autologin" value="yes"> |
| username |
Default Username |
<param name="username" value="Johnny B. Goode"> |
| password |
Default User Password |
<param name="password" value="12345"> |
| subroom |
Default Subroom |
<param name="subroom" value="The Lobby"> |
| timestamp |
Enable/Disable Timestamp |
<param name="timestamp" value="yes"> |
| audio |
Enable/Disable Audio |
<param name="audio" value="no"> |
| mycolor |
Default User Color |
<param name="mycolor" value="#cc8888"> |
| myfont |
Default User Font |
<param name="myfont" value="Verdana-PLAIN-12"> |
| user.show.emoticons |
Enable/Disable Emoticon |
<param name="user.show.emoticons" value="yes"> |
| user.show.enhanced |
Enable/Disable Markup |
<param name="user.show.enhanced" value="true"> |
| user.show.avatar |
Enable/Disable Avatars |
<param name="user.show.avatar" value="yes"> |
| user.ignore.im |
Ignore/Receive Instant Messages |
<param name="user.ignore.im" value="false"> |
| rndname |
Auto-generate random username |
<param name="rndname" value="true"> |
| url.exit |
Exit URL (See url.exit.enable)
|
<param name="url.exit" value="http://addonchat.com"> |
| url.exit.enable |
Enable Exit URL
|
<param name="url.exit.enable" value="true"> |
| username.prompt.readonly |
Make username prompt read-only
|
<param name="username.prompt.readonly" value="true"> |
| password.prompt.readonly |
Make password prompt read-only
|
<param name="password.prompt.readonly" value="true"> |
| password.prompt.after.initial |
Show password prompt after initial login attempt.
|
<param name="password.prompt.after.initial" value="true"> |
| login.prompt.after.autologin |
Show login prompt after failed auto-login attempt
|
<param name="login.prompt.after.autologin" value="true"> |
| subroom.single |
Only show current sub-room to user
|
<param name="subroom.single" value="true"> |
|
The subroom applet parameter can only be used with Enterprise-25 accounts and higher. When used in conjunction with the autologin, username, and password parameters, the subroom parameter can be used to automatically log a user in and place him/her in a specific room.
The new subroom.single parameter (introduced in AddonChat v8.5) allows Enterprise edition accounts to show only the specified subroom to the end-user. This parameter should be used in conjunction with both the subroom and autologin parameters.
Color values should be in 6 digit RGB hexadecimal; the same as used in the control panel and should begin with the '#' character; though it is not required for most applet parameters. Font values should be of the form Name-Style-Size; where Name is any valid system font name; Style is one of PLAIN, BOLD, ITALIC or BOLD+ITALIC; and size is an integer between 6 and 48.
For boolean type entries (i.e., audio), a single 1 (one), true, yes, or on may be used to enable the option. Similarly, a single 0 (zero), false, no, or off may be used to disable the option.
