website·Indexed 29 days ago
https://tgx-core.js.orgDeveloper documentation for tgx-core, featuring a comprehensive API reference for interfaces, enumerations, and namespaces. Includes guides on managing Telegram bot clients, handling events, implementing commands, and utilizing auxiliaries and extensions.
PaidMedia namespace provides functionality for handling paid media assets, specifically providing access to Photo and Video functions.QueryResultAudioPayload interface represents the payload for an audio result returned from a query. It contains metadata about the audio file, such as its URL, duration, and optional captions or reply markups.export interface QueryResultAudioPayload {
id: string;
audio_url: string;
title: string;
audio_duration?: number;
caption?: string;
caption_entities?: MessageEntities | MessageEntityPayload[];
input_message_content?: InputMessageContent;
parse_mode?: string;
performer?: string;
reply_markup?: InlineKeyboardMarkup;
type?: "audio";
}SuperGroupChat class extends BaseGroupChat and is used to represent and manage a Telegram supergroup. It provides access to members, messages, topics, and invite links, as well as methods to modify chat settings and send various types of messages.new SuperGroupChat(client, packet);ClientUser and their profile:// Refresh/get the current ClientUser object
await clientUser.asyncget();
// Get profile photos with pagination
await clientUser.asyncgetProfilePhotos(offset, limit);
// Get a specific business connection
await clientUser.asyncgetBusinessConnection('business_connection_id');
// Get the chat menu button
await clientUser.asyncgetChatMenuButton(chatId, force);QueryResultVideoPayload interface defines the structure of a video payload returned from a query. It includes metadata about the video (URL, dimensions, duration), optional captions with entity support, and display settings like whether the caption should appear above the media.export interface QueryResultVideoPayload {
id: string;
title: string;
video_url: string;
mime_type: "text/html" | "video/mp4";
thumbnail_url: string;
caption?: string;
caption_entities?: MessageEntities | MessageEntityPayload[];
description?: string;
input_message_content?: InputMessageContent;
parse_mode?: string;
reply_markup?: InlineKeyboardMarkup;
show_caption_above_media?: boolean;
type?: "video";
video_duration?: number;
video_height?: number;
video_width?: number;
}BusinessIntro interface is used to represent a business introduction packet. It consists of a title, a text message, and an associated sticker file.export interface BusinessIntro {
message: string;
sticker: StickerFilePacket;
title: string;
}InlineQueryPacket interface represents an inline query sent by a user. It contains details about the user who sent the query, the query string itself, and optional context such as the chat type and location.export interface InlineQueryPacket {
id: string;
from: User;
query: string;
offset: string;
chat_type?: "private" | "group" | "supergroup" | "channel";
location?: LocationPacket;
}PollAnswerPacket interface represents the data structure for a poll answer. It contains the identifier of the poll, the selected options, and optional information about the user and the chat where the vote occurred.export interface PollAnswerPacket {
option_ids: number[];
poll_id: string;
user?: UserPacket;
voter_chat?: ChatPacket;
}The PollAnswer class provides the following properties to retrieve information about a poll response:
id (number): The unique identifier of the poll answer.poll (Poll): The poll object associated with this answer.user (User | undefined): The user who cast the vote, if available.voter_chat (SuperGroupChat | GroupChat | ChannelChat | PrivateChat | undefined): The chat where the vote was cast.option_ids (number[]): An array of the IDs of the options selected by the user.poll_id (string): The unique identifier of the poll.client (Client): The client instance used to create this object.PollAnswer class represents a response to a poll. It extends BaseClass and implements PollAnswerPacket. It provides metadata about the poll, the user who voted, and the specific options selected.const answer = new PollAnswer(client, packet);