Telegram 小程序 | TypeScript @telegram-apps/sdk @2.x | 组件 | 初始数据

riyad

初始数据​

负责 Telegram Mini Apps init data 的💠组件。

( @+ s% K1 W3 c7 P5 Q5 [恢复​

要恢复组件状态，请使用 restore 方法。

Variable :

1. import { initData } from '@telegram-apps/sdk';
   
2. 
   3 ~" x. s- ^0 o4 I; d5 H
3. initData.restore();

复制代码

Functions :

1. import { restoreInitData } from '@telegram-apps/sdk';
   % o9 M, Y1 h; a
2. 
   
3. restoreInitData();

复制代码

解析​

要将值解析为初始数据，请使用 parseInitData 函数。

1. import { parseInitData } from '@telegram-apps/sdk';
   ( x2 r+ ^' k" ]! q6 N: \5 c/ E
2. 
   * P) U+ z- v1 M, i* r8 D
3. const initData = parseInitData();
   
4. // {
   4 T* x! T2 y2 ^- T& u! N( g
5. //   user: {
   
6. //     id: 99281932,
   2 q5 _, e! N  l" G& a% x
7. //     firstName: 'Andrew',
   5 l" H! c, L3 @3 E+ _3 V6 t6 \
8. //     lastName: 'Rogue',
   
9. //     username: 'rogue',
   - S) `* y8 c. A, u
10. //     languageCode: 'en',
    
11. //     isPremium: true,
    ( D, C+ i" y# T' r* ]! a
12. //     allowsWriteToPm: true,
    
13. //   },
    
14. //   hash: 'abcedef123',
    
15. //   authDate: Date(1716922846000),
    
16. //   startParam: 'debug',
    3 G5 y  h3 x9 X; f
17. //   chatType: 'sender',
    
18. //   chatInstance: '8428209589180549439',
    
19. // };

复制代码

该函数返回 init data 对象 ，其中包含深驼峰型属性。
信号​

本节提供了与启动数据有关的信号的完整列表。

authDate​

返回类型：Date | undefined

初始化数据的创建日期。

Variable :

1. initData.authDate(); // Date(1727368894000)

复制代码

Functions :

1. import { initDataAuthDate } from '@telegram-apps/sdk';
   " H2 [3 c5 X  d6 V* y
2. 
   ( P# p  }, U  f/ T9 H$ S6 r1 E
3. initDataAuthDate(); // Date(1727368894000)

复制代码

canSendAfter​

返回类型：number | undefined

通过 方法 answerWebAppQuery 发送信息的秒数。

Variable :

1. initData.canSendAfter(); // 3600

复制代码

Functions :

1. import { initDataCanSendAfter } from '@telegram-apps/sdk';
   
2. 
   , h* v* g0 a" Q( Z- A) Z5 K$ ^+ }: V8 ^
3. initDataAuthDate(); // 3600

复制代码

canSendAfterDate​

返回类型：Date | undefined

canSendAfter，但作为日期。

Variable :

1. initData.canSendAfterDate(); // Date(1727368897600)

复制代码

Functions :

1. import { initDataCanSendAfterDate } from '@telegram-apps/sdk';
   
2. 
   8 F0 X/ s3 S, z* p
3. initDataCanSendAfterDate(); // Date(1727368897600)

复制代码

chat​

返回类型：undefined 或 Chat，带驼峰形 属性。

包含通过附件菜单启动机器人的聊天数据的对象。

NOTE

返回超级群组、频道和群组聊天记录 - 仅适用于通过 附件菜单启动的迷你应用程序。

Variable :

1. initData.chat();
   . f$ G! h6 u+ E$ ]" U0 u$ k
2. // {
   . i1 {, l4 Q2 J5 h. V$ E7 _0 v0 W
3. //   id: 7728725378876215,
     ?1 N: `0 z! h3 Y4 _
4. //   type: 'group',
   ) E9 {8 [( C/ r/ }4 c* ], M
5. //   title: '@BotFather',
   
6. //   photoUrl: 'https://example.com/image.png',
   
7. //   username: 'botfather'
   ! z- f  R9 U3 w# D* M- I6 j/ h# _- L
8. // }

复制代码

Functions :

1. import { initDataChat } from '@telegram-apps/sdk';
   
2. 
   
3. initDataChat();
   9 Y. Y5 O- Z0 ?. t# x& v
4. // {
   3 S/ p9 u9 V& b$ d0 B! l/ ]
5. //   id: 7728725378876215,
   8 M- m4 {+ I; X4 ^0 \) W
6. //   type: 'group',
   4 a# Z0 f+ }- w- L, m0 ]
7. //   title: '@BotFather',
   9 D9 t7 k9 ]. R' b7 a
8. //   photoUrl: 'https://example.com/image.png',
   
9. //   username: 'botfather'
   ! y) Q# I* x' z! G7 U
10. // }

复制代码

chatType​

返回类型：string | undefined

打开迷你应用程序的聊天类型。 值：

• sender
• private
• group
• supergroup
• channel
  7 w/ @9 z8 k, c6 T- E

NOTE

仅返回通过直接链接打开的申请

Variable :

1. initData.chatType(); // 'group'

复制代码

Functions :

1. import { initDataChatType } from '@telegram-apps/sdk';
   ; |- u3 N, R6 `& e
2. 
   
3. initDataChatType(); // 'group'

复制代码

chatInstance​

返回类型：string | undefined

全局标识符，表示打开迷你应用的聊天窗口。

WARNING

仅返回通过直接链接打开的应用程序。

Variable :

1. initData.chatInstance(); // 'group'

复制代码

Functions :

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

复制代码

hash​

返回类型：string | undefined

初始化数据签名。

Variable :

1. initData.hash(); // 'group'

复制代码

Function :

1. import { initDataHash } from '@telegram-apps/sdk';
   $ V& `: W  h) v) A2 b% C; u) F5 I; `
2. 
   9 S3 a6 E- i& x' [
3. initDataHash(); // 'sgbbc62g3bvdhg3djsaasd'

复制代码

queryId​

返回类型：string | undefined

迷你应用程序的唯一会话 ID。 在 通过 方法 answerWebAppQuery 发送信息的过程中使用。

Variable :

1. initData.queryId(); // 'group'

复制代码

Functions :

1. import { initDataQueryId } from '@telegram-apps/sdk';
   7 s+ j8 \- T, z6 r; h; }  G# S+ u
2. 
   
3. initDataQueryId(); // 'ssVXZ231ger'

复制代码

返回类型：string | undefined

初始化数据的原始字符串。

Variable :

1. initData.raw(); // 'user=...&chat=...&...'

复制代码

Functions :

1. import { initDataRaw } from '@telegram-apps/sdk';
   0 @; W0 J# Z2 V9 B% @5 ^9 M3 _$ I+ {
2. 
   
3. initDataRaw(); // 'user=...&chat=...&...'

复制代码

receiver​

返回类型：undefined 或 User，带驼峰形 属性。

一个对象，包含当前用户在 聊天时的聊天伙伴数据，机器人是通过附件菜单启动的。

NOTE

仅对私人聊天和通过附件菜单启动的迷你应用程序返回。

Variable :

1. initData.user();
   # g# F/ {( z' Z4 ]
2. // {
   
3. //   addedToAttachmentMenu: false,
     P. ?. V  V3 R  `
4. //   allowsWriteToPm: true,
   6 b# e( w" P9 S1 ?; V" D+ }% A- h0 Z
5. //   isPremium: true,
   
6. //   firstName: 'Pavel',
   , u: A1 ~) f( _5 S
7. //   id: 78262681,
   
8. //   isBot: false,
   0 |% I& C3 H* r
9. //   lastName: 'Durov',
   
10. //   languageCode: 'ru',
    6 X9 e% g0 ?1 E: s* x- @* F
11. //   photoUrl: 'https://example.com/image.png',
    ; {: u/ A! e& F
12. //   username: 'durove',
    
13. // }

复制代码

Functions :

1. import { initDataUser } from '@telegram-apps/sdk';
   
2. 
   
3. initDataUser();
   
4. // {
   
5. //   addedToAttachmentMenu: false,
     }# k/ s, E  K+ V' n0 k: U2 v5 F- D
6. //   allowsWriteToPm: true,
   9 @9 v: u' Y. V: h4 ~
7. //   isPremium: true,
   , P8 c5 J: ^  R$ J
8. //   firstName: 'Pavel',
   # [' e4 Z8 p- c6 j: c7 g
9. //   id: 78262681,
   ( w! |) X! h, o9 q* K' v: Q
10. //   isBot: false,
    
11. //   lastName: 'Durov',
    $ Y" P* _- c& r7 J0 d
12. //   languageCode: 'ru',
    
13. //   photoUrl: 'https://example.com/image.png',
    
14. //   username: 'durove',
    
15. // }

复制代码

state​

返回类型：undefined 或 InitData，带有 深驼峰型属性。

包含对象格式初始化数据的对象。

Variable :

1. initData.state();

复制代码

Functions :

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

复制代码

startParam​

返回类型：string | undefined

链接中指定的 startattach 或 startapp 查询参数的值。

Variable :

1. initData.startParam(); // 'my-value'

复制代码

Functions :

1. import { initDataStartParam } from '@telegram-apps/sdk';
   
2. 
   % g" }4 j; t" F& D) e( F0 L, @2 F
3. initDataStartParam(); // 'my-value'

复制代码

user​

返回类型：undefined 或 User，带驼峰形 属性。

包含当前用户信息的对象。

Variable :

1. initData.user();
   
2. // {
   7 A3 y; [8 h/ I! o
3. //   addedToAttachmentMenu: false,
   
4. //   allowsWriteToPm: true,
   ( t' s3 l9 d3 G* _7 I
5. //   isPremium: true,
   
6. //   firstName: 'Pavel',
   
7. //   id: 78262681,
   2 i" F% P3 L* J) P, ~
8. //   isBot: false,
   
9. //   lastName: 'Durov',
   
10. //   languageCode: 'ru',
    
11. //   photoUrl: 'https://example.com/image.png',
    
12. //   username: 'durove',
    ( f8 c9 \4 I9 `7 M4 M5 y% {
13. // }

复制代码

Functions :

1. import { initDataUser } from '@telegram-apps/sdk';
   5 x3 x7 X- j6 T2 K
2. 
   
3. initDataUser();
   
4. // {
   ; Z" m, _3 P% H) v0 p2 w! Q* w7 f
5. //   addedToAttachmentMenu: false,
   8 b3 F, q" D$ M% z0 K
6. //   allowsWriteToPm: true,
   
7. //   isPremium: true,
   : y" _& x- v$ ]5 i9 R0 H9 R1 I  R  ?
8. //   firstName: 'Pavel',
   
9. //   id: 78262681,
   7 Q, j( y# y8 F2 K. o% {0 }
10. //   isBot: false,
    % K6 i/ j8 I1 l2 @4 g; K$ y
11. //   lastName: 'Durov',
    0 e; N: ~. A, z/ Y
12. //   languageCode: 'ru',
    # }# _' A3 _4 F+ w
13. //   photoUrl: 'https://example.com/image.png',
    % e) L/ E: B. V# \) X
14. //   username: 'durove',
    
15. // }

复制代码

5 C/ ]. D6 Y& S, Y% R' ?6 Q$ {

/ J8 ^) y& t$ [; G+ i