Saltar al contenido

@capgo/capacitor-archivo

Capacitor Plugin de archivo Implementa operaciones del sistema de archivos similares al plugin de archivo de Cordova.

El plugin de archivo Capacitor implementa operaciones del sistema de archivos similares al plugin de archivo de Cordova.

  • 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.
MétodoDescripción
requestFileSystemSolicite un sistema de archivos.
resolveLocalFileSystemURLResuelva una URL de archivo a una entrada.
getFileObtenga una entrada de archivo.
getDirectoryObtenga una entrada de directorio.
readFileLeer un archivo como texto o base64.
readAsDataURLLeer un archivo como una URL de datos (base64 con prefijo de tipo MIME).
writeFileEscribir datos en un archivo.
appendFileAgregar datos a un archivo.
deleteFileEliminar un archivo.
mkdirCrear un directorio.
rmdirEliminar un directorio.
readdirLeer los contenidos de un directorio.
statObtener metadatos sobre un archivo o directorio.
getMetadataObtener metadatos sobre un archivo o directorio. Alias para stat().
renameRenombrar o mover un archivo o directorio.
moveMover un archivo o directorio. Alias para rename().
copyCopiar un archivo o directorio.
existsComprobar si existe un archivo o directorio.
getUriObtener la URI de un archivo.
truncateTruncar un archivo a un tamaño especificado.
getDirectoriesObtener todos los directorios del sistema de archivos conocidos.
getFreeDiskSpaceObtener el espacio libre en disco en bytes.
addListenerEscuchar eventos de progreso de lectura.
addListenerEscuchar eventos de progreso de escritura.
removeAllListenersEliminar todos los escuchadores de eventos.
getPluginVersionObtener la versión del plugin.
checkPermissionsComprobar 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.
requestPermissionsSolicitar 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.

Utiliza estos valores al elegir una ubicación de almacenamiento, al escribir texto codificado o al manejar errores de archivo.

ValorEl usuario encontrará
DOCUMENTSDocumentos persistentes visibles para el usuario. En Android, esto se mapea al directorio de archivos de la aplicación.
DATADatos de la aplicación privados persistentes.
LIBRARYDatos 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.
CACHEDatos de caché temporales que el sistema operativo puede eliminar.
EXTERNALAlmacenamiento externo de Android, como una tarjeta SD o almacenamiento externo compartido.
EXTERNAL_STORAGEDirectorio de datos de almacenamiento externo de Android.
APPLICATIONDirectorio de paquete o recursos de la aplicación en solo lectura.
ValorUsar
utf8Texto en UTF-8.
asciiTexto en ASCII.
utf16Texto en UTF-16.
ValorCodeSignificado
NOT_FOUND_ERR1No se encontró el archivo o directorio.
SECURITY_ERR2La operación fue bloqueada por reglas de seguridad o permisos.
ABORT_ERR3La operación fue abortada.
NOT_READABLE_ERR4No se puede leer el archivo o directorio.
ENCODING_ERR5El código de encabezado es inválido o no es compatible.
NO_MODIFICATION_ALLOWED_ERR6El objetivo no puede ser modificado.
INVALID_STATE_ERR7El objeto se encuentra en un estado inválido para la operación.
SYNTAX_ERR8La ruta o la sintaxis de entrada es inválida.
INVALID_MODIFICATION_ERR9La solicitud de cambio es inválida para el objetivo.
QUOTA_EXCEEDED_ERR10Se superó la cuota de almacenamiento.
TYPE_MISMATCH_ERR11Tipo de valor no coincide con el tipo esperado.
PATH_EXISTS_ERR12El camino objetivo ya existe.

Esta referencia se sincroniza desde src/definitions.ts en 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.