MobileServiceSyncTableExtensions.PullAsync Method

Reference

Definition

Namespace:: Microsoft.WindowsAzure.MobileServices

Assembly:: Microsoft.Azure.Mobile.Client.dll

Assembly:: Microsoft.WindowsAzure.Mobile.dll

Package:: Microsoft.Azure.Mobile.Client v4.2.0

Package:: WindowsAzure.MobileServices v1.3.2

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

PullAsync(IMobileServiceSyncTable, String, String)	Pulls all items that match the given query from the associated remote table. Supports incremental sync.
PullAsync(IMobileServiceSyncTable, String, String, PullOptions)	Pulls all items that match the given query from the associated remote table. Supports incremental sync.
PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, CancellationToken)	Pulls all items that match the given query from the associated remote table. Supports incremental sync.
PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, Boolean, CancellationToken)	Pulls all items that match the given query from the associated remote table. Supports incremental sync.
PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, CancellationToken, PullOptions)	Pulls all items that match the given query from the associated remote table. Supports incremental sync.
PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>)	Pulls all items that match the given query from the associated remote table.
PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, PullOptions)	Pulls all items that match the given query from the associated remote table.
PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, CancellationToken)	Pulls all items that match the given query from the associated remote table.
PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, Boolean, CancellationToken)	Pulls all items that match the given query from the associated remote table.
PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, CancellationToken, PullOptions)	Pulls all items that match the given query from the associated remote table.

PullAsync(IMobileServiceSyncTable, String, String)

Pulls all items that match the given query from the associated remote table. Supports incremental sync.

public static System.Threading.Tasks.Task PullAsync (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable table, string queryId, string query);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable * string * string -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync (table As IMobileServiceSyncTable, queryId As String, query As String) As Task

Parameters

table: IMobileServiceSyncTable

The instance of table to execute pull on.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 25 characters or less and contain only alphanumeric characters, dash, and underscore.

query: String

An OData query that determines which items to pull from the remote table.

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{0,24}.

Applies to

PullAsync(IMobileServiceSyncTable, String, String, PullOptions)

Pulls all items that match the given query from the associated remote table. Supports incremental sync.

public static System.Threading.Tasks.Task PullAsync (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable table, string queryId, string query, Microsoft.WindowsAzure.MobileServices.Sync.PullOptions pullOptions);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable * string * string * Microsoft.WindowsAzure.MobileServices.Sync.PullOptions -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync (table As IMobileServiceSyncTable, queryId As String, query As String, pullOptions As PullOptions) As Task

Parameters

table: IMobileServiceSyncTable

The instance of table to execute pull on.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 255 characters or less and contain only alphanumeric characters, dash, and underscore.

query: String

An OData query that determines which items to pull from the remote table.

pullOptions: PullOptions

PullOptions that determine how to pull data from the remote table

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{1,255}.

Applies to

PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, CancellationToken)

Pulls all items that match the given query from the associated remote table. Supports incremental sync.

public static System.Threading.Tasks.Task PullAsync (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable table, string queryId, string query, System.Collections.Generic.IDictionary<string,string> parameters, System.Threading.CancellationToken cancellationToken);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable * string * string * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync (table As IMobileServiceSyncTable, queryId As String, query As String, parameters As IDictionary(Of String, String), cancellationToken As CancellationToken) As Task

Parameters

table: IMobileServiceSyncTable

The instance of table to execute pull on.

queryId: String

query: String

An OData query that determines which items to pull from the remote table.

parameters: IDictionary<String,String>

A dictionary of user-defined parameters and values to include in the request URI query string.

cancellationToken: CancellationToken

The CancellationToken token to observe

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{0,24}.

Applies to

PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, Boolean, CancellationToken)

Pulls all items that match the given query from the associated remote table. Supports incremental sync.

public static System.Threading.Tasks.Task PullAsync (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable table, string queryId, string query, System.Collections.Generic.IDictionary<string,string> parameters, bool pushOtherTables, System.Threading.CancellationToken cancellationToken);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable * string * string * System.Collections.Generic.IDictionary<string, string> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync (table As IMobileServiceSyncTable, queryId As String, query As String, parameters As IDictionary(Of String, String), pushOtherTables As Boolean, cancellationToken As CancellationToken) As Task

Parameters

table: IMobileServiceSyncTable

The table to pull from.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 255 characters or less and contain only alphanumeric characters, dash, and underscore

query: String

An OData query that determines which items to pull from the remote table.

parameters: IDictionary<String,String>

A dictionary of user-defined parameters and values to include in the request URI query string.

pushOtherTables: Boolean

Push other tables if this table is dirty.

cancellationToken: CancellationToken

The CancellationToken token to observe

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{1,255}.

Applies to

PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, CancellationToken, PullOptions)

Pulls all items that match the given query from the associated remote table. Supports incremental sync.

public static System.Threading.Tasks.Task PullAsync (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable table, string queryId, string query, System.Collections.Generic.IDictionary<string,string> parameters, System.Threading.CancellationToken cancellationToken, Microsoft.WindowsAzure.MobileServices.Sync.PullOptions pullOptions);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable * string * string * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken * Microsoft.WindowsAzure.MobileServices.Sync.PullOptions -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync (table As IMobileServiceSyncTable, queryId As String, query As String, parameters As IDictionary(Of String, String), cancellationToken As CancellationToken, pullOptions As PullOptions) As Task

Parameters

table: IMobileServiceSyncTable

The instance of table to execute pull on.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 255 characters or less and contain only alphanumeric characters, dash, and underscore.

query: String

An OData query that determines which items to pull from the remote table.

parameters: IDictionary<String,String>

A dictionary of user-defined parameters and values to include in the request URI query string.

cancellationToken: CancellationToken

The CancellationTokentoken to observe

pullOptions: PullOptions

PullOptions that determine how to pull data from the remote table

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{1,255}.

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery)

Pulls all items that match the given query from the associated remote table.

public static System.Threading.Tasks.Task PullAsync<T,U> (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<T> table, string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<'T> * string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync(Of T, U) (table As IMobileServiceSyncTable(Of T), queryId As String, query As IMobileServiceTableQuery(Of U)) As Task

Type Parameters

T

U

Parameters

table: IMobileServiceSyncTable<T>

The instance of table to execute pull on.

queryId: String

query: IMobileServiceTableQuery

An OData query that determines which items to pull from the remote table.

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{0,24}.

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery, PullOptions)

Pulls all items that match the given query from the associated remote table.

public static System.Threading.Tasks.Task PullAsync<T,U> (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<T> table, string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query, Microsoft.WindowsAzure.MobileServices.Sync.PullOptions pullOptions);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<'T> * string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> * Microsoft.WindowsAzure.MobileServices.Sync.PullOptions -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync(Of T, U) (table As IMobileServiceSyncTable(Of T), queryId As String, query As IMobileServiceTableQuery(Of U), pullOptions As PullOptions) As Task

Type Parameters

T

U

Parameters

table: IMobileServiceSyncTable<T>

The instance of table to execute pull on.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 255 characters or less and contain only alphanumeric characters, dash, and underscore

query: IMobileServiceTableQuery

An OData query that determines which items to pull from the remote table.

pullOptions: PullOptions

PullOptions that determine how to pull data from the remote table

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{1,255}.

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery, CancellationToken)

Pulls all items that match the given query from the associated remote table.

public static System.Threading.Tasks.Task PullAsync<T,U> (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<T> table, string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query, System.Threading.CancellationToken cancellationToken);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<'T> * string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync(Of T, U) (table As IMobileServiceSyncTable(Of T), queryId As String, query As IMobileServiceTableQuery(Of U), cancellationToken As CancellationToken) As Task

Type Parameters

T

U

Parameters

table: IMobileServiceSyncTable<T>

The instance of table to execute pull on.

queryId: String

query: IMobileServiceTableQuery

An OData query that determines which items to pull from the remote table.

cancellationToken: CancellationToken

The CancellationToken token to observe

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{0,24}.

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery, Boolean, CancellationToken)

Pulls all items that match the given query from the associated remote table.

public static System.Threading.Tasks.Task PullAsync<T,U> (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<T> table, string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query, bool pushOtherTables, System.Threading.CancellationToken cancellationToken);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<'T> * string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync(Of T, U) (table As IMobileServiceSyncTable(Of T), queryId As String, query As IMobileServiceTableQuery(Of U), pushOtherTables As Boolean, cancellationToken As CancellationToken) As Task

Type Parameters

T

U

Parameters

table: IMobileServiceSyncTable<T>

The table that is being pulled from.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 255 characters or less and contain only alphanumeric characters, dash, and underscore

query: IMobileServiceTableQuery

An OData query that determines which items to pull from the remote table.

pushOtherTables: Boolean

Push other tables if this table is dirty

cancellationToken: CancellationToken

The CancellationToken token to observe

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{1,255}.

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery, CancellationToken, PullOptions)

Pulls all items that match the given query from the associated remote table.

public static System.Threading.Tasks.Task PullAsync<T,U> (this Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<T> table, string queryId, Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<U> query, System.Threading.CancellationToken cancellationToken, Microsoft.WindowsAzure.MobileServices.Sync.PullOptions pullOptions);

static member PullAsync : Microsoft.WindowsAzure.MobileServices.Sync.IMobileServiceSyncTable<'T> * string * Microsoft.WindowsAzure.MobileServices.IMobileServiceTableQuery<'U> * System.Threading.CancellationToken * Microsoft.WindowsAzure.MobileServices.Sync.PullOptions -> System.Threading.Tasks.Task

<Extension()>
Public Function PullAsync(Of T, U) (table As IMobileServiceSyncTable(Of T), queryId As String, query As IMobileServiceTableQuery(Of U), cancellationToken As CancellationToken, pullOptions As PullOptions) As Task

Type Parameters

T

U

Parameters

table: IMobileServiceSyncTable<T>

The instance of table to execute pull on.

queryId: String

A string that uniquely identifies this query and is used to keep track of its sync state. Supplying this parameter enables incremental sync whenever the same key is used again. Must be 255 characters or less and contain only alphanumeric characters, dash, and underscore

query: IMobileServiceTableQuery

An OData query that determines which items to pull from the remote table.

cancellationToken: CancellationToken

The CancellationToken token to observe

pullOptions: PullOptions

PullOptions that determine how to pull data from the remote table

Returns

Task

A task that completes when pull operation has finished.

Exceptions

ArgumentException

Thrown when queryId does not match the regular expression [a-zA-Z][a-zA-Z0-9_-]{1,255}.

Applies to

Udostępnij za pośrednictwem

MobileServiceSyncTableExtensions.PullAsync Method

Definition

Overloads

PullAsync(IMobileServiceSyncTable, String, String)

Parameters

Returns

Exceptions

Applies to

PullAsync(IMobileServiceSyncTable, String, String, PullOptions)

Parameters

Returns

Exceptions

Applies to

PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, CancellationToken)

Parameters

Returns

Exceptions

Applies to

PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, Boolean, CancellationToken)

Parameters

Returns

Exceptions

Applies to

PullAsync(IMobileServiceSyncTable, String, String, IDictionary<String,String>, CancellationToken, PullOptions)

Parameters

Returns

Exceptions

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>)

Type Parameters

Parameters

Returns

Exceptions

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, PullOptions)

Type Parameters

Parameters

Returns

Exceptions

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, CancellationToken)

Type Parameters

Parameters

Returns

Exceptions

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, Boolean, CancellationToken)

Type Parameters

Parameters

Returns

Exceptions

Applies to

PullAsync<T,U>(IMobileServiceSyncTable<T>, String, IMobileServiceTableQuery<U>, CancellationToken, PullOptions)

Type Parameters

Parameters

Returns

Exceptions

Applies to

Dodatkowe zasoby