Class OwnedGiftRegular

Hierarchy (View Summary)

  • Base
    • OwnedGiftRegular

Constructors

constructor

Properties

beUpgraded? content? convertStarCount? entities? gift isPrivate? isSaved? ownedGiftId? prepaidUpgradeStarCount? senderUnixTime senderUser type wasRefunded?

Accessors

client senderAt senderTimestamp

Methods

_clone _patch _update toJSON valueOf

Constructors

constructor

Properties

OptionalbeUpgraded

beUpgraded?: true

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

Optionalcontent

content?: string

Text of the message that was added to the gift

OptionalconvertStarCount

convertStarCount?: number

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

Optionalentities

entities?: MessageEntities

Special entities that appear in the text

gift

gift: Gift

Information about the regular gift

OptionalisPrivate

isPrivate?: true

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

OptionalisSaved

isSaved?: true

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

OptionalownedGiftId

ownedGiftId?: string

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

OptionalprepaidUpgradeStarCount

prepaidUpgradeStarCount?: number

Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift

senderUnixTime

senderUnixTime: number

Date the gift was sent in Unix time

senderUser

senderUser: User

Sender of the gift if it is a known user

type

type: "regular"

Type of the gift, always “regular”

OptionalwasRefunded

wasRefunded?: true

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

Accessors

client

senderAt

  • get senderAt(): Date

  • Date the message was sent. It is always a positive number, representing a valid date

    Returns Date

senderTimestamp

  • get senderTimestamp(): number

  • Return the timestamp message was sent, in milliseconds

    Returns number

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data: Record<string, any>): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data: Record<string, any>): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

toJSON

  • toJSON(
        propsRecursive?: boolean,
        ...props: Record<string, string | boolean>[],
    ): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • ...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods