org.asteriskjava.manager.event

Class ListDialplanEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ResponseEvent

org.asteriskjava.manager.event.ListDialplanEvent

All Implemented Interfaces:

Serializable

public class ListDialplanEvent
extends ResponseEvent

A ShowDialplanCompleteEvent is triggered for each priority in the dialplan in response to a ShowDialplanAction.

Available since Asterisk 1.6

It is implemented in main/pbx.c

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

ShowDialplanAction, ShowDialplanCompleteEvent, Serialized Form

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ResponseEvent

actionId

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

Method Summary

Modifier and Type	Method and Description
String	getAppData() Returns the parameters of the application configured to handle this priority.
String	getApplication() Returns the application configured to handle this priority.
String	getExtension() Returns the extension or extension pattern.
String	getExtensionLabel() Returns the extension label.
String	getIgnorePattern()
String	getIncludeContext()
String	getRegistrar() Returns the registrar that registered this priority.
String	getSwitch()
boolean	isHint() Checks whether this is a hint.
void	setAppData(String appData)
void	setApplication(String application)
void	setExtension(String extension)
void	setExtensionLabel(String extensionLabel)
ListDialplanEvent	setIgnorePattern(String ignorePattern)
void	setIncludeContext(String includeContext)
void	setPriority(String priorityString)
void	setRegistrar(String registrar)
ListDialplanEvent	setSwitch(String _switch)

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

getActionId, getInternalActionId, setActionId, setInternalActionId

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

ListDialplanEvent

public ListDialplanEvent(Object source)

Method Detail

getExtension

public String getExtension()

Returns the extension or extension pattern.

Returns:

the extension or extension pattern.

setExtension

public void setExtension(String extension)

getExtensionLabel

public String getExtensionLabel()

Returns the extension label.

Returns:

the extension label or null if none.

setExtensionLabel

public void setExtensionLabel(String extensionLabel)

isHint

public boolean isHint()

Checks whether this is a hint.

Returns:

true if this is a hint, false otherwise.

setPriority

public void setPriority(String priorityString)

getApplication

public String getApplication()

Returns the application configured to handle this priority.

Returns:

the application configured to handle this priority.

setApplication

public void setApplication(String application)

getAppData

public String getAppData()

Returns the parameters of the application configured to handle this priority.

Returns:

the parameters of the application configured to handle this priority or null if none.

setAppData

public void setAppData(String appData)

getRegistrar

public String getRegistrar()

Returns the registrar that registered this priority.

Typical values are "features" for the parkedcalls context, "pbx_config" for priorities defined in extensions.conf or "app_dial" for the app_dial_gosub_virtual_context context.

Returns:

the registrar that registered this priority.

setRegistrar

public void setRegistrar(String registrar)

getIncludeContext

public String getIncludeContext()

setIncludeContext

public void setIncludeContext(String includeContext)

getSwitch

public String getSwitch()

setSwitch

public ListDialplanEvent setSwitch(String _switch)

getIgnorePattern

public String getIgnorePattern()

setIgnorePattern

public ListDialplanEvent setIgnorePattern(String ignorePattern)