Struct telexide::api::APIClient

source ·
pub struct APIClient { /* private fields */ }
Expand description

A default implementation of the API trait.

It requires your bot token in order to interact with the telegram API and also allows you to configure your own hyper::Client for it to use.

Using the default APIClient is as easy as:

use telexide::api::{APIClient, API, types::SendMessage};

    let message = SendMessage::new(chat_id, "hi!");

    let client = APIClient::new_default(token);
    client.send_message(message).await;

In most cases you would want to get updates though and the Client is best suited for that, as it allows for easier handling of those updates

Implementations§

source§

impl APIClient

source

pub fn new(hyper_client: Option<TlsClient>, token: impl ToString) -> Self

Creates a new APIClient with the provided token and hyper client (if it is Some).

source

pub fn new_default(token: impl ToString) -> Self

Creates a new APIClient with the provided token and the default hyper client.

source

pub async fn request<D>( &self, endpoint: APIEndpoint, data: Option<&D> ) -> Result<Response>where D: ?Sized + Serialize,

Sends a request to the provided APIEndpoint with the data provided (does not support files)

source

pub fn get_hyper(&self) -> &TlsClient

gets a reference to the underlying hyper client, for example so you can make custom api requests

Trait Implementations§

source§

impl API for APIClient

source§

fn get<'life0, 'async_trait>( &'life0 self, endpoint: APIEndpoint, data: Option<Value> ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

executes a get request to the given telegram api endpoint
source§

fn post<'life0, 'async_trait>( &'life0 self, endpoint: APIEndpoint, data: Option<Value> ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

executes a post request to the given telegram api endpoint
source§

fn post_file<'life0, 'async_trait>( &'life0 self, endpoint: APIEndpoint, data: Option<Value>, files: Option<Vec<FormDataFile>> ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

executes a post request to the given api endpoint and uploads the given files
source§

fn get_me<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<User>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn log_out<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you will not be able to log in again using the same token for 10 minutes. Returns True on success.
source§

fn close<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn’t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched.
source§

fn get_updates<'life0, 'async_trait>( &'life0 self, data: GetUpdates ) -> Pin<Box<dyn Future<Output = Result<Vec<Update>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

(WARNING: this method should not be used by the library user themselves as this gets handled by the Client object, to handle an update event, please subscribe to those using subscribe_handler) Use this method to receive incoming updates using long polling. A Vec<Update> is returned.
source§

fn set_webhook<'life0, 'async_trait>( &'life0 self, data: SetWebhook ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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 on success.
source§

fn delete_webhook<'life0, 'async_trait>( &'life0 self, data: DeleteWebhook ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to remove webhook integration if you decide to switch back to using API::get_updates. Returns True on success.
source§

fn get_webhook_info<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<WebhookInfo>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get current webhook status. On success, returns a WebhookInfo object. If the bot is using API::get_updates, will return a WebhookInfo object with the url field empty.
source§

fn send_message<'life0, 'async_trait>( &'life0 self, data: SendMessage ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send text messages. On success, the sent Message is returned.
source§

fn set_my_commands<'life0, 'async_trait>( &'life0 self, data: SetMyCommands ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the list of the bot’s commands. Returns True on success.
source§

fn get_my_commands<'life0, 'async_trait>( &'life0 self, data: GetMyCommands ) -> Pin<Box<dyn Future<Output = Result<Vec<BotCommand>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the current list of the bot’s commands. Requires no parameters. Returns a Vec<BotCommand> on success.
source§

fn set_my_name<'life0, 'async_trait>( &'life0 self, data: SetMyName ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the bot’s name. Returns True on success.
source§

fn get_my_name<'life0, 'async_trait>( &'life0 self, data: GetMyName ) -> Pin<Box<dyn Future<Output = Result<BotName>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the current bot name for the given user language. Returns BotName on success.
source§

fn set_my_description<'life0, 'async_trait>( &'life0 self, data: SetMyDescription ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the bot’s description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
source§

fn get_my_description<'life0, 'async_trait>( &'life0 self, data: GetMyDescription ) -> Pin<Box<dyn Future<Output = Result<BotDescription>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the current bot description for the given user language. Returns BotDescription on success.
source§

fn set_my_short_description<'life0, 'async_trait>( &'life0 self, data: SetMyShortDescription ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the bot’s short description, which is shown on the bot’s profile page and is sent together with the link when users share the bot. Returns True on success.
source§

fn get_my_short_description<'life0, 'async_trait>( &'life0 self, data: GetMyShortDescription ) -> Pin<Box<dyn Future<Output = Result<BotShortDescription>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
source§

fn set_chat_menu_button<'life0, 'async_trait>( &'life0 self, data: SetChatMenuButton ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the bot’s menu button in a private chat, or the default menu button. Returns True on success.
source§

fn get_chat_menu_button<'life0, 'async_trait>( &'life0 self, data: GetChatMenuButton ) -> Pin<Box<dyn Future<Output = Result<MenuButton>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button. Returns MenuButton on success.
source§

fn set_my_default_administrator_rights<'life0, 'async_trait>( &'life0 self, data: SetMyDefaultAdministratorRights ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the default administrator rights requested by the bot when it’s added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
source§

fn get_my_default_administrator_right<'life0, 'async_trait>( &'life0 self, data: GetMyDefaultAdministratorRights ) -> Pin<Box<dyn Future<Output = Result<ChatAdministratorRights>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
source§

fn delete_my_commands<'life0, 'async_trait>( &'life0 self, data: DeleteMyCommands ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to delete the list of the bot’s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
source§

fn forward_message<'life0, 'async_trait>( &'life0 self, data: ForwardMessage ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to forward messages of any kind. On success, the sent Message is returned.
source§

fn copy_message<'life0, 'async_trait>( &'life0 self, data: CopyMessage ) -> Pin<Box<dyn Future<Output = Result<MessageId>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to copy messages of any kind. The method is analogous to the method forward_message, but the copied message doesn’t have a link to the original message. Returns the MessageId of the sent message on success.
source§

fn send_photo<'life0, 'async_trait>( &'life0 self, data: SendPhoto ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send photos. On success, the sent Message is returned.
source§

fn send_audio<'life0, 'async_trait>( &'life0 self, data: SendAudio ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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 or .M4A 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.
source§

fn send_document<'life0, 'async_trait>( &'life0 self, data: SendDocument ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn send_video<'life0, 'async_trait>( &'life0 self, data: SendVideo ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn send_animation<'life0, 'async_trait>( &'life0 self, data: SendAnimation ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
source§

fn send_voice<'life0, 'async_trait>( &'life0 self, data: SendVoice ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn send_video_note<'life0, 'async_trait>( &'life0 self, data: SendVideoNote ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn send_media_group<'life0, 'async_trait>( &'life0 self, data: SendMediaGroup ) -> Pin<Box<dyn Future<Output = Result<Vec<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send a group of photos or videos as an album. On success, a Vec<Message> is returned.
source§

fn send_location<'life0, 'async_trait>( &'life0 self, data: SendLocation ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send a point on the map. On success, the sent Message is returned.
source§

fn send_venue<'life0, 'async_trait>( &'life0 self, data: SendVenue ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send information about a venue. On success, the sent Message is returned.
source§

fn send_contact<'life0, 'async_trait>( &'life0 self, data: SendContact ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send phone contacts. On success, the sent Message is returned.
source§

fn send_poll<'life0, 'async_trait>( &'life0 self, data: SendPoll ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send a native poll. On success, the sent Message is returned.
source§

fn send_dice<'life0, 'async_trait>( &'life0 self, data: SendDice ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send a dice, which will have a random value from 1 to 6. On success, the sent Message is returned.
source§

fn send_chat_action<'life0, 'async_trait>( &'life0 self, data: SendChatAction ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn edit_message_text<'life0, 'async_trait>( &'life0 self, data: EditMessageText ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
source§

fn edit_message_caption<'life0, 'async_trait>( &'life0 self, data: EditMessageCaption ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
source§

fn edit_message_media<'life0, 'async_trait>( &'life0 self, data: EditMessageMedia ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can’t be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.
source§

fn edit_message_reply_markup<'life0, 'async_trait>( &'life0 self, data: EditMessageReplyMarkup ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit only the reply markup of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
source§

fn stop_poll<'life0, 'async_trait>( &'life0 self, data: StopPoll ) -> Pin<Box<dyn Future<Output = Result<Poll>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
source§

fn delete_message<'life0, 'async_trait>( &'life0 self, data: DeleteMessage ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to delete a message, including service messages, with the following limitations: Read more
source§

fn edit_message_live_location<'life0, 'async_trait>( &'life0 self, data: EditMessageLiveLocation ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit live location messages. 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.
source§

fn stop_message_live_location<'life0, 'async_trait>( &'life0 self, data: StopMessageLiveLocation ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.
source§

fn get_user_profile_photos<'life0, 'async_trait>( &'life0 self, data: GetUserProfilePhotos ) -> Pin<Box<dyn Future<Output = Result<UserProfilePhotos>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
source§

fn get_file<'life0, 'async_trait>( &'life0 self, data: GetFile ) -> Pin<Box<dyn Future<Output = Result<File>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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<token>/<file_path>, where <file_path> 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 API::get_file again.
source§

fn unban_chat_member<'life0, 'async_trait>( &'life0 self, data: UnbanChatMember ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn ban_chat_member<'life0, 'async_trait>( &'life0 self, data: BanChatMember ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to ban 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.
source§

fn restrict_chat_member<'life0, 'async_trait>( &'life0 self, data: RestrictChatMember ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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 permissions to lift restrictions from a user. Returns True on success.
source§

fn promote_chat_member<'life0, 'async_trait>( &'life0 self, data: PromoteChatMember ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn set_chat_administrator_custom_title<'life0, 'async_trait>( &'life0 self, data: SetChatAdministratorCustomTitle ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
source§

fn ban_chat_sender_chat<'life0, 'async_trait>( &'life0 self, data: BanChatSenderChat ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won’t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
source§

fn unban_chat_sender_chat<'life0, 'async_trait>( &'life0 self, data: UnbanChatSenderChat ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
source§

fn set_chat_permissions<'life0, 'async_trait>( &'life0 self, data: SetChatPermissions ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.
Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success. Read more
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method API::revoke_chat_invite_link. Returns the new invite link as ChatInviteLink object.
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object.
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object.
source§

fn approve_chat_join_request<'life0, 'async_trait>( &'life0 self, data: ApproveChatJoinRequest ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
source§

fn decline_chat_join_request<'life0, 'async_trait>( &'life0 self, data: DeclineChatJoinRequest ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
source§

fn set_chat_photo<'life0, 'async_trait>( &'life0 self, data: SetChatPhoto ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn delete_chat_photo<'life0, 'async_trait>( &'life0 self, data: DeleteChatPhoto ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn set_chat_title<'life0, 'async_trait>( &'life0 self, data: SetChatTitle ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn set_chat_description<'life0, 'async_trait>( &'life0 self, data: SetChatDescription ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the description of a group, 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.
source§

fn pin_chat_message<'life0, 'async_trait>( &'life0 self, data: PinChatMessage ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to pin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
source§

fn unpin_chat_message<'life0, 'async_trait>( &'life0 self, data: UnpinChatMessage ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in a supergroup or ‘can_edit_messages’ admin right in a channel. Returns True on success.
source§

fn unpin_all_chat_messages<'life0, 'async_trait>( &'life0 self, data: UnpinAllChatMessages ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in a supergroup or ‘can_edit_messages’ admin right in a channel. Returns True on success.
source§

fn leave_chat<'life0, 'async_trait>( &'life0 self, data: LeaveChat ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
source§

fn get_chat<'life0, 'async_trait>( &'life0 self, data: GetChat ) -> Pin<Box<dyn Future<Output = Result<Chat>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn get_chat_administrators<'life0, 'async_trait>( &'life0 self, data: GetChatAdministrators ) -> Pin<Box<dyn Future<Output = Result<Vec<ChatMember>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get a list of administrators in a chat. On success, returns a Vec<ChatMember> 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.
source§

fn get_members_count<'life0, 'async_trait>( &'life0 self, data: GetChatMemberCount ) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get the number of members in a chat. Returns i64 on success.
source§

fn get_chat_member<'life0, 'async_trait>( &'life0 self, data: GetChatMember ) -> Pin<Box<dyn Future<Output = Result<ChatMember>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get information about a member of a chat. Returns a ChatMember object on success.
source§

fn set_chat_sticker_set<'life0, 'async_trait>( &'life0 self, data: SetChatStickerSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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 API::get_chat requests to check if the bot can use this method. Returns True on success.
source§

fn delete_chat_sticker_set<'life0, 'async_trait>( &'life0 self, data: DeleteChatStickerSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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 API::get_chat requests to check if the bot can use this method. Returns True on success.
source§

fn get_forum_topic_icon_stickers<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Vec<Sticker>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Returns a Vec<Sticker>.
source§

fn create_forum_topic<'life0, 'async_trait>( &'life0 self, data: CreateForumTopic ) -> Pin<Box<dyn Future<Output = Result<ForumTopic>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
source§

fn edit_forum_topic<'life0, 'async_trait>( &'life0 self, data: EditForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
source§

fn close_forum_topic<'life0, 'async_trait>( &'life0 self, data: CloseForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
source§

fn reopen_forum_topic<'life0, 'async_trait>( &'life0 self, data: ReopenForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
source§

fn delete_forum_topic<'life0, 'async_trait>( &'life0 self, data: DeleteForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
source§

fn unpin_all_forum_topic_messages<'life0, 'async_trait>( &'life0 self, data: UnpinAllForumTopicMessages ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
source§

fn edit_general_forum_topic<'life0, 'async_trait>( &'life0 self, data: EditGeneralForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to edit the name of the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
source§

fn close_general_forum_topic<'life0, 'async_trait>( &'life0 self, data: CloseGeneralForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to close an open ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
source§

fn reopen_general_forum_topic<'life0, 'async_trait>( &'life0 self, data: ReopenGeneralForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to reopen a closed ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
source§

fn hide_general_forum_topic<'life0, 'async_trait>( &'life0 self, data: HideGeneralForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to hide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
source§

fn unhide_general_forum_topic<'life0, 'async_trait>( &'life0 self, data: UnhideGeneralForumTopic ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to unhide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
source§

fn unpin_all_general_forum_topic_messages<'life0, 'async_trait>( &'life0 self, data: UnpinAllGeneralForumTopicMessages ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
source§

fn answer_callback_query<'life0, 'async_trait>( &'life0 self, data: AnswerCallbackQuery ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn send_sticker<'life0, 'async_trait>( &'life0 self, data: SendSticker ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
source§

fn get_sticker_set<'life0, 'async_trait>( &'life0 self, data: GetStickerSet ) -> Pin<Box<dyn Future<Output = Result<StickerSet>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get a sticker set. On success, a StickerSet object is returned.
source§

fn get_custom_emoji_stickers<'life0, 'async_trait>( &'life0 self, data: GetCustomEmojiStickers ) -> Pin<Box<dyn Future<Output = Result<Vec<Sticker>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to get information about custom emoji stickers by their identifiers. Returns a Vec of Sticker objects.
source§

fn upload_sticker_file<'life0, 'async_trait>( &'life0 self, data: UploadStickerFile ) -> Pin<Box<dyn Future<Output = Result<File>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn create_new_sticker_set<'life0, 'async_trait>( &'life0 self, data: CreateNewStickerSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.
source§

fn add_sticker_to_set<'life0, 'async_trait>( &'life0 self, data: AddStickerToSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
source§

fn set_sticker_position_in_set<'life0, 'async_trait>( &'life0 self, data: SetStickerPositionInSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
source§

fn delete_sticker_from_set<'life0, 'async_trait>( &'life0 self, data: DeleteStickerFromSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to delete a sticker from a set created by the bot. Returns True on success.
source§

fn set_sticker_emoji_list<'life0, 'async_trait>( &'life0 self, data: SetStickerEmojiList ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
source§

fn set_sticker_keywords<'life0, 'async_trait>( &'life0 self, data: SetStickerKeywords ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
source§

fn set_sticker_mask_position<'life0, 'async_trait>( &'life0 self, data: SetStickerMaskPosition ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
source§

fn set_sticker_set_title<'life0, 'async_trait>( &'life0 self, data: SetStickerSetTitle ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to set the title of a created sticker set. Returns True on success.
source§

fn set_sticker_set_thumbnail<'life0, 'async_trait>( &'life0 self, data: SetStickerSetThumbnail ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
source§

fn set_custom_emoji_sticker_set_thumbnail<'life0, 'async_trait>( &'life0 self, data: SetCustomEmojiStickerSetThumbnail ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
source§

fn delete_sticker_set<'life0, 'async_trait>( &'life0 self, data: DeleteStickerSet ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to delete a sticker set that was created by the bot. Returns True on success.
source§

fn answer_inline_query<'life0, 'async_trait>( &'life0 self, data: AnswerInlineQuery ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.
source§

fn answer_web_app_query<'life0, 'async_trait>( &'life0 self, data: AnswerWebAppQuery ) -> Pin<Box<dyn Future<Output = Result<SentWebAppMessage>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
source§

fn send_invoice<'life0, 'async_trait>( &'life0 self, data: SendInvoice ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send invoices. On success, the sent Message is returned.
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
source§

fn answer_shipping_query<'life0, 'async_trait>( &'life0 self, data: AnswerShippingQuery ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn answer_pre_checkout_query<'life0, 'async_trait>( &'life0 self, data: AnswerPreCheckoutQuery ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn send_game<'life0, 'async_trait>( &'life0 self, data: SendGame ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Use this method to send a game. On success, the sent Message is returned.
source§

fn set_game_score<'life0, 'async_trait>( &'life0 self, data: SetGameScore ) -> Pin<Box<dyn Future<Output = Result<TrueOrObject<Message>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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.
source§

fn get_game_high_scores<'life0, 'async_trait>( &'life0 self, data: GetGameHighScores ) -> Pin<Box<dyn Future<Output = Result<Vec<GameHighScore>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

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 a Vec of GameHighScore objects.
source§

fn set_passport_data_errors<'life0, 'async_trait>( &'life0 self, data: SetPassportDataErrors ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more