ISettingsUnitPlugin - интерфейс
Represents a plugin that manages the lifecycle, validation, and transformation of settings data.
Пространство имён: Tessa.SettingsUnitsСборка: Tessa (в Tessa.dll) Версия: 4.2.0+ffad8363f63902f18b3b3f4cfa533a14b2fb19a6
public interface ISettingsUnitPlugin
Public Interface ISettingsUnitPlugin
public interface class ISettingsUnitPlugin
type ISettingsUnitPlugin = interface end
| ID |
Unique identifier of the plugin.
|
| GetActualFragmentsAsync |
Resolves the actual fragment names by filtering or transforming the provided fragment names based on current context and availability.
|
| GetSchemeVersion |
Retrieves current schema version of the settings data managed by this plugin.
|
| IsSupportFragments |
Returns an indication that the plugin supports fragment processing for the unit with identifier unitID.
|
| MergePartialDataAsync |
A lifecycle hook invoked before persisting partially updated data, responsible for merging the provided
partial data with the existing Data.
|
| OnRemovedAsync |
A lifecycle hook invoked after a settings unit has been successfully removed from persistent storage.
|
| OnSavedAsync |
A lifecycle hook invoked after the settings data has been successfully persisted.
|
| PrepareForCacheAsync |
A lifecycle hook invoked after the settings data is loaded from persistent storage
or created via TryGetDefaultAsync(SettingsUnitKey, CancellationToken), but before it is placed into the cache.
|
| PrepareForClientAsync |
A lifecycle hook invoked after a settings unit is loaded for use at client (UI editor), typically from cache.
Intended for populating transient or context-specific data that must not be cached or persisted.
|
| PrepareForPersistentAsync |
A lifecycle hook invoked before the settings data is persisted to storage.
|
| PrepareForRemoveAsync |
A lifecycle hook invoked before a settings unit record is removed from persistent storage.
|
| PrepareForUsageAsync |
A lifecycle hook invoked after a settings unit is loaded for use at API, typically from cache.
Intended for populating transient or context-specific data that must not be cached or persisted.
|
| TryGetDefaultAsync |
Creates a new [!:SettingsUnitData] object initialized with default values for the specified settings unit.
|
| UpgradeAsync |
Upgrades the structure of the settings data to be compatible with the current [!:SchemeVersion].
|
| ValidateForPersistentAsync |
A lifecycle hook invoked for validation the settings unit data before it is persisted.
|