BiometricManager class
This object controls biometrics on the device. Before the first use of this object, it needs to be initialized using the init method.
Constructors
- BiometricManager(BiometricManagerJSObject _bm)
Properties
- biometricType → String
-
Bot API 7.2+ The type of biometrics currently available
on the device. Can be one of these values:
no setter
- deviceId → String
-
Bot API 7.2+ A unique device identifier that can be used
to match the token to the device.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAccessGranted → bool
-
Bot API 7.2+ Shows whether permission to use biometrics
has been granted.
no setter
- isAccessRequested → bool
-
Bot API 7.2+ Shows whether permission to use biometrics
has been requested.
no setter
- isBiometricAvailable → bool
-
Bot API 7.2+ Shows whether biometrics is available on
the current device.
no setter
- isBiometricTokenSaved → bool
-
Bot API 7.2+ Shows whether the token is saved in secure
storage on the device.
no setter
- isInited → bool
-
Bot API 7.2+ Shows whether biometrics object is initialized.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
authenticate(
BiometricAuthenticateParams params, void onResult(bool authenticated, String? token)) → BiometricManager - Bot API 7.2+ A method that authenticates the user using biometrics according to the params argument of type BiometricAuthenticateParams. If an optional callback parameter was passed, the callback function will be called and the first argument will be a boolean indicating whether the user authenticated successfully. If so, the second argument will be a biometric token.
-
init(
[void objectInitialized()?]) → BiometricManager - Bot API 7.2+ A method that initializes the BiometricManager object. It should be called before the object's first use. If an optional callback parameter was passed, the callback function will be called when the object is initialized.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openSettings(
) → BiometricManager - Bot API 7.2+ A method that opens the biometric access settings for bots. Useful when you need to request biometrics access to users who haven't granted it yet.
-
requestAccess(
BiometricRequestAccessParams params, void onResult(bool granted)) → BiometricManager - Bot API 7.2+ A method that requests permission to use biometrics according to the params argument of type BiometricRequestAccessParams. If an optional callback parameter was passed, the callback function will be called and the first argument will be a boolean indicating whether the user granted access.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateBiometricToken(
String token, void onResult(bool updated)) → BiometricManager - Bot API 7.2+ A method that updates the biometric token in secure storage on the device. To remove the token, pass an empty string. If an optional callback parameter was passed, the callback function will be called and the first argument will be a boolean indicating whether the token was updated.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited