From dc2794e17766c601ed89fe019544e287dadb4822 Mon Sep 17 00:00:00 2001 From: Alex Root Junior Date: Sun, 22 Oct 2017 13:59:45 +0300 Subject: [PATCH] Reformat code and pydocs. --- aiogram/bot/bot.py | 959 ++++++++++++++++++++++++++++++--------------- 1 file changed, 645 insertions(+), 314 deletions(-) diff --git a/aiogram/bot/bot.py b/aiogram/bot/bot.py index 2fea9cfc..941f3182 100644 --- a/aiogram/bot/bot.py +++ b/aiogram/bot/bot.py @@ -1,32 +1,37 @@ -""" -File generated by Illemius CodeGenerator v0.1.0 -Date: 2017-10-21 19:12:23.221364 -""" import typing -from aiogram import types -from aiogram.types import base -from aiogram.bot.base import api -from aiogram.bot.base import BaseBot -from aiogram.utils.payload import generate_payload, prepare_arg + +from .base import BaseBot, api +from .. import types +from ..types import base +from ..utils.payload import generate_payload, prepare_arg class Bot(BaseBot): - async def get_updates(self, offset: typing.Union[base.Integer, None] = None, limit: typing.Union[base.Integer, None] = None, timeout: typing.Union[base.Integer, None] = None, allowed_updates: typing.Union[typing.List[base.String], None] = None) -> typing.List[types.Update]: + """ + Base bot class + """ + + async def get_updates(self, offset: typing.Union[base.Integer, None] = None, + limit: typing.Union[base.Integer, None] = None, + timeout: typing.Union[base.Integer, None] = None, + allowed_updates: + typing.Union[typing.List[base.String], None] = None) -> typing.List[types.Update]: """ - Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned. + Use this method to receive incoming updates using long polling (wiki). + Notes 1. This method will not work if an outgoing webhook is set up. 2. In order to avoid getting duplicate updates, recalculate offset after each server response. - Source https://core.telegram.org/bots/apigetupdates + Source: https://core.telegram.org/bots/apigetupdates - :param offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten. + :param offset: Identifier of the first update to be returned. :type offset: :obj:`typing.Union[base.Integer, None]` - :param limit: Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. + :param limit: Limits the number of updates to be retrieved. :type limit: :obj:`typing.Union[base.Integer, None]` - :param timeout: Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. + :param timeout: Timeout in seconds for long polling. :type timeout: :obj:`typing.Union[base.Integer, None]` - :param allowed_updates: List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. + :param allowed_updates: List the types of updates you want your bot to receive. :type allowed_updates: :obj:`typing.Union[typing.List[base.String], None]` :return: An Array of Update objects is returned. :rtype: :obj:`typing.List[types.Update]` @@ -37,25 +42,26 @@ class Bot(BaseBot): return [types.Update(**update) for update in result] - async def set_webhook(self, url: base.String, certificate: typing.Union[base.InputFile, None] = None, max_connections: typing.Union[base.Integer, None] = None, allowed_updates: typing.Union[typing.List[base.String], None] = None) -> base.Boolean: + async def set_webhook(self, url: base.String, + certificate: typing.Union[base.InputFile, None] = None, + max_connections: typing.Union[base.Integer, None] = None, + allowed_updates: typing.Union[typing.List[base.String], None] = None) -> base.Boolean: """ - Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns true. - If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/. Since nobody else knows your bot‘s token, you can be pretty sure it’s us. - Notes - 1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. - 2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work. - 3. Ports currently supported for Webhooks: 443, 80, 88, 8443. - NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks. + Use this method to specify a url and receive incoming updates via an outgoing webhook. + Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, + containing a JSON-serialized Update. In case of an unsuccessful request, + we will give up after a reasonable amount of attempts. - Source https://core.telegram.org/bots/apisetwebhook + Source: https://core.telegram.org/bots/apisetwebhook :param url: HTTPS url to send updates to. Use an empty string to remove webhook integration :type url: :obj:`base.String` - :param certificate: Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. + :param certificate: Upload your public key certificate so that the root certificate in use can be checked. :type certificate: :obj:`typing.Union[base.InputFile, None]` - :param max_connections: Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot‘s server, and higher values to increase your bot’s throughput. + :param max_connections: Maximum allowed number of simultaneous HTTPS connections to the webhook + for update delivery, 1-100. :type max_connections: :obj:`typing.Union[base.Integer, None]` - :param allowed_updates: List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. + :param allowed_updates: List the types of updates you want your bot to receive. :type allowed_updates: :obj:`typing.Union[typing.List[base.String], None]` :return: Returns true. :rtype: :obj:`base.Boolean` @@ -68,9 +74,10 @@ class Bot(BaseBot): async def delete_webhook(self) -> base.Boolean: """ - Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters. + Use this method to remove webhook integration if you decide to switch back to getUpdates. + Returns True on success. Requires no parameters. - Source https://core.telegram.org/bots/apideletewebhook + Source: https://core.telegram.org/bots/apideletewebhook :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -82,11 +89,13 @@ class Bot(BaseBot): async def get_webhook_info(self) -> types.WebhookInfo: """ - Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty. + Use this method to get current webhook status. Requires no parameters. + + If the bot is using getUpdates, will return an object with the url field empty. - Source https://core.telegram.org/bots/apigetwebhookinfo + Source: https://core.telegram.org/bots/apigetwebhookinfo - :return: On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty. + :return: On success, returns a WebhookInfo object. :rtype: :obj:`types.WebhookInfo` """ payload = generate_payload(**locals()) @@ -96,9 +105,9 @@ class Bot(BaseBot): async def get_me(self) -> types.User: """ - A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object. + A simple method for testing your bot's auth token. Requires no parameters. - Source https://core.telegram.org/bots/apigetme + Source: https://core.telegram.org/bots/apigetme :return: Returns basic information about the bot in form of a User object. :rtype: :obj:`types.User` @@ -108,17 +117,26 @@ class Bot(BaseBot): return types.User(**result) - async def send_message(self, chat_id: typing.Union[base.Integer, base.String], text: base.String, parse_mode: typing.Union[base.String, None] = None, disable_web_page_preview: typing.Union[base.Boolean, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_message(self, chat_id: typing.Union[base.Integer, base.String], text: base.String, + parse_mode: typing.Union[base.String, None] = None, + disable_web_page_preview: typing.Union[base.Boolean, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send text messages. On success, the sent Message is returned. + Use this method to send text messages. - Source https://core.telegram.org/bots/apisendmessage + Source: https://core.telegram.org/bots/apisendmessage - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param text: Text of the message to be sent :type text: :obj:`base.String` - :param parse_mode: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. + :param parse_mode: Send Markdown or HTML, if you want Telegram apps to show bold, italic, + fixed-width text or inline URLs in your bot's message. :type parse_mode: :obj:`typing.Union[base.String, None]` :param disable_web_page_preview: Disables link previews for links in this message :type disable_web_page_preview: :obj:`typing.Union[base.Boolean, None]` @@ -126,8 +144,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -137,15 +156,17 @@ class Bot(BaseBot): return types.Message(**result) - async def forward_message(self, chat_id: typing.Union[base.Integer, base.String], from_chat_id: typing.Union[base.Integer, base.String], message_id: base.Integer, disable_notification: typing.Union[base.Boolean, None] = None) -> types.Message: + async def forward_message(self, chat_id: typing.Union[base.Integer, base.String], + from_chat_id: typing.Union[base.Integer, base.String], message_id: base.Integer, + disable_notification: typing.Union[base.Boolean, None] = None) -> types.Message: """ - Use this method to forward messages of any kind. On success, the sent Message is returned. + Use this method to forward messages of any kind. - Source https://core.telegram.org/bots/apiforwardmessage + Source: https://core.telegram.org/bots/apiforwardmessage - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) + :param from_chat_id: Unique identifier for the chat where the original message was sent :type from_chat_id: :obj:`typing.Union[base.Integer, base.String]` :param disable_notification: Sends the message silently. Users will receive a notification with no sound. :type disable_notification: :obj:`typing.Union[base.Boolean, None]` @@ -159,15 +180,23 @@ class Bot(BaseBot): return types.Message(**result) - async def send_photo(self, chat_id: typing.Union[base.Integer, base.String], photo: typing.Union[base.InputFile, base.String], caption: typing.Union[base.String, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_photo(self, chat_id: typing.Union[base.Integer, base.String], + photo: typing.Union[base.InputFile, base.String], + caption: typing.Union[base.String, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send photos. On success, the sent Message is returned. + Use this method to send photos. - Source https://core.telegram.org/bots/apisendphoto + Source: https://core.telegram.org/bots/apisendphoto - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. + :param photo: Photo to send. :type photo: :obj:`typing.Union[base.InputFile, base.String]` :param caption: Photo caption (may also be used when resending photos by file_id), 0-200 characters :type caption: :obj:`typing.Union[base.String, None]` @@ -175,8 +204,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -186,16 +216,29 @@ class Bot(BaseBot): return types.Message(**result) - async def send_audio(self, chat_id: typing.Union[base.Integer, base.String], audio: typing.Union[base.InputFile, base.String], caption: typing.Union[base.String, None] = None, duration: typing.Union[base.Integer, None] = None, performer: typing.Union[base.String, None] = None, title: typing.Union[base.String, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_audio(self, chat_id: typing.Union[base.Integer, base.String], + audio: typing.Union[base.InputFile, base.String], + caption: typing.Union[base.String, None] = None, + duration: typing.Union[base.Integer, None] = None, + performer: typing.Union[base.String, None] = None, + title: typing.Union[base.String, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. + Use this method to send audio files, if you want Telegram clients to display them in the music player. + Your audio must be in the .mp3 format. + For sending voice messages, use the sendVoice method instead. - Source https://core.telegram.org/bots/apisendaudio + Source: https://core.telegram.org/bots/apisendaudio - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param audio: Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. + :param audio: Audio file to send. :type audio: :obj:`typing.Union[base.InputFile, base.String]` :param caption: Audio caption, 0-200 characters :type caption: :obj:`typing.Union[base.String, None]` @@ -209,8 +252,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -220,15 +264,25 @@ class Bot(BaseBot): return types.Message(**result) - async def send_document(self, chat_id: typing.Union[base.Integer, base.String], document: typing.Union[base.InputFile, base.String], caption: typing.Union[base.String, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_document(self, chat_id: typing.Union[base.Integer, base.String], + document: typing.Union[base.InputFile, base.String], + caption: typing.Union[base.String, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. + Use this method to send general files. + + Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. - Source https://core.telegram.org/bots/apisenddocument + Source: https://core.telegram.org/bots/apisenddocument - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param document: File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :param document: File to send. :type document: :obj:`typing.Union[base.InputFile, base.String]` :param caption: Document caption (may also be used when resending documents by file_id), 0-200 characters :type caption: :obj:`typing.Union[base.String, None]` @@ -236,8 +290,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -247,15 +302,27 @@ class Bot(BaseBot): return types.Message(**result) - async def send_video(self, chat_id: typing.Union[base.Integer, base.String], video: typing.Union[base.InputFile, base.String], duration: typing.Union[base.Integer, None] = None, width: typing.Union[base.Integer, None] = None, height: typing.Union[base.Integer, None] = None, caption: typing.Union[base.String, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_video(self, chat_id: typing.Union[base.Integer, base.String], + video: typing.Union[base.InputFile, base.String], + duration: typing.Union[base.Integer, None] = None, + width: typing.Union[base.Integer, None] = None, + height: typing.Union[base.Integer, None] = None, + caption: typing.Union[base.String, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. + Use this method to send video files, Telegram clients support mp4 videos + (other formats may be sent as Document). - Source https://core.telegram.org/bots/apisendvideo + Source: https://core.telegram.org/bots/apisendvideo - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param video: Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. + :param video: Video to send. :type video: :obj:`typing.Union[base.InputFile, base.String]` :param duration: Duration of sent video in seconds :type duration: :obj:`typing.Union[base.Integer, None]` @@ -269,8 +336,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -280,15 +348,28 @@ class Bot(BaseBot): return types.Message(**result) - async def send_voice(self, chat_id: typing.Union[base.Integer, base.String], voice: typing.Union[base.InputFile, base.String], caption: typing.Union[base.String, None] = None, duration: typing.Union[base.Integer, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_voice(self, chat_id: typing.Union[base.Integer, base.String], + voice: typing.Union[base.InputFile, base.String], + caption: typing.Union[base.String, None] = None, + duration: typing.Union[base.Integer, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. + Use this method to send audio files, if you want Telegram clients to display the file + as a playable voice message. + + For this to work, your audio must be in an .ogg file encoded with OPUS + (other formats may be sent as Audio or Document). - Source https://core.telegram.org/bots/apisendvoice + Source: https://core.telegram.org/bots/apisendvoice - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param voice: Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :param voice: Audio file to send. :type voice: :obj:`typing.Union[base.InputFile, base.String]` :param caption: Voice message caption, 0-200 characters :type caption: :obj:`typing.Union[base.String, None]` @@ -298,8 +379,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -309,15 +391,25 @@ class Bot(BaseBot): return types.Message(**result) - async def send_video_note(self, chat_id: typing.Union[base.Integer, base.String], video_note: typing.Union[base.InputFile, base.String], duration: typing.Union[base.Integer, None] = None, length: typing.Union[base.Integer, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_video_note(self, chat_id: typing.Union[base.Integer, base.String], + video_note: typing.Union[base.InputFile, base.String], + duration: typing.Union[base.Integer, None] = None, + length: typing.Union[base.Integer, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned. + As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. + Use this method to send video messages. - Source https://core.telegram.org/bots/apisendvideonote + Source: https://core.telegram.org/bots/apisendvideonote - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param video_note: Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. . Sending video notes by a URL is currently unsupported + :param video_note: Video note to send. :type video_note: :obj:`typing.Union[base.InputFile, base.String]` :param duration: Duration of sent video in seconds :type duration: :obj:`typing.Union[base.Integer, None]` @@ -327,8 +419,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -338,26 +431,34 @@ class Bot(BaseBot): return types.Message(**result) - async def send_location(self, chat_id: typing.Union[base.Integer, base.String], latitude: base.Float, longitude: base.Float, live_period: typing.Union[base.Integer, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_location(self, chat_id: typing.Union[base.Integer, base.String], latitude: base.Float, + longitude: base.Float, live_period: typing.Union[base.Integer, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send point on the map. On success, the sent Message is returned. + Use this method to send point on the map. - Source https://core.telegram.org/bots/apisendlocation + Source: https://core.telegram.org/bots/apisendlocation - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param latitude: Latitude of the location :type latitude: :obj:`base.Float` :param longitude: Longitude of the location :type longitude: :obj:`base.Float` - :param live_period: Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. + :param live_period: Period in seconds for which the location will be updated :type live_period: :obj:`typing.Union[base.Integer, None]` :param disable_notification: Sends the message silently. Users will receive a notification with no sound. :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -367,14 +468,21 @@ class Bot(BaseBot): return types.Message(**result) - async def edit_message_live_location(self, latitude: base.Float, longitude: base.Float, chat_id: typing.Union[typing.Union[base.Integer, base.String], None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> typing.Union[types.Message, base.Boolean]: + async def edit_message_live_location(self, latitude: base.Float, longitude: base.Float, + chat_id: typing.Union[base.Integer, base.String, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + None] = None) -> types.Message or base.Boolean: """ - Use this method to edit live location messages sent by the bot or via the bot (for inline bots). A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned. + Use this method to edit live location messages sent by the bot or via the bot (for inline bots). + A location can be edited until its live_period expires or editing is explicitly disabled by a call + to stopMessageLiveLocation. - Source https://core.telegram.org/bots/apieditmessagelivelocation + Source: https://core.telegram.org/bots/apieditmessagelivelocation - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :type chat_id: :obj:`typing.Union[typing.Union[base.Integer, base.String], None]` + :param chat_id: Required if inline_message_id is not specified. + :type chat_id: :obj:`typing.Union[base.Integer, base.String, None]` :param message_id: Required if inline_message_id is not specified. Identifier of the sent message :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message @@ -385,7 +493,8 @@ class Bot(BaseBot): :type longitude: :obj:`base.Float` :param reply_markup: A JSON-serialized object for a new inline keyboard. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` - :return: On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned. + :return: On success, if the edited message was sent by the bot, the edited Message is returned, + otherwise True is returned. :rtype: :obj:`typing.Union[types.Message, base.Boolean]` """ reply_markup = prepare_arg(reply_markup) @@ -397,21 +506,28 @@ class Bot(BaseBot): return types.Message(**result) - async def stop_message_live_location(self, chat_id: typing.Union[typing.Union[base.Integer, base.String], None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> typing.Union[types.Message, base.Boolean]: + async def stop_message_live_location(self, + chat_id: typing.Union[base.Integer, base.String, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + None] = None) -> types.Message or base.Boolean: """ - Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned. + Use this method to stop updating a live location message sent by the bot or via the bot + (for inline bots) before live_period expires. - Source https://core.telegram.org/bots/apistopmessagelivelocation + Source: https://core.telegram.org/bots/apistopmessagelivelocation - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :type chat_id: :obj:`typing.Union[typing.Union[base.Integer, base.String], None]` + :param chat_id: Required if inline_message_id is not specified. + :type chat_id: :obj:`typing.Union[base.Integer, base.String, None]` :param message_id: Required if inline_message_id is not specified. Identifier of the sent message :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message :type inline_message_id: :obj:`typing.Union[base.String, None]` :param reply_markup: A JSON-serialized object for a new inline keyboard. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` - :return: On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned. + :return: On success, if the message was sent by the bot, the sent Message is returned, + otherwise True is returned. :rtype: :obj:`typing.Union[types.Message, base.Boolean]` """ reply_markup = prepare_arg(reply_markup) @@ -423,13 +539,21 @@ class Bot(BaseBot): return types.Message(**result) - async def send_venue(self, chat_id: typing.Union[base.Integer, base.String], latitude: base.Float, longitude: base.Float, title: base.String, address: base.String, foursquare_id: typing.Union[base.String, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_venue(self, chat_id: typing.Union[base.Integer, base.String], + latitude: base.Float, longitude: base.Float, title: base.String, address: base.String, + foursquare_id: typing.Union[base.String, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send information about a venue. On success, the sent Message is returned. + Use this method to send information about a venue. - Source https://core.telegram.org/bots/apisendvenue + Source: https://core.telegram.org/bots/apisendvenue - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param latitude: Latitude of the venue :type latitude: :obj:`base.Float` @@ -445,8 +569,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -456,13 +581,21 @@ class Bot(BaseBot): return types.Message(**result) - async def send_contact(self, chat_id: typing.Union[base.Integer, base.String], phone_number: base.String, first_name: base.String, last_name: typing.Union[base.String, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_contact(self, chat_id: typing.Union[base.Integer, base.String], + phone_number: base.String, + first_name: base.String, last_name: typing.Union[base.String, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send phone contacts. On success, the sent Message is returned. + Use this method to send phone contacts. - Source https://core.telegram.org/bots/apisendcontact + Source: https://core.telegram.org/bots/apisendcontact - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param phone_number: Contact's phone number :type phone_number: :obj:`base.String` @@ -474,8 +607,9 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -485,17 +619,21 @@ class Bot(BaseBot): return types.Message(**result) - async def send_chat_action(self, chat_id: typing.Union[base.Integer, base.String], action: base.String) -> base.Boolean: + async def send_chat_action(self, chat_id: typing.Union[base.Integer, base.String], + action: base.String) -> base.Boolean: """ - Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. - Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot. - We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. + Use this method when you need to tell the user that something is happening on the bot's side. + The status is set for 5 seconds or less + (when a message arrives from your bot, Telegram clients clear its typing status). + + We only recommend using this method when a response from the bot will take + a noticeable amount of time to arrive. - Source https://core.telegram.org/bots/apisendchataction + Source: https://core.telegram.org/bots/apisendchataction - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param action: Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes. + :param action: Type of action to broadcast. :type action: :obj:`base.String` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -505,11 +643,12 @@ class Bot(BaseBot): return result - async def get_user_profile_photos(self, user_id: base.Integer, offset: typing.Union[base.Integer, None] = None, limit: typing.Union[base.Integer, None] = None) -> types.UserProfilePhotos: + async def get_user_profile_photos(self, user_id: base.Integer, offset: typing.Union[base.Integer, None] = None, + limit: typing.Union[base.Integer, None] = None) -> types.UserProfilePhotos: """ Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. - Source https://core.telegram.org/bots/apigetuserprofilephotos + Source: https://core.telegram.org/bots/apigetuserprofilephotos :param user_id: Unique identifier of the target user :type user_id: :obj:`base.Integer` @@ -527,10 +666,13 @@ class Bot(BaseBot): async def get_file(self, file_id: base.String) -> types.File: """ - Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot/, where is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. - Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. + Use this method to get basic info about a file and prepare it for downloading. + For the moment, bots can download files of up to 20MB in size. - Source https://core.telegram.org/bots/apigetfile + Note: This function may not preserve the original file name and MIME type. + You should save the file's MIME type and name (if available) when the File object is received. + + Source: https://core.telegram.org/bots/apigetfile :param file_id: File identifier to get info about :type file_id: :obj:`base.String` @@ -542,20 +684,28 @@ class Bot(BaseBot): return types.File(**result) - async def kick_chat_member(self, chat_id: typing.Union[base.Integer, base.String], user_id: base.Integer, until_date: typing.Union[base.Integer, None] = None) -> base.Boolean: + async def kick_chat_member(self, chat_id: typing.Union[base.Integer, base.String], user_id: base.Integer, + until_date: typing.Union[base.Integer, None] = None) -> base.Boolean: """ - Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. - Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. Otherwise members may only be removed by the group's creator or by the member that added them. + Use this method to kick a user from a group, a supergroup or a channel. + In the case of supergroups and channels, the user will not be able to return to the group + on their own using invite links, etc., unless unbanned first. + + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. - Source https://core.telegram.org/bots/apikickchatmember + Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting + is off in the target group. + Otherwise members may only be removed by the group's creator or by the member that added them. - :param chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) + Source: https://core.telegram.org/bots/apikickchatmember + + :param chat_id: Unique identifier for the target group or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param user_id: Unique identifier of the target user :type user_id: :obj:`base.Integer` - :param until_date: Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever + :param until_date: Date when the user will be unbanned, unix time. :type until_date: :obj:`typing.Union[base.Integer, None]` - :return: In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc. Returns True on success. + :return: Returns True on success. :rtype: :obj:`base.Boolean` """ until_date = prepare_arg(until_date) @@ -564,17 +714,21 @@ class Bot(BaseBot): return result - async def unban_chat_member(self, chat_id: typing.Union[base.Integer, base.String], user_id: base.Integer) -> base.Boolean: + async def unban_chat_member(self, chat_id: typing.Union[base.Integer, base.String], + user_id: base.Integer) -> base.Boolean: """ - Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success. + Use this method to unban a previously kicked user in a supergroup or channel. ` + The user will not return to the group or channel automatically, but will be able to join via link, etc. + + The bot must be an administrator for this to work. - Source https://core.telegram.org/bots/apiunbanchatmember + Source: https://core.telegram.org/bots/apiunbanchatmember - :param chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format @username) + :param chat_id: Unique identifier for the target group or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param user_id: Unique identifier of the target user :type user_id: :obj:`base.Integer` - :return: The user will not return to the group or channel automatically, but will be able to join via link, etc. Returns True on success. + :return: Returns True on success. :rtype: :obj:`base.Boolean` """ payload = generate_payload(**locals()) @@ -582,25 +736,36 @@ class Bot(BaseBot): return result - async def restrict_chat_member(self, chat_id: typing.Union[base.Integer, base.String], user_id: base.Integer, until_date: typing.Union[base.Integer, None] = None, can_send_messages: typing.Union[base.Boolean, None] = None, can_send_media_messages: typing.Union[base.Boolean, None] = None, can_send_other_messages: typing.Union[base.Boolean, None] = None, can_add_web_page_previews: typing.Union[base.Boolean, None] = None) -> base.Boolean: + async def restrict_chat_member(self, chat_id: typing.Union[base.Integer, base.String], + user_id: base.Integer, + until_date: typing.Union[base.Integer, None] = None, + can_send_messages: typing.Union[base.Boolean, None] = None, + can_send_media_messages: typing.Union[base.Boolean, None] = None, + can_send_other_messages: typing.Union[base.Boolean, None] = None, + can_add_web_page_previews: typing.Union[base.Boolean, None] = None) -> base.Boolean: """ - Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success. + Use this method to restrict a user in a supergroup. + The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. + Pass True for all boolean parameters to lift restrictions from a user. - Source https://core.telegram.org/bots/apirestrictchatmember + Source: https://core.telegram.org/bots/apirestrictchatmember - :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param user_id: Unique identifier of the target user :type user_id: :obj:`base.Integer` - :param until_date: Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever + :param until_date: Date when restrictions will be lifted for the user, unix time. :type until_date: :obj:`typing.Union[base.Integer, None]` :param can_send_messages: Pass True, if the user can send text messages, contacts, locations and venues :type can_send_messages: :obj:`typing.Union[base.Boolean, None]` - :param can_send_media_messages: Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages + :param can_send_media_messages: Pass True, if the user can send audios, documents, photos, videos, + video notes and voice notes, implies can_send_messages :type can_send_media_messages: :obj:`typing.Union[base.Boolean, None]` - :param can_send_other_messages: Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages + :param can_send_other_messages: Pass True, if the user can send animations, games, stickers and + use inline bots, implies can_send_media_messages :type can_send_other_messages: :obj:`typing.Union[base.Boolean, None]` - :param can_add_web_page_previews: Pass True, if the user may add web page previews to their messages, implies can_send_media_messages + :param can_add_web_page_previews: Pass True, if the user may add web page previews to their messages, + implies can_send_media_messages :type can_add_web_page_previews: :obj:`typing.Union[base.Boolean, None]` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -611,13 +776,24 @@ class Bot(BaseBot): return result - async def promote_chat_member(self, chat_id: typing.Union[base.Integer, base.String], user_id: base.Integer, can_change_info: typing.Union[base.Boolean, None] = None, can_post_messages: typing.Union[base.Boolean, None] = None, can_edit_messages: typing.Union[base.Boolean, None] = None, can_delete_messages: typing.Union[base.Boolean, None] = None, can_invite_users: typing.Union[base.Boolean, None] = None, can_restrict_members: typing.Union[base.Boolean, None] = None, can_pin_messages: typing.Union[base.Boolean, None] = None, can_promote_members: typing.Union[base.Boolean, None] = None) -> base.Boolean: + async def promote_chat_member(self, chat_id: typing.Union[base.Integer, base.String], + user_id: base.Integer, + can_change_info: typing.Union[base.Boolean, None] = None, + can_post_messages: typing.Union[base.Boolean, None] = None, + can_edit_messages: typing.Union[base.Boolean, None] = None, + can_delete_messages: typing.Union[base.Boolean, None] = None, + can_invite_users: typing.Union[base.Boolean, None] = None, + can_restrict_members: typing.Union[base.Boolean, None] = None, + can_pin_messages: typing.Union[base.Boolean, None] = None, + can_promote_members: typing.Union[base.Boolean, None] = None) -> base.Boolean: """ - Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success. + Use this method to promote or demote a user in a supergroup or a channel. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + Pass False for all boolean parameters to demote a user. - Source https://core.telegram.org/bots/apipromotechatmember + Source: https://core.telegram.org/bots/apipromotechatmember - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param user_id: Unique identifier of the target user :type user_id: :obj:`base.Integer` @@ -635,7 +811,9 @@ class Bot(BaseBot): :type can_restrict_members: :obj:`typing.Union[base.Boolean, None]` :param can_pin_messages: Pass True, if the administrator can pin messages, supergroups only :type can_pin_messages: :obj:`typing.Union[base.Boolean, None]` - :param can_promote_members: Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) + :param can_promote_members: Pass True, if the administrator can add new administrators + with a subset of his own privileges or demote administrators that he has promoted, + directly or indirectly (promoted by administrators that were appointed by him) :type can_promote_members: :obj:`typing.Union[base.Boolean, None]` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -647,11 +825,12 @@ class Bot(BaseBot): async def export_chat_invite_link(self, chat_id: typing.Union[base.Integer, base.String]) -> base.String: """ - Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns exported invite link as String on success. + Use this method to export an invite link to a supergroup or a channel. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. - Source https://core.telegram.org/bots/apiexportchatinvitelink + Source: https://core.telegram.org/bots/apiexportchatinvitelink - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :return: Returns exported invite link as String on success. :rtype: :obj:`base.String` @@ -661,14 +840,18 @@ class Bot(BaseBot): return result - async def set_chat_photo(self, chat_id: typing.Union[base.Integer, base.String], photo: base.InputFile) -> base.Boolean: + async def set_chat_photo(self, chat_id: typing.Union[base.Integer, base.String], + photo: base.InputFile) -> base.Boolean: """ - Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. - Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. + Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + + Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ + setting is off in the target group. - Source https://core.telegram.org/bots/apisetchatphoto + Source: https://core.telegram.org/bots/apisetchatphoto - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param photo: New chat photo, uploaded using multipart/form-data :type photo: :obj:`base.InputFile` @@ -682,12 +865,15 @@ class Bot(BaseBot): async def delete_chat_photo(self, chat_id: typing.Union[base.Integer, base.String]) -> base.Boolean: """ - Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. - Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. + Use this method to delete a chat photo. Photos can't be changed for private chats. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. - Source https://core.telegram.org/bots/apideletechatphoto + Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ + setting is off in the target group. - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + Source: https://core.telegram.org/bots/apideletechatphoto + + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -697,14 +883,18 @@ class Bot(BaseBot): return result - async def set_chat_title(self, chat_id: typing.Union[base.Integer, base.String], title: base.String) -> base.Boolean: + async def set_chat_title(self, chat_id: typing.Union[base.Integer, base.String], + title: base.String) -> base.Boolean: """ - Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. - Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. + Use this method to change the title of a chat. Titles can't be changed for private chats. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + + Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ + setting is off in the target group. - Source https://core.telegram.org/bots/apisetchattitle + Source: https://core.telegram.org/bots/apisetchattitle - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param title: New chat title, 1-255 characters :type title: :obj:`base.String` @@ -716,13 +906,15 @@ class Bot(BaseBot): return result - async def set_chat_description(self, chat_id: typing.Union[base.Integer, base.String], description: typing.Union[base.String, None] = None) -> base.Boolean: + async def set_chat_description(self, chat_id: typing.Union[base.Integer, base.String], + description: typing.Union[base.String, None] = None) -> base.Boolean: """ - Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. + Use this method to change the description of a supergroup or a channel. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. - Source https://core.telegram.org/bots/apisetchatdescription + Source: https://core.telegram.org/bots/apisetchatdescription - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param description: New chat description, 0-255 characters :type description: :obj:`typing.Union[base.String, None]` @@ -734,17 +926,20 @@ class Bot(BaseBot): return result - async def pin_chat_message(self, chat_id: typing.Union[base.Integer, base.String], message_id: base.Integer, disable_notification: typing.Union[base.Boolean, None] = None) -> base.Boolean: + async def pin_chat_message(self, chat_id: typing.Union[base.Integer, base.String], message_id: base.Integer, + disable_notification: typing.Union[base.Boolean, None] = None) -> base.Boolean: """ - Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. + Use this method to pin a message in a supergroup. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. - Source https://core.telegram.org/bots/apipinchatmessage + Source: https://core.telegram.org/bots/apipinchatmessage - :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param message_id: Identifier of a message to pin :type message_id: :obj:`base.Integer` - :param disable_notification: Pass True, if it is not necessary to send a notification to all group members about the new pinned message + :param disable_notification: Pass True, if it is not necessary to send a notification to + all group members about the new pinned message :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -756,11 +951,12 @@ class Bot(BaseBot): async def unpin_chat_message(self, chat_id: typing.Union[base.Integer, base.String]) -> base.Boolean: """ - Use this method to unpin a message in a supergroup chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. + Use this method to unpin a message in a supergroup chat. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. - Source https://core.telegram.org/bots/apiunpinchatmessage + Source: https://core.telegram.org/bots/apiunpinchatmessage - :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -772,11 +968,11 @@ class Bot(BaseBot): async def leave_chat(self, chat_id: typing.Union[base.Integer, base.String]) -> base.Boolean: """ - Use this method for your bot to leave a group, supergroup or channel. Returns True on success. + Use this method for your bot to leave a group, supergroup or channel. - Source https://core.telegram.org/bots/apileavechat + Source: https://core.telegram.org/bots/apileavechat - :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :return: Returns True on success. :rtype: :obj:`base.Boolean` @@ -788,11 +984,12 @@ class Bot(BaseBot): async def get_chat(self, chat_id: typing.Union[base.Integer, base.String]) -> types.Chat: """ - Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success. + Use this method to get up to date information about the chat + (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). - Source https://core.telegram.org/bots/apigetchat + Source: https://core.telegram.org/bots/apigetchat - :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :return: Returns a Chat object on success. :rtype: :obj:`types.Chat` @@ -802,15 +999,19 @@ class Bot(BaseBot): return types.Chat(**result) - async def get_chat_administrators(self, chat_id: typing.Union[base.Integer, base.String]) -> typing.List[types.ChatMember]: + async def get_chat_administrators(self, chat_id: typing.Union[base.Integer, base.String] + ) -> typing.List[types.ChatMember]: """ - Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. + Use this method to get a list of administrators in a chat. - Source https://core.telegram.org/bots/apigetchatadministrators + Source: https://core.telegram.org/bots/apigetchatadministrators - :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :return: On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. + :return: On success, returns an Array of ChatMember objects that contains information about all + chat administrators except other bots. + If the chat is a group or a supergroup and no administrators were appointed, + only the creator will be returned. :rtype: :obj:`typing.List[types.ChatMember]` """ payload = generate_payload(**locals()) @@ -820,11 +1021,11 @@ class Bot(BaseBot): async def get_chat_members_count(self, chat_id: typing.Union[base.Integer, base.String]) -> base.Integer: """ - Use this method to get the number of members in a chat. Returns Int on success. + Use this method to get the number of members in a chat. - Source https://core.telegram.org/bots/apigetchatmemberscount + Source: https://core.telegram.org/bots/apigetchatmemberscount - :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :return: Returns Int on success. :rtype: :obj:`base.Integer` @@ -834,13 +1035,14 @@ class Bot(BaseBot): return result - async def get_chat_member(self, chat_id: typing.Union[base.Integer, base.String], user_id: base.Integer) -> types.ChatMember: + async def get_chat_member(self, chat_id: typing.Union[base.Integer, base.String], + user_id: base.Integer) -> types.ChatMember: """ - Use this method to get information about a member of a chat. Returns a ChatMember object on success. + Use this method to get information about a member of a chat. - Source https://core.telegram.org/bots/apigetchatmember + Source: https://core.telegram.org/bots/apigetchatmember - :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param user_id: Unique identifier of the target user :type user_id: :obj:`base.Integer` @@ -852,17 +1054,22 @@ class Bot(BaseBot): return types.ChatMember(**result) - async def set_chat_sticker_set(self, chat_id: typing.Union[base.Integer, base.String], sticker_set_name: base.String) -> base.Boolean: + async def set_chat_sticker_set(self, chat_id: typing.Union[base.Integer, base.String], + sticker_set_name: base.String) -> base.Boolean: """ - Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. + Use this method to set a new group sticker set for a supergroup. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + + Use the field can_set_sticker_set optionally returned in getChat requests to check + if the bot can use this method. - Source https://core.telegram.org/bots/apisetchatstickerset + Source: https://core.telegram.org/bots/apisetchatstickerset - :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param sticker_set_name: Name of the sticker set to be set as the group sticker set :type sticker_set_name: :obj:`base.String` - :return: Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. + :return: Returns True on success. :rtype: :obj:`base.Boolean` """ payload = generate_payload(**locals()) @@ -872,13 +1079,17 @@ class Bot(BaseBot): async def delete_chat_sticker_set(self, chat_id: typing.Union[base.Integer, base.String]) -> base.Boolean: """ - Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. + Use this method to delete a group sticker set from a supergroup. + The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + + Use the field can_set_sticker_set optionally returned in getChat requests + to check if the bot can use this method. - Source https://core.telegram.org/bots/apideletechatstickerset + Source: https://core.telegram.org/bots/apideletechatstickerset - :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :return: Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. + :return: Returns True on success. :rtype: :obj:`base.Boolean` """ payload = generate_payload(**locals()) @@ -886,22 +1097,31 @@ class Bot(BaseBot): return result - async def answer_callback_query(self, callback_query_id: base.String, text: typing.Union[base.String, None] = None, show_alert: typing.Union[base.Boolean, None] = None, url: typing.Union[base.String, None] = None, cache_time: typing.Union[base.Integer, None] = None) -> base.Boolean: + async def answer_callback_query(self, callback_query_id: base.String, text: typing.Union[base.String, None] = None, + show_alert: typing.Union[base.Boolean, None] = None, + url: typing.Union[base.String, None] = None, + cache_time: typing.Union[base.Integer, None] = None) -> base.Boolean: """ - Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned. - Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. + Use this method to send answers to callback queries sent from inline keyboards. + The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. - Source https://core.telegram.org/bots/apianswercallbackquery + Alternatively, the user can be redirected to the specified Game URL. + For this option to work, you must first create a game for your bot via @Botfather and accept the terms. + Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. + + Source: https://core.telegram.org/bots/apianswercallbackquery :param callback_query_id: Unique identifier for the query to be answered :type callback_query_id: :obj:`base.String` :param text: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters :type text: :obj:`typing.Union[base.String, None]` - :param show_alert: If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. + :param show_alert: If true, an alert will be shown by the client instead of a notification + at the top of the chat screen. Defaults to false. :type show_alert: :obj:`typing.Union[base.Boolean, None]` - :param url: URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. + :param url: URL that will be opened by the user's client. :type url: :obj:`typing.Union[base.String, None]` - :param cache_time: The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. + :param cache_time: The maximum amount of time in seconds that the + result of the callback query may be cached client-side. :type cache_time: :obj:`typing.Union[base.Integer, None]` :return: On success, True is returned. :rtype: :obj:`base.Boolean` @@ -911,27 +1131,37 @@ class Bot(BaseBot): return result - async def edit_message_text(self, text: base.String, chat_id: typing.Union[typing.Union[base.Integer, base.String], None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None, parse_mode: typing.Union[base.String, None] = None, disable_web_page_preview: typing.Union[base.Boolean, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> typing.Union[types.Message, base.Boolean]: + async def edit_message_text(self, text: base.String, + chat_id: typing.Union[base.Integer, base.String, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, None] = None, + parse_mode: typing.Union[base.String, None] = None, + disable_web_page_preview: typing.Union[base.Boolean, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + None] = None) -> types.Message or base.Boolean: """ - Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). - Source https://core.telegram.org/bots/apieditmessagetext + Source: https://core.telegram.org/bots/apieditmessagetext - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :type chat_id: :obj:`typing.Union[typing.Union[base.Integer, base.String], None]` + :param chat_id: Required if inline_message_id is not specified. + Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`typing.Union[base.Integer, base.String, None]` :param message_id: Required if inline_message_id is not specified. Identifier of the sent message :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message :type inline_message_id: :obj:`typing.Union[base.String, None]` :param text: New text of the message :type text: :obj:`base.String` - :param parse_mode: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. + :param parse_mode: Send Markdown or HTML, if you want Telegram apps to show bold, italic, + fixed-width text or inline URLs in your bot's message. :type parse_mode: :obj:`typing.Union[base.String, None]` :param disable_web_page_preview: Disables link previews for links in this message :type disable_web_page_preview: :obj:`typing.Union[base.Boolean, None]` :param reply_markup: A JSON-serialized object for an inline keyboard. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` - :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :return: On success, if edited message is sent by the bot, + the edited Message is returned, otherwise True is returned. :rtype: :obj:`typing.Union[types.Message, base.Boolean]` """ reply_markup = prepare_arg(reply_markup) @@ -943,14 +1173,20 @@ class Bot(BaseBot): return types.Message(**result) - async def edit_message_caption(self, chat_id: typing.Union[typing.Union[base.Integer, base.String], None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None, caption: typing.Union[base.String, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> typing.Union[types.Message, base.Boolean]: + async def edit_message_caption(self, chat_id: typing.Union[base.Integer, base.String, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, None] = None, + caption: typing.Union[base.String, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + None] = None) -> types.Message or base.Boolean: """ - Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). - Source https://core.telegram.org/bots/apieditmessagecaption + Source: https://core.telegram.org/bots/apieditmessagecaption - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :type chat_id: :obj:`typing.Union[typing.Union[base.Integer, base.String], None]` + :param chat_id: Required if inline_message_id is not specified. + Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`typing.Union[base.Integer, base.String, None]` :param message_id: Required if inline_message_id is not specified. Identifier of the sent message :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message @@ -959,7 +1195,8 @@ class Bot(BaseBot): :type caption: :obj:`typing.Union[base.String, None]` :param reply_markup: A JSON-serialized object for an inline keyboard. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` - :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :return: On success, if edited message is sent by the bot, the edited Message is returned, + otherwise True is returned. :rtype: :obj:`typing.Union[types.Message, base.Boolean]` """ reply_markup = prepare_arg(reply_markup) @@ -971,21 +1208,28 @@ class Bot(BaseBot): return types.Message(**result) - async def edit_message_reply_markup(self, chat_id: typing.Union[typing.Union[base.Integer, base.String], None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> typing.Union[types.Message, base.Boolean]: + async def edit_message_reply_markup(self, + chat_id: typing.Union[base.Integer, base.String, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + None] = None) -> types.Message or base.Boolean: """ - Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). - Source https://core.telegram.org/bots/apieditmessagereplymarkup + Source: https://core.telegram.org/bots/apieditmessagereplymarkup - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :type chat_id: :obj:`typing.Union[typing.Union[base.Integer, base.String], None]` + :param chat_id: Required if inline_message_id is not specified. + Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`typing.Union[base.Integer, base.String, None]` :param message_id: Required if inline_message_id is not specified. Identifier of the sent message :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message :type inline_message_id: :obj:`typing.Union[base.String, None]` :param reply_markup: A JSON-serialized object for an inline keyboard. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` - :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :return: On success, if edited message is sent by the bot, the edited Message is returned, + otherwise True is returned. :rtype: :obj:`typing.Union[types.Message, base.Boolean]` """ reply_markup = prepare_arg(reply_markup) @@ -997,7 +1241,8 @@ class Bot(BaseBot): return types.Message(**result) - async def delete_message(self, chat_id: typing.Union[base.Integer, base.String], message_id: base.Integer) -> base.Boolean: + async def delete_message(self, chat_id: typing.Union[base.Integer, base.String], + message_id: base.Integer) -> base.Boolean: """ Use this method to delete a message, including service messages, with the following limitations - A message can only be deleted if it was sent less than 48 hours ago. @@ -1005,12 +1250,12 @@ class Bot(BaseBot): - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. - Returns True on success. + The following methods and objects allow your bot to handle stickers and sticker sets. - Source https://core.telegram.org/bots/apideletemessage + Source: https://core.telegram.org/bots/apideletemessage - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` :param message_id: Identifier of the message to delete :type message_id: :obj:`base.Integer` @@ -1022,22 +1267,30 @@ class Bot(BaseBot): return result - async def send_sticker(self, chat_id: typing.Union[base.Integer, base.String], sticker: typing.Union[base.InputFile, base.String], disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None] = None) -> types.Message: + async def send_sticker(self, chat_id: typing.Union[base.Integer, base.String], + sticker: typing.Union[base.InputFile, base.String], + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, + types.ReplyKeyboardRemove, + types.ForceReply, None] = None) -> types.Message: """ - Use this method to send .webp stickers. On success, the sent Message is returned. + Use this method to send .webp stickers. - Source https://core.telegram.org/bots/apisendsticker + Source: https://core.telegram.org/bots/apisendsticker - :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel :type chat_id: :obj:`typing.Union[base.Integer, base.String]` - :param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data. + :param sticker: Sticker to send. :type sticker: :obj:`typing.Union[base.InputFile, base.String]` :param disable_notification: Sends the message silently. Users will receive a notification with no sound. :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - :type reply_markup: :obj:`typing.Union[typing.Union[types.InlineKeyboardMarkup, types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply], None]` + :param reply_markup: Additional interface options. + :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, + types.ReplyKeyboardMarkup, types.ReplyKeyboardRemove, types.ForceReply, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` """ @@ -1049,9 +1302,9 @@ class Bot(BaseBot): async def get_sticker_set(self, name: base.String) -> types.StickerSet: """ - Use this method to get a sticker set. On success, a StickerSet object is returned. + Use this method to get a sticker set. - Source https://core.telegram.org/bots/apigetstickerset + Source: https://core.telegram.org/bots/apigetstickerset :param name: Name of the sticker set :type name: :obj:`base.String` @@ -1065,13 +1318,15 @@ class Bot(BaseBot): async def upload_sticker_file(self, user_id: base.Integer, png_sticker: base.InputFile) -> types.File: """ - Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success. + Use this method to upload a .png file with a sticker for later use in createNewStickerSet + and addStickerToSet methods (can be used multiple times). - Source https://core.telegram.org/bots/apiuploadstickerfile + Source: https://core.telegram.org/bots/apiuploadstickerfile :param user_id: User identifier of sticker file owner :type user_id: :obj:`base.Integer` - :param png_sticker: Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. + :param png_sticker: Png image with the sticker, must be up to 512 kilobytes in size, + dimensions must not exceed 512px, and either width or height must be exactly 512px. :type png_sticker: :obj:`base.InputFile` :return: Returns the uploaded File on success. :rtype: :obj:`types.File` @@ -1081,19 +1336,23 @@ class Bot(BaseBot): return types.File(**result) - async def create_new_sticker_set(self, user_id: base.Integer, name: base.String, title: base.String, png_sticker: typing.Union[base.InputFile, base.String], emojis: base.String, contains_masks: typing.Union[base.Boolean, None] = None, mask_position: typing.Union[types.MaskPosition, None] = None) -> base.Boolean: + async def create_new_sticker_set(self, user_id: base.Integer, name: base.String, title: base.String, + png_sticker: typing.Union[base.InputFile, base.String], emojis: base.String, + contains_masks: typing.Union[base.Boolean, None] = None, + mask_position: typing.Union[types.MaskPosition, None] = None) -> base.Boolean: """ - Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success. + Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. - Source https://core.telegram.org/bots/apicreatenewstickerset + Source: https://core.telegram.org/bots/apicreatenewstickerset :param user_id: User identifier of created sticker set owner :type user_id: :obj:`base.Integer` - :param name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_”. is case insensitive. 1-64 characters. + :param name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). :type name: :obj:`base.String` :param title: Sticker set title, 1-64 characters :type title: :obj:`base.String` - :param png_sticker: Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :param png_sticker: Png image with the sticker, must be up to 512 kilobytes in size, + dimensions must not exceed 512px, and either width or height must be exactly 512px. :type png_sticker: :obj:`typing.Union[base.InputFile, base.String]` :param emojis: One or more emoji corresponding to the sticker :type emojis: :obj:`base.String` @@ -1110,17 +1369,20 @@ class Bot(BaseBot): return result - async def add_sticker_to_set(self, user_id: base.Integer, name: base.String, png_sticker: typing.Union[base.InputFile, base.String], emojis: base.String, mask_position: typing.Union[types.MaskPosition, None] = None) -> base.Boolean: + async def add_sticker_to_set(self, user_id: base.Integer, name: base.String, + png_sticker: typing.Union[base.InputFile, base.String], emojis: base.String, + mask_position: typing.Union[types.MaskPosition, None] = None) -> base.Boolean: """ - Use this method to add a new sticker to a set created by the bot. Returns True on success. + Use this method to add a new sticker to a set created by the bot. - Source https://core.telegram.org/bots/apiaddstickertoset + Source: https://core.telegram.org/bots/apiaddstickertoset :param user_id: User identifier of sticker set owner :type user_id: :obj:`base.Integer` :param name: Sticker set name :type name: :obj:`base.String` - :param png_sticker: Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :param png_sticker: Png image with the sticker, must be up to 512 kilobytes in size, + dimensions must not exceed 512px, and either width or height must be exactly 512px. :type png_sticker: :obj:`typing.Union[base.InputFile, base.String]` :param emojis: One or more emoji corresponding to the sticker :type emojis: :obj:`base.String` @@ -1137,9 +1399,9 @@ class Bot(BaseBot): async def set_sticker_position_in_set(self, sticker: base.String, position: base.Integer) -> base.Boolean: """ - Use this method to move a sticker in a set created by the bot to a specific position . Returns True on success. + Use this method to move a sticker in a set created by the bot to a specific position. - Source https://core.telegram.org/bots/apisetstickerpositioninset + Source: https://core.telegram.org/bots/apisetstickerpositioninset :param sticker: File identifier of the sticker :type sticker: :obj:`base.String` @@ -1155,12 +1417,11 @@ class Bot(BaseBot): async def delete_sticker_from_set(self, sticker: base.String) -> base.Boolean: """ - Use this method to delete a sticker from a set created by the bot. Returns True on success. - The following methods and objects allow your bot to work in inline mode. - Please see our Introduction to Inline bots for more details. - To enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot’s name. + Use this method to delete a sticker from a set created by the bot. - Source https://core.telegram.org/bots/apideletestickerfromset + The following methods and objects allow your bot to work in inline mode. + + Source: https://core.telegram.org/bots/apideletestickerfromset :param sticker: File identifier of the sticker :type sticker: :obj:`base.String` @@ -1172,26 +1433,39 @@ class Bot(BaseBot): return result - async def answer_inline_query(self, inline_query_id: base.String, results: typing.List[types.InlineQueryResult], cache_time: typing.Union[base.Integer, None] = None, is_personal: typing.Union[base.Boolean, None] = None, next_offset: typing.Union[base.String, None] = None, switch_pm_text: typing.Union[base.String, None] = None, switch_pm_parameter: typing.Union[base.String, None] = None) -> base.Boolean: + async def answer_inline_query(self, inline_query_id: base.String, results: typing.List[types.InlineQueryResult], + cache_time: typing.Union[base.Integer, None] = None, + is_personal: typing.Union[base.Boolean, None] = None, + next_offset: typing.Union[base.String, None] = None, + switch_pm_text: typing.Union[base.String, None] = None, + switch_pm_parameter: typing.Union[base.String, None] = None) -> base.Boolean: """ - Use this method to send answers to an inline query. On success, True is returned. + Use this method to send answers to an inline query. No more than 50 results per query are allowed. - Source https://core.telegram.org/bots/apianswerinlinequery + Source: https://core.telegram.org/bots/apianswerinlinequery :param inline_query_id: Unique identifier for the answered query :type inline_query_id: :obj:`base.String` :param results: A JSON-serialized array of results for the inline query :type results: :obj:`typing.List[types.InlineQueryResult]` - :param cache_time: The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. + :param cache_time: The maximum amount of time in seconds that the result of the + inline query may be cached on the server. Defaults to 300. :type cache_time: :obj:`typing.Union[base.Integer, None]` - :param is_personal: Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query + :param is_personal: Pass True, if results may be cached on the server side only + for the user that sent the query. By default, results may be returned to any user who sends the same query :type is_personal: :obj:`typing.Union[base.Boolean, None]` - :param next_offset: Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes. + :param next_offset: Pass the offset that a client should send in the + next query with the same text to receive more results. + Pass an empty string if there are no more results or if you don‘t support pagination. + Offset length can’t exceed 64 bytes. :type next_offset: :obj:`typing.Union[base.String, None]` - :param switch_pm_text: If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter + :param switch_pm_text: If passed, clients will display a button with specified text that + switches the user to a private chat with the bot and sends the bot a start message + with the parameter switch_pm_parameter :type switch_pm_text: :obj:`typing.Union[base.String, None]` - :param switch_pm_parameter: Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. + :param switch_pm_parameter: Deep-linking parameter for the /start message sent to the bot when + user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. :type switch_pm_parameter: :obj:`typing.Union[base.String, None]` :return: On success, True is returned. :rtype: :obj:`base.Boolean` @@ -1202,11 +1476,25 @@ class Bot(BaseBot): return result - async def send_invoice(self, chat_id: base.Integer, title: base.String, description: base.String, payload: base.String, provider_token: base.String, start_parameter: base.String, currency: base.String, prices: typing.List[types.LabeledPrice], photo_url: typing.Union[base.String, None] = None, photo_size: typing.Union[base.Integer, None] = None, photo_width: typing.Union[base.Integer, None] = None, photo_height: typing.Union[base.Integer, None] = None, need_name: typing.Union[base.Boolean, None] = None, need_phone_number: typing.Union[base.Boolean, None] = None, need_email: typing.Union[base.Boolean, None] = None, need_shipping_address: typing.Union[base.Boolean, None] = None, is_flexible: typing.Union[base.Boolean, None] = None, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> types.Message: + async def send_invoice(self, chat_id: base.Integer, title: base.String, description: base.String, + payload: base.String, provider_token: base.String, start_parameter: base.String, + currency: base.String, prices: typing.List[types.LabeledPrice], + photo_url: typing.Union[base.String, None] = None, + photo_size: typing.Union[base.Integer, None] = None, + photo_width: typing.Union[base.Integer, None] = None, + photo_height: typing.Union[base.Integer, None] = None, + need_name: typing.Union[base.Boolean, None] = None, + need_phone_number: typing.Union[base.Boolean, None] = None, + need_email: typing.Union[base.Boolean, None] = None, + need_shipping_address: typing.Union[base.Boolean, None] = None, + is_flexible: typing.Union[base.Boolean, None] = None, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> types.Message: """ - Use this method to send invoices. On success, the sent Message is returned. + Use this method to send invoices. - Source https://core.telegram.org/bots/apisendinvoice + Source: https://core.telegram.org/bots/apisendinvoice :param chat_id: Unique identifier for the target private chat :type chat_id: :obj:`base.Integer` @@ -1214,17 +1502,20 @@ class Bot(BaseBot): :type title: :obj:`base.String` :param description: Product description, 1-255 characters :type description: :obj:`base.String` - :param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. + :param payload: Bot-defined invoice payload, 1-128 bytes. + This will not be displayed to the user, use for your internal processes. :type payload: :obj:`base.String` :param provider_token: Payments provider token, obtained via Botfather :type provider_token: :obj:`base.String` - :param start_parameter: Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter + :param start_parameter: Unique deep-linking parameter that can be used to generate this + invoice when used as a start parameter :type start_parameter: :obj:`base.String` :param currency: Three-letter ISO 4217 currency code, see more on currencies :type currency: :obj:`base.String` - :param prices: Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) + :param prices: Price breakdown, a list of components + (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) :type prices: :obj:`typing.List[types.LabeledPrice]` - :param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. + :param photo_url: URL of the product photo for the invoice. :type photo_url: :obj:`typing.Union[base.String, None]` :param photo_size: Photo size :type photo_size: :obj:`typing.Union[base.Integer, None]` @@ -1246,7 +1537,8 @@ class Bot(BaseBot): :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. + :param reply_markup: A JSON-serialized object for an inline keyboard. + If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` @@ -1258,19 +1550,26 @@ class Bot(BaseBot): return types.Message(**result) - async def answer_shipping_query(self, shipping_query_id: base.String, ok: base.Boolean, shipping_options: typing.Union[typing.List[types.ShippingOption], None] = None, error_message: typing.Union[base.String, None] = None) -> base.Boolean: + async def answer_shipping_query(self, shipping_query_id: base.String, ok: base.Boolean, + shipping_options: typing.Union[typing.List[types.ShippingOption], None] = None, + error_message: typing.Union[base.String, None] = None) -> base.Boolean: """ - If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned. + If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, + the Bot API will send an Update with a shipping_query field to the bot. - Source https://core.telegram.org/bots/apianswershippingquery + Source: https://core.telegram.org/bots/apianswershippingquery :param shipping_query_id: Unique identifier for the query to be answered :type shipping_query_id: :obj:`base.String` - :param ok: Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) + :param ok: Specify True if delivery to the specified address is possible and False if there are any problems + (for example, if delivery to the specified address is not possible) :type ok: :obj:`base.Boolean` :param shipping_options: Required if ok is True. A JSON-serialized array of available shipping options. :type shipping_options: :obj:`typing.Union[typing.List[types.ShippingOption], None]` - :param error_message: Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. + :param error_message: Required if ok is False. + Error message in human readable form that explains why it is impossible to complete the order + (e.g. "Sorry, delivery to your desired address is unavailable'). + Telegram will display this message to the user. :type error_message: :obj:`typing.Union[base.String, None]` :return: On success, True is returned. :rtype: :obj:`base.Boolean` @@ -1281,17 +1580,25 @@ class Bot(BaseBot): return result - async def answer_pre_checkout_query(self, pre_checkout_query_id: base.String, ok: base.Boolean, error_message: typing.Union[base.String, None] = None) -> base.Boolean: + async def answer_pre_checkout_query(self, pre_checkout_query_id: base.String, ok: base.Boolean, + error_message: typing.Union[base.String, None] = None) -> base.Boolean: """ - Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. + Once the user has confirmed their payment and shipping details, + the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. + Use this method to respond to such pre-checkout queries. - Source https://core.telegram.org/bots/apianswerprecheckoutquery + Source: https://core.telegram.org/bots/apianswerprecheckoutquery :param pre_checkout_query_id: Unique identifier for the query to be answered :type pre_checkout_query_id: :obj:`base.String` - :param ok: Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. + :param ok: Specify True if everything is alright (goods are available, etc.) and the + bot is ready to proceed with the order. Use False if there are any problems. :type ok: :obj:`base.Boolean` - :param error_message: Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. + :param error_message: Required if ok is False. + Error message in human readable form that explains the reason for failure to proceed with the checkout + (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling + out your payment details. Please choose a different color or garment!"). + Telegram will display this message to the user. :type error_message: :obj:`typing.Union[base.String, None]` :return: On success, True is returned. :rtype: :obj:`base.Boolean` @@ -1301,21 +1608,26 @@ class Bot(BaseBot): return result - async def send_game(self, chat_id: base.Integer, game_short_name: base.String, disable_notification: typing.Union[base.Boolean, None] = None, reply_to_message_id: typing.Union[base.Integer, None] = None, reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> types.Message: + async def send_game(self, chat_id: base.Integer, game_short_name: base.String, + disable_notification: typing.Union[base.Boolean, None] = None, + reply_to_message_id: typing.Union[base.Integer, None] = None, + reply_markup: typing.Union[types.InlineKeyboardMarkup, None] = None) -> types.Message: """ - Use this method to send a game. On success, the sent Message is returned. + Use this method to send a game. - Source https://core.telegram.org/bots/apisendgame + Source: https://core.telegram.org/bots/apisendgame :param chat_id: Unique identifier for the target chat :type chat_id: :obj:`base.Integer` - :param game_short_name: Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather. + :param game_short_name: Short name of the game, serves as the unique identifier for the game. \ + Set up your games via Botfather. :type game_short_name: :obj:`base.String` :param disable_notification: Sends the message silently. Users will receive a notification with no sound. :type disable_notification: :obj:`typing.Union[base.Boolean, None]` :param reply_to_message_id: If the message is a reply, ID of the original message :type reply_to_message_id: :obj:`typing.Union[base.Integer, None]` - :param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game. + :param reply_markup: A JSON-serialized object for an inline keyboard. + If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game. :type reply_markup: :obj:`typing.Union[types.InlineKeyboardMarkup, None]` :return: On success, the sent Message is returned. :rtype: :obj:`types.Message` @@ -1326,19 +1638,27 @@ class Bot(BaseBot): return types.Message(**result) - async def set_game_score(self, user_id: base.Integer, score: base.Integer, force: typing.Union[base.Boolean, None] = None, disable_edit_message: typing.Union[base.Boolean, None] = None, chat_id: typing.Union[base.Integer, None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None) -> typing.Union[types.Message, base.Boolean]: + async def set_game_score(self, user_id: base.Integer, score: base.Integer, + force: typing.Union[base.Boolean, None] = None, + disable_edit_message: typing.Union[base.Boolean, None] = None, + chat_id: typing.Union[base.Integer, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, + None] = None) -> types.Message or base.Boolean: """ - Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False. + Use this method to set the score of the specified user in a game. - Source https://core.telegram.org/bots/apisetgamescore + Source: https://core.telegram.org/bots/apisetgamescore :param user_id: User identifier :type user_id: :obj:`base.Integer` :param score: New score, must be non-negative :type score: :obj:`base.Integer` - :param force: Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters + :param force: Pass True, if the high score is allowed to decrease. + This can be useful when fixing mistakes or banning cheaters :type force: :obj:`typing.Union[base.Boolean, None]` - :param disable_edit_message: Pass True, if the game message should not be automatically edited to include the current scoreboard + :param disable_edit_message: Pass True, if the game message should not be automatically + edited to include the current scoreboard :type disable_edit_message: :obj:`typing.Union[base.Boolean, None]` :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat :type chat_id: :obj:`typing.Union[base.Integer, None]` @@ -1346,7 +1666,9 @@ class Bot(BaseBot): :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message :type inline_message_id: :obj:`typing.Union[base.String, None]` - :return: On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False. + :return: On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. + Returns an error, if the new score is not greater than the user's + current score in the chat and force is False. :rtype: :obj:`typing.Union[types.Message, base.Boolean]` """ payload = generate_payload(**locals()) @@ -1357,12 +1679,18 @@ class Bot(BaseBot): return types.Message(**result) - async def get_game_high_scores(self, user_id: base.Integer, chat_id: typing.Union[base.Integer, None] = None, message_id: typing.Union[base.Integer, None] = None, inline_message_id: typing.Union[base.String, None] = None) -> typing.List[types.GameHighScore]: + async def get_game_high_scores(self, user_id: base.Integer, chat_id: typing.Union[base.Integer, None] = None, + message_id: typing.Union[base.Integer, None] = None, + inline_message_id: typing.Union[base.String, + None] = None) -> typing.List[types.GameHighScore]: """ - Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects. - This method will currently return scores for the target user, plus two of his closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change. + Use this method to get data for high score tables. - Source https://core.telegram.org/bots/apigetgamehighscores + This method will currently return scores for the target user, plus two of his closest neighbors on each side. + Will also return the top three users if the user and his neighbors are not among them. + Please note that this behavior is subject to change. + + Source: https://core.telegram.org/bots/apigetgamehighscores :param user_id: Target user id :type user_id: :obj:`base.Integer` @@ -1372,11 +1700,14 @@ class Bot(BaseBot): :type message_id: :obj:`typing.Union[base.Integer, None]` :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message :type inline_message_id: :obj:`typing.Union[base.String, None]` - :return: Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects. This method will currently return scores for the target user, plus two of his closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. + :return: Will return the score of the specified user and several of his neighbors in a game. + On success, returns an Array of GameHighScore objects. + This method will currently return scores for the target user, + plus two of his closest neighbors on each side. Will also return the top three users if the + user and his neighbors are not among them. :rtype: :obj:`typing.List[types.GameHighScore]` """ payload = generate_payload(**locals()) result = await self.request(api.Methods.GET_GAME_HIGH_SCORES, payload) return [types.GameHighScore(**gamehighscore) for gamehighscore in result] -