1/*
2 * Copyright (c) 2024 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 information, get
25 * template information, and enroll, authenticate, and delete templates, etc.
26 *
27 * @since 3.2
28 */
29
30/**
31 * @file IFingerprintAuthInterface.idl
32 *
33 * @brief Defines the API for getting the executor list of the fingerprint auth driver.
34 *
35 * @since 3.2
36 */
37
38package ohos.hdi.fingerprint_auth.v2_0;
39
40import ohos.hdi.fingerprint_auth.v2_0.IAllInOneExecutor;
41
42/**
43 * @brief Defines the API for getting the executor list of the fingerprint auth driver.
44 *
45 * @since 3.2
46 * @version 2.0
47 */
48interface IFingerprintAuthInterface {
49    /**
50     * @brief Obtains the executor list of the driver.
51     *
52     * @param allInOneExecutors Indicates the all-in-one executor list of the driver.
53     * See {@link IAllInOneExecutor}.
54     *
55     * @return Returns <b>0</b> if the operation is successful.
56     * @return Returns a non-zero value if the operation fails.
57     *
58     * @since 3.2
59     * @version 2.0
60     */
61    GetExecutorList([out] IAllInOneExecutor[] allInOneExecutors);
62}
63/** @} */