Struct tauri::AppHandle

pub struct AppHandle<R: Runtime = Wry> { /* private fields */ }

A handle to the currently running application.

This type implements Manager which allows for manipulation of global application items.

Implementations

impl AppHandle<Wry>

APIs specific to the wry runtime.

pub fn create_tao_window<F: FnOnce() -> (String, TaoWindowBuilder) + Send + 'static>( &self, f: F ) -> Result<Weak<Window>>

Create a new tao window using a callback. The event loop must be running at this point.

pub fn send_tao_window_event( &self, window_id: WindowId, message: WindowMessage ) -> Result<()>

Sends a window message to the event loop.

impl<R: Runtime> AppHandle<R>

pub fn run_on_main_thread<F: FnOnce() + Send + 'static>( &self, f: F ) -> Result<()>

Runs the given closure on the main thread.

pub fn plugin<P: Plugin<R> + 'static>(&self, plugin: P) -> Result<()>

Adds a Tauri application plugin. This function can be used to register a plugin that is loaded dynamically e.g. after login. For plugins that are created when the app is started, prefer Builder::plugin.

See Builder::plugin for more information.

Examples

use tauri::{plugin::{Builder as PluginBuilder, TauriPlugin}, Runtime};

fn init_plugin<R: Runtime>() -> TauriPlugin<R> {
  PluginBuilder::new("dummy").build()
}

tauri::Builder::default()
  .setup(move |app| {
    let handle = app.handle().clone();
    std::thread::spawn(move || {
      handle.plugin(init_plugin());
    });

    Ok(())
  });

pub fn remove_plugin(&self, plugin: &'static str) -> bool

Removes the plugin with the given name.

Examples

use tauri::{plugin::{Builder as PluginBuilder, TauriPlugin, Plugin}, Runtime};

fn init_plugin<R: Runtime>() -> TauriPlugin<R> {
  PluginBuilder::new("dummy").build()
}

let plugin = init_plugin();
// `.name()` requires the `PLugin` trait import
let plugin_name = plugin.name();
tauri::Builder::default()
  .plugin(plugin)
  .setup(move |app| {
    let handle = app.handle().clone();
    std::thread::spawn(move || {
      handle.remove_plugin(plugin_name);
    });

    Ok(())
  });

pub fn exit(&self, exit_code: i32)

Exits the app. This is the same as std::process::exit, but it performs cleanup on this application.

pub fn restart(&self)

Restarts the app. This is the same as crate::process::restart, but it performs cleanup on this application.

impl<R: Runtime> AppHandle<R>

pub fn on_menu_event<F: Fn(&AppHandle<R>, MenuEvent) + Send + Sync + 'static>( &self, handler: F )

Registers a global menu event listener.

pub fn on_tray_icon_event<F: Fn(&AppHandle<R>, TrayIconEvent) + Send + Sync + 'static>( &self, handler: F )

Available on desktop and crate feature tray-icon only.

Registers a global tray icon menu event listener.

pub fn tray(&self) -> Option<TrayIcon<R>>

Available on desktop and crate feature tray-icon only.

Gets the first tray icon registered, usually the one configured in the Tauri configuration file.

pub fn remove_tray(&self) -> Option<TrayIcon<R>>

Available on desktop and crate feature tray-icon only.

Removes the first tray icon registerd, usually the one configured in tauri config file, from tauri’s internal state and returns it.

Note that dropping the returned icon, will cause the tray icon to disappear.

pub fn tray_by_id<'a, I>(&self, id: &'a I) -> Option<TrayIcon<R>>

where I: ?Sized, TrayIconId: PartialEq<&'a I>,

Available on desktop and crate feature tray-icon only.

Gets a tray icon using the provided id.

pub fn remove_tray_by_id<'a, I>(&self, id: &'a I) -> Option<TrayIcon<R>>

where I: ?Sized, TrayIconId: PartialEq<&'a I>,

Available on desktop and crate feature tray-icon only.

Removes a tray icon using the provided id from tauri’s internal state and returns it.

Note that dropping the returned icon, will cause the tray icon to disappear.

pub fn config(&self) -> &Config

Gets the app’s configuration, defined on the tauri.conf.json file.

pub fn package_info(&self) -> &PackageInfo

Gets the app’s package information.

pub fn asset_resolver(&self) -> AssetResolver<R>

The application’s asset resolver.

pub fn primary_monitor(&self) -> Result<Option<Monitor>>

Returns the primary monitor of the system.

Returns None if it can’t identify any monitor as a primary one.

pub fn available_monitors(&self) -> Result<Vec<Monitor>>

Returns the list of all the monitors available on the system.

pub fn default_window_icon(&self) -> Option<&Icon>

Returns the default window icon.

pub fn menu(&self) -> Option<Menu<R>>

Returns the app-wide menu.

pub fn set_menu(&self, menu: Menu<R>) -> Result<Option<Menu<R>>>

Sets the app-wide menu and returns the previous one.

If a window was not created with an explicit menu or had one set explicitly, this menu will be assigned to it.

pub fn remove_menu(&self) -> Result<Option<Menu<R>>>

Remove the app-wide menu and returns it.

If a window was not created with an explicit menu or had one set explicitly, this will remove the menu from it.

pub fn hide_menu(&self) -> Result<()>

Hides the app-wide menu from windows that have it.

If a window was not created with an explicit menu or had one set explicitly, this will hide the menu from it.

pub fn show_menu(&self) -> Result<()>

Shows the app-wide menu for windows that have it.

If a window was not created with an explicit menu or had one set explicitly, this will show the menu for it.

pub fn cleanup_before_exit(&self)

Runs necessary cleanup tasks before exiting the process. You should always exit the tauri app immediately after this function returns and not use any tauri-related APIs.

Trait Implementations

impl<R: Runtime> Clone for AppHandle<R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, R: Runtime> CommandArg<'de, R> for AppHandle<R>

fn from_command(command: CommandItem<'de, R>) -> Result<Self, InvokeError>

Grabs the Window from the CommandItem and returns the associated AppHandle. This will never fail.

impl<R: Debug + Runtime> Debug for AppHandle<R>

where R::Handle: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Runtime> HasRawDisplayHandle for AppHandle<R>

fn raw_display_handle(&self) -> RawDisplayHandle

impl<R: Runtime> Manager<R> for AppHandle<R>

fn app_handle(&self) -> &AppHandle<R>

The application handle associated with this manager.

fn config(&self) -> &Config

The Config the manager was created with.

fn package_info(&self) -> &PackageInfo

The PackageInfo the manager was created with.

fn listen_global<F>(&self, event: impl Into<String>, handler: F) -> EventId

where F: Fn(Event) + Send + 'static,

Listen to an event emitted on any window.

fn unlisten(&self, id: EventId)

Remove an event listener.

fn once_global<F>(&self, event: impl Into<String>, handler: F)

where F: FnOnce(Event) + Send + 'static,

Listen to a global event only once.

fn emit<S: Serialize + Clone>(&self, event: &str, payload: S) -> Result<()>

Emits an event to all windows.

fn emit_to<S: Serialize + Clone>( &self, label: &str, event: &str, payload: S ) -> Result<()>

Emits an event to the window with the specified label.

fn emit_filter<S, F>(&self, event: &str, payload: S, filter: F) -> Result<()>

where S: Serialize + Clone, F: Fn(&Window<R>) -> bool,

Emits an event to specific windows based on a filter.

fn get_window(&self, label: &str) -> Option<Window<R>>

Fetch a single window from the manager.

fn get_focused_window(&self) -> Option<Window<R>>

Fetch the focused window. Returns None if there is not any focused window.

fn windows(&self) -> HashMap<String, Window<R>>

Fetch all managed windows.

fn manage<T>(&self, state: T) -> bool

where T: Send + Sync + 'static,

Add state to the state managed by the application.

fn state<T>(&self) -> State<'_, T>

where T: Send + Sync + 'static,

Retrieves the managed state for the type T.

fn try_state<T>(&self) -> Option<State<'_, T>>

where T: Send + Sync + 'static,

Attempts to retrieve the managed state for the type T.

fn resources_table(&self) -> MutexGuard<'_, ResourceTable>

Get a reference to the resources table.

fn env(&self) -> Env

Gets the managed Env.

fn ipc_scope(&self) -> Scope

Gets the scope for the IPC.

fn asset_protocol_scope(&self) -> Scope

Gets the scope for the asset protocol.

fn path(&self) -> &PathResolver<R>

The path resolver.