FaceSessionClient.GetLivenessSessions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetLivenessSessions(String, Nullable<Int32>, RequestContext) |
[Protocol Method] Lists sessions for /detectLiveness/SingleModal.
|
| GetLivenessSessions(String, Nullable<Int32>, CancellationToken) |
Lists sessions for /detectLiveness/SingleModal. |
GetLivenessSessions(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 GetLivenessSessions(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response GetLivenessSessions (string start, int? top, Azure.RequestContext context);abstract member GetLivenessSessions : string * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetLivenessSessions : string * Nullable<int> * Azure.RequestContext -> Azure.ResponsePublic Overridable Function GetLivenessSessions (start As String, top As Nullable(Of Integer), context As RequestContext) As ResponseParameters
- start
- String
List resources greater than the "start". It contains no more than 64 characters. Default is empty.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
Service returned a non-success status code.
Examples
This sample shows how to call GetLivenessSessions and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);
Response response = client.GetLivenessSessions(null, null, 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());
This sample shows how to call GetLivenessSessions with all parameters and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);
Response response = client.GetLivenessSessions("<start>", 1234, 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("sessionStartDateTime").ToString());
Console.WriteLine(result[0].GetProperty("sessionExpired").ToString());
Console.WriteLine(result[0].GetProperty("deviceCorrelationId").ToString());
Console.WriteLine(result[0].GetProperty("authTokenTimeToLiveInSeconds").ToString());
Applies to
GetLivenessSessions(String, Nullable<Int32>, CancellationToken)
- Source:
- FaceSessionClient.cs
Lists sessions for /detectLiveness/SingleModal.
public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LivenessSessionItem>> GetLivenessSessions (string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetLivenessSessions : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LivenessSessionItem>>
override this.GetLivenessSessions : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LivenessSessionItem>>Public Overridable Function GetLivenessSessions (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of LivenessSessionItem))Parameters
- start
- String
List resources greater than the "start". It contains no more than 64 characters. Default is empty.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Examples
This sample shows how to call GetLivenessSessions.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);
Response<IReadOnlyList<LivenessSessionItem>> response = client.GetLivenessSessions();
This sample shows how to call GetLivenessSessions with all parameters.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);
Response<IReadOnlyList<LivenessSessionItem>> response = client.GetLivenessSessions(start: "<start>", top: 1234);
Remarks
List sessions from the last sessionId greater than the 'start'.
The result should be ordered by sessionId in ascending order.
Applies to
Azure SDK for .NET