org.mobicents.csapi.jr.slee.ui
Interface IpUICallConnection

All Superinterfaces:

IpServiceConnection, IpUIConnection

public interface IpUICallConnection
extends IpUIConnection

The Call User Interaction Service Interface provides functions to send information to, or gather information from the user (or call party) to which a call leg is connected. An application can use the Call User Interaction Service Interface only in conjunction with another service interface, which provides mechanisms to connect a call leg to a user. At present, only the Call Control service supports this capability. This interface, or the IpUI interface, shall be implemented by a Generic User Interaction SCF as a minimum requirement. The minimum required methods of interface IpUI shall be implemented.

Method Summary

void	abortActionReq(int assignmentID) This asynchronous method aborts a user interaction operation, e.g.
int	deleteMessageReq(int messageID) This asynchronous method allows to delete a recorded message.
int	recordMessageReq(TpUIInfo info, TpUIMessageCriteria criteria) This asynchronous method allows the recording of a message.

Methods inherited from interface org.mobicents.csapi.jr.slee.ui.IpUIConnection

getOriginatingAddress, release, sendInfoAndCollectReq, sendInfoReq, setOriginatingAddress

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

recordMessageReq

int recordMessageReq(TpUIInfo info,
                     TpUIMessageCriteria criteria)
                     throws TpCommonExceptions,
                            P_INVALID_NETWORK_STATE,
                            P_ILLEGAL_ID,
                            P_ID_NOT_FOUND,
                            P_INVALID_CRITERIA,
                            javax.slee.resource.ResourceException

This asynchronous method allows the recording of a message. The recorded message can be played back at a later time with the sendInfoReq() method.

Parameters:

info - Specifies the information to send to the user. This information can be either an ID (for pre-defined announcement or text), a text string, or an URL (indicating the information to be sent, e.g. an audio stream).

criteria - Defines the criteria for recording of messages

Returns:

assignmentID Specifies the ID assigned by the generic user interaction interface for a user interaction request.

Throws:

TpCommonExceptions

P_INVALID_NETWORK_STATE

P_ILLEGAL_ID

P_ID_NOT_FOUND

P_INVALID_CRITERIA

javax.slee.resource.ResourceException

deleteMessageReq

int deleteMessageReq(int messageID)
                     throws TpCommonExceptions,
                            P_ILLEGAL_ID,
                            P_ID_NOT_FOUND,
                            javax.slee.resource.ResourceException

This asynchronous method allows to delete a recorded message.

Parameters:

messageID - Specifies the message ID.

Returns:

assignmentID Specifies the ID assigned by the generic user interaction interface for a user interaction request.

Throws:

TpCommonExceptions

P_ILLEGAL_ID

P_ID_NOT_FOUND

javax.slee.resource.ResourceException

abortActionReq

void abortActionReq(int assignmentID)
                    throws TpCommonExceptions,
                           P_INVALID_ASSIGNMENT_ID,
                           javax.slee.resource.ResourceException

This asynchronous method aborts a user interaction operation, e.g. a sendInfoReq(), from the specified call leg. The call and call leg are otherwise unaffected. The user interaction call service interrupts the current action on the specified leg.

Parameters:

assignmentID - Specifies the user interaction request to be cancelled.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

javax.slee.resource.ResourceException