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 HdfPinAuth 18 * @{ 19 * 20 * @brief Provides APIs for the pin auth driver. 21 * 22 * The pin auth driver provides a unified interface for the pin auth service to access the pin auth driver. 23 * After obtaining the pin auth driver proxy, the service can call related APIs to obtain executors. 24 * After obtaining the pin 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 * @version 1.0 29 */ 30 31/** 32 * @file IPinAuthInterface.idl 33 * 34 * @brief Defines the API for getting the executor list of the pin auth driver. 35 * of driver. 36 * 37 * @since 3.2 38 * @version 1.0 39 */ 40 41package ohos.hdi.pin_auth.v2_0; 42 43import ohos.hdi.pin_auth.v2_0.IAllInOneExecutor; 44import ohos.hdi.pin_auth.v2_0.ICollector; 45import ohos.hdi.pin_auth.v2_0.IVerifier; 46 47/** 48 * @brief Defines the API for getting the executor list of the pin auth driver. 49 * 50 * @since 3.2 51 * @version 1.0 52 */ 53interface IPinAuthInterface { 54 /** 55 * @brief Obtains the executor list of the driver. 56 * 57 * @param allInOneExecutors Indicates the all-in-one executor list of the driver. 58 * See {@link IAllInOneExecutor}. 59 * @param verifiers Indicates the verifier list of the driver. See {@link IVerifier}. 60 * @param collectors Indicates the collector list of the driver. See {@link ICollector}. 61 * 62 * @return Returns <b>0</b> if the operation is successful. 63 * @return Returns a non-zero value if the operation fails. 64 * 65 * @since 3.2 66 * @version 2.0 67 */ 68 GetExecutorList([out] IAllInOneExecutor[] allInOneExecutors, [out] IVerifier[] verifiers, 69 [out] ICollector[] collectors); 70} 71/** @} */