Capítulo 12 API File – 4

Capítulo 12 API File - 4

12.6   Referencia rápida

Del mismo modo que la API IndexedDB, las características de API File y sus extensiones fueron organizadas en interfaces. Cada interface provee métodos, propiedades y eventos que trabajan combinados con el resto para ofrecer diferentes alternativas con las que crear, leer y procesar archivos. En esta referencia rápida vamos a presentar todas las características estudiadas en este capítulo en un orden acorde a esta organización oficial.

IMPORTANTE: Las descripciones presentadas en esta referencia rápida solo muestran los aspectos más relevantes de cada interface. Para estudiar la especificación completa, visite nuestro sitio web y siga los enlaces correspondientes a este capítulo.

Interface Blob (API File)

Esta interface provee propiedades y métodos para operar con blobs. Es heredada por la interface File.

size Esta propiedad retorna el tamaño del blob o el archivo en bytes. type Esta propiedad retorna el tipo de medio dentro de un blob o archivo. slice(comienzo, largo, tipo) Este método retorna la parte del blob o archivo indicada por los valores en bytes de los atributos comienzo y largo.

Interface File (API File)

Esta interface es una extensión de la interface Blob para procesar archivos. name Esta propiedad retorna el nombre del archivo.

Interface FileReader (API File)

Esta interface provee métodos, propiedades y eventos para cargar blobs y archivos en memoria.

readAsArrayBuffer(archivo) Este método retorna el contenido de blobs o archivos en el formato ArrayBuffer.

readAsBinaryString(archivo) Este método retorna el contenido de blobs o archivos como una cadena binaria.

readAsText(archivo) Este método interpreta el contenido de blobs o archivos y lo retorna en formato texto.

readAsDataURL(archivo) Este método retorna el contenido de blobs o archivos en el formato data:url.

abort() Este método aborta el proceso de lectura.

result Esta propiedad representa los datos retornados por los métodos de lectura. loadstart Este evento es disparado cuando la lectura comienza.

progress Este evento es disparado periódicamente para reportar el estado del proceso de lectura.

load Este evento es disparado cuando el proceso de lectura es finalizado. abort Este evento es disparado cuando el proceso de lectura es abortado. error Este evento es disparado cuando un error ocurre en el proceso. loadend Este evento es disparado cuando la carga del archivo es finalizada, haya sido el proceso exitoso o no.

Interface LocalFileSystem (API File: Directories and System)

Esta interface es provista para iniciar un Sistema de Archivos para la aplicación.

requestFileSystem(tipo, tamaño, función éxito, función error) Este método solicita la inicialización de un Sistema de Archivos configurado de acuerdo a los valores de sus atributos. El atributo tipo puede recibir dos valores diferentes: temporary (temporario) o persistent (persistente). El tamaño debe ser especificado en bytes.

Interface FileSystem (API File: Directories and System)

Esta interface provee información acerca del Sistema de Archivos.

name Esta propiedad retorna el nombre del Sistema de Archivos.

root Esta propiedad retorna una referencia el directorio raíz del Sistema de Archivos.

Interface Entry (API File: Directories and System)

Esta interface provee métodos y propiedades para procesar entradas (archivos y directorios) en el Sistema de Archivos.

isFile Esta propiedad es un valor booleano que indica si la entrada es un archivo o no. isDirectory Esta propiedad es un valor booleano que indica si la entrada es un directorio o no. name Esta propiedad retorna el nombre de la entrada.

fullPath Esta propiedad retorna la ruta completa de la entrada desde el directorio raíz del Sistema de Archivos.

filesystem Esta propiedad contiene una referencia al Sistema de Archivos. moveTo(directorio, nombre, función éxito, función error) Este método mueve una entrada a una ubicación diferente dentro del Sistema de Archivos. El atributo directorio representa el directorio dentro del cual la entrada será movida. El atributo nombre, si es especificado, cambia el nombre de la entrada en la nueva ubicación. copyTo(directorio, nombre, función éxito, función error) Este método genera una copia de la entrada dentro del Sistema de Archivos. El atributo directorio representa el directorio dentro del cual la copia de la entrada será creada. El atributo nombre, si es especificado, cambia el nombre de la copia. remove(función éxito, función error) Este método elimina un archivo o un directorio vacío. getParent(función éxito, función error) Este método retorna el objeto DirectoryEntry padre de la entrada seleccionada.

Interface DirectoryEntry (API File: Directories and System)

Esta interface provee métodos para crear y leer archivos y directorios.

createReader() Este método crear un objeto DirectoryReader para leer entradas. getFile(ruta, opciones, función éxito, función error) Este método crea o lee el archivo indicado por el atributo ruta. El atributo opciones es declarado por dos banderas: create (crear) y exclusive (exclusivo). La primera indica si el archivo será creado o

no, y la segunda, cuando es declarada como true (verdadero), fuerza al método a retornar un error si el archivo ya existe.

getDirectory(ruta, opciones, función éxito, función error) Este método crea o lee el directorio indicado por el atributo ruta. El atributo opciones es declarado por dos banderas: create (crear) y exclusive (exclusivo). La primera indica si el directorio será creado o no, y la segunda, cuando es declarada como true (verdadero), fuerza al método a retornar un error si el directorio ya existe. removeRecursively(función éxito, función error) Este método elimina un directorio y todo su contenido.

Interface DirectoryReader (API File: Directories and System)

Esta interface ofrece la posibilidad de obtener una lista de entradas en un directorio específico.

readEntries(función éxito, función error) Este método lee un bloque de entradas desde el directorio seleccionado. Retorna el valor nuil si no se encuentran más entradas.

Interface FileEntry (API File: Directories and System)

Esta interface provee métodos para obtener un objeto File para un archivo específico y un objeto FileWriter para poder agregar contenido al mismo.

createWriter(función éxito, función error) Este método crea un objeto FileWriter para escribir contenido dentro de un archivo.

file(función éxito, función error) Este método retorna un objeto File que representa el archivo seleccionado.

Interface BlobBuilder (API File: Writer)

Esta interface provee métodos para trabajar con objetos blob.

getBlob(tipo) Este método retorna el contenido de un objeto blob como un blob. append(datos) Este método agrega datos a un objeto blob. La interface provee tres métodos append() diferentes para agregar datos en forma de texto, blob, o como un ArrayBuffer.

Interface FileWriter (API File: Writer)

La interface FileWriter es una expansión de la interface FileSaver. La última no es descripta aquí, pero los eventos listados debajo son parte de ella.

position Este propiedad retorna la posición actual en la cual se realizará la siguiente escritura.

length Esta propiedad retorna el largo del archivo en bytes. write(blob) Este método escribe contenido en un archivo.

seek(desplazamiento) Este método especifica una nueva posición en la cual se realizará la siguiente escritura.

truncate(tamaño) Este método cambia el largo del archivo al valor del atributo tamaño (en bytes).

writestart Este evento es disparado cuando la escritura comienza.

progress Este evento es disparado periódicamente para informar sobre el estado del proceso de escritura.

write Este evento es disparado cuando el proceso de escritura es finalizado. abort ste evento es disparado cuando el proceso de escritura es abortado. error Este evento es disparado si ocurre un error en el proceso de escritura. writeend Este evento es disparado cuando la solicitud es finalizada, haya sido exitosa o no.

Interface FileError (API File y extensiones)

Varios métodos en esta API retornan un valor a través de una función para indicar errores en el proceso. Este valor puede ser comparado con la siguiente lista para encontrar el error correspondiente:

NOT_FOUND_ERR – valor 1.

SECURITY_ERR – valor 2.

ABORT_ERR – valor 3.

NOT_READABLE_ERR – valor 4.

ENCODING_ERR – valor 5 NO_MODIFICATION_ALLOWED_ERR – valor 6.

INVALID_STATE_E RR – valor 7.

SYNTAX_ERR – valor 8.

INVALID_MODIFICATION_ERR – valor 9.

QUOTA_EXCEEDED_ERR – valor 10.

TYPE_MISMATCH_ERR – valor 11.

PATH EXISTS ERR – valor 12.

Publicaciones Similares