FormRecognizerClientOptions.xml

<Type Name="FormRecognizerClientOptions" FullName="Azure.AI.FormRecognizer.FormRecognizerClientOptions">
  <TypeSignature Language="C#" Value="public class FormRecognizerClientOptions : Azure.Core.ClientOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FormRecognizerClientOptions extends Azure.Core.ClientOptions" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.FormRecognizerClientOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class FormRecognizerClientOptions&#xA;Inherits ClientOptions" />
  <TypeSignature Language="F#" Value="type FormRecognizerClientOptions = class&#xA;    inherit ClientOptions" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
    <AssemblyVersion>3.0.1.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.1.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.Core.ClientOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            The set of options that can be specified when creating a <see cref="T:Azure.AI.FormRecognizer.FormRecognizerClient" />
            or a <see cref="T:Azure.AI.FormRecognizer.Training.FormTrainingClient" /> to configure its behavior.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FormRecognizerClientOptions (Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion version = Azure.AI.FormRecognizer.FormRecognizerClientOptions+ServiceVersion.V2_1);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Azure.AI.FormRecognizer.FormRecognizerClientOptions/ServiceVersion version) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClientOptions.#ctor(Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional version As FormRecognizerClientOptions.ServiceVersion = Azure.AI.FormRecognizer.FormRecognizerClientOptions+ServiceVersion.V2_1)" />
      <MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.FormRecognizerClientOptions : Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion -&gt; Azure.AI.FormRecognizer.FormRecognizerClientOptions" Usage="new Azure.AI.FormRecognizer.FormRecognizerClientOptions version" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="version" Type="Azure.AI.FormRecognizer.FormRecognizerClientOptions+ServiceVersion" />
      </Parameters>
      <Docs>
        <param name="version">The version of the service to send requests to.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.FormRecognizerClientOptions" /> class which allows
            to configure the behavior of the <see cref="T:Azure.AI.FormRecognizer.FormRecognizerClient" /> or <see cref="T:Azure.AI.FormRecognizer.Training.FormTrainingClient" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Audience">
      <MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.FormRecognizerAudience? Audience { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Azure.AI.FormRecognizer.FormRecognizerAudience&gt; Audience" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.FormRecognizerClientOptions.Audience" />
      <MemberSignature Language="VB.NET" Value="Public Property Audience As Nullable(Of FormRecognizerAudience)" />
      <MemberSignature Language="F#" Value="member this.Audience : Nullable&lt;Azure.AI.FormRecognizer.FormRecognizerAudience&gt; with get, set" Usage="Azure.AI.FormRecognizer.FormRecognizerClientOptions.Audience" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Azure.AI.FormRecognizer.FormRecognizerAudience&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
            </summary>
        <value>If <c>null</c>, <see cref="P:Azure.AI.FormRecognizer.FormRecognizerAudience.AzurePublicCloud" /> will be assumed.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Version">
      <MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion Version { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.FormRecognizer.FormRecognizerClientOptions/ServiceVersion Version" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.FormRecognizerClientOptions.Version" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As FormRecognizerClientOptions.ServiceVersion" />
      <MemberSignature Language="F#" Value="member this.Version : Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion" Usage="Azure.AI.FormRecognizer.FormRecognizerClientOptions.Version" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.FormRecognizer.FormRecognizerClientOptions+ServiceVersion</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The service version.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>