Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


com.oracle.sft.api
Interface MSRPConversation

All Superinterfaces:
Communication, Interaction

public interface MSRPConversation
extends Interaction

An interaction object that represents the session-mode instant messaging or chat session among two participants. In addition to text messaging, this communication object can be used for transferring large files among two participants.

MSRPConversation is created by the SFT internally for the incoming MSRP requests. Upon the creation of MSRPConversation, CommunicationEvent.Type.INITIALIZATION event will be invoked on the CommunicationBean.

MSRPConversation also can be created by invoking the related API .

There are two ways to create this communication object:

   CommunicationSession.createMSRPConversation(String initiator)
   CommunicationSession.createMSRPConversation(String initiator, String name)
 

If the CommunicationBean creates a MSRPConference with this conversation, then this conversation will be terminated, and the MSRPConference will be initiated. (Refer MSRPConference usage examples).

If the CommunicationBean either does not handle the event or does not create the MSRPConference, then the MSRPConversation between the two remote parties will be established.


Nested Class Summary

 

Nested classes/interfaces inherited from interface com.oracle.sft.api.Communication
Communication.State

 

Method Summary
 Participant getCallee()
          Return the callee in the MSRPConversation .
 Participant getCaller()
          Return the caller who initiated the MSRPConversation..
 Participant getOtherParty(Participant p)
          Get the other party of the specified participant in this MSRPConversation.

 

Methods inherited from interface com.oracle.sft.api.Interaction
addParticipant, addParticipant, addParticipant, addParticipant, getParticipant, getParticipant, removeParticipant, removeParticipant, replaceParticipant, replaceParticipant

 

Methods inherited from interface com.oracle.sft.api.Communication
addAgent, end, getAgent, getAgents, getInitiator, getName, getState, removeAgent

 

Method Detail

getCaller

Participant getCaller()
Return the caller who initiated the MSRPConversation..
Returns:
The caller Participant.

getCallee

Participant getCallee()
Return the callee in the MSRPConversation .
Returns:
Callee participant

getOtherParty

Participant getOtherParty(Participant p)
Get the other party of the specified participant in this MSRPConversation.
Parameters:
p - The caller or callee of current MSRPConversation.
Returns:
if p is caller, then callee is returned; if p is callee, caller is returned; otherwise, return null.

Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


Copyright © 2012 Oracle Corporation. All Rights Reserved.