2021-04-08 12:19:38 +03:00
|
|
|
/* THIS FILE WAS AUTO-GENERATED */
|
|
|
|
import { BaseTelegramClient } from '@mtcute/core'
|
|
|
|
import { tl } from '@mtcute/tl'
|
|
|
|
import { acceptTos } from './methods/auth/accept-tos'
|
|
|
|
import { checkPassword } from './methods/auth/check-password'
|
|
|
|
import { getPasswordHint } from './methods/auth/get-password-hint'
|
|
|
|
import { logOut } from './methods/auth/log-out'
|
|
|
|
import { recoverPassword } from './methods/auth/recover-password'
|
|
|
|
import { resendCode } from './methods/auth/resend-code'
|
|
|
|
import { sendCode } from './methods/auth/send-code'
|
|
|
|
import { sendRecoveryCode } from './methods/auth/send-recovery-code'
|
|
|
|
import { signInBot } from './methods/auth/sign-in-bot'
|
|
|
|
import { signIn } from './methods/auth/sign-in'
|
|
|
|
import { signUp } from './methods/auth/sign-up'
|
2021-04-17 10:05:31 +03:00
|
|
|
import { startTest } from './methods/auth/start-test'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { start } from './methods/auth/start'
|
2021-04-10 20:06:33 +03:00
|
|
|
import { addChatMembers } from './methods/chats/add-chat-members'
|
2021-04-10 20:30:28 +03:00
|
|
|
import { archiveChats } from './methods/chats/archive-chats'
|
2021-04-10 20:56:09 +03:00
|
|
|
import { createChannel } from './methods/chats/create-channel'
|
2021-04-11 00:37:12 +03:00
|
|
|
import { createGroup } from './methods/chats/create-group'
|
2021-04-10 21:08:04 +03:00
|
|
|
import { createSupergroup } from './methods/chats/create-supergroup'
|
2021-04-10 20:56:09 +03:00
|
|
|
import { deleteChannel } from './methods/chats/delete-channel'
|
2021-04-11 15:22:48 +03:00
|
|
|
import { deleteChatPhoto } from './methods/chats/delete-chat-photo'
|
2021-04-11 00:37:12 +03:00
|
|
|
import { deleteGroup } from './methods/chats/delete-group'
|
|
|
|
import { deleteHistory } from './methods/chats/delete-history'
|
2021-04-11 14:56:34 +03:00
|
|
|
import { getChatMember } from './methods/chats/get-chat-member'
|
2021-04-14 19:43:05 +03:00
|
|
|
import { getChatMembers } from './methods/chats/get-chat-members'
|
2021-04-10 17:11:25 +03:00
|
|
|
import { getChatPreview } from './methods/chats/get-chat-preview'
|
|
|
|
import { getChat } from './methods/chats/get-chat'
|
|
|
|
import { getFullChat } from './methods/chats/get-full-chat'
|
2021-04-14 19:43:05 +03:00
|
|
|
import { iterChatMembers } from './methods/chats/iter-chat-members'
|
2021-04-10 17:11:25 +03:00
|
|
|
import { joinChat } from './methods/chats/join-chat'
|
2021-04-11 00:37:12 +03:00
|
|
|
import { leaveChat } from './methods/chats/leave-chat'
|
2021-04-14 21:31:51 +03:00
|
|
|
import { saveDraft } from './methods/chats/save-draft'
|
2021-04-11 16:11:28 +03:00
|
|
|
import { setChatDefaultPermissions } from './methods/chats/set-chat-default-permissions'
|
2021-04-11 15:32:38 +03:00
|
|
|
import { setChatDescription } from './methods/chats/set-chat-description'
|
2021-04-11 15:22:48 +03:00
|
|
|
import { setChatPhoto } from './methods/chats/set-chat-photo'
|
2021-04-11 15:32:38 +03:00
|
|
|
import { setChatTitle } from './methods/chats/set-chat-title'
|
2021-04-11 16:32:10 +03:00
|
|
|
import { setChatUsername } from './methods/chats/set-chat-username'
|
2021-04-11 16:11:28 +03:00
|
|
|
import { setSlowMode } from './methods/chats/set-slow-mode'
|
2021-04-10 20:30:28 +03:00
|
|
|
import { unarchiveChats } from './methods/chats/unarchive-chats'
|
2021-04-16 00:12:07 +03:00
|
|
|
import { createFolder } from './methods/dialogs/create-folder'
|
|
|
|
import { deleteFolder } from './methods/dialogs/delete-folder'
|
|
|
|
import { editFolder } from './methods/dialogs/edit-folder'
|
|
|
|
import { getDialogs } from './methods/dialogs/get-dialogs'
|
|
|
|
import { getFolders } from './methods/dialogs/get-folders'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { downloadAsBuffer } from './methods/files/download-buffer'
|
|
|
|
import { downloadToFile } from './methods/files/download-file'
|
|
|
|
import { downloadAsIterable } from './methods/files/download-iterable'
|
|
|
|
import { downloadAsStream } from './methods/files/download-stream'
|
|
|
|
import { uploadFile } from './methods/files/upload-file'
|
2021-04-08 20:25:15 +03:00
|
|
|
import { deleteMessages } from './methods/messages/delete-messages'
|
2021-04-09 23:19:58 +03:00
|
|
|
import { editMessage } from './methods/messages/edit-message'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { _findMessageInUpdate } from './methods/messages/find-in-update'
|
2021-04-08 20:25:15 +03:00
|
|
|
import { getHistory } from './methods/messages/get-history'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { getMessages } from './methods/messages/get-messages'
|
2021-04-08 21:40:04 +03:00
|
|
|
import { iterHistory } from './methods/messages/iter-history'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { _parseEntities } from './methods/messages/parse-entities'
|
2021-04-11 16:25:17 +03:00
|
|
|
import { pinMessage } from './methods/messages/pin-message'
|
2021-04-09 13:08:32 +03:00
|
|
|
import { searchGlobal } from './methods/messages/search-global'
|
2021-04-08 22:56:40 +03:00
|
|
|
import { searchMessages } from './methods/messages/search-messages'
|
2021-04-10 15:10:34 +03:00
|
|
|
import { sendDice } from './methods/messages/send-dice'
|
2021-04-10 15:23:27 +03:00
|
|
|
import { sendLocation } from './methods/messages/send-location'
|
2021-04-10 13:28:02 +03:00
|
|
|
import { sendMedia } from './methods/messages/send-media'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { sendPhoto } from './methods/messages/send-photo'
|
|
|
|
import { sendText } from './methods/messages/send-text'
|
2021-04-11 16:25:17 +03:00
|
|
|
import { unpinMessage } from './methods/messages/unpin-message'
|
2021-04-08 12:19:38 +03:00
|
|
|
import {
|
|
|
|
getParseMode,
|
|
|
|
registerParseMode,
|
|
|
|
setDefaultParseMode,
|
|
|
|
unregisterParseMode,
|
|
|
|
} from './methods/parse-modes/parse-modes'
|
2021-04-18 16:23:25 +03:00
|
|
|
import {
|
|
|
|
_fetchUpdatesState,
|
|
|
|
_handleUpdate,
|
|
|
|
_loadStorage,
|
|
|
|
_saveStorage,
|
|
|
|
catchUp,
|
2021-04-23 22:35:37 +03:00
|
|
|
dispatchUpdate,
|
|
|
|
} from './methods/updates'
|
2021-04-08 12:19:38 +03:00
|
|
|
import { blockUser } from './methods/users/block-user'
|
|
|
|
import { getCommonChats } from './methods/users/get-common-chats'
|
|
|
|
import { getMe } from './methods/users/get-me'
|
|
|
|
import { getUsers } from './methods/users/get-users'
|
|
|
|
import { resolvePeer } from './methods/users/resolve-peer'
|
|
|
|
import { IMessageEntityParser } from './parser'
|
|
|
|
import { Readable } from 'stream'
|
|
|
|
import {
|
|
|
|
Chat,
|
2021-04-11 14:56:34 +03:00
|
|
|
ChatMember,
|
2021-04-10 17:11:25 +03:00
|
|
|
ChatPreview,
|
2021-04-14 21:31:51 +03:00
|
|
|
Dialog,
|
2021-04-08 12:19:38 +03:00
|
|
|
FileDownloadParameters,
|
2021-04-11 16:11:28 +03:00
|
|
|
InputChatPermissions,
|
2021-04-10 11:54:31 +03:00
|
|
|
InputFileLike,
|
2021-04-10 13:28:02 +03:00
|
|
|
InputMediaLike,
|
2021-04-08 12:19:38 +03:00
|
|
|
InputPeerLike,
|
|
|
|
MaybeDynamic,
|
|
|
|
Message,
|
2021-04-16 00:12:07 +03:00
|
|
|
PartialExcept,
|
2021-04-08 12:19:38 +03:00
|
|
|
ReplyMarkup,
|
|
|
|
SentCode,
|
|
|
|
TermsOfService,
|
|
|
|
UploadFileLike,
|
2021-04-08 20:25:15 +03:00
|
|
|
UploadedFile,
|
2021-04-08 12:19:38 +03:00
|
|
|
User,
|
|
|
|
} from './types'
|
|
|
|
import { MaybeArray, MaybeAsync, TelegramConnection } from '@mtcute/core'
|
2021-04-18 16:23:25 +03:00
|
|
|
import { Lock } from './utils/lock'
|
2021-04-08 12:19:38 +03:00
|
|
|
|
2021-04-18 16:59:05 +03:00
|
|
|
export interface TelegramClient extends BaseTelegramClient {
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Accept the given TOS
|
|
|
|
*
|
|
|
|
* @param tosId TOS id
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
acceptTos(tosId: string): Promise<boolean>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Check your Two-Step verification password and log in
|
|
|
|
*
|
|
|
|
* @param password Your Two-Step verification password
|
|
|
|
* @returns The authorized user
|
|
|
|
* @throws BadRequestError In case the password is invalid
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
checkPassword(password: string): Promise<User>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get your Two-Step Verification password hint.
|
|
|
|
*
|
|
|
|
* @returns The password hint as a string, if any
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getPasswordHint(): Promise<string | null>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Log out from Telegram account and optionally reset the session storage.
|
|
|
|
*
|
|
|
|
* When you log out, you can immediately log back in using
|
|
|
|
* the same {@link TelegramClient} instance.
|
|
|
|
*
|
2021-04-10 18:33:05 +03:00
|
|
|
* @param resetSession (default: `false`) Whether to reset the session
|
2021-04-08 12:19:38 +03:00
|
|
|
* @returns On success, `true` is returned
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
logOut(resetSession?: boolean): Promise<true>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Recover your password with a recovery code and log in.
|
|
|
|
*
|
|
|
|
* @param recoveryCode The recovery code sent via email
|
|
|
|
* @returns The authorized user
|
|
|
|
* @throws BadRequestError In case the code is invalid
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
recoverPassword(recoveryCode: string): Promise<User>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Re-send the confirmation code using a different type.
|
|
|
|
*
|
|
|
|
* The type of the code to be re-sent is specified in the `nextType` attribute of
|
|
|
|
* {@link SentCode} object returned by {@link sendCode}
|
|
|
|
*
|
|
|
|
* @param phone Phone number in international format
|
|
|
|
* @param phoneCodeHash Confirmation code identifier from {@link SentCode}
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
resendCode(phone: string, phoneCodeHash: string): Promise<SentCode>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Send the confirmation code to the given phone number
|
|
|
|
*
|
|
|
|
* @param phone Phone number in international format.
|
|
|
|
* @returns An object containing information about the sent confirmation code
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
sendCode(phone: string): Promise<SentCode>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Send a code to email needed to recover your password
|
|
|
|
*
|
|
|
|
* @returns String containing email pattern to which the recovery code was sent
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
sendRecoveryCode(): Promise<string>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Authorize a bot using its token issued by [@BotFather](//t.me/BotFather)
|
|
|
|
*
|
|
|
|
* @param token Bot token issued by BotFather
|
|
|
|
* @returns Bot's {@link User} object
|
|
|
|
* @throws BadRequestError In case the bot token is invalid
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
signInBot(token: string): Promise<User>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Authorize a user in Telegram with a valid confirmation code.
|
|
|
|
*
|
|
|
|
* @param phone Phone number in international format
|
|
|
|
* @param phoneCodeHash Code identifier from {@link TelegramClient.sendCode}
|
|
|
|
* @param phoneCode The confirmation code that was received
|
|
|
|
* @returns
|
|
|
|
* - If the code was valid and authorization succeeded, the {@link User} is returned.
|
|
|
|
* - If the given phone number needs to be registered AND the ToS must be accepted,
|
|
|
|
* an object containing them is returned.
|
|
|
|
* - If the given phone number needs to be registered, `false` is returned.
|
|
|
|
* @throws BadRequestError In case the arguments are invalid
|
|
|
|
* @throws SessionPasswordNeededError In case a password is needed to sign in
|
|
|
|
*/
|
|
|
|
signIn(
|
|
|
|
phone: string,
|
|
|
|
phoneCodeHash: string,
|
|
|
|
phoneCode: string
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<User | TermsOfService | false>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Register a new user in Telegram.
|
|
|
|
*
|
|
|
|
* @param phone Phone number in international format
|
|
|
|
* @param phoneCodeHash Code identifier from {@link TelegramClient.sendCode}
|
|
|
|
* @param firstName New user's first name
|
2021-04-10 18:33:05 +03:00
|
|
|
* @param lastName (default: `''`) New user's last name
|
2021-04-08 12:19:38 +03:00
|
|
|
*/
|
|
|
|
signUp(
|
|
|
|
phone: string,
|
|
|
|
phoneCodeHash: string,
|
|
|
|
firstName: string,
|
2021-04-10 18:33:05 +03:00
|
|
|
lastName?: string
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<User>
|
2021-04-17 10:05:31 +03:00
|
|
|
/**
|
|
|
|
* Utility function to quickly authorize on test DC
|
|
|
|
* using a [Test phone number](https://core.telegram.org/api/auth#test-phone-numbers),
|
|
|
|
* which is randomly generated by default.
|
|
|
|
*
|
|
|
|
* > **Note**: Using this method assumes that you
|
|
|
|
* > are using a test DC in `primaryDc` parameter.
|
|
|
|
*
|
|
|
|
* @param params Additional parameters
|
|
|
|
*/
|
|
|
|
startTest(params?: {
|
|
|
|
/**
|
|
|
|
* Whether to log out if current session is logged in.
|
|
|
|
*
|
|
|
|
* Defaults to false.
|
|
|
|
*/
|
|
|
|
logout?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Override phone number. Must be a valid Test phone number.
|
|
|
|
*
|
|
|
|
* By default is randomly generated.
|
|
|
|
*/
|
|
|
|
phone?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Override user's DC. Must be a valid test DC.
|
|
|
|
*/
|
|
|
|
dcId?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* First name of the user (used only for sign-up, defaults to 'User')
|
|
|
|
*/
|
|
|
|
firstName?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Last name of the user (used only for sign-up, defaults to empty)
|
|
|
|
*/
|
|
|
|
lastName?: MaybeDynamic<string>
|
2021-04-17 19:00:46 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* By using this method to sign up an account, you are agreeing to Telegram
|
|
|
|
* ToS. This is required and your account will be banned otherwise.
|
|
|
|
* See https://telegram.org/tos and https://core.telegram.org/api/terms.
|
|
|
|
*
|
|
|
|
* If true, TOS will not be displayed and `tosCallback` will not be called.
|
|
|
|
*/
|
|
|
|
acceptTos?: boolean
|
2021-04-18 16:59:05 +03:00
|
|
|
}): Promise<User>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Start the client in an interactive and declarative manner,
|
|
|
|
* by providing callbacks for authorization details.
|
|
|
|
*
|
|
|
|
* This method handles both login and sign up, and also handles 2FV
|
|
|
|
*
|
|
|
|
* All parameters are `MaybeDynamic<T>`, meaning you
|
|
|
|
* can either supply `T`, or a function that returns `MaybeAsync<T>`
|
|
|
|
*
|
|
|
|
* This method is intended for simple and fast use in automated
|
|
|
|
* scripts and bots. If you are developing a custom client,
|
|
|
|
* you'll probably need to use other auth methods.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
start(params: {
|
|
|
|
/**
|
|
|
|
* Phone number of the account.
|
|
|
|
* If account does not exist, it will be created
|
|
|
|
*/
|
|
|
|
phone?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Bot token to use. Ignored if `phone` is supplied.
|
|
|
|
*/
|
|
|
|
botToken?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 2FA password. Ignored if `botToken` is supplied
|
|
|
|
*/
|
|
|
|
password?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Code sent to the phone (either sms, call, flash call or other).
|
|
|
|
* Ignored if `botToken` is supplied, must be present if `phone` is supplied.
|
|
|
|
*/
|
|
|
|
code?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If passed, this function will be called if provided code or 2FA password
|
|
|
|
* was invalid. New code/password will be requested later.
|
|
|
|
*
|
|
|
|
* If provided `code`/`password` is a constant string, providing an
|
|
|
|
* invalid one will interrupt authorization flow.
|
|
|
|
*/
|
|
|
|
invalidCodeCallback?: (type: 'code' | 'password') => MaybeAsync<void>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to force code delivery through SMS
|
|
|
|
*/
|
|
|
|
forceSms?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* First name of the user (used only for sign-up, defaults to 'User')
|
|
|
|
*/
|
|
|
|
firstName?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Last name of the user (used only for sign-up, defaults to empty)
|
|
|
|
*/
|
|
|
|
lastName?: MaybeDynamic<string>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* By using this method to sign up an account, you are agreeing to Telegram
|
|
|
|
* ToS. This is required and your account will be banned otherwise.
|
|
|
|
* See https://telegram.org/tos and https://core.telegram.org/api/terms.
|
|
|
|
*
|
|
|
|
* If true, TOS will not be displayed and `tosCallback` will not be called.
|
|
|
|
*/
|
|
|
|
acceptTos?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Custom method to display ToS. Can be used to show a GUI alert of some kind.
|
|
|
|
* Defaults to `console.log`
|
|
|
|
*/
|
|
|
|
tosCallback?: (tos: TermsOfService) => MaybeAsync<void>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Custom method that is called when a code is sent. Can be used
|
|
|
|
* to show a GUI alert of some kind.
|
|
|
|
* Defaults to `console.log`
|
|
|
|
*
|
|
|
|
* @param code
|
|
|
|
*/
|
|
|
|
codeSentCallback?: (code: SentCode) => MaybeAsync<void>
|
|
|
|
|
|
|
|
/**
|
2021-04-08 20:25:15 +03:00
|
|
|
* Whether to "catch up" (load missed updates).
|
|
|
|
* Note: you should register your handlers
|
|
|
|
* before calling `start()`
|
|
|
|
*
|
2021-04-08 12:19:38 +03:00
|
|
|
* Defaults to true.
|
|
|
|
*/
|
|
|
|
catchUp?: boolean
|
2021-04-18 16:59:05 +03:00
|
|
|
}): Promise<User>
|
2021-04-10 20:06:33 +03:00
|
|
|
/**
|
|
|
|
* Add new members to a group, supergroup or channel.
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat or its username
|
|
|
|
* @param users ID(s) of the users, their username(s) or phone(s).
|
2021-04-10 20:56:09 +03:00
|
|
|
* @param forwardCount
|
|
|
|
* (default: `100`)
|
2021-04-10 20:06:33 +03:00
|
|
|
* Number of old messages to be forwarded (0-100).
|
|
|
|
* Only applicable to legacy groups, ignored for supergroups and channels
|
|
|
|
*/
|
|
|
|
addChatMembers(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
users: MaybeArray<InputPeerLike>,
|
|
|
|
forwardCount?: number
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-10 20:30:28 +03:00
|
|
|
/**
|
|
|
|
* Archive one or more chats
|
|
|
|
*
|
|
|
|
* @param chats Chat ID(s), username(s), phone number(s), `"me"` or `"self"`
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
archiveChats(chats: MaybeArray<InputPeerLike>): Promise<void>
|
2021-04-10 20:56:09 +03:00
|
|
|
/**
|
|
|
|
* Create a new broadcast channel
|
|
|
|
*
|
|
|
|
* @param title Channel title
|
|
|
|
* @param description (default: `''`) Channel description
|
|
|
|
* @returns Newly created channel
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
createChannel(title: string, description?: string): Promise<Chat>
|
2021-04-11 00:37:12 +03:00
|
|
|
/**
|
|
|
|
* Create a legacy group chat
|
|
|
|
*
|
|
|
|
* If you want to create a supergroup, use {@link createSupergroup}
|
|
|
|
* instead.
|
|
|
|
*
|
|
|
|
* @param title Group title
|
|
|
|
* @param users
|
|
|
|
* User(s) to be invited in the group (ID(s), username(s) or phone number(s)).
|
|
|
|
* Due to Telegram limitations, you can't create a legacy group with yourself.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
createGroup(title: string, users: MaybeArray<InputPeerLike>): Promise<Chat>
|
2021-04-10 21:08:04 +03:00
|
|
|
/**
|
|
|
|
* Create a new supergroup
|
|
|
|
*
|
|
|
|
* @param title Title of the supergroup
|
|
|
|
* @param description (default: `''`) Description of the supergroup
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
createSupergroup(title: string, description?: string): Promise<Chat>
|
2021-04-10 20:56:09 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete a channel or a supergroup
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
deleteChannel(chatId: InputPeerLike): Promise<void>
|
2021-04-10 20:56:09 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete a channel or a supergroup
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
deleteSupergroup(chatId: InputPeerLike): Promise<void>
|
2021-04-11 15:22:48 +03:00
|
|
|
/**
|
|
|
|
* Delete a chat photo
|
|
|
|
*
|
|
|
|
* You must be an administrator and have the appropriate permissions.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
deleteChatPhoto(chatId: InputPeerLike): Promise<void>
|
2021-04-11 00:37:12 +03:00
|
|
|
/**
|
|
|
|
* Delete a legacy group chat for all members
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
deleteGroup(chatId: InputPeerLike): Promise<void>
|
2021-04-11 00:37:12 +03:00
|
|
|
/**
|
|
|
|
* Delete communication history (for private chats
|
|
|
|
* and legacy groups)
|
|
|
|
*
|
|
|
|
* @param chat Chat or user ID, username, phone number, `"me"` or `"self"`
|
|
|
|
* @param mode
|
|
|
|
* (default: `'delete'`)
|
|
|
|
* Deletion mode. Can be:
|
|
|
|
* - `delete`: delete messages (only for yourself)
|
|
|
|
* - `clear`: delete messages (only for yourself)
|
|
|
|
* - `revoke`: delete messages for all users
|
|
|
|
* - I'm not sure what's the difference between `delete` and `clear`,
|
|
|
|
* but they are in fact different flags in TL object.
|
|
|
|
* @param maxId (default: `0`) Maximum ID of message to delete. Defaults to 0 (remove all messages)
|
|
|
|
*/
|
|
|
|
deleteHistory(
|
|
|
|
chat: InputPeerLike,
|
|
|
|
mode?: 'delete' | 'clear' | 'revoke',
|
|
|
|
maxId?: number
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-11 14:56:34 +03:00
|
|
|
/**
|
|
|
|
* Get information about a single chat member
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param userId User ID, username, phone number, `"me"` or `"self"`
|
2021-04-11 15:22:48 +03:00
|
|
|
* @throws UserNotParticipantError In case given user is not a participant of a given chat
|
2021-04-11 14:56:34 +03:00
|
|
|
*/
|
|
|
|
getChatMember(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
userId: InputPeerLike
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<ChatMember>
|
2021-04-14 19:43:05 +03:00
|
|
|
/**
|
|
|
|
* Get a chunk of members of some chat.
|
|
|
|
*
|
|
|
|
* You can retrieve up to 200 members at once
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param params Additional parameters
|
|
|
|
*/
|
|
|
|
getChatMembers(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Search query to filter members by their display names and usernames
|
|
|
|
* Defaults to `''` (empty string)
|
|
|
|
*
|
|
|
|
* > **Note**: Only used for these values of `filter`:
|
|
|
|
* > `all`, `banned`, `restricted`, `contacts`
|
|
|
|
*/
|
|
|
|
query?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sequential number of the first member to be returned.
|
|
|
|
*/
|
|
|
|
offset?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Maximum number of members to be retrieved. Defaults to `200`
|
|
|
|
*/
|
|
|
|
limit?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Type of the query. Can be:
|
|
|
|
* - `all`: get all members
|
|
|
|
* - `banned`: get only banned members
|
|
|
|
* - `restricted`: get only restricted members
|
|
|
|
* - `bots`: get only bots
|
|
|
|
* - `recent`: get recent members
|
|
|
|
* - `admins`: get only administrators (and creator)
|
|
|
|
* - `contacts`: get only contacts
|
|
|
|
* - `mention`: get users that can be mentioned ([learn more](https://mt.tei.su/tl/class/channelParticipantsMentions))
|
|
|
|
*
|
|
|
|
* Only used for channels and supergroups. Defaults to `recent`
|
|
|
|
*/
|
|
|
|
type?:
|
|
|
|
| 'all'
|
|
|
|
| 'banned'
|
|
|
|
| 'restricted'
|
|
|
|
| 'bots'
|
|
|
|
| 'recent'
|
|
|
|
| 'admins'
|
|
|
|
| 'contacts'
|
|
|
|
| 'mention'
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<ChatMember[]>
|
2021-04-10 17:11:25 +03:00
|
|
|
/**
|
|
|
|
* Get preview information about a private chat.
|
|
|
|
*
|
|
|
|
* @param inviteLink Invite link
|
|
|
|
* @throws MtCuteArgumentError In case invite link has invalid format
|
|
|
|
* @throws MtCuteNotFoundError
|
|
|
|
* In case you are trying to get info about private chat that you have already joined.
|
|
|
|
* Use {@link getChat} or {@link getFullChat} instead.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getChatPreview(inviteLink: string): Promise<ChatPreview>
|
2021-04-10 17:11:25 +03:00
|
|
|
/**
|
|
|
|
* Get basic information about a chat.
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username or invite link
|
|
|
|
* @throws MtCuteArgumentError
|
|
|
|
* In case you are trying to get info about private chat that you haven't joined.
|
|
|
|
* Use {@link getChatPreview} instead.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getChat(chatId: InputPeerLike): Promise<Chat>
|
2021-04-10 17:11:25 +03:00
|
|
|
/**
|
|
|
|
* Get full information about a chat.
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username or invite link
|
|
|
|
* @throws MtCuteArgumentError
|
|
|
|
* In case you are trying to get info about private chat that you haven't joined.
|
|
|
|
* Use {@link getChatPreview} instead.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getFullChat(chatId: InputPeerLike): Promise<Chat>
|
2021-04-14 19:43:05 +03:00
|
|
|
/**
|
|
|
|
* Iterate through chat members
|
|
|
|
*
|
|
|
|
* This method is a small wrapper over {@link getChatMembers},
|
|
|
|
* which also handles duplicate entries (i.e. does not yield
|
|
|
|
* the same member twice)
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param params Additional parameters
|
|
|
|
*/
|
|
|
|
iterChatMembers(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
params?: Parameters<TelegramClient['getChatMembers']>[1] & {
|
|
|
|
/**
|
|
|
|
* Chunk size, which will be passed as `limit` parameter
|
|
|
|
* to {@link getChatMembers}. Usually you shouldn't care about this.
|
|
|
|
*
|
|
|
|
* Defaults to `200`
|
|
|
|
*/
|
|
|
|
chunkSize?: number
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): AsyncIterableIterator<ChatMember>
|
2021-04-10 17:11:25 +03:00
|
|
|
/**
|
|
|
|
* Join a channel or supergroup
|
|
|
|
*
|
|
|
|
* @param chatId
|
|
|
|
* Chat identifier. Either an invite link (`t.me/joinchat/*`), a username (`@username`)
|
|
|
|
* or ID of the linked supergroup or channel.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
joinChat(chatId: InputPeerLike): Promise<Chat>
|
2021-04-11 00:37:12 +03:00
|
|
|
/**
|
|
|
|
* Leave a group chat, supergroup or channel
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param clear (default: `false`) Whether to clear history after leaving (only for legacy group chats)
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
leaveChat(chatId: InputPeerLike, clear?: boolean): Promise<void>
|
2021-04-14 21:31:51 +03:00
|
|
|
/**
|
|
|
|
* Save or delete a draft message associated with some chat
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param draft Draft message, or `null` to delete.
|
|
|
|
*/
|
|
|
|
saveDraft(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
draft: null | Omit<tl.RawDraftMessage, '_' | 'date'>
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-11 16:11:28 +03:00
|
|
|
/**
|
|
|
|
* Change default chat permissions for all members.
|
|
|
|
*
|
|
|
|
* You must be an administrator in the chat and have appropriate permissions.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param permissions New default chat permissions
|
|
|
|
* @example
|
|
|
|
* ```typescript
|
|
|
|
* // Completely restrict chat
|
|
|
|
* await tg.setDefaultChatPermissions('somechat', {})
|
|
|
|
*
|
|
|
|
* // Chat members can only send text, media, stickers and GIFs
|
|
|
|
* await tg.setDefaultChatPermissions('somechat', {
|
|
|
|
* canSendMessages: true,
|
|
|
|
* canSendMedia: true,
|
|
|
|
* canSendStickers: true,
|
|
|
|
* canSendGifs: true,
|
|
|
|
* })
|
|
|
|
* ```
|
|
|
|
*/
|
|
|
|
setChatDefaultPermissions(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
permissions: InputChatPermissions
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Chat>
|
2021-04-11 15:32:38 +03:00
|
|
|
/**
|
|
|
|
* Change chat description
|
|
|
|
*
|
|
|
|
* You must be an administrator and have the appropriate permissions.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param description New chat description, 0-255 characters
|
|
|
|
*/
|
|
|
|
setChatDescription(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
description: string
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-11 15:22:48 +03:00
|
|
|
/**
|
|
|
|
* Set a new chat photo or video.
|
|
|
|
*
|
|
|
|
* You must be an administrator and have the appropriate permissions.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param type Media type (photo or video)
|
|
|
|
* @param media Input media file
|
|
|
|
* @param previewSec
|
|
|
|
* When `type = video`, timestamp in seconds which will be shown
|
|
|
|
* as a static preview.
|
|
|
|
*/
|
|
|
|
setChatPhoto(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
type: 'photo' | 'video',
|
|
|
|
media: InputFileLike,
|
|
|
|
previewSec?: number
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-11 15:32:38 +03:00
|
|
|
/**
|
|
|
|
* Change chat title
|
|
|
|
*
|
|
|
|
* You must be an administrator and have the appropriate permissions.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param title New chat title, 1-255 characters
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
setChatTitle(chatId: InputPeerLike, title: string): Promise<void>
|
2021-04-11 16:32:10 +03:00
|
|
|
/**
|
|
|
|
* Change supergroup/channel username
|
|
|
|
*
|
|
|
|
* You must be an administrator and have the appropriate permissions.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or current username
|
|
|
|
* @param username New username, or `null` to remove
|
|
|
|
*/
|
|
|
|
setChatUsername(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
username: string | null
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-11 16:11:28 +03:00
|
|
|
/**
|
|
|
|
* Set supergroup's slow mode interval.
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID or username
|
|
|
|
* @param seconds
|
|
|
|
* (default: `0`)
|
|
|
|
* Slow mode interval in seconds.
|
|
|
|
* Users will be able to send a message only once per this interval.
|
|
|
|
* Valid values are: `0 (off), 10, 30, 60 (1m), 300 (5m), 900 (15m) or 3600 (1h)`
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
setSlowMode(chatId: InputPeerLike, seconds?: number): Promise<void>
|
2021-04-10 20:30:28 +03:00
|
|
|
/**
|
|
|
|
* Unarchive one or more chats
|
|
|
|
*
|
|
|
|
* @param chats Chat ID(s), username(s), phone number(s), `"me"` or `"self"`
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
unarchiveChats(chats: MaybeArray<InputPeerLike>): Promise<void>
|
2021-04-16 00:12:07 +03:00
|
|
|
/**
|
|
|
|
* Create a folder from given parameters
|
|
|
|
*
|
|
|
|
* ID for the folder is optional, if not
|
|
|
|
* provided it will be derived automatically.
|
|
|
|
*
|
|
|
|
* @param folder Parameters for the folder
|
|
|
|
* @returns Newly created folder
|
|
|
|
*/
|
|
|
|
createFolder(
|
|
|
|
folder: PartialExcept<tl.RawDialogFilter, 'title'>
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<tl.RawDialogFilter>
|
2021-04-16 00:12:07 +03:00
|
|
|
/**
|
|
|
|
* Delete a folder by its ID
|
|
|
|
*
|
|
|
|
* @param id Folder ID or folder itself
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
deleteFolder(id: number | tl.RawDialogFilter): Promise<void>
|
2021-04-16 00:12:07 +03:00
|
|
|
/**
|
|
|
|
* Edit a folder with given modification
|
|
|
|
*
|
|
|
|
* @param folder Folder or folder ID. Note that passing an ID will require re-fetching all folders
|
|
|
|
* @param modification Modification that will be applied to this folder
|
|
|
|
* @returns Modified folder
|
|
|
|
*/
|
|
|
|
editFolder(
|
|
|
|
folder: tl.RawDialogFilter | number,
|
|
|
|
modification: Partial<Omit<tl.RawDialogFilter, 'id' | '_'>>
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<tl.RawDialogFilter>
|
2021-04-16 00:12:07 +03:00
|
|
|
/**
|
2021-04-17 10:05:31 +03:00
|
|
|
* Iterate over dialogs.
|
|
|
|
*
|
|
|
|
* Note that due to Telegram limitations,
|
|
|
|
* ordering here can only be anti-chronological
|
|
|
|
* (i.e. newest - first), and draft update date
|
|
|
|
* is not considered when sorting.
|
2021-04-16 00:12:07 +03:00
|
|
|
*
|
|
|
|
* @param params Fetch parameters
|
|
|
|
*/
|
|
|
|
getDialogs(params?: {
|
|
|
|
/**
|
|
|
|
* Offset message date used as an anchor for pagination.
|
|
|
|
*/
|
|
|
|
offsetDate?: Date | number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Offset message ID used as an anchor for pagination
|
|
|
|
*/
|
|
|
|
offsetId?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Offset peer used as an anchor for pagination
|
|
|
|
*/
|
|
|
|
offsetPeer?: tl.TypeInputPeer
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Limits the number of dialogs to be received.
|
|
|
|
*
|
|
|
|
* Defaults to `Infinity`, i.e. all dialogs are fetched, ignored when `pinned=only`
|
|
|
|
*/
|
|
|
|
limit?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Chunk size which will be passed to `messages.getDialogs`.
|
|
|
|
* You shouldn't usually care about this.
|
|
|
|
*
|
|
|
|
* Defaults to 100.
|
|
|
|
*/
|
|
|
|
chunkSize?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* How to handle pinned dialogs?
|
|
|
|
*
|
|
|
|
* Whether to `include` them at the start of the list,
|
|
|
|
* `exclude` them at all, or `only` return pinned dialogs.
|
|
|
|
*
|
|
|
|
* Additionally, for folders you can specify
|
|
|
|
* `keep`, which will return pinned dialogs
|
|
|
|
* ordered by date among other non-pinned dialogs.
|
|
|
|
*
|
|
|
|
* Defaults to `include`.
|
|
|
|
*
|
2021-04-17 10:05:31 +03:00
|
|
|
* > **Note**: When using `include` mode with folders,
|
|
|
|
* > pinned dialogs will only be fetched if all offset
|
|
|
|
* > parameters are unset.
|
2021-04-16 00:12:07 +03:00
|
|
|
*/
|
|
|
|
pinned?: 'include' | 'exclude' | 'only' | 'keep'
|
|
|
|
|
|
|
|
/**
|
|
|
|
* How to handle archived chats?
|
|
|
|
*
|
|
|
|
* Whether to `keep` them among other dialogs,
|
|
|
|
* `exclude` them from the list, or `only`
|
|
|
|
* return archived dialogs
|
|
|
|
*
|
|
|
|
* Defaults to `exclude`, ignored for folders since folders
|
|
|
|
* themselves contain information about archived chats.
|
|
|
|
*
|
|
|
|
* > **Note**: when fetching `only` pinned dialogs
|
|
|
|
* > passing `keep` will act as passing `only`
|
|
|
|
*/
|
|
|
|
archived?: 'keep' | 'exclude' | 'only'
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Folder from which the dialogs will be fetched.
|
|
|
|
*
|
|
|
|
* You can pass folder object, id or title
|
|
|
|
*
|
|
|
|
* Note that passing anything except object will
|
|
|
|
* cause the list of the folders to be fetched,
|
|
|
|
* and passing a title may fetch from
|
|
|
|
* a wrong folder if you have multiple with the same title.
|
|
|
|
*
|
2021-04-17 10:05:31 +03:00
|
|
|
* Also note that fetching dialogs in a folder is
|
|
|
|
* *orders of magnitudes* slower than normal because
|
|
|
|
* of Telegram API limitations - we have to fetch all dialogs
|
|
|
|
* and filter the ones we need manually. If possible,
|
|
|
|
* use {@link Dialog.filterFolder} instead.
|
|
|
|
*
|
2021-04-16 00:12:07 +03:00
|
|
|
* When a folder with given ID or title is not found,
|
|
|
|
* {@link MtCuteArgumentError} is thrown
|
|
|
|
*
|
|
|
|
* By default fetches from "All" folder
|
|
|
|
*/
|
|
|
|
folder?: string | number | tl.RawDialogFilter
|
2021-04-18 16:59:05 +03:00
|
|
|
}): AsyncIterableIterator<Dialog>
|
2021-04-16 00:12:07 +03:00
|
|
|
/**
|
|
|
|
* Get list of folders.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getFolders(): Promise<tl.RawDialogFilter[]>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Download a file and return its contents as a Buffer.
|
|
|
|
*
|
|
|
|
* > **Note**: This method _will_ download the entire file
|
|
|
|
* > into memory at once. This might cause an issue, so use wisely!
|
|
|
|
*
|
|
|
|
* @param params File download parameters
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
downloadAsBuffer(params: FileDownloadParameters): Promise<Buffer>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Download a remote file to a local file (only for NodeJS).
|
|
|
|
* Promise will resolve once the download is complete.
|
|
|
|
*
|
|
|
|
* @param filename Local file name to which the remote file will be downloaded
|
|
|
|
* @param params File download parameters
|
|
|
|
*/
|
|
|
|
downloadToFile(
|
|
|
|
filename: string,
|
|
|
|
params: FileDownloadParameters
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Download a file and return it as an iterable, which yields file contents
|
|
|
|
* in chunks of a given size. Order of the chunks is guaranteed to be
|
|
|
|
* consecutive.
|
|
|
|
*
|
|
|
|
* @param params Download parameters
|
|
|
|
*/
|
|
|
|
downloadAsIterable(
|
|
|
|
params: FileDownloadParameters
|
2021-04-18 16:59:05 +03:00
|
|
|
): AsyncIterableIterator<Buffer>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Download a file and return it as a Node readable stream,
|
|
|
|
* streaming file contents.
|
|
|
|
*
|
|
|
|
* @param params File download parameters
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
downloadAsStream(params: FileDownloadParameters): Readable
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Upload a file to Telegram servers, without actually
|
|
|
|
* sending a message anywhere. Useful when an `InputFile` is required.
|
|
|
|
*
|
|
|
|
* This method is quite low-level, and you should use other
|
|
|
|
* methods like {@link sendDocument} that handle this under the hood.
|
|
|
|
*
|
|
|
|
* @param params Upload parameters
|
|
|
|
*/
|
|
|
|
uploadFile(params: {
|
|
|
|
/**
|
|
|
|
* Upload file source.
|
|
|
|
*
|
|
|
|
* > **Note**: `fs.ReadStream` is a subclass of `stream.Readable` and contains
|
|
|
|
* > info about file name, thus you don't need to pass them explicitly.
|
|
|
|
*/
|
|
|
|
file: UploadFileLike
|
|
|
|
|
|
|
|
/**
|
|
|
|
* File name for the uploaded file. Is usually inferred from path,
|
|
|
|
* but should be provided for files sent as `Buffer` or stream.
|
|
|
|
*
|
|
|
|
* When file name can't be inferred, it falls back to "unnamed"
|
|
|
|
*/
|
|
|
|
fileName?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Total file size. Automatically inferred for Buffer, File and local files.
|
|
|
|
*
|
|
|
|
* When using with streams, if `fileSize` is not passed, the entire file is
|
|
|
|
* first loaded into memory to determine file size, and used as a Buffer later.
|
|
|
|
* This might be a major performance bottleneck, so be sure to provide file size
|
|
|
|
* when using streams and file size is known (which often is the case).
|
|
|
|
*/
|
|
|
|
fileSize?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* File MIME type. By default is automatically inferred from magic number
|
|
|
|
* If MIME can't be inferred, it defaults to `application/octet-stream`
|
|
|
|
*/
|
|
|
|
fileMime?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Upload part size (in KB).
|
|
|
|
*
|
|
|
|
* By default, automatically selected by file size.
|
|
|
|
* Must not be bigger than 512 and must not be a fraction.
|
|
|
|
*/
|
|
|
|
partSize?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function that will be called after some part has been uploaded.
|
|
|
|
*
|
|
|
|
* @param uploaded Number of bytes already uploaded
|
|
|
|
* @param total Total file size
|
|
|
|
*/
|
|
|
|
progressCallback?: (uploaded: number, total: number) => void
|
2021-04-18 16:59:05 +03:00
|
|
|
}): Promise<UploadedFile>
|
2021-04-08 20:25:15 +03:00
|
|
|
/**
|
|
|
|
* Delete messages, including service messages.
|
|
|
|
*
|
|
|
|
* @param chatId Chat's marked ID, its username, phone or `"me"` or `"self"`.
|
|
|
|
* @param ids Message(s) ID(s) to delete.
|
2021-04-10 18:33:05 +03:00
|
|
|
* @param revoke (default: `true`) Whether to "revoke" (i.e. delete for both sides). Only used for chats and private chats.
|
2021-04-08 20:25:15 +03:00
|
|
|
*/
|
|
|
|
deleteMessages(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
ids: MaybeArray<number>,
|
2021-04-10 18:33:05 +03:00
|
|
|
revoke?: boolean
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<boolean>
|
2021-04-09 23:19:58 +03:00
|
|
|
/**
|
|
|
|
* Edit message text and/or reply markup.
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param message Message or its ID
|
|
|
|
* @param params
|
|
|
|
*/
|
|
|
|
editMessage(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
message: number | Message,
|
|
|
|
params: {
|
|
|
|
/**
|
|
|
|
* New message text
|
|
|
|
*/
|
|
|
|
text?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Parse mode to use to parse entities before sending
|
|
|
|
* the message. Defaults to current default parse mode (if any).
|
|
|
|
*
|
|
|
|
* Passing `null` will explicitly disable formatting.
|
|
|
|
*/
|
|
|
|
parseMode?: string | null
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of formatting entities to use instead of parsing via a
|
|
|
|
* parse mode.
|
|
|
|
*
|
|
|
|
* **Note:** Passing this makes the method ignore {@link parseMode}
|
|
|
|
*/
|
|
|
|
entities?: tl.TypeMessageEntity[]
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to disable links preview in this message
|
|
|
|
*/
|
|
|
|
disableWebPreview?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For bots: inline or reply markup or an instruction
|
|
|
|
* to hide a reply keyboard or to force a reply.
|
|
|
|
*/
|
|
|
|
replyMarkup?: ReplyMarkup
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message>
|
2021-04-08 20:25:15 +03:00
|
|
|
/**
|
|
|
|
* Retrieve a chunk of the chat history.
|
|
|
|
*
|
|
|
|
* You can get up to 100 messages with one call.
|
2021-04-08 21:40:04 +03:00
|
|
|
* For larger chunks, use {@link iterHistory}.
|
2021-04-08 20:25:15 +03:00
|
|
|
*
|
|
|
|
* @param chatId Chat's marked ID, its username, phone or `"me"` or `"self"`.
|
|
|
|
* @param params Additional fetch parameters
|
|
|
|
*/
|
|
|
|
getHistory(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Limits the number of messages to be retrieved.
|
|
|
|
*
|
|
|
|
* Defaults to `100`.
|
|
|
|
*/
|
|
|
|
limit?: number
|
2021-04-08 12:19:38 +03:00
|
|
|
|
2021-04-08 20:25:15 +03:00
|
|
|
/**
|
|
|
|
* Sequential number of the first message to be returned.
|
|
|
|
* Defaults to 0 (most recent message).
|
|
|
|
*
|
|
|
|
* Negative values are also accepted and are useful
|
|
|
|
* in case you set `offsetId` or `offsetDate`.
|
|
|
|
*/
|
|
|
|
offset?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass a message identifier as an offset to retrieve
|
|
|
|
* only older messages starting from that message
|
|
|
|
*/
|
|
|
|
offsetId?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass a date (`Date` or Unix time in ms) as an offset to retrieve
|
|
|
|
* only older messages starting from that date.
|
|
|
|
*/
|
|
|
|
offsetDate?: number | Date
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass `true` to retrieve messages in reversed order (from older to recent)
|
|
|
|
*/
|
|
|
|
reverse?: boolean
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message[]>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get a single message in chat by its ID
|
|
|
|
*
|
|
|
|
* **Note**: this method might return empty message
|
|
|
|
*
|
|
|
|
* @param chatId Chat's marked ID, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param messageId Messages ID
|
|
|
|
* @param [fromReply=false]
|
|
|
|
* Whether the reply to a given message should be fetched
|
|
|
|
* (i.e. `getMessages(msg.chat.id, msg.id, true).id === msg.replyToMessageId`)
|
|
|
|
*/
|
|
|
|
getMessages(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
messageId: number,
|
|
|
|
fromReply?: boolean
|
|
|
|
): Promise<Message>
|
|
|
|
/**
|
|
|
|
* Get messages in chat by their IDs
|
|
|
|
*
|
|
|
|
* **Note**: this method might return empty messages
|
|
|
|
*
|
|
|
|
* @param chatId Chat's marked ID, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param messageIds Messages IDs
|
|
|
|
* @param [fromReply=false]
|
|
|
|
* Whether the reply to a given message should be fetched
|
|
|
|
* (i.e. `getMessages(msg.chat.id, msg.id, true).id === msg.replyToMessageId`)
|
|
|
|
*/
|
|
|
|
getMessages(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
messageIds: number[],
|
|
|
|
fromReply?: boolean
|
|
|
|
): Promise<Message[]>
|
|
|
|
|
|
|
|
getMessages(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
messageIds: MaybeArray<number>,
|
2021-04-10 18:33:05 +03:00
|
|
|
fromReply?: boolean
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<MaybeArray<Message>>
|
2021-04-08 21:40:04 +03:00
|
|
|
/**
|
|
|
|
* Iterate through a chat history sequentially.
|
|
|
|
*
|
|
|
|
* This method wraps {@link getHistory} to allow processing large
|
|
|
|
* groups of messages or entire chats.
|
|
|
|
*
|
|
|
|
* @param chatId Chat's marked ID, its username, phone or `"me"` or `"self"`.
|
|
|
|
* @param params Additional fetch parameters
|
|
|
|
*/
|
|
|
|
iterHistory(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Limits the number of messages to be retrieved.
|
|
|
|
*
|
|
|
|
* By default, no limit is applied and all messages
|
|
|
|
* are returned.
|
|
|
|
*/
|
|
|
|
limit?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sequential number of the first message to be returned.
|
|
|
|
* Defaults to 0 (most recent message).
|
|
|
|
*
|
|
|
|
* Negative values are also accepted and are useful
|
|
|
|
* in case you set `offsetId` or `offsetDate`.
|
|
|
|
*/
|
|
|
|
offset?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass a message identifier as an offset to retrieve
|
|
|
|
* only older messages starting from that message
|
|
|
|
*/
|
|
|
|
offsetId?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass a date (`Date` or Unix time in ms) as an offset to retrieve
|
|
|
|
* only older messages starting from that date.
|
|
|
|
*/
|
|
|
|
offsetDate?: number | Date
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass `true` to retrieve messages in reversed order (from older to recent)
|
|
|
|
*/
|
|
|
|
reverse?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Chunk size, which will be passed as `limit` parameter
|
|
|
|
* to {@link getHistory}. Usually you shouldn't care about this.
|
|
|
|
*
|
|
|
|
* Defaults to `100`
|
|
|
|
*/
|
|
|
|
chunkSize?: number
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): AsyncIterableIterator<Message>
|
2021-04-11 16:25:17 +03:00
|
|
|
/**
|
|
|
|
* Pin a message in a group, supergroup, channel or PM.
|
|
|
|
*
|
|
|
|
* For supergroups/channels, you must have appropriate permissions,
|
|
|
|
* either as an admin, or as default permissions
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID, username, phone number, `"self"` or `"me"`
|
|
|
|
* @param messageId Message ID
|
|
|
|
* @param notify (default: `false`) Whether to send a notification (only for legacy groups and supergroups)
|
|
|
|
* @param bothSides (default: `false`) Whether to pin for both sides (only for private chats)
|
|
|
|
*/
|
|
|
|
pinMessage(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
messageId: number,
|
|
|
|
notify?: boolean,
|
|
|
|
bothSides?: boolean
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<void>
|
2021-04-09 13:08:32 +03:00
|
|
|
/**
|
|
|
|
* Search for messages globally from all of your chats
|
|
|
|
*
|
|
|
|
* **Note**: Due to Telegram limitations, you can only get up to ~10000 messages
|
|
|
|
*
|
|
|
|
* @param params Search parameters
|
|
|
|
*/
|
|
|
|
searchGlobal(params?: {
|
|
|
|
/**
|
|
|
|
* Text query string. Use `"@"` to search for mentions.
|
|
|
|
*
|
|
|
|
* Defaults to `""` (empty string)
|
|
|
|
*/
|
|
|
|
query?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Limits the number of messages to be retrieved.
|
|
|
|
*
|
|
|
|
* By default, no limit is applied and all messages are returned
|
|
|
|
*/
|
|
|
|
limit?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter the results using some filter.
|
|
|
|
* Defaults to {@link SearchFilters.Empty} (i.e. will return all messages)
|
|
|
|
*
|
|
|
|
* @link SearchFilters
|
|
|
|
*/
|
|
|
|
filter?: tl.TypeMessagesFilter
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Chunk size, which will be passed as `limit` parameter
|
|
|
|
* for `messages.search`. Usually you shouldn't care about this.
|
|
|
|
*
|
|
|
|
* Defaults to `100`
|
|
|
|
*/
|
|
|
|
chunkSize?: number
|
2021-04-18 16:59:05 +03:00
|
|
|
}): AsyncIterableIterator<Message>
|
2021-04-08 22:56:40 +03:00
|
|
|
/**
|
|
|
|
* Search for messages inside a specific chat
|
|
|
|
*
|
|
|
|
* @param chatId Chat's marked ID, its username, phone or `"me"` or `"self"`.
|
|
|
|
* @param params Additional search parameters
|
|
|
|
*/
|
|
|
|
searchMessages(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Text query string. Required for text-only messages,
|
|
|
|
* optional for media.
|
|
|
|
*
|
|
|
|
* Defaults to `""` (empty string)
|
|
|
|
*/
|
|
|
|
query?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sequential number of the first message to be returned.
|
|
|
|
*
|
|
|
|
* Defaults to `0`.
|
|
|
|
*/
|
|
|
|
offset?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Limits the number of messages to be retrieved.
|
|
|
|
*
|
|
|
|
* By default, no limit is applied and all messages are returned
|
|
|
|
*/
|
|
|
|
limit?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter the results using some filter.
|
|
|
|
* Defaults to {@link SearchFilters.Empty} (i.e. will return all messages)
|
|
|
|
*
|
|
|
|
* @link SearchFilters
|
|
|
|
*/
|
|
|
|
filter?: tl.TypeMessagesFilter
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Search for messages sent by a specific user.
|
|
|
|
*
|
|
|
|
* Pass their marked ID, username, phone or `"me"` or `"self"`
|
|
|
|
*/
|
|
|
|
fromUser?: InputPeerLike
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Chunk size, which will be passed as `limit` parameter
|
|
|
|
* for `messages.search`. Usually you shouldn't care about this.
|
|
|
|
*
|
|
|
|
* Defaults to `100`
|
|
|
|
*/
|
|
|
|
chunkSize?: number
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): AsyncIterableIterator<Message>
|
2021-04-10 15:10:34 +03:00
|
|
|
/**
|
|
|
|
* Send an animated dice with a random value.
|
|
|
|
*
|
2021-04-10 15:23:27 +03:00
|
|
|
* For convenience, known dice emojis are available
|
2021-04-10 15:10:34 +03:00
|
|
|
* as static members of {@link Dice}.
|
|
|
|
*
|
2021-04-10 15:23:27 +03:00
|
|
|
* Note that dice result value is generated randomly on the server,
|
|
|
|
* you can't influence it in any way!
|
|
|
|
*
|
2021-04-10 15:10:34 +03:00
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param emoji Emoji representing a dice
|
|
|
|
* @param params Additional sending parameters
|
|
|
|
* @link Dice
|
|
|
|
*/
|
|
|
|
sendDice(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
emoji: string,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Message to reply to. Either a message object or message ID.
|
|
|
|
*/
|
|
|
|
replyTo?: number | Message
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to send this message silently.
|
|
|
|
*/
|
|
|
|
silent?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If set, the message will be scheduled to this date.
|
|
|
|
* When passing a number, a UNIX time in ms is expected.
|
|
|
|
*/
|
|
|
|
schedule?: Date | number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For bots: inline or reply markup or an instruction
|
|
|
|
* to hide a reply keyboard or to force a reply.
|
|
|
|
*/
|
|
|
|
replyMarkup?: ReplyMarkup
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message>
|
2021-04-10 15:23:27 +03:00
|
|
|
/**
|
|
|
|
* Send a static geo location.
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param latitude Latitude of the location
|
|
|
|
* @param longitude Longitude of the location
|
|
|
|
* @param params Additional sending parameters
|
|
|
|
*/
|
|
|
|
sendLocation(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
latitude: number,
|
|
|
|
longitude: number,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Message to reply to. Either a message object or message ID.
|
|
|
|
*/
|
|
|
|
replyTo?: number | Message
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to send this message silently.
|
|
|
|
*/
|
|
|
|
silent?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If set, the message will be scheduled to this date.
|
|
|
|
* When passing a number, a UNIX time in ms is expected.
|
|
|
|
*/
|
|
|
|
schedule?: Date | number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For bots: inline or reply markup or an instruction
|
|
|
|
* to hide a reply keyboard or to force a reply.
|
|
|
|
*/
|
|
|
|
replyMarkup?: ReplyMarkup
|
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message>
|
2021-04-10 13:28:02 +03:00
|
|
|
/**
|
|
|
|
* Send a single media.
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param media Media contained in the message
|
|
|
|
* @param params Additional sending parameters
|
|
|
|
*/
|
|
|
|
sendMedia(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
media: InputMediaLike,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Message to reply to. Either a message object or message ID.
|
|
|
|
*/
|
|
|
|
replyTo?: number | Message
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Parse mode to use to parse entities before sending
|
|
|
|
* the message. Defaults to current default parse mode (if any).
|
|
|
|
*
|
|
|
|
* Passing `null` will explicitly disable formatting.
|
|
|
|
*/
|
|
|
|
parseMode?: string | null
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to send this message silently.
|
|
|
|
*/
|
|
|
|
silent?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If set, the message will be scheduled to this date.
|
|
|
|
* When passing a number, a UNIX time in ms is expected.
|
|
|
|
*/
|
|
|
|
schedule?: Date | number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For bots: inline or reply markup or an instruction
|
|
|
|
* to hide a reply keyboard or to force a reply.
|
|
|
|
*/
|
|
|
|
replyMarkup?: ReplyMarkup
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function that will be called after some part has been uploaded.
|
|
|
|
* Only used when a file that requires uploading is passed,
|
|
|
|
* and not used when uploading a thumbnail.
|
|
|
|
*
|
|
|
|
* @param uploaded Number of bytes already uploaded
|
|
|
|
* @param total Total file size
|
|
|
|
*/
|
|
|
|
progressCallback?: (uploaded: number, total: number) => void
|
2021-04-14 21:31:51 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to clear draft after sending this message.
|
|
|
|
*
|
|
|
|
* Defaults to `false`
|
|
|
|
*/
|
|
|
|
clearDraft?: boolean
|
2021-04-10 13:28:02 +03:00
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Send a single photo
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param photo Photo contained in the message.
|
|
|
|
* @param params Additional sending parameters
|
|
|
|
*/
|
|
|
|
sendPhoto(
|
|
|
|
chatId: InputPeerLike,
|
2021-04-10 11:51:17 +03:00
|
|
|
photo: InputFileLike,
|
2021-04-08 12:19:38 +03:00
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Caption for the photo
|
|
|
|
*/
|
|
|
|
caption?: string
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Message to reply to. Either a message object or message ID.
|
|
|
|
*/
|
|
|
|
replyTo?: number | Message
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Parse mode to use to parse entities before sending
|
|
|
|
* the message. Defaults to current default parse mode (if any).
|
|
|
|
*
|
|
|
|
* Passing `null` will explicitly disable formatting.
|
|
|
|
*/
|
|
|
|
parseMode?: string | null
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of formatting entities to use instead of parsing via a
|
|
|
|
* parse mode.
|
|
|
|
*
|
|
|
|
* **Note:** Passing this makes the method ignore {@link parseMode}
|
|
|
|
*/
|
|
|
|
entities?: tl.TypeMessageEntity[]
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to send this message silently.
|
|
|
|
*/
|
|
|
|
silent?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If set, the message will be scheduled to this date.
|
|
|
|
* When passing a number, a UNIX time in ms is expected.
|
|
|
|
*/
|
|
|
|
schedule?: Date | number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For bots: inline or reply markup or an instruction
|
|
|
|
* to hide a reply keyboard or to force a reply.
|
|
|
|
*/
|
|
|
|
replyMarkup?: ReplyMarkup
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Self-Destruct timer.
|
|
|
|
* If set, the photo will self-destruct in a given number
|
|
|
|
* of seconds.
|
|
|
|
*/
|
|
|
|
ttlSeconds?: number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function that will be called after some part has been uploaded.
|
|
|
|
* Only used when a file that requires uploading is passed.
|
|
|
|
*
|
|
|
|
* @param uploaded Number of bytes already uploaded
|
|
|
|
* @param total Total file size
|
|
|
|
*/
|
|
|
|
progressCallback?: (uploaded: number, total: number) => void
|
2021-04-14 21:31:51 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to clear draft after sending this message.
|
|
|
|
*
|
|
|
|
* Defaults to `false`
|
|
|
|
*/
|
|
|
|
clearDraft?: boolean
|
2021-04-08 12:19:38 +03:00
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Send a text message
|
|
|
|
*
|
|
|
|
* @param chatId ID of the chat, its username, phone or `"me"` or `"self"`
|
|
|
|
* @param text Text of the message
|
|
|
|
* @param params Additional sending parameters
|
|
|
|
*/
|
|
|
|
sendText(
|
|
|
|
chatId: InputPeerLike,
|
|
|
|
text: string,
|
|
|
|
params?: {
|
|
|
|
/**
|
|
|
|
* Message to reply to. Either a message object or message ID.
|
|
|
|
*/
|
|
|
|
replyTo?: number | Message
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Parse mode to use to parse entities before sending
|
|
|
|
* the message. Defaults to current default parse mode (if any).
|
|
|
|
*
|
|
|
|
* Passing `null` will explicitly disable formatting.
|
|
|
|
*/
|
|
|
|
parseMode?: string | null
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of formatting entities to use instead of parsing via a
|
|
|
|
* parse mode.
|
|
|
|
*
|
|
|
|
* **Note:** Passing this makes the method ignore {@link parseMode}
|
|
|
|
*/
|
|
|
|
entities?: tl.TypeMessageEntity[]
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to disable links preview in this message
|
|
|
|
*/
|
|
|
|
disableWebPreview?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to send this message silently.
|
|
|
|
*/
|
|
|
|
silent?: boolean
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If set, the message will be scheduled to this date.
|
|
|
|
* When passing a number, a UNIX time in ms is expected.
|
|
|
|
*/
|
|
|
|
schedule?: Date | number
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For bots: inline or reply markup or an instruction
|
|
|
|
* to hide a reply keyboard or to force a reply.
|
|
|
|
*/
|
|
|
|
replyMarkup?: ReplyMarkup
|
2021-04-14 21:31:51 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether to clear draft after sending this message.
|
|
|
|
*
|
|
|
|
* Defaults to `false`
|
|
|
|
*/
|
|
|
|
clearDraft?: boolean
|
2021-04-08 12:19:38 +03:00
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<Message>
|
2021-04-11 16:25:17 +03:00
|
|
|
/**
|
|
|
|
* Unpin a message in a group, supergroup, channel or PM.
|
|
|
|
*
|
|
|
|
* For supergroups/channels, you must have appropriate permissions,
|
|
|
|
* either as an admin, or as default permissions
|
|
|
|
*
|
|
|
|
* @param chatId Chat ID, username, phone number, `"self"` or `"me"`
|
|
|
|
* @param messageId Message ID
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
unpinMessage(chatId: InputPeerLike, messageId: number): Promise<void>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Register a given {@link IMessageEntityParser} as a parse mode
|
|
|
|
* for messages. When this method is first called, given parse
|
|
|
|
* mode is also set as default.
|
|
|
|
*
|
|
|
|
* @param parseMode Parse mode to register
|
2021-04-10 18:33:05 +03:00
|
|
|
* @param name (default: `parseMode.name`) Parse mode name. By default is taken from the object.
|
2021-04-08 12:19:38 +03:00
|
|
|
* @throws MtCuteError When the parse mode with a given name is already registered.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
registerParseMode(parseMode: IMessageEntityParser, name?: string): void
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Unregister a parse mode by its name.
|
|
|
|
* Will silently fail if given parse mode does not exist.
|
|
|
|
*
|
|
|
|
* Also updates the default parse mode to the next one available, if any
|
|
|
|
*
|
|
|
|
* @param name Name of the parse mode to unregister
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
unregisterParseMode(name: string): void
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get a {@link IMessageEntityParser} registered under a given name (or a default one).
|
|
|
|
*
|
|
|
|
* @param name Name of the parse mode which parser to get.
|
|
|
|
* @throws MtCuteError When the provided parse mode is not registered
|
|
|
|
* @throws MtCuteError When `name` is omitted and there is no default parse mode
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getParseMode(name?: string | null): IMessageEntityParser
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Set a given parse mode as a default one.
|
|
|
|
*
|
|
|
|
* @param name Name of the parse mode
|
|
|
|
* @throws MtCuteError When given parse mode is not registered.
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
setDefaultParseMode(name: string): void
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
2021-04-23 22:35:37 +03:00
|
|
|
* Base function for update handling. Replace or override this function
|
|
|
|
* and implement your own update handler, and call this function
|
|
|
|
* to handle externally obtained or manually crafted updates.
|
2021-04-08 12:19:38 +03:00
|
|
|
*
|
2021-04-23 22:35:37 +03:00
|
|
|
* Note that this function is called every time an `Update` is received,
|
|
|
|
* not `Updates`. Low-level updates containers are parsed by the library,
|
|
|
|
* and you receive ready to use updates and related entities.
|
|
|
|
* Also note that entity maps may contain entities that are not
|
|
|
|
* used in this particular update, so do not rely on its contents.
|
2021-04-08 12:19:38 +03:00
|
|
|
*
|
2021-04-23 22:35:37 +03:00
|
|
|
* @param update Update that has just happened
|
|
|
|
* @param users Map of users in this update
|
|
|
|
* @param chats Map of chats in this update
|
2021-04-08 12:19:38 +03:00
|
|
|
*/
|
2021-04-23 22:35:37 +03:00
|
|
|
dispatchUpdate(
|
|
|
|
update: tl.TypeUpdate | tl.TypeMessage,
|
|
|
|
users: Record<number, tl.TypeUser>,
|
|
|
|
chats: Record<number, tl.TypeChat>
|
2021-04-18 16:59:05 +03:00
|
|
|
): void
|
2021-04-18 16:23:25 +03:00
|
|
|
/**
|
|
|
|
* Catch up with the server by loading missed updates.
|
|
|
|
*
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
catchUp(): Promise<void>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Block a user
|
|
|
|
*
|
|
|
|
* @param id User ID, its username or phone number
|
|
|
|
* @returns Whether the action was successful
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
blockUser(id: InputPeerLike): Promise<boolean>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get a list of common chats you have with a given user
|
|
|
|
*
|
|
|
|
* @param userId User's ID, username or phone number
|
|
|
|
* @throws MtCuteInvalidPeerTypeError
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getCommonChats(userId: InputPeerLike): Promise<Chat[]>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get currently authorized user's full information
|
|
|
|
*
|
|
|
|
*/
|
2021-04-18 16:59:05 +03:00
|
|
|
getMe(): Promise<User>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get information about a single user.
|
|
|
|
*
|
|
|
|
* @param id User's identifier. Can be ID, username, phone number, `"me"` or `"self"` or TL object
|
|
|
|
*/
|
|
|
|
getUsers(id: InputPeerLike): Promise<User>
|
|
|
|
/**
|
|
|
|
* Get information about multiple users.
|
|
|
|
* You can retrieve up to 200 users at once
|
|
|
|
*
|
|
|
|
* @param ids Users' identifiers. Can be ID, username, phone number, `"me"`, `"self"` or TL object
|
|
|
|
*/
|
|
|
|
getUsers(ids: InputPeerLike[]): Promise<User[]>
|
|
|
|
|
2021-04-18 16:59:05 +03:00
|
|
|
getUsers(ids: MaybeArray<InputPeerLike>): Promise<MaybeArray<User>>
|
2021-04-08 12:19:38 +03:00
|
|
|
/**
|
|
|
|
* Get the `InputPeer` of a known peer id.
|
|
|
|
* Useful when an `InputPeer` is needed.
|
|
|
|
*
|
|
|
|
* @param peerId The peer identifier that you want to extract the `InputPeer` from.
|
|
|
|
*/
|
|
|
|
resolvePeer(
|
|
|
|
peerId: InputPeerLike
|
2021-04-18 16:59:05 +03:00
|
|
|
): Promise<tl.TypeInputPeer | tl.TypeInputUser | tl.TypeInputChannel>
|
|
|
|
}
|
|
|
|
/** @internal */
|
|
|
|
export class TelegramClient extends BaseTelegramClient {
|
|
|
|
protected _userId: number | null
|
|
|
|
protected _isBot: boolean
|
|
|
|
protected _downloadConnections: Record<number, TelegramConnection>
|
|
|
|
protected _parseModes: Record<string, IMessageEntityParser>
|
|
|
|
protected _defaultParseMode: string | null
|
|
|
|
protected _updLock: Lock
|
|
|
|
protected _pts: number
|
|
|
|
protected _date: number
|
|
|
|
protected _cpts: Record<number, number>
|
|
|
|
constructor(opts: BaseTelegramClient.Options) {
|
|
|
|
super(opts)
|
|
|
|
this._userId = null
|
|
|
|
this._isBot = false
|
|
|
|
this._downloadConnections = {}
|
|
|
|
this._parseModes = {}
|
|
|
|
this._defaultParseMode = null
|
|
|
|
this._updLock = new Lock()
|
|
|
|
// we dont need to initialize state fields since
|
|
|
|
// they are always loaded either from the server, or from storage.
|
|
|
|
|
|
|
|
// channel PTS are not loaded immediately, and instead are cached here
|
|
|
|
// after the first time they were retrieved from the storage.
|
|
|
|
// they are later pushed into the storage.
|
|
|
|
this._cpts = {}
|
2021-04-08 12:19:38 +03:00
|
|
|
}
|
2021-04-18 16:59:05 +03:00
|
|
|
|
|
|
|
acceptTos = acceptTos as TelegramClient['acceptTos']
|
|
|
|
checkPassword = checkPassword as TelegramClient['checkPassword']
|
|
|
|
getPasswordHint = getPasswordHint as TelegramClient['getPasswordHint']
|
|
|
|
logOut = logOut as TelegramClient['logOut']
|
|
|
|
recoverPassword = recoverPassword as TelegramClient['recoverPassword']
|
|
|
|
resendCode = resendCode as TelegramClient['resendCode']
|
|
|
|
sendCode = sendCode as TelegramClient['sendCode']
|
|
|
|
sendRecoveryCode = sendRecoveryCode as TelegramClient['sendRecoveryCode']
|
|
|
|
signInBot = signInBot as TelegramClient['signInBot']
|
|
|
|
signIn = signIn as TelegramClient['signIn']
|
|
|
|
signUp = signUp as TelegramClient['signUp']
|
|
|
|
startTest = startTest as TelegramClient['startTest']
|
|
|
|
start = start as TelegramClient['start']
|
|
|
|
addChatMembers = addChatMembers as TelegramClient['addChatMembers']
|
|
|
|
archiveChats = archiveChats as TelegramClient['archiveChats']
|
|
|
|
createChannel = createChannel as TelegramClient['createChannel']
|
|
|
|
createGroup = createGroup as TelegramClient['createGroup']
|
|
|
|
createSupergroup = createSupergroup as TelegramClient['createSupergroup']
|
|
|
|
deleteChannel = deleteChannel as TelegramClient['deleteChannel']
|
|
|
|
deleteSupergroup = deleteChannel as TelegramClient['deleteSupergroup']
|
|
|
|
deleteChatPhoto = deleteChatPhoto as TelegramClient['deleteChatPhoto']
|
|
|
|
deleteGroup = deleteGroup as TelegramClient['deleteGroup']
|
|
|
|
deleteHistory = deleteHistory as TelegramClient['deleteHistory']
|
|
|
|
getChatMember = getChatMember as TelegramClient['getChatMember']
|
|
|
|
getChatMembers = getChatMembers as TelegramClient['getChatMembers']
|
|
|
|
getChatPreview = getChatPreview as TelegramClient['getChatPreview']
|
|
|
|
getChat = getChat as TelegramClient['getChat']
|
|
|
|
getFullChat = getFullChat as TelegramClient['getFullChat']
|
|
|
|
iterChatMembers = iterChatMembers as TelegramClient['iterChatMembers']
|
|
|
|
joinChat = joinChat as TelegramClient['joinChat']
|
|
|
|
leaveChat = leaveChat as TelegramClient['leaveChat']
|
|
|
|
saveDraft = saveDraft as TelegramClient['saveDraft']
|
|
|
|
setChatDefaultPermissions = setChatDefaultPermissions as TelegramClient['setChatDefaultPermissions']
|
|
|
|
setChatDescription = setChatDescription as TelegramClient['setChatDescription']
|
|
|
|
setChatPhoto = setChatPhoto as TelegramClient['setChatPhoto']
|
|
|
|
setChatTitle = setChatTitle as TelegramClient['setChatTitle']
|
|
|
|
setChatUsername = setChatUsername as TelegramClient['setChatUsername']
|
|
|
|
setSlowMode = setSlowMode as TelegramClient['setSlowMode']
|
|
|
|
unarchiveChats = unarchiveChats as TelegramClient['unarchiveChats']
|
|
|
|
createFolder = createFolder as TelegramClient['createFolder']
|
|
|
|
deleteFolder = deleteFolder as TelegramClient['deleteFolder']
|
|
|
|
editFolder = editFolder as TelegramClient['editFolder']
|
|
|
|
getDialogs = getDialogs as TelegramClient['getDialogs']
|
|
|
|
getFolders = getFolders as TelegramClient['getFolders']
|
|
|
|
downloadAsBuffer = downloadAsBuffer as TelegramClient['downloadAsBuffer']
|
|
|
|
downloadToFile = downloadToFile as TelegramClient['downloadToFile']
|
|
|
|
downloadAsIterable = downloadAsIterable as TelegramClient['downloadAsIterable']
|
|
|
|
downloadAsStream = downloadAsStream as TelegramClient['downloadAsStream']
|
|
|
|
uploadFile = uploadFile as TelegramClient['uploadFile']
|
|
|
|
deleteMessages = deleteMessages as TelegramClient['deleteMessages']
|
|
|
|
editMessage = editMessage as TelegramClient['editMessage']
|
|
|
|
protected _findMessageInUpdate = _findMessageInUpdate
|
|
|
|
getHistory = getHistory as TelegramClient['getHistory']
|
|
|
|
getMessages = getMessages as TelegramClient['getMessages']
|
|
|
|
iterHistory = iterHistory as TelegramClient['iterHistory']
|
|
|
|
protected _parseEntities = _parseEntities
|
|
|
|
pinMessage = pinMessage as TelegramClient['pinMessage']
|
|
|
|
searchGlobal = searchGlobal as TelegramClient['searchGlobal']
|
|
|
|
searchMessages = searchMessages as TelegramClient['searchMessages']
|
|
|
|
sendDice = sendDice as TelegramClient['sendDice']
|
|
|
|
sendLocation = sendLocation as TelegramClient['sendLocation']
|
|
|
|
sendMedia = sendMedia as TelegramClient['sendMedia']
|
|
|
|
sendPhoto = sendPhoto as TelegramClient['sendPhoto']
|
|
|
|
sendText = sendText as TelegramClient['sendText']
|
|
|
|
unpinMessage = unpinMessage as TelegramClient['unpinMessage']
|
|
|
|
registerParseMode = registerParseMode as TelegramClient['registerParseMode']
|
|
|
|
unregisterParseMode = unregisterParseMode as TelegramClient['unregisterParseMode']
|
|
|
|
getParseMode = getParseMode as TelegramClient['getParseMode']
|
|
|
|
setDefaultParseMode = setDefaultParseMode as TelegramClient['setDefaultParseMode']
|
|
|
|
protected _fetchUpdatesState = _fetchUpdatesState
|
|
|
|
protected _loadStorage = _loadStorage
|
|
|
|
protected _saveStorage = _saveStorage
|
2021-04-23 22:35:37 +03:00
|
|
|
dispatchUpdate = dispatchUpdate as TelegramClient['dispatchUpdate']
|
2021-04-18 16:59:05 +03:00
|
|
|
protected _handleUpdate = _handleUpdate
|
|
|
|
catchUp = catchUp as TelegramClient['catchUp']
|
|
|
|
blockUser = blockUser as TelegramClient['blockUser']
|
|
|
|
getCommonChats = getCommonChats as TelegramClient['getCommonChats']
|
|
|
|
getMe = getMe as TelegramClient['getMe']
|
|
|
|
getUsers = getUsers as TelegramClient['getUsers']
|
|
|
|
resolvePeer = resolvePeer as TelegramClient['resolvePeer']
|
2021-04-08 12:19:38 +03:00
|
|
|
}
|