• 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 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 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.pin_auth.v1_1;
40
41import ohos.hdi.pin_auth.v1_0.IExecutor;
42import ohos.hdi.pin_auth.v1_1.PinAuthTypes;
43import ohos.hdi.pin_auth.v1_1.IExecutorCallback;
44
45/**
46 * @brief Defines the APIs of the executors. These APIs can be used to get executor information, get
47 * template information, and enroll, authenticate, and delete templates, etc.
48 *
49 * @since 4.0
50 * @version 1.1
51 */
52
53interface IExecutor extends ohos.hdi.pin_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     * @since 4.0
65     * @version 1.1
66     */
67    GetProperty([in] unsigned long[] templateIdList, [in] enum GetPropertyType[] propertyTypes, [out] struct Property property);
68    /**
69     * @brief Enrolls templates.
70     *
71     * @param scheduleId Indicates the schedule ID of enrollment.
72     * @param extraInfo Indicates the extra information of enrollment.
73     * @param callbackObj Indicates the callback object of enrollment. See {@link IExecutorCallback}.
74     *
75     * @return Returns <b>0</b> if the operation is successful.
76     * @return Returns a non-zero value if the operation fails.
77     *
78     * @since 4.0
79     * @version 1.1
80     */
81    EnrollV1_1([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj);
82    /**
83     * @brief Authenticates templates.
84     *
85     * @param scheduleId Indicates the schedule ID of authentication.
86     * @param templateId Indicates the templates to authenticate.
87     * @param extraInfo Indicates the extra information of authentication.
88     * @param callbackObj Indicates the callback object of authentication. See {@link IExecutorCallback}.
89     *
90     * @return Returns <b>0</b> if the operation is successful.
91     * @return Returns a non-zero value if the operation fails.
92     *
93     * @since 4.0
94     * @version 1.1
95     */
96    AuthenticateV1_1([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj);
97}
98/** @} */