Class FeatureFlagDescriptor
Namespace: Cephalon.Abstractions.Features
Assembly: Cephalon.Abstractions.dll
Describes one feature flag visible to the active Cephalon runtime.
public sealed class FeatureFlagDescriptorInheritance
Section titled “Inheritance”object ← FeatureFlagDescriptor
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”FeatureFlagDescriptor(string, string, string, bool, FeatureFlagSourceKind, string?, FeatureFlagTargetingDescriptor?, IReadOnlyList<FeatureFlagProviderBindingDescriptor>?, IReadOnlyDictionary<string, string>?)
Section titled “ FeatureFlagDescriptor(string, string, string, bool, FeatureFlagSourceKind, string?, FeatureFlagTargetingDescriptor?, IReadOnlyList<FeatureFlagProviderBindingDescriptor>?, IReadOnlyDictionary<string, string>?)”Creates a feature-flag descriptor.
public FeatureFlagDescriptor(string id, string displayName, string description, bool enabled = false, FeatureFlagSourceKind sourceKind = FeatureFlagSourceKind.Host, string? sourceModuleId = null, FeatureFlagTargetingDescriptor? targeting = null, IReadOnlyList<FeatureFlagProviderBindingDescriptor>? providerBindings = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable feature-flag identifier.
displayName string
The operator-facing feature-flag name.
description string
The human-readable description of the gated behavior.
enabled bool
Indicates whether the feature flag is enabled before any targeting constraints are applied.
sourceKind FeatureFlagSourceKind
Identifies whether the feature flag is host-owned or module-owned.
sourceModuleId string?
The module identifier that owns this feature flag when sourceKind is
targeting FeatureFlagTargetingDescriptor?
The optional targeting constraints attached to the feature flag.
providerBindings IReadOnlyList<FeatureFlagProviderBindingDescriptor>?
Optional external provider bindings that can further gate the Cephalon-owned feature flag without replacing the local runtime descriptor as the source of truth.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata.
Properties
Section titled “Properties”Description
Section titled “ Description”Gets the human-readable description of the gated behavior.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the operator-facing feature-flag name.
public string DisplayName { get; }Property Value
Section titled “Property Value”Enabled
Section titled “ Enabled”Gets a value indicating whether the feature flag is enabled before targeting is applied.
public bool Enabled { get; }Property Value
Section titled “Property Value”Gets the stable feature-flag identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets operator-facing metadata for the feature flag.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
ProviderBindings
Section titled “ ProviderBindings”Gets the optional external provider bindings attached to the feature flag.
public IReadOnlyList<FeatureFlagProviderBindingDescriptor> ProviderBindings { get; }Property Value
Section titled “Property Value”IReadOnlyList<FeatureFlagProviderBindingDescriptor>
SourceKind
Section titled “ SourceKind”Gets the ownership kind for this feature flag.
public FeatureFlagSourceKind SourceKind { get; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets the owning module identifier when the feature flag is module-owned.
public string? SourceModuleId { get; }Property Value
Section titled “Property Value”Targeting
Section titled “ Targeting”Gets the optional targeting constraints attached to the feature flag.
public FeatureFlagTargetingDescriptor Targeting { get; }