@capawesome/capacitor-device-info 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/deviceinfo/classes/results/GetInfoResult.java

@@ -0,0 +1,98 @@
+package io.capawesome.capacitorjs.plugins.deviceinfo.classes.results;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.deviceinfo.interfaces.Result;
+import org.json.JSONObject;
+
+public class GetInfoResult implements Result {
+
+    @Nullable
+    private final Integer androidSdkVersion;
+
+    @NonNull
+    private final String deviceType;
+
+    @Nullable
+    private final Integer iosVersion;
+
+    private final boolean isVirtual;
+
+    @NonNull
+    private final String manufacturer;
+
+    @NonNull
+    private final String model;
+
+    @Nullable
+    private final String name;
+
+    @NonNull
+    private final String operatingSystem;
+
+    @NonNull
+    private final String osVersion;
+
+    @NonNull
+    private final String platform;
+
+    @Nullable
+    private final Long totalMemory;
+
+    @Nullable
+    private final Long usedMemory;
+
+    @Nullable
+    private final String webViewVersion;
+
+    public GetInfoResult(
+        @Nullable Integer androidSdkVersion,
+        @NonNull String deviceType,
+        @Nullable Integer iosVersion,
+        boolean isVirtual,
+        @NonNull String manufacturer,
+        @NonNull String model,
+        @Nullable String name,
+        @NonNull String operatingSystem,
+        @NonNull String osVersion,
+        @NonNull String platform,
+        @Nullable Long totalMemory,
+        @Nullable Long usedMemory,
+        @Nullable String webViewVersion
+    ) {
+        this.androidSdkVersion = androidSdkVersion;
+        this.deviceType = deviceType;
+        this.iosVersion = iosVersion;
+        this.isVirtual = isVirtual;
+        this.manufacturer = manufacturer;
+        this.model = model;
+        this.name = name;
+        this.operatingSystem = operatingSystem;
+        this.osVersion = osVersion;
+        this.platform = platform;
+        this.totalMemory = totalMemory;
+        this.usedMemory = usedMemory;
+        this.webViewVersion = webViewVersion;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("androidSdkVersion", androidSdkVersion == null ? JSONObject.NULL : androidSdkVersion);
+        result.put("deviceType", deviceType);
+        result.put("iosVersion", iosVersion == null ? JSONObject.NULL : iosVersion);
+        result.put("isVirtual", isVirtual);
+        result.put("manufacturer", manufacturer);
+        result.put("model", model);
+        result.put("name", name == null ? JSONObject.NULL : name);
+        result.put("operatingSystem", operatingSystem);
+        result.put("osVersion", osVersion);
+        result.put("platform", platform);
+        result.put("totalMemory", totalMemory == null ? JSONObject.NULL : totalMemory);
+        result.put("usedMemory", usedMemory == null ? JSONObject.NULL : usedMemory);
+        result.put("webViewVersion", webViewVersion == null ? JSONObject.NULL : webViewVersion);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/deviceinfo/classes/results/GetUptimeResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.deviceinfo.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.deviceinfo.interfaces.Result;
+
+public class GetUptimeResult implements Result {
+
+    private final long uptime;
+
+    public GetUptimeResult(long uptime) {
+        this.uptime = uptime;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("uptime", uptime);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/deviceinfo/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.deviceinfo.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/deviceinfo/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.deviceinfo.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/deviceinfo/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.deviceinfo.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}

package/dist/docs.json

@@ -0,0 +1,413 @@
+{
+  "api": {
+    "name": "DeviceInfoPlugin",
+    "slug": "deviceinfoplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "getId",
+        "signature": "() => Promise<GetIdResult>",
+        "parameters": [],
+        "returns": "Promise<GetIdResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get a unique identifier for the device.\n\nOn **Android**, the identifier is the `ANDROID_ID` value, which is unique\nper app-signing key, user, and device. It is reset when the app is\nreinstalled after the signing key changes or the device is factory reset.\n\nOn **iOS**, the identifier is the `identifierForVendor` value, which is\nunique per vendor and device. It is reset when all apps from the vendor are\nuninstalled.\n\nOn **Web**, the identifier is a random UUID that is persisted in the\nbrowser's `localStorage`. It is reset when the browser storage is cleared.",
+        "complexTypes": [
+          "GetIdResult"
+        ],
+        "slug": "getid"
+      },
+      {
+        "name": "getInfo",
+        "signature": "() => Promise<GetInfoResult>",
+        "parameters": [],
+        "returns": "Promise<GetInfoResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get information about the device.",
+        "complexTypes": [
+          "GetInfoResult"
+        ],
+        "slug": "getinfo"
+      },
+      {
+        "name": "getUptime",
+        "signature": "() => Promise<GetUptimeResult>",
+        "parameters": [],
+        "returns": "Promise<GetUptimeResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the time the device has been running since its last boot, in\nmilliseconds.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetUptimeResult"
+        ],
+        "slug": "getuptime"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "GetIdResult",
+      "slug": "getidresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [
+            {
+              "text": "'2f60cd8d-3b6a-4b3c-8f2e-1a2b3c4d5e6f'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the device.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetInfoResult",
+      "slug": "getinforesult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "androidSdkVersion",
+          "tags": [
+            {
+              "text": "34",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The Android SDK version number (API level).\n\nReturns `null` on platforms other than Android.\n\nOnly available on Android.",
+          "complexTypes": [],
+          "type": "number | null"
+        },
+        {
+          "name": "deviceType",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The type of the device.",
+          "complexTypes": [
+            "DeviceType"
+          ],
+          "type": "DeviceType"
+        },
+        {
+          "name": "iosVersion",
+          "tags": [
+            {
+              "text": "17",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The major version number of iOS.\n\nReturns `null` on platforms other than iOS.\n\nOnly available on iOS.",
+          "complexTypes": [],
+          "type": "number | null"
+        },
+        {
+          "name": "isVirtual",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the app is running on a virtual device (simulator or emulator).",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "manufacturer",
+          "tags": [
+            {
+              "text": "'Apple'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The manufacturer of the device.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "model",
+          "tags": [
+            {
+              "text": "'iPhone13,4'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The model identifier of the device.\n\nOn **iOS**, this is the internal model identifier (e.g. `iPhone13,4`), not\nthe marketing name.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "'iPhone'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the device.\n\nOn **iOS 16 and newer**, a generic device name (e.g. `iPhone`) is returned\nunless the app has the required entitlement.\n\nReturns `null` if the name cannot be determined.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "operatingSystem",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The operating system of the device.",
+          "complexTypes": [
+            "OperatingSystem"
+          ],
+          "type": "OperatingSystem"
+        },
+        {
+          "name": "osVersion",
+          "tags": [
+            {
+              "text": "'17.5'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The version of the operating system.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "platform",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The platform the app is running on.",
+          "complexTypes": [
+            "Platform"
+          ],
+          "type": "Platform"
+        },
+        {
+          "name": "totalMemory",
+          "tags": [
+            {
+              "text": "4294967296",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The total amount of memory of the device, in bytes.\n\nReturns `null` if the total memory cannot be determined.\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "number | null"
+        },
+        {
+          "name": "usedMemory",
+          "tags": [
+            {
+              "text": "134217728",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The amount of memory used by the app, in bytes.\n\nReturns `null` if the used memory cannot be determined.\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "number | null"
+        },
+        {
+          "name": "webViewVersion",
+          "tags": [
+            {
+              "text": "'126.0.6478.40'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The version of the WebView that renders the app.\n\nOn **iOS**, the version of the operating system is returned, because the\nWebKit version is tied to it.\n\nReturns `null` if the WebView version cannot be determined.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetUptimeResult",
+      "slug": "getuptimeresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "uptime",
+          "tags": [
+            {
+              "text": "123456789",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The time the device has been running since its last boot, in milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "DeviceType",
+      "slug": "devicetype",
+      "docs": "The type of a device.\n\n- `phone`: A handheld phone-sized device.\n- `tablet`: A tablet-sized device.\n- `desktop`: A desktop or laptop computer.\n- `tv`: A television or set-top box.\n- `unknown`: The type could not be determined.",
+      "types": [
+        {
+          "text": "'phone'",
+          "complexTypes": []
+        },
+        {
+          "text": "'tablet'",
+          "complexTypes": []
+        },
+        {
+          "text": "'desktop'",
+          "complexTypes": []
+        },
+        {
+          "text": "'tv'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "OperatingSystem",
+      "slug": "operatingsystem",
+      "docs": "The operating system of a device.",
+      "types": [
+        {
+          "text": "'android'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ios'",
+          "complexTypes": []
+        },
+        {
+          "text": "'windows'",
+          "complexTypes": []
+        },
+        {
+          "text": "'mac'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "Platform",
+      "slug": "platform",
+      "docs": "The platform an app is running on.",
+      "types": [
+        {
+          "text": "'android'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ios'",
+          "complexTypes": []
+        },
+        {
+          "text": "'web'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}