@zturnlibs/ztron-api

---

app#

Enumerations#

BundleType#

Defined in: app.ts:42

当前发行版的安装器格式——镜像 Tauri 的 BundleType（在 .app 包内或 dev 下运行时为 App）。

Enumeration Members#

App#

App: "App"

Defined in: app.ts:48

AppImage#

AppImage: "AppImage"

Defined in: app.ts:47

Deb#

Deb: "Deb"

Defined in: app.ts:45

Msi#

Msi: "Msi"

Defined in: app.ts:44

Nsis#

Nsis: "Nsis"

Defined in: app.ts:43

Rpm#

Rpm: "Rpm"

Defined in: app.ts:46

Interfaces#

AppInfo#

Defined in: app.ts:22

Properties#

appName?#

optional appName?: string

Defined in: app.ts:24

identifier#

identifier: string

Defined in: app.ts:23

version?#

optional version?: string

Defined in: app.ts:25

Variables#

app#

const app: object

Defined in: app.ts:91

Type Declaration#

defaultWindowIcon#

defaultWindowIcon: () => Promise<null>

已注册的默认窗口图标（未设置时为 null）。

Returns#

Promise<null>

fetchDataStoreIdentifiers#

fetchDataStoreIdentifiers: () => Promise<string[]>

上游仅 Android：已知的数据存储标识符（桌面端为空数组）。

Returns#

Promise<string[]>

getBundleType#

getBundleType: () => Promise<string>

当前构建打包所用的发行格式。

Returns#

Promise<string>

getConfig#

getConfig: () => Promise<AppInfo & Record<string, unknown>>

应用配置（identifier/name/version；机密字段已剥离）。

Returns#

Promise<AppInfo & Record<string, unknown>>

getIdentifier#

getIdentifier: () => Promise<string>

配置的包标识符（如 com.example.app）。

Returns#

Promise<string>

getName#

getName: () => Promise<string>

配置的应用名（回落到包标识符）。

Returns#

Promise<string>

getTauriVersion#

getTauriVersion: () => Promise<string>

Ztron API 版本（镜像 Tauri 的 getTauriVersion）。

Returns#

Promise<string>

getVersion#

getVersion: () => Promise<string>

配置的应用版本。

Returns#

Promise<string>

hide#

hide: () => Promise<void> = hideApplication

隐藏整个应用及其所有窗口（macOS NSApp hide:）。

Returns#

Promise<void>

removeDataStore#

removeDataStore: (id) => Promise<{ removed: boolean; }>

上游仅 Android：移除一个数据存储（桌面端为空操作）。

Parameters#

id#

string

Returns#

Promise<{ removed: boolean; }>

setDockVisibility#

setDockVisibility: (visible) => Promise<void>

切换运行中应用的 macOS Dock 图标。

Parameters#

visible#

boolean

Returns#

Promise<void>

show#

show: () => Promise<void> = showApplication

显示整个应用（macOS：取消隐藏并激活）。

Returns#

Promise<void>

supportsMultipleWindows#

supportsMultipleWindows: () => Promise<boolean>

运行时是否支持继续创建新窗口。

Returns#

Promise<boolean>

Functions#

defaultWindowIcon()#

defaultWindowIcon(): Promise<null>

Defined in: app.ts:72

已注册的默认窗口图标（未设置时为 null）。

Returns#

Promise<null>

---

fetchDataStoreIdentifiers()#

fetchDataStoreIdentifiers(): Promise<string[]>

Defined in: app.ts:77

上游仅 Android：已知的数据存储标识符（桌面端为空数组）。

Returns#

Promise<string[]>

---

getBundleType()#

getBundleType(): Promise<string>

Defined in: app.ts:52

当前构建打包所用的发行格式。

Returns#

Promise<string>

---

getConfig()#

getConfig(): Promise<AppInfo & Record<string, unknown>>

Defined in: app.ts:29

应用配置（identifier/name/version；机密字段已剥离）。

Returns#

Promise<AppInfo & Record<string, unknown>>

---

getIdentifier()#

getIdentifier(): Promise<string>

Defined in: app.ts:34

配置的包标识符（如 com.example.app）。

Returns#

Promise<string>

---

getName()#

getName(): Promise<string>

Defined in: app.ts:8

配置的应用名（回落到包标识符）。

Returns#

Promise<string>

---

getTauriVersion()#

getTauriVersion(): Promise<string>

Defined in: app.ts:18

Ztron API 版本（镜像 Tauri 的 getTauriVersion）。

Returns#

Promise<string>

---

getVersion()#

getVersion(): Promise<string>

Defined in: app.ts:13

配置的应用版本。

Returns#

Promise<string>

---

hideApplication()#

hideApplication(): Promise<void>

Defined in: app.ts:67

隐藏整个应用及其所有窗口（macOS NSApp hide:）。

Returns#

Promise<void>

---

removeDataStore()#

removeDataStore(id): Promise<{ removed: boolean; }>

Defined in: app.ts:82

上游仅 Android：移除一个数据存储（桌面端为空操作）。

Parameters#

id#

string

Returns#

Promise<{ removed: boolean; }>

---

setDockVisibility()#

setDockVisibility(visible): Promise<void>

Defined in: app.ts:87

切换运行中应用的 macOS Dock 图标。

Parameters#

visible#

boolean

Returns#

Promise<void>

---

showApplication()#

showApplication(): Promise<void>

Defined in: app.ts:62

显示整个应用（macOS：取消隐藏并激活）。

Returns#

Promise<void>

---

supportsMultipleWindows()#

supportsMultipleWindows(): Promise<boolean>

Defined in: app.ts:57

运行时是否支持继续创建新窗口。

Returns#

Promise<boolean>