Share via


SyncAgent Members

The SyncAgent object orchestrates synchronization.

The following tables list the members exposed by the SyncAgent type.

Public Constructors

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

Top

Public Properties

  Name Description
Public property Configuration Gets a SyncConfiguration object that contains information about tables and synchronization parameters.
Public property LocalProvider Gets or sets an object derived from ClientSyncProvider that is used to communicate with the local data store.
Public property RemoteProvider Gets or sets an object derived from ServerSyncProvider that is used to communicate with the remote data store.
Public property SessionState Gets or sets a SyncSessionState object that is used to define whether the session is currently synchronizing.

This property is not CLS-compliant.
Public property SyncStatistics Gets a SyncStatistics object that represents statistics for a synchronization session.

Top

Public Methods

(see also Protected Methods )

  Name Description
Public method Dispose Overloaded. Releases the resources used by the SyncAgent.
Public method Equals  Overloaded. (Inherited from Object.)
Public method GetHashCode  (Inherited from Object.)
Public method GetType  (Inherited from Object.)
Public method Static ReferenceEquals  (Inherited from Object.)
Public method Synchronize Synchronizes data between the local and remote data stores.
Public method ToString  (Inherited from Object.)

Top

Protected Methods

  Name Description
Protected method Dispose Overloaded. Releases the resources used by the SyncAgent.
Protected method Finalize  (Inherited from Object.)
Protected method MemberwiseClone  (Inherited from Object.)
Protected method OnSessionProgress Raises the SessionProgress event.

This method is not CLS-compliant.
Protected method OnSessionStateChanged Raises the StateChanged event.

This method is not CLS-compliant.

Top

Public Events

  Name Description
Public event SessionProgress Occurs during synchronization: after metadata is read at the client, after metadata is written, after changes are downloaded, and after changes are uploaded.

This event is not CLS-compliant.
Public event StateChanged Occurs when there is a change in the synchronization session state.

This event is not CLS-compliant.

Top

See Also

Reference

SyncAgent Class
Microsoft.Synchronization Namespace