kotlin-tauri-apps-api/tauri.apps.api.app

Package-level declarations

Types

BundleType

sealed external interface BundleType

Bundle type of the current application.

DataStoreIdentifier

typealias DataStoreIdentifier = ReadonlyArray<Double>

Identifier type used for data stores on macOS and iOS.

OnBackButtonPressPayload

external interface OnBackButtonPressPayload

Payload for the onBackButtonPress event.

Functions

defaultWindowIcon

external fun defaultWindowIcon(): Promise<Image?>

Gets the default window icon.

fetchDataStoreIdentifiers

external fun fetchDataStoreIdentifiers(): Promise<ReadonlyArray<DataStoreIdentifier>>

Fetches the data store identifiers on macOS and iOS.

getBundleType

external fun getBundleType(): Promise<BundleType>

Gets the application bundle type.

getIdentifier

external fun getIdentifier(): Promise<String>

Gets the application identifier.

getName

external fun getName(): Promise<String>

Gets the application name.

getTauriVersion

external fun getTauriVersion(): Promise<String>

Gets the Tauri framework version used by this application.

getVersion

external fun getVersion(): Promise<String>

Gets the application version.

hide

external fun hide(): Promise<Void>

Hides the application on macOS.

onBackButtonPress

external fun onBackButtonPress(handler: (payload: OnBackButtonPressPayload) -> Unit): Promise<PluginListener>

Listens to the backButton event on Android.

removeDataStore

external fun removeDataStore(uuid: DataStoreIdentifier): Promise<Void>

Removes the data store with the given identifier.

setDockVisibility

external fun setDockVisibility(visible: Boolean): Promise<Void>

Sets the dock visibility for the application on macOS.

setTheme

external fun setTheme(theme: Theme? = definedExternally): Promise<Void>

Sets the application's theme. Pass in null or undefined to follow the system theme.

show

external fun show(): Promise<Void>

Shows the application on macOS. This function does not automatically focus any specific app window.