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

riyad

初始数据​

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

恢复​

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

Variable :

1. import { initData } from '@telegram-apps/sdk';
   
2. 
     c2 Q/ Q7 N- c. S2 N) k% e6 S
3. initData.restore();

复制代码

Functions :

1. import { restoreInitData } from '@telegram-apps/sdk';
   
2. 
   $ i$ Y: N" y9 R% O
3. restoreInitData();

复制代码

解析​

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

1. import { parseInitData } from '@telegram-apps/sdk';
   
2. 
   
3. const initData = parseInitData();
   $ x4 u. u3 k$ ?0 y# y0 o7 m. B
4. // {
   * q1 |; V) [7 t4 B. c% r2 [
5. //   user: {
   2 U+ B: j2 j/ M. x& Y6 ?
6. //     id: 99281932,
   " e7 ^: T! |3 o
7. //     firstName: 'Andrew',
   
8. //     lastName: 'Rogue',
   
9. //     username: 'rogue',
   
10. //     languageCode: 'en',
    
11. //     isPremium: true,
    / W0 }  p% n2 p6 G
12. //     allowsWriteToPm: true,
    
13. //   },
    0 u1 M+ X) ~: T
14. //   hash: 'abcedef123',
    
15. //   authDate: Date(1716922846000),
    $ r/ j3 \# o* V% h  ]) C8 [# H
16. //   startParam: 'debug',
    
17. //   chatType: 'sender',
    
18. //   chatInstance: '8428209589180549439',
    ' o2 W  S! c0 u* S) _! }
19. // };

复制代码

该函数返回 init data 对象 ，其中包含深驼峰型属性。
8 D+ j8 O8 |! E7 r* o信号​

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

authDate​

返回类型：Date | undefined

初始化数据的创建日期。

Variable :

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

复制代码

Functions :

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

复制代码

canSendAfter​

返回类型：number | undefined

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

Variable :

1. initData.canSendAfter(); // 3600

复制代码

Functions :

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

复制代码

canSendAfterDate​

返回类型：Date | undefined

canSendAfter，但作为日期。

Variable :

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

复制代码

Functions :

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

复制代码

chat​

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

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

NOTE

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

Variable :

1. initData.chat();
   % q& ?+ D+ Q& t, ^" ~/ q1 a
2. // {
   3 g. D" o0 \1 K5 m, O
3. //   id: 7728725378876215,
   " s& |; m2 \" a1 e# k3 B4 p7 U
4. //   type: 'group',
   5 Z; V# M# r+ @7 t
5. //   title: '@BotFather',
   8 A9 }  A4 W0 g0 s& G
6. //   photoUrl: 'https://example.com/image.png',
   
7. //   username: 'botfather'
   7 P# g5 y( D% ?; D
8. // }

复制代码

Functions :

1. import { initDataChat } from '@telegram-apps/sdk';
   
2. 
   
3. initDataChat();
   7 [- k) {, L' [, H4 ?
4. // {
   % e, B8 V6 p7 M$ ]( M. H* r- n
5. //   id: 7728725378876215,
   
6. //   type: 'group',
   
7. //   title: '@BotFather',
   
8. //   photoUrl: 'https://example.com/image.png',
   
9. //   username: 'botfather'
   2 t1 Z' [6 p5 E
10. // }

复制代码

chatType​

返回类型：string | undefined

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

• sender
• private
• group
• supergroup
• channel
  . |. K3 m+ H1 W- @

: S4 [( i8 U9 t+ h5 e) y8 Z3 f

NOTE

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

Variable :

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

复制代码

Functions :

1. import { initDataChatType } from '@telegram-apps/sdk';
   " H2 }1 [9 u6 k$ H6 O1 Q
2. 
   
3. initDataChatType(); // 'group'

复制代码

chatInstance​

返回类型：string | undefined

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

WARNING

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

8 A4 X5 s8 [. d% f1 a

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';
   % m9 d4 @0 q8 i! I8 k( Z
2. 
   $ B! ~0 r4 g! B, P
3. initDataHash(); // 'sgbbc62g3bvdhg3djsaasd'

复制代码

queryId​

返回类型：string | undefined

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

Variable :

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

复制代码

Functions :

1. import { initDataQueryId } from '@telegram-apps/sdk';
   
2. 
   . m# z% G  i( \; W
3. initDataQueryId(); // 'ssVXZ231ger'

复制代码

返回类型：string | undefined

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

Variable :

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

复制代码

Functions :

1. import { initDataRaw } from '@telegram-apps/sdk';
   8 T) f( o& }3 J% i) }
2. 
   
3. initDataRaw(); // 'user=...&chat=...&...'

复制代码

receiver​

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

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

NOTE

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

Variable :

1. initData.user();
   
2. // {
   
3. //   addedToAttachmentMenu: false,
   & |" R3 U1 a  u" V
4. //   allowsWriteToPm: true,
     I6 y' a9 s$ f
5. //   isPremium: true,
   
6. //   firstName: 'Pavel',
   / L3 h& x* i, k6 U: s) H* R- a+ p+ w
7. //   id: 78262681,
   
8. //   isBot: false,
   
9. //   lastName: 'Durov',
   ! M) [) S) p0 M8 E; t& A- R2 s, f
10. //   languageCode: 'ru',
    9 E( O6 v7 G( Z/ G
11. //   photoUrl: 'https://example.com/image.png',
    9 k2 C& L1 X/ C+ a
12. //   username: 'durove',
    
13. // }

复制代码

Functions :

1. import { initDataUser } from '@telegram-apps/sdk';
   
2. 
   
3. initDataUser();
   
4. // {
   4 c5 `& q% W7 ]* e# Z  s5 u. I, D& Q' |9 `
5. //   addedToAttachmentMenu: false,
   
6. //   allowsWriteToPm: true,
   
7. //   isPremium: true,
   
8. //   firstName: 'Pavel',
   * S# I! D* j7 y2 M
9. //   id: 78262681,
   
10. //   isBot: false,
    
11. //   lastName: 'Durov',
    
12. //   languageCode: 'ru',
    - s+ i5 ]+ q, t( r- a" ]$ B
13. //   photoUrl: 'https://example.com/image.png',
    
14. //   username: 'durove',
    , k& o8 P! _$ x+ G2 Z$ S
15. // }

复制代码

state​

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

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

Variable :

1. initData.state();

复制代码

Functions :

1. import { initDataState } from '@telegram-apps/sdk';
   0 J6 T( K# ~0 n' n5 x! M9 L
2. 
   ; [/ y( u2 B: \$ m# d* a1 v
3. initDataState();

复制代码

startParam​

返回类型：string | undefined

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

Variable :

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

复制代码

Functions :

1. import { initDataStartParam } from '@telegram-apps/sdk';
   
2. 
   , h( [2 s5 G( @" V# r
3. initDataStartParam(); // 'my-value'

复制代码

user​

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

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

Variable :

1. initData.user();
   9 ^; i: w  I. s% z/ D. g# P+ l* H* G
2. // {
   
3. //   addedToAttachmentMenu: false,
   
4. //   allowsWriteToPm: true,
   
5. //   isPremium: true,
   / g, A5 {* x* _# D6 Z' Z5 o
6. //   firstName: 'Pavel',
   
7. //   id: 78262681,
   ; U; x, w$ j) X7 {
8. //   isBot: false,
   % `# b$ @+ [1 {" x5 A
9. //   lastName: 'Durov',
   , }' e* t3 c0 P' m
10. //   languageCode: 'ru',
    
11. //   photoUrl: 'https://example.com/image.png',
    
12. //   username: 'durove',
    
13. // }

复制代码

Functions :

1. import { initDataUser } from '@telegram-apps/sdk';
   
2. 
   9 k* z* E* L* N- H$ `+ P) a
3. initDataUser();
   ; _$ e  ~: P2 N6 R9 q8 G( r
4. // {
   & f" [- |0 R# _7 x8 A
5. //   addedToAttachmentMenu: false,
   
6. //   allowsWriteToPm: true,
   
7. //   isPremium: true,
   
8. //   firstName: 'Pavel',
   + g, s7 n! D- |3 x9 Z' s
9. //   id: 78262681,
   
10. //   isBot: false,
    . G2 V' u' C9 [, q- `& b# u
11. //   lastName: 'Durov',
    
12. //   languageCode: 'ru',
    2 T- W% l7 \8 I# U4 |
13. //   photoUrl: 'https://example.com/image.png',
    
14. //   username: 'durove',
    9 L8 T1 U3 X5 z0 s. u
15. // }

复制代码