ErrorImage

Última actualización: 22 de julio de 2024
  • Temas:

Creado para:

  • Desarrollador
  • Usuario

Imagen de respuesta de error. El servicio de imágenes normalmente devuelve un estado de error con un mensaje de texto cuando se produce un error.

attribute::ErrorImage permite que se devuelva una imagen, una entrada de catálogo o una plantilla en caso de error.

NOTA
Las imágenes que faltan también se pueden administrar con attribute::DefaultImage.

Se puede configurar una plantilla del servicio de imágenes que pueda representar el texto del mensaje de error en la imagen de respuesta. Las siguientes variables predefinidas se pueden incluir en la plantilla $error.title, que se sustituye por una breve descripción del error, y $error.message, que se sustituye por una descripción del error más detallada (el nivel de detalle se configura con attribute::ErrorDetail).

Se devuelve el estado HTTP 200 si la imagen o plantilla de error se puede procesar correctamente. Si se produce un error durante este procesamiento, se devuelve el estado de error HTTP y un mensaje de texto.

Propiedades

Cadena de texto. Si se especifica, debe ser un valor catalog::Id válido en un catálogo de imágenes o una ruta relativa (a attribute::RootPath) o absoluta a un archivo de imagen accesible mediante el servidor de imágenes.

Predeterminado

Se hereda de default::ErrorImage si no se define. Si se define pero está vacío, el comportamiento de la imagen de error se deshabilita, incluso si se define default::ErrorImage, y se devuelve un estado de error HTTP y un mensaje de texto.

Ejemplo

Para obtener imágenes de respuesta con el mensaje de error representado en la imagen, primero debe definir la plantilla en el catálogo de imágenes. En este caso, creamos una entrada en nuestro catálogo de imágenes llamada onError, que contiene lo siguiente en catalog::Modifier:

size=300,300&bgc=ffffff&text=$error.message$

La plantilla está registrada con attribute::ErrorImage:

ErrorImage=myCatalog/onError

Para este ejemplo, el texto se representa con la fuente, el color de fuente y el tamaño de fuente predeterminados.

Véase también

attribute::RootPath , catalog::Id, attribute::DefaultImage, attribute::ErrorDetail

Experience Manager