public interface ISettingsUnitPluginPublic Interface ISettingsUnitPluginpublic interface class ISettingsUnitPlugintype ISettingsUnitPlugin = interface end| ID | Unique identifier of the plugin. |
| AfterGetAsync | A lifecycle hook invoked after the settings unit record is loaded from storage or created via TryGetDefaultDataAsync(SettingsUnitKey, CancellationToken), but before it is returned. |
| AfterRemoveAsync | A lifecycle hook invoked after the settings unit has been successfully removed. |
| AfterStoreAsync | A lifecycle hook invoked after the settings unit record has been successfully persisted. |
| BeforeGetAsync | A lifecycle hook invoked before the settings unit record is loaded from storage. |
| BeforeRemoveAsync | A lifecycle hook invoked before the settings unit record is removed. |
| BeforeStoreAsync | A lifecycle hook invoked before the settings unit record is persisted. |
| CheckFragmentsSupport | Determines whether the plugin supports fragment processing for the specified settings unit with identifier unitID. |
| GetActualFragmentsAsync | Resolves the actual fragment identifiers by filtering or transforming the provided fragment identifiers based on current context and availability. |
| GetSchemeVersion | Retrieves the current schema version of the settings data managed by this plugin for the specified settings unit key. |
| MergePartialDataAsync |
A lifecycle hook invoked before storing partially updated data, responsible for merging the provided
partial data with the existing Data. |
| TransformForEditorAsync |
A lifecycle hook invoked after a settings unit is loaded for use at UI editor.
This method will be called after TransformForUsageAsync(SettingsUnitRecord, CancellationToken).
Intended for populating transient or context-specific data that must not be cached or stored. |
| TransformForUsageAsync | A lifecycle hook invoked after a settings unit is loaded for use, typically from cache. Intended for populating transient or context-specific data that must not be cached or stored. |
| TryGetDefaultDataAsync | Creates a new data storage object initialized with default values for the specified settings unit. |
| TryGetDescriptorOverridesAsync | Provides descriptor overrides for the specified settings unit. |
| UpgradeDataAsync | Upgrades the structure of the settings data to be compatible with the current scheme version returned by GetSchemeVersion(SettingsUnitKey). |
| ValidateForStoreAsync | A lifecycle hook invoked to validate the settings unit data before it is stored. |