TextAnalyticsActionResult.xml

<Type Name="TextAnalyticsActionResult" FullName="Azure.AI.TextAnalytics.TextAnalyticsActionResult">
  <TypeSignature Language="C#" Value="public class TextAnalyticsActionResult" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TextAnalyticsActionResult extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.TextAnalyticsActionResult" />
  <TypeSignature Language="VB.NET" Value="Public Class TextAnalyticsActionResult" />
  <TypeSignature Language="F#" Value="type TextAnalyticsActionResult = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
    <AssemblyVersion>5.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.1.1.0</AssemblyVersion>
    <AssemblyVersion>5.2.0.0</AssemblyVersion>
    <AssemblyVersion>5.3.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Base type for results of Text Analytics Actions executed in a set of documents.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="ActionName">
      <MemberSignature Language="C#" Value="public string ActionName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ActionName" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsActionResult.ActionName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ActionName As String" />
      <MemberSignature Language="F#" Value="member this.ActionName : string" Usage="Azure.AI.TextAnalytics.TextAnalyticsActionResult.ActionName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the name for this action.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CompletedOn">
      <MemberSignature Language="C#" Value="public DateTimeOffset CompletedOn { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset CompletedOn" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsActionResult.CompletedOn" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property CompletedOn As DateTimeOffset" />
      <MemberSignature Language="F#" Value="member this.CompletedOn : DateTimeOffset" Usage="Azure.AI.TextAnalytics.TextAnalyticsActionResult.CompletedOn" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTimeOffset</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Indicates the time at which the action was last updated on.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Error">
      <MemberSignature Language="C#" Value="public Azure.AI.TextAnalytics.TextAnalyticsError Error { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.TextAnalytics.TextAnalyticsError Error" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsActionResult.Error" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Error As TextAnalyticsError" />
      <MemberSignature Language="F#" Value="member this.Error : Azure.AI.TextAnalytics.TextAnalyticsError" Usage="Azure.AI.TextAnalytics.TextAnalyticsActionResult.Error" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.TextAnalytics.TextAnalyticsError</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Determines the TextAnalyticsError object for an action result.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HasError">
      <MemberSignature Language="C#" Value="public bool HasError { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool HasError" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsActionResult.HasError" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasError As Boolean" />
      <MemberSignature Language="F#" Value="member this.HasError : bool" Usage="Azure.AI.TextAnalytics.TextAnalyticsActionResult.HasError" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Indicates that the document was not successfully processed and an error was returned for this document.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>