TelegramPHP Documentation

Message extends MaybeInaccessibleMessage

in package

• Application

uses MessageBehaviour

This file is generated from spec/openapi.json (Bot API 10.3) by tools/generate.php.

Tags

link

https://core.telegram.org/bots/api#message

since

v10.3

Table of Contents

Constants

DISCRIMINATOR  : mixed = null

The attribute whose value names the concrete subtype.

SUBTYPES  : array<string, Part>>|array<int, Part>> = []

The concrete classes a union parent may resolve to - keyed by discriminator value when there is one, a plain list otherwise. Empty on ordinary parts.

Properties

$animation  : Animation|null

$audio  : Audio|null

$author_signature  : string|null

$boost_added  : ChatBoostAdded|null

$business_connection_id  : string|null

$caption  : string|null

$caption_entities  : Collection<string|int, MessageEntity>|null

$channel_chat_created  : bool|null

$chat  : Chat

$chat_background_set  : ChatBackground|null

$chat_owner_changed  : ChatOwnerChanged|null

$chat_owner_left  : ChatOwnerLeft|null

$chat_shared  : ChatShared|null

$checklist  : Checklist|null

$checklist_tasks_added  : ChecklistTasksAdded|null

$checklist_tasks_done  : ChecklistTasksDone|null

$community_chat_added  : CommunityChatAdded|null

$community_chat_joined  : CommunityChatJoined|null

$community_chat_removed  : CommunityChatRemoved|null

$connected_website  : string|null

$contact  : Contact|null

$date  : CarbonImmutable

$delete_chat_photo  : bool|null

$dice  : Dice|null

$direct_message_price_changed  : DirectMessagePriceChanged|null

$direct_messages_topic  : DirectMessagesTopic|null

$document  : Document|null

$edit_date  : CarbonImmutable|null

$effect_id  : string|null

$entities  : Collection<string|int, MessageEntity>|null

$ephemeral_message_id  : int|null

$external_reply  : ExternalReplyInfo|null

$forum_topic_closed  : ForumTopicClosed|null

$forum_topic_created  : ForumTopicCreated|null

$forum_topic_edited  : ForumTopicEdited|null

$forum_topic_reopened  : ForumTopicReopened|null

$forward_origin  : MessageOrigin|null

$from  : User|null

$game  : Game|null

$general_forum_topic_hidden  : GeneralForumTopicHidden|null

$general_forum_topic_unhidden  : GeneralForumTopicUnhidden|null

$gift  : GiftInfo|null

$gift_upgrade_sent  : GiftInfo|null

$giveaway  : Giveaway|null

$giveaway_completed  : GiveawayCompleted|null

$giveaway_created  : GiveawayCreated|null

$giveaway_winners  : GiveawayWinners|null

$group_chat_created  : bool|null

$guest_bot_caller_chat  : Chat|null

$guest_bot_caller_user  : User|null

$guest_query_id  : string|null

$has_media_spoiler  : bool|null

$has_protected_content  : bool|null

$invoice  : Invoice|null

$is_automatic_forward  : bool|null

$is_from_offline  : bool|null

$is_paid_post  : bool|null

$is_topic_message  : bool|null

$left_chat_member  : User|null

$link_preview_options  : LinkPreviewOptions|null

$live_photo  : LivePhoto|null

$location  : Location|null

$managed_bot_created  : ManagedBotCreated|null

$media_group_id  : string|null

$message_auto_delete_timer_changed  : MessageAutoDeleteTimerChanged|null

$message_id  : int

$message_thread_id  : int|null

$migrate_from_chat_id  : int|null

$migrate_to_chat_id  : int|null

$new_chat_members  : Collection<string|int, User>|null

$new_chat_photo  : Collection<string|int, PhotoSize>|null

$new_chat_title  : string|null

$paid_media  : PaidMediaInfo|null

$paid_message_price_changed  : PaidMessagePriceChanged|null

$paid_star_count  : int|null

$passport_data  : PassportData|null

$photo  : Collection<string|int, PhotoSize>|null

$pinned_message  : MaybeInaccessibleMessage|null

$poll  : Poll|null

$poll_option_added  : PollOptionAdded|null

$poll_option_deleted  : PollOptionDeleted|null

$proximity_alert_triggered  : ProximityAlertTriggered|null

$quote  : TextQuote|null

$receiver_user  : User|null

$refunded_payment  : RefundedPayment|null

$reply_markup  : InlineKeyboardMarkup|null

$reply_to_checklist_task_id  : int|null

$reply_to_message  : Message|null

$reply_to_poll_option_id  : string|null

$reply_to_story  : Story|null

$rich_message  : RichMessage|null

$sender_boost_count  : int|null

$sender_business_bot  : User|null

$sender_chat  : Chat|null

$sender_tag  : string|null

$show_caption_above_media  : bool|null

$sticker  : Sticker|null

$story  : Story|null

$successful_payment  : SuccessfulPayment|null

$suggested_post_approval_failed  : SuggestedPostApprovalFailed|null

$suggested_post_approved  : SuggestedPostApproved|null

$suggested_post_declined  : SuggestedPostDeclined|null

$suggested_post_info  : SuggestedPostInfo|null

$suggested_post_paid  : SuggestedPostPaid|null

$suggested_post_refunded  : SuggestedPostRefunded|null

$supergroup_chat_created  : bool|null

$text  : string|null

$unique_gift  : UniqueGiftInfo|null

$users_shared  : UsersShared|null

$venue  : Venue|null

$via_bot  : User|null

$video  : Video|null

$video_chat_ended  : VideoChatEnded|null

$video_chat_participants_invited  : VideoChatParticipantsInvited|null

$video_chat_scheduled  : VideoChatScheduled|null

$video_chat_started  : VideoChatStarted|null

$video_note  : VideoNote|null

$voice  : Voice|null

$web_app_data  : WebAppData|null

$write_access_allowed  : WriteAccessAllowed|null

$casts  : array<string, string>

$dates  : array<int, string>

$fillable  : array<int, string>

$telegram  : Telegram

Methods

__construct()  : mixed

__debugInfo()  : array<string, mixed>

__get()  : mixed

__isset()  : bool

__set()  : void

__toString()  : string

attributeExists()  : bool

copy()  : PromiseInterface<string|int, MessageId>

Copies this message to another chat, without a link back to the original.

delete()  : PromiseInterface<string|int, bool>

Deletes this message.

edit()  : PromiseInterface<string|int, Message|bool>

Edits this message's text. Only messages the bot sent can be edited.

editCaption()  : PromiseInterface<string|int, Message|bool>

Edits this message's caption.

editReplyMarkup()  : PromiseInterface<string|int, Message|bool>

Replaces the buttons under this message.

fill()  : void

forward()  : PromiseInterface<string|int, Message>

Forwards this message to another chat.

getAttribute()  : mixed

getCasts()  : array<string, string>

getChatId()  : int|string|null

The id of the chat this message belongs to.

getFillable()  : array<int, string>

getRawAttributes()  : array<string, mixed>

getTelegram()  : Telegram

jsonSerialize()  : array<string, mixed>

The payload this part would be sent back to Telegram as - nested parts and collections flattened, timestamps left as the integers they arrived as.

offsetExists()  : bool

offsetGet()  : mixed

offsetSet()  : void

offsetUnset()  : void

pin()  : PromiseInterface<string|int, bool>

Pins this message in its chat.

react()  : PromiseInterface<string|int, bool>

Reacts to this message. Passing no emoji clears the bot's reaction.

reply()  : PromiseInterface<string|int, Message>

Replies to this message.

replyWithDocument()  : PromiseInterface<string|int, Message>

Replies with a document.

replyWithPhoto()  : PromiseInterface<string|int, Message>

Replies with a photo.

resolveSubtype()  : Part>

say()  : PromiseInterface<string|int, Message>

Sends a message to this chat without quoting this one.

setAttribute()  : void

unpin()  : PromiseInterface<string|int, bool>

Unpins this message.

factory()  : Factory

Builds another part from the same client - for nested objects.

getRawAttribute()  : mixed

Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.

setRawAttribute()  : void

Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.