Click or drag to resize

AuthenticationSetUserPageAuthentication Method

Method to enable or disable user page authentication.

Namespace: Crestron.SimplSharp.CrestronAuthentication
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public static bool SetUserPageAuthentication(
	AuthenticationUserToken paramUserToken,
	bool paramState
)

Parameters

paramUserToken  AuthenticationUserToken
User token obtained using "GetAuthenticationToken" method passed
paramState  Boolean
'false' for disabling and 'true' for enabling user page authentication.

Return Value

Boolean
Returns 'true' if user authentication state is changed successfully to the state mentioned in "paramState".
Exceptions
ExceptionCondition
InvalidOperationExceptionAuthentication or Forced Authentication is not currently enabled on the controller.
ArgumentExceptionInvalid token passed to this method.
AuthenticationPrivilegeExceptionHigher privileges are required to use this method.
NotSupportedExceptionIf the API is not supported on this platform. Use DevicePlatform to determine the running platform type.

If minimum firmware version requirement is not satisfied.

Remarks
The minimum firmware version required for this method is 1.602.0002 for 3-Series devices and 2.4361.02171 for 4-Series devices.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also