SyncOrchestrator Class

Initiates and controls synchronization sessions.

Inheritance Hierarchy


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


Public Class SyncOrchestrator
Dim instance As SyncOrchestrator
public class SyncOrchestrator
public ref class SyncOrchestrator
type SyncOrchestrator =  class end
public class SyncOrchestrator

The SyncOrchestrator type exposes the following members.


  Name Description
Public method SyncOrchestrator Initializes a new instance of the SyncOrchestrator class.



  Name Description
Public property Direction Gets or sets the direction of synchronization. For two-way synchronizations, this also includes the order in which the synchronizations are performed.
Public property LocalDataConverter Gets 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 property LocalProvider Gets or sets the local synchronization provider.
Public property RemoteDataConverter Gets 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 property RemoteProvider Gets or sets the remote synchronization provider.
Public property State Gets the current state of the orchestrator.



  Name Description
Public method Cancel Cancels the current synchronization session.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Synchronize Starts a synchronization session.
Public method ToString (Inherited from Object.)



  Name Description
Public event SessionProgress Occurs periodically during the synchronization session to report progress.
Public event StateChanged Occurs 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.

Thread Safety

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

See Also


Microsoft.Synchronization Namespace