@capgo/capacitor-intent-launcher 0.0.1

package/dist/docs.json

@@ -0,0 +1,455 @@
+{
+  "api": {
+    "name": "IntentLauncherPlugin",
+    "slug": "intentlauncherplugin",
+    "docs": "Capacitor Intent Launcher Plugin for launching Android intents and opening system settings.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "startActivityAsync",
+        "signature": "(options: IntentLauncherParams) => Promise<IntentLauncherResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The intent launch options including action and optional parameters",
+            "type": "IntentLauncherParams"
+          }
+        ],
+        "returns": "Promise<IntentLauncherResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The intent launch options including action and optional parameters"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the result from the activity"
+          },
+          {
+            "name": "throws",
+            "text": "Error if the activity cannot be started or is not available"
+          },
+          {
+            "name": "platform",
+            "text": "Android"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Open location settings\nconst result = await IntentLauncher.startActivityAsync({\n  action: ActivityAction.LOCATION_SOURCE_SETTINGS\n});\n\n// Open a specific app settings\nconst result = await IntentLauncher.startActivityAsync({\n  action: ActivityAction.APPLICATION_DETAILS_SETTINGS,\n  data: 'package:com.example.app'\n});\n```"
+          }
+        ],
+        "docs": "Starts an Android activity for the given action.",
+        "complexTypes": [
+          "IntentLauncherResult",
+          "IntentLauncherParams"
+        ],
+        "slug": "startactivityasync"
+      },
+      {
+        "name": "openApplication",
+        "signature": "(options: OpenApplicationOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The package name of the application to open",
+            "type": "OpenApplicationOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The package name of the application to open"
+          },
+          {
+            "name": "throws",
+            "text": "Error if the application is not installed or cannot be opened"
+          },
+          {
+            "name": "platform",
+            "text": "Android"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Open Gmail app\nawait IntentLauncher.openApplication({ packageName: 'com.google.android.gm' });\n```"
+          }
+        ],
+        "docs": "Opens an application by its package name.",
+        "complexTypes": [
+          "OpenApplicationOptions"
+        ],
+        "slug": "openapplication"
+      },
+      {
+        "name": "getApplicationIconAsync",
+        "signature": "(options: GetApplicationIconOptions) => Promise<GetApplicationIconResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The package name of the application",
+            "type": "GetApplicationIconOptions"
+          }
+        ],
+        "returns": "Promise<GetApplicationIconResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The package name of the application"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the base64 icon data or empty string if unavailable"
+          },
+          {
+            "name": "platform",
+            "text": "Android"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { icon } = await IntentLauncher.getApplicationIconAsync({\n  packageName: 'com.google.android.gm'\n});\nif (icon) {\n  const img = document.createElement('img');\n  img.src = icon;\n}\n```"
+          }
+        ],
+        "docs": "Gets the application icon as a base64-encoded PNG string.",
+        "complexTypes": [
+          "GetApplicationIconResult",
+          "GetApplicationIconOptions"
+        ],
+        "slug": "getapplicationiconasync"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await IntentLauncher.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "IntentLauncherResult",
+      "slug": "intentlauncherresult",
+      "docs": "Result from starting an activity.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "resultCode",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The result code returned by the activity.",
+          "complexTypes": [
+            "ResultCode"
+          ],
+          "type": "ResultCode"
+        },
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional data URI returned by the activity.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "extra",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional extra data returned by the activity.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "IntentLauncherParams",
+      "slug": "intentlauncherparams",
+      "docs": "Options for starting an activity.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "action",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The action to perform. Use values from `ActivityAction` enum.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "category",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional category to add to the intent.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "className",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional class name for the component to launch.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional URI data for the intent. Must be a valid URI.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "extra",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional extra data to pass to the intent as key-value pairs.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        },
+        {
+          "name": "flags",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional intent flags as a bitmask.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "packageName",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional package name for the component.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional MIME type for the intent data.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "OpenApplicationOptions",
+      "slug": "openapplicationoptions",
+      "docs": "Options for opening an application.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "packageName",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The package name of the application to open.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetApplicationIconResult",
+      "slug": "getapplicationiconresult",
+      "docs": "Result from getting an application icon.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "icon",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The application icon as a base64-encoded PNG string prefixed with 'data:image/png;base64,'.\nEmpty string if the icon is not available.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetApplicationIconOptions",
+      "slug": "getapplicationiconoptions",
+      "docs": "Options for getting an application icon.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "packageName",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The package name of the application.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "ResultCode",
+      "slug": "resultcode",
+      "members": [
+        {
+          "name": "Success",
+          "value": "-1",
+          "tags": [],
+          "docs": "The activity completed successfully."
+        },
+        {
+          "name": "Canceled",
+          "value": "0",
+          "tags": [],
+          "docs": "The activity was canceled by the user."
+        },
+        {
+          "name": "FirstUser",
+          "value": "1",
+          "tags": [],
+          "docs": "First custom user-defined result code."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}