SyncOrchestrator Class

Initiates and controls synchronization sessions.


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

public class SyncOrchestrator

The SyncOrchestrator type exposes the following members.

Public methodSyncOrchestratorInitializes a new instance of the SyncOrchestrator class.

Public propertyDirectionGets or sets the direction of synchronization. For two-way synchronizations, this also includes the order in which the synchronizations are performed.
Public propertyLocalDataConverterGets or sets the data converter for the local provider. This enables the conversion of data to and from the local provider’s data format.
Public propertyLocalProviderGets or sets the local synchronization provider.
Public propertyRemoteDataConverterGets or sets the data converter for the remote provider. This enables the conversion of data to and from the remote provider’s data format.
Public propertyRemoteProviderGets or sets the remote synchronization provider.
Public propertyStateGets the current state of the orchestrator.

Public methodCancelCancels the current synchronization session.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSynchronizeStarts a synchronization session.
Public methodToString (Inherited from Object.)

Public eventSessionProgressOccurs periodically during the synchronization session to report progress.
Public eventStateChangedOccurs when State changes.

SyncOrchestrator contains the two SyncProvider objects that will participate in synchronization. It starts and controls the synchronization session, and dispatches progress events to the application.

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