Telegram 小程序 | TypeScript @telegram-apps/sdk @2.x | 组件 | 生物统计学

riyad

生物统计学​

负责 Telegram 迷你应用程序生物测量功能的💠组件。

检查支持​

要检查当前 Telegram 小应用程序版本是否支持生物测量，请使用 isSupported 方法：

Variable :

1. import { biometry } from '@telegram-apps/sdk';
   
2. 
   
3. biometry.isSupported(); // boolean

复制代码

Functions :

1. import { isBiometrySupported } from '@telegram-apps/sdk';
   + C7 o. u' g  [8 T# ~
2. 
   5 K& z8 n- e/ e4 T. \1 W) J
3. isBiometrySupported(); // boolean

复制代码

安装​

在使用组件之前，必须先安装组件。

这个过程是异步的，因为生物测量数据需要向 Telegram 应用程序申请。 在进程中，isMounting 信号将被设置为 true，并在完成后更新为 false。

如果挂载成功，isMounted 信号将设为 true。 如果出现错误，mountError 信号将反映错误。

Variable :

1. try {
   
2.   const promise = biometry.mount();
   
3.   biometry.isMounting(); // true
   
4.   await promise;
   
5.   biometry.isMounting(); // false
     x7 D! Q3 X5 \8 A$ {. P
6.   biometry.isMounted(); // true
   4 |7 V5 Q! @0 g  c
7. } catch (err) {
   7 i* e! t7 e7 \! s4 \6 v- i5 \  P% ~
8.   biometry.mountError(); // equals "err"
   % C  ?- E- q5 h) B! H9 h
9.   biometry.isMounting(); // false
   
10.   biometry.isMounted(); // false
    
11. }

复制代码

Functions :

1. import {
   
2.   mountBiometry,
   6 F; }/ _' u! p" ?2 S; g8 l2 d
3.   isBiometryMounting,
   5 n- T* K! W7 T% V  c, ?
4.   isBiometryMounted,
   5 W$ w2 i9 X* I6 G
5.   biometryMountError,
   
6. } from '@telegram-apps/sdk';
   
7. 
   
8. try {
   
9.   const promise = mountBiometry();
   $ \! E+ ?6 x4 x/ _+ Y; _
10.   isBiometryMounting(); // true
    
11.   await promise;
    # M9 B& b+ W, w
12.   isBiometryMounting(); // false
    1 L+ Z- @# {6 E( u; V- k4 T
13.   isBiometryMounted(); // true
    * Z( k4 Q: P7 w; l
14. } catch (err) {
    1 D0 C) w, w1 ^
15.   biometryMountError(); // equals "err"
    * e& ~0 I0 \/ A* [- L8 k
16.   isBiometryMounting(); // false
    
17.   isBiometryMounted(); // false
    
18. }

复制代码

要卸载，请使用 unmount 方法：

Variable :

1. biometry.unmount();
   
2. biometry.isMounted(); // false

复制代码

Functions :

1. import { unmountBiometry, isBiometryMounted } from '@telegram-apps/sdk';
   
2. 
   
3. unmountBiometry();
   . \( J4 W0 `; n' \
4. isBiometryMounted(); // false

复制代码

申请生物测量访问​

要请求生物测量访问，请使用 requestAccess 方法。 它返回一个带有布尔 值的 promise，表示用户是否允许访问。

Variable :

1. const granted = await biometry.requestAccess(); // boolean

复制代码

Functions :

1. import { requestBiometryAccess } from '@telegram-apps/sdk';
     \4 A4 p+ A9 E' T" B0 {* s
2. 
   
3. const granted = await requestBiometryAccess(); // boolean

复制代码

认证​

要验证用户身份并检索先前保存的令牌，请使用 authenticate 方法。

它可选择接受一个具有以下属性的对象：

• reason?: string: 要向用户显示的身份验证原因。
  

该方法返回一个包含 status （'failed' 或'authorized'）的对象，如果成功， token: string。

Variable :

1. const { status, token } = await biometry.authenticate({
   + T" j( J$ V  k
2.   reason: 'Please!',
   3 O0 D6 J* |. _  N
3. });
   
4. 
   + g6 c7 y- ?% U6 y3 e
5. if (status === 'authorized') {
   * v# O% ?) A% Y6 Q; E1 [; @: g
6.   console.log(`Authorized. Token: ${token}`);
   
7. } else {
   1 g# Q( @2 s; ]
8.   console.log('Not authorized');
   ( G& m; w2 r( y4 v- G; E
9. }

复制代码

Functions :

1. import { authenticateBiometry } from '@telegram-apps/sdk';
   ) f3 x1 ^2 K! F; u9 y& j% Q' q
2. 
   - V5 g# b4 a3 I0 p
3. const { status, token } = await authenticateBiometry({
   
4.   reason: 'Please!',
     {5 i1 g2 p3 V
5. });
   
6. 
   
7. if (status === 'authorized') {
   ( N. H2 o6 ^% L! q; R3 X; y8 D  f
8.   console.log(`Authorized. Token: ${token}`);
   ' ?' d- o  Z9 b& l
9. } else {
   & L6 I. N, N" v! _
10.   console.log('Not authorized');
    
11. }

复制代码

更新令牌​

要更新本地安全存储中存储的令牌，请使用 updateToken 方法。

该方法接受一个带有 reason 和 token 属性的可选对象。 如果 未提供令牌，则会删除现有令牌。

它会返回一个带有布尔值的 promise，表示是否进行了任何更改。

Variable :

1. const updated = await biometry.updateToken({
   
2.   reason: 'Want to delete',
   
3. });
   
4. 
   
5. await biometry.updateToken({
   % M: E0 r0 _2 e: d/ i
6.   reason: 'Will set a new one',
   
7.   token: 'new token',
   . i( `# H* i( ], ]
8. });

复制代码

Functions :

1. import { updateBiometryToken } from '@telegram-apps/sdk';
   " J; j, @+ h: v0 z3 u4 |
2. 
   5 E+ m+ f: L2 x2 p% y' s
3. const updated = await updateBiometryToken({
   1 }4 q: f' w  J1 l2 k
4.   reason: 'Want to delete',
   2 {  u  {2 t: R. ^
5. });
   3 B/ u: C; y4 T# S
6. 
   
7. await updateBiometryToken({
   0 H5 b3 q; h. v
8.   reason: 'Will set a new one',
   
9.   token: 'new token',
   ) m) U9 u3 {- ]/ d0 ~. \- i
10. });

复制代码

打开设置​

要打开生物测量相关设置模式，请使用 openSettings 方法。 该方法只能通过 响应用户交互来触发。

Variable :

1. biometry.openSettings();

复制代码

Functions :

1. import { openBiometrySettings } from '@telegram-apps/sdk';
   
2. 
   
3. openBiometrySettings();

复制代码

, [! g) T# `2 P