org.eclipse.ecf.presence.chatroom
Interface IChatRoomInfo

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable

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

Chat room information. Instances implementing this interface are returned by IChatRoomManager.getChatRoomInfo(String) or IChatRoomManager.getChatRoomInfos()

See Also:
IChatRoomManager.getChatRoomInfo(String)

Method Summary
 IChatRoomContainer createChatRoomContainer()
          Create a new IChatRoomContainer instance.
 ID getConnectedID()
           
 java.lang.String getDescription()
          Get a description for this room
 java.lang.String getName()
          Get a long name for room
 int getParticipantsCount()
          Get a count of the current number of room participants
 ID getRoomID()
          Get the ID associated with this room
 java.lang.String getSubject()
          Get subject/topic for room
 boolean isModerated()
           
 boolean isPersistent()
           
 boolean requiresPassword()
           
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getDescription

java.lang.String getDescription()
Get a description for this room

Returns:
String description for this chat room. May be null.

getSubject

java.lang.String getSubject()
Get subject/topic for room

Returns:
String topic. May be null.

getRoomID

ID getRoomID()
Get the ID associated with this room

Returns:
ID for room. Will not be null.

getParticipantsCount

int getParticipantsCount()
Get a count of the current number of room participants

Returns:
int number of participants

getName

java.lang.String getName()
Get a long name for room

Returns:
String name. May be null.

isPersistent

boolean isPersistent()
Returns:
true if room is persistent, false otherwise

requiresPassword

boolean requiresPassword()
Returns:
true if room connect requires password, false otherwise

isModerated

boolean isModerated()
Returns:
true if room is moderated, false otherwise

getConnectedID

ID getConnectedID()
Returns:
ID of connected user

createChatRoomContainer

IChatRoomContainer createChatRoomContainer()
                                           throws ContainerCreateException
Create a new IChatRoomContainer instance. This method can be used to create and connect a container to the chat room identified by this chat room info object.

Returns:
non-null IChatRoomContainer instance. Will not return null.
Throws:
ContainerCreateException - if chat room container cannot be made