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 string GetStringAttribute(
	string attributeName
)
Visual Basic
Public Function GetStringAttribute ( _
	attributeName As String _
) As String

Parameters

attributeName
Type: System..::..String
Name of the attribute.

Return Value

The string value.

Remarks

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).
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