Class AuditHistorySettings
Namespace: Cephalon.Engine.Configuration
Assembly: Cephalon.Engine.dll
Describes configuration-driven durable audit-history settings for a Cephalon app.
public sealed class AuditHistorySettingsInheritance
Section titled “Inheritance”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”AuditHistorySettings(bool?, string?, string?, AuditHistoryExportSettings?, AuditHistoryRetentionSettings?)
Section titled “ AuditHistorySettings(bool?, string?, string?, AuditHistoryExportSettings?, AuditHistoryRetentionSettings?)”Initializes a new instance of the
public AuditHistorySettings(bool? enabled = null, string? provider = null, string? databaseRole = null, AuditHistoryExportSettings? export = null, AuditHistoryRetentionSettings? retention = null)Parameters
Section titled “Parameters”enabled bool?
Whether durable audit history was explicitly enabled.
provider string?
The selected durable history provider identifier.
databaseRole string?
The selected logical database role for durable history.
export AuditHistoryExportSettings?
The configured export settings for durable history.
retention AuditHistoryRetentionSettings?
The selected retention settings for durable history.
Fields
Section titled “Fields”DefaultDatabaseRole
Section titled “ DefaultDatabaseRole”Gets the default logical database role used by the durable audit-history path.
public const string DefaultDatabaseRole = "history"Field Value
Section titled “Field Value”Properties
Section titled “Properties”DatabaseRole
Section titled “ DatabaseRole”Gets the selected logical database role used by durable history.
public string? DatabaseRole { get; }Property Value
Section titled “Property Value”Gets an empty audit-history settings instance.
public static AuditHistorySettings Empty { get; }Property Value
Section titled “Property Value”Enabled
Section titled “ Enabled”Gets a value indicating whether durable audit history was explicitly enabled.
public bool? Enabled { get; }Property Value
Section titled “Property Value”bool?
Export
Section titled “ Export”Gets the configured export settings for durable history.
public AuditHistoryExportSettings Export { get; }Property Value
Section titled “Property Value”HasValues
Section titled “ HasValues”Gets a value indicating whether any durable audit-history settings were explicitly supplied.
public bool HasValues { get; }Property Value
Section titled “Property Value”Provider
Section titled “ Provider”Gets the selected durable history provider identifier.
public string? Provider { get; }Property Value
Section titled “Property Value”Retention
Section titled “ Retention”Gets the configured retention settings for durable history.
public AuditHistoryRetentionSettings Retention { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”FromSection(IConfigurationSection?)
Section titled “ FromSection(IConfigurationSection?)”Reads durable audit-history settings from the supplied configuration section.
public static AuditHistorySettings FromSection(IConfigurationSection? section)Parameters
Section titled “Parameters”section IConfigurationSection?
The audit-history configuration section to read.
Returns
Section titled “Returns”The parsed durable audit-history settings.