org.asteriskjava.manager.event.AgentCalledEvent Maven / Gradle / Ivy
Show all versions of asterisk-java Show documentation
/*
* Copyright 2004-2006 Stefan Reuter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.asteriskjava.manager.event;
import java.util.Map;
/**
* 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
*
* @author srt
* @version $Id$
*/
public class AgentCalledEvent extends ManagerEvent
{
/**
* Serializable version identifier.
*/
private static final long serialVersionUID = 2L;
private String queue;
private String agentCalled;
private String channelCalling;
private String destinationChannel;
private String uniqueId;
private String memberName;
private Map variables;
private String destExten;
private String destChannelStateDesc;
private String destUniqueId;
private String destConnectedLineNum;
private String destConnectedLineName;
private String destCallerIdName;
private String destCallerIdNum;
private String destContext;
private String destPriority;
private String destChannel;
private String destChannelState;
private String iface;
private String channel;
private String destAccountCode;
private String language;
private String destLanguage;
private String linkedId;
private String destLinkedId;
private String accountcode;
/**
* @param source
*/
public AgentCalledEvent(Object source)
{
super(source);
}
/**
* Returns the name of the queue.
*
* Available since Asterisk 1.6.
*
* @return the name of the queue.
* @since 1.0.0
*/
public String getQueue()
{
return queue;
}
public void setQueue(String queue)
{
this.queue = queue;
}
/**
* Returns the member interface of the agent that has been called.
*
* @return the member interface of the agent that has been called.
* @see QueueMemberEvent#getLocation()
*/
public String getAgentCalled()
{
return agentCalled;
}
/**
* Sets the member interface of the agent that has been called.
*
* @param agentCalled the member interface of the agent that has been
* called.
*/
public void setAgentCalled(String agentCalled)
{
this.agentCalled = agentCalled;
}
/**
* Returns the name of the agent that has been called.
*
* Available since Asterisk 1.6.
*
* @return the name of the agent that has been called.
* @since 1.0.0
* @deprecated use {@lkink #getMemberName()} instead (asterisk 13)
*/
@Deprecated
public String getAgentName()
{
return memberName;
}
@Deprecated
public void setAgentName(String agentName)
{
this.memberName = agentName;
}
/**
* Returns the name of the caller's channel that is about to be handled by
* the agent.
*
* @return the name of the caller's channel.
*/
public String getChannelCalling()
{
return channelCalling;
}
/**
* Sets the name of the caller's channel.
*
* @param channelCalling the name of the caller's channel.
*/
public void setChannelCalling(String channelCalling)
{
this.channelCalling = channelCalling;
}
/**
* Returns the name of the channel calling the agent.
*
* Available since Asterisk 1.6
*
* @return the name of the channel calling the agent.
* @since 1.0.0
*/
public String getDestinationChannel()
{
return destinationChannel;
}
public void setDestinationChannel(String destinationChannel)
{
this.destinationChannel = destinationChannel;
}
/**
* Returns the Caller ID number of the caller's channel.
*
* @return the Caller ID number of the caller's channel.
* @deprecated as of 1.0.0, use {@link #getCallerIdNum()} instead.
*/
@Deprecated
public String getCallerId()
{
return callerIdNum;
}
/**
* Sets the Caller ID number of the caller's channel.
*
* @param callerId the Caller ID number of the caller's channel.
*/
public void setCallerId(String callerId)
{
this.callerIdNum = callerId;
}
public String getExtension()
{
return exten;
}
public void setExtension(String extension)
{
this.exten = extension;
}
/**
* Returns the unique id of the caller's channel that is about to be handled
* by the agent. This corresponds to {@link #getChannelCalling()}.
*
* Available since Asterisk 1.6
*
* @return the unique id of the caller's channel.
* @since 1.0.0
*/
public String getUniqueId()
{
return uniqueId;
}
public void setUniqueId(String uniqueId)
{
this.uniqueId = uniqueId;
}
/**
* Returns the Queue Member name.
*
* Available since Asterisk 13 replace agentName
*
*/
public String getMemberName()
{
return memberName;
}
public void setMemberName(String memberName)
{
this.memberName = memberName;
}
/**
* Returns the channel variables if eventwhencalled is set to
* vars in queues.conf.
*
* Available since Asterisk 1.6
*
* @return the channel variables.
* @since 1.0.0
*/
public Map getVariables()
{
return variables;
}
/**
* Sets the channel variables.
*
* Available since Asterisk 1.6
*
* @param variables the channel variables.
* @since 1.0.0
*/
public void setVariables(Map variables)
{
this.variables = variables;
}
/**
* @return the destExten
*/
public String getDestExten()
{
return destExten;
}
/**
* @param destExten the destExten to set
*/
public void setDestExten(String destExten)
{
this.destExten = destExten;
}
/**
* @return the destChannelStateDesc
*/
public String getDestChannelStateDesc()
{
return destChannelStateDesc;
}
/**
* @param destChannelStateDesc the destChannelStateDesc to set
*/
public void setDestChannelStateDesc(String destChannelStateDesc)
{
this.destChannelStateDesc = destChannelStateDesc;
}
/**
* @return the destUniqueId
*/
public String getDestUniqueId()
{
return destUniqueId;
}
/**
* @param destUniqueId the destUniqueId to set
*/
public void setDestUniqueId(String destUniqueId)
{
this.destUniqueId = destUniqueId;
}
/**
* @return the destConnectedLineNum
*/
public String getDestConnectedLineNum()
{
return destConnectedLineNum;
}
/**
* @param destConnectedLineNum the destConnectedLineNum to set
*/
public void setDestConnectedLineNum(String destConnectedLineNum)
{
this.destConnectedLineNum = destConnectedLineNum;
}
/**
* @return the destCallerIdName
*/
public String getDestCallerIdName()
{
return destCallerIdName;
}
/**
* @param destCallerIdName the destCallerIdName to set
*/
public void setDestCallerIdName(String destCallerIdName)
{
this.destCallerIdName = destCallerIdName;
}
/**
* @return the destCallerIdNum
*/
public String getDestCallerIdNum()
{
return destCallerIdNum;
}
/**
* @param destCallerIdNum the destCallerIdNum to set
*/
public void setDestCallerIdNum(String destCallerIdNum)
{
this.destCallerIdNum = destCallerIdNum;
}
/**
* @return the destContext
*/
public String getDestContext()
{
return destContext;
}
/**
* @param destContext the destContext to set
*/
public void setDestContext(String destContext)
{
this.destContext = destContext;
}
/**
* @return the destPriority
*/
public String getDestPriority()
{
return destPriority;
}
/**
* @param destPriority the destPriority to set
*/
public void setDestPriority(String destPriority)
{
this.destPriority = destPriority;
}
/**
* @return the destChannel
*/
public String getDestChannel()
{
return destChannel;
}
/**
* @param destChannel the destChannel to set
*/
public void setDestChannel(String destChannel)
{
this.destChannel = destChannel;
}
/**
* @return the destChannelState
*/
public String getDestChannelState()
{
return destChannelState;
}
/**
* @param destChannelState the destChannelState to set
*/
public void setDestChannelState(String destChannelState)
{
this.destChannelState = destChannelState;
}
/**
* @return the iface
*/
public String getInterface()
{
return iface;
}
/**
* @param iface the iface to set
*/
public void setInterface(String iface)
{
this.iface = iface;
}
/**
* @return the channel
*/
public String getChannel()
{
return channel;
}
/**
* @param channel the channel to set
*/
public void setChannel(String channel)
{
this.channel = channel;
}
/**
* @return the destConnectedLineName
*/
public String getDestConnectedLineName()
{
return destConnectedLineName;
}
/**
* @param destConnectedLineName the destConnectedLineName to set
*/
public void setDestConnectedLineName(String destConnectedLineName)
{
this.destConnectedLineName = destConnectedLineName;
}
public String getDestAccountCode()
{
return destAccountCode;
}
public void setDestAccountCode(String destAccountCode)
{
this.destAccountCode = destAccountCode;
}
public String getLanguage()
{
return language;
}
public void setLanguage(String language)
{
this.language = language;
}
public String getDestLanguage()
{
return destLanguage;
}
public void setDestLanguage(String destLanguage)
{
this.destLanguage = destLanguage;
}
public String getLinkedId()
{
return linkedId;
}
public void setLinkedId(String linkedId)
{
this.linkedId = linkedId;
}
public String getDestLinkedId()
{
return destLinkedId;
}
public void setDestLinkedId(String destLinkedId)
{
this.destLinkedId = destLinkedId;
}
public String getAccountcode()
{
return accountcode;
}
public void setAccountcode(String accountcode)
{
this.accountcode = accountcode;
}
}