Ponte al día con lo más destacado de Firebase en Google I/O 2023. Más información

Usa metadatos de archivo con Cloud Storage en Flutter

Después de subir un archivo a la referencia de Cloud Storage, también puedes obtener y actualizar los metadatos de 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.

Obtén metadatos de archivos

Los metadatos de archivos contienen propiedades comunes, como name, size y contentType (a menudo, denominado tipo de MIME), además de otros menos comunes, como contentDisposition y timeCreated. Estos metadatos se pueden recuperar de una referencia de Cloud Storage con 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'

Actualiza metadatos de archivo

Para actualizar los metadatos de un archivo en cualquier momento después de haberlo subido, puedes usar el método updateMetadata(). Consulta la lista completa para obtener más información sobre qué propiedades se pueden actualizar. Solo se actualizan las propiedades especificadas en los metadatos; todas las demás quedan sin cambios.

// 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

Para borrar propiedades de los metadatos que admiten escritura, puedes usar null:

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

Soluciona errores

Existen diferentes motivos por los que pueden producirse errores cuando se quieren obtener o actualizar metadatos; por ejemplo, es posible que el archivo no exista o que el usuario no tenga permiso para acceder al archivo deseado. Para obtener más información sobre los errores, consulta la sección de los documentos denominada Soluciona errores.

Metadatos personalizados

Puedes especificar metadatos personalizados con 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

Puedes almacenar datos específicos de tu app para cada archivo en forma de metadatos personalizados, pero te recomendamos que uses una base de datos (como Firebase Realtime Database) para almacenar y sincronizar este tipo de datos.

Propiedades de los metadatos de archivos

A continuación, puedes ver una lista completa de las propiedades de metadatos de un archivo:

Propiedad Tipo ¿Se puede configurar?
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>

Es importante subir, descargar y actualizar archivos, pero también lo es poder quitarlos. Veamos cómo borrar archivos de Cloud Storage.