org.eclipse.ecf.presence.chat
Interface IChatRoomManager

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

public interface IChatRoomManager
extends org.eclipse.core.runtime.IAdaptable

Chat room manager. Entry point for getting access to chat rooms managed by this manager. Access to objects implementing this interface is provided by IPresenceContainerAdapter.getChatRoomManager()

Method Summary

void	addInvitationListener(IChatRoomInvitationListener listener) Add invitation listener
IChatRoomInfo	getChatRoomInfo(java.lang.String roomname) Get detailed room info for given room name
IChatRoomInfo[]	getChatRoomsInfo() Get detailed room info for all chat rooms associated with this manager
IChatRoomManager[]	getChildren() Get any children managers of this IChatRoomManager.
IChatRoomManager	getParent() Get parent IChatRoomManager.
void	removeInvitationListener(IChatRoomInvitationListener listener) Remove invitation listener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

addInvitationListener

void addInvitationListener(IChatRoomInvitationListener listener)

Add invitation listener

Parameters:

listener - the invitation listener to add

removeInvitationListener

void removeInvitationListener(IChatRoomInvitationListener listener)

Remove invitation listener

Parameters:

listener - the invitation listener to remove

getParent

IChatRoomManager getParent()

Get parent IChatRoomManager. If this manager is the root, then this method returns null.

Returns:

IChatRoomManager instance if this manager has a parent. Returns null if this manager is the root of the hierarchy

getChildren

IChatRoomManager[] getChildren()

Get any children managers of this IChatRoomManager. If this chat room manager has children chat room managers, then the returned array will have more than zero elements. If this IChatRoomManager has no children, then a zero-length array will be returned.

Returns:

IChatRoomManager[] of children for this chat room manager. If no children, a zero-length array will be returned. Null will not be returned.

getChatRoomInfo

IChatRoomInfo getChatRoomInfo(java.lang.String roomname)

Get detailed room info for given room name

Parameters:

roomname - the name of the room to get detailed info for. If null, the room info is assumed to be a room associated with the chat room manager instance itself. For example, for IRC, the chat room manager is also a chat room where message can be sent/received

Returns:

IChatRoomInfo an instance that provides the given info. Null if no chat room info associated with given name or null

getChatRoomsInfo

IChatRoomInfo[] getChatRoomsInfo()

Get detailed room info for all chat rooms associated with this manager

Returns:

IChatRoomInfo an array of instances that provide info for all chat rooms