初始数据

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

恢复

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

Variable

import { initData } from '@telegram-apps/sdk';

initData.restore();

Functions

import { restoreInitData } from '@telegram-apps/sdk';

restoreInitData();

解析

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

import { parseInitData } from '@telegram-apps/sdk';

const initData = parseInitData();
// {
//   user: {
//     id: 99281932,
//     firstName: 'Andrew',
//     lastName: 'Rogue',
//     username: 'rogue',
//     languageCode: 'en',
//     isPremium: true,
//     allowsWriteToPm: true,
//   },
//   hash: 'abcedef123',
//   authDate: Date(1716922846000),
//   startParam: 'debug',
//   chatType: 'sender',
//   chatInstance: '8428209589180549439',
// };

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

信号

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

authDate

返回类型：Date | undefined

初始化数据的创建日期。

Variable

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

Functions

import { initDataAuthDate } from '@telegram-apps/sdk';

initDataAuthDate(); // Date(1727368894000)

canSendAfter

返回类型：number | undefined

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

Variable

initData.canSendAfter(); // 3600

Functions

import { initDataCanSendAfter } from '@telegram-apps/sdk';

initDataAuthDate(); // 3600

canSendAfterDate

返回类型：Date | undefined

canSendAfter，但作为日期。

Variable

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

Functions

import { initDataCanSendAfterDate } from '@telegram-apps/sdk';

initDataCanSendAfterDate(); // Date(1727368897600)

chat

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

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

NOTE

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

Variable

initData.chat();
// {
//   id: 7728725378876215,
//   type: 'group',
//   title: '@BotFather',
//   photoUrl: 'https://example.com/image.png',
//   username: 'botfather'
// }

Functions

import { initDataChat } from '@telegram-apps/sdk';

initDataChat();
// {
//   id: 7728725378876215,
//   type: 'group',
//   title: '@BotFather',
//   photoUrl: 'https://example.com/image.png',
//   username: 'botfather'
// }

chatType

返回类型：string | undefined

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

• sender
• private
• group
• supergroup
• channel

NOTE

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

Variable

initData.chatType(); // 'group'

Functions

import { initDataChatType } from '@telegram-apps/sdk';

initDataChatType(); // 'group'

chatInstance

返回类型：string | undefined

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

WARNING

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

Variable

initData.chatInstance(); // 'group'

Functions

import { initDataChatInstance } from '@telegram-apps/sdk';

initDataChatInstance(); // '899667289674387257'

hash

返回类型：string | undefined

初始化数据签名。

Variable

initData.hash(); // 'group'

Functions

import { initDataHash } from '@telegram-apps/sdk';

initDataHash(); // 'sgbbc62g3bvdhg3djsaasd'

queryId

返回类型：string | undefined

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

Variable

initData.queryId(); // 'group'

Functions

import { initDataQueryId } from '@telegram-apps/sdk';

initDataQueryId(); // 'ssVXZ231ger'

raw

返回类型：string | undefined

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

Variable

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

Functions

import { initDataRaw } from '@telegram-apps/sdk';

initDataRaw(); // 'user=...&chat=...&...'

receiver

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

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

NOTE

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

Variable

initData.user();
// {
//   addedToAttachmentMenu: false,
//   allowsWriteToPm: true,
//   isPremium: true,
//   firstName: 'Pavel',
//   id: 78262681,
//   isBot: false,
//   lastName: 'Durov',
//   languageCode: 'ru',
//   photoUrl: 'https://example.com/image.png',
//   username: 'durove',
// }

Functions

import { initDataUser } from '@telegram-apps/sdk';

initDataUser();
// {
//   addedToAttachmentMenu: false,
//   allowsWriteToPm: true,
//   isPremium: true,
//   firstName: 'Pavel',
//   id: 78262681,
//   isBot: false,
//   lastName: 'Durov',
//   languageCode: 'ru',
//   photoUrl: 'https://example.com/image.png',
//   username: 'durove',
// }

state

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

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

Variable

initData.state();

Functions

import { initDataState } from '@telegram-apps/sdk';

initDataState();

startParam

返回类型：string | undefined

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

Variable

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

Functions

import { initDataStartParam } from '@telegram-apps/sdk';

initDataStartParam(); // 'my-value'

user

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

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

Variable

initData.user();
// {
//   addedToAttachmentMenu: false,
//   allowsWriteToPm: true,
//   isPremium: true,
//   firstName: 'Pavel',
//   id: 78262681,
//   isBot: false,
//   lastName: 'Durov',
//   languageCode: 'ru',
//   photoUrl: 'https://example.com/image.png',
//   username: 'durove',
// }

Functions

import { initDataUser } from '@telegram-apps/sdk';

initDataUser();
// {
//   addedToAttachmentMenu: false,
//   allowsWriteToPm: true,
//   isPremium: true,
//   firstName: 'Pavel',
//   id: 78262681,
//   isBot: false,
//   lastName: 'Durov',
//   languageCode: 'ru',
//   photoUrl: 'https://example.com/image.png',
//   username: 'durove',
// }