ISynchronizationCollectionGetChangesAsync Method |
IT Hit User File System
Provides the engine with changes received from remote storage since last sync token.
Namespace:
ITHit.FileSystem.Synchronization
Assembly:
ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 8.3.27213.0
Syntax Task<IChanges> GetChangesAsync(
string syncToken,
bool deep,
Nullable<long> limit,
CancellationToken cancellationToken
)
Function GetChangesAsync (
syncToken As String,
deep As Boolean,
limit As Nullable(Of Long),
cancellationToken As CancellationToken
) As Task(Of IChanges)
Task<IChanges^>^ GetChangesAsync(
String^ syncToken,
bool deep,
Nullable<long long> limit,
CancellationToken cancellationToken
)
abstract GetChangesAsync :
syncToken : string *
deep : bool *
limit : Nullable<int64> *
cancellationToken : CancellationToken -> Task<IChanges>
Parameters
- syncToken
- Type: SystemString
The synchronization token provided by the remote storage dyring last sychronization event.
Null in case of the initial synchronization call.
- deep
- Type: SystemBoolean
Indicates the "scope" of the synchronization report request, false - immediate children and true - all children at any depth. - limit
- Type: SystemNullableInt64
The number of items to return. Null in case of no limit. - cancellationToken
- Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.
Return Value
Type:
TaskIChanges
A list of changes that correspond to a
syncToken.
In
NewSyncToken property this object must return
a new new sync-token received from the remote storage.
Remarks
In this method you will request all changes from your remote storage passing the provided syncToken.
The remote storage must return all changes that happend after the provided syncToken
and a new sync-token.
You will return all changes and a new sync-token to the Engine. The Engine will process all changes and save a new sync-token.
Any items that failed to process, for example because an item was blocked, will be marked as a conflict.
See Also