Class Gift

constructor

• new Gift(client: TelegramClient | BaseClient, data: Gift): Gift

  Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this

  • data: Gift

    Data about the gift that can be sent by the bot.

  Returns Gift

id

OptionalpublisherChat

OptionalremainingCount

startCount

sticker

OptionaltotalCount

OptionalupgradeStarCount

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.