PropagatedTenant struct

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

An extension point: for code that extends the package, such as another package that builds on it. An application rarely needs it.

What ITenantPropagator resolved for a job or message: a tenant to run as (PropagatedTenant.Resolved), no tenant (PropagatedTenant.WithoutTenant), or that the work must not run (PropagatedTenant.Skipped).

[EditorBrowsable(EditorBrowsableState.Advanced)]
public readonly record struct PropagatedTenant : IEquatable<PropagatedTenant>

Implements IEquatable<PropagatedTenant>.

PropertiesCopy Anchor Link

SkipCopy Anchor Link

The work must not run: the policy that applied is TenantPropagationBehavior.Skip.

public bool Skip { get; }

Value: bool

SkippedCopy Anchor Link

Do not run: the policy that applied is TenantPropagationBehavior.Skip.

public static PropagatedTenant Skipped { get; }

Value: PropagatedTenant

TenantCopy Anchor Link

The tenant to run as, an ITenantDescriptor<TKey>, or null when the work runs without one or is skipped.

public ITenantDescriptor? Tenant { get; }

Value: ITenantDescriptor

WithoutTenantCopy Anchor Link

Run without a tenant.

public static PropagatedTenant WithoutTenant { get; }

Value: PropagatedTenant

MethodsCopy Anchor Link

Resolved(ITenantDescriptor)Copy Anchor Link

Run as tenant.

public static PropagatedTenant Resolved(ITenantDescriptor tenant)

Parameters:

• tenant ITenantDescriptor: The tenant, an ITenantDescriptor<TKey> of the application's tenant key type.

Returns: PropagatedTenant: The result to pass to ITenantPropagator.Use.