GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — python-telegram-bot/telegram/chat.py at master · saintbyte/python-telegram-bot Expand file tree/ Copy pathchat.pyMore file actions 339 lines (251 loc) · 11.6 KB / Copy pathchat.pyFile metadata and controls339 lines (251 loc) · 11.6 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 #!/usr/bin/env python # pylint: disable=C0103,W0622 # # A library that provides a Python interface to the Telegram Bot API # Copyright (C) 2015-2018 # Leandro Toledo de Souza <[email protected]> # # 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 Chat.""" from telegram import TelegramObject, ChatPhoto class Chat(TelegramObject): """This object represents a chat. Attributes: id (:obj:`int`): Unique identifier for this chat. type (:obj:`str`): Type of chat. title (:obj:`str`): Optional. Title, for supergroups, channels and group chats. username (:obj:`str`): Optional. Username. first_name (:obj:`str`): Optional. First name of the other party in a private chat. last_name (:obj:`str`): Optional. Last name of the other party in a private chat. all_members_are_administrators (:obj:`bool`): Optional. photo (:class:`telegram.ChatPhoto`): Optional. Chat photo. description (:obj:`str`): Optional. Description, for supergroups and channel chats. invite_link (:obj:`str`): Optional. Chat invite link, for supergroups and channel chats. pinned_message (:class:`telegram.Message`): Optional. Pinned message, for supergroups. Returned only in get_chat. sticker_set_name (:obj:`str`): Optional. For supergroups, name of Group sticker set. can_set_sticker_set (:obj:`bool`): Optional. ``True``, if the bot can change group the sticker set. Args: id (:obj:`int`): Unique identifier for this chat. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. type (:obj:`str`): Type of chat, can be either 'private', 'group', 'supergroup' or 'channel'. title (:obj:`str`, optional): Title, for supergroups, channels and group chats. username(:obj:`str`, optional): Username, for private chats, supergroups and channels if available. first_name(:obj:`str`, optional): First name of the other party in a private chat. last_name(:obj:`str`, optional): Last name of the other party in a private chat. all_members_are_administrators (:obj:`bool`, optional): True if a group has `All Members Are Admins` enabled. photo (:class:`telegram.ChatPhoto`, optional): Chat photo. Returned only in getChat. description (:obj:`str`, optional): Description, for supergroups and channel chats. Returned only in get_chat. invite_link (:obj:`str`, optional): Chat invite link, for supergroups and channel chats. Returned only in get_chat. pinned_message (:class:`telegram.Message`, optional): Pinned message, for supergroups. Returned only in get_chat. bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods. sticker_set_name (:obj:`str`, optional): For supergroups, name of Group sticker set. Returned only in get_chat. can_set_sticker_set (:obj:`bool`, optional): ``True``, if the bot can change group the sticker set. Returned only in get_chat. **kwargs (:obj:`dict`): Arbitrary keyword arguments. """ PRIVATE = 'private' """:obj:`str`: 'private'""" GROUP = 'group' """:obj:`str`: 'group'""" SUPERGROUP = 'supergroup' """:obj:`str`: 'supergroup'""" CHANNEL = 'channel' """:obj:`str`: 'channel'""" def __init__(self, id, type, title=None, username=None, first_name=None, last_name=None, all_members_are_administrators=None, bot=None, photo=None, description=None, invite_link=None, pinned_message=None, sticker_set_name=None, can_set_sticker_set=None, **kwargs): # Required self.id = int(id) self.type = type # Optionals self.title = title self.username = username self.first_name = first_name self.last_name = last_name self.all_members_are_administrators = all_members_are_administrators self.photo = photo self.description = description self.invite_link = invite_link self.pinned_message = pinned_message self.sticker_set_name = sticker_set_name self.can_set_sticker_set = can_set_sticker_set self.bot = bot self._id_attrs = (self.id,) @property def link(self): """:obj:`str`: Convenience property. If the chat has a :attr:`username`, returns a t.me link of the chat.""" if self.username: return "https://t.me/{}".format(self.username) return None @classmethod def de_json(cls, data, bot): if not data: return None data['photo'] = ChatPhoto.de_json(data.get('photo'), bot) from telegram import Message data['pinned_message'] = Message.de_json(data.get('pinned_message'), bot) return cls(bot=bot, **data) def send_action(self, *args, **kwargs): """Shortcut for:: bot.send_chat_action(update.message.chat.id, *args, **kwargs) Returns: :obj:`bool`: If the action was sent successfully. """ return self.bot.send_chat_action(self.id, *args, **kwargs) def leave(self, *args, **kwargs): """Shortcut for:: bot.leave_chat(update.message.chat.id, *args, **kwargs) Returns: :obj:`bool` If the action was sent successfully. """ return self.bot.leave_chat(self.id, *args, **kwargs) def get_administrators(self, *args, **kwargs): """Shortcut for:: bot.get_chat_administrators(update.message.chat.id, *args, **kwargs) Returns: List[:class:`telegram.ChatMember`]: A list of administrators in a chat. An Array of :class:`telegram.ChatMember` objects 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 """ return self.bot.get_chat_administrators(self.id, *args, **kwargs) def get_members_count(self, *args, **kwargs): """Shortcut for:: bot.get_chat_members_count(update.message.chat.id, *args, **kwargs) Returns: :obj:`int` """ return self.bot.get_chat_members_count(self.id, *args, **kwargs) def get_member(self, *args, **kwargs): """Shortcut for:: bot.get_chat_member(update.message.chat.id, *args, **kwargs) Returns: :class:`telegram.ChatMember` """ return self.bot.get_chat_member(self.id, *args, **kwargs) def kick_member(self, *args, **kwargs): """Shortcut for:: bot.kick_chat_member(update.message.chat.id, *args, **kwargs) Returns: :obj:`bool`: If the action was sent succesfully. Note: This method will only work if the `All Members Are Admins` setting is off in the target group. Otherwise members may only be removed by the group's creator or by the member that added them. """ return self.bot.kick_chat_member(self.id, *args, **kwargs) def unban_member(self, *args, **kwargs): """Shortcut for:: bot.unban_chat_member(update.message.chat.id, *args, **kwargs) Returns: :obj:`bool`: If the action was sent successfully. """ return self.bot.unban_chat_member(self.id, *args, **kwargs) def send_message(self, *args, **kwargs): """Shortcut for:: bot.send_message(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_message(self.id, *args, **kwargs) def send_photo(self, *args, **kwargs): """Shortcut for:: bot.send_photo(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_photo(self.id, *args, **kwargs) def send_audio(self, *args, **kwargs): """Shortcut for:: bot.send_audio(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_audio(self.id, *args, **kwargs) def send_document(self, *args, **kwargs): """Shortcut for:: bot.send_document(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_document(self.id, *args, **kwargs) def send_animation(self, *args, **kwargs): """Shortcut for:: bot.send_animation(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_animation(self.id, *args, **kwargs) def send_sticker(self, *args, **kwargs): """Shortcut for:: bot.send_sticker(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_sticker(self.id, *args, **kwargs) def send_video(self, *args, **kwargs): """Shortcut for:: bot.send_video(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_video(self.id, *args, **kwargs) def send_video_note(self, *args, **kwargs): """Shortcut for:: bot.send_video_note(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_video_note(self.id, *args, **kwargs) def send_voice(self, *args, **kwargs): """Shortcut for:: bot.send_voice(Chat.id, *args, **kwargs) Where Chat is the current instance. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ return self.bot.send_voice(self.id, *args, **kwargs) |
| You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |