org.asteriskjava.manager.event

Class TransferEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.TransferEvent

All Implemented Interfaces:

Serializable

public class TransferEvent
extends ManagerEvent

A TransferEvent is triggered when a SIP channel is transfered.

It is implemented in channels/chan_sip.c.

Available since Asterisk 1.6 for SIP channels.

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TRANSFER_METHOD_SIP
static String	TRANSFER_TYPE_ATTENDED
static String	TRANSFER_TYPE_BLIND

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TransferEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getChannel() Returns the name of the transfering channel.
String	getSipCallId() Returns the SIP call id.
String	getTargetChannel() Returns the name of the target channel.
String	getTargetUniqueId() Returns the unique id of the target channel.
Boolean	getTransfer2Parking() Returns whether this is a transfer to a parking extension.
String	getTransferContext() Returns the target context (in the dialplan) the call is transfered to.
String	getTransferExten() Returns the target extension the call is transfered to.
String	getTransferMethod() Returns the transfer method.
String	getTransferType() Returns whether this is an attended or a blind transfer.
String	getUniqueId() Returns the unique id of the transfering channel.
boolean	isAttended() Checks whether this is an attended transfer or not.
boolean	isBlind() Checks whether this is a blind transfer or not.
boolean	isParking() Convenience method to check if this is a transfer to a parking extension.
void	setChannel(String channel)
void	setSipCallId(String sipCallId)
void	setTargetChannel(String targetChannel)
void	setTargetUniqueId(String targetUniqueId)
void	setTransfer2Parking(Boolean transfer2Parking)
void	setTransferContext(String transferContext)
void	setTransferExten(String transferExten)
void	setTransferMethod(String transferMethod)
void	setTransferType(String transferType)
void	setUniqueId(String uniqueId)

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, toString

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

TRANSFER_METHOD_SIP

public static final String TRANSFER_METHOD_SIP

See Also:

Constant Field Values

TRANSFER_TYPE_ATTENDED

public static final String TRANSFER_TYPE_ATTENDED

See Also:

Constant Field Values

TRANSFER_TYPE_BLIND

public static final String TRANSFER_TYPE_BLIND

See Also:

Constant Field Values

Constructor Detail

TransferEvent

public TransferEvent(Object source)

Method Detail

getChannel

public String getChannel()

Returns the name of the transfering channel.

Returns:

channel the name of the transfering channel.

setChannel

public void setChannel(String channel)

getUniqueId

public String getUniqueId()

Returns the unique id of the transfering channel.

Returns:

the unique id of the transfering channel.

setUniqueId

public void setUniqueId(String uniqueId)

getTransferMethod

public String getTransferMethod()

Returns the transfer method. Currently this is always "SIP".

Returns:

the transfer method ("SIP").

setTransferMethod

public void setTransferMethod(String transferMethod)

getTransferType

public String getTransferType()

Returns whether this is an attended or a blind transfer. Possible values are "Attended" and "Blind".

Returns:

"Attended" if this an attended transfer, "Blind" if it is a blind transfer.

See Also:

TRANSFER_TYPE_ATTENDED, TRANSFER_TYPE_BLIND

isAttended

public boolean isAttended()

Checks whether this is an attended transfer or not.

Returns:

true if this is an attended transfer, false if not.

isBlind

public boolean isBlind()

Checks whether this is a blind transfer or not.

Returns:

true if this is an blind transfer, false if not.

setTransferType

public void setTransferType(String transferType)

getSipCallId

public String getSipCallId()

Returns the SIP call id.

Returns:

the SIP call id.

setSipCallId

public void setSipCallId(String sipCallId)

getTargetChannel

public String getTargetChannel()

Returns the name of the target channel.

Returns:

the name of the target channel.

setTargetChannel

public void setTargetChannel(String targetChannel)

getTargetUniqueId

public String getTargetUniqueId()

Returns the unique id of the target channel.

Returns:

the unique id of the target channel.

setTargetUniqueId

public void setTargetUniqueId(String targetUniqueId)

getTransferExten

public String getTransferExten()

Returns the target extension the call is transfered to. This is only available for blind transfers. If the call is transfered to a parking extension, the parking extension is returned.

Returns:

the target extension the call is transfered to or null for attended transfers.

setTransferExten

public void setTransferExten(String transferExten)

getTransferContext

public String getTransferContext()

Returns the target context (in the dialplan) the call is transfered to. This is only available for blind transfers. If the call is transfered to a parking extension null is returned.

Returns:

the target context the call is transfered to or null for attended transfers and transfers to a parking extension.

setTransferContext

public void setTransferContext(String transferContext)

getTransfer2Parking

public Boolean getTransfer2Parking()

Returns whether this is a transfer to a parking extension.

Returns:

Boolean.TRUE if this is a transfer to a parking extension, null otherwise.

setTransfer2Parking

public void setTransfer2Parking(Boolean transfer2Parking)

isParking

public boolean isParking()

Convenience method to check if this is a transfer to a parking extension.

Returns:

true if this is a transfer to a parking extension, false otherwise.