Webchat Lite

Overview

The Webchat Lite application is a smaller and simplier version of our Webchat application. The primary difference in the two applications is that Webchat Lite does not have any AV support and is a strictly text-only experience. The Webchat Lite can be embed inside of the Presence Bar, as an embeded stand alone application, and a popup experience.

Properties

Property	Description	Required
roomId	The room identifier you wish to embed.	Yes
containerId	That container element that you wish to render the Webchat Lite application.	Yes
autoJoin	Whether or not to join the room by default or leave the user in an anonymous view only mode..	Yes
roomName	This label will be used in the title of your Room. If no label is provided, it will use the containerId value originally provided.	No
enableIm	Boolean value to control whether or not IMs can be launched for the users in the Webchat Lite by clicking on the room roster items.	No

Public Properties

Property	Value	Defined By
room	A roomVO project which contains all the properties about the particular room including a copy of the occupants within the room.	UPWebchateLite

Localization

See Override Locale Settings

Examples

To embed to Webchat Lite simply add the following in the proper location on your page.

onReady = function () {
    up.api.require("WebchatLite",{ containerID: "wcl-demo", roomId: "Userplane",  roomName: "Userplane" });
}
up.api.addEventListener(up.api.events.READY,onReady);

The above embed code will setup Webchat Lite to be ready to be displayed anywhere on your page. Next, you will need to add the <div> with the ID you specified in the embed code. For example, using the above embed code, you could do something like this:

<div id="wcl-demo" style="width:500px; height:600px;"></div>

You can style the div however you want, so it fits with your design and layout. The SDK is intelligent and will adapt the input pane, message pane, and roster pane, accordingly to what dimensions you provide it.