/*
* Copyright (c) 2024, Salesforce, Inc.
* All rights reserved.
* For full license text, see the LICENSE.txt file
*/
import { BaseCapability } from "../BaseCapability.js";
/**
* Use this factory function to get an instance of {@linkcode BiometricsService}.
* @returns An instance of {@linkcode BiometricsService}.
*/
export function getBiometricsService(): BiometricsService;
/**
* Access a device’s biometrics capabilities from a Lightning web component.
* @see {@link https://developer.salesforce.com/docs/platform/lwc/guide/reference-lightning-biometricsservice.html|BiometricsService API}
*/
export interface BiometricsService extends BaseCapability {
/**
* Verify if the biometrics hardware or pin code is available to use to verify the user’s device ownership.
* @param options A {@linkcode BiometricsServiceOptions} object to configure the {@linkcode BiometricsService} request.
* @returns A Promise object that resolves as a Boolean value. True if the biometrics hardware or pin code is available for use and false otherwise.
*/
isBiometricsReady(options?: BiometricsServiceOptions): Promise<boolean>;
/**
* Verify if the user is the device owner using the device’s biometrics hardware or pin code.
* @param options A {@linkcode BiometricsServiceOptions} object to configure the {@linkcode BiometricsService} request.
* @returns A Promise object that resolves as a Boolean value. True if the user is the registered device owner and false otherwise.
*/
checkUserIsDeviceOwner(options?: BiometricsServiceOptions): Promise<boolean>;
}
/**
* An object for specifying which instances of a recurring event are affected by an update to or deletion of one instance of the event.
*/
export interface BiometricsServiceOptions {
/**
* Reason to use biometrics scanner.
*/
permissionRequestBody?: string;
/**
* Title used in the dialog when the reason text is displayed. Allowed on iOS, but effective only on Android.
*/
permissionRequestTitle?: string;
/**
* Policies specified in the array allows customization of the biometrics scan behavior.
*/
additionalSupportedPolicies?: BiometricsServicePolicy[];
}
/**
* An object representing policy to use pin code as an alternative to biometrics.
*/
export type BiometricsServicePolicy =
/** User cancelled the operation. */ "PIN_CODE";
/**
* An object representing an error that occurred when accessing {@linkcode BiometricsService} features.
*/
interface BiometricsServiceFailure {
/**
* A value representing the reason for a biometrics service error. See {@linkcode BiometricsServiceFailureCode} for the list of possible values.
*/
code: BiometricsServiceFailureCode;
/**
* A string value describing the reason for the failure. This value is suitable for use in user interface messages. The message is provided in English and isn’t localized.
*/
message: string;
}
/**
* Correlates with the code property on the {@linkcode BiometricsServiceFailure} object.
*/
type BiometricsServiceFailureCode =
| "HARDWARE_NOT_AVAILABLE" // There is no fingerprint scanner or face recognition hardware found.
| "NOT_CONFIGURED" // Biometrics hardware was found but has not been set up yet.
| "SERVICE_NOT_ENABLED" // BiometricsService is not enabled and cannot be used.
| "UNKNOWN_REASON"; // An error occurred in the native code that isn’t related to permissions or hardware issues. More information is provided in the BiometricsServiceFailure message.
