TelegramPHP Documentation

ChatMemberRestricted extends ChatMember
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.

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

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

v10.3

Table of Contents

Constants

DISCRIMINATOR  : mixed = null
The attribute whose value names the concrete subtype.
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

$can_add_web_page_previews  : bool
$can_change_info  : bool
$can_edit_tag  : bool
$can_invite_users  : bool
$can_manage_topics  : bool
$can_pin_messages  : bool
$can_react_to_messages  : bool
$can_send_audios  : bool
$can_send_documents  : bool
$can_send_messages  : bool
$can_send_other_messages  : bool
$can_send_photos  : bool
$can_send_polls  : bool
$can_send_video_notes  : bool
$can_send_videos  : bool
$can_send_voice_notes  : bool
$is_member  : bool
$status  : string
$tag  : string|null
$until_date  : CarbonImmutable
$user  : User
$casts  : array<string, string>
$dates  : array<int, string>
$fillable  : array<int, string>
$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.

public mixed DISCRIMINATOR = null

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

$can_add_web_page_previews

public bool $can_add_web_page_previews

True, if the user is allowed to add web page previews to their messages

$can_change_info

public bool $can_change_info

True, if the user is allowed to change the chat title, photo and other settings

$can_edit_tag

public bool $can_edit_tag

True, if the user is allowed to edit their own tag

$can_invite_users

public bool $can_invite_users

True, if the user is allowed to invite new users to the chat

$can_manage_topics

public bool $can_manage_topics

True, if the user is allowed to create forum topics

$can_pin_messages

public bool $can_pin_messages

True, if the user is allowed to pin messages

$can_react_to_messages

public bool $can_react_to_messages

True, if the user is allowed to react to messages

$can_send_audios

public bool $can_send_audios

True, if the user is allowed to send audios

$can_send_documents

public bool $can_send_documents

True, if the user is allowed to send documents

$can_send_messages

public bool $can_send_messages

True, if the user is allowed to send text messages, rich messages, contacts, giveaways, giveaway winners, invoices, locations and venues

$can_send_other_messages

public bool $can_send_other_messages

True, if the user is allowed to send animations, games, stickers and use inline bots

$can_send_photos

public bool $can_send_photos

True, if the user is allowed to send photos

$can_send_polls

public bool $can_send_polls

True, if the user is allowed to send polls and checklists

$can_send_video_notes

public bool $can_send_video_notes

True, if the user is allowed to send video notes

$can_send_videos

public bool $can_send_videos

True, if the user is allowed to send videos

$can_send_voice_notes

public bool $can_send_voice_notes

True, if the user is allowed to send voice notes

$is_member

public bool $is_member

True, if the user is a member of the chat at the moment of the request

$until_date

public CarbonImmutable $until_date

Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever.

$fillable

protected array<int, string> $fillable = ['status', 'tag', 'user', 'is_member', 'can_send_messages', 'can_send_audios', 'can_send_documents', 'can_send_photos', 'can_send_videos', 'can_send_video_notes', 'can_send_voice_notes', 'can_send_polls', 'can_send_other_messages', 'can_add_web_page_previews', 'can_react_to_messages', 'can_edit_tag', 'can_change_info', 'can_invite_users', 'can_pin_messages', 'can_manage_topics', 'until_date']

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