Interface IModuleStore

Provides an abstraction for a store which manages modules.

Inherited Members

System.IDisposable.Dispose()

IUseExecutionStrategy.Suspended

IUseExecutionStrategy.Strategy

Namespace: IRM.AspNetCore.Identity

Assembly: IRM.AspNetCore.Identity.dll

Syntax

public interface IModuleStore : IDisposable, IUseExecutionStrategy

Methods

CreateAsync(BoughtModule, CancellationToken)

Creates the specified boughtModule in the module store.

Declaration

Task<IdentityResult> CreateAsync(BoughtModule boughtModule, CancellationToken cancellationToken = default(CancellationToken))

Parameters

BoughtModule boughtModule The bought module to create.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<IdentityResult> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the creation operation.

CreateAsync(Module, CancellationToken)

Creates the specified module in the module store.

Declaration

Task<IdentityResult> CreateAsync(Module module, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Module module The module to create.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<IdentityResult> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the creation operation.

DeleteAsync(Module, CancellationToken)

Deletes a module from the store as an asynchronous operation.

Declaration

Task<IdentityResult> DeleteAsync(Module module, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Module module The module to delete from the store.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<IdentityResult> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the creation operation.

DeleteFunctionalityAsync(Functionality, CancellationToken)

Deletes a functionality from the store as an asynchronous operation.

Declaration

Task<IdentityResult> DeleteFunctionalityAsync(Functionality functionality, CancellationToken cancellationToken)

Parameters

Functionality functionality The functionality to delete from the store.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<IdentityResult> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the creation operation.

FindBoughtModulesByTenantAsync(Guid, CancellationToken)

Finds and returns all bought modules, if any, for the specified tenantId.

Declaration

Task<List<BoughtModule>> FindBoughtModulesByTenantAsync(Guid tenantId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

System.Guid tenantId The tenant ID to search for bought modules.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<List<BoughtModule>> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the bought module for the specified tenantId if it exists.

FindByIdAsync(Guid, CancellationToken)

Finds and returns a module, if any, who has the specified moduleId.

Declaration

Task<Module> FindByIdAsync(Guid moduleId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

System.Guid moduleId The module ID to search for.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<Module> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the module matching the specified moduleId if it exists.

FindByNameAsync(String, CancellationToken)

Gets the module, if any, associated with the specified name.

Declaration

Task<Module> FindByNameAsync(string moduleName, CancellationToken cancellationToken = default(CancellationToken))

Parameters

String moduleName The module name to search for.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<Module> The task object containing the results of the asynchronous lookup operation, the module if any associated with the specified module name.

FindFunctionalityForModulesAsync(Guid[], CancellationToken)

Finds and returns all functionality, if any, for the specified moduleIds.

Declaration

Task<List<Functionality>> FindFunctionalityForModulesAsync(Guid[] moduleIds, CancellationToken cancellationToken = default(CancellationToken))

Parameters

System.Guid[] moduleIds An array of module id to get functionality for.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<List<Functionality>> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the functionalities for the specified moduleIds if it exists.

Remarks

If no moduleIds is specified, then all functionality will be returned.

GetAllAsync(ModuleSearchQuery, CancellationToken)

Gets all available modules.

Declaration

Task<QueryResult<Module>> GetAllAsync(ModuleSearchQuery query, CancellationToken cancellationToken = default(CancellationToken))

Parameters

ModuleSearchQuery query The ModuleSearchQuery used to limit the returned result.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<QueryResult<Module>> The System.Threading.Tasks.Task that represents the asynchronous operation, containing modules.

UpdateAsync(Module, CancellationToken)

Updates a module in a store as an asynchronous operation.

Declaration

Task<IdentityResult> UpdateAsync(Module module, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Module module The module to update in the store.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<IdentityResult> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult for the update.