Gets the contents.
Namespace: ININ.IceLib.InteractionsAssembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
| C# |
|---|
public ReadOnlyCollection<Interaction> GetContents() |
| Visual Basic |
|---|
Public Function GetContents As ReadOnlyCollection(Of Interaction) |
Return Value
A ReadOnlyCollection<(Of <(<'T>)>)> of Interaction objects.Remarks
Calling GetContents 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.
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. |
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.
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.
