org.asteriskjava.pbx.activities

Interface DialActivity

All Superinterfaces:

Activity

All Known Implementing Classes:

DialActivityImpl

public interface DialActivity
extends Activity

Method Summary

Modifier and Type	Method and Description
boolean	cancelledByOperator() Returns true if markCancelled was called during the dial attempt.
Channel	getAcceptingChannel() Returns the 'accepting' channel which is brought up as part of the dial activity.
EndPoint	getAcceptingEndPoint() Returns the end point which is being dialed.
Call	getNewCall()
Channel	getOriginatingChannel() Returns the 'originating' channel which is brought up as part of the dial activity.
EndPoint	getOriginatingEndPoint() Returns the end point which originated the dial.
void	markCancelled() Call markCancelled if you want to stop a dial which is in progress from completing.

Methods inherited from interface org.asteriskjava.pbx.Activity

getLastException, isSuccess

Method Detail

getOriginatingEndPoint

EndPoint getOriginatingEndPoint()

Returns the end point which originated the dial.

getAcceptingEndPoint

EndPoint getAcceptingEndPoint()

Returns the end point which is being dialed. This is available even before the dial commences.

getOriginatingChannel

Channel getOriginatingChannel()

Returns the 'originating' channel which is brought up as part of the dial activity. The 'originating' channel may return null if the channel is not up.

Returns:

the 'originating' channel if it has been brought up otherwise null.

getAcceptingChannel

Channel getAcceptingChannel()

Returns the 'accepting' channel which is brought up as part of the dial activity. The accepting party is the party that answers the call. The 'accepting' channel may return null if the channel is not up.

Returns:

the 'accepting' channel if it has been brought up otherwise null

markCancelled

void markCancelled()

Call markCancelled if you want to stop a dial which is in progress from completing. This allows a user to cancel a dial.

cancelledByOperator

boolean cancelledByOperator()

Returns true if markCancelled was called during the dial attempt.

Returns:

getNewCall

Call getNewCall()