Struct TelegramWebApp 

pub struct TelegramWebApp { /* private fields */ }

Safe wrapper around window.Telegram.WebApp

Implementations

impl TelegramWebApp

pub fn instance() -> Option<Self>

Get instance of Telegram.WebApp or None if not present

pub fn try_instance() -> Result<Self, JsValue>

Try to get instance of Telegram.WebApp.

Errors

Returns JsValue if the Telegram.WebApp object is missing or malformed.

pub fn validate_init_data( init_data: &str, key: ValidationKey<'_>, ) -> Result<(), ValidationError>

Validate an initData payload using either HMAC-SHA256 or Ed25519.

Pass ValidationKey::BotToken to verify the hash parameter using the bot token. Use ValidationKey::Ed25519PublicKey to verify the signature parameter with an Ed25519 public key.

Errors

Returns validate_init_data::ValidationError if validation fails.

Examples

use telegram_webapp_sdk::{TelegramWebApp, validate_init_data::ValidationKey};
let bot_token = "123456:ABC";
let query = "a=1&b=2&hash=9e5e8d7c0b1f9f3a";
TelegramWebApp::validate_init_data(query, ValidationKey::BotToken(bot_token)).unwrap();

pub fn send_data(&self, data: &str) -> Result<(), JsValue>

Call WebApp.sendData(data).

Errors

Returns JsValue if the underlying JS call fails.

pub fn expand(&self) -> Result<(), JsValue>

Call WebApp.expand().

Errors

Returns JsValue if the underlying JS call fails.

pub fn close(&self) -> Result<(), JsValue>

Call WebApp.close().

Errors

Returns JsValue if the underlying JS call fails.

pub fn enable_closing_confirmation(&self) -> Result<(), JsValue>

Call WebApp.enableClosingConfirmation().

Examples

app.enable_closing_confirmation().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn disable_closing_confirmation(&self) -> Result<(), JsValue>

Call WebApp.disableClosingConfirmation().

Examples

app.disable_closing_confirmation().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn is_closing_confirmation_enabled(&self) -> bool

Returns whether closing confirmation is currently enabled.

Examples

let _ = app.is_closing_confirmation_enabled();

pub fn request_fullscreen(&self) -> Result<(), JsValue>

Call WebApp.requestFullscreen().

Examples

app.request_fullscreen().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn exit_fullscreen(&self) -> Result<(), JsValue>

Call WebApp.exitFullscreen().

Examples

app.exit_fullscreen().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn lock_orientation(&self, orientation: &str) -> Result<(), JsValue>

Call WebApp.lockOrientation(orientation).

Examples

app.lock_orientation("portrait").unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn unlock_orientation(&self) -> Result<(), JsValue>

Call WebApp.unlockOrientation().

Examples

app.unlock_orientation().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn enable_vertical_swipes(&self) -> Result<(), JsValue>

Call WebApp.enableVerticalSwipes().

Examples

app.enable_vertical_swipes().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn disable_vertical_swipes(&self) -> Result<(), JsValue>

Call WebApp.disableVerticalSwipes().

Examples

app.disable_vertical_swipes().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn show_alert(&self, msg: &str) -> Result<(), JsValue>

Call WebApp.showAlert(message).

Errors

Returns JsValue if the underlying JS call fails.

pub fn show_confirm<F>(&self, msg: &str, on_confirm: F) -> Result<(), JsValue>

where F: 'static + Fn(bool),

Call WebApp.showConfirm(message, callback).

Errors

Returns JsValue if the underlying JS call fails.

pub fn open_link(&self, url: &str) -> Result<(), JsValue>

Call WebApp.openLink(url).

Examples

app.open_link("https://example.com").unwrap();

pub fn open_telegram_link(&self, url: &str) -> Result<(), JsValue>

Call WebApp.openTelegramLink(url).

Examples

app.open_telegram_link("https://t.me/telegram").unwrap();

pub fn open_invoice<F>(&self, url: &str, callback: F) -> Result<(), JsValue>

where F: 'static + Fn(String),

Call WebApp.openInvoice(url, callback).

Examples

app.open_invoice("https://invoice", |status| {
    let _ = status;
})
.unwrap();

pub fn switch_inline_query( &self, query: &str, choose_chat_types: Option<&JsValue>, ) -> Result<(), JsValue>

Call WebApp.switchInlineQuery(query, choose_chat_types).

Examples

app.switch_inline_query("query", None).unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn share_message<F>(&self, msg_id: &str, callback: F) -> Result<(), JsValue>

where F: 'static + Fn(bool),

Call WebApp.shareMessage(msg_id, callback).

Examples

app.share_message("id123", |sent| {
    let _ = sent;
})
.unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn share_to_story( &self, media_url: &str, params: Option<&JsValue>, ) -> Result<(), JsValue>

Call WebApp.shareToStory(media_url, params).

Examples

let params = Object::new();
app.share_to_story("https://example.com/image.png", Some(&params.into()))
    .unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn share_url(&self, url: &str, text: Option<&str>) -> Result<(), JsValue>

Call WebApp.shareURL(url, text).

Examples

app.share_url("https://example.com", Some("Check this"))
    .unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn join_voice_chat( &self, chat_id: &str, invite_hash: Option<&str>, ) -> Result<(), JsValue>

Call WebApp.joinVoiceChat(chat_id, invite_hash).

Examples

app.join_voice_chat("chat", None).unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn add_to_home_screen(&self) -> Result<bool, JsValue>

Call WebApp.addToHomeScreen() and return whether the prompt was shown.

Examples

let _shown = app.add_to_home_screen().unwrap();

pub fn check_home_screen_status<F>(&self, callback: F) -> Result<(), JsValue>

where F: 'static + Fn(String),

Call WebApp.checkHomeScreenStatus(callback).

Examples

app.check_home_screen_status(|status| {
    let _ = status;
})
.unwrap();

pub fn request_write_access<F>(&self, callback: F) -> Result<(), JsValue>

where F: 'static + Fn(bool),

Call WebApp.requestWriteAccess(callback).

Examples

app.request_write_access(|granted| {
    let _ = granted;
})
.unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn download_file<F>( &self, params: DownloadFileParams<'_>, callback: F, ) -> Result<(), JsValue>

where F: 'static + Fn(String),

Call WebApp.downloadFile(params, callback).

Examples

let params = DownloadFileParams {
    url:       "https://example.com/file",
    file_name: None,
    mime_type: None
};
app.download_file(params, |file_id| {
    let _ = file_id;
})
.unwrap();

Errors

Returns JsValue if the underlying JS call fails or the parameters fail to serialize.

pub fn request_emoji_status_access<F>(&self, callback: F) -> Result<(), JsValue>

where F: 'static + Fn(bool),

Call WebApp.requestEmojiStatusAccess(callback).

Examples

app.request_emoji_status_access(|granted| {
    let _ = granted;
})
.unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn set_emoji_status<F>( &self, status: &JsValue, callback: F, ) -> Result<(), JsValue>

where F: 'static + Fn(bool),

Call WebApp.setEmojiStatus(status, callback).

Examples

let status = Object::new();
let _ = Reflect::set(&status, &"custom_emoji_id".into(), &"123".into());
app.set_emoji_status(&status.into(), |success| {
    let _ = success;
})
.unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn show_popup<F>( &self, params: &JsValue, callback: F, ) -> Result<(), JsValue>

where F: 'static + Fn(String),

Call WebApp.showPopup(params, callback).

Examples

let params = Object::new();
app.show_popup(&params.into(), |id| {
    let _ = id;
})
.unwrap();

pub fn show_scan_qr_popup<F>( &self, text: &str, callback: F, ) -> Result<(), JsValue>

where F: 'static + Fn(String),

Call WebApp.showScanQrPopup(text, callback).

Examples

app.show_scan_qr_popup("Scan", |text| {
    let _ = text;
})
.unwrap();

pub fn close_scan_qr_popup(&self) -> Result<(), JsValue>

Call WebApp.closeScanQrPopup().

Examples

app.close_scan_qr_popup().unwrap();

pub fn hide_keyboard(&self) -> Result<(), JsValue>

Hide the on-screen keyboard. Call WebApp.hideKeyboard().

Examples

app.hide_keyboard().unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn read_text_from_clipboard<F>(&self, callback: F) -> Result<(), JsValue>

where F: 'static + Fn(String),

Call WebApp.readTextFromClipboard(callback).

Examples

app.read_text_from_clipboard(|text| {
    let _ = text;
})
.unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn show_bottom_button(&self, button: BottomButton) -> Result<(), JsValue>

Call WebApp.MainButton.show().

Errors

Returns JsValue if the underlying JS call fails.

pub fn hide_bottom_button(&self, button: BottomButton) -> Result<(), JsValue>

Hide a bottom button.

Errors

Returns JsValue if the underlying JS call fails.

pub fn ready(&self) -> Result<(), JsValue>

Call WebApp.ready().

Errors

Returns JsValue if the underlying JS call fails.

pub fn show_back_button(&self) -> Result<(), JsValue>

Show back button.

Errors

Returns JsValue if the underlying JS call fails.

pub fn hide_back_button(&self) -> Result<(), JsValue>

Hide back button.

Errors

Returns JsValue if the underlying JS call fails.

pub fn set_header_color(&self, color: &str) -> Result<(), JsValue>

Call WebApp.setHeaderColor(color).

Errors

Returns JsValue if the underlying JS call fails.

Examples

app.set_header_color("#ffffff").unwrap();

pub fn set_background_color(&self, color: &str) -> Result<(), JsValue>

Call WebApp.setBackgroundColor(color).

Errors

Returns JsValue if the underlying JS call fails.

Examples

app.set_background_color("#ffffff").unwrap();

pub fn set_bottom_bar_color(&self, color: &str) -> Result<(), JsValue>

Call WebApp.setBottomBarColor(color).

Errors

Returns JsValue if the underlying JS call fails.

Examples

app.set_bottom_bar_color("#ffffff").unwrap();

pub fn set_bottom_button_text( &self, button: BottomButton, text: &str, ) -> Result<(), JsValue>

Set main button text.

Errors

Returns JsValue if the underlying JS call fails.

pub fn set_bottom_button_color( &self, button: BottomButton, color: &str, ) -> Result<(), JsValue>

Set bottom button color (setColor(color)).

Errors

Returns JsValue if the underlying JS call fails.

Examples

let _ = app.set_bottom_button_color(BottomButton::Main, "#ff0000");

pub fn set_bottom_button_text_color( &self, button: BottomButton, color: &str, ) -> Result<(), JsValue>

Set bottom button text color (setTextColor(color)).

Errors

Returns JsValue if the underlying JS call fails.

Examples

let _ = app.set_bottom_button_text_color(BottomButton::Main, "#ffffff");

pub fn set_bottom_button_callback<F>( &self, button: BottomButton, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Set callback for onClick() on a bottom button.

Returns an EventHandle that can be used to remove the callback.

Errors

Returns JsValue if the underlying JS call fails.

pub fn remove_bottom_button_callback( &self, handle: EventHandle<dyn FnMut()>, ) -> Result<(), JsValue>

Remove previously set bottom button callback.

Errors

Returns JsValue if the underlying JS call fails.

pub fn show_main_button(&self) -> Result<(), JsValue>

Legacy alias for Self::show_bottom_button with BottomButton::Main.

pub fn show_secondary_button(&self) -> Result<(), JsValue>

Show the secondary bottom button.

pub fn hide_main_button(&self) -> Result<(), JsValue>

Legacy alias for Self::hide_bottom_button with BottomButton::Main.

pub fn hide_secondary_button(&self) -> Result<(), JsValue>

Hide the secondary bottom button.

pub fn set_main_button_text(&self, text: &str) -> Result<(), JsValue>

Legacy alias for Self::set_bottom_button_text with BottomButton::Main.

pub fn set_secondary_button_text(&self, text: &str) -> Result<(), JsValue>

Set text for the secondary bottom button.

pub fn set_main_button_color(&self, color: &str) -> Result<(), JsValue>

Legacy alias for Self::set_bottom_button_color with BottomButton::Main.

pub fn set_secondary_button_color(&self, color: &str) -> Result<(), JsValue>

Set color for the secondary bottom button.

pub fn set_main_button_text_color(&self, color: &str) -> Result<(), JsValue>

Legacy alias for Self::set_bottom_button_text_color with BottomButton::Main.

pub fn set_secondary_button_text_color( &self, color: &str, ) -> Result<(), JsValue>

Set text color for the secondary bottom button.

pub fn set_main_button_callback<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Legacy alias for Self::set_bottom_button_callback with BottomButton::Main.

pub fn set_secondary_button_callback<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Set callback for the secondary bottom button.

pub fn remove_main_button_callback( &self, handle: EventHandle<dyn FnMut()>, ) -> Result<(), JsValue>

Legacy alias for Self::remove_bottom_button_callback.

pub fn remove_secondary_button_callback( &self, handle: EventHandle<dyn FnMut()>, ) -> Result<(), JsValue>

Remove callback for the secondary bottom button.

pub fn on_event<F>( &self, event: &str, callback: F, ) -> Result<EventHandle<dyn FnMut(JsValue)>, JsValue>

where F: 'static + Fn(JsValue),

Register event handler (web_app_event_name, callback).

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_background_event<F>( &self, event: BackgroundEvent, callback: F, ) -> Result<EventHandle<dyn FnMut(JsValue)>, JsValue>

where F: 'static + Fn(JsValue),

Register a callback for a background event.

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn off_event<T: ?Sized>( &self, handle: EventHandle<T>, ) -> Result<(), JsValue>

Deregister a previously registered event handler.

Errors

Returns JsValue if the underlying JS call fails.

pub fn viewport_height(&self) -> Option<f64>

Returns the current viewport height in pixels.

Examples

let _ = app.viewport_height();

pub fn viewport_width(&self) -> Option<f64>

Returns the current viewport width in pixels.

Examples

let _ = app.viewport_width();

pub fn viewport_stable_height(&self) -> Option<f64>

Returns the stable viewport height in pixels.

Examples

let _ = app.viewport_stable_height();

pub fn is_expanded(&self) -> bool

pub fn expand_viewport(&self) -> Result<(), JsValue>

Call WebApp.expand() to expand the viewport.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_theme_changed<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Register a callback for theme changes.

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_safe_area_changed<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Register a callback for safe area changes.

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_content_safe_area_changed<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Register a callback for content safe area changes.

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_viewport_changed<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Register a callback for viewport changes.

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_clipboard_text_received<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut(JsValue)>, JsValue>

where F: 'static + Fn(String),

Register a callback for received clipboard text.

Returns an EventHandle that can be passed to off_event.

Errors

Returns JsValue if the underlying JS call fails.

pub fn on_invoice_closed<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut(String)>, JsValue>

where F: 'static + Fn(String),

Register a callback for invoice payment result.

Returns an EventHandle that can be passed to off_event.

Examples

let handle = app
    .on_invoice_closed(|status| {
        let _ = status;
    })
    .unwrap();
app.off_event(handle).unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn set_back_button_callback<F>( &self, callback: F, ) -> Result<EventHandle<dyn FnMut()>, JsValue>

where F: 'static + Fn(),

Registers a callback for the native back button.

Returns an EventHandle that can be passed to remove_back_button_callback.

Examples

let handle = app.set_back_button_callback(|| {}).expect("callback");
app.remove_back_button_callback(handle).unwrap();

Errors

Returns JsValue if the underlying JS call fails.

pub fn remove_back_button_callback( &self, handle: EventHandle<dyn FnMut()>, ) -> Result<(), JsValue>

Remove previously set back button callback.

Errors

Returns JsValue if the underlying JS call fails.

pub fn is_back_button_visible(&self) -> bool

Returns whether the native back button is visible.

Examples

let _ = app.is_back_button_visible();

Trait Implementations

impl Clone for TelegramWebApp

fn clone(&self) -> TelegramWebApp

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.