Trait telexide::api::API[−][src]

pub trait API: Sync {

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

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

    #[must_use]
    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
        'life0: 'async_trait,
        Self: 'async_trait;

    #[must_use]
    fn get_me<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<User>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn log_out<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn close<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

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

    #[must_use]
    fn get_webhook_info<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<WebhookInfo>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

    #[must_use]
    fn get_my_commands<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<Vec<BotCommand>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    #[must_use]
    fn kick_chat_member<'life0, 'async_trait>(
        &'life0 self, 
        data: KickChatMember
    ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

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

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

    #[must_use]
    fn export_chat_invite_link<'life0, 'async_trait>(
        &'life0 self, 
        data: ExportChatInviteLink
    ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn create_chat_invite_link<'life0, 'async_trait>(
        &'life0 self, 
        data: CreateChatInviteLink
    ) -> Pin<Box<dyn Future<Output = Result<ChatInviteLink>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn edit_chat_invite_link<'life0, 'async_trait>(
        &'life0 self, 
        data: EditChatInviteLink
    ) -> Pin<Box<dyn Future<Output = Result<ChatInviteLink>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

    #[must_use]
    fn revoke_chat_invite_link<'life0, 'async_trait>(
        &'life0 self, 
        data: RevokeChatInviteLink
    ) -> Pin<Box<dyn Future<Output = Result<ChatInviteLink>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

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

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

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

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

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

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

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

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

    #[must_use]
    fn get_members_count<'life0, 'async_trait>(
        &'life0 self, 
        data: GetChatMembersCount
    ) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

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

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

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

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

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

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

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

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

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

    #[must_use]
    fn set_sticker_set_thumb<'life0, 'async_trait>(
        &'life0 self, 
        data: SetStickerSetThumb
    ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }

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

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

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

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

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

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

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

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

}

This trait provides methods for interacting with the telegram API.

Required methods

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

executes a get request to the given telegram api endpoint

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

executes a post request to the given telegram api endpoint

#[must_use]
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
    'life0: 'async_trait,
    Self: 'async_trait, [src]

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

Loading content...

Provided methods

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

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.

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

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.

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

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.

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

(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.

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

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.

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

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

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

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.

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

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

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

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

#[must_use]
fn get_my_commands<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<BotCommand>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, [src]

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

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

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

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

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.

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

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

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

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.
  • A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
  • Bots can delete outgoing messages in private chats, groups, and supergroups.
  • Bots can delete incoming messages in private chats.
  • 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.

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

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.

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

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.

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

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

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

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.

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

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.

#[must_use]
fn kick_chat_member<'life0, 'async_trait>(
    &'life0 self,
    data: KickChatMember
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, [src]

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.

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

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.

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

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.

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

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

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

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.

Note: Each administrator in a chat generates their own invite links. Bots can’t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using API::export_chat_invite_link – after this the link will become available to the bot via the API::get_chat method. If your bot needs to generate a new invite link replacing its previous one, use API::export_chat_invite_link again.

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

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

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.

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

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.

#[must_use]
fn get_members_count<'life0, 'async_trait>(
    &'life0 self,
    data: GetChatMembersCount
) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, [src]

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

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

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

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

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.

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

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.

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

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.

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

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

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

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

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

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.

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

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.

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

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.

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

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

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

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

#[must_use]
fn set_sticker_set_thumb<'life0, 'async_trait>(
    &'life0 self,
    data: SetStickerSetThumb
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, [src]

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.

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

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

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

Use this method to send invoices. On success, the sent Message is returned.

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

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.

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

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.

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

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

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

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.

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

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.

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

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.

Use this if the data submitted by the user doesn’t satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Loading content...

Implementors

impl API for APIClient[src]

Loading content...