org.eclipse.ecf.telephony.call
Interface ICallSession

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IIdentifiable

public interface ICallSession
extends IIdentifiable, org.eclipse.core.runtime.IAdaptable

Contract for interacting with an arbitrary call session.

Method Summary

CallSessionErrorDetails	getErrorDetails() Get error information.
CallSessionFailureReason	getFailureReason() Get the reason for failure.
ID	getInitiator() Get ID of initiator.
ICallSessionListener	getListener() Get listener for this call session instance.
ID	getReceiver() Get ID of receiver.
CallSessionState	getState() Get call session state
void	sendTerminate() Send terminate message to given receiver

Methods inherited from interface org.eclipse.ecf.core.identity.IIdentifiable

getID

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getInitiator

ID getInitiator()

Get ID of initiator. Will not be null.

Returns:

ID of initiator. Will not be null.

getReceiver

ID getReceiver()

Get ID of receiver. Will not be null.

Returns:

ID of receiver. Will not be null.

getListener

ICallSessionListener getListener()

Get listener for this call session instance.

Returns:

ICallSessionListener for this ICallSession. Will not be null.

getState

CallSessionState getState()

Get call session state

Returns:

CallSessionState current call session state

getFailureReason

CallSessionFailureReason getFailureReason()

Get the reason for failure. Will be null unless the returned value from getState() is CallSessionState.FAILED.

Returns:

CallSessionFailureReason associated with previous call failure. Will be null unless the current CallSessionState is CallSessionState.FAILED.

getErrorDetails

CallSessionErrorDetails getErrorDetails()

Get error information. Will be null unless the returned value from getState() is CallSessionState.ERROR

Returns:

CallSessionErrorDetails instance associated with CallSessionState.ERROR

sendTerminate

void sendTerminate()
                   throws CallException

Send terminate message to given receiver

Throws:

CallException - exception if cannot send terminate