|
Oracle Communications Converged Application Server Java API Reference 5.1 E36938-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Communication
Represents a communication session. Conversation, MessageObservation, Conference, and the other subinterfaces are each a type of Communication that may occur between Participants. A communication session occurs between Participants of the Communication, thus a Communication consists of different types of Participants.
Note that an object of this type is a server side representation.
CommunicationSession
, CommunicationService
, Participant
, CommunicationBean
Nested Class Summary | |
---|---|
static class |
Communication.State Different Communication States. |
Method Summary | ||
---|---|---|
|
addAgent(String name, Agent<T> agent) Set an agent instance in the communication. |
|
void |
end() End the communication. |
|
|
getAgent(String name) Gets the agent from its name. |
|
Collection<Agent> |
getAgents() Retrieve the agent instance pertaining to the communication. |
|
Participant |
getInitiator() Retrieves the participant initiating the communication. |
|
String |
getName() Returns the name of the communication. |
|
Communication.State |
getState() Return the current state of communication. |
|
|
removeAgent(String name) Method to remove an agent from the communication. |
Method Detail |
---|
void end()
Communication.State getState()
String getName()
Conversation
, Conference
<T> void addAgent(String name, Agent<T> agent)
T
- Type of Agent.agent
- An instance of Agent.Agent
Collection<Agent> getAgents()
<T> Agent<T> getAgent(String name)
name
- Name of the Agent<T> Agent<T> removeAgent(String name)
T
- typename
- name of the agent.Participant getInitiator()
For example, if a Conference is initiated by a phone, the party executing the createConference() method is identified as the initiator. However, if a Conference is initiated by a web-based application, the com.oracle.sft.api.Focus interface is the initiator.
Similarly, when a Conversation is initiated using a phone, the caller is the initiator. If a Conversation is instead initiated using a web-based application, the initiator is specified by the CommunicationSession.createConversation() method.
Participant
|
Oracle Communications Converged Application Server Java API Reference 5.1 E36938-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2012 Oracle Corporation. All Rights Reserved.