ExternalReplyInfo
extends Part
in package
This file is generated from spec/openapi.json (Bot API 10.3) by tools/generate.php.
Do not edit it by hand - run composer spec:build instead.
This object contains information about a message that is being replied to, which may come from another chat or forum topic.
Tags
Table of Contents
Constants
- DISCRIMINATOR : mixed = null
- The attribute whose value names the concrete subtype, for union parents.
- 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
- $chat : Chat|null
- $checklist : Checklist|null
- $contact : Contact|null
- $dice : Dice|null
- $document : Document|null
- $game : Game|null
- $giveaway : Giveaway|null
- $giveaway_winners : GiveawayWinners|null
- $has_media_spoiler : bool|null
- $invoice : Invoice|null
- $link_preview_options : LinkPreviewOptions|null
- $live_photo : LivePhoto|null
- $location : Location|null
- $message_id : int|null
- $origin : MessageOrigin
- $paid_media : PaidMediaInfo|null
- $photo : Collection<string|int, PhotoSize>|null
- $poll : Poll|null
- $sticker : Sticker|null
- $story : Story|null
- $venue : Venue|null
- $video : Video|null
- $video_note : VideoNote|null
- $voice : Voice|null
- $casts : array<string, string>
- Attribute name => Telegram type token ("User", "Array of PhotoSize"), used to hydrate nested objects into parts.
- $dates : array<int, string>
- Attribute names holding Unix timestamps, read back as {@see CarbonImmutable}.
- $fillable : array<int, string>
- Attribute names this part accepts. Empty = accept anything.
- $telegram : Telegram
Methods
- __construct() : mixed
- __debugInfo() : array<string, mixed>
- __get() : mixed
- __isset() : bool
- __set() : void
- __toString() : string
- attributeExists() : bool
- fill() : void
- getAttribute() : mixed
- getCasts() : array<string, string>
- 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
- resolveSubtype() : Part>
- The concrete class an incoming payload belongs to, for a union parent.
- setAttribute() : void
- 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()}.
Constants
DISCRIMINATOR
The attribute whose value names the concrete subtype, for union parents.
public
mixed
DISCRIMINATOR
= null
null on ordinary parts and on unions Telegram does not tag.
SUBTYPES
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.
public
array<string, Part>>|array<int, Part>>
SUBTYPES
= []
Properties
$animation
public
Animation|null
$animation
Optional. Message is an animation, information about the animation
$audio
public
Audio|null
$audio
Optional. Message is an audio file, information about the file
$chat
public
Chat|null
$chat
Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.
$checklist
public
Checklist|null
$checklist
Optional. Message is a checklist
$contact
public
Contact|null
$contact
Optional. Message is a shared contact, information about the contact
$dice
public
Dice|null
$dice
Optional. Message is a dice with random value
$document
public
Document|null
$document
Optional. Message is a general file, information about the file
$game
public
Game|null
$game
Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games
$giveaway
public
Giveaway|null
$giveaway
Optional. Message is a scheduled giveaway, information about the giveaway
$giveaway_winners
public
GiveawayWinners|null
$giveaway_winners
Optional. A giveaway with public winners was completed
$has_media_spoiler
public
bool|null
$has_media_spoiler
Optional. True, if the message media is covered by a spoiler animation
$invoice
public
Invoice|null
$invoice
Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments
$link_preview_options
public
LinkPreviewOptions|null
$link_preview_options
Optional. Options used for link preview generation for the original message, if it is a text message
$live_photo
public
LivePhoto|null
$live_photo
Optional. Message is a live photo, information about the live photo
$location
public
Location|null
$location
Optional. Message is a shared location, information about the location
$message_id
public
int|null
$message_id
Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.
$origin
public
MessageOrigin
$origin
Origin of the message replied to by the given message
$paid_media
public
PaidMediaInfo|null
$paid_media
Optional. Message contains paid media; information about the paid media
$photo
public
Collection<string|int, PhotoSize>|null
$photo
Optional. Message is a photo, available sizes of the photo
$poll
public
Poll|null
$poll
Optional. Message is a native poll, information about the poll
$sticker
public
Sticker|null
$sticker
Optional. Message is a sticker, information about the sticker
$story
public
Story|null
$story
Optional. Message is a forwarded story
$venue
public
Venue|null
$venue
Optional. Message is a venue, information about the venue
$video
public
Video|null
$video
Optional. Message is a video, information about the video
$video_note
public
VideoNote|null
$video_note
Optional. Message is a video note, information about the video message
$voice
public
Voice|null
$voice
Optional. Message is a voice message, information about the file
$casts
Attribute name => Telegram type token ("User", "Array of PhotoSize"), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= ['origin' => 'MessageOrigin', 'chat' => 'Chat', 'link_preview_options' => 'LinkPreviewOptions', 'animation' => 'Animation', 'audio' => 'Audio', 'document' => 'Document', 'live_photo' => 'LivePhoto', 'paid_media' => 'PaidMediaInfo', 'photo' => 'Array of PhotoSize', 'sticker' => 'Sticker', 'story' => 'Story', 'video' => 'Video', 'video_note' => 'VideoNote', 'voice' => 'Voice', 'checklist' => 'Checklist', 'contact' => 'Contact', 'dice' => 'Dice', 'game' => 'Game', 'giveaway' => 'Giveaway', 'giveaway_winners' => 'GiveawayWinners', 'invoice' => 'Invoice', 'location' => 'Location', 'poll' => 'Poll', 'venue' => 'Venue']
$dates
Attribute names holding Unix timestamps, read back as {@see CarbonImmutable}.
protected
array<int, string>
$dates
= []
$fillable
Attribute names this part accepts. Empty = accept anything.
protected
array<int, string>
$fillable
= ['origin', 'chat', 'message_id', 'link_preview_options', 'animation', 'audio', 'document', 'live_photo', 'paid_media', 'photo', 'sticker', 'story', 'video', 'video_note', 'voice', 'has_media_spoiler', 'checklist', 'contact', 'dice', 'game', 'giveaway', 'giveaway_winners', 'invoice', 'location', 'poll', 'venue']
$telegram read-only
protected
Telegram
$telegram
Methods
__construct()
public
__construct(Telegram $telegram[, array<string, mixed>|object $attributes = [] ]) : mixed
Parameters
- $telegram : Telegram
- $attributes : array<string, mixed>|object = []
__debugInfo()
public
__debugInfo() : array<string, mixed>
Return values
array<string, mixed>__get()
public
__get(string $name) : mixed
Parameters
- $name : string
__isset()
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool__set()
public
__set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
__toString()
public
__toString() : string
Return values
stringattributeExists()
public
attributeExists(string $key) : bool
Parameters
- $key : string
Return values
boolfill()
public
fill(array<string, mixed> $attributes) : void
Parameters
- $attributes : array<string, mixed>
getAttribute()
public
getAttribute(string $key) : mixed
Parameters
- $key : string
getCasts()
public
getCasts() : array<string, string>
Return values
array<string, string>getFillable()
public
getFillable() : array<int, string>
Return values
array<int, string>getRawAttributes()
public
getRawAttributes() : array<string, mixed>
Return values
array<string, mixed>getTelegram()
public
getTelegram() : Telegram
Return values
TelegramjsonSerialize()
The payload this part would be sent back to Telegram as - nested parts and collections flattened, timestamps left as the integers they arrived as.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
resolveSubtype()
The concrete class an incoming payload belongs to, for a union parent.
public
static resolveSubtype(array<string, mixed> $attributes) : Part>
Tagged unions resolve on their discriminator. The handful Telegram leaves
untagged (InputMessageContent, and the rest), and any payload whose tag
this build does not recognise - a member added to the Bot API since it was
generated - resolve instead to the subtype whose attributes the payload
matches most closely.
Parameters
- $attributes : array<string, mixed>
Tags
Return values
Part>setAttribute()
public
setAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
factory()
Builds another part from the same client - for nested objects.
protected
factory() : Factory
Return values
FactorygetRawAttribute()
Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
protected
getRawAttribute(string $key) : mixed
Parameters
- $key : string
setRawAttribute()
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()}.
protected
setRawAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed