Permalink
Fetching contributors…
Cannot retrieve contributors at this time
421 lines (421 sloc) 22.8 KB
<Type Name="IMobileServiceTable" FullName="Microsoft.WindowsAzure.MobileServices.IMobileServiceTable">
<TypeSignature Language="C#" Value="public interface IMobileServiceTable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IMobileServiceTable" />
<TypeSignature Language="DocId" Value="T:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Provides operations on a table for a Microsoft Azure Mobile Service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="DeleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; DeleteAsync (Newtonsoft.Json.Linq.JObject instance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; DeleteAsync(class Newtonsoft.Json.Linq.JObject instance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.DeleteAsync(Newtonsoft.Json.Linq.JObject)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
</Parameters>
<Docs>
<param name="instance">
The instance to delete from the table.
</param>
<summary>
Deletes an <paramref name="instance" /> from the table.
</summary>
<returns>
A task that will complete when the delete finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; DeleteAsync (Newtonsoft.Json.Linq.JObject instance, System.Collections.Generic.IDictionary&lt;string,string&gt; parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; DeleteAsync(class Newtonsoft.Json.Linq.JObject instance, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.DeleteAsync(Newtonsoft.Json.Linq.JObject,System.Collections.Generic.IDictionary{System.String,System.String})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
<Parameter Name="parameters" Type="System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;" />
</Parameters>
<Docs>
<param name="instance">
The instance to delete from the table.
</param>
<param name="parameters">
A dictionary of user-defined parameters and values to include in
the request URI query string.
</param>
<summary>
Deletes an <paramref name="instance" /> from the table.
</summary>
<returns>
A task that will complete when the delete finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InsertAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; InsertAsync (Newtonsoft.Json.Linq.JObject instance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; InsertAsync(class Newtonsoft.Json.Linq.JObject instance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.InsertAsync(Newtonsoft.Json.Linq.JObject)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
</Parameters>
<Docs>
<param name="instance">
The instance to insert into the table.
</param>
<summary>
Inserts an <paramref name="instance" /> into the table.
</summary>
<returns>
A task that will complete when the insert finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InsertAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; InsertAsync (Newtonsoft.Json.Linq.JObject instance, System.Collections.Generic.IDictionary&lt;string,string&gt; parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; InsertAsync(class Newtonsoft.Json.Linq.JObject instance, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.InsertAsync(Newtonsoft.Json.Linq.JObject,System.Collections.Generic.IDictionary{System.String,System.String})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
<Parameter Name="parameters" Type="System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;" />
</Parameters>
<Docs>
<param name="instance">
The instance to insert into the table.
</param>
<param name="parameters">
A dictionary of user-defined parameters and values to include in
the request URI query string.
</param>
<summary>
Inserts an <paramref name="instance" /> into the table.
</summary>
<returns>
A task that will complete when the insert finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LookupAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; LookupAsync (object id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; LookupAsync(object id) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.LookupAsync(System.Object)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Object" />
</Parameters>
<Docs>
<param name="id">
The id of the instance to lookup.
</param>
<summary>
Executes a lookup against a table.
</summary>
<returns>
A task that will return with a result when the lookup finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LookupAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; LookupAsync (object id, System.Collections.Generic.IDictionary&lt;string,string&gt; parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; LookupAsync(object id, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.LookupAsync(System.Object,System.Collections.Generic.IDictionary{System.String,System.String})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Object" />
<Parameter Name="parameters" Type="System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;" />
</Parameters>
<Docs>
<param name="id">
The id of the instance to lookup.
</param>
<param name="parameters">
A dictionary of user-defined parameters and values to include in
the request URI query string.
</param>
<summary>
Executes a lookup against a table.
</summary>
<returns>
A task that will return with a result when the lookup finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MobileServiceClient">
<MemberSignature Language="C#" Value="public Microsoft.WindowsAzure.MobileServices.MobileServiceClient MobileServiceClient { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.WindowsAzure.MobileServices.MobileServiceClient MobileServiceClient" />
<MemberSignature Language="DocId" Value="P:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.MobileServiceClient" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.WindowsAzure.MobileServices.MobileServiceClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a reference to the <see cref="P:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.MobileServiceClient" /> associated
with this table.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; ReadAsync (string query);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; ReadAsync(string query) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.ReadAsync(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="System.String" />
</Parameters>
<Docs>
<param name="query">
A query to execute.
</param>
<summary>
Executes a query against the table.
</summary>
<returns>
A task that will return with results when the query finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; ReadAsync (string query, System.Collections.Generic.IDictionary&lt;string,string&gt; parameters, bool wrapResult);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; ReadAsync(string query, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; parameters, bool wrapResult) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.ReadAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="System.String" />
<Parameter Name="parameters" Type="System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;" />
<Parameter Name="wrapResult" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="query">
A query to execute.
</param>
<param name="parameters">
A dictionary of user-defined parameters and values to include in
the request URI query string.
</param>
<param name="wrapResult">
Specifies whether response should be formatted as JObject including extra response details e.g. link header
</param>
<summary>
Executes a query against the table.
</summary>
<returns>
A task that will return with results when the query finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TableName">
<MemberSignature Language="C#" Value="public string TableName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TableName" />
<MemberSignature Language="DocId" Value="P:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.TableName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the table.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UndeleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; UndeleteAsync (Newtonsoft.Json.Linq.JObject instance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; UndeleteAsync(class Newtonsoft.Json.Linq.JObject instance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.UndeleteAsync(Newtonsoft.Json.Linq.JObject)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
</Parameters>
<Docs>
<param name="instance">The instance to undelete from the table.</param>
<summary>
Undeletes an <paramref name="instance" /> from the table. This requires the soft delete feature to be enabled on the Mobile Service. Visit <see href="http://go.microsoft.com/fwlink/?LinkId=507647">the link</see> for details.
</summary>
<returns>A task that will complete when the undelete finishes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UndeleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; UndeleteAsync (Newtonsoft.Json.Linq.JObject instance, System.Collections.Generic.IDictionary&lt;string,string&gt; parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; UndeleteAsync(class Newtonsoft.Json.Linq.JObject instance, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.UndeleteAsync(Newtonsoft.Json.Linq.JObject,System.Collections.Generic.IDictionary{System.String,System.String})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
<Parameter Name="parameters" Type="System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;" />
</Parameters>
<Docs>
<param name="instance">The instance to undelete from the table.</param>
<param name="parameters">
A dictionary of user-defined parameters and values to include in
the request URI query string.
</param>
<summary>
Undeletes an <paramref name="instance" /> from the table. This requires the soft delete feature to be enabled on the Mobile Service. Visit <see href="http://go.microsoft.com/fwlink/?LinkId=507647">the link</see> for details.
</summary>
<returns>A task that will complete when the undelete finishes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; UpdateAsync (Newtonsoft.Json.Linq.JObject instance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; UpdateAsync(class Newtonsoft.Json.Linq.JObject instance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.UpdateAsync(Newtonsoft.Json.Linq.JObject)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
</Parameters>
<Docs>
<param name="instance">
The instance to update in the table.
</param>
<summary>
Updates an <paramref name="instance" /> in the table.
</summary>
<returns>
A task that will complete when the update finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt; UpdateAsync (Newtonsoft.Json.Linq.JObject instance, System.Collections.Generic.IDictionary&lt;string,string&gt; parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Newtonsoft.Json.Linq.JToken&gt; UpdateAsync(class Newtonsoft.Json.Linq.JObject instance, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.MobileServices.IMobileServiceTable.UpdateAsync(Newtonsoft.Json.Linq.JObject,System.Collections.Generic.IDictionary{System.String,System.String})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.Azure.Mobile.Client</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Newtonsoft.Json.Linq.JToken&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="instance" Type="Newtonsoft.Json.Linq.JObject" />
<Parameter Name="parameters" Type="System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;" />
</Parameters>
<Docs>
<param name="instance">
The instance to update in the table.
</param>
<param name="parameters">
A dictionary of user-defined parameters and values to include in
the request URI query string.
</param>
<summary>
Updates an <paramref name="instance" /> in the table.
</summary>
<returns>
A task that will complete when the update finishes.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>