README.md
1# Embedded User Authentication Control
2
3
4## Introduction
5
6Provide face and fingerprint authentication icon displayed on the application interface, with specific functions as follows:
71. Provide embedded face and fingerprint authentication control icon that can be integrated into applications.
82. Support customizing the color and size of icon, but the icon style cannot be changed.
93. After clicking on the control icon, the system pop-up style face and fingerprint authentication control can be pulled up.
10
11
12## Directory Structure
13
14```undefined
15//base/useriam/user_auth_framework/user_auth_icon
16├── library # library module directory
17│ ├── src/main/ets/components/mainpage # the entry point for implementing embedded controls
18```
19
20
21### Available APIs
22
23**Table 1** APIs for embedded user authentication
24
25**table1** Icon click event callback interface
26
27| interface | description |
28| ------ | -------------------------------- |
29| onIconClick?: () => void; | Notify the application that a click event has been triggered. |
30
31**table2** Identity authentication result notification callback interface
32
33| interface | description |
34| ------ | -------------------------------- |
35| onAuthResult: (result: userAuth.UserAuthResult) => void; | Notify the application of user authentication result information. |
36
37
38
39## Demo
40
41```undefined
42import userAuth from '@ohos.userIAM.userAuth';
43import UserAuthIcon from '@ohos.userIAM.userAuthIcon';
44
45@Entry
46@Component
47struct Index {
48 authParam: userAuth.AuthParam = {
49 challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
50 authType: [userAuth.UserAuthType.FACE, userAuth.UserAuthType.PIN],
51 authTrustLevel: userAuth.AuthTrustLevel.ATL3,
52 };
53 widgetParam: userAuth.WidgetParam = {
54 title: '请进行身份认证',
55 };
56
57 build() {
58 Row() {
59 Column() {
60 UserAuthIcon({
61 authParam: this.authParam,
62 widgetParam: this.widgetParam,
63 iconHeight: 200,
64 iconColor: Color.Blue,
65 onIconClick: () => {
66 console.info("The user clicked the icon.");
67 },
68 onAuthResult: (result: userAuth.UserAuthResult) => {
69 console.info('Get user auth result, result = ' + JSON.stringify(result));
70 },
71 })
72 }
73 }
74 }
75}
76```
77
README_ZH.md
1# 嵌入式用户身份认证控件
2
3- [简介](#简介)
4- [目录](#目录)
5- [说明](#说明)
6 - [接口说明](#接口说明)
7- [示例](#示例)
8
9
10## 简介
11
12**嵌入式用户身份认证控件** 提供应用界面上展示的人脸、指纹认证图标，具体功能如下：
13
141、提供嵌入式人脸、指纹认证控件图标，可被应用集成。
15
162、支持自定义图标的颜色和大小，但图标样式不可变更。
17
183、点击控件图标后可拉起系统弹窗式人脸、指纹认证控件。
19
20
21## 目录
22
23```undefined
24//base/useriam/user_auth_framework/user_auth_icon
25├── library # library模块目录
26│ ├── src/main/ets/components/mainpage # 嵌入式控件实现，入口
27```
28
29
30## 说明
31
32### **嵌入式用户身份认证控件接口说明**
33
34**表1** Icon点击事件回调接口
35
36| 接口名 | 描述 |
37| ------ | -------------------------------- |
38| onIconClick?: () => void; | 通知应用点击事件触发 |
39
40**表2** 身份认证结果通知回调接口
41
42| 接口名 | 描述 |
43| ------ | -------------------------------- |
44| onAuthResult: (result: userAuth.UserAuthResult) => void; | 通知应用身份认证结果信息 |
45
46
47## 示例
48
49```undefined
50import userAuth from '@ohos.userIAM.userAuth';
51import UserAuthIcon from '@ohos.userIAM.userAuthIcon';
52
53@Entry
54@Component
55struct Index {
56 authParam: userAuth.AuthParam = {
57 challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
58 authType: [userAuth.UserAuthType.FACE, userAuth.UserAuthType.PIN],
59 authTrustLevel: userAuth.AuthTrustLevel.ATL3,
60 };
61 widgetParam: userAuth.WidgetParam = {
62 title: '请进行身份认证',
63 };
64
65 build() {
66 Row() {
67 Column() {
68 UserAuthIcon({
69 authParam: this.authParam,
70 widgetParam: this.widgetParam,
71 iconHeight: 200,
72 iconColor: Color.Blue,
73 onIconClick: () => {
74 console.info("The user clicked the icon.");
75 },
76 onAuthResult: (result: userAuth.UserAuthResult) => {
77 console.info('Get user auth result, result = ' + JSON.stringify(result));
78 },
79 })
80 }
81 }
82 }
83}
84```
85