Asynchronously gets the contents.

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 GetContentsAsync(
	EventHandler<GetContentsCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub GetContentsAsync ( _
	completedCallback As EventHandler(Of GetContentsCompletedEventArgs), _
	userState As Object _
)

Parameters

completedCallback
Type: System..::..EventHandler<(Of <(<'GetContentsCompletedEventArgs>)>)>
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

Calling GetContentsAsync without an active InteractionQueue watch will retrieve the queue contents from the IC Server, but will not keep them up to date. This means that the collection of Interaction objects returned from this call will eventually become stale. Making subsequent GetContents calls will not refresh the collection. If the desired behavior is to have an up-to-date Interaction collection, a watch must first be started on an InteractionQueue object, being sure to have all event handlers set before starting the watch.

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.

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.

See Also