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. 
   
3. parseLaunchParams(
   
4.   new URLSearchParams([
   , D# h: x' Z% ?$ Q1 z
5.     ['tgWebAppVersion', '6.7'],
   
6.     ['tgWebAppPlatform', 'tdekstop'],
   & u$ H$ e, Q, f" I- J
7.     ['tgWebAppBotInline', '1'],
   
8.     ['tgWebAppData', new URLSearchParams([
   
9.       ['query_id', 'AAHdF6IQAAAAAN0XohAOqR8k'],
   
10.       ['user', JSON.stringify({
    1 h. {5 |4 ]9 Q6 n8 G9 j
11.         id: 279058397,
    
12.         first_name: 'Vladislav',
    , E* y0 r: g( v" l5 q/ e+ e
13.         last_name: 'Kibenko',
    
14.         username: 'vdkfrost',
    
15.         language_code: 'ru',
    
16.         is_premium: true,
    
17.         allows_write_to_pm: true,
    $ `. w0 r" Q+ a
18.       })],
    ; J" r0 w( D% |& y' ^
19.       ['auth_date', '1691441944'],
    
20.       ['hash', 'abc'],
    + S. F8 ~2 \, T3 l; V4 t
21.     ]).toString()],
    0 F8 W+ A; I" N1 H( [
22.     ['tgWebAppThemeParams', JSON.stringify({
    8 E1 ]* w/ R5 B; C5 F! P: D
23.       bg_color: '#17212b',
    
24.       button_color: '#5288c1',
    
25.       button_text_color: '#ffffff',
    , O6 T8 r& z+ v% F- P
26.       hint_color: '#708499',
    4 Z, U1 ^, q9 }; C1 @, D# f
27.       link_color: '#6ab3f3',
    
28.       secondary_bg_color: '#232e3c',
    % J1 e( r) c) ~- _% h6 e
29.       text_color: '#f5f5f5',
    
30.     })],
    
31.   ]),
    2 n4 i# Z. T  _: j& F4 ]9 `% ^
32. );

复制代码

Expected Result :

1. const result = {
   0 a& l/ H0 M& e' c: M" ]5 i
2.   botInline: true,
   
3.   version: '6.7',
   & h! U8 C7 U' F
4.   platform: 'tdesktop',
   ' i1 ]9 g, L3 T" B" C, j
5.   themeParams: {
   
6.     bgColor: '#17212b',
   6 \! [% G8 D, X, v- p
7.     buttonColor: '#5288c1',
   
8.     buttonTextColor: '#ffffff',
   
9.     hintColor: '#708499',
   
10.     linkColor: '#6ab3f3',
    
11.     secondaryBgColor: '#232e3c',
    
12.     textColor: '#f5f5f5',
    : {1 j0 g+ e8 A) Q9 f0 G7 |
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',
    ; v2 `- M/ f8 W# Z
15.   initData: {
    
16.     queryId: 'AAHdF6IQAAAAAN0XohAOqR8k',
    
17.     authDate: new Date(1691441944000),
    9 Q# t3 e0 W0 @8 }+ a& ^
18.     hash: 'abc',
    
19.     user: {
    ( `/ }- ^1 i% K/ t. h, P5 O
20.       id: 279058397,
    
21.       firstName: 'Vladislav',
    
22.       lastName: 'Kibenko',
    
23.       username: 'vdkfrost',
    3 y* q, W" U3 J4 {2 ?7 f7 P
24.       languageCode: 'ru',
    ( B; q6 D9 u9 l& x+ }
25.       isPremium: true,
    : l0 o! t9 |) Q0 G! J
26.       allowsWriteToPm: true,
    " o( e. {. i. ^0 s
27.     },
    
28.   },
    0 ?& J( k: ~) ]/ ~* u
29. };

复制代码

序列化​

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

1. import { serializeLaunchParams } from '@telegram-apps/sdk';
   , j' u# ^, Q+ P' {& z0 W. }
2. 
   
3. serializeLaunchParams({
   8 k% N8 V9 A* G4 r) f
4.   version: '6.7',
   8 T* k0 q5 i/ T: _
5.   platform: 'tdesktop',
   
6.   themeParams: {
   
7.     bgColor: '#17212b',
   
8.     buttonColor: '#5288c1',
   
9.     buttonTextColor: '#ffffff',
   
10.     hintColor: '#708499',
    
11.     linkColor: '#6ab3f3',
    
12.     secondaryBgColor: '#232e3c',
    1 }$ U( E: d/ q3 }
13.     textColor: '#f5f5f5',
    
14.   },
    
15. });
    . @: z5 w6 |3 C0 Z" Y+ H
16. 
    . Q" Z: ^$ b* q3 s7 d3 G1 ]/ D
17. // Result:
    5 j& L5 W( \8 q, o1 \
18. // tgWebAppVersion=6.7
    , ]- X' d$ j" H, t& s( J( }
19. // &tgWebAppPlatform=tdesktop
    
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. 
   
3. const launchParams = retrieveLaunchParams();

复制代码

) E( y* ?0 P2 Q