org.asteriskjava.manager.event

Class AgentCalledEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.AgentCalledEvent

All Implemented Interfaces:

Serializable

public class AgentCalledEvent
extends ManagerEvent

An AgentCalledEvent is triggered when an agent is rung.
To enable AgentCalledEvents you have to set eventwhencalled = yes in queues.conf.
This event is implemented in apps/app_queue.c

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

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
AgentCalledEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getAccountcode()
String	getAgentCalled() Returns the member interface of the agent that has been called.
String	getAgentName() Deprecated. use instead (asterisk 13)
String	getCallerId() Deprecated. as of 1.0.0, use ManagerEvent.getCallerIdNum() instead.
String	getChannel()
String	getChannelCalling() Returns the name of the caller's channel that is about to be handled by the agent.
String	getDestAccountCode()
String	getDestCallerIdName()
String	getDestCallerIdNum()
String	getDestChannel()
String	getDestChannelState()
String	getDestChannelStateDesc()
String	getDestConnectedLineName()
String	getDestConnectedLineNum()
String	getDestContext()
String	getDestExten()
String	getDestinationChannel() Returns the name of the channel calling the agent.
String	getDestLanguage()
String	getDestLinkedId()
String	getDestPriority()
String	getDestUniqueId()
String	getExtension()
String	getInterface()
String	getLanguage()
String	getLinkedId()
String	getMemberName() Returns the Queue Member name.
String	getQueue() Returns the name of the queue.
String	getUniqueId() Returns the unique id of the caller's channel that is about to be handled by the agent.
Map<String,String>	getVariables() Returns the channel variables if eventwhencalled is set to vars in queues.conf.
void	setAccountcode(String accountcode)
void	setAgentCalled(String agentCalled) Sets the member interface of the agent that has been called.
void	setAgentName(String agentName) Deprecated.
void	setCallerId(String callerId) Sets the Caller ID number of the caller's channel.
void	setChannel(String channel)
void	setChannelCalling(String channelCalling) Sets the name of the caller's channel.
void	setDestAccountCode(String destAccountCode)
void	setDestCallerIdName(String destCallerIdName)
void	setDestCallerIdNum(String destCallerIdNum)
void	setDestChannel(String destChannel)
void	setDestChannelState(String destChannelState)
void	setDestChannelStateDesc(String destChannelStateDesc)
void	setDestConnectedLineName(String destConnectedLineName)
void	setDestConnectedLineNum(String destConnectedLineNum)
void	setDestContext(String destContext)
void	setDestExten(String destExten)
void	setDestinationChannel(String destinationChannel)
void	setDestLanguage(String destLanguage)
void	setDestLinkedId(String destLinkedId)
void	setDestPriority(String destPriority)
void	setDestUniqueId(String destUniqueId)
void	setExtension(String extension)
void	setInterface(String iface)
void	setLanguage(String language)
void	setLinkedId(String linkedId)
void	setMemberName(String memberName)
void	setQueue(String queue)
void	setUniqueId(String uniqueId)
void	setVariables(Map<String,String> variables) Sets the channel variables.

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

Constructor Detail

AgentCalledEvent

public AgentCalledEvent(Object source)

Parameters:

source -

Method Detail

getQueue

public String getQueue()

Returns the name of the queue.

Available since Asterisk 1.6.

Returns:

the name of the queue.

Since:

1.0.0

setQueue

public void setQueue(String queue)

getAgentCalled

public String getAgentCalled()

Returns the member interface of the agent that has been called.

Returns:

the member interface of the agent that has been called.

See Also:

QueueMemberEvent.getLocation()

setAgentCalled

public void setAgentCalled(String agentCalled)

Sets the member interface of the agent that has been called.

Parameters:

agentCalled - the member interface of the agent that has been called.

getAgentName

@Deprecated
public String getAgentName()

Deprecated. use instead (asterisk 13)

Returns the name of the agent that has been called.

Available since Asterisk 1.6.

Returns:

the name of the agent that has been called.

Since:

1.0.0

setAgentName

@Deprecated
public void setAgentName(String agentName)

Deprecated.

getChannelCalling

public String getChannelCalling()

Returns the name of the caller's channel that is about to be handled by the agent.

Returns:

the name of the caller's channel.

setChannelCalling

public void setChannelCalling(String channelCalling)

Sets the name of the caller's channel.

Parameters:

channelCalling - the name of the caller's channel.

getDestinationChannel

public String getDestinationChannel()

Returns the name of the channel calling the agent.

Available since Asterisk 1.6

Returns:

the name of the channel calling the agent.

Since:

1.0.0

setDestinationChannel

public void setDestinationChannel(String destinationChannel)

getCallerId

@Deprecated
public String getCallerId()

Deprecated. as of 1.0.0, use ManagerEvent.getCallerIdNum() instead.

Returns the Caller ID number of the caller's channel.

Returns:

the Caller ID number of the caller's channel.

setCallerId

public void setCallerId(String callerId)

Sets the Caller ID number of the caller's channel.

Parameters:

callerId - the Caller ID number of the caller's channel.

getExtension

public String getExtension()

setExtension

public void setExtension(String extension)

getUniqueId

public String getUniqueId()

Returns the unique id of the caller's channel that is about to be handled by the agent. This corresponds to getChannelCalling().

Available since Asterisk 1.6

Returns:

the unique id of the caller's channel.

Since:

1.0.0

setUniqueId

public void setUniqueId(String uniqueId)

getMemberName

public String getMemberName()

Returns the Queue Member name.

Available since Asterisk 13 replace agentName

setMemberName

public void setMemberName(String memberName)

getVariables

public Map<String,String> getVariables()

Returns the channel variables if eventwhencalled is set to vars in queues.conf.

Available since Asterisk 1.6

Returns:

the channel variables.

Since:

1.0.0

setVariables

public void setVariables(Map<String,String> variables)

Sets the channel variables.

Available since Asterisk 1.6

Parameters:

variables - the channel variables.

Since:

1.0.0

getDestExten

public String getDestExten()

Returns:

the destExten

setDestExten

public void setDestExten(String destExten)

Parameters:

destExten - the destExten to set

getDestChannelStateDesc

public String getDestChannelStateDesc()

Returns:

the destChannelStateDesc

setDestChannelStateDesc

public void setDestChannelStateDesc(String destChannelStateDesc)

Parameters:

destChannelStateDesc - the destChannelStateDesc to set

getDestUniqueId

public String getDestUniqueId()

Returns:

the destUniqueId

setDestUniqueId

public void setDestUniqueId(String destUniqueId)

Parameters:

destUniqueId - the destUniqueId to set

getDestConnectedLineNum

public String getDestConnectedLineNum()

Returns:

the destConnectedLineNum

setDestConnectedLineNum

public void setDestConnectedLineNum(String destConnectedLineNum)

Parameters:

destConnectedLineNum - the destConnectedLineNum to set

getDestCallerIdName

public String getDestCallerIdName()

Returns:

the destCallerIdName

setDestCallerIdName

public void setDestCallerIdName(String destCallerIdName)

Parameters:

destCallerIdName - the destCallerIdName to set

getDestCallerIdNum

public String getDestCallerIdNum()

Returns:

the destCallerIdNum

setDestCallerIdNum

public void setDestCallerIdNum(String destCallerIdNum)

Parameters:

destCallerIdNum - the destCallerIdNum to set

getDestContext

public String getDestContext()

Returns:

the destContext

setDestContext

public void setDestContext(String destContext)

Parameters:

destContext - the destContext to set

getDestPriority

public String getDestPriority()

Returns:

the destPriority

setDestPriority

public void setDestPriority(String destPriority)

Parameters:

destPriority - the destPriority to set

getDestChannel

public String getDestChannel()

Returns:

the destChannel

setDestChannel

public void setDestChannel(String destChannel)

Parameters:

destChannel - the destChannel to set

getDestChannelState

public String getDestChannelState()

Returns:

the destChannelState

setDestChannelState

public void setDestChannelState(String destChannelState)

Parameters:

destChannelState - the destChannelState to set

getInterface

public String getInterface()

Returns:

the iface

setInterface

public void setInterface(String iface)

Parameters:

iface - the iface to set

getChannel

public String getChannel()

Returns:

the channel

setChannel

public void setChannel(String channel)

Parameters:

channel - the channel to set

getDestConnectedLineName

public String getDestConnectedLineName()

Returns:

the destConnectedLineName

setDestConnectedLineName

public void setDestConnectedLineName(String destConnectedLineName)

Parameters:

destConnectedLineName - the destConnectedLineName to set

getDestAccountCode

public String getDestAccountCode()

setDestAccountCode

public void setDestAccountCode(String destAccountCode)

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

getDestLanguage

public String getDestLanguage()

setDestLanguage

public void setDestLanguage(String destLanguage)

getLinkedId

public String getLinkedId()

setLinkedId

public void setLinkedId(String linkedId)

getDestLinkedId

public String getDestLinkedId()

setDestLinkedId

public void setDestLinkedId(String destLinkedId)

getAccountcode

public String getAccountcode()

setAccountcode

public void setAccountcode(String accountcode)