OpenMod Docs OpenMod Docs
OpenMod Docs OpenMod Docs
OpenMod .NET Plugin Framework.

Interface IPermissionCheckProvider

Providers used for checking permissions.

Namespace: OpenMod.API.Permissions
Assembly: OpenMod.API.dll
Syntax
public interface IPermissionCheckProvider

Methods

| Improve this Doc View Source

CheckPermissionAsync(IPermissionActor, String)

Checks if an actor has authorization to execute an action.

Declaration
Task<PermissionGrantResult> CheckPermissionAsync(IPermissionActor actor, string permission)
Parameters
Type Name Description
IPermissionActor actor

The actor to check.

System.String permission

The permission to check.

Returns
Type Description
Task<PermissionGrantResult>

Grant if the actor explicitly has the permission, Deny if the actor explicitly does not have the permission; otherwise, Default

| Improve this Doc View Source

SupportsActor(IPermissionActor)

Defines if the given actor is supported by this provider.

Declaration
bool SupportsActor(IPermissionActor actor)
Parameters
Type Name Description
IPermissionActor actor

The actor to check.

Returns
Type Description
System.Boolean

true if the given actor is supported; otherwise, false.

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)