Show / Hide Table of Contents

Interface IUserValidatorPlugin

Plugin for validating user-names and passwords.

Namespace: SuperOffice.CRM.Administration
Assembly: SoDataBase.dll
Syntax
public interface IUserValidatorPlugin : IPlugin
Remarks

These plugins are called in a chain. If any plugin rejects a user-name or password, it is rejected.

Methods

IsAssociateNameLegal(Int32, UserType, Int32, String, out String)

Check if an associate name is valid for a given user.

Declaration
bool IsAssociateNameLegal(int associateId, UserType type, int personId, string associateName, out string reason)
Parameters
Type Name Description
Int32 associateId

Associate id of the user to check if the user name is valid for.

SuperOffice.License.UserType type

Type of user.

Int32 personId

Person id of the user (if the user is a named user).

String associateName

Candidate for associate name.

String reason

The reason for denying an associate name.

Returns
Type Description
Boolean

Return true if the associate name is valid.

IsAssociateUserNameLegal(Int32, UserType, Int32, String, out String)

Check if an associate username is valid for a given user.

Declaration
bool IsAssociateUserNameLegal(int associateId, UserType type, int personId, string associateUsername, out string reason)
Parameters
Type Name Description
Int32 associateId

Associate id of the user to check if the user name is valid for.

SuperOffice.License.UserType type

Type of user.

Int32 personId

Person id of the user (if the user is a named user).

String associateUsername
String reason

The reason for denying a username.

Returns
Type Description
Boolean

Return true if the associate username is valid.

IsPasswordLegal(Int32, UserType, Int32, String, out String)

Chack if the password is valid.

Declaration
bool IsPasswordLegal(int associateId, UserType type, int personId, string password, out string reason)
Parameters
Type Name Description
Int32 associateId

Associate id of the user to check if the user name is valid for.

SuperOffice.License.UserType type

Type of user.

Int32 personId

Person id of the user (if the user is a named user).

String password

The password candidate

String reason

The reason for denying the password

Returns
Type Description
Boolean

Return true if the password is valid

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top