Class OnTenantResolvedResult

Namespace

GroupeIsa.Neos.Application

Assembly

GroupeIsa.Neos.Application.Abstractions.dll

Represents the on tenant resolved server method result.

public class OnTenantResolvedResult

Inheritance

object

OnTenantResolvedResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OnTenantResolvedResult(bool, Dictionary<string, object>?, string?, string?, string[]?)

Initializes a new instance of the OnTenantResolvedResult class.

public OnTenantResolvedResult(bool authorized, Dictionary<string, object>? context = null, string? theme = null, string? applicationCulture = null, string[]? inputCultures = null)

Parameters

authorized bool

The value indicating whether the user is authorized.

context Dictionary<string, object>

The context.

theme string

The theme.

applicationCulture string

The application culture with format "en-US".

inputCultures string[]

The input cultures with format "en-US".

OnTenantResolvedResult(Dictionary<string, object>?, string?, string?, string[]?)

Initializes a new instance of the OnTenantResolvedResult class.

public OnTenantResolvedResult(Dictionary<string, object>? context = null, string? theme = null, string? applicationCulture = null, string[]? inputCultures = null)

Parameters

context Dictionary<string, object>

The context.

theme string

The theme.

applicationCulture string

The application culture with format "en-US".

inputCultures string[]

The input cultures with format "en-US".

Properties

ApplicationCulture

Gets or sets the application culture.

public string? ApplicationCulture { get; protected set; }

Property Value

string

Authorized

Gets or sets a value indicating whether the user is authorized.

public bool Authorized { get; protected set; }

Property Value

bool

ClientOnlyContext

Gets or sets the client-only context.

public Dictionary<string, object>? ClientOnlyContext { get; protected set; }

Property Value

Dictionary<string, object>

Context

Gets or sets the context.

public Dictionary<string, object>? Context { get; protected set; }

Property Value

Dictionary<string, object>

InputCultures

Gets or sets the input culture used to display and input data.

public string[]? InputCultures { get; protected set; }

Property Value

string[]

Theme

Gets or sets the theme.

public string? Theme { get; protected set; }

Property Value

string

VisualIdentity

Gets or sets the name of the visual identity of the tenant to apply.

public string? VisualIdentity { get; protected set; }

Property Value

string

Remarks

In a multitenant cluster, it holds the visual identity chosen by the rules of Tenant Management before the first interceptor runs, or null when the tenant keeps the standard look. The value left by the last interceptor is applied. A name that Tenant Management does not know is logged and the visual identity of the rules is kept. An interceptor that returns a new result without calling WithVisualIdentity(string?) keeps the visual identity of the previous result.

Methods

RemoveClientOnlyContextValue(string)

Removes a client-only application context value.

public OnTenantResolvedResult RemoveClientOnlyContextValue(string key)

Parameters

key string

The key.

Returns

OnTenantResolvedResult

This.

RemoveContextValue(string)

Removes an application context value.

public OnTenantResolvedResult RemoveContextValue(string key)

Parameters

key string

The key.

Returns

OnTenantResolvedResult

This.

WithApplicationCulture(string?)

Sets the application culture.

public OnTenantResolvedResult WithApplicationCulture(string? applicationCulture)

Parameters

applicationCulture string

The application culture.

Returns

OnTenantResolvedResult

This.

WithAuthorized(bool)

Sets the authorized.

public OnTenantResolvedResult WithAuthorized(bool authorized)

Parameters

authorized bool

Authorized.

Returns

OnTenantResolvedResult

This.

WithClientOnlyContextValue(string, object)

Adds or updates a client-only application context value.

public OnTenantResolvedResult WithClientOnlyContextValue(string key, object value)

Parameters

key string

The key.

value object

The value.

Returns

OnTenantResolvedResult

This.

WithContextValue(string, object)

Adds or updates an application context value.

public OnTenantResolvedResult WithContextValue(string key, object value)

Parameters

key string

The key.

value object

The value.

Returns

OnTenantResolvedResult

This.

WithInputCultures(IEnumerable<string>?)

Sets the input cultures.

public OnTenantResolvedResult WithInputCultures(IEnumerable<string>? inputCultures)

Parameters

inputCultures IEnumerable<string>

The input cultures.

Returns

OnTenantResolvedResult

This.

WithTheme(string?)

Sets the theme.

public OnTenantResolvedResult WithTheme(string? theme)

Parameters

theme string

The theme.

Returns

OnTenantResolvedResult

This.

WithVisualIdentity(string?)

Sets the visual identity of the tenant to apply, which replaces the one chosen by the rules of Tenant Management.

public OnTenantResolvedResult WithVisualIdentity(string? visualIdentity)

Parameters

visualIdentity string

The exact name of a visual identity of Tenant Management, compared with its case, or null for the standard look.

Returns

OnTenantResolvedResult

This.