Package com.compoze.collab.im

This package provides the classes for the instant messaging schema.

See:
Description

Interface Summary

IFriend	Provides the interface to the Friend item.
IFriendGroupContainer	Container class that holds a group of IM friends (as opposed to the top level IFriendsContainer, which holds all friends and groups).
IFriendsContainer	Container class that holds IM friends.
IImListener	Classes that implement this interface can listen for instant messaging events.
IImRootContainer	Container class for the IM root container.
IImSession	Extends the collab ISession with additional instant messaging specific functionality.
IInstantMessage	Provides the interface to the instant message item.
IMessagesContainer	Container class that holds instant messages.

Class Summary

FriendStatus	The element class for the FriendStatusEnum enumeration.
FriendStatusEnum	The enumeration class that contains FriendStatus elements.
ImEvent	This class is used to notify listeners on a container that some changed has occurred in the container.
QueueEventListener	This class implements an event listener that stores events internally until they are retrieved.
QueueImEventListener	An event listener that queues IM events.

Package com.compoze.collab.im Description

This package provides the classes for the instant messaging schema.

Before understanding how this API is used you must first understand the Collaboration Framework in general. See the package description of the com.compoze.collab package for more information on this.

Access to instant messaging is provided through special in-memory containers and items held in a single, fixed root container. Starting at the root of the container tree, there is a Friends container and a Messages container, as follows:

The Friends container holds Friend items, one per friend. Friends may be a part of multiple friend groups at the same time, so this layout gives the ability to access the full friends list or lists of friends by group. Underneath the Friends container is a container for each friend group. Getting a list of items in one of these friend group subcontainers returns only the friends in that group. The Friend items that are returned in the friend group subcontainers may not be the same exact instances as the ones in the Friends container itself and as such must be compared for equality using the equals method.

The Messages container both holds incoming instant messages and provides the ability to create outgoing messages.