react-klasha

# @capacitor/app 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. ## Install ```bash npm install @capacitor/app npx cap sync ``` ## iOS For being able to open the app from a custom scheme you need to register the scheme first. You can do it by editing the [`Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) file and adding this lines. ```xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLName</key> <string>com.getcapacitor.capacitor</string> <key>CFBundleURLSchemes</key> <array> <string>mycustomscheme</string> </array> </dict> </array> ``` ## Android For being able to open the app from a custom scheme you need to register the scheme first. You can do it by adding this lines inside the `activity` section of the `AndroidManifest.xml`. ```xml <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="@string/custom_url_scheme" /> </intent-filter> ``` `custom_url_scheme` value is stored in `strings.xml`. When the Android platform is added, `@capacitor/cli` adds the app's package name as default value, but can be replaced by editing the `strings.xml` file. ## Example ```typescript import { App } from '@capacitor/app'; App.addListener('appStateChange', ({ isActive }) => { console.log('App state changed. Is active?', isActive); }); App.addListener('appUrlOpen', data => { console.log('App opened with URL:', data); }); App.addListener('appRestoredResult', data => { console.log('Restored state:', data); }); const checkAppLaunchUrl = async () => { const { url } = await App.getLaunchUrl(); alert('App opened with URL: ' + url); }; ``` ## API <docgen-index> * [`exitApp()`](#exitapp) * [`getInfo()`](#getinfo) * [`getState()`](#getstate) * [`getLaunchUrl()`](#getlaunchurl) * [`addListener('appStateChange', ...)`](#addlistenerappstatechange-) * [`addListener('appUrlOpen', ...)`](#addlistenerappurlopen-) * [`addListener('appRestoredResult', ...)`](#addlistenerapprestoredresult-) * [`addListener('backButton', ...)`](#addlistenerbackbutton-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) </docgen-index> <docgen-api>  ### exitApp() ```typescript exitApp() => never ``` 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. **Returns:** <code>never</code> **Since:** 1.0.0 -------------------- ### getInfo() ```typescript getInfo() => Promise<AppInfo> ``` Return information about the app. **Returns:** <code>Promise<<a href="#appinfo">AppInfo</a>></code> **Since:** 1.0.0 -------------------- ### getState() ```typescript getState() => Promise<AppState> ``` Gets the current app state. **Returns:** <code>Promise<<a href="#appstate">AppState</a>></code> **Since:** 1.0.0 -------------------- ### getLaunchUrl() ```typescript getLaunchUrl() => Promise<AppLaunchUrl | undefined> ``` Get the URL the app was launched with, if any. **Returns:** <code>Promise<<a href="#applaunchurl">AppLaunchUrl</a>></code> **Since:** 1.0.0 -------------------- ### addListener('appStateChange', ...) ```typescript addListener(eventName: 'appStateChange', listenerFunc: StateChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle ``` Listen for changes in the App's active state (whether the app is in the foreground or background) | Param | Type | | ------------------ | ------------------------------------------------------------------- | | **`eventName`** | <code>'appStateChange'</code> | | **`listenerFunc`** | <code><a href="#statechangelistener">StateChangeListener</a></code> | **Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>> & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code> **Since:** 1.0.0 -------------------- ### addListener('appUrlOpen', ...) ```typescript addListener(eventName: 'appUrlOpen', listenerFunc: URLOpenListener) => Promise<PluginListenerHandle> & 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) | Param | Type | | ------------------ | ----------------------------------------------------------- | | **`eventName`** | <code>'appUrlOpen'</code> | | **`listenerFunc`** | <code><a href="#urlopenlistener">URLOpenListener</a></code> | **Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>> & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code> **Since:** 1.0.0 -------------------- ### addListener('appRestoredResult', ...) ```typescript addListener(eventName: 'appRestoredResult', listenerFunc: RestoredListener) => Promise<PluginListenerHandle> & 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. | Param | Type | | ------------------ | ------------------------------------------------------------- | | **`eventName`** | <code>'appRestoredResult'</code> | | **`listenerFunc`** | <code><a href="#restoredlistener">RestoredListener</a></code> | **Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>> & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code> **Since:** 1.0.0 -------------------- ### addListener('backButton', ...) ```typescript addListener(eventName: 'backButton', listenerFunc: BackButtonListener) => Promise<PluginListenerHandle> & 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()`. | Param | Type | | ------------------ | ----------------------------------------------------------------- | | **`eventName`** | <code>'backButton'</code> | | **`listenerFunc`** | <code><a href="#backbuttonlistener">BackButtonListener</a></code> | **Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>> & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code> **Since:** 1.0.0 -------------------- ### removeAllListeners() ```typescript removeAllListeners() => Promise<void> ``` Remove all native listeners for this plugin **Since:** 1.0.0 -------------------- ### Interfaces #### AppInfo | Prop | Type | Description | Since | | ------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----- | | **`name`** | <code>string</code> | The name of the app. | 1.0.0 | | **`id`** | <code>string</code> | The identifier of the app. On iOS it's the Bundle Identifier. On Android it's the Application ID | 1.0.0 | | **`build`** | <code>string</code> | The build version. On iOS it's the CFBundleVersion. On Android it's the versionCode. | 1.0.0 | | **`version`** | <code>string</code> | The app version. On iOS it's the CFBundleShortVersionString. On Android it's package's versionName. | 1.0.0 | #### AppState | Prop | Type | Description | Since | | -------------- | -------------------- | --------------------------------- | ----- | | **`isActive`** | <code>boolean</code> | Whether the app is active or not. | 1.0.0 | #### AppLaunchUrl | Prop | Type | Description | Since | | --------- | ------------------- | ----------------------------- | ----- | | **`url`** | <code>string</code> | The url used to open the app. | 1.0.0 | #### PluginListenerHandle | Prop | Type | | ------------ | ----------------------------------------- | | **`remove`** | <code>() => Promise<void></code> | #### URLOpenListenerEvent | Prop | Type | Description | Since | | -------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **`url`** | <code>string</code> | The URL the app was opened with. | 1.0.0 | | **`iosSourceApplication`** | <code>any</code> | The source application opening the app (iOS only) https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623128-sourceapplication | 1.0.0 | | **`iosOpenInPlace`** | <code>boolean</code> | Whether the app should open the passed document in-place or must copy it first. https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623123-openinplace | 1.0.0 | #### RestoredListenerEvent | Prop | Type | Description | Since | | ---------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **`pluginId`** | <code>string</code> | The pluginId this result corresponds to. For example, `Camera`. | 1.0.0 | | **`methodName`** | <code>string</code> | The methodName this result corresponds to. For example, `getPhoto` | 1.0.0 | | **`data`** | <code>any</code> | The result data passed from the plugin. This would be the result you'd expect from normally calling the plugin method. For example, `CameraPhoto` | 1.0.0 | | **`success`** | <code>boolean</code> | Boolean indicating if the plugin call succeeded. | 1.0.0 | | **`error`** | <code>{ message: string; }</code> | If the plugin call didn't succeed, it will contain the error message. | 1.0.0 | #### BackButtonListenerEvent | Prop | Type | Description | Since | | --------------- | -------------------- | --------------------------------------------------------------------------------------------------------- | ----- | | **`canGoBack`** | <code>boolean</code> | Indicates whether the browser can go back in history. False when the history stack is on the first entry. | 1.0.0 | ### Type Aliases #### StateChangeListener <code>(state: <a href="#appstate">AppState</a>): void</code> #### URLOpenListener <code>(event: <a href="#urlopenlistenerevent">URLOpenListenerEvent</a>): void</code> #### RestoredListener <code>(event: <a href="#restoredlistenerevent">RestoredListenerEvent</a>): void</code> #### BackButtonListener <code>(event: <a href="#backbuttonlistenerevent">BackButtonListenerEvent</a>): void</code> </docgen-api>