IsUserInRole Method

Summary

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

Syntax

Objective-C

C++/CLI

Java

Python

public virtual bool IsUserInRole( 
   string userName, 
   AnnOperationInfoEventArgs info 
)

- (BOOL)isUser:(NSString *)userName inRole:(LTAnnOperationInfoEventArgs *)info;

public boolean isUserInRole(String userName, AnnOperationInfoEvent info)

public:  
   virtual bool IsUserInRole( 
      String^ userName, 
      AnnOperationInfoEventArgs^ info 
   )

def IsUserInRole(self,userName,info):

userName
User name to check

info
Operation information including its type and the annotation object involved.

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:

GetUserRoles is called obtain the roles for the specified user (through the groups this user belong to).
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.
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

Help Version 23.0.2024.2.29

Leadtools.Annotations.Engine Assembly