Resumen
Sección titulada “Resumen”El plugin de archivo Capacitor implementa operaciones del sistema de archivos similares al plugin de archivo de Cordova.
Capacidades básicas
Sección titulada “Capacidades básicas”requestFileSystem- Solicite un sistema de archivos.resolveLocalFileSystemURL- Resuelva una URL de archivo a una entrada.getFile- Obtenga una entrada de archivo.getDirectory- Obtenga una entrada de directorio.
Público API
Sección titulada “Público API”| Método | Descripción |
|---|---|
requestFileSystem | Solicite un sistema de archivos. |
resolveLocalFileSystemURL | Resuelva una URL de archivo a una entrada. |
getFile | Obtenga una entrada de archivo. |
getDirectory | Obtenga una entrada de directorio. |
readFile | Leer un archivo como texto o base64. |
readAsDataURL | Leer un archivo como una URL de datos (base64 con prefijo de tipo MIME). |
writeFile | Escribir datos en un archivo. |
appendFile | Agregar datos a un archivo. |
deleteFile | Eliminar un archivo. |
mkdir | Crear un directorio. |
rmdir | Eliminar un directorio. |
readdir | Leer los contenidos 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 de un archivo. |
truncate | Truncar un archivo a un tamaño especificado. |
getDirectories | Obtener todos los directorios del sistema de archivos conocidos. |
getFreeDiskSpace | Obtener el espacio libre en disco en bytes. |
addListener | Escuchar eventos de progreso de lectura. |
addListener | Escuchar eventos de progreso de escritura. |
removeAllListeners | Eliminar todos los escuchadores de eventos. |
getPluginVersion | Obtener la versión del plugin. |
checkPermissions | Comprobar 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 | Solicitar 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
Sección titulada “Valores de Referencia”Utiliza estos valores al elegir una ubicación de almacenamiento, al escribir texto codificado o al 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 | Datos de la aplicación persistentes que no son visibles para el usuario. En Android, esto se mapea al directorio de archivos de la aplicación. |
CACHE | Datos de caché temporales que el sistema operativo puede eliminar. |
EXTERNAL | Almacenamiento externo de Android, como una tarjeta SD o almacenamiento externo compartido. |
EXTERNAL_STORAGE | Directorio de datos de almacenamiento externo de Android. |
APPLICATION | Directorio de paquete o recursos de la aplicación en solo lectura. |
Codificaciones
Sección titulada “Codificaciones”| Valor | Usar |
|---|---|
utf8 | Texto en UTF-8. |
ascii | Texto en ASCII. |
utf16 | Texto en UTF-16. |
Códigos de errores de archivo
Sección titulada “Códigos de errores de archivo”| Valor | Code | Significado |
|---|---|---|
NOT_FOUND_ERR | 1 | No se encontró el archivo o directorio. |
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 código de encabezado es inválido o no es compatible. |
NO_MODIFICATION_ALLOWED_ERR | 6 | El objetivo no puede ser modificado. |
INVALID_STATE_ERR | 7 | El objeto se encuentra en un estado inválido para la operación. |
SYNTAX_ERR | 8 | La ruta o la sintaxis de entrada es inválida. |
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 | Tipo de valor no coincide con el tipo esperado. |
PATH_EXISTS_ERR | 12 | El camino objetivo ya existe. |
Fuente de Verdad
Sección titulada “Fuente de Verdad”Esta referencia se sincroniza 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-file para la capacidad nativa en Usando @capgo/capacitor-file, @capgo/capacitor-almacenamiento-de-datos-sqlite para el detalle de implementación en @capgo/capacitor-almacenamiento-de-datos-sqlite, Usando @capgo/capacitor-almacenamiento-de-datos-sqlite para la capacidad nativa en Usando @capgo/capacitor-almacenamiento-de-datos-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.