TelegramPHP Documentation

ChatFullInfo extends Part
in package
uses ChatFullInfoBehaviour

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 full information about a chat.

Tags
link
https://core.telegram.org/bots/api#chatfullinfo
since

v10.3

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

$accent_color_id  : int
$accepted_gift_types  : AcceptedGiftTypes
$active_usernames  : array<int, string>|null
$available_reactions  : Collection<string|int, ReactionType>|null
$background_custom_emoji_id  : string|null
$bio  : string|null
$birthdate  : Birthdate|null
$business_intro  : BusinessIntro|null
$business_location  : BusinessLocation|null
$business_opening_hours  : BusinessOpeningHours|null
$can_send_paid_media  : bool|null
$can_set_sticker_set  : bool|null
$community  : Community|null
$custom_emoji_sticker_set_name  : string|null
$description  : string|null
$emoji_status_custom_emoji_id  : string|null
$emoji_status_expiration_date  : CarbonImmutable|null
$first_name  : string|null
$first_profile_audio  : Audio|null
$guard_bot  : User|null
$has_aggressive_anti_spam_enabled  : bool|null
$has_hidden_members  : bool|null
$has_private_forwards  : bool|null
$has_protected_content  : bool|null
$has_restricted_voice_and_video_messages  : bool|null
$has_visible_history  : bool|null
$id  : int
$invite_link  : string|null
$is_direct_messages  : bool|null
$is_forum  : bool|null
$join_by_request  : bool|null
$join_to_send_messages  : bool|null
$last_name  : string|null
$linked_chat_id  : int|null
$location  : ChatLocation|null
$max_reaction_count  : int
$message_auto_delete_time  : int|null
$paid_message_star_count  : int|null
$parent_chat  : Chat|null
$permissions  : ChatPermissions|null
$personal_chat  : Chat|null
$photo  : ChatPhoto|null
$pinned_message  : Message|null
$profile_accent_color_id  : int|null
$profile_background_custom_emoji_id  : string|null
$rating  : UserRating|null
$slow_mode_delay  : int|null
$sticker_set_name  : string|null
$title  : string|null
$type  : string
$unique_gift_colors  : UniqueGiftColors|null
$unrestrict_boost_count  : int|null
$username  : string|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

$accent_color_id

public int $accent_color_id

Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.

$accepted_gift_types

public AcceptedGiftTypes $accepted_gift_types

Information about types of gifts that are accepted by the chat or by the corresponding user for private chats

$active_usernames

public array<int, string>|null $active_usernames

Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels

$available_reactions

public Collection<string|int, ReactionType>|null $available_reactions

Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.

$background_custom_emoji_id

public string|null $background_custom_emoji_id

Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background

$bio

public string|null $bio

Optional. Bio of the other party in a private chat

$birthdate

public Birthdate|null $birthdate

Optional. For private chats, the date of birth of the user

$business_intro

public BusinessIntro|null $business_intro

Optional. For private chats with business accounts, the intro of the business

$business_location

public BusinessLocation|null $business_location

Optional. For private chats with business accounts, the location of the business

$business_opening_hours

public BusinessOpeningHours|null $business_opening_hours

Optional. For private chats with business accounts, the opening hours of the business

$can_send_paid_media

public bool|null $can_send_paid_media

Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.

$can_set_sticker_set

public bool|null $can_set_sticker_set

Optional. True, if the bot can change the group sticker set

$custom_emoji_sticker_set_name

public string|null $custom_emoji_sticker_set_name

Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.

$description

public string|null $description

Optional. Description, for groups, supergroups and channel chats

$emoji_status_custom_emoji_id

public string|null $emoji_status_custom_emoji_id

Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat

$emoji_status_expiration_date

public CarbonImmutable|null $emoji_status_expiration_date

Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any

$first_name

public string|null $first_name

Optional. First name of the other party in a private chat

$first_profile_audio

public Audio|null $first_profile_audio

Optional. For private chats, the first audio added to the profile of the user

$guard_bot

public User|null $guard_bot

Optional. The bot that processes join request queries in the chat. The field is only available to chat administrators.

$has_aggressive_anti_spam_enabled

public bool|null $has_aggressive_anti_spam_enabled

Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.

$has_hidden_members

public bool|null $has_hidden_members

Optional. True, if non-administrators can only get the list of bots and administrators in the chat

$has_private_forwards

public bool|null $has_private_forwards

Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user

$has_protected_content

public bool|null $has_protected_content

Optional. True, if messages from the chat can't be forwarded to other chats

$has_restricted_voice_and_video_messages

public bool|null $has_restricted_voice_and_video_messages

Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat

$has_visible_history

public bool|null $has_visible_history

Optional. True, if new chat members will have access to old messages; available only to chat administrators

$id

public int $id

Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

public string|null $invite_link

Optional. Primary invite link, for groups, supergroups and channel chats

$is_direct_messages

public bool|null $is_direct_messages

Optional. True, if the chat is the direct messages chat of a channel

$is_forum

public bool|null $is_forum

Optional. True, if the supergroup chat is a forum (has topics enabled)

$join_by_request

public bool|null $join_by_request

Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators

$join_to_send_messages

public bool|null $join_to_send_messages

Optional. True, if users need to join the supergroup before they can send messages

$last_name

public string|null $last_name

Optional. Last name of the other party in a private chat

$linked_chat_id

public int|null $linked_chat_id

Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

$location

public ChatLocation|null $location

Optional. For supergroups, the location to which the supergroup is connected

$max_reaction_count

public int $max_reaction_count

The maximum number of reactions that can be set on a message in the chat

$message_auto_delete_time

public int|null $message_auto_delete_time

Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds

$paid_message_star_count

public int|null $paid_message_star_count

Optional. The number of Telegram Stars a general user has to pay to send a message to the chat

$parent_chat

public Chat|null $parent_chat

Optional. Information about the corresponding channel chat; for direct messages chats only

$personal_chat

public Chat|null $personal_chat

Optional. For private chats, the personal channel of the user

$pinned_message

public Message|null $pinned_message

Optional. The most recent pinned message (by sending date)

$profile_accent_color_id

public int|null $profile_accent_color_id

Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.

$profile_background_custom_emoji_id

public string|null $profile_background_custom_emoji_id

Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background

$slow_mode_delay

public int|null $slow_mode_delay

Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds

$sticker_set_name

public string|null $sticker_set_name

Optional. For supergroups, name of the group sticker set

$title

public string|null $title

Optional. Title, for supergroups, channels and group chats

$type

public string $type

Type of the chat, can be either "private", "group", "supergroup" or "channel"

$unique_gift_colors

public UniqueGiftColors|null $unique_gift_colors

Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews

$unrestrict_boost_count

public int|null $unrestrict_boost_count

Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions

$username

public string|null $username

Optional. Username, for private chats, supergroups and channels if available

$casts

Attribute name => Telegram type token ("User", "Array of PhotoSize"), used to hydrate nested objects into parts.

protected array<string, string> $casts = ['photo' => 'ChatPhoto', 'active_usernames' => 'Array of String', 'birthdate' => 'Birthdate', 'business_intro' => 'BusinessIntro', 'business_location' => 'BusinessLocation', 'business_opening_hours' => 'BusinessOpeningHours', 'personal_chat' => 'Chat', 'parent_chat' => 'Chat', 'available_reactions' => 'Array of ReactionType', 'pinned_message' => 'Message', 'permissions' => 'ChatPermissions', 'accepted_gift_types' => 'AcceptedGiftTypes', 'location' => 'ChatLocation', 'rating' => 'UserRating', 'first_profile_audio' => 'Audio', 'unique_gift_colors' => 'UniqueGiftColors', 'guard_bot' => 'User', 'community' => 'Community']

$dates

Attribute names holding Unix timestamps, read back as {@see CarbonImmutable}.

protected array<int, string> $dates = ['emoji_status_expiration_date']

$fillable

Attribute names this part accepts. Empty = accept anything.

protected array<int, string> $fillable = ['id', 'type', 'title', 'username', 'first_name', 'last_name', 'is_forum', 'is_direct_messages', 'accent_color_id', 'max_reaction_count', 'photo', 'active_usernames', 'birthdate', 'business_intro', 'business_location', 'business_opening_hours', 'personal_chat', 'parent_chat', 'available_reactions', 'background_custom_emoji_id', 'profile_accent_color_id', 'profile_background_custom_emoji_id', 'emoji_status_custom_emoji_id', 'emoji_status_expiration_date', 'bio', 'has_private_forwards', 'has_restricted_voice_and_video_messages', 'join_to_send_messages', 'join_by_request', 'description', 'invite_link', 'pinned_message', 'permissions', 'accepted_gift_types', 'can_send_paid_media', 'slow_mode_delay', 'unrestrict_boost_count', 'message_auto_delete_time', 'has_aggressive_anti_spam_enabled', 'has_hidden_members', 'has_protected_content', 'has_visible_history', 'sticker_set_name', 'can_set_sticker_set', 'custom_emoji_sticker_set_name', 'linked_chat_id', 'location', 'rating', 'first_profile_audio', 'unique_gift_colors', 'paid_message_star_count', 'guard_bot', 'community']

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
string

attributeExists()

public attributeExists(string $key) : bool
Parameters
$key : string
Return values
bool

fill()

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>

jsonSerialize()

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
bool

offsetGet()

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
throws
PartException

When the part is not a union, or nothing matches.

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
Factory

getRawAttribute()

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
On this page

Search results