• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @addtogroup HdfFingerprintAuth
18 * @{
19 *
20 * @brief Provides APIs for the fingerprint auth driver.
21 *
22 * The fingerprint auth driver provides a unified interface for the fingerprint auth service to access the fingerprint auth driver.
23 * After obtaining the fingerprint auth driver proxy, the service can call related APIs to obtain executors.
24 * After obtaining the fingerprint auth executors, the service can call related APIs to get executor info, get
25 * template info, enroll template, authenticate template, delete template, etc.
26 *
27 * @since 4.0
28 */
29
30/**
31 * @file IFingerprintAuthInterface.idl
32 *
33 * @brief Defines the get executor list API of the fingerprint auth driver. This API can be used to get executor list
34 * of driver.
35 *
36 * @since 4.0
37 */
38
39package ohos.hdi.fingerprint_auth.v1_1;
40
41import ohos.hdi.fingerprint_auth.v1_0.IFingerprintAuthInterface;
42import ohos.hdi.fingerprint_auth.v1_1.IExecutor;
43
44/**
45 * @brief Defines the get executor list API of the fingerprint auth driver.
46 *
47 * @since 4.0
48 * @version 1.1
49 */
50interface IFingerprintAuthInterface extends ohos.hdi.fingerprint_auth.v1_0.IFingerprintAuthInterface {
51    /**
52     * @brief Obtains executor list of driver.
53     *
54     * @param executorList Indicates executor list of driver. For details, see {@link IExecutor}.
55     *
56     * @return Returns <b>0</b> if the operation is successful.
57     * @return Returns a non-zero value if the operation fails.
58     */
59    GetExecutorListV1_1([out] IExecutor[] executorList);
60}