TelegramPHP Documentation

User extends Part

in package

• Application

uses UserBehaviour

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

Tags

link

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

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

$added_to_attachment_menu  : bool|null

$allows_users_to_create_topics  : bool|null

$can_connect_to_business  : bool|null

$can_join_groups  : bool|null

$can_manage_bots  : bool|null

$can_read_all_group_messages  : bool|null

$first_name  : string

$has_main_web_app  : bool|null

$has_topics_enabled  : bool|null

$id  : int

$is_bot  : bool

$is_premium  : bool|null

$language_code  : string|null

$last_name  : string|null

$supports_guest_queries  : bool|null

$supports_inline_queries  : bool|null

$supports_join_request_queries  : bool|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>

getFullName()  : string

First and last name, joined - the name Telegram shows.

getHandle()  : string

`@username` when they have one, their display name otherwise.

getProfilePhotos()  : PromiseInterface<string|int, UserProfilePhotos>

This user's profile photos.

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.

mention()  : string

A Markdown or HTML mention that links to this user, which works even when they have no username.

offsetExists()  : bool

offsetGet()  : mixed

offsetSet()  : void

offsetUnset()  : void

resolveSubtype()  : Part>

The concrete class an incoming payload belongs to, for a union parent.

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

Messages this user directly.

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()}.