JSR-043: JTAPI-1.4

javax.telephony
Interface CallEvent

All Superinterfaces:
Event
All Known Subinterfaces:
CallCenterCallEvent, CallCenterConnectionEvent, CallCenterTrunkEvent, CallControlCallEvent, CallControlConnectionEvent, CallControlTerminalConnectionEvent, ConnectionEvent, TerminalConnectionEvent

public interface CallEvent
extends Event

The CallEvent interface is the base interface for all Call-related events. All Call-related events must extend this interface. Events which extend this interface are reported via the CallListener interface.

An individual CallEvent conveys one of a series of different possible Call state changes; the specific Call state change is indicated by the Event.getID() value returned by the event.

The core package defines events which are reported when the Call changes state. The event IDs (as returned by Event.getID()) are: CALL_ACTIVE and CALL_INVALID. Also, the core package defines the CALL_EVENT_TRANSMISSION_ENDED event ID which is sent when the the application can no longer listen for Call events.

These event IDs are reported via methods in the CallListener interface (see method CallListener.CallInvalid)

The ConnectionEvent and TerminalConnectionEvent interfaces extend this interface. This reflects the fact that all Connection and TerminalConnection events are reported via the CallListener interface.

The CallEvent.getCall() method on this interface returns the Call associated with the Call event.

See Also:
Event, ConnectionEvent, TerminalConnectionEvent, CallListener, Call

Field Summary
static int CALL_ACTIVE
          The CALL_ACTIVE event indicates that the state of the Call object has changed to Call.ACTIVE.
static int CALL_EVENT_TRANSMISSION_ENDED
          The CALL_EVENT_TRANSMISSION_ENDED event indicates that the application will no longer receive Call events on the instance of the CallListener.
static int CALL_INVALID
          The CALL_INVALID event indicates that the state of the Call object has changed to 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
 Call getCall()
          Returns the Call object associated with this Call event.
 
Methods inherited from interface javax.telephony.Event
getCause, getID, getMetaEvent, getSource
 

Field Detail

CALL_ACTIVE

public static final int CALL_ACTIVE
The CALL_ACTIVE event indicates that the state of the Call object has changed to Call.ACTIVE.

This constant corresponds to a specific call state change, is passed via a CallEvent event, and is reported to the CallListener.callActive method.


CALL_INVALID

public static final int CALL_INVALID
The CALL_INVALID event indicates that the state of the Call object has changed to Call.INVALID.

This constant corresponds to a specific call state change, is passed via a CallEvent event, and is reported to the CallListener.callInvalid method.


CALL_EVENT_TRANSMISSION_ENDED

public static final int CALL_EVENT_TRANSMISSION_ENDED
The CALL_EVENT_TRANSMISSION_ENDED event indicates that the application will no longer receive Call events on the instance of the CallListener.

This constant corresponds to this specific circumstance, is passed via a CallEvent event, and is reported to the CallListener.callEventTransmissionEnded method.

Method Detail

getCall

public Call getCall()
Returns the Call object associated with this Call event.

Returns:
The Call associated with this event.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org