com.genesyslab.ail.collaboration
Interface InteractionInvitationIn

All Superinterfaces:
AbstractInteraction, IdObject, Interaction, InteractionMail, InteractionMailIn, InteractionMultimedia, Possible, Savable

public interface InteractionInvitationIn
extends InteractionMailIn

InteractionInvitationIn is an interaction for the collaboration feature. This interface represents an invitation interaction for a Participant in a collaboration session. It includes the following features:

Getting instances of this interface depends on the collaboration mode:

Answer this incoming interaction as a common e-mail by calling the answerCall method.

Once the interaction is in TALKING status, accept the collaboration by calling the accept(com.genesyslab.ail.Place) method, or decline the invitation by calling the decline(com.genesyslab.ail.Place) method.

If the agent accepts, he or she can reply to the invitation, as shown in the following code snippet:
//Getting the interaction for the reply
InteractionReplyOut myReply = (InteractionReplyOut) myInteractionInvitationIn.reply("my_Participant_Place_Id") ;

See Also:
InteractionReplyOut

Nested Class Summary
static class InteractionInvitationIn.Action
          Actions possible on incoming e-mails.
static class InteractionInvitationIn.Status
          Constants for interaction statuses, common for all media.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.InteractionMultimedia
InteractionMultimedia.StopProcessingReason
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.Interaction
Interaction.Type
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.AbstractInteraction
AbstractInteraction.AbstractCallType
 
Field Summary
 
Fields inherited from interface com.genesyslab.ail.InteractionMail
QUOTE_HEADER_CONTACT, QUOTE_HEADER_DATE
 
Method Summary
 void accept(Place _place)
          Accepts the invitation.
 void decline(Place _place)
          Declines the invitation.
 InteractionInvitationIn.Status getCollaborationStatus()
          Gets the collaboration status of this invitation.
 InteractionReplyOut getCollaborativeReply()
          Gets the collaborative reply of this invitation if any.
 boolean isParentView()
          Gets the InvitationIn point of view, true if it is Parent point of view or false if it is Child point of view..
 void markDone(Place _place)
          Marks this call as done.
 InteractionMailOut reply(Place _place)
          Replies to the invitation.
 
Methods inherited from interface com.genesyslab.ail.InteractionMailIn
getCurrentReplyMailOut, getCustomData, getExternalAgentTransferAddress, getMailbox, getReplyToAddress, isEscalated, reply, reply, transferExternalAgent
 
Methods inherited from interface com.genesyslab.ail.InteractionMail
getAttachment, getAttachments, getCcAddresses, getDateSent, getFromAddress, getMessageText, getMimeMessage, getToAddresses, hasAttachments
 
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, setSubject, setText
 
Methods inherited from interface com.genesyslab.ail.AbstractInteraction
addInteractionListener, getAttachedData, getAttachedData, getAttachedDataEx, getTConnectionId, queryStatus, removeAttachedData, removeInteractionListener, saveAttachedData, setAttachedData
 
Methods inherited from interface com.genesyslab.ail.Possible
arePossible, isPossible
 
Methods inherited from interface com.genesyslab.ail.Savable
getContactServerId, isDirty
 

Method Detail

accept

void accept(Place _place)
            throws RequestFailedException
Accepts the invitation.

Parameters:
_place - a place
Throws:
RequestFailedException - if request cannot proceed.
Since:
7.0

decline

void decline(Place _place)
             throws RequestFailedException
Declines the invitation.

Parameters:
_place - a place
Throws:
RequestFailedException - if request cannot proceed.
Since:
7.0

reply

InteractionMailOut reply(Place _place)
                         throws RequestFailedException
Replies to the invitation.

Parameters:
_place - a place
Throws:
RequestFailedException - if request cannot proceed.
Since:
7.0

getCollaborativeReply

InteractionReplyOut getCollaborativeReply()
                                          throws RequestFailedException
Gets the collaborative reply of this invitation if any.

Returns:
InteractionReplyOut
Throws:
RequestFailedException - if request cannot proceed.
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

getCollaborationStatus

InteractionInvitationIn.Status getCollaborationStatus()
Gets the collaboration status of this invitation.

Returns:
InteractionInvitationIn.Status
Since:
7.0

isParentView

boolean isParentView()
Gets the InvitationIn point of view, true if it is Parent point of view or false if it is Child point of view..

Returns:
true if InteractionInvitationIn Parent point of view.