Asynchronously gets the value of an attribute as a String.

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 GetStringAttributeAsync(
	string attributeName,
	EventHandler<GetAttributeCompletedEventArgs<string>> completedCallback,
	Object userState
)
Visual Basic
Public Sub GetStringAttributeAsync ( _
	attributeName As String, _
	completedCallback As EventHandler(Of GetAttributeCompletedEventArgs(Of String)), _
	userState As Object _
)

Parameters

attributeName
Type: System..::..String
Name of the attribute.
completedCallback
Type: System..::..EventHandler<(Of <(<'GetAttributeCompletedEventArgs<(Of <(<'String>)>)>>)>)>
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 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.

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.

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.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
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 GA and beyond.

See Also