Class Gift

Hierarchy (View Summary)

Constructors

constructor

Properties

id publisherChat? remainingCount? startCount sticker totalCount? upgradeStarCount?

Accessors

client

Methods

_clone _patch _update equals send toJSON valueOf

Constructors

constructor

Properties

id

id: string

Unique identifier of the gift

OptionalpublisherChat

publisherChat?: Chat

Information about the chat that published the gift

OptionalremainingCount

remainingCount?: number

The number of remaining gifts of this type that can be sent; for limited gifts only

startCount

startCount: number

The number of Telegram Stars that must be paid to send the sticker

sticker

sticker: Sticker

The sticker that represents the gift

OptionaltotalCount

totalCount?: number

The total number of the gifts of this type that can be sent; for limited gifts only

OptionalupgradeStarCount

upgradeStarCount?: number

The number of Telegram Stars that must be paid to upgrade the gift to a unique one

Accessors

client

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

equals

  • equals(other: Gift): boolean

  • Checks if this gift is equal to another gift.

    Parameters

    • other: Gift

      The other object to compare with.

    Returns boolean

    True if both objects are instances of Gift and are equal based on key properties, otherwise false.

send

  • send(
        userId: string | number,
        options?: Omit<
            {
                chatId?: string
                | number;
                giftId: string;
                payForUpgrade?: boolean;
                text?: string;
                textEntities?: MessageEntity[];
                textParseMode?: ParseMode;
                userId?: string | number;
            },
            "giftId"
            | "userId",
        >,
    ): Promise<true>

  • Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user.

    Parameters

    • userId: string | number

      Unique identifier of the target user that will receive the gift.

    • Optionaloptions: Omit<
          {
              chatId?: string
              | number;
              giftId: string;
              payForUpgrade?: boolean;
              text?: string;
              textEntities?: MessageEntity[];
              textParseMode?: ParseMode;
              userId?: string | number;
          },
          "giftId"
          | "userId",
      >

      out parameters.

    Returns Promise<true>

    Returns True on success.

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