Package com.appliedrec.verid.core2.session

Class RegistrationSessionSettings

java.lang.Object

com.appliedrec.verid.core2.session.VerIDSessionSettings

com.appliedrec.verid.core2.session.RegistrationSessionSettings

All Implemented Interfaces:

android.os.Parcelable

public class RegistrationSessionSettings
extends VerIDSessionSettings
implements android.os.Parcelable

Registration 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<RegistrationSessionSettings>	CREATOR

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
	RegistrationSessionSettings()
protected	RegistrationSessionSettings(android.os.Parcel in)
	RegistrationSessionSettings(java.lang.String userId)	Constructor
	RegistrationSessionSettings(java.lang.String userId, Bearing[] bearingsToRegister)

Method Summary

Modifier and Type	Method	Description
int	describeContents()	Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(java.lang.Object o)
Bearing[]	getBearingsToRegister()
java.lang.String	getUserId()	Get the ID of the user who will be registered in the session.
int	hashCode()
void	setBearingsToRegister(Bearing[] bearingsToRegister)
void	setUserId(java.lang.String userId)	Set the ID of the user who will be registered in the session.
void	setUseSafeFaceAssignment(boolean useSafeFaceAssignment)
boolean	useSafeFaceAssignment()
void	writeToParcel(android.os.Parcel dest, int flags)	Flatten this object in to a Parcel.

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

getStability

Field Detail

CREATOR

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

Constructor Detail

RegistrationSessionSettings

public RegistrationSessionSettings()

RegistrationSessionSettings

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

Constructor

Parameters:

userId - ID of the user to register in this session

Since:

1.0.0

RegistrationSessionSettings

public RegistrationSessionSettings(@NonNull
                                   java.lang.String userId,
                                   @Nullable
                                   Bearing[] bearingsToRegister)

RegistrationSessionSettings

protected RegistrationSessionSettings(android.os.Parcel in)

Method Detail

getUserId

public java.lang.String getUserId()

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

Returns:

User ID

Since:

1.0.0

See Also:

setUserId(String)

setUserId

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

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

Parameters:

userId - User ID

Since:

1.0.0

See Also:

getUserId()

getBearingsToRegister

public Bearing[] getBearingsToRegister()

setBearingsToRegister

public void setBearingsToRegister(@NonNull
                                  Bearing[] bearingsToRegister)

useSafeFaceAssignment

public boolean useSafeFaceAssignment()

Returns:

`false` to register faces from the session even if similar faces are already registered as another user, otherwise `true`

Since:

2.6.0

setUseSafeFaceAssignment

public void setUseSafeFaceAssignment(boolean useSafeFaceAssignment)

Parameters:

useSafeFaceAssignment - Set to `false` to register faces from the session even if similar faces are already registered as another user

Since:

2.6.0

describeContents

@RestrictTo(LIBRARY_GROUP)
public int describeContents()

Description copied from interface: android.os.Parcelable

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of Parcelable.writeToParcel(Parcel, int), the return value of this method must include the Parcelable.CONTENTS_FILE_DESCRIPTOR bit.

Specified by:

describeContents in interface android.os.Parcelable

Overrides:

describeContents in class VerIDSessionSettings

Returns:

a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

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 VerIDSessionSettings

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.

equals

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

Overrides:

equals in class VerIDSessionSettings

hashCode

@RestrictTo(LIBRARY_GROUP)
public int hashCode()

Overrides:

hashCode in class VerIDSessionSettings