phpbotgram

ChatFullInfo extends Chat
in package

FinalYes

This object contains full information about a chat.

Source: https://core.telegram.org/bots/api#chatfullinfo

Table of Contents

Properties

$accentColorId  : int
$acceptedGiftTypes  : AcceptedGiftTypes
$activeUsernames  : array<string|int, mixed>|null
$availableReactions  : array<string|int, mixed>|null
$backgroundCustomEmojiId  : string|null
$bio  : string|null
$birthdate  : Birthdate|null
$bot  : Bot|null
$businessIntro  : BusinessIntro|null
$businessLocation  : BusinessLocation|null
$businessOpeningHours  : BusinessOpeningHours|null
$canSendPaidMedia  : bool|null
$canSetStickerSet  : bool|null
$customEmojiStickerSetName  : string|null
$description  : string|null
$emojiStatusCustomEmojiId  : string|null
$emojiStatusExpirationDate  : DateTime|null
$firstName  : string|null
$firstProfileAudio  : Audio|null
$guardBot  : User|null
$hasAggressiveAntiSpamEnabled  : bool|null
$hasHiddenMembers  : bool|null
$hasPrivateForwards  : bool|null
$hasProtectedContent  : bool|null
$hasRestrictedVoiceAndVideoMessages  : bool|null
$hasVisibleHistory  : bool|null
$id  : int
$inviteLink  : string|null
$isDirectMessages  : bool|null
$isForum  : bool|null
$joinByRequest  : bool|null
$joinToSendMessages  : bool|null
$lastName  : string|null
$linkedChatId  : int|null
$location  : ChatLocation|null
$maxReactionCount  : int
$messageAutoDeleteTime  : int|null
$paidMessageStarCount  : int|null
$parentChat  : Chat|null
$permissions  : ChatPermissions|null
$personalChat  : Chat|null
$photo  : ChatPhoto|null
$pinnedMessage  : Message|null
$profileAccentColorId  : int|null
$profileBackgroundCustomEmojiId  : string|null
$rating  : UserRating|null
$slowModeDelay  : int|null
$stickerSetName  : string|null
$title  : string|null
$type  : string
$uniqueGiftColors  : UniqueGiftColors|null
$unrestrictBoostCount  : int|null
$username  : string|null

Methods

__construct()  : mixed
as_()  : static
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
ban()  : BanChatMember
banSenderChat()  : BanChatSenderChat
createInviteLink()  : CreateChatInviteLink
deleteMessage()  : DeleteMessage
deletePhoto()  : DeleteChatPhoto
deleteStickerSet()  : DeleteChatStickerSet
do()  : SendChatAction
editInviteLink()  : EditChatInviteLink
exportInviteLink()  : ExportChatInviteLink
fullName()  : string
getAdministrators()  : GetChatAdministrators
getMember()  : GetChatMember
getMemberCount()  : GetChatMemberCount
leave()  : LeaveChat
pinMessage()  : PinChatMessage
promote()  : PromoteChatMember
restrict()  : RestrictChatMember
revokeInviteLink()  : RevokeChatInviteLink
setAdministratorCustomTitle()  : SetChatAdministratorCustomTitle
setDescription()  : SetChatDescription
setMemberTag()  : SetChatMemberTag
setPermissions()  : SetChatPermissions
setPhoto()  : SetChatPhoto
setStickerSet()  : SetChatStickerSet
setTitle()  : SetChatTitle
unban()  : UnbanChatMember
unbanSenderChat()  : UnbanChatSenderChat
unpinAllGeneralForumTopicMessages()  : UnpinAllGeneralForumTopicMessages
unpinAllMessages()  : UnpinAllChatMessages
unpinMessage()  : 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.

Properties

$activeUsernames read-only

public array<string|int, mixed>|null $activeUsernames = null

$availableReactions read-only

public array<string|int, mixed>|null $availableReactions = null

$backgroundCustomEmojiId read-only

public string|null $backgroundCustomEmojiId = null

$canSendPaidMedia read-only

public bool|null $canSendPaidMedia = null

$canSetStickerSet read-only

public bool|null $canSetStickerSet = null

$customEmojiStickerSetName read-only

public string|null $customEmojiStickerSetName = null

$description read-only

public string|null $description = null

$emojiStatusCustomEmojiId read-only

public string|null $emojiStatusCustomEmojiId = null

$firstName read-only

public string|null $firstName = null

$hasAggressiveAntiSpamEnabled read-only

public bool|null $hasAggressiveAntiSpamEnabled = null

$hasHiddenMembers read-only

public bool|null $hasHiddenMembers = null

$hasPrivateForwards read-only

public bool|null $hasPrivateForwards = null

$hasProtectedContent read-only

public bool|null $hasProtectedContent = null

$hasRestrictedVoiceAndVideoMessages read-only

public bool|null $hasRestrictedVoiceAndVideoMessages = null

$hasVisibleHistory read-only

public bool|null $hasVisibleHistory = null

$id read-only

public int $id

$inviteLink read-only

public string|null $inviteLink = null

$isDirectMessages read-only

public bool|null $isDirectMessages = null

$isForum read-only

public bool|null $isForum = null

$joinByRequest read-only

public bool|null $joinByRequest = null

$joinToSendMessages read-only

public bool|null $joinToSendMessages = null

$lastName read-only

public string|null $lastName = null

$linkedChatId read-only

public int|null $linkedChatId = null

$maxReactionCount read-only

public int $maxReactionCount

$messageAutoDeleteTime read-only

public int|null $messageAutoDeleteTime = null

$paidMessageStarCount read-only

public int|null $paidMessageStarCount = null

$profileAccentColorId read-only

public int|null $profileAccentColorId = null

$profileBackgroundCustomEmojiId read-only

public string|null $profileBackgroundCustomEmojiId = null

$slowModeDelay read-only

public int|null $slowModeDelay = null

$stickerSetName read-only

public string|null $stickerSetName = null

$title read-only

public string|null $title = null

$type read-only

public string $type

$unrestrictBoostCount read-only

public int|null $unrestrictBoostCount = null

$username read-only

public string|null $username = null

Methods

__construct()

public __construct(int $id, string $type, int $accentColorId, int $maxReactionCount, AcceptedGiftTypes $acceptedGiftTypes[, string|null $title = null ][, string|null $username = null ][, string|null $firstName = null ][, string|null $lastName = null ][, bool|null $isForum = null ][, bool|null $isDirectMessages = null ][, ChatPhoto|null $photo = null ][, null|array<int, string> $activeUsernames = null ][, Birthdate|null $birthdate = null ][, BusinessIntro|null $businessIntro = null ][, BusinessLocation|null $businessLocation = null ][, BusinessOpeningHours|null $businessOpeningHours = null ][, Chat|null $personalChat = null ][, Chat|null $parentChat = null ][, null|array<int, ReactionType> $availableReactions = null ][, string|null $backgroundCustomEmojiId = null ][, int|null $profileAccentColorId = null ][, string|null $profileBackgroundCustomEmojiId = null ][, string|null $emojiStatusCustomEmojiId = null ][, DateTime|null $emojiStatusExpirationDate = null ][, string|null $bio = null ][, bool|null $hasPrivateForwards = null ][, bool|null $hasRestrictedVoiceAndVideoMessages = null ][, bool|null $joinToSendMessages = null ][, bool|null $joinByRequest = null ][, string|null $description = null ][, string|null $inviteLink = null ][, Message|null $pinnedMessage = null ][, ChatPermissions|null $permissions = null ][, bool|null $canSendPaidMedia = null ][, int|null $slowModeDelay = null ][, int|null $unrestrictBoostCount = null ][, int|null $messageAutoDeleteTime = null ][, bool|null $hasAggressiveAntiSpamEnabled = null ][, bool|null $hasHiddenMembers = null ][, bool|null $hasProtectedContent = null ][, bool|null $hasVisibleHistory = null ][, string|null $stickerSetName = null ][, bool|null $canSetStickerSet = null ][, string|null $customEmojiStickerSetName = null ][, int|null $linkedChatId = null ][, ChatLocation|null $location = null ][, UserRating|null $rating = null ][, Audio|null $firstProfileAudio = null ][, UniqueGiftColors|null $uniqueGiftColors = null ][, int|null $paidMessageStarCount = null ][, User|null $guardBot = null ][, Bot|null $bot = null ]) : mixed
Parameters
$id : int
$type : string
$accentColorId : int
$maxReactionCount : int
$acceptedGiftTypes : AcceptedGiftTypes
$title : string|null = null
$username : string|null = null
$firstName : string|null = null
$lastName : string|null = null
$isForum : bool|null = null
$isDirectMessages : bool|null = null
$photo : ChatPhoto|null = null
$activeUsernames : null|array<int, string> = null
$birthdate : Birthdate|null = null
$businessIntro : BusinessIntro|null = null
$businessLocation : BusinessLocation|null = null
$businessOpeningHours : BusinessOpeningHours|null = null
$personalChat : Chat|null = null
$parentChat : Chat|null = null
$availableReactions : null|array<int, ReactionType> = null
$backgroundCustomEmojiId : string|null = null
$profileAccentColorId : int|null = null
$profileBackgroundCustomEmojiId : string|null = null
$emojiStatusCustomEmojiId : string|null = null
$emojiStatusExpirationDate : DateTime|null = null
$bio : string|null = null
$hasPrivateForwards : bool|null = null
$hasRestrictedVoiceAndVideoMessages : bool|null = null
$joinToSendMessages : bool|null = null
$joinByRequest : bool|null = null
$description : string|null = null
$inviteLink : string|null = null
$pinnedMessage : Message|null = null
$permissions : ChatPermissions|null = null
$canSendPaidMedia : bool|null = null
$slowModeDelay : int|null = null
$unrestrictBoostCount : int|null = null
$messageAutoDeleteTime : int|null = null
$hasAggressiveAntiSpamEnabled : bool|null = null
$hasHiddenMembers : bool|null = null
$hasProtectedContent : bool|null = null
$hasVisibleHistory : bool|null = null
$stickerSetName : string|null = null
$canSetStickerSet : bool|null = null
$customEmojiStickerSetName : string|null = null
$linkedChatId : int|null = null
$location : ChatLocation|null = null
$rating : UserRating|null = null
$firstProfileAudio : Audio|null = null
$uniqueGiftColors : UniqueGiftColors|null = null
$paidMessageStarCount : int|null = null
$guardBot : User|null = null
$bot : Bot|null = null

as_()

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

public as_(Bot|null $bot) : static

IMPORTANT: behaves DIFFERENTLY from upstream — upstream mutates self.bot in place and returns self. The PHP port can't mutate readonly, so this returns a clone. Callers must reassign: $msg = $msg->as($bot).

Parameters
$bot : Bot|null
Return values
static

ban()

public ban(int $userId[, DateInterval|DateTime|int|null $untilDate = null ][, bool|null $revokeMessages = null ]) : BanChatMember
Parameters
$userId : int
$untilDate : DateInterval|DateTime|int|null = null
$revokeMessages : bool|null = null
Return values
BanChatMember

createInviteLink()

public createInviteLink([string|null $name = null ][, DateInterval|DateTime|int|null $expireDate = null ][, int|null $memberLimit = null ][, bool|null $createsJoinRequest = null ]) : CreateChatInviteLink
Parameters
$name : string|null = null
$expireDate : DateInterval|DateTime|int|null = null
$memberLimit : int|null = null
$createsJoinRequest : bool|null = null
Return values
CreateChatInviteLink

do()

public do(string $action[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ]) : SendChatAction
Parameters
$action : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
Return values
SendChatAction

editInviteLink()

public editInviteLink(string $inviteLink[, string|null $name = null ][, DateInterval|DateTime|int|null $expireDate = null ][, int|null $memberLimit = null ][, bool|null $createsJoinRequest = null ]) : EditChatInviteLink
Parameters
$inviteLink : string
$name : string|null = null
$expireDate : DateInterval|DateTime|int|null = null
$memberLimit : int|null = null
$createsJoinRequest : bool|null = null
Return values
EditChatInviteLink

pinMessage()

public pinMessage(int $messageId[, string|null $businessConnectionId = null ][, bool|null $disableNotification = null ]) : PinChatMessage
Parameters
$messageId : int
$businessConnectionId : string|null = null
$disableNotification : bool|null = null
Return values
PinChatMessage

promote()

public promote(int $userId[, bool|null $isAnonymous = null ][, bool|null $canManageChat = null ][, bool|null $canDeleteMessages = null ][, bool|null $canManageVideoChats = null ][, bool|null $canRestrictMembers = null ][, bool|null $canPromoteMembers = null ][, bool|null $canChangeInfo = null ][, bool|null $canInviteUsers = null ][, bool|null $canPostStories = null ][, bool|null $canEditStories = null ][, bool|null $canDeleteStories = null ][, bool|null $canPostMessages = null ][, bool|null $canEditMessages = null ][, bool|null $canPinMessages = null ][, bool|null $canManageTopics = null ][, bool|null $canManageDirectMessages = null ][, bool|null $canManageTags = null ]) : PromoteChatMember
Parameters
$userId : int
$isAnonymous : bool|null = null
$canManageChat : bool|null = null
$canDeleteMessages : bool|null = null
$canManageVideoChats : bool|null = null
$canRestrictMembers : bool|null = null
$canPromoteMembers : bool|null = null
$canChangeInfo : bool|null = null
$canInviteUsers : bool|null = null
$canPostStories : bool|null = null
$canEditStories : bool|null = null
$canDeleteStories : bool|null = null
$canPostMessages : bool|null = null
$canEditMessages : bool|null = null
$canPinMessages : bool|null = null
$canManageTopics : bool|null = null
$canManageDirectMessages : bool|null = null
$canManageTags : bool|null = null
Return values
PromoteChatMember

unban()

public unban(int $userId[, bool|null $onlyIfBanned = null ]) : UnbanChatMember
Parameters
$userId : int
$onlyIfBanned : bool|null = null
Return values
UnbanChatMember

unpinMessage()

public unpinMessage([string|null $businessConnectionId = null ][, int|null $messageId = null ]) : UnpinChatMessage
Parameters
$businessConnectionId : string|null = null
$messageId : int|null = null
Return values
UnpinChatMessage

withBot()

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.

public withBot(Bot|null $bot) : static

list<list<KeyboardButton>>) are walked element-wise. Plain values (scalars, DateTime, enums, InputFile etc.) pass through untouched.

Mirrors upstream pydantic model_validate(context={"bot": bot}) (aiogram ContextController.as_/model_dump_json+model_validate).

Scope note: PHP 8.5 treats public readonly as effectively public protected(set) readonly for clone-with — only code running with a scope in the property's declaring class hierarchy (declaring class plus its ancestors and descendants) can use clone($obj, ['x' => ...]) against it. Because this method lives on BotContextController and every TelegramObject/TelegramMethod subclass extends it, the walker's clone($this, [...]) call legally rewrites subclass-declared readonly slots like Message::$chat. External callers cannot use the same syntax — they must funnel through this method.

Parameters
$bot : Bot|null
Return values
static
On this page

Search results