phpbotgram

Message extends MaybeInaccessibleMessage

in package

• Application

uses MessageShortcuts

This object represents a message.

Table of Contents

Constants

WireNames  : array<string|int, mixed> = ['fromUser' => 'from']

Properties

$animation  : Animation|null

$audio  : Audio|null

$authorSignature  : string|null

$boostAdded  : ChatBoostAdded|null

$bot  : Bot|null

$businessConnectionId  : string|null

$caption  : string|null

$captionEntities  : array<string|int, mixed>|null

$channelChatCreated  : bool|null

$chat  : Chat

$chatBackgroundSet  : ChatBackground|null

$chatOwnerChanged  : ChatOwnerChanged|null

$chatOwnerLeft  : ChatOwnerLeft|null

$chatShared  : ChatShared|null

$checklist  : Checklist|null

$checklistTasksAdded  : ChecklistTasksAdded|null

$checklistTasksDone  : ChecklistTasksDone|null

$connectedWebsite  : string|null

$contact  : Contact|null

$date  : DateTime

$deleteChatPhoto  : bool|null

$dice  : Dice|null

$directMessagePriceChanged  : DirectMessagePriceChanged|null

$directMessagesTopic  : DirectMessagesTopic|null

$document  : Document|null

$editDate  : int|null

$effectId  : string|null

$entities  : array<string|int, mixed>|null

$externalReply  : ExternalReplyInfo|null

$forumTopicClosed  : ForumTopicClosed|null

$forumTopicCreated  : ForumTopicCreated|null

$forumTopicEdited  : ForumTopicEdited|null

$forumTopicReopened  : ForumTopicReopened|null

$forwardOrigin  : MessageOrigin|null

$fromUser  : User|null

$game  : Game|null

$generalForumTopicHidden  : GeneralForumTopicHidden|null

$generalForumTopicUnhidden  : GeneralForumTopicUnhidden|null

$gift  : GiftInfo|null

$giftUpgradeSent  : GiftInfo|null

$giveaway  : Giveaway|null

$giveawayCompleted  : GiveawayCompleted|null

$giveawayCreated  : GiveawayCreated|null

$giveawayWinners  : GiveawayWinners|null

$groupChatCreated  : bool|null

$guestBotCallerChat  : Chat|null

$guestBotCallerUser  : User|null

$guestQueryId  : string|null

$hasMediaSpoiler  : bool|null

$hasProtectedContent  : bool|null

$invoice  : Invoice|null

$isAutomaticForward  : bool|null

$isFromOffline  : bool|null

$isPaidPost  : bool|null

$isTopicMessage  : bool|null

$leftChatMember  : User|null

$linkPreviewOptions  : LinkPreviewOptions|null

$livePhoto  : LivePhoto|null

$location  : Location|null

$managedBotCreated  : ManagedBotCreated|null

$mediaGroupId  : string|null

$messageAutoDeleteTimerChanged  : MessageAutoDeleteTimerChanged|null

$messageId  : int

$messageThreadId  : int|null

$migrateFromChatId  : int|null

$migrateToChatId  : int|null

$newChatMembers  : array<string|int, mixed>|null

$newChatPhoto  : array<string|int, mixed>|null

$newChatTitle  : string|null

$paidMedia  : PaidMediaInfo|null

$paidMessagePriceChanged  : PaidMessagePriceChanged|null

$paidStarCount  : int|null

$passportData  : PassportData|null

$photo  : array<string|int, mixed>|null

$pinnedMessage  : MaybeInaccessibleMessage|null

$poll  : Poll|null

$pollOptionAdded  : PollOptionAdded|null

$pollOptionDeleted  : PollOptionDeleted|null

$proximityAlertTriggered  : ProximityAlertTriggered|null

$quote  : TextQuote|null

$refundedPayment  : RefundedPayment|null

$replyMarkup  : InlineKeyboardMarkup|null

$replyToChecklistTaskId  : int|null

$replyToMessage  : Message|null

$replyToPollOptionId  : string|null

$replyToStory  : Story|null

$richMessage  : RichMessage|null

$senderBoostCount  : int|null

$senderBusinessBot  : User|null

$senderChat  : Chat|null

$senderTag  : string|null

$showCaptionAboveMedia  : bool|null

$sticker  : Sticker|null

$story  : Story|null

$successfulPayment  : SuccessfulPayment|null

$suggestedPostApprovalFailed  : SuggestedPostApprovalFailed|null

$suggestedPostApproved  : SuggestedPostApproved|null

$suggestedPostDeclined  : SuggestedPostDeclined|null

$suggestedPostInfo  : SuggestedPostInfo|null

$suggestedPostPaid  : SuggestedPostPaid|null

$suggestedPostRefunded  : SuggestedPostRefunded|null

$supergroupChatCreated  : bool|null

$text  : string|null

$uniqueGift  : UniqueGiftInfo|null

$usersShared  : UsersShared|null

$venue  : Venue|null

$viaBot  : User|null

$video  : Video|null

$videoChatEnded  : VideoChatEnded|null

$videoChatParticipantsInvited  : VideoChatParticipantsInvited|null

$videoChatScheduled  : VideoChatScheduled|null

$videoChatStarted  : VideoChatStarted|null

$videoNote  : VideoNote|null

$voice  : Voice|null

$webAppData  : WebAppData|null

$writeAccessAllowed  : WriteAccessAllowed|null

Methods

__construct()  : mixed

answer()  : SendMessage

answerAnimation()  : SendAnimation

answerAudio()  : SendAudio

answerContact()  : SendContact

answerDice()  : SendDice

answerDocument()  : SendDocument

answerGame()  : SendGame

answerGuestQuery()  : AnswerGuestQuery

answerInvoice()  : SendInvoice

answerLocation()  : SendLocation

answerMediaGroup()  : SendMediaGroup

answerPaidMedia()  : SendPaidMedia

answerPhoto()  : SendPhoto

answerPoll()  : SendPoll

answerRich()  : SendRichMessage

answerSticker()  : SendSticker

answerVenue()  : SendVenue

answerVideo()  : SendVideo

answerVideoNote()  : SendVideoNote

answerVoice()  : SendVoice

as_()  : static

Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).

asReplyParameters()  : ReplyParameters

Build a `ReplyParameters` referencing this message.

copyTo()  : CopyMessage

delete()  : DeleteMessage

deleteReplyMarkup()  : EditMessageReplyMarkup

editCaption()  : EditMessageCaption

editLiveLocation()  : EditMessageLiveLocation

editMedia()  : EditMessageMedia

editReplyMarkup()  : EditMessageReplyMarkup

editText()  : EditMessageText

forward()  : ForwardMessage

pin()  : PinChatMessage

react()  : SetMessageReaction

reply()  : SendMessage

replyAnimation()  : SendAnimation

replyAudio()  : SendAudio

replyContact()  : SendContact

replyDice()  : SendDice

replyDocument()  : SendDocument

replyGame()  : SendGame

replyInvoice()  : SendInvoice

replyLocation()  : SendLocation

replyMediaGroup()  : SendMediaGroup

replyPaidMedia()  : SendPaidMedia

replyPhoto()  : SendPhoto

replyPoll()  : SendPoll

replyRich()  : SendRichMessage

replySticker()  : SendSticker

replyVenue()  : SendVenue

replyVideo()  : SendVideo

replyVideoNote()  : SendVideoNote

replyVoice()  : SendVoice

stopLiveLocation()  : StopMessageLiveLocation

unpin()  : UnpinChatMessage

withBot()  : static

Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.