TelegramPHP Documentation

OwnedGiftRegular extends OwnedGift
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.

Describes a regular gift owned by a user or a chat.

Tags
link
https://core.telegram.org/bots/api#ownedgiftregular
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_be_upgraded  : bool|null
$convert_star_count  : int|null
$entities  : Collection<string|int, MessageEntity>|null
$gift  : Gift
$is_private  : bool|null
$is_saved  : bool|null
$is_upgrade_separate  : bool|null
$owned_gift_id  : string|null
$prepaid_upgrade_star_count  : int|null
$send_date  : CarbonImmutable
$sender_user  : User|null
$text  : string|null
$type  : string
$unique_gift_number  : int|null
$was_refunded  : bool|null
$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_be_upgraded

public bool|null $can_be_upgraded

Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only

$convert_star_count

public int|null $convert_star_count

Optional. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only

$is_private

public bool|null $is_private

Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

$is_saved

public bool|null $is_saved

Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only

$is_upgrade_separate

public bool|null $is_upgrade_separate

Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only

$owned_gift_id

public string|null $owned_gift_id

Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only

$prepaid_upgrade_star_count

public int|null $prepaid_upgrade_star_count

Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift

$send_date

public CarbonImmutable $send_date

Date the gift was sent in Unix time

$sender_user

public User|null $sender_user

Optional. Sender of the gift if it is a known user

$text

public string|null $text

Optional. Text of the message that was added to the gift

$unique_gift_number

public int|null $unique_gift_number

Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

$was_refunded

public bool|null $was_refunded

Optional. True, if the gift was refunded and isn't available anymore

$casts

protected array<string, string> $casts = ['gift' => 'Gift', 'sender_user' => 'User', 'entities' => 'Array of MessageEntity']

$fillable

protected array<int, string> $fillable = ['type', 'gift', 'owned_gift_id', 'sender_user', 'send_date', 'text', 'entities', 'is_private', 'is_saved', 'can_be_upgraded', 'was_refunded', 'convert_star_count', 'prepaid_upgrade_star_count', 'is_upgrade_separate', 'unique_gift_number']

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