Show / Hide Table of Contents

Class TenantSettingsStore<TContext>

Represents a new instance of a persistence store for tenant authentication settings.

Inheritance
Object
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase
TenantSettingsStore<TContext>
Inherited Members
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.GetAllSchemesAsync(System.Threading.CancellationToken)
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.GetSchemesAsync(System.String, System.Threading.CancellationToken)
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.HasSchemeChanged(IRM.AspNetCore.Authentication.Serialization.AuthenticationScheme, IRM.AspNetCore.Authentication.Serialization.AuthenticationScheme)
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.HasSchemeOptionsChanged(IRM.AspNetCore.Authentication.Serialization.AuthenticationScheme, IRM.AspNetCore.Authentication.Serialization.AuthenticationScheme)
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.Options
Object.Equals(Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: IRM.AspNetCore.Identity.EntityFrameworkCore
Assembly: IRM.AspNetCore.Identity.EntityFrameworkCore.dll
Syntax
public class TenantSettingsStore<TContext> : DynamicAuthenticationSchemeStoreBase, ITenantSettingsStore, IAuthenticationSchemeStore, IDisposable where TContext : DbContext
Type Parameters
TContext

Constructors

TenantSettingsStore(ITenantSettingsCache, IConfigureDynamicOptions, IOptionsMonitor<DynamicAuthenticationOptions>, IServiceProvider)

Declaration
public TenantSettingsStore(ITenantSettingsCache tenantAuthenticationSettingsCache, IConfigureDynamicOptions configureDynamicOptions, IOptionsMonitor<DynamicAuthenticationOptions> dynamicAuthenticationOptions, IServiceProvider serviceProvider)
Parameters
ITenantSettingsCache tenantAuthenticationSettingsCache

IRM.AspNetCore.Authentication.Dynamic.IConfigureDynamicOptions configureDynamicOptions

Microsoft.Extensions.Options.IOptionsMonitor<IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationOptions> dynamicAuthenticationOptions

System.IServiceProvider serviceProvider

Methods

ConfigureAuthenticationSchemes(CancellationToken)

Declaration
protected override async Task ConfigureAuthenticationSchemes(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken cancellationToken

Returns
System.Threading.Tasks.Task

Overrides
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.ConfigureAuthenticationSchemes(System.Threading.CancellationToken)

Dispose()

Releases all resources used by the store.

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

Dispose(Boolean)

Releases the unmanaged resources used by the organisation manager and optionally releases the managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

FindById(Guid)

Gets the TenantSettings for the tenant identified by tenantId.

Declaration
public TenantSettings FindById(Guid tenantId)
Parameters
System.Guid tenantId

The unique identity of a tenant.

Returns
TenantSettings

The TenantSettings for the tenant identified by tenantId.

Implements
ITenantSettingsStore.FindById(Guid)

FindByIdAsync(Guid, CancellationToken)

Gets the TenantSettings for the tenant identified by tenantId.

Declaration
public async Task<TenantSettings> FindByIdAsync(Guid tenantId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Guid tenantId

The unique identity of a tenant.

System.Threading.CancellationToken cancellationToken

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

Returns
System.Threading.Tasks.Task<TenantSettings>

The TenantSettings for the tenant identified by tenantId.

Implements
ITenantSettingsStore.FindByIdAsync(Guid, CancellationToken)

FindByIdsAsync(Guid[], CancellationToken)

Declaration
public async Task<List<TenantSettings>> FindByIdsAsync(Guid[] tenantIds, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Guid[] tenantIds

System.Threading.CancellationToken cancellationToken

Returns
System.Threading.Tasks.Task<List<TenantSettings>>

FindByUniqueUrl(String, CancellationToken)

Gets the TenantSettings for the tenant identified by uniqueUrl.

Declaration
public async Task<TenantSettings> FindByUniqueUrl(string uniqueUrl, CancellationToken cancellationToken = default(CancellationToken))
Parameters
String uniqueUrl

The unique url identifying a tenant.

System.Threading.CancellationToken cancellationToken

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

Returns
System.Threading.Tasks.Task<TenantSettings>

The TenantSettings for the tenant identified by uniqueUrl.

Implements
ITenantSettingsStore.FindByUniqueUrl(String, CancellationToken)

GetAuthenticationSchemesFromStore(CancellationToken)

Declaration
protected override async Task<IEnumerable<AuthenticationScheme>> GetAuthenticationSchemesFromStore(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken cancellationToken

Returns
System.Threading.Tasks.Task<IEnumerable<Microsoft.AspNetCore.Authentication.AuthenticationScheme>>

Overrides
IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationSchemeStoreBase.GetAuthenticationSchemesFromStore(System.Threading.CancellationToken)

SaveAsync(TenantSettings, CancellationToken)

Saves the TenantSettings for a tenant.

Declaration
public async Task<IdentityResult> SaveAsync(TenantSettings tenantAuthenticationSettings, CancellationToken cancellationToken = default(CancellationToken))
Parameters
TenantSettings tenantAuthenticationSettings

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 save operation.

Implements
ITenantSettingsStore.SaveAsync(TenantSettings, CancellationToken)

ThrowIfDisposed()

Throws an System.ObjectDisposedException if the person store is disposed.

Declaration
protected void ThrowIfDisposed()
Back to top Generated by DocFX