Utilice metadatos de archivos con Cloud Storage en Flutter

Después de cargar un archivo en la referencia de Cloud Storage, también puede obtener y actualizar los metadatos del archivo, por ejemplo, para ver o actualizar el tipo de contenido. Los archivos también pueden almacenar pares clave/valor personalizados con metadatos de archivo adicionales.

Obtener metadatos de archivos

Los metadatos de archivos contienen propiedades comunes como name , size y contentType (a menudo denominado tipo MIME), además de algunas menos comunes como contentDisposition y timeCreated . Estos metadatos se pueden recuperar de una referencia de Cloud Storage mediante el método getMetadata() .

// Create reference to the file whose metadata we want to retrieve
final forestRef = storageRef.child("images/forest.jpg");

// Get metadata properties
final metadata = await forestRef.getMetadata();

// Metadata now contains the metadata for 'images/forest.jpg'

Actualizar metadatos del archivo

Puede actualizar los metadatos del archivo en cualquier momento después de que se complete la carga del archivo utilizando el método updateMetadata() . Consulte la lista completa para obtener más información sobre qué propiedades se pueden actualizar. Sólo se actualizan las propiedades especificadas en los metadatos, todas las demás no se modifican.

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newMetadata = SettableMetadata(
  cacheControl: "public,max-age=300",
  contentType: "image/jpeg",
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newMetadata);

// Updated metadata for 'images/forest.jpg' is returned

Puede eliminar propiedades de metadatos grabables pasando null :

// Delete the cacheControl property
final newMetadata = SettableMetadata(cacheControl: null);
final metadata = await forestRef.updateMetadata(newMetadata);

Manejar errores

Hay varias razones por las que pueden ocurrir errores al obtener o actualizar metadatos, incluido el archivo que no existe o que el usuario no tiene permiso para acceder al archivo deseado. Puede encontrar más información sobre errores en la sección Manejar errores de los documentos.

Metadatos personalizados

Puede especificar metadatos personalizados utilizando el parámetro customMetadata del constructor SettableMetadata :

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newCustomMetadata = SettableMetadata(
  customMetadata: {
    "location": "Yosemite, CA, USA",
    "activity": "Hiking",
  },
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newCustomMetadata);

// Updated metadata for 'images/forest.jpg' is returned

Puede almacenar datos específicos de la aplicación para cada archivo en metadatos personalizados, pero recomendamos encarecidamente utilizar una base de datos (como Firebase Realtime Database ) para almacenar y sincronizar este tipo de datos.

Propiedades de metadatos de archivo

A continuación se encuentra disponible una lista completa de las propiedades de metadatos de un archivo:

Propiedad Tipo ¿Configurable?
bucket String No
generation String No
metageneration String No
metadataGeneration String No
fullPath String No
name String No
size int No
timeCreated DateTime No
updated DateTime No
md5Hash String No
cacheControl String
contentDisposition String
contentEncoding String
contentLanguage String
contentType String
customMetadata Map<String, String>

Cargar, descargar y actualizar archivos es importante, pero también lo es poder eliminarlos. Aprendamos cómo eliminar archivos de Cloud Storage.