Package com.appliedrec.verid.core2.session

Class AuthenticationSessionSettings

java.lang.Object

com.appliedrec.verid.core2.session.VerIDSessionSettings

com.appliedrec.verid.core2.session.LivenessDetectionSessionSettings

com.appliedrec.verid.core2.session.AuthenticationSessionSettings

All Implemented Interfaces:

android.os.Parcelable

public class AuthenticationSessionSettings
extends LivenessDetectionSessionSettings
implements android.os.Parcelable

Authentication session settings

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.ContentsFlags, android.os.Parcelable.Creator<T>, android.os.Parcelable.Stability, android.os.Parcelable.WriteFlags

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<AuthenticationSessionSettings>	CREATOR

Fields inherited from class com.appliedrec.verid.core2.session.LivenessDetectionSessionSettings

DEFAULT_BEARINGS

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_STABILITY_LOCAL, PARCELABLE_STABILITY_VINTF, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor	Description
	AuthenticationSessionSettings()	Constructor that sets the user ID to null
protected	AuthenticationSessionSettings(android.os.Parcel in)
	AuthenticationSessionSettings(java.lang.String userId)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getUserId()	Get the ID of the user who will be authenticated in the session.
int	hashCode()
void	setUserId(java.lang.String userId)	Set the ID of the user who will be authenticated in the session.
void	writeToParcel(android.os.Parcel dest, int flags)	Flatten this object in to a Parcel.

Methods inherited from class com.appliedrec.verid.core2.session.LivenessDetectionSessionSettings

describeContents, getBearings, setBearings

Methods inherited from class com.appliedrec.verid.core2.session.VerIDSessionSettings

getExpectedFaceExtents, getFaceCaptureCount, getFaceCaptureFaceCount, getMaxDuration, getMoireDetectionConfidenceThreshold, getPauseDuration, getPitchThreshold, getSpoofDeviceDetectionConfidenceThreshold, getYawThreshold, isFaceCoveringDetectionEnabled, isMoireDetectionEnabled, isPassiveLivenessDetectionEnabled, isSessionDiagnosticsEnabled, isSpoofDeviceDetectionEnabled, setExpectedFaceExtents, setFaceCaptureCount, setFaceCaptureFaceCount, setFaceCoveringDetectionEnabled, setMaxDuration, setMoireDetectionConfidenceThreshold, setMoireDetectionEnabled, setPassiveLivenessDetectionEnabled, setPauseDuration, setPitchThreshold, setSessionDiagnosticsEnabled, setSpoofDeviceDetectionConfidenceThreshold, setSpoofDeviceDetectionEnabled, setYawThreshold

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents, getStability

Field Detail

CREATOR

@RestrictTo(LIBRARY_GROUP)
public static final android.os.Parcelable.Creator<AuthenticationSessionSettings> CREATOR

Constructor Detail

AuthenticationSessionSettings

public AuthenticationSessionSettings()

Constructor that sets the user ID to null

If you use this constructor make sure you set the user ID before you start the session.

Since:

1.0.0

See Also:

setUserId(String)

AuthenticationSessionSettings

public AuthenticationSessionSettings(@NonNull
                                     java.lang.String userId)

Constructor

Parameters:

userId - ID of the user to authenticate in the session

Since:

1.0.0

AuthenticationSessionSettings

protected AuthenticationSessionSettings(android.os.Parcel in)

Method Detail

writeToParcel

@RestrictTo(LIBRARY_GROUP)
public void writeToParcel(android.os.Parcel dest,
                          int flags)

Description copied from interface: android.os.Parcelable

Flatten this object in to a Parcel.

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class LivenessDetectionSessionSettings

Parameters:

dest - The Parcel in which the object should be written.

flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

getUserId

public java.lang.String getUserId()

Get the ID of the user who will be authenticated in the session.

Returns:

User ID

Since:

1.0.0

See Also:

setUserId(String), AuthenticationSessionSettings(String)

setUserId

public void setUserId(@NonNull
                      java.lang.String userId)

Set the ID of the user who will be authenticated in the session.

Parameters:

userId - User ID

Since:

1.0.0

See Also:

getUserId()

equals

@RestrictTo(LIBRARY_GROUP)
public boolean equals(java.lang.Object o)

Overrides:

equals in class LivenessDetectionSessionSettings

hashCode

@RestrictTo(LIBRARY_GROUP)
public int hashCode()

Overrides:

hashCode in class LivenessDetectionSessionSettings