ITenantScope<TKey> interface

Namespace: Tenantry.Core · Package: Tenantry.Core · API reference

Represents a scoped interface for managing tenant-specific context within the application. It provides mechanisms to activate and maintain a tenant context within the current execution flow, such as for HTTP requests or background tasks.

public interface ITenantScope<TKey> : ITenantContext<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

• TKey: The type used for tenant identification. This type must support equality comparison and parsing operations.

MethodsCopy Anchor Link

BeginScope(ITenantDescriptor<TKey>)Copy Anchor Link

Activates a tenant for the current execution context (e.g. an HTTP request or background job). Scopes may nest: an inner scope shadows the outer tenant, and disposing it restores the outer tenant (the outermost scope restores "no tenant"). The returned IDisposable restores the previously active tenant when disposed.

IDisposable BeginScope(ITenantDescriptor<TKey> tenant)

Parameters:

• tenant ITenantDescriptor<TKey>: The tenant to activate.

Returns: IDisposable: A handle that restores the previously active tenant on disposal.