kotlin-tauri-apps-api/tauri.apps.api.core

Package-level declarations

Types

external class Channel<T>

A message channel used to stream values from Rust to the frontend.

typealias InvokeArgs = Any

Command arguments.

external interface InvokeOptions

PermissionState

sealed external interface PermissionState

external class PluginListener

A handle to a listener registered with {@linkcode addPluginListener}.

open external class Resource

A rust-backed resource stored through tauri::Manager::resources_table API.

Properties

val PermissionState.Companion.denied: PermissionState

val PermissionState.Companion.granted: PermissionState

val PermissionState.Companion.prompt: PermissionState

promptWithRationale

val PermissionState.Companion.promptWithRationale: PermissionState

SERIALIZE_TO_IPC_FN

external val SERIALIZE_TO_IPC_FN: Any?

Functions

addPluginListener

external fun <T> addPluginListener(plugin: String, event: String, cb: (payload: T) -> Unit): Promise<PluginListener>

Adds a listener to a plugin event.

checkPermissions

external fun <T> checkPermissions(plugin: String): Promise<T>

Get permission state for a plugin.

external fun convertFileSrc(filePath: String, protocol: String = definedExternally): String

Convert a device file path to a URL that can be loaded by the webview.

external fun <T> invoke(cmd: String, args: InvokeArgs = definedExternally, options: InvokeOptions = definedExternally): Promise<T>

Sends a message to the backend.

external fun isTauri(): Boolean

Checks whether the code is running inside a Tauri webview.

requestPermissions

external fun <T> requestPermissions(plugin: String): Promise<T>

Request permissions.

transformCallback

external fun <T> transformCallback(callback: (response: T) -> Unit = definedExternally, once: Boolean = definedExternally): Double

Stores the callback in a known location, and returns an identifier that can be passed to the backend. The backend uses the identifier to eval() the callback.