Portex SDK Documentation
    Preparing search index...

    Interface WebApp

    interface WebApp {
        initData: string;
        initDataUnsafe: WebAppInitData;
        version: string;
        platform: string;
        colorScheme: "light" | "dark";
        themeParams: ThemeParams;
        isExpanded: boolean;
        viewportHeight: number;
        viewportStableHeight: number;
        headerColor: string;
        backgroundColor: string;
        isClosingConfirmationEnabled: boolean;
        MainButton: MainButton;
        BackButton: BackButton;
        HapticFeedback: HapticFeedback;
        CloudStorage: CloudStorage;
        ready(): void;
        expand(): void;
        close(): void;
        onEvent(eventType: string, eventHandler: Function): void;
        offEvent(eventType: string, eventHandler: Function): void;
        sendData(data: any): void;
        enableClosingConfirmation(): void;
        disableClosingConfirmation(): void;
        setHeaderColor(color: string): void;
        setBackgroundColor(color: string): void;
        switchInlineQuery(query: string, choose_chat_types?: string[]): void;
        openLink(url: string, options?: { try_instant_view?: boolean }): void;
        openTelegramLink(url: string): void;
        openInvoice(url: string, callback?: Function): void;
        showPopup(
            params: {
                title?: string;
                message: string;
                buttons?: {
                    id?: string;
                    type?: "ok" | "default" | "close" | "cancel" | "destructive";
                    text?: string;
                }[];
            },
            callback?: Function,
        ): void;
        showAlert(message: string, callback?: Function): void;
        showConfirm(message: string, callback?: Function): void;
        requestWriteAccess(callback?: Function): void;
        requestContact(callback?: Function): void;
        showScanQrPopup(params: { text?: string }, callback?: Function): void;
        closeScanQrPopup(): void;
        readTextFromClipboard(callback?: Function): void;
    }
    Index

    Properties

    initData initDataUnsafe version platform colorScheme themeParams isExpanded viewportHeight viewportStableHeight headerColor backgroundColor isClosingConfirmationEnabled MainButton BackButton HapticFeedback CloudStorage

    Methods

    ready expand close onEvent offEvent sendData enableClosingConfirmation disableClosingConfirmation setHeaderColor setBackgroundColor switchInlineQuery openLink openTelegramLink openInvoice showPopup showAlert showConfirm requestWriteAccess requestContact showScanQrPopup closeScanQrPopup readTextFromClipboard

    Properties

    initData: string
    initDataUnsafe: WebAppInitData
    version: string
    platform: string
    colorScheme: "light" | "dark"
    themeParams: ThemeParams
    isExpanded: boolean
    viewportHeight: number
    viewportStableHeight: number
    headerColor: string
    backgroundColor: string
    isClosingConfirmationEnabled: boolean
    MainButton: MainButton
    BackButton: BackButton
    HapticFeedback: HapticFeedback
    CloudStorage: CloudStorage

    Methods

    • Parameters

      • eventType: string
      • eventHandler: Function

      Returns void

    • Parameters

      • eventType: string
      • eventHandler: Function

      Returns void

    • Parameters

      • query: string
      • Optionalchoose_chat_types: string[]

      Returns void

    • Parameters

      • url: string
      • Optionaloptions: { try_instant_view?: boolean }

      Returns void

    • Parameters

      • url: string
      • Optionalcallback: Function

      Returns void

    • Parameters

      • params: {
            title?: string;
            message: string;
            buttons?: {
                id?: string;
                type?: "ok" | "default" | "close" | "cancel" | "destructive";
                text?: string;
            }[];
        }
      • Optionalcallback: Function

      Returns void

    • Parameters

      • message: string
      • Optionalcallback: Function

      Returns void

    • Parameters

      • message: string
      • Optionalcallback: Function

      Returns void

    • Parameters

      • Optionalcallback: Function

      Returns void

    • Parameters

      • Optionalcallback: Function

      Returns void

    • Parameters

      • params: { text?: string }
      • Optionalcallback: Function

      Returns void

    • Parameters

      • Optionalcallback: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods