Documentation - v0.27.1
    Preparing search index...

    Type Alias InputWebview

    InputWebview:
        | { compact?: boolean; startParam?: string; type: "main" }
        | { type: "from_reply_keyboard" | "from_switch_inline"; url: string }
        | { type: "from_side_menu" }
        | {
            compact?: boolean;
            fireAndForget?: boolean;
            replyTo?: number | tl.TypeInputReplyTo;
            sendAs?: InputPeerLike;
            silent?: boolean;
            type: "from_inline_keyboard" | "from_bot_menu";
            url: string;
        }
        | {
            compact?: boolean;
            fireAndForget?: boolean;
            replyTo?: number
            | tl.TypeInputReplyTo;
            sendAs?: InputPeerLike;
            silent?: boolean;
            type: "from_attach_menu";
        }
        | {
            allowWrite?: boolean;
            compact?: boolean;
            fireAndForget?: boolean;
            shortName: string;
            startParam?: string;
            type: "from_link";
        }

    Information about the mini app for openWebview method

    Type Declaration

    • { compact?: boolean; startParam?: string; type: "main" }
      • Optionalcompact?: boolean

        If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the Main Mini App link is equal to compact.

      • OptionalstartParam?: string

        Start parameter from the deep link for the mini app

      • type: "main"
    • { type: "from_reply_keyboard" | "from_switch_inline"; url: string }
      • type: "from_reply_keyboard" | "from_switch_inline"
      • url: string

        URL of the mini app found in the button

    • { type: "from_side_menu" }
    • {
          compact?: boolean;
          fireAndForget?: boolean;
          replyTo?: number | tl.TypeInputReplyTo;
          sendAs?: InputPeerLike;
          silent?: boolean;
          type: "from_inline_keyboard" | "from_bot_menu";
          url: string;
      }
      • Optionalcompact?: boolean

        If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the Main Mini App link is equal to compact.

      • OptionalfireAndForget?: boolean

        Telegram asks us to keep sending messages.prolongWebView requests every minute until the webview is closed. If this parameter is set to true, the timer will not be started, and the webview will never be prolonged.

      • OptionalreplyTo?: number | tl.TypeInputReplyTo

        ID of the message to which we should reply if the mini app asks to do so

      • OptionalsendAs?: InputPeerLike

        Peer to use when sending the message.

      • Optionalsilent?: boolean

        If the mini app asks to send a message, whether to send it silently

      • type: "from_inline_keyboard" | "from_bot_menu"
      • url: string

        URL of the mini app found in the button

    • {
          compact?: boolean;
          fireAndForget?: boolean;
          replyTo?: number | tl.TypeInputReplyTo;
          sendAs?: InputPeerLike;
          silent?: boolean;
          type: "from_attach_menu";
      }
      • Optionalcompact?: boolean

        If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the Main Mini App link is equal to compact.

      • OptionalfireAndForget?: boolean

        Telegram asks us to keep sending messages.prolongWebView requests every minute until the webview is closed. If this parameter is set to true, the timer will not be started, and the webview will never be prolonged.

      • OptionalreplyTo?: number | tl.TypeInputReplyTo

        ID of the message to which we should reply if the mini app asks to do so

      • OptionalsendAs?: InputPeerLike

        Peer to use when sending the message.

      • Optionalsilent?: boolean

        If the mini app asks to send a message, whether to send it silently

      • type: "from_attach_menu"
    • {
          allowWrite?: boolean;
          compact?: boolean;
          fireAndForget?: boolean;
          shortName: string;
          startParam?: string;
          type: "from_link";
      }
      • OptionalallowWrite?: boolean

        If the bot is asking permission to send messages to the user, whether to allow it to do so

      • Optionalcompact?: boolean

        If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the Main Mini App link is equal to compact.

      • OptionalfireAndForget?: boolean

        Telegram asks us to keep sending messages.prolongWebView requests every minute until the webview is closed. If this parameter is set to true, the timer will not be started, and the webview will never be prolonged.

      • shortName: string

        Short name of the app (from the link)

      • OptionalstartParam?: string

        Start parameter from the deep link for the mini app

      • type: "from_link"