IncomingPoolingSyncProcessAsync Method (String, ProcessingDepth, ILogger, CancellationToken)

public Task<OperationResult> ProcessAsync(
	string userFileSystemPath,
	ProcessingDepth processingDepth = ProcessingDepth.Infinity,
	ILogger logger = null,
	CancellationToken cancellationToken = null
)

Public Function ProcessAsync ( 
	userFileSystemPath As String,
	Optional processingDepth As ProcessingDepth = ProcessingDepth.Infinity,
	Optional logger As ILogger = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of OperationResult)

public:
Task<OperationResult^>^ ProcessAsync(
	String^ userFileSystemPath, 
	ProcessingDepth processingDepth = ProcessingDepth::Infinity, 
	ILogger^ logger = nullptr, 
	CancellationToken cancellationToken = nullptr
)

member ProcessAsync : 
        userFileSystemPath : string * 
        ?processingDepth : ProcessingDepth * 
        ?logger : ILogger * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _processingDepth = defaultArg processingDepth ProcessingDepth.Infinity
        let _logger = defaultArg logger null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<OperationResult> 

Parameters

userFileSystemPath

Type: SystemString
File or folder path in user file system to start synchronization from.

processingDepth (Optional)

Type: ITHit.FileSystem.Windows.SynchronizationProcessingDepth
Specifies processing depth.

logger (Optional)

Type: ITHit.FileSystemILogger
Logger

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.

Return Value

Calling this method will trigger one time remote storage to user file system synchronization of a file or a folder. In case a folder is specified, and processingDepth parameter is Infinity, the Engine will traverse all folders loaded on the client under the specified folder and call GetChildrenAsync(String, IOperationContext, IFolderListingResultContext, CancellationToken) for each folder to get new folder content from your remote storage. The Engine will compare folder content and create, update and delete items on the client. To find if an item content or metadata is modified the Engine will use MetadataETag and ContentETag.

The Engine calls this method automatically for root folder with Infinity parameter if the IncomingSyncMode is set to TimerPooling. You will call this method manually if your remote storage provides information about create, update, delete and move operations via web sockets, on first web sockets connection and every web sockets reconnection.

• To get all changes from remote storage that were made when the Engine was not running.
• After web sockets connection to the remote storage is restored.
• After succesefull authentication.
• To find and process all items that failed to sync from remote storage to user file system for any reason.

Reference