SyncOrchestrator Class
Initiates and controls synchronization sessions.
Inheritance Hierarchy
System.Object
Microsoft.Synchronization.SyncOrchestrator
Namespace: Microsoft.Synchronization
Assembly: Microsoft.Synchronization (in Microsoft.Synchronization.dll)
Syntax
'Declaration
Public Class SyncOrchestrator
'Usage
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.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SyncOrchestrator | Initializes a new instance of the SyncOrchestrator class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "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. |
|
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. |
|
LocalProvider | Gets or sets the local synchronization provider. |
|
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. |
|
RemoteProvider | Gets or sets the remote synchronization provider. |
|
State | Gets the current state of the orchestrator. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Cancel | Cancels the current synchronization session. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
Synchronize | Starts a synchronization session. |
|
ToString | (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
SessionProgress | Occurs periodically during the synchronization session to report progress. |
|
StateChanged | Occurs when State changes. |
Top
Remarks
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.