Delen via


IArraySettingMigrator Interface

Definition

Migration support for array settings in Unified Settings. This is invoked if array settings include a migrationCallback property indicating the package and/or service ID to invoke. It should be implemented by the setting owner.

public interface IArraySettingMigrator
type IArraySettingMigrator = interface
Public Interface IArraySettingMigrator

Methods

MigrateFromUnifiedSettingsAsync(String, ArraySettingContent, CancellationToken)

Writes an array setting into the legacy store at its old location and persistence format.

MigrateToUnifiedSettingsAsync(String, CancellationToken)

Reads a persisted array setting from its legacy location and returns it in a form Unified Settings can understand.

SupportsIncompleteItems(String)

Returns a Boolean value indicating whether this migrator's MigrateFromUnifiedSettingsAsync(String, ArraySettingContent, CancellationToken) method supports "incomplete" items: items that are missing some properties (because those properties haven't been customized from the default). If this returns false, the caller will add default values in place of missing properties before calling that method.

Applies to