Introducción a la API de configuración de usuario en Microsoft Graph (versión preliminar)

La API de configuración de usuario de Microsoft Graph permite que la aplicación almacene y recupere datos de configuración por carpeta junto con el contenido de un buzón de Exchange Online. Un objeto userConfiguration (elemento asociado a la carpeta, FAI) está asociado a una carpeta de correo específica y se identifica mediante una clave que es única dentro de esa carpeta. Cada objeto se aplica a una sola carpeta en lugar de a todo el buzón. Este ámbito permite que la aplicación mantenga el estado cerca del contenido al que se relaciona.

La API proporciona a la aplicación control completo de creación, lectura, actualización y eliminación sobre los objetos userConfiguration y admite varios estilos de carga útil que permiten almacenar el formato que mejor se adapte a su escenario: datos binarios arbitrarios, XML serializados o pares clave-valor fuertemente tipados.

¿Por qué integrar con la API de configuración de usuario?

Almacenar el estado y la configuración de la aplicación por carpeta

Muchas aplicaciones necesitan un lugar confiable para mantener la configuración o el estado que pertenece a una carpeta de correo específica. Entre los ejemplos se incluyen el identificador de elemento sincronizado por última vez para una herramienta de sincronización de bandeja de entrada, las preferencias de vista de una carpeta personalizada o las marcas de características con ámbito en una carpeta. La API de configuración de usuario proporciona a la aplicación una ubicación de almacenamiento dedicada y residente en buzones para este tipo de datos, por lo que no es necesario mantener un almacén externo independiente.

Conservar los metadatos de la aplicación junto con el contenido del buzón

Los objetos de configuración de usuario residen dentro del buzón de correo. Como resultado, los datos se encuentran cerca del contenido al que se relacionan y los mismos controles de acceso que protegen el otro contenido del buzón de correo del usuario también protegen estos datos. Este patrón de almacenamiento hace que la API sea una buena opción para los metadatos de la aplicación que deben permanecer vinculados a una carpeta específica.

Elija el estilo de carga útil que se ajuste a los datos.

El recurso userConfiguration admite tres propiedades de carga útil y puede elegir la forma adecuada para el escenario:

  • Use binaryData para contenido binario arbitrario.
  • Use xmlData para xml serializado.
  • Use structuredData para almacenar pares clave-valor con tipo sin serializar su propio formato. Los tipos complejos structuredDataEntry y structuredDataEntryTypedValue modela los tipos de valor admitidos.

Un único objeto userConfiguration puede llevar cualquier combinación de estas propiedades. Puede combinar estilos de carga a medida que evoluciona la aplicación.

Referencia de la API

¿Busca la referencia de la API para este servicio? Consulte el tipo de recurso userConfiguration y sus métodos admitidos.

Pasos siguientes