The Interaction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| Interaction |
Initializes a new instance of the Interaction class.
|
Methods
| Name | Description | |
|---|---|---|
| AppendNote |
Appends to the Notes.
| |
| AppendNoteAsync |
Asynchronously appends to the Notes.
| |
| AppendStringAttribute |
Sets the value of a string attribute.
| |
| AppendStringAttributeAsync |
Asynchronously sets the value of a string attribute.
| |
| BlindTransfer(String) |
Performs a blind transfer to the specified number given the number as a string.
| |
| BlindTransfer(QueueId) |
Performs a blind transfer to the specified target, given the QueueId of the target.
| |
| BlindTransferAsync(String, AsyncCompletedEventHandler, Object) |
Asynchronously performs a blind transfer to the specified number, given that number as a string.
| |
| BlindTransferAsync(QueueId, AsyncCompletedEventHandler, Object) |
Asynchronously performs a blind transfer to the specified target, given the QueueId of the target.
| |
| ChangeWatchedAttributes |
Changes what attributes of the Interaction are being watched. (See InteractionAttributeName.)
| |
| ChangeWatchedAttributesAsync |
Asynchronously changes what attributes of the Interaction are being watched. (See InteractionAttributeName.)
| |
| Coach |
Changes the coaching state of the interaction.
| |
| CoachAsync |
Asynchronously changes the coaching state of the interaction.
| |
| ConsultTransfer |
Performs a consult transfer with the specified interaction.
| |
| ConsultTransferAsync |
Asynchronously performs a consult transfer with the specified interaction.
| |
| Disconnect |
Disconnects this Interaction.
| |
| DisconnectAsync |
Asynchronously disconnects this Interaction.
| |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
| GetBooleanAttribute |
Gets the value of an attribute as a Boolean.
| |
| GetBooleanAttributeAsync |
Asynchronously gets the value of an attribute as a Boolean.
| |
| GetDateTimeAttribute |
Gets the value of an attribute as a DateTime.
| |
| GetDateTimeAttributeAsync |
Asynchronously gets the value of an attribute as a DateTime.
| |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetIntegerAttribute |
Gets the value of an attribute as an Int32.
| |
| GetIntegerAttributeAsync |
Asynchronously gets the value of an attribute as an Int32.
| |
| GetStringAttribute |
Gets the value of an attribute as a String.
| |
| GetStringAttributeAsync |
Asynchronously gets the value of an attribute as a String.
| |
| GetStringAttributes |
Gets the values of attributes, where each attribute value is returned as a String.
| |
| GetStringAttributesAsync |
Asynchronously gets the values of attributes, where each attribute value is returned as a String.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| GetWatchedBooleanAttribute |
Gets the value of a watched attribute as a Boolean.
| |
| GetWatchedDateTimeAttribute |
Gets the value of a watched attribute as a DateTime.
| |
| GetWatchedIntegerAttribute |
Gets the value of a watched attribute as an Int32.
| |
| GetWatchedStringAttribute |
Gets the value of a watched attribute as a String.
| |
| GetWatchedStringsAttribute |
Gets the value of a watched attribute as a ReadOnlyCollection<(Of <(<'T>)>)> of String.
| |
| Hold |
Places the interaction on hold or takes it off hold.
| |
| HoldAsync |
Asynchronously places the interaction on hold or takes it off hold.
| |
| InitiateRecordingSnip |
Changes the recording snippet state of the interaction.
| |
| InitiateRecordingSnipAsync |
Asynchronously changes the recording snip state of the interaction.
| |
| InitiateSecureInput |
Initiates secure input which allows for confidential information (e.g., credit card number, expiration date, etc) to be securely provided.
| |
| InitiateSecureInputAsync |
Asynchronously initiates secure input.
| |
| IsValidCapability |
Determines whether the interaction has the specified capabilities.
| |
| IsWatching()()()() |
Determines whether a watch is active.
| |
| IsWatching(String) |
Determines whether a watch is active and if the specified value is being watched.
| |
| Join |
Joins this Interaction in a conference.
| |
| JoinAsync |
Asynchronously joins this Interaction in a conference.
| |
| Listen |
Changes the listen state of the interaction.
| |
| ListenAsync |
Asynchronously changes the listen state of the interaction.
| |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| Mute |
Changes the mute state.
| |
| MuteAsync |
Asynchronously changes the mute state.
| |
| Park(String) |
Parks the Interaction on the specified target, given a string.
| |
| Park(QueueId) |
Parks the Interaction on the specified target, given the QueueId of the target.
| |
| ParkAsync(String, AsyncCompletedEventHandler, Object) |
Asynchronously parks the Interaction on the specified target, given a string.
| |
| ParkAsync(QueueId, AsyncCompletedEventHandler, Object) |
Asynchronously parks the Interaction on the specified target, given the QueueId of the target.
| |
| Pause |
Changes the recording pause state.
| |
| PauseAsync |
Asynchronously changes the recording pause state.
| |
| Pickup |
Picks up this Interaction.
| |
| PickupAsync |
Asynchronously picks up this Interaction.
| |
| Private |
Changes the private state.
| |
| PrivateAsync |
Asynchronously changes the private state.
| |
| Record |
Changes the record state.
| |
| RecordAsync |
Asynchronously changes the record state.
| |
| RequestHelp | Obsolete.
Sends a request for help.
| |
| RequestHelpAsync | Obsolete.
Asynchronously sends a request for help.
| |
| SecureRecordingPause(Boolean) | Obsolete.
Changes the secure recording pause state.
| |
| SecureRecordingPause(SecureRecordingPauseParameters) |
Pauses or resumes a secure recording. Secure recordings are recordings started by Recorder, which are
configured via Interaction Administrator.
| |
| SecureRecordingPauseAsync(Boolean, AsyncCompletedEventHandler, Object) | Obsolete.
Asynchronously changes the secure recording pause state.
| |
| SecureRecordingPauseAsync(SecureRecordingPauseParameters, AsyncCompletedEventHandler, Object) |
Pauses or resumes a secure recording. Secure recordings are recordings started by Recorder, which are
configured via Interaction Administrator.
| |
| SetAccountCodeId |
Sets the Account Code ID.
| |
| SetAccountCodeIdAsync |
Asynchronously sets the Account Code ID.
| |
| SetDateTimeAttribute |
Sets the value of a string attribute.
| |
| SetDateTimeAttributeAsync |
Asynchronously sets the value of a string attribute.
| |
| SetRemoteName |
Sets the RemoteName.
| |
| SetRemoteNameAsync |
Asynchronously sets the RemoteName.
| |
| SetStateDescription |
Sets the StateDescription.
| |
| SetStateDescriptionAsync |
Asynchronously sets the StateDescription.
| |
| SetStringAttribute |
Sets the value of a string attribute.
| |
| SetStringAttributeAsync |
Asynchronously sets the value of a string attribute.
| |
| SetStringAttributes |
Sets the values of a set of string attributes.
| |
| SetStringAttributesAsync |
Asynchronously sets the values of a set of string attributes.
| |
| SetWrapUpCodeId | Obsolete.
Sets the WrapUp Code ID.
| |
| SetWrapUpCodeIdAsync | Obsolete.
Asynchronously sets the WrapUp Code ID.
| |
| StartWatching | ||
| StartWatchingAsync |
Asynchronously starts watching the specified attributeNames for this Interaction. (See InteractionAttributeName.)
| |
| StopWatching |
Stops watching the Interaction.
| |
| StopWatchingAsync |
Asynchronously stops watching the Interaction.
| |
| ToString | Returns a String that represents the current Object. (Overrides Object..::..ToString()()()().) | |
| TransferToVoicemail(String) |
Transfers to voicemail at the specified number, given a string.
| |
| TransferToVoicemail(QueueId) |
Transfers to voicemail at the specified number, given a QueueId.
| |
| TransferToVoicemailAsync(String, AsyncCompletedEventHandler, Object) |
Asynchronously transfers to voicemail at the specified number, given the target as a string.
| |
| TransferToVoicemailAsync(QueueId, AsyncCompletedEventHandler, Object) |
Asynchronously transfers to voicemail at the specified number, given the target as a QueueId.
| |
| TryGetWatchedBooleanAttribute |
Tries to get the value of a watched attribute as a Boolean.
| |
| TryGetWatchedDateTimeAttribute |
Tries to get the value of a watched attribute as a DateTime.
| |
| TryGetWatchedIntegerAttribute |
Tries to get the value of a watched attribute as an Int32.
| |
| TryGetWatchedStringAttribute |
Tries to get the value of a watched attribute as a String.
| |
| TryGetWatchedStringsAttribute |
Tries to get the value of a watched attribute as ReadOnlyCollection<(Of <(<'T>)>)> of String.
| |
| Voicemail |
Sends the Interaction to voicemail.
| |
| VoicemailAsync |
Asynchronously sends the Interaction to voicemail.
|
Properties
| Name | Description | |
|---|---|---|
| AccountCodeId |
Gets the Id of the account code.
AccountCodeId is only available if the AccountCodeId attribute is being watched.
| |
| AlertSound |
Gets the AlertSound.
AlertSound is only available if the AlertSound attribute is being watched.
| |
| AssociatedProcessDisplayName |
Gets the AssociatedProcessDisplayName.
AssociatedProcessDisplayName is only available if the AssociatedProcessDisplayName attribute is being watched.
| |
| AssociatedProcessInstanceId |
Gets the AssociatedProcessInstanceId.
AssociatedProcessInstanceId is only available if the AssociatedProcessInstanceId attribute is being watched.
| |
| CallIdKey | ||
| CallType | ||
| Capabilities |
Gets the capabilities of this interaction. The EffectiveStation comes into effect when
determining the capabilities of this interaction. Capabilities are only available if the Capabilities
attribute is being watched.
| |
| ClientMessage |
Gets the ClientMessage.
ClientMessage is only available if the ClientMessage attribute is being watched.
| |
| ConferenceId |
Gets the ConferenceId.
ConferenceId is only available if the ConferenceId
attribute is being watched.
| |
| ConsultCallId |
Gets ID of the ConsultTransfer, if this interaction is participating in a consult transfer.
ConsultCallId is only available if the ConsultCallId attribute is being watched.
| |
| DeallocationSeconds |
Gets the DeallocationSeconds.
DeallocationSeconds is only available if the DeallocationSeconds
attribute is being watched.
| |
| Direction | ||
| DisconnectionTime |
Gets the DisconnectionTime.
DisconnectionTime is only available if the DisconnectionTime
attribute is being watched.
| |
| DisconnectRingNoAnswer |
Gets a value indicating whether to disconnect on ring no answer.
DisconnectRingNoAnswer is only available if the DisconnectRingNoAnswer attribute is being watched.
| |
| Duration |
Gets the duration of the Interaction as of the current time (using InitiationTime and DisconnectionTime).
Duration is only available when InitiationTime, DisconnectionTime and State are being watched.
| |
| HasSnippetRecording |
Gets a value indicating whether this instance has snippet recordings.
| |
| ImmediateAccess |
Gets a value indicating whether to allow ImmediateAccess.
ImmediateAccess is only available if the ImmediateAccess attribute is being watched.
| |
| InitiationTime |
Gets the InitiationTime.
InitiationTime is only available if the InitiationTime
attribute is being watched.
| |
| InteractionId |
Gets the ID of the Interaction.
| |
| InteractionsManager |
Gets the InteractionManager with which this Interaction is associated.
| |
| InteractionType |
Gets the type of the interaction.
InteractionType is only available if the InteractionType attribute is being watched.
| |
| IsConnected |
Gets a value indicating whether the Interaction is in a connected state.
IsConnected is only available if the State
attribute is being watched.
| |
| IsDisconnected |
Gets a value indicating whether the Interaction is in a disconnected state.
IsDisconnected is only available if the State
attribute is being watched.
| |
| IsHeld | ||
| IsMonitored |
Gets a value indicating whether this instance is being monitored by the session user.
IsMonitored is only available if the Monitors and SupervisorMonitors
attributes are being watched.
| |
| IsMuted | ||
| IsOnMyInteractionsQueue |
Gets a value indicating whether this instance is on the MyInteractions queue.
IsOnMyInterationsQueue is only available if the UserQueueNames
and StationQueueNames attributes are being watched.
| |
| IsPaused |
Gets a value indicating whether this instance has a paused recorder for the session user.
IsPaused is only available if the Recorders and SupervisorRecorders
attributes are being watched.
| |
| IsPrivate | ||
| IsRecording |
Gets a value indicating whether this instance is being recorded by the session user.
IsRecording is only available if the Recorders and SupervisorRecorders
attributes are being watched.
| |
| IsShared |
Gets a value indicating whether this is a shared instance.
| |
| Language | ||
| LastSegment |
Gets the last segment on this interaction.
LastSegment is only available if the InteractionConnectionSegments attribute is being watched.
| |
| LastSegmentForCurrentUser |
Gets the last segment for the session user on this interaction.
LastSegmentForCurrentUser is only available if the InteractionConnectionSegments attribute is being watched.
| |
| LineName |
Gets the name of the line queue.
LineName is only available if the LineQueueName
attribute is being watched.
| |
| LocalAddress |
Gets the address of the local party.
LocalAddress is only available if the LocalAddress attribute is being watched.
| |
| LocalId |
Gets the displayable address of local party.
LocalId is only available if the LocalId attribute is being watched.
| |
| LocalName |
Gets the user-friendly name of the local party.
LocalName is only available if the LocalName attribute is being watched.
| |
| LocalPartyType |
Gets the LocalPartyType of the local party.
LocalPartyType is only available if the LocalPartyType attribute is being watched.
| |
| LocalSecurityLevelRequested |
Gets the requested local security level. (See LocalSecurityLevelRequested).
LocalSecurityLevelRequested is only available if the LocalSecurityLevelRequested attribute is being watched.
| |
| Log | ||
| Monitors | ||
| MonitorsCombinedCount |
Gets the MonitorsCombinedCount.
MonitorsCombinedCount is only available if the MonitorsCombinedCount attribute is being watched.
| |
| MonitorType |
Gets the type of the monitor.
MonitorType is only available if the MonitorType attribute is being watched.
| |
| Notes | ||
| OrbitQueueName |
Gets the unscoped orbit queue name.
OrbitQueueName is only available if the OrbitQueueName attribute is being watched.
| |
| PopApplication |
Gets the application that should be popped for the Interaction.
PopApplication is only available if the PopApplication attribute is being watched.
| |
| Recorders | ||
| RecordersCombinedCount |
Gets the RecordersCombinedCount.
RecordersCombinedCount is only available if the RecordersCombinedCount attribute is being watched.
| |
| RelatedSnippetRecordings |
Gets the RelatedSnippetRecordings.
RelatedSnippetRecordings is only available if the RelatedSnippetRecordings
attribute is being watched.
| |
| RemoteAddress |
Gets the RemoteAddress.
RemoteAddress is only available if the RemoteAddress attribute is being watched.
| |
| RemoteDisplay |
Gets a displayable identifier for an interaction.
RemoteDisplay is only available if the RemoteName attribute is being watched.
| |
| RemoteId |
Gets the remote party ID as a friendly display value.
RemoteId is only available if the RemoteId attribute is being watched.
| |
| RemoteName |
Gets the name of the remote party.
RemoteName is only available if the RemoteName attribute is being watched.
| |
| RemotePartyType |
Gets the RemotePartyType of the remote party.
RemotePartyType is only available if the RemotePartyType attribute is being watched.
| |
| RemoteSecurityLevelRequested |
Gets the requested remote security level. (See RemoteSecurityLevelRequested).
ImmediateAccess is only available if the ImmediateAccess attribute is being watched.
| |
| SecurityLevelActual |
Gets the actual security level. (See SecurityLevelActual).
SecurityLevelActual is only available if the SecurityLevelActual attribute is being watched.
| |
| SecurityLevelViolation |
Gets the reason for the security level violation. (See SecurityLevelViolation).
SecurityLevelViolation is only available if the SecurityLevelViolation attribute is being watched.
| |
| Segments |
Gets the collection of segments for this interaction. (See InteractionConnectionSegments).
Segments is only available if the InteractionConnectionSegments attribute is being watched.
| |
| State | ||
| StateDescription |
Gets the state display string.
StateDescription is only available if the StateDescription attribute is being watched.
| |
| StationQueueNames |
Gets the unscoped name(s) of the station queue(s).
StationQueueNames is only available if the StationQueueNames attribute is being watched.
| |
| SupervisorMonitors |
Gets the SupervisorMonitors.
SupervisorMonitors is only available if the SupervisorMonitors attribute is being watched.
| |
| SupervisorRecorders |
Gets the SupervisorRecorders.
SupervisorRecorders is only available if the SupervisorRecorders
attribute is being watched.
| |
| TimeInWorkgroupQueue |
Gets the duration of the Interaction as of the time it joined a workgroup queue (using WorkgroupQueueTimestamp and DisconnectionTime).
TimeInWorkgroupQueue is only available when WorkgroupQueueTimestamp, DisconnectionTime and State are being watched.
| |
| UserQueueNames |
Gets the unscoped name(s) of the user queue(s).
UserQueueNames is only available if the UserQueueNames attribute is being watched.
| |
| WorkgroupQueueDisplayName |
Gets the display name of the workgroup queue.
WorkgroupQueueDisplayName is only available if the WorkgroupQueueDisplayName attribute is being watched.
| |
| WorkgroupQueueName |
Gets the unscoped name of the workgroup queue.
WorkgroupQueueName is only available if the WorkgroupQueueName attribute is being watched.
| |
| WrapUpAssignments |
Gets the wrap up assignments for this interaction. (See WrapUpAssignments).
WrapUpAssignments is only available if the WrapUpAssignments attribute is being watched.
| |
| WrapUpCodeId | Obsolete.
Gets the ID of the wrap up code.
|
Events
| Name | Description | |
|---|---|---|
| AttributesChanged |
Occurs when an Interaction's watched attributes change.
| |
| Deallocated |
Occurs when an Interaction is deallocated.
| |
| LostRights |
Occurs when the User loses rights for the Interaction.
| |
| Morphed |
Occurs when an Interaction is replaced by another (e.g. during a Consult
operation).
| |
| RecordingSnippetCreated |
Occurs when a recording snippet is created for an interaction.
|