Add more detailed docs for ChatAction class

This commit is contained in:
Dan 2018-01-03 17:37:51 +01:00
parent bd00da380e
commit 0292d1d446

View File

@ -20,18 +20,45 @@ from pyrogram.api import types
class ChatAction: 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 CANCEL = types.SendMessageCancelAction
"""Cancels any chat action currently displayed."""
TYPING = types.SendMessageTypingAction TYPING = types.SendMessageTypingAction
"""User is typing a text message."""
PLAYING = types.SendMessageGamePlayAction PLAYING = types.SendMessageGamePlayAction
"""User is playing a game."""
CHOOSE_CONTACT = types.SendMessageChooseContactAction CHOOSE_CONTACT = types.SendMessageChooseContactAction
"""User is choosing a contact to share."""
UPLOAD_PHOTO = types.SendMessageUploadPhotoAction UPLOAD_PHOTO = types.SendMessageUploadPhotoAction
"""User is uploading a photo."""
RECORD_VIDEO = types.SendMessageRecordVideoAction RECORD_VIDEO = types.SendMessageRecordVideoAction
"""User is recording a video."""
UPLOAD_VIDEO = types.SendMessageUploadVideoAction UPLOAD_VIDEO = types.SendMessageUploadVideoAction
"""User is uploading a video."""
RECORD_AUDIO = types.SendMessageRecordAudioAction RECORD_AUDIO = types.SendMessageRecordAudioAction
"""User is recording an audio message."""
UPLOAD_AUDIO = types.SendMessageUploadAudioAction UPLOAD_AUDIO = types.SendMessageUploadAudioAction
"""User is uploading an audio message."""
UPLOAD_DOCUMENT = types.SendMessageUploadDocumentAction UPLOAD_DOCUMENT = types.SendMessageUploadDocumentAction
"""User is uploading a generic document."""
FIND_LOCATION = types.SendMessageGeoLocationAction FIND_LOCATION = types.SendMessageGeoLocationAction
"""User is searching for a location on the map."""
RECORD_VIDEO_NOTE = types.SendMessageRecordRoundAction RECORD_VIDEO_NOTE = types.SendMessageRecordRoundAction
"""User is recording a round video note."""
UPLOAD_VIDEO_NOTE = types.SendMessageUploadRoundAction UPLOAD_VIDEO_NOTE = types.SendMessageUploadRoundAction
"""User is uploading a round video note."""