net.java.sip.communicator.service.protocol.event
Class LocalUserChatRoomPresenceChangeEvent

java.lang.Object
  java.util.EventObject
      net.java.sip.communicator.service.protocol.event.LocalUserChatRoomPresenceChangeEvent

All Implemented Interfaces:

Serializable

public class LocalUserChatRoomPresenceChangeEvent
extends EventObject

Dispatched to notify interested parties that a change in our presence in the source chat room has occured. Changes may include us being kicked, join, left, etc.

Author:

Emil Ivov, Stephane Remy

See Also:

Serialized Form

Field Summary

static String	LOCAL_USER_DROPPED Indicates that this event was triggered as a result of the local participant beeing disconnected from the server brutally, or ping timeout.
static String	LOCAL_USER_JOIN_FAILED Indicates that this event was triggered as a result of the local participant failed to join a chat room.
static String	LOCAL_USER_JOINED Indicates that this event was triggered as a result of the local participant joining a chat room.
static String	LOCAL_USER_KICKED Indicates that this event was triggered as a result of the local participant being kicked from a chat room.
static String	LOCAL_USER_LEFT Indicates that this event was triggered as a result of the local participant leaving a chat room.

Fields inherited from class java.util.EventObject

source

Constructor Summary

LocalUserChatRoomPresenceChangeEvent(OperationSetMultiUserChat source, ChatRoom chatRoom, String eventType, String reason)
Creates a ChatRoomLocalUserPresenceChangeEvent representing that a change in local participant presence in the source chat room has occured.

Method Summary

ChatRoom	getChatRoom() Returns the ChatRoom, that this event is about.
String	getEventType() Returns the type of this event which could be one of the LOCAL_USER_XXX member fields.
OperationSetMultiUserChat	getMultiUserChatOpSet() Returns the OperationSetMultiUserChat, where this event has occurred.
String	getReason() A reason string indicating a human readable reason for this event.
String	toString() Returns a String representation of this event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOCAL_USER_JOINED

public static final String LOCAL_USER_JOINED

Indicates that this event was triggered as a result of the local participant joining a chat room.

See Also:

Constant Field Values

LOCAL_USER_JOIN_FAILED

public static final String LOCAL_USER_JOIN_FAILED

Indicates that this event was triggered as a result of the local participant failed to join a chat room.

See Also:

Constant Field Values

LOCAL_USER_LEFT

public static final String LOCAL_USER_LEFT

Indicates that this event was triggered as a result of the local participant leaving a chat room.

See Also:

Constant Field Values

LOCAL_USER_KICKED

public static final String LOCAL_USER_KICKED

Indicates that this event was triggered as a result of the local participant being kicked from a chat room.

See Also:

Constant Field Values

LOCAL_USER_DROPPED

public static final String LOCAL_USER_DROPPED

Indicates that this event was triggered as a result of the local participant beeing disconnected from the server brutally, or ping timeout.

See Also:

Constant Field Values

Constructor Detail

LocalUserChatRoomPresenceChangeEvent

public LocalUserChatRoomPresenceChangeEvent(OperationSetMultiUserChat source,
                                            ChatRoom chatRoom,
                                            String eventType,
                                            String reason)

Creates a ChatRoomLocalUserPresenceChangeEvent representing that a change in local participant presence in the source chat room has occured.

Parameters:

source - the OperationSetMultiUserChat, which produced this event

chatRoom - the ChatRoom that this event is about

eventType - the type of this event.

reason - the reason explaining why this event might have occurred

Method Detail

getMultiUserChatOpSet

public OperationSetMultiUserChat getMultiUserChatOpSet()

Returns the OperationSetMultiUserChat, where this event has occurred.

Returns:

the OperationSetMultiUserChat, where this event has occurred

getChatRoom

public ChatRoom getChatRoom()

Returns the ChatRoom, that this event is about.

Returns:

the ChatRoom, that this event is about

getReason

public String getReason()

A reason string indicating a human readable reason for this event.

Returns:

a human readable String containing the reason for this event, or null if no particular reason was specified

getEventType

public String getEventType()

Returns the type of this event which could be one of the LOCAL_USER_XXX member fields.

Returns:

one of the LOCAL_USER_XXX fields indicating the type of this event.

toString

public String toString()

Returns a String representation of this event.

Overrides:

toString in class EventObject

Returns:

String representation of this event