Resumen
Sección titulada “Resumen”Capacitor Plugin de archivo Implementa operaciones del sistema de archivos similares al plugin de archivo de Cordova.
Capacidades básicas
Sección titulada “Capacidades básicas”requestFileSystem- Solicitar un sistema de archivos.resolveLocalFileSystemURL- Resolver una URL de archivo a una entrada.getFile- Obtener una entrada de archivo.getDirectory- Obtén una entrada de directorio.
Público API
Sección titulada “Público API”| Método | Descripción |
|---|---|
requestFileSystem | Solicita un sistema de archivos. |
resolveLocalFileSystemURL | Resuelve una URL de archivo a una entrada. |
getFile | Obtén una entrada de archivo. |
getDirectory | Obtén una entrada de directorio. |
readFile | Lee un archivo como texto o base64. |
readAsDataURL | Lee un archivo como una URL de datos (base64 con prefijo MIME). |
writeFile | Escribe datos en un archivo. |
appendFile | Anexar datos a un archivo. |
deleteFile | Eliminar un archivo. |
mkdir | Crear un directorio. |
rmdir | Eliminar un directorio. |
readdir | Leer el contenido de un directorio. |
stat | Obtener metadatos sobre un archivo o directorio. |
getMetadata | Obtener metadatos sobre un archivo o directorio. Alias para stat(). |
rename | Renombrar o mover un archivo o directorio. |
move | Mover un archivo o directorio. Alias para rename(). |
copy | Copiar un archivo o directorio. |
exists | Comprobar si existe un archivo o directorio. |
getUri | Obtener la URI para un archivo. |
truncate | Reduzca un archivo a un tamaño especificado. |
getDirectories | Get all known file system directories. |
getFreeDiskSpace | Obtenga el espacio libre en disco en bytes. |
addListener | Escuche eventos de progreso de lectura. |
addListener | Escuche eventos de progreso de escritura. |
removeAllListeners | Elimine todos los escuchadores de eventos. |
getPluginVersion | Obtenga la versión del complemento. |
checkPermissions | Verifique el estado de permiso actual para operaciones de archivo. En Android, esto verifica las permisos de almacenamiento externo. En iOS y web, siempre devuelve ‘concedido’ ya que no se necesitan permisos especiales. |
requestPermissions | Solicite permisos para operaciones de archivo. En Android, esto solicita permisos de almacenamiento externo necesarios para acceder a archivos fuera de los directorios privados del aplicativo. En iOS y web, siempre devuelve ‘concedido’ ya que no se necesitan permisos especiales. |
Valores de Referencia
Título de la sección “Valores de Referencia”Utilice estos valores al elegir una ubicación de almacenamiento, escribir texto codificado o manejar errores de archivo.
Directorios
Sección titulada “Directorios”| Valor | El usuario encontrará |
|---|---|
DOCUMENTS | Documentos persistentes visibles para el usuario. En Android, esto se mapea al directorio de archivos de la aplicación. |
DATA | Datos de la aplicación privados persistentes. |
LIBRARY | Persistent app data that is not user-visible. On Android this maps to the app files directory. |
CACHE | Datos de caché temporal que el sistema operativo puede eliminar. |
EXTERNAL | Raíz de almacenamiento externo de Android, como una tarjeta SD o almacenamiento externo compartido. |
EXTERNAL_STORAGE | Directorio de datos de almacenamiento externo de Android. |
APPLICATION | Paquete de aplicación de solo lectura o directorio de recursos. |
Encodings
Sección titulada “Codificaciones”| Valor | Usar |
|---|---|
utf8 | Texto UTF-8. |
ascii | Texto ASCII. |
utf16 | Texto UTF-16. |
Códigos de errores de archivo
Sección titulada “Códigos de errores de archivo”| Valor | Code | Significado |
|---|---|---|
NOT_FOUND_ERR | 1 | El archivo o directorio no se encontró. |
SECURITY_ERR | 2 | La operación fue bloqueada por reglas de seguridad o permisos. |
ABORT_ERR | 3 | La operación fue abortada. |
NOT_READABLE_ERR | 4 | No se puede leer el archivo o directorio. |
ENCODING_ERR | 5 | El codificado es inválido o no es compatible. |
NO_MODIFICATION_ALLOWED_ERR | 6 | No se puede modificar el objetivo. |
INVALID_STATE_ERR | 7 | El objeto se encuentra en un estado inválido para la operación. |
SYNTAX_ERR | 8 | El camino o la sintaxis de entrada es inválido. |
INVALID_MODIFICATION_ERR | 9 | La solicitud de cambio es inválida para el objetivo. |
QUOTA_EXCEEDED_ERR | 10 | Se superó la cuota de almacenamiento. |
TYPE_MISMATCH_ERR | 11 | El tipo de valor no coincide con el tipo esperado. |
PATH_EXISTS_ERR | 12 | El camino del objetivo ya existe. |
Fuente de Verdad
Sección titulada “Fuente de Verdad”Esta referencia está sincronizada desde src/definitions.ts en capacitor-archivo.
Sigue adelante desde @capgo/capacitor-archivo
Sección titulada “Sigue adelante desde @capgo/capacitor-archivo”Si estás utilizando @capgo/capacitor-archivo para planificar el almacenamiento y el manejo de archivos, conecta con Usando @capgo/capacitor-archivo para la capacidad nativa en Usando @capgo/capacitor-archivo, @capgo/capacitor-almacenamiento-de-datos-sqlite para el detalle de implementación en @capgo/capacitor-almacenamiento-sqlite, Usando @capgo/capacitor-almacenamiento-sqlite para la capacidad nativa en Usando @capgo/capacitor-almacenamiento-sqlite, @capgo/capacitor-subidor para el detalle de implementación en @capgo/capacitor-subidor, y Usando @capgo/capacitor-subidor para la capacidad nativa en Usando @capgo/capacitor-subidor.