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

Class DefaultPermissionRoleStore

Inheritance
System.Object
DefaultPermissionRoleStore
Implements
IPermissionRoleStore
Namespace: OpenMod.Core.Permissions
Assembly: OpenMod.Core.dll
Syntax
public class DefaultPermissionRoleStore : object, IPermissionRoleStore

Constructors

| Improve this Doc View Source

DefaultPermissionRoleStore(IPermissionRolesDataStore, IUserDataStore, IRuntime, IEventBus)

Declaration
public DefaultPermissionRoleStore(IPermissionRolesDataStore permissionRolesDataStore, IUserDataStore userDataStore, IRuntime runtime, IEventBus eventBus)
Parameters
Type Name Description
IPermissionRolesDataStore permissionRolesDataStore
IUserDataStore userDataStore
IRuntime runtime
IEventBus eventBus

Methods

| Improve this Doc View Source

AddRoleToActorAsync(IPermissionActor, String)

Declaration
public virtual Task<bool> AddRoleToActorAsync(IPermissionActor actor, string roleId)
Parameters
Type Name Description
IPermissionActor actor
System.String roleId
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

CreateRoleAsync(IPermissionRole)

Declaration
public virtual Task<bool> CreateRoleAsync(IPermissionRole role)
Parameters
Type Name Description
IPermissionRole role
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

DeleteRoleAsync(String)

Declaration
public virtual Task<bool> DeleteRoleAsync(string roleId)
Parameters
Type Name Description
System.String roleId
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

GetAutoAssignedRolesAsync(String, String)

Declaration
public Task<IReadOnlyCollection<string>> GetAutoAssignedRolesAsync(string actorId, string actorType)
Parameters
Type Name Description
System.String actorId
System.String actorType
Returns
Type Description
Task<IReadOnlyCollection<System.String>>
| Improve this Doc View Source

GetAutoAssignRoles()

Declaration
protected IEnumerable<IPermissionRole> GetAutoAssignRoles()
Returns
Type Description
IEnumerable<IPermissionRole>
| Improve this Doc View Source

GetPersistentDataAsync<T>(String, String)

Declaration
public Task<T> GetPersistentDataAsync<T>(string roleId, string key)
Parameters
Type Name Description
System.String roleId
System.String key
Returns
Type Description
Task<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

GetRoleAsync(String)

Declaration
public virtual Task<IPermissionRole> GetRoleAsync(string roleId)
Parameters
Type Name Description
System.String roleId
Returns
Type Description
Task<IPermissionRole>
| Improve this Doc View Source

GetRolesAsync()

Declaration
public virtual Task<IReadOnlyCollection<IPermissionRole>> GetRolesAsync()
Returns
Type Description
Task<IReadOnlyCollection<IPermissionRole>>
| Improve this Doc View Source

GetRolesAsync(IPermissionActor, Boolean)

Declaration
public virtual Task<IReadOnlyCollection<IPermissionRole>> GetRolesAsync(IPermissionActor actor, bool inherit = true)
Parameters
Type Name Description
IPermissionActor actor
System.Boolean inherit
Returns
Type Description
Task<IReadOnlyCollection<IPermissionRole>>
| Improve this Doc View Source

RemoveRoleFromActorAsync(IPermissionActor, String)

Declaration
public virtual Task<bool> RemoveRoleFromActorAsync(IPermissionActor actor, string roleId)
Parameters
Type Name Description
IPermissionActor actor
System.String roleId
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

SavePersistentDataAsync<T>(String, String, T)

Declaration
public Task SavePersistentDataAsync<T>(string roleId, string key, T data)
Parameters
Type Name Description
System.String roleId
System.String key
T data
Returns
Type Description
Task
Type Parameters
Name Description
T
| Improve this Doc View Source

UpdateRoleAsync(IPermissionRole)

Declaration
public virtual Task<bool> UpdateRoleAsync(IPermissionRole role)
Parameters
Type Name Description
IPermissionRole role
Returns
Type Description
Task<System.Boolean>

Implements

IPermissionRoleStore

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)