[−][src]Struct tbot::Bot
Provides methods to call the Bots API.
A Bot
lets you call methods from the methods
module.
let bot = tbot::from_env!("BOT_TOKEN"); let me = bot.get_me().call().await.unwrap(); dbg!(me);
Besides, a Bot
is used to construct an EventLoop
— a struct
responsible for configuring handlers and listening to updates.
Methods
impl Bot<Https>
[src]
pub fn new(token: String) -> Self
[src]
Constructs a new Bot
.
pub fn from_env(env_var: &'static str) -> Self
[src]
impl<C> Bot<C>
[src]
pub fn event_loop(self) -> EventLoop<C>
[src]
Constructs an EventLoop
.
pub fn add_sticker_to_set<'a>(
&'a self,
user_id: Id,
name: &'a str,
png_sticker: PngSticker<'a>,
emojis: &'a str
) -> AddStickerToSet<'a, C>
[src]
&'a self,
user_id: Id,
name: &'a str,
png_sticker: PngSticker<'a>,
emojis: &'a str
) -> AddStickerToSet<'a, C>
Adds a new sticker to an existing sticker set.
pub fn create_new_sticker_set<'a>(
&'a self,
user_id: Id,
name: &'a str,
title: &'a str,
png_sticker: PngSticker<'a>,
emojis: &'a str
) -> CreateNewStickerSet<'a, C>
[src]
&'a self,
user_id: Id,
name: &'a str,
title: &'a str,
png_sticker: PngSticker<'a>,
emojis: &'a str
) -> CreateNewStickerSet<'a, C>
Creates a new sticker set.
pub fn delete_chat_photo<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> DeleteChatPhoto<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> DeleteChatPhoto<'a, C>
Deletes a chat's photo.
pub fn delete_chat_sticker_set<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> DeleteChatStickerSet<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> DeleteChatStickerSet<'a, C>
Deletes a chat's sticker set.
pub fn delete_message<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> DeleteMessage<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> DeleteMessage<'a, C>
Deletes a message from a chat.
pub fn delete_sticker_from_set<'a>(
&'a self,
sticker: &'a str
) -> DeleteStickerFromSet<'a, C>
[src]
&'a self,
sticker: &'a str
) -> DeleteStickerFromSet<'a, C>
Deletes a sticker from a sticker set.
pub fn edit_inline_caption<'a>(
&'a self,
inline_message_id: Ref<'a>,
caption: impl Into<Text<'a>>
) -> EditInlineCaption<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
caption: impl Into<Text<'a>>
) -> EditInlineCaption<'a, C>
Edits the caption of a media message sent via the inline mode.
pub fn edit_inline_location<'a>(
&'a self,
inline_message_id: Ref<'a>,
position: (f64, f64)
) -> EditInlineLocation<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
position: (f64, f64)
) -> EditInlineLocation<'a, C>
Edits a live location sent via the inline mode.
pub fn edit_inline_media<'a>(
&'a self,
inline_message_id: Ref<'a>,
media: impl Into<EditableMedia<'a>>
) -> EditInlineMedia<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
media: impl Into<EditableMedia<'a>>
) -> EditInlineMedia<'a, C>
Edits the media of a message sent via the inline mode.
pub fn edit_inline_reply_markup<'a>(
&'a self,
inline_message_id: Ref<'a>,
reply_markup: Keyboard<'a>
) -> EditInlineReplyMarkup<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
reply_markup: Keyboard<'a>
) -> EditInlineReplyMarkup<'a, C>
Edits the inline keyboard of a message sent via the inline mode.
pub fn edit_inline_text<'a>(
&'a self,
inline_message_id: Ref<'a>,
text: impl Into<Text<'a>>
) -> EditInlineText<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
text: impl Into<Text<'a>>
) -> EditInlineText<'a, C>
Edits the text of a message sent via the inline mode.
pub fn edit_message_caption<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
caption: impl Into<Text<'a>>
) -> EditMessageCaption<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
caption: impl Into<Text<'a>>
) -> EditMessageCaption<'a, C>
Edits the caption of a media message sent by the bot itself.
pub fn edit_message_location<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
position: (f64, f64)
) -> EditMessageLocation<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
position: (f64, f64)
) -> EditMessageLocation<'a, C>
Edits a live location sent by the bot itself.
pub fn edit_message_media<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
media: impl Into<EditableMedia<'a>>
) -> EditMessageMedia<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
media: impl Into<EditableMedia<'a>>
) -> EditMessageMedia<'a, C>
Edits a live location sent by the bot itself.
pub fn edit_message_reply_markup<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
reply_markup: Keyboard<'a>
) -> EditMessageReplyMarkup<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
reply_markup: Keyboard<'a>
) -> EditMessageReplyMarkup<'a, C>
Edits the inline keyboard of a message sent by the bot itself.
pub fn edit_message_text<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
text: impl Into<Text<'a>>
) -> EditMessageText<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
text: impl Into<Text<'a>>
) -> EditMessageText<'a, C>
Edits the text of a message sent by the bot itself.
pub fn export_chat_invite_link<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> ExportChatInviteLink<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> ExportChatInviteLink<'a, C>
Exports a chat's invite link.
pub fn forward_message<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
from_chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> ForwardMessage<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
from_chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> ForwardMessage<'a, C>
Forwards a message.
pub fn get_chat<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> GetChat<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> GetChat<'a, C>
Gets information about a chat.
pub fn get_file<'a>(&'a self, file_id: &'a impl AsFileId) -> GetFile<'a, C>
[src]
Gets information about a file.
pub fn get_inline_game_high_scores<'a>(
&'a self,
inline_message_id: Ref<'a>,
user_id: Id
) -> GetInlineGameHighScores<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
user_id: Id
) -> GetInlineGameHighScores<'a, C>
Gets an excerpt from the high score table of a game sent via the inline mode.
pub fn get_chat_administrators<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> GetChatAdministrators<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> GetChatAdministrators<'a, C>
Gets information about a chat's admins.
pub fn get_chat_member<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> GetChatMember<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> GetChatMember<'a, C>
Gets information about a chat's member.
pub fn get_chat_members_count<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> GetChatMembersCount<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> GetChatMembersCount<'a, C>
Gets a chat's member count.
pub fn get_message_game_high_scores<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
user_id: Id
) -> GetMessageGameHighScores<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
user_id: Id
) -> GetMessageGameHighScores<'a, C>
Gets an excerpt from the high score table of a game sent by the bot itself.
pub fn get_me(&self) -> GetMe<C>
[src]
Gets information about the bot.
pub fn get_sticker_set<'a>(&'a self, name: &'a str) -> GetStickerSet<'a, C>
[src]
Gets a sticker set by its name.
pub fn get_user_profile_photos(&self, user_id: Id) -> GetUserProfilePhotos<C>
[src]
Gets a user's profile photos.
pub fn get_webhook_info(&self) -> GetWebhookInfo<C>
[src]
Gets information about the bot's webhook.
pub fn kick_chat_member<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> KickChatMember<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> KickChatMember<'a, C>
Kicks a member out of a chat.
pub fn leave_chat<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> LeaveChat<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> LeaveChat<'a, C>
Leaves a chat.
pub fn pin_chat_message<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> PinChatMessage<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> PinChatMessage<'a, C>
Pins a message in a chat.
pub fn promote_chat_member<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> PromoteChatMember<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> PromoteChatMember<'a, C>
Promotes a chat member to an admin.
pub fn restrict_chat_member<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id,
permissions: Permissions
) -> RestrictChatMember<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id,
permissions: Permissions
) -> RestrictChatMember<'a, C>
Restricts a chat member.
pub fn send_animation<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
animation: Animation<'a>
) -> SendAnimation<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
animation: Animation<'a>
) -> SendAnimation<'a, C>
Sends an animation.
pub fn send_audio<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
audio: Audio<'a>
) -> SendAudio<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
audio: Audio<'a>
) -> SendAudio<'a, C>
Sends an audio.
pub fn send_chat_action<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
action: Action
) -> SendChatAction<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
action: Action
) -> SendChatAction<'a, C>
Sends a chat action.
pub fn send_contact<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
phone_number: &'a str,
first_name: &'a str
) -> SendContact<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
phone_number: &'a str,
first_name: &'a str
) -> SendContact<'a, C>
Sends a contact.
pub fn send_game<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
game_short_name: &'a str
) -> SendGame<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
game_short_name: &'a str
) -> SendGame<'a, C>
Sends a game.
pub fn send_document<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
document: Document<'a>
) -> SendDocument<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
document: Document<'a>
) -> SendDocument<'a, C>
Sends a document.
pub fn send_invoice<'a>(
&'a self,
chat_id: impl Into<Id>,
title: &'a str,
description: &'a str,
payload: &'a str,
provider_token: &'a str,
start_parameter: &'a str,
currency: &'a str,
prices: &'a [LabeledPrice<'a>]
) -> SendInvoice<'a, C>
[src]
&'a self,
chat_id: impl Into<Id>,
title: &'a str,
description: &'a str,
payload: &'a str,
provider_token: &'a str,
start_parameter: &'a str,
currency: &'a str,
prices: &'a [LabeledPrice<'a>]
) -> SendInvoice<'a, C>
Sends an invoice.
pub fn send_location<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
position: (f64, f64)
) -> SendLocation<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
position: (f64, f64)
) -> SendLocation<'a, C>
Sends a location.
pub fn send_media_group<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
media: &'a [GroupMedia<'a>]
) -> SendMediaGroup<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
media: &'a [GroupMedia<'a>]
) -> SendMediaGroup<'a, C>
Sends an album.
pub fn send_message<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
text: impl Into<Text<'a>>
) -> SendMessage<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
text: impl Into<Text<'a>>
) -> SendMessage<'a, C>
Sends a text message.
pub fn send_photo<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
photo: Photo<'a>
) -> SendPhoto<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
photo: Photo<'a>
) -> SendPhoto<'a, C>
Sends a photo.
pub fn send_poll<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
question: &'a str,
options: &'a [&'a str]
) -> SendPoll<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
question: &'a str,
options: &'a [&'a str]
) -> SendPoll<'a, C>
Sends a poll.
pub fn send_sticker<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
sticker: Sticker<'a>
) -> SendSticker<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
sticker: Sticker<'a>
) -> SendSticker<'a, C>
Sends a sticker.
pub fn send_venue<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
position: (f64, f64),
title: &'a str,
address: &'a str
) -> SendVenue<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
position: (f64, f64),
title: &'a str,
address: &'a str
) -> SendVenue<'a, C>
Sends a venue.
pub fn send_video_note<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
video_note: VideoNote<'a>
) -> SendVideoNote<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
video_note: VideoNote<'a>
) -> SendVideoNote<'a, C>
Sends a video note.
pub fn send_video<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
video: Video<'a>
) -> SendVideo<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
video: Video<'a>
) -> SendVideo<'a, C>
Sends a video.
pub fn send_voice<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
voice: Voice<'a>
) -> SendVoice<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
voice: Voice<'a>
) -> SendVoice<'a, C>
Sends a voice.
pub fn set_chat_description<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
description: &'a str
) -> SetChatDescription<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
description: &'a str
) -> SetChatDescription<'a, C>
Sets a chat's description.
pub fn set_chat_permissions<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
permissions: Permissions
) -> SetChatPermissions<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
permissions: Permissions
) -> SetChatPermissions<'a, C>
Sets a group's global permissions.
pub fn set_chat_photo<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
photo: ChatPhoto<'a>
) -> SetChatPhoto<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
photo: ChatPhoto<'a>
) -> SetChatPhoto<'a, C>
Sets a chat's photo.
pub fn set_chat_sticker_set<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
sticker_set_name: &'a str
) -> SetChatStickerSet<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
sticker_set_name: &'a str
) -> SetChatStickerSet<'a, C>
Sets a group's sticker set.
pub fn set_chat_title<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
title: &'a str
) -> SetChatTitle<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
title: &'a str
) -> SetChatTitle<'a, C>
Sets a group's title.
pub fn set_inline_game_score<'a>(
&'a self,
inline_message_id: Ref<'a>,
user_id: Id,
score: u32
) -> SetInlineGameScore<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>,
user_id: Id,
score: u32
) -> SetInlineGameScore<'a, C>
Sets a user's new high score in a game sent via the inline mode.
pub fn set_message_game_score<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
user_id: Id,
score: u32
) -> SetMessageGameScore<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id,
user_id: Id,
score: u32
) -> SetMessageGameScore<'a, C>
Sets a user's new high score in a game sent by the bot itself.
pub fn set_passport_data_errors<'a>(
&'a self,
user_id: Id,
errors: &'a [Error<'a>]
) -> SetPassportDataErrors<'a, C>
[src]
&'a self,
user_id: Id,
errors: &'a [Error<'a>]
) -> SetPassportDataErrors<'a, C>
Reports passport errors to the user.
pub fn set_sticker_position_in_set<'a>(
&'a self,
sticker: &'a str,
position: u32
) -> SetStickerPositionInSet<'a, C>
[src]
&'a self,
sticker: &'a str,
position: u32
) -> SetStickerPositionInSet<'a, C>
Changes a sticker's position in a sticker set.
pub fn stop_inline_location<'a>(
&'a self,
inline_message_id: Ref<'a>
) -> StopInlineLocation<'a, C>
[src]
&'a self,
inline_message_id: Ref<'a>
) -> StopInlineLocation<'a, C>
Stops a live location sent via the inline mode.
pub fn stop_message_location<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> StopMessageLocation<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> StopMessageLocation<'a, C>
Stops a live location sent by the bot itself.
pub fn stop_poll<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> StopPoll<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
message_id: Id
) -> StopPoll<'a, C>
Stops a poll.
pub fn unban_chat_member<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> UnbanChatMember<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>,
user_id: Id
) -> UnbanChatMember<'a, C>
Lifts all restrictions from a group's member.
pub fn unpin_chat_message<'a>(
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> UnpinChatMessage<'a, C>
[src]
&'a self,
chat_id: impl ImplicitChatId<'a>
) -> UnpinChatMessage<'a, C>
Unpins a chat message.
pub fn upload_sticker_file<'a>(
&'a self,
user_id: Id,
png_sticker: &'a [u8]
) -> UploadStickerFile<'a, C>
[src]
&'a self,
user_id: Id,
png_sticker: &'a [u8]
) -> UploadStickerFile<'a, C>
Uploads a sticker file.
impl<C: Connector> Bot<C>
[src]
pub fn with_connector(token: String, connector: C) -> Self
[src]
Constructs a Bot
with a custom connector.
pub fn from_env_with_connector(env_var: &'static str, connector: C) -> Self
[src]
Like Bot::from_env
with a custom connector.
pub async fn download_file<'_, '_>(
&'_ self,
file: &'_ File
) -> Result<Vec<u8>, Download>
[src]
&'_ self,
file: &'_ File
) -> Result<Vec<u8>, Download>
Downloads a file.
Trait Implementations
Auto Trait Implementations
impl<C> !RefUnwindSafe for Bot<C>
impl<C> Send for Bot<C> where
C: Send + Sync,
C: Send + Sync,
impl<C> Sync for Bot<C> where
C: Send + Sync,
C: Send + Sync,
impl<C> Unpin for Bot<C>
impl<C> !UnwindSafe for Bot<C>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,