Skip to content

Commit cdb6d67

Browse files
committed
Add some comment.
1 parent 5bd8e9d commit cdb6d67

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

telebot/__init__.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,25 +295,53 @@ def get_user_profile_photos(self, user_id, offset=None, limit=None):
295295
return types.UserProfilePhotos.de_json(result)
296296

297297
def get_chat(self, chat_id):
298+
"""
299+
Use this method to get up to date information about the chat (current name of the user for one-on-one
300+
conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
301+
:param chat_id:
302+
:return:
303+
"""
298304
result = apihelper.get_chat(self.token, chat_id)
299305
return types.Chat.de_json(result)
300306

301307
def leave_chat(self, chat_id):
308+
"""
309+
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
310+
:param chat_id:
311+
:return:
312+
"""
302313
result = apihelper.leave_chat(self.token, chat_id)
303314
return result
304315

305316
def get_chat_administrators(self, chat_id):
317+
"""
318+
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects
319+
that contains information about all chat administrators except other bots.
320+
:param chat_id:
321+
:return:
322+
"""
306323
result = apihelper.get_chat_administrators(self.token, chat_id)
307324
ret = []
308325
for r in result:
309326
ret.append(types.ChatMember.de_json(r))
310327
return ret
311328

312329
def get_chat_members_count(self, chat_id):
330+
"""
331+
Use this method to get the number of members in a chat. Returns Int on success.
332+
:param chat_id:
333+
:return:
334+
"""
313335
result = apihelper.get_chat_members_count(self.token, chat_id)
314336
return result
315337

316338
def get_chat_member(self, chat_id, user_id):
339+
"""
340+
Use this method to get information about a member of a chat. Returns a ChatMember object on success.
341+
:param chat_id:
342+
:param user_id:
343+
:return:
344+
"""
317345
result = apihelper.get_chat_member(self.token, chat_id, user_id)
318346
return types.ChatMember.de_json(result)
319347

0 commit comments

Comments
 (0)