Asynchronous request to change the speakers on the consult transfer.

Namespace: ININ.IceLib.Interactions
Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.1.0.214)

Syntax

C#
public void ChangeSpeakersAsync(
	ConsultTransferParticipants speakTo,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub ChangeSpeakersAsync ( _
	speakTo As ConsultTransferParticipants, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

speakTo
Type: ININ.IceLib.Interactions..::..ConsultTransferParticipants
The participants to speak with.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

When using Agent for the speakTo value, neither the consult nor the caller will be speaking. Additionally, the agent is always a speaker on a consult, if Agent is omitted, it will be added back by default. When using Caller for the speakTo value, only the agent and the caller will be speaking. When using Consult for the speakTo value, only the agent and the consult will be speaking. When using All for the speakTo value, all parties will be speaking.

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

Exceptions

ExceptionCondition
System..::..ArgumentOutOfRangeException The specified speak to is not from the ConsultTransferParticipants enumeration. The specified speak to is set to None.

Version Information

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

See Also