FaceList.xml

<Type Name="FaceList" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList">
  <TypeSignature Language="C#" Value="public class FaceList" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FaceList extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList" />
  <TypeSignature Language="VB.NET" Value="Public Class FaceList" />
  <TypeSignature Language="F#" Value="type FaceList = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
    <AssemblyVersion>2.7.0.0</AssemblyVersion>
    <AssemblyVersion>2.8.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Face list object.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FaceList ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the FaceList class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FaceList (string faceListId, string name, string userData = default, string recognitionModel = default, System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt; persistedFaces = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string faceListId, string name, string userData, string recognitionModel, class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt; persistedFaces) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.#ctor(System.String,System.String,System.String,System.String,System.Collections.Generic.IList{Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (faceListId As String, name As String, Optional userData As String = Nothing, Optional recognitionModel As String = Nothing, Optional persistedFaces As IList(Of PersistedFace) = Nothing)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList : string * string * string * string * System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt; -&gt; Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList" Usage="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList (faceListId, name, userData, recognitionModel, persistedFaces)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="faceListId" Type="System.String" />
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="userData" Type="System.String" />
        <Parameter Name="recognitionModel" Type="System.String" />
        <Parameter Name="persistedFaces" Type="System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt;" />
      </Parameters>
      <Docs>
        <param name="faceListId">FaceListId of the target face
            list.</param>
        <param name="name">User defined name, maximum length is
            128.</param>
        <param name="userData">User specified data. Length should not
            exceed 16KB.</param>
        <param name="recognitionModel">Possible values include:
            'recognition_01', 'recognition_02'</param>
        <param name="persistedFaces">Persisted faces within the face
            list.</param>
        <summary>
            Initializes a new instance of the FaceList class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FaceListId">
      <MemberSignature Language="C#" Value="public string FaceListId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string FaceListId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.FaceListId" />
      <MemberSignature Language="VB.NET" Value="Public Property FaceListId As String" />
      <MemberSignature Language="F#" Value="member this.FaceListId : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.FaceListId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="faceListId")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="faceListId")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets faceListId of the target face list.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.Name" />
      <MemberSignature Language="VB.NET" Value="Public Property Name As String" />
      <MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.Name" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="name")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="name")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PersistedFaces">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt; PersistedFaces { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt; PersistedFaces" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.PersistedFaces" />
      <MemberSignature Language="VB.NET" Value="Public Property PersistedFaces As IList(Of PersistedFace)" />
      <MemberSignature Language="F#" Value="member this.PersistedFaces : System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt; with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.PersistedFaces" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="persistedFaces")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="persistedFaces")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets persisted faces within the face list.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RecognitionModel">
      <MemberSignature Language="C#" Value="public string RecognitionModel { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string RecognitionModel" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.RecognitionModel" />
      <MemberSignature Language="VB.NET" Value="Public Property RecognitionModel As String" />
      <MemberSignature Language="F#" Value="member this.RecognitionModel : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.RecognitionModel" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="recognitionModel")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="recognitionModel")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UserData">
      <MemberSignature Language="C#" Value="public string UserData { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string UserData" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.UserData" />
      <MemberSignature Language="VB.NET" Value="Public Property UserData As String" />
      <MemberSignature Language="F#" Value="member this.UserData : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.UserData" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="userData")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="userData")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="public virtual void Validate ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList.Validate" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
      <MemberSignature Language="F#" Value="abstract member Validate : unit -&gt; unit&#xA;override this.Validate : unit -&gt; unit" Usage="faceList.Validate " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
        <AssemblyVersion>2.8.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Validate the object.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Rest.ValidationException">
            Thrown if validation fails
            </exception>
      </Docs>
    </Member>
  </Members>
</Type>