From 0292d1d4461955c478664996b86a91e8c38e79b4 Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Wed, 3 Jan 2018 17:37:51 +0100 Subject: [PATCH] Add more detailed docs for ChatAction class --- pyrogram/client/chat_action.py | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/pyrogram/client/chat_action.py b/pyrogram/client/chat_action.py index 777f61a2..d2a8c35a 100644 --- a/pyrogram/client/chat_action.py +++ b/pyrogram/client/chat_action.py @@ -20,18 +20,45 @@ from pyrogram.api import types class ChatAction: - """This class provides constants to be used for sending Chat Actions""" + """This class provides a convenient access to all Chat Actions available. + It is intended to be used with :obj:`pyrogram.Client.send_chat_action`. + """ CANCEL = types.SendMessageCancelAction + """Cancels any chat action currently displayed.""" + TYPING = types.SendMessageTypingAction + """User is typing a text message.""" + PLAYING = types.SendMessageGamePlayAction + """User is playing a game.""" + CHOOSE_CONTACT = types.SendMessageChooseContactAction + """User is choosing a contact to share.""" + UPLOAD_PHOTO = types.SendMessageUploadPhotoAction + """User is uploading a photo.""" + RECORD_VIDEO = types.SendMessageRecordVideoAction + """User is recording a video.""" + UPLOAD_VIDEO = types.SendMessageUploadVideoAction + """User is uploading a video.""" + RECORD_AUDIO = types.SendMessageRecordAudioAction + """User is recording an audio message.""" + UPLOAD_AUDIO = types.SendMessageUploadAudioAction + """User is uploading an audio message.""" + UPLOAD_DOCUMENT = types.SendMessageUploadDocumentAction + """User is uploading a generic document.""" + FIND_LOCATION = types.SendMessageGeoLocationAction + """User is searching for a location on the map.""" + RECORD_VIDEO_NOTE = types.SendMessageRecordRoundAction + """User is recording a round video note.""" + UPLOAD_VIDEO_NOTE = types.SendMessageUploadRoundAction + """User is uploading a round video note."""