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 java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AgentCalledEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getAgentCalled() Returns the member interface of the agent that has been called.
String	getAgentName() Returns the name of the agent that has been called.
String	getCallerId() Deprecated. as of 1.0.0, use getCallerIdNum() instead.
String	getCallerIdName() Returns the Caller ID name of the caller's channel.
String	getCallerIdNum() Returns the Caller ID number of the caller's channel.
String	getChannelCalling() Returns the name of the caller's channel that is about to be handled by the agent.
String	getConnectedlinename() Returns the Caller*ID name of the channel connected if set.
String	getConnectedlinenum() Returns the Caller*ID number of the channel connected if set.
String	getContext()
String	getDestinationChannel() Returns the name of the channel calling the agent.
String	getExtension()
String	getPriority()
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	setAgentCalled(String agentCalled) Sets the member interface of the agent that has been called.
void	setAgentName(String agentName)
void	setCallerId(String callerId) Sets the Caller ID number of the caller's channel.
void	setCallerIdName(String callerIdName) Sets the Caller ID name of the caller's channel.
void	setCallerIdNum(String callerIdNum)
void	setChannelCalling(String channelCalling) Sets the name of the caller's channel.
void	setConnectedlinename(String connectedlinename)
void	setConnectedlinenum(String connectedlinenum)
void	setContext(String context)
void	setDestinationChannel(String destinationChannel)
void	setExtension(String extension)
void	setPriority(String priority)
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, getDateReceived, getFile, getFunc, getLine, getPrivilege, getSequenceNumber, getServer, getTimestamp, setDateReceived, setFile, setFunc, setLine, setPrivilege, setSequenceNumber, setServer, 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

public String getAgentName()

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

public void setAgentName(String agentName)

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)

getCallerIdNum

public String getCallerIdNum()

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

Returns:

the Caller ID number of the caller's channel or "unknown" of none has been set.

Since:

1.0.0

setCallerIdNum

public void setCallerIdNum(String callerIdNum)

getCallerId

@Deprecated
public String getCallerId()

Deprecated. as of 1.0.0, use 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.

getCallerIdName

public String getCallerIdName()

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

Returns:

the Caller ID name of the caller's channel or "unknown" if none has been set.

Since:

0.2

setCallerIdName

public void setCallerIdName(String callerIdName)

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

Parameters:

callerIdName - the Caller ID name of the caller's channel.

Since:

0.2

getContext

public String getContext()

setContext

public void setContext(String context)

getExtension

public String getExtension()

setExtension

public void setExtension(String extension)

getPriority

public String getPriority()

setPriority

public void setPriority(String priority)

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)

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

getConnectedlinename

public String getConnectedlinename()

Returns the Caller*ID name of the channel connected if set. If the channel has no caller id set "unknown" is returned.

Since:

1.0.0

setConnectedlinename

public void setConnectedlinename(String connectedlinename)

getConnectedlinenum

public String getConnectedlinenum()

Returns the Caller*ID number of the channel connected if set. If the channel has no caller id set "unknown" is returned.

Since:

1.0.0

setConnectedlinenum

public void setConnectedlinenum(String connectedlinenum)