javax.telephony
Interface SingleCallMetaEvent

All Superinterfaces:

Event, MetaEvent

public interface SingleCallMetaEvent

extends MetaEvent

The SingleCallMetaEvent interface is the base interface for all single-call Call Meta events. All single-call MetaEvent's must extend this interface. Events which extend this interface are reported via the CallListener interface.

An individual SingleCallMetaEvent conveys, directly and with necessary details, what an application needs to know to respond to a higher-level call event that only effects a single call. The specific SingleCallMetaEvent event is indicated by the Event.getID() value returned by the event.

Since all these Meta events relate to a single JTAPI Call entity, this interface provides the method getCall to grant the application access to the affected Call.

The core package defines events which are reported when high-level actions occur. The event IDs (as returned by Event.getID()) are: SINGLECALL_META_PROGRESS_STARTED, SINGLECALL_META_PROGRESS_ENDED, MULTICALL_META_TRANSFER_STARTED and MULTICALL_META_TRANSFER_ENDED.

See Also:

CallListener, Call

Field Summary

static int	SINGLECALL_META_PROGRESS_ENDED The SINGLECALL_META_PROGRESS_ENDED event indicates that the current call in the telephony platform has changed state, and all the events that were associated with that change have now been reported.
static int	SINGLECALL_META_PROGRESS_STARTED The SINGLECALL_META_PROGRESS_STARTED event indicates that the current call in the telephony platform has changed state, and events will follow which indicate the changes to this call.
static int	SINGLECALL_META_SNAPSHOT_ENDED The SINGLECALL_META_SNAPSHOT_ENDED event indicates that the JTAPI implementation has finished reporting a set of simulated state changes that in effect construct the current state of the call.
static int	SINGLECALL_META_SNAPSHOT_STARTED The SINGLECALL_META_SNAPSHOT_STARTED event indicates that the JTAPI implementation is reporting to the application the current state of the call on the associated telephony platform, by reporting a set of simulated state changes that in effect construct the current state of the call.

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 the higher-level operation reported by this SingleCallMetaEvent event.

Methods inherited from interface javax.telephony.Event

getCause, getID, getMetaEvent, getSource

Field Detail

SINGLECALL_META_PROGRESS_STARTED

public static final int SINGLECALL_META_PROGRESS_STARTED

The SINGLECALL_META_PROGRESS_STARTED event indicates that the current call in the telephony platform has changed state, and events will follow which indicate the changes to this call.

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

SINGLECALL_META_PROGRESS_ENDED

public static final int SINGLECALL_META_PROGRESS_ENDED

The SINGLECALL_META_PROGRESS_ENDED event indicates that the current call in the telephony platform has changed state, and all the events that were associated with that change have now been reported.

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

SINGLECALL_META_SNAPSHOT_STARTED

public static final int SINGLECALL_META_SNAPSHOT_STARTED

The SINGLECALL_META_SNAPSHOT_STARTED event indicates that the JTAPI implementation is reporting to the application the current state of the call on the associated telephony platform, by reporting a set of simulated state changes that in effect construct the current state of the call. The events which follow convey that current state.

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

SINGLECALL_META_SNAPSHOT_ENDED

public static final int SINGLECALL_META_SNAPSHOT_ENDED

The SINGLECALL_META_SNAPSHOT_ENDED event indicates that the JTAPI implementation has finished reporting a set of simulated state changes that in effect construct the current state of the call.

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

Method Detail

getCall

public Call getCall()

Returns the Call object associated with the higher-level operation reported by this SingleCallMetaEvent event.

Returns:

The result Call associated with this event.