@capacitor/app
Version:
The App API handles high level App state and events.For example, this API emits events when the app enters and leaves the foreground, handles deeplinks, opens other apps, and manages persisted plugin state.
237 lines (236 loc) • 8.47 kB
TypeScript
import type { PluginListenerHandle } from '@capacitor/core';
export interface AppInfo {
/**
* The name of the app.
*
* @since 1.0.0
*/
name: string;
/**
* The identifier of the app.
* On iOS it's the Bundle Identifier.
* On Android it's the Application ID
*
* @since 1.0.0
*/
id: string;
/**
* The build version.
* On iOS it's the CFBundleVersion.
* On Android it's the versionCode.
*
* @since 1.0.0
*/
build: string;
/**
* The app version.
* On iOS it's the CFBundleShortVersionString.
* On Android it's package's versionName.
*
* @since 1.0.0
*/
version: string;
}
export interface AppState {
/**
* Whether the app is active or not.
*
* @since 1.0.0
*/
isActive: boolean;
}
export interface URLOpenListenerEvent {
/**
* The URL the app was opened with.
*
* @since 1.0.0
*/
url: string;
/**
* The source application opening the app (iOS only)
* https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623128-sourceapplication
*
* @since 1.0.0
*/
iosSourceApplication?: any;
/**
* Whether the app should open the passed document in-place
* or must copy it first.
* https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623123-openinplace
*
* @since 1.0.0
*/
iosOpenInPlace?: boolean;
}
export interface AppLaunchUrl {
/**
* The url used to open the app.
*
* @since 1.0.0
*/
url: string;
}
export interface RestoredListenerEvent {
/**
* The pluginId this result corresponds to. For example, `Camera`.
*
* @since 1.0.0
*/
pluginId: string;
/**
* The methodName this result corresponds to. For example, `getPhoto`
*
* @since 1.0.0
*/
methodName: string;
/**
* The result data passed from the plugin. This would be the result you'd
* expect from normally calling the plugin method. For example, `CameraPhoto`
*
* @since 1.0.0
*/
data?: any;
/**
* Boolean indicating if the plugin call succeeded.
*
* @since 1.0.0
*/
success: boolean;
/**
* If the plugin call didn't succeed, it will contain the error message.
*
* @since 1.0.0
*/
error?: {
message: string;
};
}
export interface BackButtonListenerEvent {
/**
* Indicates whether the browser can go back in history.
* False when the history stack is on the first entry.
*
* @since 1.0.0
*/
canGoBack: boolean;
}
export declare type StateChangeListener = (state: AppState) => void;
export declare type URLOpenListener = (event: URLOpenListenerEvent) => void;
export declare type RestoredListener = (event: RestoredListenerEvent) => void;
export declare type BackButtonListener = (event: BackButtonListenerEvent) => void;
export interface AppPlugin {
/**
* Force exit the app. This should only be used in conjunction with the `backButton` handler for Android to
* exit the app when navigation is complete.
*
* Ionic handles this itself so you shouldn't need to call this if using Ionic.
*
* @since 1.0.0
*/
exitApp(): Promise<void>;
/**
* Return information about the app.
*
* @since 1.0.0
*/
getInfo(): Promise<AppInfo>;
/**
* Gets the current app state.
*
* @since 1.0.0
*/
getState(): Promise<AppState>;
/**
* Get the URL the app was launched with, if any.
*
* @since 1.0.0
*/
getLaunchUrl(): Promise<AppLaunchUrl | undefined>;
/**
* Minimizes the application.
*
* Only available for Android.
*
* @since 1.1.0
*/
minimizeApp(): Promise<void>;
/**
* Listen for changes in the app or the activity states.
*
* On iOS it's fired when the native [UIApplication.willResignActiveNotification](https://developer.apple.com/documentation/uikit/uiapplication/1622973-willresignactivenotification) and
* [UIApplication.didBecomeActiveNotification](https://developer.apple.com/documentation/uikit/uiapplication/1622953-didbecomeactivenotification) events get fired.
* On Android it's fired when the Capacitor's Activity [onResume](https://developer.android.com/reference/android/app/Activity#onResume()) and [onStop](https://developer.android.com/reference/android/app/Activity#onStop()) methods gets called.
* On Web it's fired when the document's visibilitychange gets fired.
*
* @since 1.0.0
*/
addListener(eventName: 'appStateChange', listenerFunc: StateChangeListener): Promise<PluginListenerHandle>;
/**
* Listen for when the app or the activity are paused.
*
* On iOS it's fired when the native [UIApplication.didEnterBackgroundNotification](https://developer.apple.com/documentation/uikit/uiapplication/1623071-didenterbackgroundnotification) event gets fired.
* On Android it's fired when the Capacitor's Activity [onPause](https://developer.android.com/reference/android/app/Activity#onPause()) method gets called.
* On Web it's fired when the document's visibilitychange gets fired and document.hidden is true.
*
* @since 4.1.0
*/
addListener(eventName: 'pause', listenerFunc: () => void): Promise<PluginListenerHandle>;
/**
* Listen for when the app or activity are resumed.
*
* On iOS it's fired when the native [UIApplication.willEnterForegroundNotification](https://developer.apple.com/documentation/uikit/uiapplication/1622944-willenterforegroundnotification) event gets fired.
* On Android it's fired when the Capacitor's Activity [onResume](https://developer.android.com/reference/android/app/Activity#onResume()) method gets called,
* but only after resume has fired first.
* On Web it's fired when the document's visibilitychange gets fired and document.hidden is false.
*
* @since 4.1.0
*/
addListener(eventName: 'resume', listenerFunc: () => void): Promise<PluginListenerHandle>;
/**
* Listen for url open events for the app. This handles both custom URL scheme links as well
* as URLs your app handles (Universal Links on iOS and App Links on Android)
*
* @since 1.0.0
*/
addListener(eventName: 'appUrlOpen', listenerFunc: URLOpenListener): Promise<PluginListenerHandle>;
/**
* If the app was launched with previously persisted plugin call data, such as on Android
* when an activity returns to an app that was closed, this call will return any data
* the app was launched with, converted into the form of a result from a plugin call.
*
* On Android, due to memory constraints on low-end devices, it's possible
* that, if your app launches a new activity, your app will be terminated by
* the operating system in order to reduce memory consumption.
*
* For example, that means the Camera API, which launches a new Activity to
* take a photo, may not be able to return data back to your app.
*
* To avoid this, Capacitor stores all restored activity results on launch.
* You should add a listener for `appRestoredResult` in order to handle any
* plugin call results that were delivered when your app was not running.
*
* Once you have that result (if any), you can update the UI to restore a
* logical experience for the user, such as navigating or selecting the
* proper tab.
*
* We recommend every Android app using plugins that rely on external
* Activities (for example, Camera) to have this event and process handled.
*
* @since 1.0.0
*/
addListener(eventName: 'appRestoredResult', listenerFunc: RestoredListener): Promise<PluginListenerHandle>;
/**
* Listen for the hardware back button event (Android only). Listening for this event will disable the
* default back button behaviour, so you might want to call `window.history.back()` manually.
* If you want to close the app, call `App.exitApp()`.
*
* @since 1.0.0
*/
addListener(eventName: 'backButton', listenerFunc: BackButtonListener): Promise<PluginListenerHandle>;
/**
* Remove all native listeners for this plugin
*
* @since 1.0.0
*/
removeAllListeners(): Promise<void>;
}