Class SettingDescriptor

Namespace

RDCore.SDK.Server.Configuration

Assembly

RDCore.SDK.dll

One setting of the platform: its key, what its value is, when a change of it takes effect, and what it does.

public sealed record SettingDescriptor : IEquatable<SettingDescriptor>

Inheritance

object

SettingDescriptor

Implements

IEquatable<SettingDescriptor>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A descriptor is data, which travels where the settings types do not: to a client that completes and checks what is typed for a setting.

Properties

Choices

The values it can be, for a Choice or a Boolean; none otherwise.

public IReadOnlyList<string> Choices { get; init; }

Property Value

IReadOnlyList<string>

Description

What it does, in the language of the user interface; null when nothing describes it.

public string? Description { get; init; }

Property Value

string

IsSettable

Whether a client can change it: every setting but the ones only the deployed configuration sets (Deployment).

public bool IsSettable { get; }

Property Value

bool

IsTrustSensitive

Whether it decides what a program may do to the machine it runs on (TrustSensitiveSettingAttribute).

public bool IsTrustSensitive { get; init; }

Property Value

bool

Key

The key of the setting, its sections and its name separated by dots, as the settings types name them: Server.Verbose. A key is compared without regard to case.

public string Key { get; init; }

Property Value

string

Kind

What its value is.

public SettingValueKind Kind { get; init; }

Property Value

SettingValueKind

Maximum

The greatest value of a Integer; null for other kinds.

public long? Maximum { get; init; }

Property Value

long?

Minimum

The least value of a Integer; null for other kinds.

public long? Minimum { get; init; }

Property Value

long?

Reach

When a change of it takes effect (SettingAttribute).

public SettingReach Reach { get; init; }

Property Value

SettingReach