OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2025-01-11 04:21:29 +01:00
Code Issues Projects Releases Packages Wiki Activity
python-telegram-bot/docs/source/telegram.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

98 lines
2.5 KiB
ReStructuredText
Raw Normal View History

Adding docs
2015-08-11 21:17:38 +02:00
telegram package
================
Add Tuple Based Version Info and Rename `telegram.bot_api_version` to `telegram.__bot_api_version__` (#3030)
2022-05-14 15:50:12 +02:00
Version Constants
-----------------
.. automodule:: telegram
:members: __version__, __version_info__, __bot_api_version__, __bot_api_version_info__
Available Types
---------------
Adding docs
2015-08-11 21:17:38 +02:00
.. toctree::
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.animation
telegram.audio
telegram.bot
API 4.7 (#1858) * Pure API changes * Address review * set Bot.commands on successfull call of set_my_commands * Get started on tests * More tests! * More Coverage! * Reset changes in utils.request * Filters.dice, Filters.dice.text * more coverage * Address review * Address review * Test stop_poll with reply_markup * Test stop_poll also without reply_markup * Rephrase note on 'dice' * Fix grammar in note on Filters.dice * update api version readme * address review
2020-04-10 19:22:45 +02:00
telegram.botcommand
API 5.3 (#2572) * BotCommandScopes * pre-commit * typo Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> * rename kickChatMember & getChatMembersCount method Signed-off-by: starry69 <starry369126@outlook.com> * add `language_code` and `scope` to `get/set_my_commands` and add `delete_my_commands()` * add `input_field_placeholder` to replykeyboardmarkup.py and forcereply.py also improved/fixed docs along the way * showcase `input_field_placeholder` in conversationbot.py * review 1 'i will not go away' has gone away 😢 * deprecate `Bot.commands` and make sure its only used for default scope * review 2 (use constants for scope) * Review Signed-off-by: starry69 <starry369126@outlook.com> * doc updates * New ChatMember classes Signed-off-by: starry69 <starry369126@outlook.com> * Address review Signed-off-by: starry69 <starry369126@outlook.com> * add versionadded tags again Signed-off-by: starry69 <starry369126@outlook.com> * Improve tests & add a deprecation note to ChatMember * test_official * Documentation tweaks * Bump bot api version number * but bot * Rename chat shortcuts Signed-off-by: starry69 <starry369126@outlook.com> * deepsource Signed-off-by: starry69 <starry369126@outlook.com> * add missing slot in botcommandscope & missing slot tests Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: starry69 <starry369126@outlook.com> Co-authored-by: Harshil <ilovebhagwan@gmail.com>
2021-07-01 17:45:19 +02:00
telegram.botcommandscope
telegram.botcommandscopeallchatadministrators
Documentation Improvements (#3010, #3007, #3012, #3067, #3081, #3082) Co-authored-by: KnorpelSenf <shtrog@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Adi <71205439+Aditya-Rajgor@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-09 17:08:54 +02:00
telegram.botcommandscopeallgroupchats
telegram.botcommandscopeallprivatechats
API 5.3 (#2572) * BotCommandScopes * pre-commit * typo Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> * rename kickChatMember & getChatMembersCount method Signed-off-by: starry69 <starry369126@outlook.com> * add `language_code` and `scope` to `get/set_my_commands` and add `delete_my_commands()` * add `input_field_placeholder` to replykeyboardmarkup.py and forcereply.py also improved/fixed docs along the way * showcase `input_field_placeholder` in conversationbot.py * review 1 'i will not go away' has gone away 😢 * deprecate `Bot.commands` and make sure its only used for default scope * review 2 (use constants for scope) * Review Signed-off-by: starry69 <starry369126@outlook.com> * doc updates * New ChatMember classes Signed-off-by: starry69 <starry369126@outlook.com> * Address review Signed-off-by: starry69 <starry369126@outlook.com> * add versionadded tags again Signed-off-by: starry69 <starry369126@outlook.com> * Improve tests & add a deprecation note to ChatMember * test_official * Documentation tweaks * Bump bot api version number * but bot * Rename chat shortcuts Signed-off-by: starry69 <starry369126@outlook.com> * deepsource Signed-off-by: starry69 <starry369126@outlook.com> * add missing slot in botcommandscope & missing slot tests Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: starry69 <starry369126@outlook.com> Co-authored-by: Harshil <ilovebhagwan@gmail.com>
2021-07-01 17:45:19 +02:00
telegram.botcommandscopechat
telegram.botcommandscopechatadministrators
telegram.botcommandscopechatmember
Documentation Improvements (#3010, #3007, #3012, #3067, #3081, #3082) Co-authored-by: KnorpelSenf <shtrog@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Adi <71205439+Aditya-Rajgor@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-09 17:08:54 +02:00
telegram.botcommandscopedefault
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.callbackquery
telegram.chat
API 6.0 (#2956) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
2022-05-03 18:21:50 +02:00
telegram.chatadministratorrights
API 5.1 (#2424) * Feat: New invite links * Fix: doc strings Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> * new dice, new admin privilege, revoke_messages, update and fix some docs * add missing param to shortcut * Add ChatMemberUpdated * Add voicechat related objects Signed-off-by: starry69 <starry369126@outlook.com> * add versionadd tags Signed-off-by: starry69 <starry369126@outlook.com> * Fix filter tests * Update tg.Update * ChatMemberHandler * Add versioning directives * add can_manage_voice_chats attr and fix docs Signed-off-by: starry69 <starry369126@outlook.com> * fix chat shortcut Signed-off-by: starry69 <starry369126@outlook.com> * address review * MADTC * Chat.message_auto_delete_time * Some doc fixes * address review Signed-off-by: starry69 <starry369126@outlook.com> * welp Signed-off-by: starry69 <starry369126@outlook.com> * Add voicechat related filters Signed-off-by: starry69 <starry369126@outlook.com> * Fix: Addressing review change place of version adding, added obj:True as doc string, changing how member limit is initiated * feat: adding chat shortcuts for invite links * fix: changing equality of chatinviteobjects * Non-test comments * Some test fixes * A bit more tests * Bump API version in both readmes * Increase coverage * Add Bot API Version in telegram.constants (#2429) * add bot api version in constants Signed-off-by: starry69 <starry369126@outlook.com> * addressing review Signed-off-by: starry69 <starry369126@outlook.com> * add versioning directive Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> * pre-commit & coverage Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> Co-authored-by: Harshil <ilovebhagwan@gmail.com> Co-authored-by: starry69 <starry369126@outlook.com>
2021-03-14 16:41:35 +01:00
telegram.chatinvitelink
Add ChatJoinRequest(Handler) to Docs (#2771)
2021-11-08 19:56:57 +01:00
telegram.chatjoinrequest
API 5.0 (#2181) Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
2020-11-29 16:20:46 +01:00
telegram.chatlocation
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.chatmember
API 5.3 (#2572) * BotCommandScopes * pre-commit * typo Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> * rename kickChatMember & getChatMembersCount method Signed-off-by: starry69 <starry369126@outlook.com> * add `language_code` and `scope` to `get/set_my_commands` and add `delete_my_commands()` * add `input_field_placeholder` to replykeyboardmarkup.py and forcereply.py also improved/fixed docs along the way * showcase `input_field_placeholder` in conversationbot.py * review 1 'i will not go away' has gone away 😢 * deprecate `Bot.commands` and make sure its only used for default scope * review 2 (use constants for scope) * Review Signed-off-by: starry69 <starry369126@outlook.com> * doc updates * New ChatMember classes Signed-off-by: starry69 <starry369126@outlook.com> * Address review Signed-off-by: starry69 <starry369126@outlook.com> * add versionadded tags again Signed-off-by: starry69 <starry369126@outlook.com> * Improve tests & add a deprecation note to ChatMember * test_official * Documentation tweaks * Bump bot api version number * but bot * Rename chat shortcuts Signed-off-by: starry69 <starry369126@outlook.com> * deepsource Signed-off-by: starry69 <starry369126@outlook.com> * add missing slot in botcommandscope & missing slot tests Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: starry69 <starry369126@outlook.com> Co-authored-by: Harshil <ilovebhagwan@gmail.com>
2021-07-01 17:45:19 +02:00
telegram.chatmemberadministrator
Documentation Improvements (#3010, #3007, #3012, #3067, #3081, #3082) Co-authored-by: KnorpelSenf <shtrog@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Adi <71205439+Aditya-Rajgor@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-09 17:08:54 +02:00
telegram.chatmemberbanned
telegram.chatmemberleft
API 5.3 (#2572) * BotCommandScopes * pre-commit * typo Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> * rename kickChatMember & getChatMembersCount method Signed-off-by: starry69 <starry369126@outlook.com> * add `language_code` and `scope` to `get/set_my_commands` and add `delete_my_commands()` * add `input_field_placeholder` to replykeyboardmarkup.py and forcereply.py also improved/fixed docs along the way * showcase `input_field_placeholder` in conversationbot.py * review 1 'i will not go away' has gone away 😢 * deprecate `Bot.commands` and make sure its only used for default scope * review 2 (use constants for scope) * Review Signed-off-by: starry69 <starry369126@outlook.com> * doc updates * New ChatMember classes Signed-off-by: starry69 <starry369126@outlook.com> * Address review Signed-off-by: starry69 <starry369126@outlook.com> * add versionadded tags again Signed-off-by: starry69 <starry369126@outlook.com> * Improve tests & add a deprecation note to ChatMember * test_official * Documentation tweaks * Bump bot api version number * but bot * Rename chat shortcuts Signed-off-by: starry69 <starry369126@outlook.com> * deepsource Signed-off-by: starry69 <starry369126@outlook.com> * add missing slot in botcommandscope & missing slot tests Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: starry69 <starry369126@outlook.com> Co-authored-by: Harshil <ilovebhagwan@gmail.com>
2021-07-01 17:45:19 +02:00
telegram.chatmembermember
Documentation Improvements (#3010, #3007, #3012, #3067, #3081, #3082) Co-authored-by: KnorpelSenf <shtrog@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Adi <71205439+Aditya-Rajgor@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-09 17:08:54 +02:00
telegram.chatmemberowner
API 5.3 (#2572) * BotCommandScopes * pre-commit * typo Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> * rename kickChatMember & getChatMembersCount method Signed-off-by: starry69 <starry369126@outlook.com> * add `language_code` and `scope` to `get/set_my_commands` and add `delete_my_commands()` * add `input_field_placeholder` to replykeyboardmarkup.py and forcereply.py also improved/fixed docs along the way * showcase `input_field_placeholder` in conversationbot.py * review 1 'i will not go away' has gone away 😢 * deprecate `Bot.commands` and make sure its only used for default scope * review 2 (use constants for scope) * Review Signed-off-by: starry69 <starry369126@outlook.com> * doc updates * New ChatMember classes Signed-off-by: starry69 <starry369126@outlook.com> * Address review Signed-off-by: starry69 <starry369126@outlook.com> * add versionadded tags again Signed-off-by: starry69 <starry369126@outlook.com> * Improve tests & add a deprecation note to ChatMember * test_official * Documentation tweaks * Bump bot api version number * but bot * Rename chat shortcuts Signed-off-by: starry69 <starry369126@outlook.com> * deepsource Signed-off-by: starry69 <starry369126@outlook.com> * add missing slot in botcommandscope & missing slot tests Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: starry69 <starry369126@outlook.com> Co-authored-by: Harshil <ilovebhagwan@gmail.com>
2021-07-01 17:45:19 +02:00
telegram.chatmemberrestricted
API 5.1 (#2424) * Feat: New invite links * Fix: doc strings Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> * new dice, new admin privilege, revoke_messages, update and fix some docs * add missing param to shortcut * Add ChatMemberUpdated * Add voicechat related objects Signed-off-by: starry69 <starry369126@outlook.com> * add versionadd tags Signed-off-by: starry69 <starry369126@outlook.com> * Fix filter tests * Update tg.Update * ChatMemberHandler * Add versioning directives * add can_manage_voice_chats attr and fix docs Signed-off-by: starry69 <starry369126@outlook.com> * fix chat shortcut Signed-off-by: starry69 <starry369126@outlook.com> * address review * MADTC * Chat.message_auto_delete_time * Some doc fixes * address review Signed-off-by: starry69 <starry369126@outlook.com> * welp Signed-off-by: starry69 <starry369126@outlook.com> * Add voicechat related filters Signed-off-by: starry69 <starry369126@outlook.com> * Fix: Addressing review change place of version adding, added obj:True as doc string, changing how member limit is initiated * feat: adding chat shortcuts for invite links * fix: changing equality of chatinviteobjects * Non-test comments * Some test fixes * A bit more tests * Bump API version in both readmes * Increase coverage * Add Bot API Version in telegram.constants (#2429) * add bot api version in constants Signed-off-by: starry69 <starry369126@outlook.com> * addressing review Signed-off-by: starry69 <starry369126@outlook.com> * add versioning directive Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> * pre-commit & coverage Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> Co-authored-by: Harshil <ilovebhagwan@gmail.com> Co-authored-by: starry69 <starry369126@outlook.com>
2021-03-14 16:41:35 +01:00
telegram.chatmemberupdated
API 4.4 (#1464)
2019-09-06 21:41:43 +02:00
telegram.chatpermissions
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.chatphoto
telegram.contact
API 4.7 (#1858) * Pure API changes * Address review * set Bot.commands on successfull call of set_my_commands * Get started on tests * More tests! * More Coverage! * Reset changes in utils.request * Filters.dice, Filters.dice.text * more coverage * Address review * Address review * Test stop_poll with reply_markup * Test stop_poll also without reply_markup * Rephrase note on 'dice' * Fix grammar in note on Filters.dice * update api version readme * address review
2020-04-10 19:22:45 +02:00
telegram.dice
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.document
telegram.file
telegram.forcereply
telegram.inlinekeyboardbutton
telegram.inlinekeyboardmarkup
telegram.inputfile
telegram.inputmedia
telegram.inputmediaanimation
telegram.inputmediaaudio
telegram.inputmediadocument
telegram.inputmediaphoto
telegram.inputmediavideo
telegram.keyboardbutton
API 4.6 (#1723) * First take on 4.6 support * improved docs * Minor doc formattings * added poll and poll_answer to filters * added tests, fixed mentioned issues * added poll_answer + poll filter tests * Update docs according to official API docs * introducing pollhandler and pollanswerhandler * First take on 4.6 support * improved docs * Minor doc formattings * added poll and poll_answer to filters * added tests, fixed mentioned issues * added poll_answer + poll filter tests * Update docs according to official API docs * introducing pollhandler and pollanswerhandler * correct_option_id validated with None when trying to send a poll with correct option id 0 it was failing. Now None check is done so that even when 0 is passed it is assigned. * improving example * improving code * adding poll filter example to the pollbot.py * Update Readme * simplify pollbot.py and add some comments * add tests for Poll(Answer)Handler * We just want Filters.poll, not Filters.update.poll * Make test_official fail again * Handle ME.language in M._parse_* Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de> Co-authored-by: Sharun Kumar <715417+sharunkumar@users.noreply.github.com>
2020-03-29 09:52:30 +02:00
telegram.keyboardbuttonpolltype
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.location
Doc fixes (#1499)
2019-09-13 20:49:04 +02:00
telegram.loginurl
API 6.0 (#2956) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
2022-05-03 18:21:50 +02:00
telegram.menubutton
telegram.menubuttoncommands
telegram.menubuttondefault
telegram.menubuttonwebapp
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.message
API 5.1 (#2424) * Feat: New invite links * Fix: doc strings Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> * new dice, new admin privilege, revoke_messages, update and fix some docs * add missing param to shortcut * Add ChatMemberUpdated * Add voicechat related objects Signed-off-by: starry69 <starry369126@outlook.com> * add versionadd tags Signed-off-by: starry69 <starry369126@outlook.com> * Fix filter tests * Update tg.Update * ChatMemberHandler * Add versioning directives * add can_manage_voice_chats attr and fix docs Signed-off-by: starry69 <starry369126@outlook.com> * fix chat shortcut Signed-off-by: starry69 <starry369126@outlook.com> * address review * MADTC * Chat.message_auto_delete_time * Some doc fixes * address review Signed-off-by: starry69 <starry369126@outlook.com> * welp Signed-off-by: starry69 <starry369126@outlook.com> * Add voicechat related filters Signed-off-by: starry69 <starry369126@outlook.com> * Fix: Addressing review change place of version adding, added obj:True as doc string, changing how member limit is initiated * feat: adding chat shortcuts for invite links * fix: changing equality of chatinviteobjects * Non-test comments * Some test fixes * A bit more tests * Bump API version in both readmes * Increase coverage * Add Bot API Version in telegram.constants (#2429) * add bot api version in constants Signed-off-by: starry69 <starry369126@outlook.com> * addressing review Signed-off-by: starry69 <starry369126@outlook.com> * add versioning directive Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> * pre-commit & coverage Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> Co-authored-by: Harshil <ilovebhagwan@gmail.com> Co-authored-by: starry69 <starry369126@outlook.com>
2021-03-14 16:41:35 +01:00
telegram.messageautodeletetimerchanged
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.messageentity
Documentation Improvements (#3010, #3007, #3012, #3067, #3081, #3082) Co-authored-by: KnorpelSenf <shtrog@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Adi <71205439+Aditya-Rajgor@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-09 17:08:54 +02:00
telegram.messageid
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.photosize
All api 4.2 and 4.3 changes (#1418)
2019-08-23 21:20:41 +02:00
telegram.poll
API 4.6 (#1723) * First take on 4.6 support * improved docs * Minor doc formattings * added poll and poll_answer to filters * added tests, fixed mentioned issues * added poll_answer + poll filter tests * Update docs according to official API docs * introducing pollhandler and pollanswerhandler * First take on 4.6 support * improved docs * Minor doc formattings * added poll and poll_answer to filters * added tests, fixed mentioned issues * added poll_answer + poll filter tests * Update docs according to official API docs * introducing pollhandler and pollanswerhandler * correct_option_id validated with None when trying to send a poll with correct option id 0 it was failing. Now None check is done so that even when 0 is passed it is assigned. * improving example * improving code * adding poll filter example to the pollbot.py * Update Readme * simplify pollbot.py and add some comments * add tests for Poll(Answer)Handler * We just want Filters.poll, not Filters.update.poll * Make test_official fail again * Handle ME.language in M._parse_* Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de> Co-authored-by: Sharun Kumar <715417+sharunkumar@users.noreply.github.com>
2020-03-29 09:52:30 +02:00
telegram.pollanswer
All api 4.2 and 4.3 changes (#1418)
2019-08-23 21:20:41 +02:00
telegram.polloption
API 5.0 (#2181) Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
2020-11-29 16:20:46 +01:00
telegram.proximityalerttriggered
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.replykeyboardmarkup
Documentation Improvements (#3010, #3007, #3012, #3067, #3081, #3082) Co-authored-by: KnorpelSenf <shtrog@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Adi <71205439+Aditya-Rajgor@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-09 17:08:54 +02:00
telegram.replykeyboardremove
API 6.0 (#2956) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
2022-05-03 18:21:50 +02:00
telegram.sentwebappmessage
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.telegramobject
telegram.update
telegram.user
telegram.userprofilephotos
telegram.venue
telegram.video
API 6.0 (#2956) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
2022-05-03 18:21:50 +02:00
telegram.videochatended
telegram.videochatparticipantsinvited
telegram.videochatscheduled
telegram.videochatstarted
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.videonote
telegram.voice
API 6.0 (#2956) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
2022-05-03 18:21:50 +02:00
telegram.webappdata
telegram.webappinfo
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
telegram.webhookinfo
Documentation Improvements (#3139, #3153, #3135) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <github@poolitzer.eu> Co-authored-by: Pawan <pawanrai9999@gmail.com> Co-authored-by: Aditya Yadav <69784758+aditya-yadav-27@users.noreply.github.com>
2022-08-27 11:46:51 +02:00
telegram.stickers-tree.rst
telegram.inline-tree.rst
telegram.payments-tree.rst
telegram.games-tree.rst
telegram.passport-tree.rst
Docs update (#728) Amazing new documentation.
2017-07-23 22:33:08 +02:00
Reference in a new issue Copy permalink