SimpleSyncProvider Class

Represents a simple provider that is used to synchronize a replica. You will typically extend FullEnumerationSimpleSyncProvider or AnchorEnumerationSimpleSyncProvider.

Namespace:  Microsoft.Synchronization.SimpleProviders
Assembly:  Microsoft.Synchronization.SimpleProviders (in Microsoft.Synchronization.SimpleProviders.dll)

'Declaration
Public MustInherit Class SimpleSyncProvider _
	Inherits SyncProvider
'Usage
Dim instance As SimpleSyncProvider

The SimpleSyncProvider type exposes the following members.

  NameDescription
Protected methodSimpleSyncProviderInitializes a new instance of the SimpleSyncProvider class.
Top

  NameDescription
Public propertyConfigurationWhen overridden in a derived class, gets a KnowledgeSyncProviderConfiguration object that represents configuration information for a provider, such as the conflict resolution policy.
Public propertyDestinationCallbacksWhen overridden in a derived class, gets a SyncCallbacks object that is used to dispatch a synchronization event.
Public propertyIdFormatsWhen overridden in a derived class, gets a SyncIdFormatGroup object that represents the format of replica and item IDs.
Public propertyMetadataSchemaWhen overridden in a derived class, gets an ItemMetadataSchema object that represents the metadata schema for an item.
Public propertyProviderVersionWhen overridden in a derived class, gets the version number for the simple provider.
Top

  NameDescription
Public methodBeginSessionWhen overridden in a derived class, called by the Sync Framework runtime at the start of each session.
Public methodDeleteItemWhen overridden in a derived class, called by the Sync Framework runtime to delete an item from the destination store.
Public methodEndSessionWhen overridden in a derived class, called by the Sync Framework runtime at the end of each session unless a session is terminated because of an exception.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetMetadataStoreWhen overridden in a derived class, called by the Sync Framework runtime to return a MetadataStore object for a replica.
Public methodGetType (Inherited from Object.)
Public methodInsertItemWhen overridden in a derived class, called by the Sync Framework runtime to insert an item into the destination store.
Public methodLoadChangeDataWhen overridden in a derived class, called by the Sync Framework runtime to load the change data for the item with the specified key.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodOnChangeDetectionCompletedWhen overridden in a derived class, raises the ChangeDetectionCompleted event.
Public methodOnItemConflictingWhen overridden in a derived class, raises the ItemConflicting event.
Public methodOnItemConstraintWhen overridden in a derived class, raises the ItemConstraint event.
Public methodOnMetadataStoreInitializedWhen overridden in a derived class, raises the MetadataStoreInitialized event.
Public methodToString (Inherited from Object.)
Public methodUpdateItemWhen overridden in a derived class, called by the Sync Framework runtime to update an item in the destination store.
Top

  NameDescription
Public eventChangeDetectionCompletedOccurs when change detection is complete for a source provider.
Public eventItemConflictingOccurs when Sync Framework detects that an item being processed is involved in a concurrency conflict.
Public eventItemConstraintOccurs when Sync Framework detects that an item being processed is involved in a constraint conflict.
Public eventMetadataStoreInitializedOccurs when the metadata store that is associated with a provider is initialized.
Top

The simple provider API is designed primarily for two types of replicas:

  • Replicas that do not support any kind of change tracking. This type of replica uses a full enumeration provider (FullEnumerationSimpleSyncProvider), which enumerates all items from the source replica every time synchronization occurs.

  • Replicas that support anchor-based change tracking. This type of replica uses an anchor-based provider (AnchorEnumerationSimpleSyncProvider), which enumerates the items from the source replica that changed after a specific anchor was set, which is typically a point in time.

For more information about simple providers, see How to: Create a Managed Simple Provider. For more information about custom providers in general, see Custom Provider Fundamentals, especially the section "Deciding Between a Simple Provider and a Standard Provider".

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: