Jump to: navigation, search

Open Media

DevGuide2.png Purpose: To provide information about customizable commands.
Updated in: 8.1.300.17

Learn about Open Media Commands

The open media interactions are top level interfaces implemented by e-mail, chat, and work item interactions. The open media commands presented in this page are basic operations which apply to open media interactions by inheritance: e-mail, chat, and workitem interactions. E-Mails, Chat, and Work Items are specific to e-mail, chat, and work items respectively, and present an addition to the commands detailed in this page. You can also use specific Windows which apply to open media interactions in some GUI components.

Read Use Customizable Commands to see code snippets which demonstrate the usage of the commands.

Managing Open Media Interactions

Open media commands cover the following features (this list is not exhaustive):

  • Accept and decline;
  • Place in queue;
  • Transfer;
  • Move to workbins.
Chains of Commands to Manage Open Media Interactions
Default commands Parameters
Chain InteractionOpenMediaCanPullInteraction
Available since: 8.1.300.17
  • CanPullInteraction
  • CommandParameter: Dictionary<ref name="Dictionary" >Dictionary<string, object></ref>
Chain InteractionOpenMediaClose
  • IsContactModified
    Added in 8.1.4
  • CaseId: String<ref name="String" />
  • Close
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionOpenMediaCloseOnOutOfService
  • UpdateInteractionUCS
  • CommandParameter: IInteraction<ref name="IInteraction" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteraction</ref>
  • SmsReleaseParty
Available since: 8.1.100.14
  • CommandParameter: IInteractionSms<ref name="IInteractionSms" >Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Sms.IInteractionSms</ref>
  • ReleaseMyParty
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Chat.IInteractionChat</ref>
  • AfterActionMode: String <ref name="String" >System.String</ref>
  • CloseConsult
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Close
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.IInteractionOpenMedia</ref>
Chain InteractionOpenMediaConferenceAgent
  • ConferenceAgent
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Visibility: String<ref name="String" />
  • Destination: String<ref name="String" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" > Genesyslab.Enterprise.Commons.Collections.KeyValueCollection</ref>
Chain InteractionOpenMediaGetInteractionStateById
Available since: 8.1.300.17
  • GetInteractionState
  • CommandParameter: String<ref name="String" />
Chain InteractionOpenMediaHandlingTimeout
  • UpdateInteractionUCS
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • SmsReleaseParty
Available since: 8.1.100.14
  • CommandParameter: IInteractionSms<ref name="IInteractionSms" />
  • ReleaseMyParty
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • AfterActionMode: String<ref name="String" />
  • CloseConsult
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Close
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionOpenMediaMoveToQueue
Added in 8.1.4
  • PlaceInQueue
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionOpenMediaMoveToWorkbin
Added in 8.1.4
  • MoveToWorkbin
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • WorkbinId: String<ref name="String" />
  • WorkbinParameter: String<ref name="String" />
  • WorkbinType: WorkbinType<ref name="WorkbinType" > Genesyslab.Platform.OpenMedia.Protocols.OpenMediaAttributes.WorkbinType</ref>
Chain InteractionOpenMediaPlaceInQueue
  • UpdateInteractionUCS
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
Parameter available since: 8.1.300.17
  • IsContactModified
    Added in 8.1.4
  • CaseId: String<ref name="String" />
  • SaveAttachedData
Available since: 8.1.100.14
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • SetAutoClose
    Available since: 8.1.300.17
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • PlaceInQueue
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • UpdateContactInformation
    Added in 8.1.4
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" > Genesyslab.Desktop.Modules.TeamCommunicator.ObjectTC</ref>
Chain InteractionOpenMediaPullById
Available since: 8.1.300.17
  • PullInteraction
  • CommandParameter: String<ref name="String" />
  • queue: String<ref name="String" />
  • sourceType: String<ref name="String" />
  • agentId: String<ref name="String" />
Chain InteractionOpenMediaPullFromWorkbinById
Available since: 8.1.300.17
  • GetInteractionState
  • CommandParameter: String<ref name="String" />
  • CanPullInteraction
  • CommandParameter: Dictionary<ref name="Dictionary" />
  • DisplayWarningPullNotPossible
  • canPullInteraction (result: String<ref name="String" />)
  • PullFromWorkbin
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
Chain InteractionOpenMediaUCSStopProcessing
  • StopProcessing
  • CommandParameter: String<ref name="String" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionOpenMediaUCSUpdate
  • UpdateInteraction
  • CommandParameter: IInteraction<ref name="IInteraction" />
Chain InteractionOpenMediaPullFromWorkbinById
Added in 8.1.4
  • GetInteractionState
  • CommandParameter: String<ref name="String" />
  • CanPullInteraction
  • CommandParameter: Dictionary<string, object><ref name="Dictionary" />
  • DisplayWarningPullNotPossible
  • canPullInteraction (result: String<ref name="String" />)
  • PullFromWorkbin
  • CommandParameter: String<ref name="String" />
  • QueueId: String<ref name="String" />
Chain InteractionOpenMediaTransferAgent
  • SetAutoClose
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" > Genesyslab.Desktop.Modules.Windows.Interactions.INotepadViewModel</ref>
  • TransferAgent
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionOpenMediaWorkflow
  • PromptDone
Available since: 8.1.300.17
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • ConfirmParentWindow: Window<ref name="Window" >System.Window.Window</ref>
  • Workflow
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Workflow: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionPossibleToMoveToWorkbin
  • IsWorkbinDestinationDefined
    Available since: 8.1.3
  • WorkbinId: String<ref name="String" />
  • WorkbinOptionName: String<ref name="String" />
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionInternalConferenceInviteAccept
Added in 8.1.4
  • Accept
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionInternalConferenceInviteConferenceAgent
Added in 8.1.4
  • ConferenceAgent
  • CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Invite.IInteractionInternalConferenceInvite</ref>
  • Visibility: String<ref name="String" />
  • Destination: String<ref name="String" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionInternalConferenceInviteDecline
Added in 8.1.4
  • Decline
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • Close
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionInternalConferenceInvitePull
Added in 8.1.4
  • GetInteractionProperties
  • CommandParameter: String<ref name="String" />
  • Pull
  • CommandParameter: String<ref name="String" />
Chain InteractionInternalConferenceInviteSendInvite
Added in 8.1.4
  • SetCollaborationQueueContext
  • CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" />
  • System.String: Queue, output parameter
  • SetOwner
  • CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" />
  • PlaceInQueueCollaboration
  • CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" />
  • Queue: String<ref name="String" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • CorrelatorData: String<ref name="String" />
Chain InteractionInternalConferenceInviteStopProcessing
Added in 8.1.4
  • StopProcessing
  • CommandParameter: IIOpenMediaInteraction<ref name="IIOpenMediaInteraction">Genesyslab.Enterprise.Model.Interaction.IIOpenMediaInteraction</ref>
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • CorrelatorData: String<ref name="String" />


Commands common to all interactions
Chain InteractionSetAttachedDataWithDelay
  • SetAttachedData
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • AttachedData: KeyValueCollection<ref name="KeyValueCollection" />
Chain BundleClose
  • GetAttachedDataInformationUCS
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionsBundle</ref>
  • UpdateNotePadForVoice
    Available since: 8.1.300.17
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
  • ResetInteractionChatConsultation
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
  • IsContactModified
    Available since: 8.1.4
  • CaseId: String<ref name="String" />
  • IsPossibleToClose
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
  • CompleteDispositionCodeOnBundle
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
  • Close
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
  • StopInteractionVoiceUCS
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
  • GetOutboundPreviewRecord
  • CommandParameter: ICampaign<ref name="ICampaign" > Genesyslab.Enterprise.Model.Interaction.ICampaign</ref>

<references />

This page was last modified on March 25, 2013, at 03:00.

Feedback

Comment on this article:

blog comments powered by Disqus