FaceSessionClient.GetLivenessSessionsAsync Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

Azure.AI.Vision.Face v1.0.0-beta.2

Overloads

GetLivenessSessionsAsync(String, Nullable<Int32>, RequestContext)	[Protocol Method] Lists sessions for /detectLiveness/SingleModal. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessSessionsAsync(String, Nullable<Int32>, CancellationToken)	Lists sessions for /detectLiveness/SingleModal.

GetLivenessSessionsAsync(String, Nullable<Int32>, RequestContext)

Source:

FaceSessionClient.cs

[Protocol Method] Lists sessions for /detectLiveness/SingleModal.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetLivenessSessionsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> GetLivenessSessionsAsync (string start, int? top, Azure.RequestContext context);

abstract member GetLivenessSessionsAsync : string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLivenessSessionsAsync : string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetLivenessSessionsAsync (start As String, top As Nullable(Of Integer), context As RequestContext) As Task(Of Response)

Parameters

start

String

List resources greater than the "start". It contains no more than 64 characters. Default is empty.

top

Nullable<Int32>

The number of items to list, ranging in [1, 1000]. Default is 1000.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetLivenessSessionsAsync and parse the result.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);

Response response = await client.GetLivenessSessionsAsync("00000000-0000-0000-0000-000000000000", 20, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result[0].GetProperty("id").ToString());
Console.WriteLine(result[0].GetProperty("createdDateTime").ToString());
Console.WriteLine(result[0].GetProperty("sessionExpired").ToString());

GetLivenessSessionsAsync(String, Nullable<Int32>, CancellationToken)

Source:

FaceSessionClient.cs

Lists sessions for /detectLiveness/SingleModal.

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LivenessSessionItem>>> GetLivenessSessionsAsync (string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetLivenessSessionsAsync : string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LivenessSessionItem>>>
override this.GetLivenessSessionsAsync : string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LivenessSessionItem>>>

Public Overridable Function GetLivenessSessionsAsync (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of LivenessSessionItem)))

Parameters

start

String

List resources greater than the "start". It contains no more than 64 characters. Default is empty.

top

Nullable<Int32>

The number of items to list, ranging in [1, 1000]. Default is 1000.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<IReadOnlyList<LivenessSessionItem>>>

Examples

This sample shows how to call GetLivenessSessionsAsync.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);

Response<IReadOnlyList<LivenessSessionItem>> response = await client.GetLivenessSessionsAsync();

Remarks

Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-sessions for more details.