xml/Microsoft.Azure.Documents.SystemFunctions/TypeCheckFunctionsExtensions.xml (325 lines of code) (raw):
<Type Name="TypeCheckFunctionsExtensions" FullName="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions">
<TypeSignature Language="C#" Value="public static class TypeCheckFunctionsExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit TypeCheckFunctionsExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module TypeCheckFunctionsExtensions" />
<TypeSignature Language="F#" Value="type TypeCheckFunctionsExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provide methods for type checking.
These methods are to be used in LINQ expressions only and will be evaluated on server.
There's no implementation provided in the client library.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="IsArray">
<MemberSignature Language="C#" Value="public static bool IsArray (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsArray(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsArray(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsArray (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsArray : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsArray obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is of array JSON type.
</summary>
<returns>Returns true if this property is an array otherwise returns false.</returns>
<remarks>To be added.</remarks>
<example>
<code><![CDATA[
var isArrayQuery = documents.Where(document => document.Names.IsArray());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsBool">
<MemberSignature Language="C#" Value="public static bool IsBool (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsBool(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsBool(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsBool (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsBool : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsBool obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is of boolean JSON type.
</summary>
<returns>Returns true if this property is a boolean otherwise returns false.</returns>
<remarks>To be added.</remarks>
<example>
<code><![CDATA[
var isBoolQuery = documents.Where(document => document.Name.IsBool());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsDefined">
<MemberSignature Language="C#" Value="public static bool IsDefined (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsDefined(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsDefined(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsDefined (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsDefined : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsDefined obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is defined or not.
</summary>
<returns>Returns true if this property is defined otherwise returns false.</returns>
<remarks />
<example>
<code><![CDATA[
var isDefinedQuery = documents.Where(document => document.Name.IsDefined());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsNull">
<MemberSignature Language="C#" Value="public static bool IsNull (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsNull(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsNull(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsNull (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsNull : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsNull obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is null or not.
</summary>
<returns>Returns true if this property is null otherwise returns false.</returns>
<remarks />
<example>
<code><![CDATA[
var isNullQuery = documents.Where(document => document.Name.IsNull());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsNumber">
<MemberSignature Language="C#" Value="public static bool IsNumber (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsNumber(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsNumber(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsNumber (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsNumber : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsNumber obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is of number JSON type.
</summary>
<returns>Returns true if this property is a number otherwise returns false.</returns>
<remarks>To be added.</remarks>
<example>
<code><![CDATA[
var isNumberQuery = documents.Where(document => document.Amount.IsNumber());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsObject">
<MemberSignature Language="C#" Value="public static bool IsObject (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsObject(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsObject(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsObject (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsObject : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsObject obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is of object JSON type.
</summary>
<returns>Returns true if this property is an object otherwise returns false.</returns>
<remarks>To be added.</remarks>
<example>
<code><![CDATA[
var isObjectQuery = documents.Where(document => document.Person.IsObject());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsPrimitive">
<MemberSignature Language="C#" Value="public static bool IsPrimitive (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsPrimitive(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsPrimitive(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsPrimitive (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsPrimitive : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsPrimitive obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is of premitive JSON type.
</summary>
<returns>Returns true if this property is null otherwise returns false.</returns>
<remarks>
Premitive JSON types (Double, String, Boolean and Null)
</remarks>
<example>
<code><![CDATA[
var isPrimitiveQuery = documents.Where(document => document.Name.IsPrimitive());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="IsString">
<MemberSignature Language="C#" Value="public static bool IsString (this object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsString(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsString(System.Object)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsString (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="static member IsString : obj -> bool" Usage="Microsoft.Azure.Documents.SystemFunctions.TypeCheckFunctionsExtensions.IsString obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" RefType="this" />
</Parameters>
<Docs>
<param name="obj" />
<summary>
Determines if a certain property is of string JSON type.
</summary>
<returns>Returns true if this property is a string otherwise returns false.</returns>
<remarks>To be added.</remarks>
<example>
<code><![CDATA[
var isStringQuery = documents.Where(document => document.Name.IsString());
]]></code>
</example>
</Docs>
</Member>
</Members>
</Type>