The ININ.IceLib.Interactions namespace contains classes for manipulating Interaction Center interaction queues.

There are a number of classes within the ININ.IceLib.Interactions namespace that provide support to the classes mentioned in the preceding summary. Example of the supporting classes are enumerations, event argument classes, and delegates used by events within classes.

Queue Watches. There are a number of object classes that are used to get specific attributes for the Interactions contained in a given Interaction Queue. They are watched, meaning, that any time an attribute is changed, the internal cache of that object is kept up to date so anytime that attribute's property is referenced the current value will be returned. An event notification is available when any of the attributes changes in value.

Note
If the entire contents of an InteractionQueue is to be watched, Queue watches are more efficient than having individual Interaction watches on each Interaction in the Queue.

Interaction Watches. There are a number of object classes that are used to get specific attributes for a given Interaction. They are watched, meaning, that any time an attribute is changed, the internal cache of that object is kept up to date so anytime that attribute's property is referenced the current value will be returned. An event notification is available when any of the attributes changes in value. All such objects inherit from Interaction. Examples of Interaction classes are: CallInteraction, ChatInteraction, and EmailInteraction.

Interaction Conferences. The InteractionConference object provides information about a conference of interactions. Additionally, the InteractionQueue object provides support for watching attribute changes for Interactions within conferences contained on an interaction queue.

Note
For more information on getting started with queues and interactions see Getting Started With Interactions.

Classes

	Class	Description
	ActionParameterNames	Parameter name strings used with the PerformingActionEventArgs and PerformedActionEventArgs event argument classes.
	AgentAssistanceList	This class represents a collection of assistance request items belonging to an agent.
	AgentHelpRequest	Obsolete. This class represents an agent's request for help from a supervisor.
	AgentHelpRequestEventArgs	Obsolete. Provides data for the AgentHelpRequested event. The AgentHelpRequest object is contained in objects of this class.
	AgentHelpResponse	Obsolete. This class represents a supervisor's response to an agent's help request.
	AgentHelpResponseEventArgs	Obsolete. Provides data for the AgentHelpResponseReceived event.
	AssistanceItem	This class represents an Agent Assistance Request Item.
	AssistanceItemChangedEventArgs	Provides data for the ItemChanged event of an AssistanceItem.
	AssistanceItemMessageAddedEventArgs	Provides data for the MessageAdded event of an AssistanceItem.
	AssistanceItemParticipantEventArgs	Provides data for the ParticipantAdded and ParticipantChanged event of an AssistanceItem.
	AssistanceItemParticipantRemovedEventArgs	Provides data for the ParticipantRemoved event of an AssistanceItem.
	AssistanceItemStateChangedEventArgs	Provides data for the StateChanged event of an AssistanceItem.
	AssistanceList	This class represents the list of assistance request items that belong to an agent and/or supervisor.
	AssistanceListEventArgs	Provides data for the ItemAdded/ItemRemoved events of an AssistanceList.
	AssistanceListItemAddedEventArgs	Provides data for the ItemAdded event of an AssistanceList.
	AssistanceMessage	Describes data associated with a message for an AssistanceItem.
	AssistanceParticipant	Describes a participant associated with an AssistanceItem.
	AssistanceRequestCompletedEventArgs	Provides data for the SendAssistanceRequestAsync(SendAssistanceRequestParameters, EventHandler<(Of <<'(AssistanceRequestCompletedEventArgs>)>>), Object)completedCallback delegate of InteractionsManager.
	AsyncStartWatchCompletedEventArgs	Provides data for the completedCallback delegate of StartWatchingAsync(EventHandler<(Of <<'(AsyncStartWatchCompletedEventArgs>)>>), Object), GetStringAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(String>)>>)>)>>), Object), GetIntegerAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(Int32>)>>)>)>>), Object), and GetDateTimeAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(DateTime>)>>)>)>>), Object) events of a InteractionAlerting.
	AttributeMonitorId	Identifies an InteractionAttributeMonitor within the Interaction Center system. InteractionAttributeMonitor has more details.
	AttributesEventArgs	Provides data for the AttributesChanged event of a Interaction.
	CallbackInteraction	Represents a callback interaction within the Interaction Center system. Callback interactions occur when agents call a customer in accordance with a callback request.
	CallbackInteractionAttributeName	Specifies attribute names that can be used with CallbackInteractions.
	CallbackInteractionParameters	Provides details when creating Callback Interactions via MakeCallbackInteraction(CallbackInteractionParameters).
	CallbackSetCompletionParameters	Provides details when completing a callback via CallbackInteraction's SetCompletion method.
	CallInteraction	Represents a call within the Interaction Center system.
	CallInteractionParameters	Provides details when making a call via InteractionsManager's MakeCall method.
	CallMadeEventArgs	Provides data for the CallMade event.
	ChatInteraction	Represents a chat within the Interaction Center system.
	ChatMember	Represents a member (person participating) in a ChatInteraction.
	ChatMemberEventArgs	Provides data for the ChatMemberAdded/Changed/Removed events of a ChatInteraction.
	ChatText	Represents a single chat entry in a ChatInteraction.
	ChatUpdateEventArgs	Provides data for the ChatMemberAdded/Removed events of a ChatInteraction.
	ConferenceId	Identifies a Conference within the Interaction Center system.
	ConferenceInteractionAttributesEventArgs	Provides data for the ConferenceInteractionChanged event of an InteractionQueue object.
	ConferenceInteractionEventArgs	Provides data for the events involving a single Interaction conference member.
	ConferenceItemData	Contains information about a conference item.
	ConsultTransfer	Represents a consult transfer between a caller, agent, and consult.
	ConsultTransferParameters	Provides details when creating Consult Transfers via MakeConsultTransfer(ConsultTransferParameters).
	EmailAddress	Represents a resolved Email address from an EmailResolver.
	EmailAddressesEventArgs	Provides data for the EmailResolved event.
	EmailBody	Represents an email body within an EmailContent.
	EmailContent	Represents the content for an EmailInteraction.
	EmailContentUpdateEventArgs	Used to notify listeners of updated email contents.
	EmailCreateResponseCompletedEventArgs	Represents the completion of a CreateResponseAsync(EmailContent, EmailResponseType, EventHandler<(Of <<'(EmailCreateResponseCompletedEventArgs>)>>), Object) call.
	EmailDownloadMessageAttachmentCompletedEventArgs	Represents the completion of a DownloadMessageAttachmentAsync(EmailMessageAttachment, EventHandler<(Of <<'(EmailDownloadMessageAttachmentCompletedEventArgs>)>>), Object) call.
	EmailEncryptionCertificate	Definition for EmailEncryptionCertificate class.
	EmailFileAttachment	Represents an attachment to an EmailInteraction.
	EmailInteraction	Represents an email within the Interaction Center system.
	EmailInteractionAttributeName	Specifies attribute names that can be used with EmailInteraction.
	EmailInteractionParameters	Provides details when making an email via InteractionsManager's MakeEmail method.
	EmailMessageAttachment	Represents a message attachment to a EmailInteraction.
	EmailResolver	Allows resolving Email addresses within the Interaction Center system.
	EmailSignatureCertificate	Definition for EmailSignatureCertificate class.
	GenericInteraction	Represents a generic interaction object within the Interaction Center system.
	GenericInteractionParameters	Provides details when creating Generic Interactions via MakeGenericInteraction(GenericInteractionParameters).
	GetAttributeCompletedEventArgs<(Of <(<'TAttributeValue>)>)>	Provides data for the completedCallback delegate of GetBooleanAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(Boolean>)>>)>)>>), Object), GetStringAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(String>)>>)>)>>), Object), GetIntegerAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(Int32>)>>)>)>>), Object), and GetDateTimeAttributeAsync(String, EventHandler<(Of <<'(GetAttributeCompletedEventArgs<(Of <<'(DateTime>)>>)>)>>), Object) events of a Interaction.
	GetContentsCompletedEventArgs	Provides data for asynchronous completed events of InteractionConference and InteractionQueue.
	GetStringAttributesCompletedEventArgs	Provides data for the completedCallback delegate of GetStringAttributesAsync(array<String>[]()[][], EventHandler<(Of <<'(GetStringAttributesCompletedEventArgs>)>>), Object) events of a Interaction.
	HistoryItem	Contains history information for an Interaction.
	InitiateSecureInputCompletedEventArgs	Provides data for the InitiateSecureInputAsync(SecureInputParameters, EventHandler<(Of <<'(InitiateSecureInputCompletedEventArgs>)>>), Object)'s completedCallback delegate of Interaction.
	Interaction	Represents an Interaction within the Interaction Center system.
	InteractionAlerting	This class provides information about Interactions that are alerting for the Session User.
	InteractionAlertingDetails	Provides details for alerting via the InteractionAlerting class.
	InteractionAlertingEventArgs	Provides data for the AlertReceived event.
	InteractionAttributeMonitor	Allows attribute level monitors on the Interaction Center system.
	InteractionAttributeName	Specifies attribute names that can be used with Interaction watches.
	InteractionAttributesEventArgs	Provides data for the InteractionAttributesChanged event of a InteractionQueue.
	InteractionCompletedEventArgs	Provides data for the asynchronous completed events of InteractionsManager.
	InteractionConference	Represents a conference within the Interaction Center system.
	InteractionEventArgs	Provides data for events involving a single Interaction.
	InteractionId	Identifies an Interaction within the Interaction Center system.
	InteractionMonitor	Represents a monitoring on an Interaction.
	InteractionQueue	Represents a queue of Interactions within the Interaction Center system.
	InteractionRecord	Represents a recording of an Interaction.
	InteractionSegment	A segment of an Interaction.
	InteractionsHistory	Provides access to interaction history information for a user.
	InteractionsManager	Provides access to Interactions and InteractionQueues.
	InvitePartyCompletedEventArgs	Provides data for the InvitePartyAsync(InteractionId, InvitePartyParameters, EventHandler<(Of <<'(InvitePartyCompletedEventArgs>)>>), Object)completedCallback delegate of InvitePartyAsync(InteractionId, InvitePartyParameters, EventHandler<(Of <<'(InvitePartyCompletedEventArgs>)>>), Object).
	InvitePartyParameters	Provides details when inviting a party via InviteParty(InteractionId, InvitePartyParameters).
	MakeCallbackInteractionCompletedEventArgs	Provides data for the MakeCallbackInteractionAsync(CallbackInteractionParameters, EventHandler<(Of <<'(MakeCallbackInteractionCompletedEventArgs>)>>), Object) completedCallback delegate of InteractionsManager.
	MakeCallException	This exception is thrown by various MakeCall methods of InteractionsManager when the server is unable to make a call.
	MakeChatCompletedEventArgs	Provides data for the MakeChatAsync(String, EventHandler<(Of <<'(MakeChatCompletedEventArgs>)>>), Object) completedCallback delegate of InteractionsManager.
	MakeConsultTransferCompletedEventArgs	Provides data for the MakeConsultTransferAsync(ConsultTransferParameters, EventHandler<(Of <<'(MakeConsultTransferCompletedEventArgs>)>>), Object)completedCallback delegate of InteractionsManager.
	MakeEmailCompletedEventArgs	Provides data for the MakeEmailAsync(EmailInteractionParameters, EventHandler<(Of <<'(MakeEmailCompletedEventArgs>)>>), Object) completedCallback delegate of InteractionsManager.
	MakeGenericInteractionCompletedEventArgs	Provides data for the MakeGenericInteractionAsync(GenericInteractionParameters, EventHandler<(Of <<'(MakeGenericInteractionCompletedEventArgs>)>>), Object) completedCallback delegate of InteractionsManager.
	MakeNewConferenceCompletedEventArgs	Provides data for the MakeNewConferenceAsync(array<Interaction>[]()[][], EventHandler<(Of <<'(MakeNewConferenceCompletedEventArgs>)>>), Object) completedCallback delegate of InteractionsManager.
	MonitoredQueueAlerting	This class provides the main interface to enable alerting on a monitored queue.
	MonitorInteraction	Represents a monitor interaction within the Interaction Center system.
	MonitorInteractionAttributeName	Specifies attribute names that can be used with the MonitorInteractions class.
	NotificationsSuspendedEventArgs	Provides data for the NotificationsSuspendedChanged notification.
	PerformedActionEventArgs	Provides data for the PerformingAction event.
	PerformingActionEventArgs	Provides data for the PerformingAction event.
	PhoneNumber	Detailed information about a phone number within the Interaction Center system.
	QueryPhoneNumberDetailsCompletedEventArgs	Provides data for the QueryPhoneNumberDetailsAsync(array<String>[]()[][], EventHandler<(Of <<'(QueryPhoneNumberDetailsCompletedEventArgs>)>>), Object) completedCallback delegate of InteractionsManager.
	QueueConferenceItem	Provides queue conference item details for QueueContentsChangedEventArgs.
	QueueConferenceItemAttributes	Provides queue conference item details for QueueContentsChangedEventArgs.
	QueueContentsChangedEventArgs	Provides data for the QueueContentsChanged event of a InteractionQueue.
	QueueId	Identifies an InteractionQueue within the Interaction Center system.
	QueueItem	Provides queue item details for QueueContentsChangedEventArgs.
	QueueItemAttributes	Provides queue item details for QueueContentsChangedEventArgs.
	RecorderInteraction	Represents a recorder interaction within the Interaction Center system.
	RecorderInteractionAttributeName	Specifies attribute names that can be used with RecorderInteractions.
	RecordingSnippetCreatedEventArgs	Provides data for the RecordingSnippetCreated event of a Interaction.
	RelatedSnippetRecording	Represents a related snippet recording of an Interaction.
	ScreenPop	This class serves as the main interface for tracking when DDE screen pops occur.
	ScreenPopEventArgs	Provides data for the screen pop events of ScreenPop.
	ScreenPopItem	This class contains the ScreenPop event data.
	SecureInputParameters	Provides details when initiating secure input via the InitiateSecureInput(SecureInputParameters) method.
	SecureRecordingPauseParameters	Provides a mechanism to pass secure recording pause parameters. Used in SecureRecordingPause(SecureRecordingPauseParameters) and SecureRecordingPauseAsync(SecureRecordingPauseParameters, AsyncCompletedEventHandler, Object).
	SendAssistanceRequestParameters	Provides details when sending an assistance request via SendAssistanceRequest(SendAssistanceRequestParameters).
	SensitiveAttributeDataContext	Provides access to the Session's sensitive data context for Interaction attributes.
	SocialConversationInteraction	SocialConversationInteraction - Social Conversation Interactions are handled here
	SocialDirectMessageInteraction	Represents Social Direct Message within the Interaction Center system.
	SupervisorAssistanceList	This class represents a collection of assistance request items belonging to a supervisor.
	WrapUpAssignment	Representation of an assignment of a wrap-up code to a segment of an interaction.

Enumerations

	Enumeration	Description
	AssistanceItemState	Defines the states for an AssistanceItem.
	AssistanceParticipantAction	Describes the action of an AssistanceParticipant in regards to an AssistanceItem.
	CallAnalysisType	Used to specify if analysis needs to be performed on a call.
	CallbackCompletion	Specifies constants indicating the completion of a CallbackInteraction.
	CallMadeStage	Specifies constants indicating when the CallMade event should be raised.
	ChatMemberType	Specifies constants indicating the whether a ChatMember is internal or external.
	ConsultTransferParticipants	The participants in a ConsultTransfer.
	EmailCloneAttachmentType	Determines what attachments from the source email to include when an EmailContent object is cloned.
	EmailEncryptionStatus	Possible encryption status of an EmailInteraction.
	EmailInteractionCapabilities	Specifies constants indicating the capabilities of an EmailInteraction.
	EmailPriority	The priority of an e-mail.
	EmailResponseType	Specifies constants indicating the response type of an EmailInteraction.
	EmailSignatureStatus	Possible status of an DigitalSignatures.
	HistoryItemFlags	An set of flags to indicate the status of the interaction.
	HistoryItemProperty	Each value in the enumeration represents a property of HistoryItem.
	InteractionAlertAction	Indicates the action that needs to be taken when an alert event is received.
	InteractionAlertType	Represents the reason why an interaction is alerting.
	InteractionCallPartyType	Specifies constants indicating the party type of a call.
	InteractionCallType	Specifies constants indicating the call type.
	InteractionCapabilities	Specifies constants indicating the capabilities of an Interaction.
	InteractionDirection	Specifies constants indicating the direction of an Interaction.
	InteractionMonitorType	Specifies constants indicating the type of an Interaction monitor.
	InteractionPartyType	Represents local party type and remote party type of an interaction.
	InteractionSecurityLevel	Specifies constants indicating the security level of an Interaction.
	InteractionState	Specifies constants indicating the state of an Interaction.
	InteractionType	Specifies constants indicating the type of an Interaction.
	IsdnCauseCode	ISDN Cause Codes that may have been returned when placing a call.
	MakeCallFailureCode	Call failure codes describing the results of an attempt to place a call.
	MonitoredQueueAlertMode	Specifies if an alert should be a silent alert or not.
	QueueType	Specifies constants indicating the type of an InteractionQueue.
	SecureRecordingPauseAction	Specifies the secure recording pause action that should be taken.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.