IMobileServiceSyncTable.PurgeAsync(String, String, Boolean, CancellationToken) IMobileServiceSyncTable.PurgeAsync(String, String, Boolean, CancellationToken) Method

Definition

Deletes all the items in local table that match the query.

public System.Threading.Tasks.Task PurgeAsync (string queryId, string query, bool force, System.Threading.CancellationToken cancellationToken);
abstract member PurgeAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Parameters
queryId
String String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter resets the incremental sync state for the query.

query
String String

An OData query that determines which items to delete.

force
Boolean Boolean

Force the purge by discarding the pending operations.

cancellationToken
CancellationToken CancellationToken

The CancellationToken token to observe

Returns

A task that completes when purge operation has finished.

Applies to