Show / Hide Table of Contents

Interface IUserPlugin

Interface required to implement for User Plugins to provide defulat values.

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

The plugin must be declared with UserPluginAttribute.
The default implementation UserPlugin can also be used.

Methods

GetDefaultAssociateName(UserType, Person, CheckIfAssociateNameIsLegal)

Get default associate name for a user.

Declaration
string GetDefaultAssociateName(UserType type, Person person, CheckIfAssociateNameIsLegal validator)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

CheckIfAssociateNameIsLegal validator

Validator to help check if the an associate name is valid.

Returns
Type Description
String

Default associate name validated with the provided CheckIfAssociateNameIsLegal delegate.

GetDefaultAssociateUserName(UserType, Person, CheckIfAssociateNameIsLegal)

Get default associate user name for a user.

Declaration
string GetDefaultAssociateUserName(UserType type, Person person, CheckIfAssociateNameIsLegal validator)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

CheckIfAssociateNameIsLegal validator

Validator to help check if the an associate user name is valid.

Returns
Type Description
String

Default associate user name validated with the provided CheckIfAssociateNameIsLegal delegate.

GetDefaultPrimaryGroup(UserType, Person)

Get default primary group for the user.

Declaration
int GetDefaultPrimaryGroup(UserType type, Person person)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

Returns
Type Description
Int32

Default primary group id.

GetDefaultRole(UserType, Person)

Get default role id for the user

Declaration
int GetDefaultRole(UserType type, Person person)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

Returns
Type Description
Int32

Default role id for the user.

GetDefaultSecondaryGroups(UserType, Person)

Get default secondary groups for the user

Declaration
int[] GetDefaultSecondaryGroups(UserType type, Person person)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

Returns
Type Description
Int32[]

Default secoundary group ids

GetValidAssociateName(UserType, Person, String, CheckIfAssociateNameIsLegal)

Get valid associate name for a user.

Declaration
string GetValidAssociateName(UserType type, Person person, string associateName, CheckIfAssociateNameIsLegal validator)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

String associateName

Candidate for associate name.

CheckIfAssociateNameIsLegal validator

Validator to help check if the an associate name is valid.

Returns
Type Description
String

Default associate name validated with the provided CheckIfAssociateNameIsLegal delegate.

GetValidAssociateUserName(UserType, Person, String, CheckIfAssociateNameIsLegal)

Get valid associate user name for a user.

Declaration
string GetValidAssociateUserName(UserType type, Person person, string associateUserName, CheckIfAssociateNameIsLegal validator)
Parameters
Type Name Description
SuperOffice.License.UserType type

Type of user.

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

String associateUserName

Candidate for user name.

CheckIfAssociateNameIsLegal validator

Validator to help check if the an associate name is valid.

Returns
Type Description
String

Default associate user name validated with the provided CheckIfAssociateNameIsLegal delegate.

ProcessProvidedAssociateName(String, Int32, UserType, Person, CheckIfAssociateNameIsLegal)

Process a provided associate name and allow modifications of an associate name.

Declaration
string ProcessProvidedAssociateName(string providedAssociateName, int associateId, UserType type, Person person, CheckIfAssociateNameIsLegal validator)
Parameters
Type Name Description
String providedAssociateName

Provided associate name

Int32 associateId

Associate id of the user. The value 0 will be provided for new users.

SuperOffice.License.UserType type

Type of user

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

CheckIfAssociateNameIsLegal validator

Validator to help check if the an associate name is valid.

Returns
Type Description
String

Associate name validated with the provided CheckIfAssociateNameIsLegal delegate.

Remarks

The name provided is guaranteed to meet the requirements set forth by teh provided validator.

ProcessProvidedAssociateUserName(String, Int32, UserType, Person, CheckIfAssociateNameIsLegal)

Process a provided associate user name and allow modifications of an associate user name.

Declaration
string ProcessProvidedAssociateUserName(string providedAssociateUserName, int associateId, UserType type, Person person, CheckIfAssociateNameIsLegal validator)
Parameters
Type Name Description
String providedAssociateUserName

Provided associate user name

Int32 associateId

Associate id of the user. The value 0 will be provided for new users.

SuperOffice.License.UserType type

Type of user

Person person

Person this is a user for. This value will be null (VB Noting) for System and Anonymous users.

CheckIfAssociateNameIsLegal validator

Validator to help check if the an associate name is valid.

Returns
Type Description
String

Associate user name validated with the provided CheckIfAssociateNameIsLegal delegate.

Remarks

The user name provided is guaranteed to meet the requirements set forth by teh provided validator.

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