org.asteriskjava.manager.event.DialEvent 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;
/**
* A dial event is triggered whenever a phone attempts to dial someone.
* This event is implemented in apps/app_dial.c.
* Available since Asterisk 1.2.
*
* @author Asteria Solutions Group, Inc. http://www.asteriasgi.com/
* @version $Id$
* @since 0.2
*/
public class DialEvent extends ManagerEvent
{
/**
* Serializable version identifier.
*/
private static final long serialVersionUID = 1L;
public static final String SUBEVENT_BEGIN = "Begin";
public static final String SUBEVENT_END = "End";
public static final String DIALSTATUS_CHANUNAVAIL = "CHANUNAVAIL";
public static final String DIALSTATUS_CONGESTION = "CONGESTION";
public static final String DIALSTATUS_NOANSWER = "NOANSWER";
public static final String DIALSTATUS_BUSY = "BUSY";
public static final String DIALSTATUS_ANSWER = "ANSWER";
public static final String DIALSTATUS_CANCEL = "CANCEL";
public static final String DIALSTATUS_DONTCALL = "DONTCALL";
public static final String DIALSTATUS_TORTURE = "TORTURE";
public static final String DIALSTATUS_INVALIDARGS = "INVALIDARGS";
private String subEvent = SUBEVENT_BEGIN;
private String connectedlinename;
private String connectedlinenum;
/**
* The name of the source channel.
*/
private String channel;
/**
* The name of the destination channel.
*/
private String destination;
/**
* The new Caller*ID.
*/
private String callerIdNum;
/**
* The new Caller*ID Name.
*/
private String callerIdName;
/**
* The unique id of the source channel.
*/
private String uniqueId;
/**
* The unique id of the destination channel.
*/
private String destUniqueId;
private String dialString;
private String dialStatus;
public DialEvent(Object source)
{
super(source);
}
/**
* Since Asterisk 1.6 the begin and the end of a dial command generate a Dial event. The
* subEvent property returns whether the dial started execution ("Begin") or completed ("End").
* As Asterisk prior to 1.6 only sends one event per Dial command this always returns "Begin"
* for Asterisk prior to 1.6.
* For an "End" sub event only the properies channel, unqiue id and dial status are available,
* for a "Begin" sub event all properties are available except for the dial status.
*
* @return "Begin" or "End" for Asterisk since 1.6, "Begin" for Asterisk prior to 1.6.
* @since 1.0.0
*/
public String getSubEvent()
{
return subEvent;
}
public void setSubEvent(String subEvent)
{
this.subEvent = subEvent;
}
/**
* Returns the name of the source channel.
*
* @return the name of the source channel.
* @since 1.0.0
*/
public String getChannel()
{
return channel;
}
/**
* Returns the name of the source channel.
*
* @param channel the name of the source channel.
* @since 1.0.0
*/
public void setChannel(String channel)
{
this.channel = channel;
}
/**
* Returns the name of the source channel.
*
* @return the name of the source channel.
* @deprecated as of 1.0.0, use {@link #getChannel()} instead.
*/
@Deprecated public String getSrc()
{
return channel;
}
/**
* Sets the name of the source channel.
* Asterisk versions up to 1.4 use the "Source" property instead of "Channel".
*
* @param src the name of the source channel.
*/
public void setSrc(String src)
{
this.channel = src;
}
/**
* Returns the name of the destination channel.
*
* @return the name of the destination channel.
*/
public String getDestination()
{
return destination;
}
/**
* Sets the name of the destination channel.
*
* @param destination the name of the destination channel.
*/
public void setDestination(String destination)
{
this.destination = destination;
}
/**
* Returns the the Caller*ID Number.
*
* @return the the Caller*ID Number or "<unknown>" if none has been set.
* @since 1.0.0
*/
public String getCallerIdNum()
{
return callerIdNum;
}
public void setCallerIdNum(String callerIdNum)
{
this.callerIdNum = callerIdNum;
}
/**
* Returns the Caller*ID.
*
* @return the Caller*ID or "<unknown>" if none has been set.
* @deprecated as of 1.0.0, use {@link #getCallerIdNum()} instead.
*/
@Deprecated public String getCallerId()
{
return callerIdNum;
}
/**
* Sets the caller*ID.
*
* @param callerId the caller*ID.
*/
public void setCallerId(String callerId)
{
this.callerIdNum = callerId;
}
/**
* Returns the Caller*ID Name.
*
* @return the Caller*ID Name or "<unknown>" if none has been set.
*/
public String getCallerIdName()
{
return callerIdName;
}
/**
* Sets the Caller*Id Name.
*
* @param callerIdName the Caller*Id Name to set.
*/
public void setCallerIdName(String callerIdName)
{
this.callerIdName = callerIdName;
}
/**
* Returns the unique ID of the source channel.
*
* @return the unique ID of the source channel.
* @since 1.0.0
*/
public String getUniqueId()
{
return uniqueId;
}
/**
* Sets the unique ID of the source channel.
*
* @param srcUniqueId the unique ID of the source channel.
* @since 1.0.0
*/
public void setUniqueId(String srcUniqueId)
{
this.uniqueId = srcUniqueId;
}
/**
* Returns the unique ID of the source channel.
*
* @return the unique ID of the source channel.
* @deprecated as of 1.0.0, use {@link #getUniqueId()} instead.
*/
@Deprecated public String getSrcUniqueId()
{
return uniqueId;
}
/**
* Sets the unique ID of the source channel.
* Asterisk versions up to 1.4 use the "SrcUniqueId" property instead of "UniqueId".
*
* @param srcUniqueId the unique ID of the source channel.
*/
public void setSrcUniqueId(String srcUniqueId)
{
this.uniqueId = srcUniqueId;
}
/**
* Returns the unique ID of the destination channel.
*
* @return the unique ID of the destination channel.
*/
public String getDestUniqueId()
{
return destUniqueId;
}
/**
* Sets the unique ID of the destination channel.
*
* @param destUniqueId the unique ID of the destination channel.
*/
public void setDestUniqueId(String destUniqueId)
{
this.destUniqueId = destUniqueId;
}
/**
* Returns the dial string passed to the Dial application.
* Available since Asterisk 1.6.
*
* @return the dial string passed to the Dial application.
* @since 1.0.0
*/
public String getDialString()
{
return dialString;
}
/**
* Sets the dial string passed to the Dial application.
*
* @param dialString the dial string passed to the Dial application.
* @since 1.0.0
*/
public void setDialString(String dialString)
{
this.dialString = dialString;
}
/**
* For end subevents this returns whether the completion status of the dial application.
* Possible values are:
*
* - CHANUNAVAIL
* - CONGESTION
* - NOANSWER
* - BUSY
* - ANSWER
* - CANCEL
* - DONTCALL
* - TORTURE
* - INVALIDARGS
*
* It corresponds the the DIALSTATUS variable used in the dialplan.
* Available since Asterisk 1.6.
*
* @return the completion status of the dial application.
* @since 1.0.0
*/
public String getDialStatus()
{
return dialStatus;
}
public void setDialStatus(String dialStatus)
{
this.dialStatus = dialStatus;
}
/**
* 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
*/
public String getConnectedlinename()
{
return connectedlinename;
}
public void setConnectedlinename(String connectedlinename)
{
this.connectedlinename = connectedlinename;
}
/**
* 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
*/
public String getConnectedlinenum()
{
return connectedlinenum;
}
public void setConnectedlinenum(String connectedlinenum)
{
this.connectedlinenum = connectedlinenum;
}
}