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

riyad

初始数据​

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

恢复​

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

Variable :

1. import { initData } from '@telegram-apps/sdk';
   % o7 U7 S6 z  J, C
2. 
   
3. initData.restore();

复制代码

Functions :

1. import { restoreInitData } from '@telegram-apps/sdk';
   , x5 O+ i9 f0 B
2. 
   
3. restoreInitData();

复制代码

解析​

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

1. import { parseInitData } from '@telegram-apps/sdk';
   : N, C1 T  K- H' n0 g2 V4 r5 n
2. 
   ; e/ {9 p, u5 d) s
3. const initData = parseInitData();
   
4. // {
   
5. //   user: {
   
6. //     id: 99281932,
   ( ^- K1 V! c' ]$ Z  B7 N0 d
7. //     firstName: 'Andrew',
   ( I6 v3 I  n$ q! J
8. //     lastName: 'Rogue',
   
9. //     username: 'rogue',
   
10. //     languageCode: 'en',
    
11. //     isPremium: true,
    4 ~* R# E$ r2 ^7 Y+ t5 h8 {- m: D
12. //     allowsWriteToPm: true,
    
13. //   },
    
14. //   hash: 'abcedef123',
    $ N& O' [% c8 F+ x, V- e
15. //   authDate: Date(1716922846000),
    
16. //   startParam: 'debug',
    , I$ n" X9 ?7 g
17. //   chatType: 'sender',
    
18. //   chatInstance: '8428209589180549439',
    0 S7 }1 ~# X* w5 V' c2 Y$ P
19. // };

复制代码

该函数返回 init data 对象 ，其中包含深驼峰型属性。
" M3 Q( e2 M7 A9 g' c信号​

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

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. 
   + x6 h. p( j5 E* T) B* k3 B+ z
3. initDataCanSendAfterDate(); // Date(1727368897600)

复制代码

chat​

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

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

NOTE

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

Variable :

1. initData.chat();
   
2. // {
   6 X! O! T# }: E) h( W- s- [3 I
3. //   id: 7728725378876215,
   
4. //   type: 'group',
   5 M% G1 S! b) l) N8 [6 D$ ]' x6 g6 F
5. //   title: '@BotFather',
   
6. //   photoUrl: 'https://example.com/image.png',
   . U3 N6 M7 j) ]7 _1 P5 o
7. //   username: 'botfather'
   # H! C7 d# {6 ]# g
8. // }

复制代码

Functions :

1. import { initDataChat } from '@telegram-apps/sdk';
   % \. k6 q+ U# ?: [) a+ t2 F, g
2. 
   
3. initDataChat();
   4 q6 S3 _) H, ^# K+ u/ O- I
4. // {
   3 U$ d3 }& V  A# x
5. //   id: 7728725378876215,
   
6. //   type: 'group',
   $ X& [0 R1 t' O" @2 u
7. //   title: '@BotFather',
   ' e' G2 x9 v% N5 K! v! _' I
8. //   photoUrl: 'https://example.com/image.png',
   . p2 ]+ P# H+ ~: N
9. //   username: 'botfather'
   + [6 Q7 K' n9 L. y' Z" u9 h6 u0 Q
10. // }

复制代码

chatType​

返回类型：string | undefined

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

• sender
• private
• group
• supergroup
• channel
  

6 p( k) w! e' D9 _) @; q

NOTE

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

Variable :

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

复制代码

Functions :

1. import { initDataChatType } from '@telegram-apps/sdk';
   5 @) s. |9 p6 ?: @9 w: k
2. 
   
3. initDataChatType(); // 'group'

复制代码

chatInstance​

返回类型：string | undefined

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

WARNING

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

Variable :

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

复制代码

Functions :

1. import { initDataChatInstance } from '@telegram-apps/sdk';
   9 K; H$ V- T5 d- M. S
2. 
   6 ]( E+ a' o8 s; G. h
3. initDataChatInstance(); // '899667289674387257'

复制代码

hash​

返回类型：string | undefined

初始化数据签名。

Variable :

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

复制代码

Function :

1. import { initDataHash } from '@telegram-apps/sdk';
   
2. 
   2 ^$ f3 ]. F/ y
3. initDataHash(); // 'sgbbc62g3bvdhg3djsaasd'

复制代码

queryId​

返回类型：string | undefined

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

Variable :

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

复制代码

Functions :

1. import { initDataQueryId } from '@telegram-apps/sdk';
   7 F( u  P' \& z8 p4 r
2. 
   9 Y2 p3 I6 l' k5 p3 z% L
3. initDataQueryId(); // 'ssVXZ231ger'

复制代码

返回类型：string | undefined

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

Variable :

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

复制代码

Functions :

1. import { initDataRaw } from '@telegram-apps/sdk';
   & [  G# v% g+ Y! P( ?" j
2. 
   
3. initDataRaw(); // 'user=...&chat=...&...'

复制代码

receiver​

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

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

NOTE

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

Variable :

1. initData.user();
   
2. // {
   
3. //   addedToAttachmentMenu: false,
   
4. //   allowsWriteToPm: true,
   
5. //   isPremium: true,
   
6. //   firstName: 'Pavel',
   # s2 z* K; P4 i' G
7. //   id: 78262681,
   8 U$ T% x7 D; [: u$ q8 C  u/ t
8. //   isBot: false,
   
9. //   lastName: 'Durov',
   & E/ U# _3 K! c, }9 j( m
10. //   languageCode: 'ru',
    
11. //   photoUrl: 'https://example.com/image.png',
    + Q9 p9 `* m0 f2 z2 C9 H8 K" N
12. //   username: 'durove',
    ( y4 F" S3 L& y4 y* ^  P8 X
13. // }

复制代码

Functions :

1. import { initDataUser } from '@telegram-apps/sdk';
   
2. 
   
3. initDataUser();
   2 E- ~0 v$ z$ F: ^- V1 a
4. // {
   + D3 H$ G# w" v
5. //   addedToAttachmentMenu: false,
   
6. //   allowsWriteToPm: true,
   6 ~: n$ S7 r- y- k9 I8 B" c
7. //   isPremium: true,
   ! C4 W7 B, o% s: l
8. //   firstName: 'Pavel',
   
9. //   id: 78262681,
   8 ]" G4 q) r$ d) d& g( e9 ]
10. //   isBot: false,
    
11. //   lastName: 'Durov',
    
12. //   languageCode: 'ru',
    
13. //   photoUrl: 'https://example.com/image.png',
    0 X  x" g& a7 O- A! B
14. //   username: 'durove',
    : K5 {+ h# \" f7 W: S- B0 a
15. // }

复制代码

state​

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

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

Variable :

1. initData.state();

复制代码

Functions :

1. import { initDataState } from '@telegram-apps/sdk';
   # N8 \: [4 k. Z" j' L1 }
2. 
   6 ?! o/ M, l5 i# z2 F* v
3. initDataState();

复制代码

startParam​

返回类型：string | undefined

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

Variable :

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

复制代码

Functions :

1. import { initDataStartParam } from '@telegram-apps/sdk';
   
2. 
   ( q7 u4 |& v  S3 Z  X
3. initDataStartParam(); // 'my-value'

复制代码

user​

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

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

Variable :

1. initData.user();
   
2. // {
   
3. //   addedToAttachmentMenu: false,
   & O3 x: s% i4 c* I1 O
4. //   allowsWriteToPm: true,
   4 F* ]- ?" I: L# x: P+ l7 d$ H; R, }: f
5. //   isPremium: true,
   
6. //   firstName: 'Pavel',
   
7. //   id: 78262681,
   5 f* F+ J4 R+ J' a' M9 M
8. //   isBot: false,
   
9. //   lastName: 'Durov',
   * T8 {! F2 _  a: C2 X3 ^  s
10. //   languageCode: 'ru',
    
11. //   photoUrl: 'https://example.com/image.png',
    
12. //   username: 'durove',
    
13. // }

复制代码

Functions :

1. import { initDataUser } from '@telegram-apps/sdk';
   
2. 
   
3. initDataUser();
   
4. // {
   / ?/ x6 I4 O$ s  I% e7 m* B4 N) ]; R
5. //   addedToAttachmentMenu: false,
   0 R+ ~+ C9 o- s2 w4 k1 l
6. //   allowsWriteToPm: true,
   4 h* U# O: B4 d; d
7. //   isPremium: true,
   + N' l5 V) x: N% `$ }
8. //   firstName: 'Pavel',
   , b  p7 T$ y' A& B6 w" x0 }
9. //   id: 78262681,
   
10. //   isBot: false,
    , E- b) o4 z6 ~8 Z
11. //   lastName: 'Durov',
    
12. //   languageCode: 'ru',
    / n, y+ i! w5 e6 t% r
13. //   photoUrl: 'https://example.com/image.png',
    1 M/ }5 d( W5 B8 _/ ^: H  ?
14. //   username: 'durove',
    % S/ [  G5 y: Z, ?9 L- \2 _
15. // }

复制代码

, W3 m8 O4 ^. e
  F" A% A  X- Z, O- }$ T