Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
| C# |
|---|
public class InteractionQueue |
| Visual Basic |
|---|
Public Class InteractionQueue |
Remarks
To start a watch on an interaction queue, call StartWatching(array<String>[]()[][]) or StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object) and provide and array of attributes. When the asynchronous start watch operation completes, it invokes the completedCallback delegate.
To stop a watch on an interaction queue, call StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object). When the asynchronous stop watch operation completes, it invokes the completedCallback delegate.
To change the attributes watched, call ChangeWatchedAttributes(array<String>[]()[][], array<String>[]()[][], Boolean) or ChangeWatchedAttributesAsync(array<String>[]()[][], array<String>[]()[][], Boolean, AsyncCompletedEventHandler, Object). When the asynchronous change watch operation completes, it invokes the completedCallback delegate.
To retrieve the contents of an interaction queue, call GetContents()()()() or GetContentsAsync(EventHandler<(Of <<'(GetContentsCompletedEventArgs>)>>), Object). When the asynchronous get contents operation completes, it invokes the completedCallback delegate and returns the InteractionCompletedEventArgs object containing the contents of the interaction queue. The queue contents is represented by a collection of Interaction objects.
Calling StartWatching(array<String>[]()[][]) or StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object) when a watch is in place or StopWatching()()()(), StopWatchingAsync(AsyncCompletedEventHandler, Object),
ChangeWatchedAttributes(array<String>[]()[][], array<String>[]()[][], Boolean), or ChangeWatchedAttributesAsync(array<String>[]()[][], array<String>[]()[][], Boolean, AsyncCompletedEventHandler, Object) when a watch is not in place raises an InvalidOperationException.
 Note |
|---|
| The asynchronous version of the above methods is preferred since these operations can be lengthy. |
| Note |
|---|
| For more information on getting started with queues and interactions see Getting Started With Interactions. |
Exceptions
| Exception | Condition |
|---|---|
| ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
| ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
| System..::..ObjectDisposedException | The Session has been disposed. |
Inheritance Hierarchy
ININ.IceLib.Interactions..::..InteractionQueue
Version Information
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.
