Interface UserEnrollment.OsUserEnrollment
- All Superinterfaces:
UserEnrollment
- Enclosing interface:
- UserEnrollment
The object containing the user enrollment information for an authenticator
whose credentials are managed by the operating system (like the fingerprint
authenticator). In this case, there is no notion of
Account
:
either the authenticator is enrolled at the operating system level (for all
users) or not.-
Nested Class Summary
Nested classes/interfaces inherited from interface ch.nevis.mobile.sdk.api.localdata.UserEnrollment
UserEnrollment.OsUserEnrollment, UserEnrollment.SdkUserEnrollment
-
Method Summary
Modifier and TypeMethodDescriptionboolean
For the biometric authenticator, if the user is enrolled with a Class 3 (formerly strong) biometric sensor, returnstrue
.boolean
For the biometric authenticator, returnstrue
if the user is enrolled in the OS with at least one Class 2 (formerly weak) or Class 3 (formerly strong) biometric sensor,false
otherwise.
-
Method Details
-
isEnrolled
boolean isEnrolled()For the biometric authenticator, if the user is enrolled with a Class 3 (formerly strong) biometric sensor, returnstrue
. Returnsfalse
otherwise. For instance if the user is enrolled with a Class 2 sensor, but not with a Class 3 sensor, this method will returnfalse
.
For the fingerprint authenticator, returnstrue
if there is a fingerprint enrolled in the operating system,false
otherwise.- Returns:
true
if the user is enrolled in the OS,false
otherwise
-
isEnrolledWithClass2OrClass3Sensor
boolean isEnrolledWithClass2OrClass3Sensor()For the biometric authenticator, returnstrue
if the user is enrolled in the OS with at least one Class 2 (formerly weak) or Class 3 (formerly strong) biometric sensor,false
otherwise.
For the PIN and fingerprint authenticators, it returns the same value asisEnrolled()
.This method must be used instead of
isEnrolled()
if Class 2 biometric sensors were allowed during registration of a biometric authenticator. If no Class 2 biometric sensor is allowed, this method will return the same value asisEnrolled()
.- Returns:
true
if the user is enrolled in the OS with a Class 2 or 3 biometric sensor,false
otherwise- See Also:
-