1/*
2 * Copyright (c) 2022 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 3.2
28 */
29
30/**
31 * @file IExecutorCallback.idl
32 *
33 * @brief Defines the callback for async API. These callback can be used to report operation result or info
34 * of async API.
35 *
36 * @since 3.2
37 */
38
39package ohos.hdi.fingerprint_auth.v1_0;
40
41/**
42 * @brief Defines the callback for async API. This callback needs to be registered when
43 * executor user calls an async function. For details, see {@link IExecutor}.
44 *
45 * @since 3.2
46 * @version 1.0
47 */
48[callback] interface IExecutorCallback {
49    /**
50     * @brief Defines the function for reporting operation result.
51     *
52     * @param result Indicates result code.
53     * @param extraInfo Indicates extra info to report.
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    OnResult([in] int result, [in] unsigned char[] extraInfo);
59    /**
60     * @brief defines the function for reporting info in process.
61     *
62     * @param tip Indicates tip code, see {@link FingerprintTipsCode}.
63     * @param extraInfo Indicates extra info to report.
64     *
65     * @return Returns <b>0</b> if the operation is successful.
66     * @return Returns a non-zero value if the operation fails.
67     */
68    OnTip([in] int tip, [in] unsigned char[] extraInfo);
69}