Places the interaction on hold or takes it off hold.

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 Hold(
	bool on
)
Visual Basic
Public Sub Hold ( _
	on As Boolean _
)

Parameters

on
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic), on.

Remarks

This method will raise the PerformingAction event and (if the action was not cancelled) the PerformedAction event. When those events are raised, the two events' arguments (ActionParameters and ActionParameters, respectively) will contain an entry for On.

Exceptions

ExceptionCondition
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