IMobileServiceSyncTable<T>.PurgeAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| PurgeAsync<U>(String, IMobileServiceTableQuery<U>, CancellationToken) |
Deletes all the items in local table that match the query. |
| PurgeAsync<U>(String, IMobileServiceTableQuery<U>, Boolean, CancellationToken) |
Deletes all the items in local table that match the query. |
PurgeAsync<U>(String, IMobileServiceTableQuery<U>, CancellationToken)
Deletes all the items in local table that match the query.
public System.Threading.Tasks.Task PurgeAsync<U> (string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query, System.Threading.CancellationToken cancellationToken);abstract member PurgeAsync : string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function PurgeAsync(Of U) (queryId As String, query As IMobileServiceTableQuery(Of U), cancellationToken As CancellationToken) As TaskType Parameters
- U
Parameters
- queryId
- 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
- IMobileServiceTableQuery<U>
An OData query that determines which items to delete.
- cancellationToken
- CancellationToken
The CancellationToken token to observe
Returns
A task that completes when purge operation has finished.
Applies to
PurgeAsync<U>(String, IMobileServiceTableQuery<U>, Boolean, CancellationToken)
Deletes all the items in local table that match the query.
public System.Threading.Tasks.Task PurgeAsync<U> (string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query, bool force, System.Threading.CancellationToken cancellationToken);abstract member PurgeAsync : string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function PurgeAsync(Of U) (queryId As String, query As IMobileServiceTableQuery(Of U), force As Boolean, cancellationToken As CancellationToken) As TaskType Parameters
- U
Parameters
- queryId
- 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
- IMobileServiceTableQuery<U>
An OData query that determines which items to delete.
- force
- Boolean
Force the purge by discarding the pending operations.
- cancellationToken
- CancellationToken
The CancellationToken token to observe
Returns
A task that completes when purge operation has finished.
Applies to
Azure SDK for .NET