IFileDataRetriever Interface

Represents the mechanism by which a file synchronization provider and a custom provider transfer data between each other.

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

public interface IFileDataRetriever

The IFileDataRetriever type exposes the following members.

  NameDescription
Public propertyAbsoluteSourceFilePathWhen overridden in a derived class, gets the absolute path to a file that is part of a replica.
Public propertyFileDataWhen overridden in a derived class, gets a FileData object that represents information about a file, such as its size.
Public propertyFileStreamWhen overridden in a derived class, gets a Stream object that can be used to access the data in a file.
Public propertyRelativeDirectoryPathWhen overridden in a derived class, gets the path of the file (without the file name), relative to the root directory of the replica.
Top

When a custom provider is the source provider and a FileSyncProvider object is the destination provider, the source provider must return an object that implements IFileDataRetriever object in its LoadChangeData method (LoadChangeData for simple providers).

When a custom provider is the destination provider and a FileSyncProvider object is the source provider, the destination provider will receive an IFileDataRetriever object in its SaveItemChange method. The destination provider can then use the IFileDataRetriever methods to get the file data from the source replica so that it can apply the change to the destination replica. For more information, see Synchronizing File Synchronization Provider with Other Providers.

Show: