TelegramPHP Documentation

BusinessBotRights extends Part
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 the rights of a business bot.

Tags
link
https://core.telegram.org/bots/api#businessbotrights
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

$can_change_gift_settings  : bool|null
$can_convert_gifts_to_stars  : bool|null
$can_delete_all_messages  : bool|null
$can_delete_sent_messages  : bool|null
$can_edit_bio  : bool|null
$can_edit_name  : bool|null
$can_edit_profile_photo  : bool|null
$can_edit_username  : bool|null
$can_manage_stories  : bool|null
$can_read_messages  : bool|null
$can_reply  : bool|null
$can_transfer_and_upgrade_gifts  : bool|null
$can_transfer_stars  : bool|null
$can_view_gifts_and_stars  : bool|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

$can_change_gift_settings

public bool|null $can_change_gift_settings

Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account

$can_convert_gifts_to_stars

public bool|null $can_convert_gifts_to_stars

Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars

$can_delete_all_messages

public bool|null $can_delete_all_messages

Optional. True, if the bot can delete all private messages in managed chats

$can_delete_sent_messages

public bool|null $can_delete_sent_messages

Optional. True, if the bot can delete messages sent by the bot

$can_edit_bio

public bool|null $can_edit_bio

Optional. True, if the bot can edit the bio of the business account

$can_edit_name

public bool|null $can_edit_name

Optional. True, if the bot can edit the first and last name of the business account

$can_edit_profile_photo

public bool|null $can_edit_profile_photo

Optional. True, if the bot can edit the profile photo of the business account

$can_edit_username

public bool|null $can_edit_username

Optional. True, if the bot can edit the username of the business account

$can_manage_stories

public bool|null $can_manage_stories

Optional. True, if the bot can post, edit and delete stories on behalf of the business account

$can_read_messages

public bool|null $can_read_messages

Optional. True, if the bot can mark incoming private messages as read

$can_reply

public bool|null $can_reply

Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours

$can_transfer_and_upgrade_gifts

public bool|null $can_transfer_and_upgrade_gifts

Optional. True, if the bot can transfer and upgrade gifts owned by the business account

$can_transfer_stars

public bool|null $can_transfer_stars

Optional. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts

$can_view_gifts_and_stars

public bool|null $can_view_gifts_and_stars

Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account

$casts

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

protected array<string, string> $casts = []

$dates

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

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

$fillable

Attribute names this part accepts. Empty = accept anything.

protected array<int, string> $fillable = ['can_reply', 'can_read_messages', 'can_delete_sent_messages', 'can_delete_all_messages', 'can_edit_name', 'can_edit_bio', 'can_edit_profile_photo', 'can_edit_username', 'can_change_gift_settings', 'can_view_gifts_and_stars', 'can_convert_gifts_to_stars', 'can_transfer_and_upgrade_gifts', 'can_transfer_stars', 'can_manage_stories']

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