@capawesome/capacitor-android-intent-launcher 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/androidintentlauncher/classes/options/IntentOptions.java

@@ -0,0 +1,110 @@
+package io.capawesome.capacitorjs.plugins.androidintentlauncher.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.androidintentlauncher.classes.CustomExceptions;
+import java.util.List;
+import org.json.JSONException;
+
+public class IntentOptions {
+
+    @NonNull
+    private final String action;
+
+    @Nullable
+    private final List<String> categories;
+
+    @Nullable
+    private final String className;
+
+    @Nullable
+    private final String dataUri;
+
+    @Nullable
+    private final JSObject extras;
+
+    @Nullable
+    private final Integer flags;
+
+    @Nullable
+    private final String packageName;
+
+    @Nullable
+    private final String type;
+
+    public IntentOptions(@NonNull PluginCall call) throws Exception {
+        this.action = getActionFromCall(call);
+        this.categories = getCategoriesFromCall(call);
+        this.className = call.getString("className");
+        this.dataUri = call.getString("dataUri");
+        this.extras = call.getObject("extras");
+        this.flags = call.getInt("flags");
+        this.packageName = call.getString("packageName");
+        this.type = call.getString("type");
+    }
+
+    @NonNull
+    public String getAction() {
+        return action;
+    }
+
+    @Nullable
+    public List<String> getCategories() {
+        return categories;
+    }
+
+    @Nullable
+    public String getClassName() {
+        return className;
+    }
+
+    @Nullable
+    public String getDataUri() {
+        return dataUri;
+    }
+
+    @Nullable
+    public JSObject getExtras() {
+        return extras;
+    }
+
+    @Nullable
+    public Integer getFlags() {
+        return flags;
+    }
+
+    @Nullable
+    public String getPackageName() {
+        return packageName;
+    }
+
+    @Nullable
+    public String getType() {
+        return type;
+    }
+
+    @NonNull
+    private static String getActionFromCall(@NonNull PluginCall call) throws Exception {
+        String action = call.getString("action");
+        if (action == null) {
+            throw CustomExceptions.ACTION_MISSING;
+        }
+        return action;
+    }
+
+    @Nullable
+    private static List<String> getCategoriesFromCall(@NonNull PluginCall call) {
+        JSArray categories = call.getArray("categories");
+        if (categories == null) {
+            return null;
+        }
+        try {
+            return categories.toList();
+        } catch (JSONException exception) {
+            return null;
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/androidintentlauncher/classes/results/CanResolveActivityResult.java

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

package/android/src/main/java/io/capawesome/capacitorjs/plugins/androidintentlauncher/classes/results/StartActivityResult.java

@@ -0,0 +1,29 @@
+package io.capawesome.capacitorjs.plugins.androidintentlauncher.classes.results;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.androidintentlauncher.interfaces.Result;
+import org.json.JSONObject;
+
+public class StartActivityResult implements Result {
+
+    @Nullable
+    private final String dataUri;
+
+    private final int resultCode;
+
+    public StartActivityResult(int resultCode, @Nullable String dataUri) {
+        this.resultCode = resultCode;
+        this.dataUri = dataUri;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("resultCode", resultCode);
+        result.put("dataUri", dataUri == null ? JSONObject.NULL : dataUri);
+        return result;
+    }
+}

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

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

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

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.androidintentlauncher.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/androidintentlauncher/interfaces/Result.java

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

package/dist/docs.json

@@ -0,0 +1,296 @@
+{
+  "api": {
+    "name": "AndroidIntentLauncherPlugin",
+    "slug": "androidintentlauncherplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "canResolveActivity",
+        "signature": "(options: CanResolveActivityOptions) => Promise<CanResolveActivityResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartActivityOptions"
+          }
+        ],
+        "returns": "Promise<CanResolveActivityResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check whether an activity exists that can handle the given intent.\n\nThis is a wrapper around the `PackageManager.resolveActivity(...)` API.\n\nOn Android 11 (API level 30) and higher, the result is affected by\npackage visibility. Your app may need to declare matching `<queries>`\nentries in its `AndroidManifest.xml` for the intent to be resolved.\n\nOnly available on Android.",
+        "complexTypes": [
+          "CanResolveActivityResult",
+          "CanResolveActivityOptions"
+        ],
+        "slug": "canresolveactivity"
+      },
+      {
+        "name": "startActivity",
+        "signature": "(options: StartActivityOptions) => Promise<StartActivityResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartActivityOptions"
+          }
+        ],
+        "returns": "Promise<StartActivityResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Launch an activity for the given intent.\n\nThe intent is started via the `startActivityForResult(...)` API so the\nresult code and result data of the launched activity are returned once it\nfinishes.\n\nThis is the power-user escape hatch for system screens and app\nintegrations that no dedicated plugin covers. Prefer a typed plugin (such\nas [Settings Launcher](https://capawesome.io/docs/sdks/capacitor/settings-launcher/)\nor [App Launcher](https://capawesome.io/docs/sdks/capacitor/app-launcher/))\nwhere one exists.\n\nOnly available on Android.",
+        "complexTypes": [
+          "StartActivityResult",
+          "StartActivityOptions"
+        ],
+        "slug": "startactivity"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "CanResolveActivityResult",
+      "slug": "canresolveactivityresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "canResolve",
+          "tags": [
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether or not an activity exists that can handle the intent.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "StartActivityOptions",
+      "slug": "startactivityoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "action",
+          "tags": [
+            {
+              "text": "'android.intent.action.VIEW'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The action of the intent.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "categories",
+          "tags": [
+            {
+              "text": "['android.intent.category.DEFAULT']",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The categories to add to the intent.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "className",
+          "tags": [
+            {
+              "text": "'com.example.app.MainActivity'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The fully qualified class name of the component to launch.\n\nMust be used together with the `packageName` property to create an\nexplicit intent that targets a specific component.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "dataUri",
+          "tags": [
+            {
+              "text": "'https://capawesome.io'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The data URI of the intent.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "extras",
+          "tags": [
+            {
+              "text": "{ 'android.intent.extra.TEXT': 'Hello world!' }",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The extras to add to the intent.\n\nOnly primitive values (string, number and boolean) are supported.",
+          "complexTypes": [],
+          "type": "{ [key: string]: string | number | boolean; } | undefined"
+        },
+        {
+          "name": "flags",
+          "tags": [
+            {
+              "text": "268435456",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The flags to add to the intent.\n\nMultiple flags can be combined using the bitwise OR operator.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "packageName",
+          "tags": [
+            {
+              "text": "'com.example.app'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The package name of the component to launch.\n\nIf used without the `className` property, the intent is restricted to the\ngiven package. If used together with the `className` property, an explicit\nintent that targets a specific component is created.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "'text/plain'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The MIME type of the intent data.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StartActivityResult",
+      "slug": "startactivityresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "dataUri",
+          "tags": [
+            {
+              "text": "'content://com.example.app/1'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The data URI returned by the launched activity.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "resultCode",
+          "tags": [
+            {
+              "text": "-1",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The result code returned by the launched activity.\n\nThe value is `-1` if the activity finished successfully (`RESULT_OK`), `0`\nif it was canceled (`RESULT_CANCELED`) or any other custom result code set\nby the launched activity.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "CanResolveActivityOptions",
+      "slug": "canresolveactivityoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "StartActivityOptions",
+          "complexTypes": [
+            "StartActivityOptions"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,164 @@
+export interface AndroidIntentLauncherPlugin {
+    /**
+     * Check whether an activity exists that can handle the given intent.
+     *
+     * This is a wrapper around the `PackageManager.resolveActivity(...)` API.
+     *
+     * On Android 11 (API level 30) and higher, the result is affected by
+     * package visibility. Your app may need to declare matching `<queries>`
+     * entries in its `AndroidManifest.xml` for the intent to be resolved.
+     *
+     * Only available on Android.
+     *
+     * @since 0.1.0
+     */
+    canResolveActivity(options: CanResolveActivityOptions): Promise<CanResolveActivityResult>;
+    /**
+     * Launch an activity for the given intent.
+     *
+     * The intent is started via the `startActivityForResult(...)` API so the
+     * result code and result data of the launched activity are returned once it
+     * finishes.
+     *
+     * This is the power-user escape hatch for system screens and app
+     * integrations that no dedicated plugin covers. Prefer a typed plugin (such
+     * as [Settings Launcher](https://capawesome.io/docs/sdks/capacitor/settings-launcher/)
+     * or [App Launcher](https://capawesome.io/docs/sdks/capacitor/app-launcher/))
+     * where one exists.
+     *
+     * Only available on Android.
+     *
+     * @since 0.1.0
+     */
+    startActivity(options: StartActivityOptions): Promise<StartActivityResult>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface StartActivityOptions {
+    /**
+     * The action of the intent.
+     *
+     * @example 'android.intent.action.VIEW'
+     * @since 0.1.0
+     */
+    action: string;
+    /**
+     * The categories to add to the intent.
+     *
+     * @example ['android.intent.category.DEFAULT']
+     * @since 0.1.0
+     */
+    categories?: string[];
+    /**
+     * The fully qualified class name of the component to launch.
+     *
+     * Must be used together with the `packageName` property to create an
+     * explicit intent that targets a specific component.
+     *
+     * @example 'com.example.app.MainActivity'
+     * @since 0.1.0
+     */
+    className?: string;
+    /**
+     * The data URI of the intent.
+     *
+     * @example 'https://capawesome.io'
+     * @since 0.1.0
+     */
+    dataUri?: string;
+    /**
+     * The extras to add to the intent.
+     *
+     * Only primitive values (string, number and boolean) are supported.
+     *
+     * @example { 'android.intent.extra.TEXT': 'Hello world!' }
+     * @since 0.1.0
+     */
+    extras?: {
+        [key: string]: string | number | boolean;
+    };
+    /**
+     * The flags to add to the intent.
+     *
+     * Multiple flags can be combined using the bitwise OR operator.
+     *
+     * @example 268435456
+     * @since 0.1.0
+     */
+    flags?: number;
+    /**
+     * The package name of the component to launch.
+     *
+     * If used without the `className` property, the intent is restricted to the
+     * given package. If used together with the `className` property, an explicit
+     * intent that targets a specific component is created.
+     *
+     * @example 'com.example.app'
+     * @since 0.1.0
+     */
+    packageName?: string;
+    /**
+     * The MIME type of the intent data.
+     *
+     * @example 'text/plain'
+     * @since 0.1.0
+     */
+    type?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface StartActivityResult {
+    /**
+     * The data URI returned by the launched activity.
+     *
+     * @example 'content://com.example.app/1'
+     * @since 0.1.0
+     */
+    dataUri: string | null;
+    /**
+     * The result code returned by the launched activity.
+     *
+     * The value is `-1` if the activity finished successfully (`RESULT_OK`), `0`
+     * if it was canceled (`RESULT_CANCELED`) or any other custom result code set
+     * by the launched activity.
+     *
+     * @example -1
+     * @since 0.1.0
+     */
+    resultCode: number;
+}
+/**
+ * @since 0.1.0
+ */
+export type CanResolveActivityOptions = StartActivityOptions;
+/**
+ * @since 0.1.0
+ */
+export interface CanResolveActivityResult {
+    /**
+     * Whether or not an activity exists that can handle the intent.
+     *
+     * @example true
+     * @since 0.1.0
+     */
+    canResolve: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * No activity was found that can handle the intent.
+     *
+     * @since 0.1.0
+     */
+    ActivityNotFound = "ACTIVITY_NOT_FOUND",
+    /**
+     * The activity could not be started.
+     *
+     * @since 0.1.0
+     */
+    StartFailed = "START_FAILED"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,19 @@
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * No activity was found that can handle the intent.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["ActivityNotFound"] = "ACTIVITY_NOT_FOUND";
+    /**
+     * The activity could not be started.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["StartFailed"] = "START_FAILED";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAwJA;;GAEG;AACH,MAAM,CAAN,IAAY,SAaX;AAbD,WAAY,SAAS;IACnB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC;;;;OAIG;IACH,yCAA4B,CAAA;AAC9B,CAAC,EAbW,SAAS,KAAT,SAAS,QAapB","sourcesContent":["export interface AndroidIntentLauncherPlugin {\n  /**\n   * Check whether an activity exists that can handle the given intent.\n   *\n   * This is a wrapper around the `PackageManager.resolveActivity(...)` API.\n   *\n   * On Android 11 (API level 30) and higher, the result is affected by\n   * package visibility. Your app may need to declare matching `<queries>`\n   * entries in its `AndroidManifest.xml` for the intent to be resolved.\n   *\n   * Only available on Android.\n   *\n   * @since 0.1.0\n   */\n  canResolveActivity(\n    options: CanResolveActivityOptions,\n  ): Promise<CanResolveActivityResult>;\n  /**\n   * Launch an activity for the given intent.\n   *\n   * The intent is started via the `startActivityForResult(...)` API so the\n   * result code and result data of the launched activity are returned once it\n   * finishes.\n   *\n   * This is the power-user escape hatch for system screens and app\n   * integrations that no dedicated plugin covers. Prefer a typed plugin (such\n   * as [Settings Launcher](https://capawesome.io/docs/sdks/capacitor/settings-launcher/)\n   * or [App Launcher](https://capawesome.io/docs/sdks/capacitor/app-launcher/))\n   * where one exists.\n   *\n   * Only available on Android.\n   *\n   * @since 0.1.0\n   */\n  startActivity(options: StartActivityOptions): Promise<StartActivityResult>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface StartActivityOptions {\n  /**\n   * The action of the intent.\n   *\n   * @example 'android.intent.action.VIEW'\n   * @since 0.1.0\n   */\n  action: string;\n  /**\n   * The categories to add to the intent.\n   *\n   * @example ['android.intent.category.DEFAULT']\n   * @since 0.1.0\n   */\n  categories?: string[];\n  /**\n   * The fully qualified class name of the component to launch.\n   *\n   * Must be used together with the `packageName` property to create an\n   * explicit intent that targets a specific component.\n   *\n   * @example 'com.example.app.MainActivity'\n   * @since 0.1.0\n   */\n  className?: string;\n  /**\n   * The data URI of the intent.\n   *\n   * @example 'https://capawesome.io'\n   * @since 0.1.0\n   */\n  dataUri?: string;\n  /**\n   * The extras to add to the intent.\n   *\n   * Only primitive values (string, number and boolean) are supported.\n   *\n   * @example { 'android.intent.extra.TEXT': 'Hello world!' }\n   * @since 0.1.0\n   */\n  extras?: { [key: string]: string | number | boolean };\n  /**\n   * The flags to add to the intent.\n   *\n   * Multiple flags can be combined using the bitwise OR operator.\n   *\n   * @example 268435456\n   * @since 0.1.0\n   */\n  flags?: number;\n  /**\n   * The package name of the component to launch.\n   *\n   * If used without the `className` property, the intent is restricted to the\n   * given package. If used together with the `className` property, an explicit\n   * intent that targets a specific component is created.\n   *\n   * @example 'com.example.app'\n   * @since 0.1.0\n   */\n  packageName?: string;\n  /**\n   * The MIME type of the intent data.\n   *\n   * @example 'text/plain'\n   * @since 0.1.0\n   */\n  type?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface StartActivityResult {\n  /**\n   * The data URI returned by the launched activity.\n   *\n   * @example 'content://com.example.app/1'\n   * @since 0.1.0\n   */\n  dataUri: string | null;\n  /**\n   * The result code returned by the launched activity.\n   *\n   * The value is `-1` if the activity finished successfully (`RESULT_OK`), `0`\n   * if it was canceled (`RESULT_CANCELED`) or any other custom result code set\n   * by the launched activity.\n   *\n   * @example -1\n   * @since 0.1.0\n   */\n  resultCode: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport type CanResolveActivityOptions = StartActivityOptions;\n\n/**\n * @since 0.1.0\n */\nexport interface CanResolveActivityResult {\n  /**\n   * Whether or not an activity exists that can handle the intent.\n   *\n   * @example true\n   * @since 0.1.0\n   */\n  canResolve: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * No activity was found that can handle the intent.\n   *\n   * @since 0.1.0\n   */\n  ActivityNotFound = 'ACTIVITY_NOT_FOUND',\n  /**\n   * The activity could not be started.\n   *\n   * @since 0.1.0\n   */\n  StartFailed = 'START_FAILED',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { AndroidIntentLauncherPlugin } from './definitions';
+declare const AndroidIntentLauncher: AndroidIntentLauncherPlugin;
+export * from './definitions';
+export { AndroidIntentLauncher };