IsGrantedExtensions.CanReadByUser(SecurityStrategy, IPermissionPolicyUser, Type, IObjectSpace, Object, String) Method

Checks whether the specified user can read an object with the specified key or this object’s member.

Namespace: DevExpress.ExpressApp.Security

Assembly: DevExpress.ExpressApp.Security.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Security

Declaration

C#

public static bool CanReadByUser(
    this SecurityStrategy security,
    IPermissionPolicyUser targetUser,
    Type type,
    IObjectSpace objectSpace,
    object targetObjectKey,
    string memberName = null
)

VB.NET

<ExtensionAttribute>
Public Shared Function CanReadByUser(
    security As SecurityStrategy,
    targetUser As IPermissionPolicyUser,
    type As Type,
    objectSpace As IObjectSpace,
    targetObjectKey As Object,
    memberName As String = Nothing
) As Boolean

Parameters

Name	Type	Description
security	SecurityStrategy	A SecurityStrategy object that specifies an application’s Security Strategy.
targetUser	IPermissionPolicyUser	An IPermissionPolicyUser object that is a user this method checks.
type	Type	A Type of an object this method checks.
objectSpace	IObjectSpace	An Object Space this method uses to get an object to check.
targetObjectKey	Object	An Object that is a key of an object this method checks.

Optional Parameters

Name	Type	Default	Description
memberName	String	null	A String that is a name of the target object’s member this method checks. This parameter is optional.

Returns

Type	Description
Boolean	true, if the specified user can read an object with the specified key or this object’s member; otherwise, false.

Remarks

The following example shows how to use this method.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Security;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl.EF.PermissionPolicy;
using System;
// ...
public class CheckReadPermissionController : ObjectViewController<ListView, Contact> {
    SecurityStrategy securityStrategy;
    protected override void OnActivated() {
        base.OnActivated();
        securityStrategy = Application.GetSecurityStrategy();
        View.CurrentObjectChanged += View_CurrentObjectChanged;
    }
    private void View_CurrentObjectChanged(object sender, EventArgs e) {
        Department department = ViewCurrentObject.Department;
        if (department != null) {
            object key = ObjectSpace.GetKeyValue(department);
            foreach (IPermissionPolicyUser user in ObjectSpace.GetObjects<ApplicationUser>()) {
                if (!securityStrategy.CanReadByUser(user, typeof(Department), ObjectSpace, key, nameof(Department.Office))) {
                    // ...
                }
            }
        }
    }
}