Enumerations

This page is about Pyrogram enumerations. Enumerations are types that hold a group of related values to be used whenever a constant value is required. They will help you deal with those values in a type-safe way and also enable code completion so that you can be sure to apply only a valid value among the expected ones.


BlockList

Block list enumeration

BusinessSchedule

Business away enumeration used in BusinessMessage.

ButtonStyle

Button style type enumeration used in KeyboardButton and InlineKeyboardButton.

ChatAction

Chat action enumeration used in ChatEvent.

ChatEventAction

Chat event action enumeration used in get_chat_event_log().

ChatJoinType

How the service message NEW_CHAT_MEMBERS was used for the member to join the chat.

ChatMemberStatus

Chat member status enumeration used in ChatMember.

ChatMembersFilter

Chat members filter enumeration used in get_chat_members()

ChatType

Chat type enumeration used in Chat.

ClientPlatform

Valid platforms for a Client.

FolderColor

Folder color enumeration used in Folder.

MessageEntityType

Message entity type enumeration used in MessageEntity.

MessageMediaType

Message media type enumeration used in Message.

MessageOriginType

Message origin type enumeration used in MessageOrigin.

MessageServiceType

Message service type enumeration used in Message.

MessagesFilter

Messages filter enumeration used in search_messages() and search_global()

NextCodeType

Next code type enumeration used in SentCode.

PaidReactionPrivacy

Reaction privacy type enumeration used in send_paid_reaction().

ParseMode

Parse mode enumeration used in various places to set a specific parse mode

PhoneCallDiscardReason

Phone call discard reason enumeration used in PhoneCallEnded.

PhoneNumberCodeType

Describes type of the request for which a code is sent to a phone number

PollType

Poll type enumeration used in Poll.

PrivacyKey

Privacy key enumeration used in set_privacy().

ProfileColor

Profile color enumeration used in update_color() and ChatColor.

ProfileTab

Profile tab enumeration used in Chat.

ReplyColor

Reply color enumeration used in update_color() and ChatColor.

SentCodeType

Sent code type enumeration used in SentCode.

StoriesPrivacyRules

Stories privacy rules type enumeration used in send_story().

UserStatus

User status enumeration used in User.

UpgradedGiftOrigin

Origin from which the upgraded gift was obtained.

GiftAttributeType

Star gift attribute type enumeration used in GiftAttribute.

MediaAreaType

Media area type enumeration used in MediaArea.

PrivacyRuleType

Privacy rule type enumeration used in PrivacyRule.

GiftForResaleOrder

Describes order in which upgraded gifts for resale will be sorted.

GiftPurchaseOfferState

Gift purchase offer state enumeration used in UpgradedGiftPurchaseOffer.

GiftType

Gift type enumeration used in Gift.

PaymentFormType

Describes type of payment form.

StickerType

Sticker type enumeration used in Sticker.

MaskPointType

Mask point type enumeration used in MaskPosition.

SuggestedPostRefundReason

Suggested post refund reason enumeration used in SuggestedPostRefunded.

SuggestedPostState

Suggested post state enumeration used in SuggestedPostInfo.