org.glassfish.cafe.api
Interface IMConference

All Superinterfaces:

Communication

public interface IMConference
extends Communication

Author:

Mohit

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.cafe.api.Communication

Communication.State

Method Summary

MessageIndication	createMessageIndication() Creates a message indication object.
MessageIndication	createMessageIndication(MessageIndication.State state) Creates a message indication object.
TextMessage	createTextMessage() Creats an empty text message object.
TextMessage	createTextMessage(String msg) Creates the text message with the supplied text.
Collection<UserParticipant>	getAllParticipants() Return all the participants in the conference.
String	getDescription() Return the description of the conference.
void	setDescription(String description) Set the description of the conference.

Methods inherited from interface org.glassfish.cafe.api.Communication

addAgent, addParticipant, addParticipant, addParticipant, addParticipant, end, getAgent, getAgents, getInitiator, getName, getParticipant, getParticipant, getState, removeAgent, removeParticipant, removeParticipant, replaceParticipant

Method Detail

setDescription

void setDescription(String description)

Set the description of the conference.

Parameters:

description -

getDescription

String getDescription()

Return the description of the conference.

Returns:

getAllParticipants

Collection<UserParticipant> getAllParticipants()

Return all the participants in the conference.

Returns:

a Collection of UserParticipant objects.

createTextMessage

TextMessage createTextMessage()

Creats an empty text message object. Application would then fill it with text content and send to the participant.

Returns:

a TextMessage object.

See Also:

TextMessage

createTextMessage

TextMessage createTextMessage(String msg)

Creates the text message with the supplied text. This is equivalent to doing. TextMessage tm = im.createTextMessage(); tm.setText(msg);

Parameters:

msg - Text data of the message.

Returns:

a TextMessage object.

See Also:

TextMessage

createMessageIndication

MessageIndication createMessageIndication()

Creates a message indication object. The object will be created with default values specified in the MessageIndication class

Returns:

a MessageIndication object.

See Also:

MessageIndication

createMessageIndication

MessageIndication createMessageIndication(MessageIndication.State state)

Creates a message indication object. The object will be created with default values specified in the MessageIndication class

Returns:

a MessageIndication object.

See Also:

MessageIndication