The Interaction type exposes the following members.

Constructors

  NameDescription
Protected methodInteraction
Initializes a new instance of the Interaction class.

Methods

  NameDescription
Public methodAppendNote
Appends to the Notes.
Public methodAppendNoteAsync
Asynchronously appends to the Notes.
Public methodAppendStringAttribute
Sets the value of a string attribute.
Public methodAppendStringAttributeAsync
Asynchronously sets the value of a string attribute.
Public methodBlindTransfer(String)
Performs a blind transfer to the specified number given the number as a string.
Public methodBlindTransfer(QueueId)
Performs a blind transfer to the specified target, given the QueueId of the target.
Public methodBlindTransferAsync(String, AsyncCompletedEventHandler, Object)
Asynchronously performs a blind transfer to the specified number, given that number as a string.
Public methodBlindTransferAsync(QueueId, AsyncCompletedEventHandler, Object)
Asynchronously performs a blind transfer to the specified target, given the QueueId of the target.
Public methodChangeWatchedAttributes
Changes what attributes of the Interaction are being watched. (See InteractionAttributeName.)
Public methodChangeWatchedAttributesAsync
Asynchronously changes what attributes of the Interaction are being watched. (See InteractionAttributeName.)
Public methodCoach
Changes the coaching state of the interaction.
Public methodCoachAsync
Asynchronously changes the coaching state of the interaction.
Public methodConsultTransfer
Performs a consult transfer with the specified interaction.
Public methodConsultTransferAsync
Asynchronously performs a consult transfer with the specified interaction.
Public methodDisconnect
Disconnects this Interaction.
Public methodDisconnectAsync
Asynchronously disconnects this Interaction.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBooleanAttribute
Gets the value of an attribute as a Boolean.
Public methodGetBooleanAttributeAsync
Asynchronously gets the value of an attribute as a Boolean.
Public methodGetDateTimeAttribute
Gets the value of an attribute as a DateTime.
Public methodGetDateTimeAttributeAsync
Asynchronously gets the value of an attribute as a DateTime.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIntegerAttribute
Gets the value of an attribute as an Int32.
Public methodGetIntegerAttributeAsync
Asynchronously gets the value of an attribute as an Int32.
Public methodGetStringAttribute
Gets the value of an attribute as a String.
Public methodGetStringAttributeAsync
Asynchronously gets the value of an attribute as a String.
Public methodGetStringAttributes
Gets the values of attributes, where each attribute value is returned as a String.
Public methodGetStringAttributesAsync
Asynchronously gets the values of attributes, where each attribute value is returned as a String.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWatchedBooleanAttribute
Gets the value of a watched attribute as a Boolean.
Public methodGetWatchedDateTimeAttribute
Gets the value of a watched attribute as a DateTime.
Public methodGetWatchedIntegerAttribute
Gets the value of a watched attribute as an Int32.
Public methodGetWatchedStringAttribute
Gets the value of a watched attribute as a String.
Public methodGetWatchedStringsAttribute
Gets the value of a watched attribute as a ReadOnlyCollection<(Of <(<'T>)>)> of String.
Public methodHold
Places the interaction on hold or takes it off hold.
Public methodHoldAsync
Asynchronously places the interaction on hold or takes it off hold.
Public methodInitiateRecordingSnip
Changes the recording snippet state of the interaction.
Public methodInitiateRecordingSnipAsync
Asynchronously changes the recording snip state of the interaction.
Public methodInitiateSecureInput
Initiates secure input which allows for confidential information (e.g., credit card number, expiration date, etc) to be securely provided.
Public methodInitiateSecureInputAsync
Asynchronously initiates secure input.
Public methodIsValidCapability
Determines whether the interaction has the specified capabilities.
Public methodIsWatching()()()()
Determines whether a watch is active.
Public methodIsWatching(String)
Determines whether a watch is active and if the specified value is being watched.
Public methodJoin
Joins this Interaction in a conference.
Public methodJoinAsync
Asynchronously joins this Interaction in a conference.
Public methodListen
Changes the listen state of the interaction.
Public methodListenAsync
Asynchronously changes the listen state of the interaction.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMute
Changes the mute state.
Public methodMuteAsync
Asynchronously changes the mute state.
Public methodPark(String)
Parks the Interaction on the specified target, given a string.
Public methodPark(QueueId)
Parks the Interaction on the specified target, given the QueueId of the target.
Public methodParkAsync(String, AsyncCompletedEventHandler, Object)
Asynchronously parks the Interaction on the specified target, given a string.
Public methodParkAsync(QueueId, AsyncCompletedEventHandler, Object)
Asynchronously parks the Interaction on the specified target, given the QueueId of the target.
Public methodPause
Changes the recording pause state.
Public methodPauseAsync
Asynchronously changes the recording pause state.
Public methodPickup
Picks up this Interaction.
Public methodPickupAsync
Asynchronously picks up this Interaction.
Public methodPrivate
Changes the private state.
Public methodPrivateAsync
Asynchronously changes the private state.
Public methodRecord
Changes the record state.
Public methodRecordAsync
Asynchronously changes the record state.
Public methodRequestHelp Obsolete.
Sends a request for help.
Public methodRequestHelpAsync Obsolete.
Asynchronously sends a request for help.
Public methodSecureRecordingPause(Boolean) Obsolete.
Changes the secure recording pause state.
Public methodSecureRecordingPause(SecureRecordingPauseParameters)
Pauses or resumes a secure recording. Secure recordings are recordings started by Recorder, which are configured via Interaction Administrator.
Public methodSecureRecordingPauseAsync(Boolean, AsyncCompletedEventHandler, Object) Obsolete.
Asynchronously changes the secure recording pause state.
Public methodSecureRecordingPauseAsync(SecureRecordingPauseParameters, AsyncCompletedEventHandler, Object)
Pauses or resumes a secure recording. Secure recordings are recordings started by Recorder, which are configured via Interaction Administrator.
Public methodSetAccountCodeId
Sets the Account Code ID.
Public methodSetAccountCodeIdAsync
Asynchronously sets the Account Code ID.
Public methodSetDateTimeAttribute
Sets the value of a string attribute.
Public methodSetDateTimeAttributeAsync
Asynchronously sets the value of a string attribute.
Public methodSetRemoteName
Sets the RemoteName.
Public methodSetRemoteNameAsync
Asynchronously sets the RemoteName.
Public methodSetStateDescription
Sets the StateDescription.
Public methodSetStateDescriptionAsync
Asynchronously sets the StateDescription.
Public methodSetStringAttribute
Sets the value of a string attribute.
Public methodSetStringAttributeAsync
Asynchronously sets the value of a string attribute.
Public methodSetStringAttributes
Sets the values of a set of string attributes.
Public methodSetStringAttributesAsync
Asynchronously sets the values of a set of string attributes.
Public methodSetWrapUpCodeId Obsolete.
Sets the WrapUp Code ID.
Public methodSetWrapUpCodeIdAsync Obsolete.
Asynchronously sets the WrapUp Code ID.
Public methodStartWatching
Starts watching the specified attributeNames for this Interaction. (See InteractionAttributeName.)
Public methodStartWatchingAsync
Asynchronously starts watching the specified attributeNames for this Interaction. (See InteractionAttributeName.)
Public methodStopWatching
Stops watching the Interaction.
Public methodStopWatchingAsync
Asynchronously stops watching the Interaction.
Public methodToString
Returns a String that represents the current Object.
(Overrides Object..::..ToString()()()().)
Public methodTransferToVoicemail(String)
Transfers to voicemail at the specified number, given a string.
Public methodTransferToVoicemail(QueueId)
Transfers to voicemail at the specified number, given a QueueId.
Public methodTransferToVoicemailAsync(String, AsyncCompletedEventHandler, Object)
Asynchronously transfers to voicemail at the specified number, given the target as a string.
Public methodTransferToVoicemailAsync(QueueId, AsyncCompletedEventHandler, Object)
Asynchronously transfers to voicemail at the specified number, given the target as a QueueId.
Public methodTryGetWatchedBooleanAttribute
Tries to get the value of a watched attribute as a Boolean.
Public methodTryGetWatchedDateTimeAttribute
Tries to get the value of a watched attribute as a DateTime.
Public methodTryGetWatchedIntegerAttribute
Tries to get the value of a watched attribute as an Int32.
Public methodTryGetWatchedStringAttribute
Tries to get the value of a watched attribute as a String.
Public methodTryGetWatchedStringsAttribute
Tries to get the value of a watched attribute as ReadOnlyCollection<(Of <(<'T>)>)> of String.
Public methodVoicemail
Sends the Interaction to voicemail.
Public methodVoicemailAsync
Asynchronously sends the Interaction to voicemail.

Properties

  NameDescription
Public propertyAccountCodeId
Gets the Id of the account code. AccountCodeId is only available if the AccountCodeId attribute is being watched.
Public propertyAlertSound
Gets the AlertSound. AlertSound is only available if the AlertSound attribute is being watched.
Public propertyAssociatedProcessDisplayName
Gets the AssociatedProcessDisplayName. AssociatedProcessDisplayName is only available if the AssociatedProcessDisplayName attribute is being watched.
Public propertyAssociatedProcessInstanceId
Gets the AssociatedProcessInstanceId. AssociatedProcessInstanceId is only available if the AssociatedProcessInstanceId attribute is being watched.
Public propertyCallIdKey
Gets the CallIdKey. CallIdKey is only available if the CallIdKey attribute is being watched.
Public propertyCallType
Gets the CallType. CallType is only available if the CallType attribute is being watched.
Public propertyCapabilities
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.
Public propertyClientMessage
Gets the ClientMessage. ClientMessage is only available if the ClientMessage attribute is being watched.
Public propertyConferenceId
Gets the ConferenceId. ConferenceId is only available if the ConferenceId attribute is being watched.
Public propertyConsultCallId
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.
Public propertyDeallocationSeconds
Gets the DeallocationSeconds. DeallocationSeconds is only available if the DeallocationSeconds attribute is being watched.
Public propertyDirection
Gets the Direction. Direction is only available if the Direction attribute is being watched.
Public propertyDisconnectionTime
Gets the DisconnectionTime. DisconnectionTime is only available if the DisconnectionTime attribute is being watched.
Public propertyDisconnectRingNoAnswer
Gets a value indicating whether to disconnect on ring no answer. DisconnectRingNoAnswer is only available if the DisconnectRingNoAnswer attribute is being watched.
Public propertyDuration
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.
Public propertyHasSnippetRecording
Gets a value indicating whether this instance has snippet recordings.
Public propertyImmediateAccess
Gets a value indicating whether to allow ImmediateAccess. ImmediateAccess is only available if the ImmediateAccess attribute is being watched.
Public propertyInitiationTime
Gets the InitiationTime. InitiationTime is only available if the InitiationTime attribute is being watched.
Public propertyInteractionId
Gets the ID of the Interaction.
Public propertyInteractionsManager
Gets the InteractionManager with which this Interaction is associated.
Public propertyInteractionType
Gets the type of the interaction. InteractionType is only available if the InteractionType attribute is being watched.
Public propertyIsConnected
Gets a value indicating whether the Interaction is in a connected state. IsConnected is only available if the State attribute is being watched.
Public propertyIsDisconnected
Gets a value indicating whether the Interaction is in a disconnected state. IsDisconnected is only available if the State attribute is being watched.
Public propertyIsHeld
Gets a value indicating whether this instance is Held. IsHeld is only available if the State attribute is being watched.
Public propertyIsMonitored
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.
Public propertyIsMuted
Gets a value indicating whether this instance is Muted. IsMuted is only available if the Muted attribute is being watched.
Public propertyIsOnMyInteractionsQueue
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.
Public propertyIsPaused
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.
Public propertyIsPrivate
Gets a value indicating whether this instance is Private. IsPrivate is only available if the Private attribute is being watched.
Public propertyIsRecording
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.
Public propertyIsShared
Gets a value indicating whether this is a shared instance.
Public propertyLanguage
Gets the Language to use for the prompt. Language is only available if the Language attribute is being watched.
Public propertyLastSegment
Gets the last segment on this interaction. LastSegment is only available if the InteractionConnectionSegments attribute is being watched.
Public propertyLastSegmentForCurrentUser
Gets the last segment for the session user on this interaction. LastSegmentForCurrentUser is only available if the InteractionConnectionSegments attribute is being watched.
Public propertyLineName
Gets the name of the line queue. LineName is only available if the LineQueueName attribute is being watched.
Public propertyLocalAddress
Gets the address of the local party. LocalAddress is only available if the LocalAddress attribute is being watched.
Public propertyLocalId
Gets the displayable address of local party. LocalId is only available if the LocalId attribute is being watched.
Public propertyLocalName
Gets the user-friendly name of the local party. LocalName is only available if the LocalName attribute is being watched.
Public propertyLocalPartyType
Gets the LocalPartyType of the local party. LocalPartyType is only available if the LocalPartyType attribute is being watched.
Public propertyLocalSecurityLevelRequested
Gets the requested local security level. (See LocalSecurityLevelRequested). LocalSecurityLevelRequested is only available if the LocalSecurityLevelRequested attribute is being watched.
Public propertyLog
Gets the Log. Log is only available if the Log attribute is being watched.
Public propertyMonitors
Gets the Monitors. Monitors is only available if the Monitors attribute is being watched.
Public propertyMonitorsCombinedCount
Gets the MonitorsCombinedCount. MonitorsCombinedCount is only available if the MonitorsCombinedCount attribute is being watched.
Public propertyMonitorType
Gets the type of the monitor. MonitorType is only available if the MonitorType attribute is being watched.
Public propertyNotes
Gets the Notes. Notes is only available if the Notes attribute is being watched.
Public propertyOrbitQueueName
Gets the unscoped orbit queue name. OrbitQueueName is only available if the OrbitQueueName attribute is being watched.
Public propertyPopApplication
Gets the application that should be popped for the Interaction. PopApplication is only available if the PopApplication attribute is being watched.
Public propertyRecorders
Gets the Recorders. Recorders is only available if the Recorders attribute is being watched.
Public propertyRecordersCombinedCount
Gets the RecordersCombinedCount. RecordersCombinedCount is only available if the RecordersCombinedCount attribute is being watched.
Public propertyRelatedSnippetRecordings
Gets the RelatedSnippetRecordings. RelatedSnippetRecordings is only available if the RelatedSnippetRecordings attribute is being watched.
Public propertyRemoteAddress
Gets the RemoteAddress. RemoteAddress is only available if the RemoteAddress attribute is being watched.
Public propertyRemoteDisplay
Gets a displayable identifier for an interaction. RemoteDisplay is only available if the RemoteName attribute is being watched.
Public propertyRemoteId
Gets the remote party ID as a friendly display value. RemoteId is only available if the RemoteId attribute is being watched.
Public propertyRemoteName
Gets the name of the remote party. RemoteName is only available if the RemoteName attribute is being watched.
Public propertyRemotePartyType
Gets the RemotePartyType of the remote party. RemotePartyType is only available if the RemotePartyType attribute is being watched.
Public propertyRemoteSecurityLevelRequested
Gets the requested remote security level. (See RemoteSecurityLevelRequested). ImmediateAccess is only available if the ImmediateAccess attribute is being watched.
Public propertySecurityLevelActual
Gets the actual security level. (See SecurityLevelActual). SecurityLevelActual is only available if the SecurityLevelActual attribute is being watched.
Public propertySecurityLevelViolation
Gets the reason for the security level violation. (See SecurityLevelViolation). SecurityLevelViolation is only available if the SecurityLevelViolation attribute is being watched.
Public propertySegments
Gets the collection of segments for this interaction. (See InteractionConnectionSegments). Segments is only available if the InteractionConnectionSegments attribute is being watched.
Public propertyState
Gets the Interaction State. State is only available if the State attribute is being watched.
Public propertyStateDescription
Gets the state display string. StateDescription is only available if the StateDescription attribute is being watched.
Public propertyStationQueueNames
Gets the unscoped name(s) of the station queue(s). StationQueueNames is only available if the StationQueueNames attribute is being watched.
Public propertySupervisorMonitors
Gets the SupervisorMonitors. SupervisorMonitors is only available if the SupervisorMonitors attribute is being watched.
Public propertySupervisorRecorders
Gets the SupervisorRecorders. SupervisorRecorders is only available if the SupervisorRecorders attribute is being watched.
Public propertyTimeInWorkgroupQueue
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.
Public propertyUserQueueNames
Gets the unscoped name(s) of the user queue(s). UserQueueNames is only available if the UserQueueNames attribute is being watched.
Public propertyWorkgroupQueueDisplayName
Gets the display name of the workgroup queue. WorkgroupQueueDisplayName is only available if the WorkgroupQueueDisplayName attribute is being watched.
Public propertyWorkgroupQueueName
Gets the unscoped name of the workgroup queue. WorkgroupQueueName is only available if the WorkgroupQueueName attribute is being watched.
Public propertyWrapUpAssignments
Gets the wrap up assignments for this interaction. (See WrapUpAssignments). WrapUpAssignments is only available if the WrapUpAssignments attribute is being watched.
Public propertyWrapUpCodeId Obsolete.

Events

  NameDescription
Public eventAttributesChanged
Occurs when an Interaction's watched attributes change.
Public eventDeallocated
Occurs when an Interaction is deallocated.
Public eventLostRights
Occurs when the User loses rights for the Interaction.
Public eventMorphed
Occurs when an Interaction is replaced by another (e.g. during a Consult operation).
Public eventRecordingSnippetCreated
Occurs when a recording snippet is created for an interaction.

See Also