feat(App): Add getState method to check current app state (#2611)

android/capacitor/src/main/java/com/getcapacitor/plugin/App.java

@@ -19,11 +19,13 @@ public class App extends Plugin {
   private static final String EVENT_URL_OPEN = "appUrlOpen";
   private static final String EVENT_STATE_CHANGE = "appStateChange";
   private static final String EVENT_RESTORED_RESULT = "appRestoredResult";
+  private boolean isActive = false;
 
   public void fireChange(boolean isActive) {
     Log.d(getLogTag(), "Firing change: " + isActive);
     JSObject data = new JSObject();
     data.put("isActive", isActive);
+    this.isActive = isActive;
     notifyListeners(EVENT_STATE_CHANGE, data, false);
   }
 
@@ -60,6 +62,13 @@ public void getLaunchUrl(PluginCall call) {
     }
   }
 
+  @PluginMethod()
+  public void getState(PluginCall call) {
+    JSObject data = new JSObject();
+    data.put("isActive", this.isActive);
+    call.success(data);
+  }
+
   @PluginMethod()
   public void canOpenUrl(PluginCall call) {
     String url = call.getString("url");

core/src/core-plugin-definitions.ts

@@ -107,6 +107,11 @@ export interface AppPlugin extends Plugin {
    */
   openUrl(options: { url: string }): Promise<{completed: boolean}>;
 
+  /**
+   * Gets the current app state
+   */
+  getState(): Promise<AppState>;
+
   /**
    * Get the URL the app was launched with, if any
    */

core/src/web/app.ts

@@ -1,6 +1,6 @@
 import { WebPlugin } from './index';
 
-import { AppPlugin, AppLaunchUrl } from '../core-plugin-definitions';
+import { AppPlugin, AppLaunchUrl, AppState } from '../core-plugin-definitions';
 
 export class AppPluginWeb extends WebPlugin implements AppPlugin {
   constructor() {
@@ -30,6 +30,10 @@ export class AppPluginWeb extends WebPlugin implements AppPlugin {
     return Promise.resolve({ url: '' });
   }
 
+  getState(): Promise<AppState> {
+    return Promise.resolve({ isActive: document.hidden !== true });
+  }
+
   handleVisibilityChange(): void {
     const data = {
       isActive: document.hidden !== true

electron/src/electron/app.ts

@@ -1,6 +1,7 @@
-import { WebPlugin, AppPlugin, AppLaunchUrl } from '@capacitor/core';
+import { WebPlugin, AppPlugin, AppPluginWeb, AppLaunchUrl, AppState } from '@capacitor/core';
 
 const { remote, shell } = require('electron');
+const webApp = new AppPluginWeb();
 
 export class AppPluginElectron extends WebPlugin implements AppPlugin {
   constructor() {
@@ -25,6 +26,9 @@ export class AppPluginElectron extends WebPlugin implements AppPlugin {
   getLaunchUrl(): Promise<AppLaunchUrl> {
     throw new Error('Method not implemented.');
   }
+  getState(): Promise<AppState> {
+    return webApp.getState();
+  }
 }
 
 const App = new AppPluginElectron();

ios/Capacitor/Capacitor/Plugins/App.swift

@@ -53,7 +53,7 @@ public class CAPAppPlugin : CAPPlugin {
   @objc func exitApp(_ call: CAPPluginCall) {
     call.unimplemented()
   }
-  
+
   @objc func getLaunchUrl(_ call: CAPPluginCall) {
     if let lastUrl = CAPBridge.getLastUrl() {
       let urlValue = lastUrl.absoluteString
@@ -63,7 +63,15 @@ public class CAPAppPlugin : CAPPlugin {
     }
     call.resolve()
   }
-
+
+  @objc func getState(_ call: CAPPluginCall) {
+    DispatchQueue.main.async {
+      call.resolve([
+        "isActive": UIApplication.shared.applicationState == UIApplication.State.active
+      ])
+    }
+  }
+
   @objc func canOpenUrl(_ call: CAPPluginCall) {
     guard let urlString = call.getString("url") else {
       call.error("Must supply a URL")

ios/Capacitor/Capacitor/Plugins/DefaultPlugins.m

@@ -11,6 +11,7 @@
 CAP_PLUGIN(CAPAppPlugin, "App",
   CAP_PLUGIN_METHOD(exitApp, CAPPluginReturnNone);
   CAP_PLUGIN_METHOD(getLaunchUrl, CAPPluginReturnPromise);
+  CAP_PLUGIN_METHOD(getState, CAPPluginReturnPromise);
   CAP_PLUGIN_METHOD(canOpenUrl, CAPPluginReturnPromise);
   CAP_PLUGIN_METHOD(openUrl, CAPPluginReturnPromise);
   CAP_PLUGIN_METHOD(removeAllListeners, CAPPluginReturnNone);