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

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

All Implemented Interfaces:

Serializable

public class CallPeerControlEvent
extends EventObject

The CallPeerControlEvent is issued by the PhoneUIService as a result of a user request to modify the way a CallPeer is associated with a call, or in other words "Answer" the incoming call of a CallPeer or "Hangup" and thus and the participation of a CallPeer in a call. The source of the event is considered to be the CallPeer that is being controlled. As the event might also be used to indicate a user request to transfer a given call peer to a different number, the class also contains a targetURI field, containing the address that a client is being redirected to (the target uri might also have slightly different meanings depending on the method dispatching the event).

Author:

Emil Ivov

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

CallPeerControlEvent(CallPeer source, String targetURI)
Creates a new event instance with the specified source CallPeer and targetURI, if any.

Method Summary

CallPeer	getAssociatedCallPeer() Returns the CallPeer that this event is pertaining to.
String	getTargetURI() Returns the target URI if this is event is triggered by a transfer request or null if not.

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

Constructor Detail

CallPeerControlEvent

public CallPeerControlEvent(CallPeer source,
                            String targetURI)

Creates a new event instance with the specified source CallPeer and targetURI, if any.

Parameters:

source - the CallPeer that this event is pertaining to.

targetURI - the URI to transfer to if this is a "Transfer" event or null otherwise.

Method Detail

getAssociatedCallPeer

public CallPeer getAssociatedCallPeer()

Returns the CallPeer that this event is pertaining to.

Returns:

the CallPeer that this event is pertaining to.

getTargetURI

public String getTargetURI()

Returns the target URI if this is event is triggered by a transfer request or null if not.

Returns:

null or a tranfer URI.