mirror of
https://github.com/mii443/vrclipboard-ime-gui.git
synced 2025-08-22 16:15:32 +00:00
165 lines
3.8 KiB
TypeScript
165 lines
3.8 KiB
TypeScript
import { Image } from './image';
|
|
import { Theme } from './window';
|
|
export type DataStoreIdentifier = [
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number,
|
|
number
|
|
];
|
|
/**
|
|
* Application metadata and related APIs.
|
|
*
|
|
* @module
|
|
*/
|
|
/**
|
|
* Gets the application version.
|
|
* @example
|
|
* ```typescript
|
|
* import { getVersion } from '@tauri-apps/api/app';
|
|
* const appVersion = await getVersion();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function getVersion(): Promise<string>;
|
|
/**
|
|
* Gets the application name.
|
|
* @example
|
|
* ```typescript
|
|
* import { getName } from '@tauri-apps/api/app';
|
|
* const appName = await getName();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function getName(): Promise<string>;
|
|
/**
|
|
* Gets the Tauri version.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { getTauriVersion } from '@tauri-apps/api/app';
|
|
* const tauriVersion = await getTauriVersion();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function getTauriVersion(): Promise<string>;
|
|
/**
|
|
* Gets the application identifier.
|
|
* @example
|
|
* ```typescript
|
|
* import { getIdentifier } from '@tauri-apps/api/app';
|
|
* const identifier = await getIdentifier();
|
|
* ```
|
|
*
|
|
* @returns The application identifier as configured in `tauri.conf.json`.
|
|
*
|
|
* @since 2.4.0
|
|
*/
|
|
declare function getIdentifier(): Promise<string>;
|
|
/**
|
|
* Shows the application on macOS. This function does not automatically focus any specific app window.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { show } from '@tauri-apps/api/app';
|
|
* await show();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function show(): Promise<void>;
|
|
/**
|
|
* Hides the application on macOS.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { hide } from '@tauri-apps/api/app';
|
|
* await hide();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function hide(): Promise<void>;
|
|
/**
|
|
* Fetches the data store identifiers on macOS and iOS.
|
|
*
|
|
* See https://developer.apple.com/documentation/webkit/wkwebsitedatastore for more information.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { fetchDataStoreIdentifiers } from '@tauri-apps/api/app';
|
|
* const ids = await fetchDataStoreIdentifiers();
|
|
* ```
|
|
*
|
|
* @since 2.4.0
|
|
*/
|
|
declare function fetchDataStoreIdentifiers(): Promise<DataStoreIdentifier[]>;
|
|
/**
|
|
* Removes the data store with the given identifier.
|
|
*
|
|
* Note that any webview using this data store should be closed before running this API.
|
|
*
|
|
* See https://developer.apple.com/documentation/webkit/wkwebsitedatastore for more information.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { fetchDataStoreIdentifiers, removeDataStore } from '@tauri-apps/api/app';
|
|
* for (const id of (await fetchDataStoreIdentifiers())) {
|
|
* await removeDataStore(id);
|
|
* }
|
|
* ```
|
|
*
|
|
* @since 2.4.0
|
|
*/
|
|
declare function removeDataStore(uuid: DataStoreIdentifier): Promise<DataStoreIdentifier[]>;
|
|
/**
|
|
* Get the default window icon.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { defaultWindowIcon } from '@tauri-apps/api/app';
|
|
* await defaultWindowIcon();
|
|
* ```
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
declare function defaultWindowIcon(): Promise<Image | null>;
|
|
/**
|
|
* Set app's theme, pass in `null` or `undefined` to follow system theme
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { setTheme } from '@tauri-apps/api/app';
|
|
* await setTheme('dark');
|
|
* ```
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **iOS / Android:** Unsupported.
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
declare function setTheme(theme?: Theme | null): Promise<void>;
|
|
/**
|
|
* Sets the dock visibility for the application on macOS.
|
|
*
|
|
* @param visible whether the dock should be visible or not
|
|
* @since 2.5.0
|
|
*/
|
|
declare function setDockVisibility(visible: boolean): Promise<void>;
|
|
export { getName, getVersion, getTauriVersion, getIdentifier, show, hide, defaultWindowIcon, setTheme, fetchDataStoreIdentifiers, removeDataStore, setDockVisibility };
|