Changes the coaching state of the interaction.

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

Syntax

C#
public void Coach(
	bool on,
	bool supervisor
)
Visual Basic
Public Sub Coach ( _
	on As Boolean, _
	supervisor As Boolean _
)

Parameters

on
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic), on.
supervisor
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic), the resulting monitor will be included in SupervisorMonitors, otherwise included in Monitors.

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 and Supervisor.

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