org.eclipse.ecf.telephony.call
Interface ICallSessionContainerAdapter

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable
All Known Subinterfaces:
ICallSessionService

public interface ICallSessionContainerAdapter
extends org.eclipse.core.runtime.IAdaptable

Call session container entry point adapter. This interface is an adapter to allow providers to expose call sessions to clients. It may be used in the following way:

  ICallSessionContainerAdapter callcontainer = (ICallSessionContainerAdapter) container.getAdapter(ICallSessionContainerAdapter.class);
  if (callcontainer != null) {
     // use callcontainer to create call sessions
     ...
  } else {
     // container does not support call container functionality
  }
 


Method Summary
 void addCallSessionRequestListener(ICallSessionRequestListener listener)
          Add listener for call session request event reception
 Namespace getReceiverNamespace()
          Get namespace for creating IDs for receiving call initiation requests.
 void removeCallSessionRequestListener(ICallSessionRequestListener listener)
          Remove listener for call session request event reception
 void sendCallRequest(ID[] receivers, ICallSessionListener listener, java.util.Map properties)
          Initiate call.
 void sendCallRequest(ID receiver, ICallSessionListener listener, java.util.Map properties)
          Initiate call.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getReceiverNamespace

Namespace getReceiverNamespace()
Get namespace for creating IDs for receiving call initiation requests.

Returns:
Namespace for creating IDs for call initiation requests.

addCallSessionRequestListener

void addCallSessionRequestListener(ICallSessionRequestListener listener)
Add listener for call session request event reception

Parameters:
listener - the ICallSessionRequestListener to receive call session request events

removeCallSessionRequestListener

void removeCallSessionRequestListener(ICallSessionRequestListener listener)
Remove listener for call session request event reception

Parameters:
listener - the ICallSessionRequestListener to remove

sendCallRequest

void sendCallRequest(ID[] receivers,
                     ICallSessionListener listener,
                     java.util.Map properties)
                     throws CallException
Initiate call. This is the entry point for initiating calls.

Parameters:
receivers - the intended receivers of the call initiation request. Must not be null.
listener - a listener for asynchronous ICallSessionEvent. Must not be null.
properties - an optional Map of properties. May be null.
Throws:
CallException - if call request cannot be sent

sendCallRequest

void sendCallRequest(ID receiver,
                     ICallSessionListener listener,
                     java.util.Map properties)
                     throws CallException
Initiate call. This is the entry point for initiating calls.

Parameters:
receiver - the intended receiver of the call initiation request. Must not be null.
listener - a listener for asynchronous ICallSessionEvent. Must not be null.
properties - an optional Map of properties. May be null.
Throws:
CallException - if call request cannot be sent