FaceSessionClient.GetLivenessSessionResult Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Overloads

GetLivenessSessionResult(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details.
GetLivenessSessionResult(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionResult(String, CancellationToken) convenience overload with strongly typed models first.

GetLivenessSessionResult(String, CancellationToken)

Source:

FaceSessionClient.cs

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

public virtual Azure.Response<Azure.AI.Vision.Face.LivenessSession> GetLivenessSessionResult (string sessionId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetLivenessSessionResult : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.LivenessSession>
override this.GetLivenessSessionResult : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.LivenessSession>

Public Overridable Function GetLivenessSessionResult (sessionId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of LivenessSession)

Parameters

sessionId

String

The unique ID to reference this session.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<LivenessSession>

Exceptions

ArgumentNullException

sessionId is null.

ArgumentException

sessionId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetLivenessSessionResult.

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

Response<LivenessSession> response = client.GetLivenessSessionResult("b12e033e-bda7-4b83-a211-e721c661f30e");

GetLivenessSessionResult(String, RequestContext)

Source:

FaceSessionClient.cs

[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details.

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

public virtual Azure.Response GetLivenessSessionResult (string sessionId, Azure.RequestContext context);

abstract member GetLivenessSessionResult : string * Azure.RequestContext -> Azure.Response
override this.GetLivenessSessionResult : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetLivenessSessionResult (sessionId As String, context As RequestContext) As Response

Parameters

sessionId

String

The unique ID to reference this session.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

sessionId is null.

ArgumentException

sessionId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

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

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

Response response = client.GetLivenessSessionResult("b12e033e-bda7-4b83-a211-e721c661f30e", null);

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