org.eclipse.corona.collaboration.ecf.interfaces
Interface ITopicUser

All Known Subinterfaces:
ITopic
All Known Implementing Classes:
AbstractTopic, Topic, Topic

public interface ITopicUser


Method Summary
 void addListener(ITopicListener eventListener)
          Add an topic listener for the specified topic.
 void addUser(org.eclipse.ecf.core.user.IUser userInfo)
           
 java.lang.String[] getMembers()
          Retrieve the current members of the group.
 java.lang.String getTopicName()
          Get the name of the topic.
 void removeListener(ITopicListener eventListener)
          Remove an topic listener for the specified topic.
 void removeUser(org.eclipse.ecf.core.user.IUser userInfo)
           
 void sendMessage(java.lang.String[] ids, java.lang.Object msgObject)
          Send message to specified users.
 

Method Detail

getTopicName

java.lang.String getTopicName()
Get the name of the topic.

Returns:
The name of the topic

sendMessage

void sendMessage(java.lang.String[] ids,
                 java.lang.Object msgObject)
                 throws java.io.IOException
Send message to specified users.

Parameters:
ids - An array of user ids to send message to. If the value is null or the array is empty all members of the topic will be send the message.
msgObject - Message to be send. This object and all container objects must be serializable.
Throws:
java.io.IOException

getMembers

java.lang.String[] getMembers()
Retrieve the current members of the group.

Returns:
A String array of member Ids/names.

addListener

void addListener(ITopicListener eventListener)
Add an topic listener for the specified topic.

Parameters:
topicListener - The topic listener to process events for the topic.

removeListener

void removeListener(ITopicListener eventListener)
Remove an topic listener for the specified topic.

Parameters:
topicListener - The topic listener to be removed.

addUser

void addUser(org.eclipse.ecf.core.user.IUser userInfo)

removeUser

void removeUser(org.eclipse.ecf.core.user.IUser userInfo)

Copyright 2006 IBM Corporation and others.
All Rights Reserved.