@capgo/capacitor-file-picker 8.0.0

package/dist/docs.json

@@ -0,0 +1,804 @@
+{
+  "api": {
+    "name": "CapgoFilePickerPlugin",
+    "slug": "capgofilepickerplugin",
+    "docs": "Capacitor File Picker Plugin interface for selecting files, images, videos, and directories.",
+    "tags": [
+      {
+        "text": "8.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "pickFiles",
+        "signature": "(options?: PickFilesOptions | undefined) => Promise<PickFilesResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for picking files",
+            "type": "PickFilesOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PickFilesResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Options for picking files"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the picked files"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapgoFilePicker.pickFiles({\n  types: ['application/pdf', 'image/*'],\n  limit: 5,\n  readData: false\n});\nconsole.log('Picked files:', result.files);\n```"
+          }
+        ],
+        "docs": "Pick one or more files from the device.",
+        "complexTypes": [
+          "PickFilesResult",
+          "PickFilesOptions"
+        ],
+        "slug": "pickfiles"
+      },
+      {
+        "name": "pickImages",
+        "signature": "(options?: PickMediaOptions | undefined) => Promise<PickFilesResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for picking images",
+            "type": "PickMediaOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PickFilesResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Options for picking images"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the picked images"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapgoFilePicker.pickImages({\n  limit: 10,\n  readData: false\n});\nconsole.log('Picked images:', result.files);\n```"
+          }
+        ],
+        "docs": "Pick one or more images from the gallery.\nAndroid/iOS only.",
+        "complexTypes": [
+          "PickFilesResult",
+          "PickMediaOptions"
+        ],
+        "slug": "pickimages"
+      },
+      {
+        "name": "pickVideos",
+        "signature": "(options?: PickMediaOptions | undefined) => Promise<PickFilesResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for picking videos",
+            "type": "PickMediaOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PickFilesResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Options for picking videos"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the picked videos"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapgoFilePicker.pickVideos({\n  limit: 3,\n  skipTranscoding: true\n});\nconsole.log('Picked videos:', result.files);\n```"
+          }
+        ],
+        "docs": "Pick one or more videos from the gallery.\nAndroid/iOS only.",
+        "complexTypes": [
+          "PickFilesResult",
+          "PickMediaOptions"
+        ],
+        "slug": "pickvideos"
+      },
+      {
+        "name": "pickMedia",
+        "signature": "(options?: PickMediaOptions | undefined) => Promise<PickFilesResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for picking media",
+            "type": "PickMediaOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PickFilesResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Options for picking media"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the picked media files"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapgoFilePicker.pickMedia({\n  limit: 5,\n  readData: true\n});\nconsole.log('Picked media:', result.files);\n```"
+          }
+        ],
+        "docs": "Pick one or more images or videos from the gallery.\nAndroid/iOS only.",
+        "complexTypes": [
+          "PickFilesResult",
+          "PickMediaOptions"
+        ],
+        "slug": "pickmedia"
+      },
+      {
+        "name": "pickDirectory",
+        "signature": "() => Promise<PickDirectoryResult>",
+        "parameters": [],
+        "returns": "Promise<PickDirectoryResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the picked directory path"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapgoFilePicker.pickDirectory();\nconsole.log('Selected directory:', result.path);\n```"
+          }
+        ],
+        "docs": "Pick a directory from the device.\nAndroid/iOS only.",
+        "complexTypes": [
+          "PickDirectoryResult"
+        ],
+        "slug": "pickdirectory"
+      },
+      {
+        "name": "convertHeicToJpeg",
+        "signature": "(options: ConvertHeicToJpegOptions) => Promise<ConvertHeicToJpegResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for the conversion",
+            "type": "ConvertHeicToJpegOptions"
+          }
+        ],
+        "returns": "Promise<ConvertHeicToJpegResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Options for the conversion"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the converted file path"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapgoFilePicker.convertHeicToJpeg({\n  path: '/path/to/image.heic',\n  quality: 0.9\n});\nconsole.log('Converted file:', result.path);\n```"
+          }
+        ],
+        "docs": "Convert a HEIC image to JPEG format.\niOS only.",
+        "complexTypes": [
+          "ConvertHeicToJpegResult",
+          "ConvertHeicToJpegOptions"
+        ],
+        "slug": "convertheictojpeg"
+      },
+      {
+        "name": "copyFile",
+        "signature": "(options: CopyFileOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for copying the file",
+            "type": "CopyFileOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Options for copying the file"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the copy is complete"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoFilePicker.copyFile({\n  from: '/source/file.pdf',\n  to: '/destination/file.pdf',\n  overwrite: true\n});\n```"
+          }
+        ],
+        "docs": "Copy a file to a new location.",
+        "complexTypes": [
+          "CopyFileOptions"
+        ],
+        "slug": "copyfile"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the permission status"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst status = await CapgoFilePicker.checkPermissions();\nconsole.log('Read permission:', status.readExternalStorage);\n```"
+          }
+        ],
+        "docs": "Check permissions for reading files.\nAndroid only.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the permission status"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst status = await CapgoFilePicker.requestPermissions();\nif (status.readExternalStorage === 'granted') {\n  console.log('Permission granted');\n}\n```"
+          }
+        ],
+        "docs": "Request permissions for reading files.\nAndroid only.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'pickerDismissed', listenerFunc: PickerDismissedListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'pickerDismissed'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The listener function",
+            "type": "PickerDismissedListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The listener function"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the listener handle"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Add a listener for the picker dismissed event.\niOS only.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PickerDismissedListener"
+        ],
+        "slug": "addlistenerpickerdismissed-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapgoFilePicker.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PickFilesResult",
+      "slug": "pickfilesresult",
+      "docs": "Result of picking files.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "files",
+          "tags": [],
+          "docs": "Array of picked files",
+          "complexTypes": [
+            "PickedFile"
+          ],
+          "type": "PickedFile[]"
+        }
+      ]
+    },
+    {
+      "name": "PickedFile",
+      "slug": "pickedfile",
+      "docs": "Represents a picked file.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "The name of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "The path to the file",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "mimeType",
+          "tags": [],
+          "docs": "The MIME type of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "size",
+          "tags": [],
+          "docs": "The size of the file in bytes",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "data",
+          "tags": [],
+          "docs": "The base64 encoded data of the file.\nOnly present if readData was true.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "blob",
+          "tags": [],
+          "docs": "The Blob instance of the file.\nWeb only.",
+          "complexTypes": [
+            "Blob"
+          ],
+          "type": "Blob"
+        },
+        {
+          "name": "width",
+          "tags": [],
+          "docs": "Width in pixels (images/videos only)",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "height",
+          "tags": [],
+          "docs": "Height in pixels (images/videos only)",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Duration in seconds (videos only)",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "modifiedAt",
+          "tags": [],
+          "docs": "Last modified timestamp in milliseconds",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PickFilesOptions",
+      "slug": "pickfilesoptions",
+      "docs": "Options for picking files.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "types",
+          "tags": [],
+          "docs": "List of accepted MIME types or file extensions.\nOn iOS, only MIME types are supported.\nExamples: ['image/*'], ['application/pdf'], ['.pdf', '.doc']",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "limit",
+          "tags": [
+            {
+              "text": "0",
+              "name": "default"
+            }
+          ],
+          "docs": "Maximum number of files to pick.\nSet to 0 for unlimited (platform default).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "readData",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether to read the file data as base64.\nNote: Reading large files may cause memory issues.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PickMediaOptions",
+      "slug": "pickmediaoptions",
+      "docs": "Options for picking media (images/videos).",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "limit",
+          "tags": [
+            {
+              "text": "0",
+              "name": "default"
+            }
+          ],
+          "docs": "Maximum number of files to pick.\nSet to 0 for unlimited (platform default).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "readData",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether to read the file data as base64.\nNote: Reading large files may cause memory issues.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "skipTranscoding",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "iOS only: Skip transcoding of videos.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "ordered",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "iOS 15+ only: Show ordered selection badges.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PickDirectoryResult",
+      "slug": "pickdirectoryresult",
+      "docs": "Result of picking a directory.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "The path to the selected directory",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ConvertHeicToJpegResult",
+      "slug": "convertheictojpegresult",
+      "docs": "Result of HEIC to JPEG conversion.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "The path to the converted JPEG file",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ConvertHeicToJpegOptions",
+      "slug": "convertheictojpegoptions",
+      "docs": "Options for converting HEIC to JPEG.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "The path to the HEIC file to convert",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "quality",
+          "tags": [
+            {
+              "text": "0.9",
+              "name": "default"
+            }
+          ],
+          "docs": "The compression quality for JPEG (0.0 - 1.0).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "CopyFileOptions",
+      "slug": "copyfileoptions",
+      "docs": "Options for copying a file.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "from",
+          "tags": [],
+          "docs": "Source file path",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "to",
+          "tags": [],
+          "docs": "Destination file path",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "overwrite",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether to overwrite if destination exists.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "Permission status for file access.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "readExternalStorage",
+          "tags": [],
+          "docs": "Whether permission to read media files is granted",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "accessMediaLocation",
+          "tags": [],
+          "docs": "Whether permission to access media location is granted",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PickerDismissedListener",
+      "slug": "pickerdismissedlistener",
+      "docs": "Listener callback for picker dismissed event.",
+      "types": [
+        {
+          "text": "(event: null): void",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}