Visão geral da API de configuração do usuário no Microsoft Graph (versão prévia)

A API de configuração do usuário no Microsoft Graph permite que seu aplicativo armazene e recupere dados de configuração por pasta junto com o conteúdo de uma caixa de correio do Exchange Online. Um objeto userConfiguration (item associado à pasta, FAI) é associado a uma pasta de email específica e identificado por uma chave exclusiva dentro dessa pasta. Cada objeto se aplica a uma única pasta em vez de toda a caixa de correio. Esse escopo permite que seu aplicativo mantenha o estado próximo ao conteúdo ao qual ele se relaciona.

A API dá ao seu aplicativo controle total de criação, leitura, atualização e exclusão sobre objetos userConfiguration e dá suporte a vários estilos de conteúdo que permitem armazenar o formato que melhor se adapta ao seu cenário: dados binários arbitrários, XML serializado ou pares de chave-valor fortemente tipados.

Por que integrar com a API de configuração do usuário?

Armazenar configurações e estado do aplicativo por pasta

Muitos aplicativos precisam de um local confiável para manter as configurações ou o estado que pertencem a uma pasta de email específica. Os exemplos incluem a ID do último item sincronizado para uma ferramenta de sincronização da caixa de entrada, preferências de exibição para uma pasta personalizada ou sinalizadores de recursos com escopo para uma pasta. A API de configuração do usuário fornece ao seu aplicativo um local de armazenamento dedicado residente em caixa de correio para esses tipos de dados, para que você não precise manter um armazenamento externo separado.

Persistir os metadados do aplicativo juntamente com o conteúdo da caixa de correio

Os objetos de configuração do usuário residem dentro da caixa de correio. Como resultado, os dados ficam próximos ao conteúdo ao qual se relacionam e os mesmos controles de acesso que protegem o outro conteúdo da caixa de correio do usuário também protegem esses dados. Esse padrão de armazenamento torna a API uma boa opção para metadados de aplicativo que devem permanecer vinculados a uma pasta específica.

Escolha o estilo de conteúdo que se ajusta aos seus dados

O recurso userConfiguration dá suporte a três propriedades de conteúdo e você pode escolher a forma certa para seu cenário:

  • Use binaryData para conteúdo binário arbitrário.
  • Use xmlData para XML serializado.
  • Use structuredData para armazenar pares de chave-valor digitados sem serializar seu próprio formato. Os tipos complexos structuredDataEntry e structuredDataEntryTypedValue modelam os tipos de valor com suporte.

Um único objeto userConfiguration pode transportar qualquer combinação dessas propriedades. Você pode misturar estilos de conteúdo à medida que seu aplicativo evolui.

Referência da API

Está procurando a referência de API para esse serviço? Consulte o tipo de recurso userConfiguration e seus métodos com suporte.

Próximas etapas

  • Last updated on