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

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

All Implemented Interfaces:

Serializable

public class CallPeerConferenceEvent
extends EventObject

Represents an event fired by a CallPeer to notify interested CallPeerConferenceListeners about changes in its conference-related information such as it acting or not acting as a conference focus and conference membership details.

Author:

Lubomir Marinov

See Also:

Serialized Form

Field Summary

static int	CONFERENCE_FOCUS_CHANGED The ID of CallPeerConferenceEvent which notifies about a change in the characteristic of a specific CallPeer being a conference focus.
static int	CONFERENCE_MEMBER_ADDED The ID of CallPeerConferenceEvent which notifies about an addition to the list of ConferenceMembers managed by a specific CallPeer.
static int	CONFERENCE_MEMBER_REMOVED The ID of CallPeerConferenceEvent which notifies about a removal from the list of ConferenceMembers managed by a specific CallPeer.

Fields inherited from class java.util.EventObject

source

Constructor Summary

CallPeerConferenceEvent(CallPeer sourceCallPeer, int eventID)
Initializes a new CallPeerConferenceEvent which is to be fired by a specific CallPeer and which notifies about a change in its conference-related information not including a change pertaining to a specific ConferenceMember.

CallPeerConferenceEvent(CallPeer sourceCallPeer, int eventID, ConferenceMember conferenceMember)
Initializes a new CallPeerConferenceEvent which is to be fired by a specific CallPeer and which notifies about a change in its conference-related information pertaining to a specific ConferenceMember.

Method Summary

ConferenceMember	getConferenceMember() Gets the ConferenceMember which has been changed (e.g.
int	getEventID() Gets the ID of this event which may be one of CONFERENCE_FOCUS_CHANGED, CONFERENCE_MEMBER_ADDED and CONFERENCE_MEMBER_REMOVED and indicates the specifics of the change in the conference-related information and the details this event carries.
CallPeer	getSourceCallPeer() Gets the CallPeer which is the source of/fired the event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

CONFERENCE_FOCUS_CHANGED

public static final int CONFERENCE_FOCUS_CHANGED

The ID of CallPeerConferenceEvent which notifies about a change in the characteristic of a specific CallPeer being a conference focus. The event does not carry information about a specific ConferenceMember i.e. the conferenceMember property is of value null.

See Also:

Constant Field Values

CONFERENCE_MEMBER_ADDED

public static final int CONFERENCE_MEMBER_ADDED

The ID of CallPeerConferenceEvent which notifies about an addition to the list of ConferenceMembers managed by a specific CallPeer. The conferenceMember property specifies the ConferenceMember which was added and thus caused the event to be fired.

See Also:

Constant Field Values

CONFERENCE_MEMBER_REMOVED

public static final int CONFERENCE_MEMBER_REMOVED

The ID of CallPeerConferenceEvent which notifies about a removal from the list of ConferenceMembers managed by a specific CallPeer. The conferenceMember property specifies the ConferenceMember which was removed and thus caused the event to be fired.

See Also:

Constant Field Values

Constructor Detail

CallPeerConferenceEvent

public CallPeerConferenceEvent(CallPeer sourceCallPeer,
                               int eventID)

Initializes a new CallPeerConferenceEvent which is to be fired by a specific CallPeer and which notifies about a change in its conference-related information not including a change pertaining to a specific ConferenceMember.

Parameters:

sourceCallPeer - the CallPeer which is to fire the new event

eventID - the ID of this event which may be CONFERENCE_FOCUS_CHANGED and indicates the specifics of the change in the conference-related information and the details this event carries

CallPeerConferenceEvent

public CallPeerConferenceEvent(CallPeer sourceCallPeer,
                               int eventID,
                               ConferenceMember conferenceMember)

Initializes a new CallPeerConferenceEvent which is to be fired by a specific CallPeer and which notifies about a change in its conference-related information pertaining to a specific ConferenceMember.

Parameters:

sourceCallPeer - the CallPeer which is to fire the new event

eventID - the ID of this event which may be CONFERENCE_MEMBER_ADDED and CONFERENCE_MEMBER_REMOVED and indicates the specifics of the change in the conference-related information and the details this event carries

conferenceMember - the ConferenceMember which caused the new event to be fired

Method Detail

getConferenceMember

public ConferenceMember getConferenceMember()

Gets the ConferenceMember which has been changed (e.g. added to or removed from the conference) if this event has been fired because of such a change.

Returns:

the ConferenceMember which has been changed if this event has been fired because of such a change; otherwise, null

getEventID

public int getEventID()

Gets the ID of this event which may be one of CONFERENCE_FOCUS_CHANGED, CONFERENCE_MEMBER_ADDED and CONFERENCE_MEMBER_REMOVED and indicates the specifics of the change in the conference-related information and the details this event carries.

Returns:

the ID of this event which may be one of CONFERENCE_FOCUS_CHANGED, CONFERENCE_MEMBER_ADDED and CONFERENCE_MEMBER_REMOVED and indicates the specifics of the change in the conference-related information and the details this event carries

getSourceCallPeer

public CallPeer getSourceCallPeer()

Gets the CallPeer which is the source of/fired the event.

Returns:

the CallPeer which is the source of/fired the event