isUserInRole Method

Summary

Gets a value that indicate whether the specified user have enough roles to allow running the specified operation.

Syntax
TypeScript
JavaScript
AnnGroupsRoles.prototype.isUserInRole = function( 
   userName, 
   info 
) 
isUserInRole( 
   userName: string, 
   info: AnnOperationInfoEventArgs 
): boolean; 

Parameters

userName

User name to check

info

Operation information including its type and the annotation object involved.

Return Value

true if the user has enough roles to allow the operation, otherwise; false including if the user was not found in any groups.

Remarks

This method works as follows:

  1. GetUserRoles is called obtain the roles for the specified user (through the groups this user belong to).

  2. AnnOperationInfoEventArgs.Type is checked agains the built-in roles of the system. For instance, if the operation type is AnnOperationType.CreateObjects, then the user must contain AnnRoles.Edit or AnnRoles.EditAll (with edit only works if the

userName is the same as info.AnnObject.UserId.

  1. If the build-in roles matched against the operation type could not verify if the operation is allowed or denied, then this is a custom role and the GenerateRole event will occur to ask the application for te role name to use with this operation. This role is checked again against the group roles to return the boolean value.

Requirements

Target Platforms

Help Version 20.0.2019.12.4
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly