• Home
• TelegramBot
• Api
• Types
• Message

PHP Class TelegramBot\Api\Types\Message

Show file Open project: TelegramBot/Api Class Usage Examples

Protected Properties

Property	Type	Description
$audio	TelegramBot\Api\Types\Audio	Optional. Message is an audio file, information about the file
$caption	string	Optional. Text description of the video (usually empty)
$channelChatCreated	boolean	Optional. Service message: the channel has been created
$chat	Chat	Conversation the message belongs to — user in case of a private message, GroupChat in case of a group
$contact	TelegramBot\Api\Types\Contact	Optional. Message is a shared contact, information about the contact
$date	integer	Date the message was sent in Unix time
$deleteChatPhoto	boolean	Optional. Informs that the group photo was deleted
$document	TelegramBot\Api\Types\Document	Optional. Message is a general file, information about the file
$entities	array	array of \TelegramBot\Api\Types\MessageEntity
$forwardDate	integer	Optional. For forwarded messages, date the original message was sent in Unix time
$forwardFrom	User	Optional. For forwarded messages, sender of the original message
$from	User	Optional. Sender name. Can be empty for messages sent to channels
$groupChatCreated	boolean	Optional. Informs that the group has been created
$leftChatMember	User	Optional. A member was removed from the group, information about them (this member may be bot itself)
$location	TelegramBot\Api\Types\Location	Optional. Message is a shared location, information about the location
$map	array
$messageId	integer	Unique message identifier
$migrateFromChatId	integer	Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value
$migrateToChatId	integer	Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value
$newChatMember	User	Optional. A new member was added to the group, information about them (this member may be bot itself)
$newChatPhoto	mixed	Optional. A group photo was change to this value
$newChatTitle	string	Optional. A group title was changed to this value
$photo	array	Optional. Message is a photo, available sizes of the photo array of \TelegramBot\Api\Types\Photo
$pinnedMessage	Message	Optional. Specified message was pinned.Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
$replyToMessage	Message	Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
$requiredParams	array
$sticker	TelegramBot\Api\Types\Sticker	Optional. Message is a sticker, information about the sticker
$supergroupChatCreated	boolean	Optional. Service message: the supergroup has been created
$text	string	Optional. For text messages, the actual UTF-8 text of the message
$venue	Venue	Optional. Message is a venue, information about the venue
$video	TelegramBot\Api\Types\Video	Optional. Message is a video, information about the video
$voice	TelegramBot\Api\Types\Voice	Optional. Message is a voice message, information about the file

Public Methods

Method	Description
getAudio ( ) : TelegramBot\Api\Types\Audio
getCaption ( ) : string
getChat ( ) : Chat
getContact ( ) : TelegramBot\Api\Types\Contact
getDate ( ) : integer
getDocument ( ) : TelegramBot\Api\Types\Document
getEntities ( ) : array
getForwardDate ( ) : integer
getForwardFrom ( ) : User
getFrom ( ) : User
getLeftChatMember ( ) : User
getLocation ( ) : TelegramBot\Api\Types\Location
getMessageId ( ) : integer
getMigrateFromChatId ( ) : integer
getMigrateToChatId ( ) : integer
getNewChatMember ( ) : User
getNewChatPhoto ( ) : array
getNewChatTitle ( ) : string
getPhoto ( ) : array
getPinnedMessage ( ) : Message
getReplyToMessage ( ) : Message
getSticker ( ) : TelegramBot\Api\Types\Sticker
getText ( ) : string
getVenue ( ) : Venue
getVideo ( ) : TelegramBot\Api\Types\Video
getVoice ( ) : TelegramBot\Api\Types\Voice
isChannelChatCreated ( ) : boolean
isDeleteChatPhoto ( ) : boolean
isGroupChatCreated ( ) : boolean
isSupergroupChatCreated ( ) : boolean
setAudio ( TelegramBot\Api\Types\Audio $audio )
setCaption ( string $caption )
setChannelChatCreated ( boolean $channelChatCreated )
setChat ( Chat $chat )
setContact ( TelegramBot\Api\Types\Contact $contact )
setDate ( integer $date )
setDeleteChatPhoto ( boolean $deleteChatPhoto )
setDocument ( TelegramBot\Api\Types\Document $document )
setEntities ( array $entities )
setForwardDate ( integer $forwardDate )
setForwardFrom ( User $forwardFrom )
setFrom ( User $from )
setGroupChatCreated ( boolean $groupChatCreated )
setLeftChatMember ( User $leftChatMember )
setLocation ( TelegramBot\Api\Types\Location $location )
setMessageId ( integer $messageId )
setMigrateFromChatId ( integer $migrateFromChatId )
setMigrateToChatId ( integer $migrateToChatId )
setNewChatMember ( User $newChatMember )
setNewChatPhoto ( array $newChatPhoto )
setNewChatTitle ( string $newChatTitle )
setPhoto ( array $photo )
setPinnedMessage ( Message $pinnedMessage )
setReplyToMessage ( Message $replyToMessage )
setSticker ( TelegramBot\Api\Types\Sticker $sticker )
setSupergroupChatCreated ( boolean $supergroupChatCreated )
setText ( string $text )
setVenue ( Venue $venue )
setVideo ( TelegramBot\Api\Types\Video $video )
setVoice ( TelegramBot\Api\Types\Voice $voice )

Method Details

Property Details