JSR-043: JTAPI-1.4

javax.telephony
Interface ConnectionEvent

All Superinterfaces:
CallEvent, Event
All Known Subinterfaces:
CallCenterConnectionEvent, CallControlConnectionEvent

public interface ConnectionEvent
extends CallEvent

The ConnectionEvent interface is the base event interface for all Connection-related events. All events which pertain to the Connection object must extend this interface. This interface extends the CallEvent interface and therefore is reported via the CallListener interface.

The core package defines events which are reported when the Connection changes state. These events are: CONNECTION_IN_PROGRESS, CONNECTION_ALERTING, CONNECTION_CONNECTED, CONNECTION_DISCONNECTED, CONNECTION_FAILED, and CONNECTION_UNKNOWN. Also, the CONNECTION_CREATED is sent when a new Connection is created.

Each of these events is reported to the corresponding method for an application registered as a ConnectionListener or TerminalConnectionListener.

The ConnectionEvent.getConnection method on this interface returns the Connection associated with this Connection event.

See Also:
Connection, CallListener, CallEvent

Field Summary
static int CONNECTION_ALERTING
          The CONNECTION_ALERTING event indicates that the state of the Connection object has changed to Connection.ALERTING.
static int CONNECTION_CONNECTED
          The CONNECTION_CONNECTED event indicates that the state of the Connection object has changed to Connection.CONNECTED.
static int CONNECTION_CREATED
          The CONNECTION_CREATED event indicates that a new Connection object has been created.
static int CONNECTION_DISCONNECTED
          The CONNECTION_DISCONNECTED event indicates that the state of the Connection object has changed to Connection.DISCONNECTED.
static int CONNECTION_FAILED
          The CONNECTION_FAILED interface indicates that the state of the Connection object has changed to Connection.FAILED.
static int CONNECTION_IN_PROGRESS
          The CONNECTION_IN_PROGRESS event indicates that the state of the Connection object has changed to Connection.IN_PROGRESS.
static int CONNECTION_UNKNOWN
          The CONNECTION_UNKNOWN event indicates that the state of the Connection object has changed to Connection.UNKNOWN.
 
Fields inherited from interface javax.telephony.CallEvent
CALL_ACTIVE, CALL_EVENT_TRANSMISSION_ENDED, CALL_INVALID
 
Fields inherited from interface javax.telephony.Event
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN
 
Method Summary
 Connection getConnection()
          Returns the Connection associated with this Connection event.
 
Methods inherited from interface javax.telephony.CallEvent
getCall
 
Methods inherited from interface javax.telephony.Event
getCause, getID, getMetaEvent, getSource
 

Field Detail

CONNECTION_ALERTING

public static final int CONNECTION_ALERTING
The CONNECTION_ALERTING event indicates that the state of the Connection object has changed to Connection.ALERTING.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.


CONNECTION_CONNECTED

public static final int CONNECTION_CONNECTED
The CONNECTION_CONNECTED event indicates that the state of the Connection object has changed to Connection.CONNECTED.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.


CONNECTION_CREATED

public static final int CONNECTION_CREATED
The CONNECTION_CREATED event indicates that a new Connection object has been created.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.


CONNECTION_DISCONNECTED

public static final int CONNECTION_DISCONNECTED
The CONNECTION_DISCONNECTED event indicates that the state of the Connection object has changed to Connection.DISCONNECTED.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.


CONNECTION_FAILED

public static final int CONNECTION_FAILED
The CONNECTION_FAILED interface indicates that the state of the Connection object has changed to Connection.FAILED.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.


CONNECTION_IN_PROGRESS

public static final int CONNECTION_IN_PROGRESS
The CONNECTION_IN_PROGRESS event indicates that the state of the Connection object has changed to Connection.IN_PROGRESS.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.


CONNECTION_UNKNOWN

public static final int CONNECTION_UNKNOWN
The CONNECTION_UNKNOWN event indicates that the state of the Connection object has changed to Connection.UNKNOWN.

This constant indicates a specific event passed via a ConnectionEvent event, and is reported on the CallListener interface.

Method Detail

getConnection

public Connection getConnection()
Returns the Connection associated with this Connection event.

Returns:
The Connection associated with this event.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org