DocumentAnalysisClientBuilderExtensions.xml

<Type Name="DocumentAnalysisClientBuilderExtensions" FullName="Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions">
  <TypeSignature Language="C#" Value="public static class DocumentAnalysisClientBuilderExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DocumentAnalysisClientBuilderExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module DocumentAnalysisClientBuilderExtensions" />
  <TypeSignature Language="F#" Value="type DocumentAnalysisClientBuilderExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Extension methods to add the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> to clients builder.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="AddDocumentAnalysisClient&lt;TBuilder&gt;">
      <MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; AddDocumentAnalysisClient&lt;TBuilder&gt; (this TBuilder builder, Uri endpoint) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential;" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2&lt;class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient, class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; AddDocumentAnalysisClient&lt;(class Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential) TBuilder&gt;(!!TBuilder builder, class System.Uri endpoint) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions.AddDocumentAnalysisClient``1(``0,System.Uri)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function AddDocumentAnalysisClient(Of TBuilder As IAzureClientFactoryBuilderWithCredential) (builder As TBuilder, endpoint As Uri) As IAzureClientBuilder(Of DocumentAnalysisClient, DocumentAnalysisClientOptions)" />
      <MemberSignature Language="F#" Value="static member AddDocumentAnalysisClient : 'Builder * Uri -&gt; Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; (requires 'Builder :&gt; Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential)" Usage="Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions.AddDocumentAnalysisClient (builder, endpoint)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="TBuilder">
          <Constraints>
            <InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential</InterfaceName>
          </Constraints>
        </TypeParameter>
      </TypeParameters>
      <Parameters>
        <Parameter Name="builder" Type="TBuilder" RefType="this" />
        <Parameter Name="endpoint" Type="System.Uri" />
      </Parameters>
      <Docs>
        <typeparam name="TBuilder">To be added.</typeparam>
        <param name="builder">To be added.</param>
        <param name="endpoint">To be added.</param>
        <summary>
            Registers a <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> instance with the provided <paramref name="endpoint" />.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddDocumentAnalysisClient&lt;TBuilder&gt;">
      <MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; AddDocumentAnalysisClient&lt;TBuilder&gt; (this TBuilder builder, Uri endpoint, Azure.AzureKeyCredential credential) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilder;" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2&lt;class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient, class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; AddDocumentAnalysisClient&lt;(class Azure.Core.Extensions.IAzureClientFactoryBuilder) TBuilder&gt;(!!TBuilder builder, class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions.AddDocumentAnalysisClient``1(``0,System.Uri,Azure.AzureKeyCredential)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function AddDocumentAnalysisClient(Of TBuilder As IAzureClientFactoryBuilder) (builder As TBuilder, endpoint As Uri, credential As AzureKeyCredential) As IAzureClientBuilder(Of DocumentAnalysisClient, DocumentAnalysisClientOptions)" />
      <MemberSignature Language="F#" Value="static member AddDocumentAnalysisClient : 'Builder * Uri * Azure.AzureKeyCredential -&gt; Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; (requires 'Builder :&gt; Azure.Core.Extensions.IAzureClientFactoryBuilder)" Usage="Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions.AddDocumentAnalysisClient (builder, endpoint, credential)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="TBuilder">
          <Constraints>
            <InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilder</InterfaceName>
          </Constraints>
        </TypeParameter>
      </TypeParameters>
      <Parameters>
        <Parameter Name="builder" Type="TBuilder" RefType="this" />
        <Parameter Name="endpoint" Type="System.Uri" />
        <Parameter Name="credential" Type="Azure.AzureKeyCredential" />
      </Parameters>
      <Docs>
        <typeparam name="TBuilder">To be added.</typeparam>
        <param name="builder">To be added.</param>
        <param name="endpoint">To be added.</param>
        <param name="credential">To be added.</param>
        <summary>
            Registers a <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> instance with the provided <paramref name="endpoint" /> and <paramref name="credential" />.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddDocumentAnalysisClient&lt;TBuilder,TConfiguration&gt;">
      <MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; AddDocumentAnalysisClient&lt;TBuilder,TConfiguration&gt; (this TBuilder builder, TConfiguration configuration) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration&lt;TConfiguration&gt;;" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2&lt;class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient, class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; AddDocumentAnalysisClient&lt;(class Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration`1&lt;!!TConfiguration&gt;) TBuilder, TConfiguration&gt;(!!TBuilder builder, !!TConfiguration configuration) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions.AddDocumentAnalysisClient``2(``0,``1)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function AddDocumentAnalysisClient(Of TBuilder As IAzureClientFactoryBuilderWithConfiguration(Of TConfiguration), TConfiguration As IAzureClientFactoryBuilderWithConfiguration(Of TConfiguration)) (builder As TBuilder, configuration As TConfiguration) As IAzureClientBuilder(Of DocumentAnalysisClient, DocumentAnalysisClientOptions)" />
      <MemberSignature Language="F#" Value="static member AddDocumentAnalysisClient : 'Builder * 'Configuration -&gt; Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt; (requires 'Builder :&gt; Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration&lt;'Configuration&gt;)" Usage="Microsoft.Extensions.Azure.DocumentAnalysisClientBuilderExtensions.AddDocumentAnalysisClient (builder, configuration)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
        <AssemblyVersion>4.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Core.Extensions.IAzureClientBuilder&lt;Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="TBuilder">
          <Constraints>
            <InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration&lt;TConfiguration&gt;</InterfaceName>
          </Constraints>
        </TypeParameter>
        <TypeParameter Name="TConfiguration" />
      </TypeParameters>
      <Parameters>
        <Parameter Name="builder" Type="TBuilder" RefType="this" />
        <Parameter Name="configuration" Type="TConfiguration" />
      </Parameters>
      <Docs>
        <typeparam name="TBuilder">To be added.</typeparam>
        <typeparam name="TConfiguration">To be added.</typeparam>
        <param name="builder">To be added.</param>
        <param name="configuration">To be added.</param>
        <summary>
            Registers a <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> instance with connection options loaded from the provided <paramref name="configuration" /> instance.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>