Telegram 小程序 | TypeScript @telegram-apps/sdk @1.x | 启动参数

riyad

启动参数​

本节 SDK 涵盖与 launch parameters 相关的主题。

解析​

要解析作为启动参数的值，软件包提供了 parseLaunchParams 方法。 方法接受以字符串或 URLSearchParams 实例形式呈现的查询参数，并返回 LaunchParams 接口。 如果传递的数据无效，则会出错。

Usage Example :

1. import { parseLaunchParams, launchParamsParser } from '@telegram-apps/sdk';
   
2. 
   1 D. @2 U" I2 u3 z0 Z1 L
3. parseLaunchParams(
   
4.   new URLSearchParams([
   ! M! j; j' D: |& n
5.     ['tgWebAppVersion', '6.7'],
   
6.     ['tgWebAppPlatform', 'tdekstop'],
   & I2 A3 u# {3 y! L, u6 m
7.     ['tgWebAppBotInline', '1'],
   
8.     ['tgWebAppData', new URLSearchParams([
   
9.       ['query_id', 'AAHdF6IQAAAAAN0XohAOqR8k'],
   
10.       ['user', JSON.stringify({
    
11.         id: 279058397,
    
12.         first_name: 'Vladislav',
    8 T* r4 w, z% G2 k7 f8 c  c% k
13.         last_name: 'Kibenko',
    
14.         username: 'vdkfrost',
    2 O, e' B6 [! x3 g
15.         language_code: 'ru',
    
16.         is_premium: true,
    8 U6 j. h& i+ [; F$ ^2 ]2 M
17.         allows_write_to_pm: true,
    
18.       })],
    9 J2 ^4 E: Z% e' }( ?9 p
19.       ['auth_date', '1691441944'],
    7 V/ _# u8 \  X" @' ^8 ]4 G% j
20.       ['hash', 'abc'],
    + s1 ~0 M. h5 k( S2 a! R+ s1 N6 n) t
21.     ]).toString()],
    
22.     ['tgWebAppThemeParams', JSON.stringify({
    
23.       bg_color: '#17212b',
    
24.       button_color: '#5288c1',
    3 f' }0 f0 z7 k7 F7 c; H
25.       button_text_color: '#ffffff',
    
26.       hint_color: '#708499',
    
27.       link_color: '#6ab3f3',
    
28.       secondary_bg_color: '#232e3c',
    2 X# X& q; ?# i3 s4 t8 d4 @+ R' d
29.       text_color: '#f5f5f5',
    
30.     })],
    # C1 e- U) z+ I
31.   ]),
    + J" V0 k7 a$ S6 ~, G
32. );

复制代码

Expected Result :

1. const result = {
   
2.   botInline: true,
   4 ~- B% F1 t1 [
3.   version: '6.7',
   
4.   platform: 'tdesktop',
   - x) o8 }' S; y
5.   themeParams: {
   & {! |) C# E* q
6.     bgColor: '#17212b',
   
7.     buttonColor: '#5288c1',
   3 W4 P* F4 {7 M1 |
8.     buttonTextColor: '#ffffff',
   
9.     hintColor: '#708499',
   
10.     linkColor: '#6ab3f3',
    # j9 S5 @! C3 H
11.     secondaryBgColor: '#232e3c',
    
12.     textColor: '#f5f5f5',
    / X: Q/ F% x* @" r, g
13.   },
    
14.   initDataRaw: 'query_id=AAHdF6IQAAAAAN0XohAOqR8k&user=%7B%22id%22%3A279058397%2C%22first_name%22%3A%22Vladislav%22%2C%22last_name%22%3A%22Kibenko%22%2C%22username%22%3A%22vdkfrost%22%2C%22language_code%22%3A%22ru%22%2C%22is_premium%22%3Atrue%2C%22allows_write_to_pm%22%3Atrue%7D&auth_date=1691441944&hash=abc',
    8 L% `' ^: N# R4 o7 f% D: J) B. g
15.   initData: {
    ! m. O7 T5 l0 S% }
16.     queryId: 'AAHdF6IQAAAAAN0XohAOqR8k',
    
17.     authDate: new Date(1691441944000),
    ; _8 D" \: R" P( j0 Q! _8 e
18.     hash: 'abc',
    # M4 E0 J; a+ h) o- {$ H8 M* R4 \
19.     user: {
    
20.       id: 279058397,
    
21.       firstName: 'Vladislav',
    " M6 H# g; f' M0 L# I
22.       lastName: 'Kibenko',
    " U% `2 R3 R) P4 g; O
23.       username: 'vdkfrost',
    5 ?8 Q/ Y6 U' F
24.       languageCode: 'ru',
    
25.       isPremium: true,
    
26.       allowsWriteToPm: true,
    
27.     },
    3 _" M7 ]/ k+ X6 d8 Z. I, s
28.   },
    6 D' \% ?- A$ g$ h
29. };

复制代码

序列化​

要将启动参数对象表示转换为字符串，开发人员应使用 的 serializeLaunchParams 函数：

1. import { serializeLaunchParams } from '@telegram-apps/sdk';
   / @8 }8 c* u: u( F
2. 
   
3. serializeLaunchParams({
   8 e9 U" l2 R) P' ~1 Z# l* p
4.   version: '6.7',
   
5.   platform: 'tdesktop',
   % w/ E3 d$ c5 F$ e7 f; y* e% V9 _! C
6.   themeParams: {
   
7.     bgColor: '#17212b',
   
8.     buttonColor: '#5288c1',
   
9.     buttonTextColor: '#ffffff',
   " I+ z" l9 s6 o2 c& F3 Z
10.     hintColor: '#708499',
    * l0 k) P! z) P$ D9 h
11.     linkColor: '#6ab3f3',
    
12.     secondaryBgColor: '#232e3c',
    
13.     textColor: '#f5f5f5',
    
14.   },
    5 k5 z' K  f" ]* c% y) s
15. });
    
16. 
    ) u0 N0 i* }/ [  w
17. // Result:
    
18. // tgWebAppVersion=6.7
    % b) n5 w8 }4 m; q4 J
19. // &tgWebAppPlatform=tdesktop
    ! `8 w& q  g+ C5 c+ k
20. // &tgWebAppThemeParams=%7B%22bg_color%22%3A%22%2317212b%22%2C%22button_color%22%3A%22%235288c1%22%2C%22button_text_color%22%3A%22%23ffffff%22%2C%22hint_color%22%3A%22%23708499%22%2C%22link_color%22%3A%22%236ab3f3%22%2C%22secondary_bg_color%22%3A%22%23232e3c%22%2C%22text_color%22%3A%22%23f5f5f5%22%7D

复制代码

检索​

该软件包可使用 的 retrieveLaunchParams 函数从当前环境中提取启动参数。 如果所有已知数据源都包含无效数据，则 会抛出错误。

1. import { retrieveLaunchParams } from '@telegram-apps/sdk';
   
2. 
   : t& f8 i( N# G+ m! E* }  A8 r
3. const launchParams = retrieveLaunchParams();

复制代码

" N9 C$ V; c! Y$ r1 p# X* S