PersonGroupOperationsExtensions.ListAsync(IPersonGroupOperations, String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) Method

Definition

List person groups’s personGroupId, name, userData and recognitionModel.<br />

  • Person groups are stored in alphabetical order of personGroupId.
  • "start" parameter (string, optional) is a user-provided personGroupId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
  • "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify "start" with the last retuned entry’s Id of the current call. <br /> For example, total 5 person groups: "group1", ..., "group5". <br /> "start=&top=" will return all 5 groups. <br /> "start=&top=2" will return "group1", "group2". <br /> "start=group2&top=3" will return "group3", "group4", "group5".
public static System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>> ListAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations operations, string start = default, int? top = 1000, bool? returnRecognitionModel = False, System.Threading.CancellationToken cancellationToken = default);
static member ListAsync : Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations * string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>
<Extension()>
Public Function ListAsync (operations As IPersonGroupOperations, Optional start As String = Nothing, Optional top As Nullable(Of Integer) = 1000, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of PersonGroup))

Parameters

operations
IPersonGroupOperations

The operations group for this extension method.

start
String

List person groups from the least personGroupId greater than the "start".

top
Nullable<Int32>

The number of person groups to list.

returnRecognitionModel
Nullable<Boolean>

A value indicating whether the operation should return 'recognitionModel' in response.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<IList<PersonGroup>>

Applies to