AIVisionFaceModelFactory.LivenessSessionItem Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Source:

AIVisionFaceModelFactory.cs

Initializes a new instance of LivenessSessionItem.

public static Azure.AI.Vision.Face.LivenessSessionItem LivenessSessionItem (string id = default, DateTimeOffset createdDateTime = default, DateTimeOffset? sessionStartDateTime = default, bool sessionExpired = false, string deviceCorrelationId = default, int? authTokenTimeToLiveInSeconds = default);

static member LivenessSessionItem : string * DateTimeOffset * Nullable<DateTimeOffset> * bool * string * Nullable<int> -> Azure.AI.Vision.Face.LivenessSessionItem

Public Shared Function LivenessSessionItem (Optional id As String = Nothing, Optional createdDateTime As DateTimeOffset = Nothing, Optional sessionStartDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional sessionExpired As Boolean = false, Optional deviceCorrelationId As String = Nothing, Optional authTokenTimeToLiveInSeconds As Nullable(Of Integer) = Nothing) As LivenessSessionItem

Parameters

id

String

The unique ID to reference this session.

createdDateTime

DateTimeOffset

DateTime when this session was created.

sessionStartDateTime

Nullable<DateTimeOffset>

DateTime when this session was started by the client.

sessionExpired

Boolean

Whether or not the session is expired.

deviceCorrelationId

String

Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null.

authTokenTimeToLiveInSeconds

Nullable<Int32>

Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.

Returns

LivenessSessionItem

A new LivenessSessionItem instance for mocking.