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

riyad

生物统计学​

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

检查支持​

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

Variable :

1. import { biometry } from '@telegram-apps/sdk';
   & t) `+ O. I; R# x+ b% G
2. 
   
3. biometry.isSupported(); // boolean

复制代码

Functions :

1. import { isBiometrySupported } from '@telegram-apps/sdk';
   
2. 
   
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
   
6.   biometry.isMounted(); // true
   
7. } catch (err) {
   
8.   biometry.mountError(); // equals "err"
   : a8 I" F4 z$ O) J- n: x* L! `5 Z
9.   biometry.isMounting(); // false
   
10.   biometry.isMounted(); // false
    
11. }

复制代码

Functions :

1. import {
   
2.   mountBiometry,
   " p" m; J4 m# i  {
3.   isBiometryMounting,
   
4.   isBiometryMounted,
   $ g; V% r+ s  I
5.   biometryMountError,
   
6. } from '@telegram-apps/sdk';
   
7. 
   
8. try {
   " Y) q0 A% q* o( M4 l) |
9.   const promise = mountBiometry();
   ; Z1 E  X3 f  h
10.   isBiometryMounting(); // true
    ; P! q& `% l, w
11.   await promise;
    : T$ m3 Q* y4 M1 M: T
12.   isBiometryMounting(); // false
    + U% V; m% D/ S' J; `
13.   isBiometryMounted(); // true
    
14. } catch (err) {
    
15.   biometryMountError(); // equals "err"
    
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. 
   8 w# r& g0 N" M- a/ m* g+ o! }
3. unmountBiometry();
   
4. isBiometryMounted(); // false

复制代码

申请生物测量访问​

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

Variable :

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

复制代码

Functions :

1. import { requestBiometryAccess } from '@telegram-apps/sdk';
   
2. 
   
3. const granted = await requestBiometryAccess(); // boolean

复制代码

认证​

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

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

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

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

Variable :

1. const { status, token } = await biometry.authenticate({
   
2.   reason: 'Please!',
   + `3 X! I3 W% e& e! G1 S$ f
3. });
   
4. 
   
5. if (status === 'authorized') {
   
6.   console.log(`Authorized. Token: ${token}`);
     f, s' [2 A3 e: R8 [. A/ w. A
7. } else {
   & \* c; T% d8 q0 P
8.   console.log('Not authorized');
   2 T; s! S$ G( q0 g$ f+ q
9. }

复制代码

Functions :

1. import { authenticateBiometry } from '@telegram-apps/sdk';
   ) t7 I- ?4 M9 G/ r
2. 
   1 B* M9 b0 T$ P( |+ {& l$ i$ Y
3. const { status, token } = await authenticateBiometry({
   
4.   reason: 'Please!',
   
5. });
   + O; E$ s4 _/ t' T3 T. [4 [/ q
6. 
   : s  Y. _6 `2 I7 k
7. if (status === 'authorized') {
   7 ^8 m& q% M2 ~2 L
8.   console.log(`Authorized. Token: ${token}`);
   
9. } else {
   
10.   console.log('Not authorized');
    % X3 O$ H0 _, @, |3 G6 J* H# E
11. }

复制代码

更新令牌​

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

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

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

Variable :

1. const updated = await biometry.updateToken({
   # @/ b& s; Z7 `8 h7 c# K" C
2.   reason: 'Want to delete',
   
3. });
   1 H0 e- E9 H' [; F7 c
4. 
   - H: ?$ N: \6 {* m  H2 F3 T# T  u
5. await biometry.updateToken({
   ( r" s' o+ R" c5 g' a% Y+ p: D
6.   reason: 'Will set a new one',
   
7.   token: 'new token',
   * ^8 ^+ F3 V8 `
8. });

复制代码

Functions :

1. import { updateBiometryToken } from '@telegram-apps/sdk';
   9 C5 P1 f$ G: z5 q: _
2. 
   - U# f  U4 j4 h% E* g3 o
3. const updated = await updateBiometryToken({
   
4.   reason: 'Want to delete',
   
5. });
   & O( ~& [/ ^% k% j' I  o& |
6. 
   
7. await updateBiometryToken({
   7 W) y1 l5 X9 h6 F% z% d# I8 `
8.   reason: 'Will set a new one',
   
9.   token: 'new token',
   ! p+ l1 X& R$ j2 N
10. });

复制代码

打开设置​

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

Variable :

1. biometry.openSettings();

复制代码

Functions :

1. import { openBiometrySettings } from '@telegram-apps/sdk';
   
2. 
   1 x5 S8 T# q0 C$ B# {
3. openBiometrySettings();

复制代码

( }4 g* H6 l5 \, Z