/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents/JsonSerializable.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
288 lines (288 sloc) 15.1 KB
<Type Name="JsonSerializable" FullName="Microsoft.Azure.Documents.JsonSerializable">
<TypeSignature Language="C#" Value="public abstract class JsonSerializable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit JsonSerializable extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.JsonSerializable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the base class for Azure DocumentDB database objects and provides methods for serializing and deserializing from JSON.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="LoadFrom">
<MemberSignature Language="C#" Value="public virtual void LoadFrom (Newtonsoft.Json.JsonReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LoadFrom(class Newtonsoft.Json.JsonReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.LoadFrom(Newtonsoft.Json.JsonReader)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="Newtonsoft.Json.JsonReader" />
</Parameters>
<Docs>
<param name="reader">Loads the object from this JSON reader.</param>
<summary>
Loads the object from the specified JSON reader in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadFrom">
<MemberSignature Language="C#" Value="public virtual void LoadFrom (Newtonsoft.Json.JsonReader reader, Newtonsoft.Json.JsonSerializerSettings serializerSettings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LoadFrom(class Newtonsoft.Json.JsonReader reader, class Newtonsoft.Json.JsonSerializerSettings serializerSettings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.LoadFrom(Newtonsoft.Json.JsonReader,Newtonsoft.Json.JsonSerializerSettings)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="Newtonsoft.Json.JsonReader" />
<Parameter Name="serializerSettings" Type="Newtonsoft.Json.JsonSerializerSettings" />
</Parameters>
<Docs>
<param name="reader">Loads the object from this JSON reader.</param>
<param name="serializerSettings">The JsonSerializerSettings to be used.</param>
<summary>
Loads the object from the specified JSON reader in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadFrom&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T LoadFrom&lt;T&gt; (System.IO.Stream stream) where T : Microsoft.Azure.Documents.JsonSerializablenew();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T LoadFrom&lt;.ctor (class Microsoft.Azure.Documents.JsonSerializable) T&gt;(class System.IO.Stream stream) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.LoadFrom``1(System.IO.Stream)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<BaseTypeName>Microsoft.Azure.Documents.JsonSerializable</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<typeparam name="T">The type of the returning object.</typeparam>
<param name="stream">The stream to load from.</param>
<summary>
Loads the object from the specified stream in the Azure DocumentDB database service.
</summary>
<returns>The object loaded from the specified stream.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadFromWithConstructor&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T LoadFromWithConstructor&lt;T&gt; (System.IO.Stream stream, Func&lt;T&gt; constructorFunction);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T LoadFromWithConstructor&lt;T&gt;(class System.IO.Stream stream, class System.Func`1&lt;!!T&gt; constructorFunction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.LoadFromWithConstructor``1(System.IO.Stream,System.Func{``0})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="constructorFunction" Type="System.Func&lt;T&gt;" />
</Parameters>
<Docs>
<typeparam name="T">The type of the object.</typeparam>
<param name="stream">The stream to load from.</param>
<param name="constructorFunction">The constructor used for the returning object.</param>
<summary>
Deserializes the specified stream using the given constructor in the Azure DocumentDB database service.
</summary>
<returns>The object loaded from the specified stream.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadFromWithConstructor&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T LoadFromWithConstructor&lt;T&gt; (System.IO.Stream stream, Func&lt;T&gt; constructorFunction, Newtonsoft.Json.JsonSerializerSettings settings);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T LoadFromWithConstructor&lt;T&gt;(class System.IO.Stream stream, class System.Func`1&lt;!!T&gt; constructorFunction, class Newtonsoft.Json.JsonSerializerSettings settings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.LoadFromWithConstructor``1(System.IO.Stream,System.Func{``0},Newtonsoft.Json.JsonSerializerSettings)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="constructorFunction" Type="System.Func&lt;T&gt;" />
<Parameter Name="settings" Type="Newtonsoft.Json.JsonSerializerSettings" />
</Parameters>
<Docs>
<typeparam name="T">The type of the object.</typeparam>
<param name="stream">The stream to load from.</param>
<param name="constructorFunction">The constructor used for the returning object.</param>
<param name="settings">The JsonSerializerSettings to be used.</param>
<summary>
Deserializes the specified stream using the given constructor in the Azure DocumentDB database service.
</summary>
<returns>The object loaded from the specified stream.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SaveTo">
<MemberSignature Language="C#" Value="public void SaveTo (System.IO.Stream stream, Microsoft.Azure.Documents.SerializationFormattingPolicy formattingPolicy = Microsoft.Azure.Documents.SerializationFormattingPolicy.None);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SaveTo(class System.IO.Stream stream, valuetype Microsoft.Azure.Documents.SerializationFormattingPolicy formattingPolicy) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.SaveTo(System.IO.Stream,Microsoft.Azure.Documents.SerializationFormattingPolicy)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="formattingPolicy" Type="Microsoft.Azure.Documents.SerializationFormattingPolicy" />
</Parameters>
<Docs>
<param name="stream">Saves the object to this output stream.</param>
<param name="formattingPolicy">Uses an optional serialization formatting policy when saving the object. The default policy is set to None.</param>
<summary>
Saves the object to the specified stream in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SaveTo">
<MemberSignature Language="C#" Value="public void SaveTo (System.IO.Stream stream, Microsoft.Azure.Documents.SerializationFormattingPolicy formattingPolicy, Newtonsoft.Json.JsonSerializerSettings settings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SaveTo(class System.IO.Stream stream, valuetype Microsoft.Azure.Documents.SerializationFormattingPolicy formattingPolicy, class Newtonsoft.Json.JsonSerializerSettings settings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.SaveTo(System.IO.Stream,Microsoft.Azure.Documents.SerializationFormattingPolicy,Newtonsoft.Json.JsonSerializerSettings)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="formattingPolicy" Type="Microsoft.Azure.Documents.SerializationFormattingPolicy" />
<Parameter Name="settings" Type="Newtonsoft.Json.JsonSerializerSettings" />
</Parameters>
<Docs>
<param name="stream">Saves the object to this output stream.</param>
<param name="formattingPolicy">Uses a custom serialization formatting policy when saving the object.</param>
<param name="settings">The serializer settings to use.</param>
<summary>
Saves the object to the specified stream in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.JsonSerializable.ToString" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the string representation of the object in the Azure DocumentDB database service.
</summary>
<returns>The string representation of the object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>