org.asteriskjava.manager.event
Class DialEvent

java.lang.Object
  java.util.EventObject
      org.asteriskjava.manager.event.ManagerEvent
          org.asteriskjava.manager.event.DialEvent

All Implemented Interfaces:

java.io.Serializable

public class DialEvent
extends ManagerEvent

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.

Since:

0.2

Version:

$Id: DialEvent.java 972 2008-02-03 15:17:59Z srt $

Author:

Asteria Solutions Group, Inc.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

DialEvent(java.lang.Object source)

Method Summary

java.lang.String	getCallerId() Returns the Caller*ID.
java.lang.String	getCallerIdName() Returns the Caller*ID Name.
java.lang.String	getChannel() Returns the name of the source channel.
java.lang.String	getDestination() Returns the name of the destination channel.
java.lang.String	getDestUniqueId() Returns the unique ID of the destination channel.
java.lang.String	getDialString() Returns the dial string passed to the Dial application.
java.lang.String	getSrc() Deprecated. as of 1.0.0, use getChannel() instead.
java.lang.String	getSrcUniqueId() Deprecated. as of 1.0.0, use getUniqueId() instead.
java.lang.String	getUniqueId() Returns the unique ID of the source channel.
void	setCallerId(java.lang.String callerId) Sets the caller*ID.
void	setCallerIdName(java.lang.String callerIdName) Sets the Caller*Id Name.
void	setChannel(java.lang.String channel) Returns the name of the source channel.
void	setDestination(java.lang.String destination) Sets the name of the destination channel.
void	setDestUniqueId(java.lang.String destUniqueId) Sets the unique ID of the destination channel.
void	setDialString(java.lang.String dialString) Sets the dial string passed to the Dial application.
void	setSrc(java.lang.String src) Sets the name of the source channel.
void	setSrcUniqueId(java.lang.String srcUniqueId) Sets the unique ID of the source channel.
void	setUniqueId(java.lang.String srcUniqueId) Sets the unique ID of the source channel.

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

getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, 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

DialEvent

public DialEvent(java.lang.Object source)

Method Detail

getChannel

public java.lang.String getChannel()

Returns the name of the source channel.

Returns:

the name of the source channel.

Since:

1.0.0

setChannel

public void setChannel(java.lang.String channel)

Returns the name of the source channel.

Parameters:

channel - the name of the source channel.

Since:

1.0.0

getSrc

public java.lang.String getSrc()

Deprecated. as of 1.0.0, use getChannel() instead.

Returns the name of the source channel.

Returns:

the name of the source channel.

setSrc

public void setSrc(java.lang.String src)

Sets the name of the source channel.

Asterisk versions up to 1.4 use the "Source" property instead of "Channel".

Parameters:

src - the name of the source channel.

getDestination

public java.lang.String getDestination()

Returns the name of the destination channel.

Returns:

the name of the destination channel.

setDestination

public void setDestination(java.lang.String destination)

Sets the name of the destination channel.

Parameters:

destination - the name of the destination channel.

getCallerId

public java.lang.String getCallerId()

Returns the Caller*ID.

Returns:

the Caller*ID or "" if none has been set.

setCallerId

public void setCallerId(java.lang.String callerId)

Sets the caller*ID.

Parameters:

callerId - the caller*ID.

getCallerIdName

public java.lang.String getCallerIdName()

Returns the Caller*ID Name.

Returns:

the Caller*ID Name or "" if none has been set.

setCallerIdName

public void setCallerIdName(java.lang.String callerIdName)

Sets the Caller*Id Name.

Parameters:

callerIdName - the Caller*Id Name to set.

getUniqueId

public java.lang.String getUniqueId()

Returns the unique ID of the source channel.

Returns:

the unique ID of the source channel.

Since:

1.0.0

setUniqueId

public void setUniqueId(java.lang.String srcUniqueId)

Sets the unique ID of the source channel.

Parameters:

srcUniqueId - the unique ID of the source channel.

Since:

1.0.0

getSrcUniqueId

public java.lang.String getSrcUniqueId()

Deprecated. as of 1.0.0, use getUniqueId() instead.

Returns the unique ID of the source channel.

Returns:

the unique ID of the source channel.

setSrcUniqueId

public void setSrcUniqueId(java.lang.String srcUniqueId)

Sets the unique ID of the source channel.

Asterisk versions up to 1.4 use the "SrcUniqueId" property instead of "UniqueId".

Parameters:

srcUniqueId - the unique ID of the source channel.

getDestUniqueId

public java.lang.String getDestUniqueId()

Returns the unique ID of the destination channel.

Returns:

the unique ID of the destination channel.

setDestUniqueId

public void setDestUniqueId(java.lang.String destUniqueId)

Sets the unique ID of the destination channel.

Parameters:

destUniqueId - the unique ID of the destination channel.

getDialString

public java.lang.String getDialString()

Returns the dial string passed to the Dial application.

Available since Asterisk 1.6.

Returns:

the dial string passed to the Dial application.

Since:

1.0.0

setDialString

public void setDialString(java.lang.String dialString)

Sets the dial string passed to the Dial application.

Parameters:

dialString - the dial string passed to the Dial application.

Since:

1.0.0