Asynchronously gets the values of attributes, where each attribute value is returned as a String.

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

Syntax

C#
public void GetStringAttributesAsync(
	string[] attributeNames,
	EventHandler<GetStringAttributesCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub GetStringAttributesAsync ( _
	attributeNames As String(), _
	completedCallback As EventHandler(Of GetStringAttributesCompletedEventArgs), _
	userState As Object _
)

Parameters

attributeNames
Type: array<System..::..String>[]()[][]
Names of the attributes.
completedCallback
Type: System..::..EventHandler<(Of <(<'GetStringAttributesCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An object that contains state information for this request.

Remarks

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.

This method will return the value from the cache, if the attribute is cached. If the attribute is not being cached, it will send a request to the server and get the attribute.

Note
For information about the standard attributes defined by the Interaction Center System, see the "Interaction Attributes Technical Reference" in the Interaction Center Documentation Library. This document describes the attributes and the format of their values.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionattributeNames is empty.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe 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 SU 11 and beyond.

See Also