IProviderUpgradeCallback Interface
When implemented by a derived class, represents methods that Sync Framework can call to notify a provider about events that occur during a metadata store upgrade that is initiated because the provider version has changed.
Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)
Syntax
'Declaration
Public Interface IProviderUpgradeCallback
'Usage
Dim instance As IProviderUpgradeCallback
public interface IProviderUpgradeCallback
public interface class IProviderUpgradeCallback
type IProviderUpgradeCallback = interface end
public interface IProviderUpgradeCallback
The IProviderUpgradeCallback type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
OnCustomReplicaMetadataDeserialized | Occurs when the custom metadata field for the replica is read from the serialized metadata. |
|
OnItemMetadataDeserialized | Occurs one time for each item that is read from the serialized metadata. |
|
OnProviderUpgradeRequired | Occurs when the expected provider compatibility version specified to DeserializeReplicaMetadata does not match the provider version that is contained in the serialized metadata. |
Top
Remarks
The IProviderUpgradeCallback interface is typically implemented by a provider.
After a provider opens a metadata storage service store, it can check the provider version that is associated with the metadata in the store, and determine whether the metadata must be upgraded. The provider version associated with the metadata is stored in the ProviderVersion property.
To upgrade the metadata for a replica, the provider saves the metadata in canonical format, removes the metadata from the current store, initializes new replica metadata in the metadata store by using the upgraded schema, and imports the metadata into the store by using DeserializeReplicaMetadata together with an IProviderUpgradeCallback object. For more information, see Upgrading the Metadata Store Version.