com.sun.im.service
Interface ConferenceEvent


public interface ConferenceEvent

An Event is a piece of information originated by the service, as opposed to a Message which is originated by another user of the service. The format of pre-defined events is documented here. Nothing prevents a deployment to define other types of events by extending EventType.


Field Summary
static int ETYPE_ACCESS_MODIFIED
          indicates a change of service access level for the current user.
static int ETYPE_ACTIVE
          The current user has successfully joined the conference.
static int ETYPE_CLOSE
          The conference is being terminated
static int ETYPE_MODERATION_STARTED
          The current user has started the moderation for the conference.
static int ETYPE_MODERATION_STOPED
          The current user has stoped the moderation for the conference.
static int ETYPE_OTHER
           
static int ETYPE_USER_INPUT_STARTED
          indication of user input.
static int ETYPE_USER_INPUT_STOPED
          indication of user input.
static int ETYPE_USER_JOINED
          indicates that a member of the NotificationSession has left it.
static int ETYPE_USER_LEFT
          indicates that a member of the NotificationSession has left it.
 
Method Summary
 int getType()
          Returns the event type
 java.lang.String toString()
          Returns the serialized version of the event (XML data) $return XML data.
 

Field Detail

ETYPE_USER_INPUT_STARTED

public static final int ETYPE_USER_INPUT_STARTED
indication of user input. This allows the application to convey to the user that a message is being composed by another member of the conference. The XML format associated with this event is defined in XXX. Example

See Also:
Constant Field Values

ETYPE_USER_INPUT_STOPED

public static final int ETYPE_USER_INPUT_STOPED
indication of user input. This allows the application to convey to the user that a message composing is stoped by another member of the conference. The XML format associated with this event is defined in XXX. Example

See Also:
Constant Field Values

ETYPE_USER_LEFT

public static final int ETYPE_USER_LEFT
indicates that a member of the NotificationSession has left it. Example content:

See Also:
Constant Field Values

ETYPE_USER_JOINED

public static final int ETYPE_USER_JOINED
indicates that a member of the NotificationSession has left it. example content:

See Also:
Constant Field Values

ETYPE_ACCESS_MODIFIED

public static final int ETYPE_ACCESS_MODIFIED
indicates a change of service access level for the current user. it applies to the current conference. Example content:

See Also:
Constant Field Values

ETYPE_CLOSE

public static final int ETYPE_CLOSE
The conference is being terminated

See Also:
Constant Field Values

ETYPE_ACTIVE

public static final int ETYPE_ACTIVE
The current user has successfully joined the conference.

See Also:
Constant Field Values

ETYPE_MODERATION_STARTED

public static final int ETYPE_MODERATION_STARTED
The current user has started the moderation for the conference.

See Also:
Constant Field Values

ETYPE_MODERATION_STOPED

public static final int ETYPE_MODERATION_STOPED
The current user has stoped the moderation for the conference.

See Also:
Constant Field Values

ETYPE_OTHER

public static final int ETYPE_OTHER
See Also:
Constant Field Values
Method Detail

toString

public java.lang.String toString()
Returns the serialized version of the event (XML data) $return XML data.


getType

public int getType()
Returns the event type

Returns:
int code for this event type