Interface ISystemConfigurationSettings

Settings for the System Configuration Service.

Namespace: Serenity.SystemConfiguration.Application.Entities

Assembly: Serenity.SystemConfiguration.Application.dll

Syntax

public interface ISystemConfigurationSettings : IFoundationSettings

Properties

CollectOnFocusChange

Indicates whether to collect system configuration data on focus change.

Declaration

bool CollectOnFocusChange { get; }

Property Value

Type	Description
bool	True if collection on focus change is enabled; otherwise, false.

CollectOnResolutionChange

Indicates whether to collect system configuration data on resolution change.

Declaration

bool CollectOnResolutionChange { get; }

Property Value

Type	Description
bool	True if collection on resolution change is enabled; otherwise, false.

CollectOnStartup

Indicates whether to collect system configuration data on application startup.

Declaration

bool CollectOnStartup { get; }

Property Value

Type	Description
bool	True if collection on startup is enabled; otherwise, false.

CultureListSource

Specifies the source for determining the list of supported cultures in the system configuration data collection.

Declaration

CultureListSourceMode CultureListSource { get; }

Property Value

Type	Description
CultureListSourceMode	The source for determining the list of supported cultures.

EnableEditorPersistence

Indicates whether to enable persistence of settings in the editor environment.

Declaration

bool EnableEditorPersistence { get; }

Property Value

Type	Description
bool	True if editor persistence is enabled; otherwise, false.

EnableOnPlatform

Specifies the platforms on which the system configuration service is enabled.

Declaration

PlatformMask EnableOnPlatform { get; }

Property Value

Type	Description
PlatformMask	The platform mask indicating enabled platforms.

IncludeCultureInfo

Indicates whether to include culture information in the system configuration data collection.

Declaration

bool IncludeCultureInfo { get; }

Property Value

Type	Description
bool	True if culture information is included; otherwise, false.

IncludeDisplayInfo

Indicates whether to include display and graphics information in the system configuration data collection.

Declaration

bool IncludeDisplayInfo { get; }

Property Value

Type	Description
bool	True if display and graphics information is included; otherwise, false.

IncludeMachineName

Indicates whether to include the machine name in logs and telemetry data.

Declaration

bool IncludeMachineName { get; }

Property Value

Type	Description
bool	True if the machine name is included; otherwise, false.

IncludeOsAndHardware

Indicates whether to include operating system and hardware information in the system configuration data collection.

Declaration

bool IncludeOsAndHardware { get; }

Property Value

Type	Description
bool	True if OS and hardware information is included; otherwise, false.

IncludeXRInfo

Indicates whether to include XR (Extended Reality) information in the system configuration data collection.

Declaration

bool IncludeXRInfo { get; }

Property Value

Type	Description
bool	True if XR information is included; otherwise, false.

JsonFileName

Specifies the JSON file name to use when persisting the last collected snapshot to disk.

Declaration

string JsonFileName { get; }

Property Value

Type	Description
string	The JSON file name as a string.

MinRefreshRateHz

Specifies the minimum refresh rate (in Hz) to consider when collecting system configuration data.

Declaration

int MinRefreshRateHz { get; }

Property Value

Type	Description
int	The minimum refresh rate in Hz as an integer (0 to not filter).

PersistLastSnapshotToDisk

Indicates whether to persist the last collected snapshot to disk for debugging purposes.

Declaration

bool PersistLastSnapshotToDisk { get; }

Property Value

Type	Description
bool	True if persisting to disk is enabled; otherwise, false.

PollingEnabled

Indicates whether polling is enabled for system configuration data collection.

Declaration

bool PollingEnabled { get; }

Property Value

Type	Description
bool	True if polling is enabled; otherwise, false.

PollingIntervalSeconds

Specifies the polling interval in seconds for system configuration data collection.

Declaration

float PollingIntervalSeconds { get; }

Property Value

Type	Description
float	The polling interval in seconds as a float.

PreferredCultureOverride

Specifies the preferred culture to use if the override is enabled.

Declaration

string PreferredCultureOverride { get; }

Property Value

Type	Description
string	The preferred culture as a string.

PrimaryDisplayIndex

Specifies the index of the primary display to be used in the system configuration data collection.

Declaration

int PrimaryDisplayIndex { get; }

Property Value

Type	Description
int	The index of the primary display as an integer.

RayTracingMode

Specifies the mode for detecting ray tracing support in the system configuration data collection.

Declaration

RayTracingDetectionMode RayTracingMode { get; }

Property Value

Type	Description
RayTracingDetectionMode	The mode for detecting ray tracing support.

RefreshRateSource

Specifies the source for determining the refresh rate in the system configuration data collection.

Declaration

RefreshRateSourceMode RefreshRateSource { get; }

Property Value

Type	Description
RefreshRateSourceMode	The source for determining the refresh rate.

SyncMap

Specifies the mapping between system configuration snapshot keys and game settings keys for synchronization.

Declaration

SnapshotKeyMap[] SyncMap { get; }

Property Value

Type	Description
SnapshotKeyMap[]	An array of snapshot key mappings.

SyncWithGameSettingsOnCollect

Indicates whether to synchronize system configuration settings with game settings on data collection.

Declaration

bool SyncWithGameSettingsOnCollect { get; }

Property Value

Type	Description
bool	True if synchronization with game settings is enabled; otherwise, false.

UsePreferredCultureOverride

Indicates whether to use a preferred culture override instead of the system's current culture.

Declaration

bool UsePreferredCultureOverride { get; }

Property Value

Type	Description
bool	True if the preferred culture override is enabled; otherwise, false.

Verbosity

Specifies the verbosity level for logging system configuration service activities.

Declaration

LogVerbosity Verbosity { get; }

Property Value

Type	Description
LogVerbosity	The verbosity level.