typescript-telegram-bot-api/dist/types/LoginUrl.d.ts

Telegram Bot API wrapper for Node.js written in TypeScript

/**
 * ## LoginUrl
 * This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a
 * great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is
 * tap/click a button and confirm that they want to log in:
 * Telegram apps support these buttons as of version 5.7.
 * > Sample bot: @discussbot
 * @see https://core.telegram.org/bots/api#loginurl
 */
export type LoginUrl = {
    /**
     * An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed.
     * If the user refuses to provide authorization data, the original URL without information about the user will be
     * opened. The data added is the same as described in Receiving authorization data.
     *
     * NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the
     * data as described in Checking authorization.
     */
    url: string;
    /**
     * Optional. New text of the button in forwarded messages.
     */
    forward_text?: string;
    /**
     * Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details.
     * If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain
     * linked with the bot. See Linking your domain to the bot for more details.
     */
    bot_username?: string;
    /**
     * Optional. Pass True to request the permission for your bot to send messages to the user.
     */
    request_write_access?: boolean;
};