org.asteriskjava.pbx.internal.managerAPI

Class Dial

java.lang.Object

org.asteriskjava.lock.Lockable

org.asteriskjava.pbx.internal.managerAPI.EventListenerBaseClass

org.asteriskjava.pbx.internal.managerAPI.Dial

All Implemented Interfaces:

AutoCloseable, FilteredManagerListener<ManagerEvent>

public class Dial
extends EventListenerBaseClass

Nested Class Summary

Nested classes/interfaces inherited from class org.asteriskjava.pbx.internal.managerAPI.EventListenerBaseClass

EventListenerBaseClass.AutoClose

Constructor Summary

Constructors

Constructor and Description
Dial(String descriptiveName)

Method Summary

Modifier and Type	Method and Description
OriginateResult[]	dial(NewChannelListener listener, EndPoint localHandset, EndPoint targetEndPoint, String dialContext, CallerID callerID, boolean hideCallerId, Map<String,String> channelVarsToSet, String dialOptions) Dials the targetEndPoint connecting the call to the localHandset.
ListenerPriority	getPriority() Set the listeners priority.
void	onManagerEvent(ManagerEvent event) Called for each manager event that the connection receives for which the filterEvent returned true.
HashSet<Class<? extends ManagerEvent>>	requiredEvents() Called whenever the listener is first added and any time any listener is removed to refresh the list of required events.

Methods inherited from class org.asteriskjava.pbx.internal.managerAPI.EventListenerBaseClass

close, getName, startListener

Methods inherited from class org.asteriskjava.lock.Lockable

getDumpRateLimit, withLock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Dial

public Dial(String descriptiveName)

Method Detail

dial

public OriginateResult[] dial(NewChannelListener listener,
                              EndPoint localHandset,
                              EndPoint targetEndPoint,
                              String dialContext,
                              CallerID callerID,
                              boolean hideCallerId,
                              Map<String,String> channelVarsToSet,
                              String dialOptions)
                       throws PBXException

Dials the targetEndPoint connecting the call to the localHandset. The dial is done in two parts as we need to set the auto answer header differently for each phone. For the localHandset we set auto answer on, whilst for the remote targetEndPoint we MUST not auto answer the phone.

Parameters:

localHandset - the users handset we are going to dial from (e.g. receptionist phone).

targetEndPoint - - the remote handset we are going to connect the localHandset to.

dialContext - - context we are going to dial from.

hideCallerId -

channelVarsToSet -

callerId - - the callerID to display on the targetEndPoint.

Returns:

Throws:

PBXException

requiredEvents

public HashSet<Class<? extends ManagerEvent>> requiredEvents()

Description copied from interface: FilteredManagerListener

Called whenever the listener is first added and any time any listener is removed to refresh the list of required events.

Returns:

list of required events.

onManagerEvent

public void onManagerEvent(ManagerEvent event)

Description copied from interface: FilteredManagerListener

Called for each manager event that the connection receives for which the filterEvent returned true.

getPriority

public ListenerPriority getPriority()

Description copied from interface: FilteredManagerListener

Set the listeners priority. Higher priority listeners have events dispatched to them before lower priority listeners.

Returns: