com.genesyslab.ail.collaboration
Interface InteractionReplyOut
- All Superinterfaces:
- AbstractInteraction, IdObject, Interaction, InteractionMail, InteractionMailOut, InteractionMultimedia, Possible, Savable
public interface InteractionReplyOut
- extends InteractionMailOut
This interface represents a reply interaction sent by a participant in a collaboration session.
The participant uses it to send a reply to the initiator of the collaboration session, and the
initiator uses it to read the reply's content.
To get an instance of this interface, the participant's application calls the reply method of
the InteractionInvitationIn interaction received for this collaboration session. Then the participant's
application uses this interface to set the message text, then send this message to the initiator of the
collaboration session. These steps are shown in the following code snippet:
//Getting the interaction for the reply
InteractionReplyOut myReply =
(InteractionReplyOut) myInteractionInvitationIn.reply("my_Participant_Place_Id") ;
//Setting the collaboration message
myReply.setMessageText("My reply is...");
//Sending the message
myReply.send();
Once the reply is sent, the collaboration status of the corresponding InteractionInvitationParentIn
interaction becomes FULFILLED. The initiator's application can get the InteractionReplyOut by calling the
InteractionInvitationParentIn.getCollaborativeReply() method.
| Methods inherited from interface com.genesyslab.ail.InteractionMailOut |
addAttachment, addAttachmentEx, addInvitationListener, copyAttachments, createCollaborationInvitation, getBccAddresses, getDraftInvitation, getReplyToAddress, getSentInvitations, isQAReview, removeAttachment, removeAttachment, removeInvitationListener, send, setBccAddresses, setCcAddresses, setFromAddress, setMessageText, setReplyToAddress, setSubject, setToAddresses |
| Methods inherited from interface com.genesyslab.ail.InteractionMultimedia |
addSuggestedCategories, delete, getAvailableQueuesForChildInteraction, getAvailableQueuesForThisInteraction, getCategoryId, getExternalId, getInteractionSubtype, getInteractionType, getIsCategoryApproved, getMaxSubjectLength, getMediaType, getQueue, getSuggestedCategories, isMarkDoneAvailable, placeInQueue, setAttachedData, setAvailableQueuesForChildInteraction, setAvailableQueuesForThisInteraction, setCategoryId, setExternalId, setIsCategoryApproved, submit, transferAgent, transferPlace, transferQueue |
| Methods inherited from interface com.genesyslab.ail.Interaction |
answerCall, countOtherPendingInteractions, getContactId, getContentBinary, getContentBinaryMimeType, getContentBinarySize, getDateCreated, getDn, getEndDate, getMedia, getNotepad, getParentInteraction, getPlace, getStatus, getStructTextMimeType, getStructuredText, getSubject, getText, getType, getUserName, isDone, markDone, merge, releaseCall, save, setContactId, setContentBinary, setContentBinaryMimeType, setContentBinarySize, setNotepad, setStructTextMimeType, setStructuredText, setText |
getCollaborationStatus
InteractionInvitationIn.Status getCollaborationStatus()
- Gets the collaboration status of this reply
- Returns:
InteractionInvitationIn.Status.- Since:
- 7.0
markDone
void markDone(Place _place)
throws RequestFailedException
- Marks this call as done.
This method must be used when this interaction is processed
in workbin (collaboration pull mode).
Uses the
Interaction.markDone() method in the
collaboration push mode.
- Parameters:
_place - a place.
- Throws:
RequestFailedException - if request cannot proceed.- Since:
- 7.0