mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-03-27 17:00:45 +01:00
a0720b9ac6
* Minor doc updates, following official API docs * Fix spelling in Defaults docstrings * Clarify Changelog of v12.7 about aware dates * Fix typo in CHANGES.rst (#2024) * Fix PicklePersistence.flush() with only bot_data (#2017) * Update pylint in pre-commit to fix CI (#2018) * Add Filters.via_bot (#2009) * feat: via_bot filter also fixing a small mistake in the empty parameter of the user filter and improve docs slightly * fix: forgot to set via_bot to None * fix: redoing subclassing to copy paste solution * Cosmetic changes Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de> * Update CHANGES.rst Fixed Typo Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com> * Update downloads badge, add info on IRC Channel to Getting Help section * Remove RegexHandler from ConversationHandlers Docs (#1973) Replaced RegexHandler with MessageHandler, since the former is deprecated * Fix Filters.via_bot docstrings * Add notes on Markdown v1 being legacy mode * Fixed typo in the Regex doc.. (#2036) * Typo: Spelling * Minor cleanup from #2043 * Document CommandHandler ignoring channel posts * Doc fixes for a few telegram.ext classes * Doc fixes for most `telegram` classes. * pep-8 forgot the hard wrap is at 99 chars, not 100! fixed a few spelling mistakes too. * Address review and made rendering of booleans consistent True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes. * Few doc fixes for inline* classes As usual, docs were cross-checked with official tg api docs. * Doc fixes for telegram/files classes As usual, docs were cross-checked with official tg api docs. * Doc fixes for telegram.Game Mostly just added hyperlinks. And fixed message length doc. As usual, docs were cross-checked with official tg api docs. * Very minor doc fix for passportfile.py and passportelementerrors.py Didn't bother changing too much since this seems to be a custom implementation. * Doc fixes for telegram.payments As usual, cross-checked with official bot api docs. * Address review 2 Few tiny other fixes too. * Changed from ``True/False/None`` to :obj:`True/False/None` project-wide. Few tiny other doc fixes too. Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com> Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com> Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com> Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com> Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
79 lines
3.4 KiB
Python
79 lines
3.4 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2020
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""This module contains an object that represents a Telegram WebhookInfo."""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class WebhookInfo(TelegramObject):
|
|
"""This object represents a Telegram WebhookInfo.
|
|
|
|
Contains information about the current status of a webhook.
|
|
|
|
Attributes:
|
|
url (:obj:`str`): Webhook URL.
|
|
has_custom_certificate (:obj:`bool`): If a custom certificate was provided for webhook.
|
|
pending_update_count (:obj:`int`): Number of updates awaiting delivery.
|
|
last_error_date (:obj:`int`): Optional. Unix time for the most recent error that happened.
|
|
last_error_message (:obj:`str`): Optional. Error message in human-readable format.
|
|
max_connections (:obj:`int`): Optional. Maximum allowed number of simultaneous HTTPS
|
|
connections.
|
|
allowed_updates (List[:obj:`str`]): Optional. A list of update types the bot is subscribed
|
|
to.
|
|
|
|
Args:
|
|
url (:obj:`str`): Webhook URL, may be empty if webhook is not set up.
|
|
has_custom_certificate (:obj:`bool`): :obj:`True`, if a custom certificate was provided for
|
|
webhook certificate checks.
|
|
pending_update_count (:obj:`int`): Number of updates awaiting delivery.
|
|
last_error_date (:obj:`int`, optional): Unix time for the most recent error that happened
|
|
when trying to deliver an update via webhook.
|
|
last_error_message (:obj:`str`, optional): Error message in human-readable format for the
|
|
most recent error that happened when trying to deliver an update via webhook.
|
|
max_connections (:obj:`int`, optional): Maximum allowed number of simultaneous HTTPS
|
|
connections to the webhook for update delivery.
|
|
allowed_updates (List[:obj:`str`], optional): A list of update types the bot is subscribed
|
|
to. Defaults to all update types.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
url,
|
|
has_custom_certificate,
|
|
pending_update_count,
|
|
last_error_date=None,
|
|
last_error_message=None,
|
|
max_connections=None,
|
|
allowed_updates=None,
|
|
**kwargs):
|
|
# Required
|
|
self.url = url
|
|
self.has_custom_certificate = has_custom_certificate
|
|
self.pending_update_count = pending_update_count
|
|
self.last_error_date = last_error_date
|
|
self.last_error_message = last_error_message
|
|
self.max_connections = max_connections
|
|
self.allowed_updates = allowed_updates
|
|
|
|
@classmethod
|
|
def de_json(cls, data, bot):
|
|
if not data:
|
|
return None
|
|
|
|
return cls(**data)
|