ISettingsUnitPluginUpgradeDataAsync - метод
Пространство имён: Tessa.SettingsUnitsСборка: Tessa (в Tessa.dll) Версия: 4.2.2+a8f0dd3c063817b2e3f05a923303d808e447c338
ValueTask<Dictionary<string?, Object>> UpgradeDataAsync(
SettingsUnitRecord record,
CancellationToken cancellationToken = default
)
Function UpgradeDataAsync (
record As SettingsUnitRecord,
Optional cancellationToken As CancellationToken = Nothing
) As ValueTask(Of Dictionary(Of String, Object))
ValueTask<Dictionary<String^, Object^>^> UpgradeDataAsync(
SettingsUnitRecord^ record,
CancellationToken cancellationToken = CancellationToken()
)
abstract UpgradeDataAsync :
record : SettingsUnitRecord *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> ValueTask<Dictionary<string, Object>>
- record SettingsUnitRecord
-
The settings unit record whose data may require an upgrade.
The provided record object must not be modified directly.
Return a modified copy of Data if changes are required.
- cancellationToken CancellationToken (Optional)
Propagates notification that operations should be canceled.
ValueTaskDictionaryString,
ObjectA modified data storage object if an upgrade was performed; otherwise,
.
This method provides schema migration support and ensures backward compatibility by migrating older data schemas to the current one.
It is invoked once when the settings record is receiving or importing if it schema version differs from the current version returned by
GetSchemeVersion(SettingsUnitKey).