Struct tauri::App

pub struct App<P: Params = Args<String, String, String, String, EmbeddedAssets, Wry>> { /* fields omitted */ }

The instance of the currently running application.

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

Implementations

impl<P: Params> App<P>

pub fn create_window<F>(
    &self,
    label: P::Label,
    url: WindowUrl,
    setup: F
) -> Result<()> where
    F: FnOnce(<<P::Runtime as Runtime>::Dispatcher as Dispatch>::WindowBuilder, WebviewAttributes) -> (<<P::Runtime as Runtime>::Dispatcher as Dispatch>::WindowBuilder, WebviewAttributes), 

Creates a new webview window.

pub fn tray_handle(&self) -> SystemTrayHandle<P>

This is supported on crate feature system-tray only.

Gets a handle handle to the system tray.

pub fn path_resolver(&self) -> PathResolver

The path resolver for the application.

pub fn global_shortcut_manager(
    &self
) -> <P::Runtime as Runtime>::GlobalShortcutManager

Gets a copy of the global shortcut manager instance.

pub fn clipboard_manager(&self) -> <P::Runtime as Runtime>::ClipboardManager

Gets a copy of the clipboard manager instance.

pub fn config(&self) -> Arc<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.

impl<P: Params> App<P>

pub fn handle(&self) -> AppHandle<P>

Gets a handle to the application instance.

Trait Implementations

impl<P: Params> Manager<P> for App<P>

fn config(&self) -> Arc<Config>

The Config the manager was created with.

fn emit_all<E: ?Sized, S>(&self, event: &E, payload: S) -> Result<()> where
    P::Event: Borrow<E>,
    E: TagRef<P::Event>,
    S: Serialize + Clone, 

Emits a event to all windows.

fn emit_to<E: ?Sized, L: ?Sized, S: Serialize + Clone>(
    &self,
    label: &L,
    event: &E,
    payload: S
) -> Result<()> where
    P::Label: Borrow<L>,
    P::Event: Borrow<E>,
    L: TagRef<P::Label>,
    E: TagRef<P::Event>, 

Emits an event to a window with the specified label.

fn listen_global<E: Into<P::Event>, F>(
    &self,
    event: E,
    handler: F
) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to a global event.

fn once_global<E: Into<P::Event>, F>(
    &self,
    event: E,
    handler: F
) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to a global event only once.

fn trigger_global<E: ?Sized>(&self, event: &E, data: Option<String>) where
    P::Event: Borrow<E>,
    E: TagRef<P::Event>, 

Trigger a global event.

fn unlisten(&self, handler_id: EventHandler)

Remove an event listener.

fn get_window<L: ?Sized>(&self, label: &L) -> Option<Window<P>> where
    P::Label: Borrow<L>,
    L: TagRef<P::Label>, 

Fetch a single window from the manager.

fn windows(&self) -> HashMap<P::Label, Window<P>>

Fetch all managed windows.

fn manage<T>(&self, state: T) where
    T: Send + Sync + 'static, 

Add state to the state managed by the application. See crate::Builder for instructions.

fn state<T>(&self) -> State<'_, T> where
    T: Send + Sync + 'static, 

Gets the managed state for the type T.