LivenessSession Class

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Source:

LivenessSession.cs

Session result of detect liveness.

public class LivenessSession : System.ClientModel.Primitives.IJsonModel<Azure.AI.Vision.Face.LivenessSession>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Vision.Face.LivenessSession>

type LivenessSession = class
    interface IJsonModel<LivenessSession>
    interface IPersistableModel<LivenessSession>

Public Class LivenessSession
Implements IJsonModel(Of LivenessSession), IPersistableModel(Of LivenessSession)

Inheritance

Object

LivenessSession

Implements

IJsonModel<LivenessSession> IPersistableModel<LivenessSession> IPersistableModel<T>

Properties

AuthTokenTimeToLiveInSeconds	Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.
CreatedDateTime	DateTime when this session was created.
DeviceCorrelationId	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.
Id	The unique ID to reference this session.
Result	The latest session audit result only populated if status == 'ResultAvailable'.
SessionExpired	Whether or not the session is expired.
SessionStartDateTime	DateTime when this session was started by the client.
Status	The current status of the session.

Explicit Interface Implementations

IJsonModel<LivenessSession>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<LivenessSession>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<LivenessSession>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<LivenessSession>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<LivenessSession>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.