Chatbar portlet

Note

The Chatbar portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.

The Chatbar portlet shows the Chatbar application of eXo Collaboration that can be positioned in the portal or page layout as any other, but behaves as a floating box. The bar remains floating at its location even when the browser window is scrolled or resized. Its height is fixed, but can be expanded horizontally to any size available in its container. This allows the portlet to be placed in two layout cases:

Large width area (typically header or footer).

Narrow column.

The Chatbar application implements all functions of the Chat application, allowing you to send and receive messages anywhere after you are logged in successfully. The Chatbar is a typical toolbar with buttons to open menus. It gives access to main features of Chat:

Status change and presence indicator.

Contacts.

Rooms.

Minimized conversation window.

Package

The Chatbar portlet is packaged in the Chatbar.war file.

Portlet preferences

The Chatbar Portlet consists of some preferences as in the following sample code:




<portlet-preferences>

  <preference>

    <name>showMailLink</name>

    <value>true</value> <!--true/false -->

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>showCalendarLink</name>

    <value>true</value> <!--true/false -->

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>showContactLink</name>

    <value>true</value> <!--true/false -->

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>mailUrl</name>

    <value>portal/private/intranet/mail</value> <!--String page name -->

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>calendarUrl</name>

    <value>portal/private/intranet/calendar</value> <!--String page name -->

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>contactUrl</name>

    <value>portal/private/intranet/contact</value> <!--String page name -->

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>info</name>

    <value>info</value> <!--this is only the key to get the resource bundle the full key : UIConfigForm.label.info -->

    <read-only>true</read-only>

  </preference>

</portlet-preferences>

In which:

Preference Name	Possible Values	Default Values	Description
showMailLink	`true / false`	`true`	The value as "true" or "false" means that users are allowed to see the application icon or not respectively.
showCalendarLink	`true / false`	`true`	The value as "true" or "false" means that users are allowed to see the application icon or not respectively.
showContactLink	`true / false`	`true`	The value as "true" or "false" means that users are allowed to see the application icon or not respectively.
mailUrl	`string`	`Portal/private/intranet/mail`	The URL to the Mail application page in the portal without combining with the %domain name. The port% chatbar will resolve it from server.
calendarUrl	`string`	`Portal/private/intranet/calendar`	The URL to the Calendar application page in the portal without combining with the %domain name. The port% chatbar will resolve it from server.
contactUrl	`string`	`Portal/private/intranet/contact`	The URL to the Address Book application page in the portal without combining with the %domain name. The port% chatbar will resolve it from server.
info	`Info`	`Info`	This is only the key to get the resource bundle of the full key: UIConfigForm.label.info.

Portlet.xml

See the portlet in the project following this path: /eXoApplication/chatbar/webapp/src/main/webapp/WEB-INF/portlet.xml.