app

Enumeraciones

BundleType

Tipo de paquete de la aplicación actual.

Miembros de enumeraciones

App

App: "app";

Paquete de aplicación de macOS

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L48

AppImage

AppImage: "appimage";

AppImage de Linux

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L46

Deb

Deb: "deb";

Paquete Debian de Linux

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L42

Msi

Msi: "msi";

MSI de Windows

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L40

Nsis

Nsis: "nsis";

NSIS de Windows

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L38

Rpm

Rpm: "rpm";

RPM de Linux

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L44

Alias de tipos

DataStoreIdentifier

type DataStoreIdentifier: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];

Tipo de identificador utilizado para almacenes de datos en macOS e iOS.

Representa un identificador de 128 bits, comúnmente expresado como un UUID de 16 bytes.

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L14

---

OnBackButtonPressPayload

type OnBackButtonPressPayload: object;

Payload para el evento onBackButtonPress.

Declaración de tipo

Nombre	Tipo	Descripción	Definido en
canGoBack	boolean	Si la propiedad canGoBack del webview es true.	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L260

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L258

Funciones

defaultWindowIcon()

function defaultWindowIcon(): Promise<Image | null>

Obtiene el ícono de ventana predeterminado.

Devuelve

Promise<Image | null>

Ejemplo

import { defaultWindowIcon } from '@tauri-apps/api/app';
const icon = await defaultWindowIcon();

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L197

---

fetchDataStoreIdentifiers()

function fetchDataStoreIdentifiers(): Promise<DataStoreIdentifier[]>

Obtiene los identificadores del almacén de datos en macOS e iOS.

Consulta https://developer.apple.com/documentation/webkit/wkwebsitedatastore para obtener más información.

Devuelve

Promise<DataStoreIdentifier[]>

Ejemplo

import { fetchDataStoreIdentifiers } from '@tauri-apps/api/app';
const ids = await fetchDataStoreIdentifiers();

Desde

2.4.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L160

---

getBundleType()

function getBundleType(): Promise<BundleType>

Obtiene el tipo de paquete de la aplicación.

Devuelve

Promise<BundleType>

Ejemplo

import { getBundleType } from '@tauri-apps/api/app';
const type = await getBundleType();

Desde

2.5.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L251

---

getIdentifier()

function getIdentifier(): Promise<string>

Obtiene el identificador de la aplicación.

Devuelve

Promise<string>

El identificador de la aplicación configurado en tauri.conf.json.

Ejemplo

import { getIdentifier } from '@tauri-apps/api/app';
const identifier = await getIdentifier();

Desde

2.4.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L112

---

getName()

function getName(): Promise<string>

Obtiene el nombre de la aplicación.

Devuelve

Promise<string>

Ejemplo

import { getName } from '@tauri-apps/api/app';
const appName = await getName();

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L81

---

getTauriVersion()

function getTauriVersion(): Promise<string>

Obtiene la versión del framework Tauri utilizada por esta aplicación.

Devuelve

Promise<string>

Ejemplo

import { getTauriVersion } from '@tauri-apps/api/app';
const tauriVersion = await getTauriVersion();

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L96

---

getVersion()

function getVersion(): Promise<string>

Obtiene la versión de la aplicación.

Devuelve

Promise<string>

Ejemplo

import { getVersion } from '@tauri-apps/api/app';
const appVersion = await getVersion();

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L67

---

hide()

function hide(): Promise<void>

Oculta la aplicación en macOS.

Devuelve

Promise<void>

Ejemplo

import { hide } from '@tauri-apps/api/app';
await hide();

Desde

1.2.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L143

---

onBackButtonPress()

function onBackButtonPress(handler): Promise<PluginListener>

Escucha el evento backButton en Android.

Parámetros

Parámetro	Tipo	Descripción
handler	(payload) => void

Devuelve

Promise<PluginListener>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L267

---

removeDataStore()

function removeDataStore(uuid): Promise<void>

Elimina el almacén de datos con el identificador dado.

Ten en cuenta que cualquier webview que use este almacén de datos debe cerrarse antes de ejecutar esta API.

Consulta https://developer.apple.com/documentation/webkit/wkwebsitedatastore para obtener más información.

Parámetros

Parámetro	Tipo
uuid	DataStoreIdentifier

Devuelve

Promise<void>

Ejemplo

import { fetchDataStoreIdentifiers, removeDataStore } from '@tauri-apps/api/app';
for (const id of (await fetchDataStoreIdentifiers())) {
  await removeDataStore(id);
}

Desde

2.4.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L181

---

setDockVisibility()

function setDockVisibility(visible): Promise<void>

Establece la visibilidad del dock para la aplicación en macOS.

Parámetros

Parámetro	Tipo	Descripción
visible	boolean	Si el dock debe ser visible o no.

Devuelve

Promise<void>

Ejemplo

import { setDockVisibility } from '@tauri-apps/api/app';
await setDockVisibility(false);

Desde

2.5.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L236

---

setTheme()

function setTheme(theme?): Promise<void>

Establece el tema de la aplicación. Pasa null o undefined para seguir el tema del sistema.

Parámetros

Parámetro	Tipo
theme?	null | Theme

Devuelve

Promise<void>

Ejemplo

import { setTheme } from '@tauri-apps/api/app';
await setTheme('dark');

Específico de la plataforma

• iOS / Android: No soportado.

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L219

---

show()

function show(): Promise<void>

Muestra la aplicación en macOS. Esta función no enfoca automáticamente ninguna ventana específica de la aplicación.

Devuelve

Promise<void>

Ejemplo

import { show } from '@tauri-apps/api/app';
await show();

Desde

1.2.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L128

---

supportsMultipleWindows()

function supportsMultipleWindows(): Promise<boolean>

Devuelve

Promise<boolean>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/app.ts#L277