Class SharedUser

constructor

• new SharedUser(client, data): SharedUser

• Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this
  • data: SharedUser

    Data about the contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button

  Returns SharedUser

OptionalfirstName

OptionallastName

Optionalphoto

userId

Optionalusername

_patch

• _patch(data): SharedUser

• Parameters

  • data: SharedUser

    Data about the contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button

  Returns SharedUser

equals

• equals(other): boolean

• Checks if this user is equal to another user.

  Parameters

  • other: SharedUser

    The other object to compare with.

  Returns boolean

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

fetch

• fetch(options?): Promise<User>

• Fetches this user

  Parameters

  • Optionaloptions: Omit<IFetchOptions, "cache" | "fullInfo"> & {
        fullInfo?: false;
    }

    options for fetch user

  Returns Promise<User>
• fetch(options?): Promise<ChatFullInfo>

• Fetches this user

  Parameters

  • Optionaloptions: Omit<IFetchOptions, "cache" | "fullInfo"> & {
        fullInfo: true;
    }

    options for fetch user

  Returns Promise<ChatFullInfo>
• fetch(options?): Promise<ChatFullInfo | User>

• Fetches this user

  Parameters

  • Optionaloptions: Omit<IFetchOptions, "cache">

    options for fetch user

  Returns Promise<ChatFullInfo | User>

fetchChatBoosts

• fetchChatBoosts(chatId): Promise<UserChatBoosts>

• Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat.

  Parameters

  • chatId: string | number

    Unique identifier for the chat or username of the channel (in the format @channelusername).

  Returns Promise<UserChatBoosts>

  Returns a UserChatBoosts object.

fetchProfilePhotos

• fetchProfilePhotos(offset?, limit?): Promise<UserProfilePhotos>

• Use this method to get a list of profile pictures for a user.

  Parameters

  • Optionaloffset: number

    Sequential number of the first photo to be returned. By default, all photos are returned
  • Optionallimit: number

    Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100

  Returns Promise<UserProfilePhotos>

  Returns a UserProfilePhotos object.

refundStarPayment

• refundStarPayment(telegramPaymentId): Promise<true>

• Refunds a successful payment in Telegram Stars.

  Parameters

  • telegramPaymentId: string

    Telegram payment identifier

  Returns Promise<true>

  Returns True on success.

saveInlineMessage

• saveInlineMessage(result, options?): Promise<PreparedInlineMessage>

• Stores a message that can be sent by a user of a Mini App.

  Parameters

  • result: InlineQueryResult

    An object describing the message to be sent.
  • Optionaloptions: Omit<{
        allowBotChats?: boolean;
        allowChannelChats?: boolean;
        allowGroupChats?: boolean;
        allowUserChats?: boolean;
        result: InlineQueryResult;
        userId: string | number;
    }, "userId" | "result">

    out parameters.

  Returns Promise<PreparedInlineMessage>

  Returns a PreparedInlineMessage object.

send

• send(text, options?): Promise<Message & {
      content: string;
  }>

• Use this method to send text messages.

  Parameters

  • text: string

    Text of the message to be sent, 1-4096 characters after entities parsing and media group options
  • Optionaloptions: Omit<{
        businessConnectionId?: string;
        chatId: string | number;
        disableNotification?: boolean;
        entities?: MessageEntity[];
        linkPreviewOptions?: LinkPreviewOptions;
        messageEffectId?: string;
        messageThreadId?: string | number;
        parseMode?: ParseMode;
        protectContent?: boolean;
        replyMarkup?:
            | InlineKeyboardMarkup
            | ForceReply
            | ReplyKeyboardMarkup
            | ReplyKeyboardRemove;
        replyParameters?: ReplyParameters;
        text: string;
    }, "text" | "chatId">

    out parameters

  Returns Promise<Message & {
      content: string;
  }>

  On success, the sent Message is returned.
• send(text): Promise<(
      | Message & {
          audio: Audio;
      }
      | Message & {
          document: Document;
      }
      | Message & {
          photo: Photo;
      }
      | Message & {
          video: Video;
      })[]>

• Parameters

  • text: Omit<{
        businessConnectionId?: string;
        chatId: string | number;
        disableNotification?: boolean;
        media: readonly (
            | InputMediaAudio
            | InputMediaDocument
            | InputMediaPhoto
            | InputMediaVideo)[];
        messageEffectId?: string;
        messageThreadId?: string | number;
        protectContent?: boolean;
        replyParameters?: ReplyParameters;
    }, "chatId">

  Returns Promise<(
      | Message & {
          audio: Audio;
      }
      | Message & {
          document: Document;
      }
      | Message & {
          photo: Photo;
      }
      | Message & {
          video: Video;
      })[]>

• send(text, options?): Promise<Message & {
      content: string;
  } | (
      | Message & {
          audio: Audio;
      }
      | Message & {
          document: Document;
      }
      | Message & {
          photo: Photo;
      }
      | Message & {
          video: Video;
      })[]>

• Parameters

  • text: string | Omit<{
        businessConnectionId?: string;
        chatId: string | number;
        disableNotification?: boolean;
        media: readonly (
            | InputMediaAudio
            | InputMediaDocument
            | InputMediaPhoto
            | InputMediaVideo)[];
        messageEffectId?: string;
        messageThreadId?: string | number;
        protectContent?: boolean;
        replyParameters?: ReplyParameters;
    }, "chatId">
  • Optionaloptions: Omit<{
        businessConnectionId?: string;
        chatId: string | number;
        disableNotification?: boolean;
        entities?: MessageEntity[];
        linkPreviewOptions?: LinkPreviewOptions;
        messageEffectId?: string;
        messageThreadId?: string | number;
        parseMode?: ParseMode;
        protectContent?: boolean;
        replyMarkup?:
            | InlineKeyboardMarkup
            | ForceReply
            | ReplyKeyboardMarkup
            | ReplyKeyboardRemove;
        replyParameters?: ReplyParameters;
        text: string;
    }, "text" | "chatId">

  Returns Promise<Message & {
      content: string;
  } | (
      | Message & {
          audio: Audio;
      }
      | Message & {
          document: Document;
      }
      | Message & {
          photo: Photo;
      }
      | Message & {
          video: Video;
      })[]>

sendGift

• sendGift(giftId, options?): Promise<true>

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

  Parameters

  • giftId: string

    Identifier of the gift.
  • Optionaloptions: Omit<{
        giftId: string;
        text?: string;
        textEntities?: MessageEntity[];
        textParseMode?: ParseMode;
        userId: string | number;
    }, "giftId" | "userId">

    out parameters.

  Returns Promise<true>

  Returns True on success.

setPassportErrors

• setPassportErrors(errors): Promise<true>

• Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change).

  Parameters

  • errors: readonly PassportElementError[]

    An array describing the errors

  Returns Promise<true>

  Returns True on success.

setStarSubscription

• setStarSubscription(telegramPaymentChargeId, isCanceled): Promise<true>

• Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars.

  Parameters

  • telegramPaymentChargeId: string

    Telegram payment identifier for the subscription.
  • isCanceled: boolean

    Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.

  Returns Promise<true>

  Returns True on success.