javax.telephony
Interface MultiCallMetaEvent

All Superinterfaces:

Event, MetaEvent

public interface MultiCallMetaEvent

extends MetaEvent

The MultiCallMetaEvent interface is the base interface for all multiple-call Call Meta events (multi-call MetaEvent). All multi-call MetaEvent's must extend this interface. Events which extend this interface are reported via the CallListener interface.

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

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

See Also:

CallEvent, MetaEvent, CallListener, Call

Field Summary

static int	MULTICALL_META_MERGE_ENDED The MULTICALL_META_MERGE_ENDED event indicates that calls have merged, and that all state change events resulting from this merge have been reported.
static int	MULTICALL_META_MERGE_STARTED The MULTICALL_META_MERGE_STARTED event indicates that calls are merging, and events will follow which indicate the changes to those calls.
static int	MULTICALL_META_TRANSFER_ENDED The MULTICALL_META_TRANSFER_ENDED event indicates that a transfer has completed, and that all state change events resulting from this transfer have been reported.
static int	MULTICALL_META_TRANSFER_STARTED The MULTICALL_META_TRANSFER_STARTED event indicates that a transfer is occurring, and events will follow which indicate the changes to the affected calls.

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	getNewCall() Returns the Call object associated with the result of the multiple-call operation reported by this MultiCallMetaEvent event.
Call[]	getOldCalls() Returns an array of Call objects which were considered input to the multiple-call operation reported by this MultiCallMetaEvent event.

Methods inherited from interface javax.telephony.Event

getCause, getID, getMetaEvent, getSource

Field Detail

MULTICALL_META_MERGE_STARTED

public static final int MULTICALL_META_MERGE_STARTED

The MULTICALL_META_MERGE_STARTED event indicates that calls are merging, and events will follow which indicate the changes to those calls. The former calls involved are returned by MultiCallMetaEvent.getOldCalls() and the resulting call is returned by MultiCallMetaEvent.getNewCall().

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

MULTICALL_META_MERGE_ENDED

public static final int MULTICALL_META_MERGE_ENDED

The MULTICALL_META_MERGE_ENDED event indicates that calls have merged, and that all state change events resulting from this merge have been reported.

The former calls involved are returned by MultiCallMetaEvent.getOldCalls() and the resulting call is returned by MultiCallMetaEvent.getNewCall().

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

MULTICALL_META_TRANSFER_STARTED

public static final int MULTICALL_META_TRANSFER_STARTED

The MULTICALL_META_TRANSFER_STARTED event indicates that a transfer is occurring, and events will follow which indicate the changes to the affected calls. The former calls involved are returned by MultiCallMetaEvent.getOldCalls() and the resulting call is returned by MultiCallMetaEvent.getNewCall().

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

MULTICALL_META_TRANSFER_ENDED

public static final int MULTICALL_META_TRANSFER_ENDED

The MULTICALL_META_TRANSFER_ENDED event indicates that a transfer has completed, and that all state change events resulting from this transfer have been reported.

The former calls involved are returned by MultiCallMetaEvent.getOldCalls() and the resulting call is returned by MultiCallMetaEvent.getNewCall().

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

Method Detail

getNewCall

public Call getNewCall()

Returns the Call object associated with the result of the multiple-call operation reported by this MultiCallMetaEvent event.

Returns:

The result Call associated with this event.

getOldCalls

public Call[] getOldCalls()

Returns an array of Call objects which were considered input to the multiple-call operation reported by this MultiCallMetaEvent event.

Returns:

An array of old Calls associated with this event's operation.