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 HdfFaceAuth 18 * @{ 19 * 20 * @brief Provides APIs for the face auth driver. 21 * 22 * The face auth driver provides a unified interface for the face auth service to access the face auth driver. 23 * After obtaining the face auth driver proxy, the service can call related APIs to obtain executors. 24 * After obtaining the face 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 4.0 28 */ 29 30/** 31 * @file IExecutor.idl 32 * 33 * @brief Defines the APIs of the executors. These APIs can be used to get executor information, get 34 * template information, and enroll, authenticate, and delete templates, etc. 35 * 36 * @since 4.0 37 */ 38 39package ohos.hdi.face_auth.v1_1; 40 41import ohos.hdi.face_auth.v1_0.FaceAuthTypes; 42import ohos.hdi.face_auth.v1_0.IExecutor; 43import ohos.hdi.face_auth.v1_1.FaceAuthTypes; 44import ohos.hdi.face_auth.v1_1.ISaCommandCallback; 45 46/** 47 * @brief Defines the APIs of the executors. These APIs can be used to get executor information, get 48 * template information, and enroll, authenticate, and delete templates, etc. 49 * 50 * @since 4.0 51 * @version 1.1 52 */ 53interface IExecutor extends ohos.hdi.face_auth.v1_0.IExecutor { 54 /** 55 * @brief Get property. 56 * 57 * @param templateIdList Indicates the templates to process. 58 * @param propertyTypes Indicates the property types to get. See {@link GetPropertyType}. 59 * @param property Indicates property. See {@link Property}. 60 * 61 * @return Returns <b>0</b> if the operation is successful. 62 * @return Returns a non-zero value if the operation fails. 63 */ 64 GetProperty([in] unsigned long[] templateIdList, [in] enum GetPropertyType[] propertyTypes, [out] struct Property property); 65 /** 66 * @brief Set cached templates. 67 * 68 * @param templateIdList Indicates the templates to cache. 69 * 70 * @return Returns <b>0</b> if the operation is successful. 71 * @return Returns a non-zero value if the operation fails. 72 */ 73 SetCachedTemplates([in] unsigned long[] templateIdList); 74 75 /** 76 * @brief Register sa command callback. 77 * 78 * @param callbackObj Indicates the sa command callback. 79 * 80 * @return Returns <b>0</b> if the operation is successful. 81 * @return Returns a non-zero value if the operation fails. 82 */ 83 RegisterSaCommandCallback([in] ISaCommandCallback callbackObj); 84} 85/** @} */