FormRecognizerAudience.xml

<Type Name="FormRecognizerAudience" FullName="Azure.AI.FormRecognizer.FormRecognizerAudience">
  <TypeSignature Language="C#" Value="public readonly struct FormRecognizerAudience : IEquatable&lt;Azure.AI.FormRecognizer.FormRecognizerAudience&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit FormRecognizerAudience extends System.ValueType implements class System.IEquatable`1&lt;valuetype Azure.AI.FormRecognizer.FormRecognizerAudience&gt;" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.FormRecognizerAudience" />
  <TypeSignature Language="VB.NET" Value="Public Structure FormRecognizerAudience&#xA;Implements IEquatable(Of FormRecognizerAudience)" />
  <TypeSignature Language="F#" Value="type FormRecognizerAudience = struct" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IEquatable&lt;Azure.AI.FormRecognizer.FormRecognizerAudience&gt;</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary> Cloud audiences available for FormRecognizer. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FormRecognizerAudience (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (value As String)" />
      <MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.FormRecognizerAudience : string -&gt; Azure.AI.FormRecognizer.FormRecognizerAudience" Usage="new Azure.AI.FormRecognizer.FormRecognizerAudience value" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">The Azure Active Directory audience to use when forming authorization scopes. For FormRecognizer, this value corresponds to a URL that identifies the Azure cloud where the resource is located. For more information: <see href="https://docs.microsoft.com/azure/azure-government/documentation-government-cognitiveservices" />.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.FormRecognizerAudience" /> object.
            </summary>
        <remarks>Please use one of the constant members over creating a custom value unless you have special needs for doing so.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="value" /> is null. </exception>
        <exception cref="T:System.ArgumentException">
          <paramref name="value" /> is empty. </exception>
      </Docs>
    </Member>
    <Member MemberName="AzureChina">
      <MemberSignature Language="C#" Value="public static Azure.AI.FormRecognizer.FormRecognizerAudience AzureChina { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.AI.FormRecognizer.FormRecognizerAudience AzureChina" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.FormRecognizerAudience.AzureChina" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property AzureChina As FormRecognizerAudience" />
      <MemberSignature Language="F#" Value="static member AzureChina : Azure.AI.FormRecognizer.FormRecognizerAudience" Usage="Azure.AI.FormRecognizer.FormRecognizerAudience.AzureChina" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.FormRecognizer.FormRecognizerAudience</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Azure China. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AzureGovernment">
      <MemberSignature Language="C#" Value="public static Azure.AI.FormRecognizer.FormRecognizerAudience AzureGovernment { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.AI.FormRecognizer.FormRecognizerAudience AzureGovernment" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.FormRecognizerAudience.AzureGovernment" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property AzureGovernment As FormRecognizerAudience" />
      <MemberSignature Language="F#" Value="static member AzureGovernment : Azure.AI.FormRecognizer.FormRecognizerAudience" Usage="Azure.AI.FormRecognizer.FormRecognizerAudience.AzureGovernment" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.FormRecognizer.FormRecognizerAudience</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Azure Government. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AzurePublicCloud">
      <MemberSignature Language="C#" Value="public static Azure.AI.FormRecognizer.FormRecognizerAudience AzurePublicCloud { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.AI.FormRecognizer.FormRecognizerAudience AzurePublicCloud" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.FormRecognizerAudience.AzurePublicCloud" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property AzurePublicCloud As FormRecognizerAudience" />
      <MemberSignature Language="F#" Value="static member AzurePublicCloud : Azure.AI.FormRecognizer.FormRecognizerAudience" Usage="Azure.AI.FormRecognizer.FormRecognizerAudience.AzurePublicCloud" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.FormRecognizer.FormRecognizerAudience</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Azure Public Cloud. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public bool Equals (Azure.AI.FormRecognizer.FormRecognizerAudience other);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Azure.AI.FormRecognizer.FormRecognizerAudience other) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.Equals(Azure.AI.FormRecognizer.FormRecognizerAudience)" />
      <MemberSignature Language="VB.NET" Value="Public Function Equals (other As FormRecognizerAudience) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : Azure.AI.FormRecognizer.FormRecognizerAudience -&gt; bool" Usage="formRecognizerAudience.Equals other" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="Azure.AI.FormRecognizer.FormRecognizerAudience" />
      </Parameters>
      <Docs>
        <param name="other">An object to compare with this object.</param>
        <summary>Indicates whether the current object is equal to another object of the same type.</summary>
        <returns>
          <see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="formRecognizerAudience.Equals obj" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The object to compare with the current instance.</param>
        <summary>Indicates whether this instance and a specified object are equal.</summary>
        <returns>
          <see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="formRecognizerAudience.GetHashCode " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the hash code for this instance.</summary>
        <returns>A 32-bit signed integer that is the hash code for this instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool operator == (Azure.AI.FormRecognizer.FormRecognizerAudience left, Azure.AI.FormRecognizer.FormRecognizerAudience right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Azure.AI.FormRecognizer.FormRecognizerAudience left, valuetype Azure.AI.FormRecognizer.FormRecognizerAudience right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.op_Equality(Azure.AI.FormRecognizer.FormRecognizerAudience,Azure.AI.FormRecognizer.FormRecognizerAudience)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator == (left As FormRecognizerAudience, right As FormRecognizerAudience) As Boolean" />
      <MemberSignature Language="F#" Value="static member ( = ) : Azure.AI.FormRecognizer.FormRecognizerAudience * Azure.AI.FormRecognizer.FormRecognizerAudience -&gt; bool" Usage="left = right" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.AI.FormRecognizer.FormRecognizerAudience" />
        <Parameter Name="right" Type="Azure.AI.FormRecognizer.FormRecognizerAudience" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.AI.FormRecognizer.FormRecognizerAudience" /> values are the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static implicit operator Azure.AI.FormRecognizer.FormRecognizerAudience (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype Azure.AI.FormRecognizer.FormRecognizerAudience op_Implicit(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.op_Implicit(System.String)~Azure.AI.FormRecognizer.FormRecognizerAudience" />
      <MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (value As String) As FormRecognizerAudience" />
      <MemberSignature Language="F#" Value="static member op_Implicit : string -&gt; Azure.AI.FormRecognizer.FormRecognizerAudience" Usage="Azure.AI.FormRecognizer.FormRecognizerAudience.op_Implicit value" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.FormRecognizer.FormRecognizerAudience</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Converts a string to a <see cref="T:Azure.AI.FormRecognizer.FormRecognizerAudience" />. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool operator != (Azure.AI.FormRecognizer.FormRecognizerAudience left, Azure.AI.FormRecognizer.FormRecognizerAudience right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Azure.AI.FormRecognizer.FormRecognizerAudience left, valuetype Azure.AI.FormRecognizer.FormRecognizerAudience right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerAudience.op_Inequality(Azure.AI.FormRecognizer.FormRecognizerAudience,Azure.AI.FormRecognizer.FormRecognizerAudience)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator != (left As FormRecognizerAudience, right As FormRecognizerAudience) As Boolean" />
      <MemberSignature Language="F#" Value="static member op_Inequality : Azure.AI.FormRecognizer.FormRecognizerAudience * Azure.AI.FormRecognizer.FormRecognizerAudience -&gt; bool" Usage="Azure.AI.FormRecognizer.FormRecognizerAudience.op_Inequality (left, right)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.AI.FormRecognizer.FormRecognizerAudience" />
        <Parameter Name="right" Type="Azure.AI.FormRecognizer.FormRecognizerAudience" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.AI.FormRecognizer.FormRecognizerAudience" /> values are not the same. </summary>
        <returns>To be added.</returns>
        <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:Azure.AI.FormRecognizer.FormRecognizerAudience.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="formRecognizerAudience.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the fully qualified type name of this instance.</summary>
        <returns>The fully qualified type name.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>