Obter componente no Microsoft Graph Toolkit

Cuidado

O Microsoft Graph Toolkit foi preterido. O período de aposentadoria começa em 1º de setembro de 2025, com aposentadoria total planejada para 28 de agosto de 2026. Os desenvolvedores devem migrar para o uso dos SDKs do Microsoft Graph ou outras ferramentas do Microsoft Graph com suporte para criar experiências na Web. Para obter mais informações, consulte o anúncio de substituição.

Você pode usar mgt-get para fazer qualquer consulta GET do Microsoft Graph diretamente em seu HTML. O componente não fornece uma interface do usuário padrão e requer que você escreva um modelo.

Exemplo

O exemplo a seguir mostra o uso do mgt-get componente para exibir os emails de um usuário. Você pode usar o editor de código para ver como as propriedades e os atributos alteram o comportamento do componente.

Propriedades e atributos

Você pode usar vários atributos para alterar o comportamento do componente. O único atributo necessário é resource.

Atributo Propriedade Descrição
recurso recurso O recurso a ser obtido do Microsoft Graph (por exemplo, /me).
escopos escopos Matriz opcional de cadeias de caracteres, se a propriedade for usada, ou um escopo delimitado por vírgula, se estiver usando o atributo. O componente e um provedor com suporte garantem que o usuário consente com pelo menos uma das permissões fornecidas.
versão versão Versão de API opcional a ser usada ao fazer a GET solicitação. O padrão é v1.0.
máx. de páginas maxPages Número opcional de páginas (para recursos compatíveis com paginação). O padrão é 3. Definir esse valor como 0 recupera todas as páginas.
polling-rate pollingRate Número opcional de milissegundos. Quando definido, o componente sonda o URI de solicitação para obter atualizações no intervalo definido. Se estiver usando uma consulta delta, a sondagem sempre consultará a API delta. O modelo só é atualizado quando os dados são alterados.
habilitado para cache cacheEnabled Booleano opcional. Quando definido, indica que a resposta do recurso está armazenada em cache. Substitua se refresh() for chamado ou se pollingRate estiver em uso. O padrão é false.
período de invalidação de cache cacheInvalidationPeriod Número opcional de milissegundos. Quando definido em combinação com cacheEnabled, o atraso antes que o cache atinja seu período de invalidação modifica o valor. O padrão é 0 e usa o período de invalidação padrão.
type type Tipo opcional da resposta esperada. O padrão é json. Suporta json ou image (só terá suporte em pontos de extremidade que terminam com /photo/value$).
N/D response Resposta somente leitura do Microsoft Graph se a solicitação tiver sido bem-sucedida.
N/D erro Erro somente leitura do Microsoft Graph se a solicitação não tiver sido bem-sucedida.

Métodos

Método Descrição
refresh(force?: boolean) Chame o método para atualizar os dados. Por padrão, a interface do usuário só será atualizada se os dados forem alterados. Passe true para forçar a atualização do componente.

Eventos

Evento Quando é emitido Dados personalizados Cancelável Bolhas Funciona com modelo personalizado
dataChange Acionado após o componente carregar seus dados. { response: any, error: any }. A response propriedade contém a resposta recuperada do Microsoft Graph. A error propriedade contém informações sobre o erro, se ocorreu Não Não Sim

Dica

Para obter mais informações sobre os dados retornados na propriedade, response consulte a referência da API da API que você usou na resource propriedade do componente Get.

Para obter mais informações sobre como lidar com eventos, consulte eventos.

Modelos

O mgt-get componente oferece suporte a vários modelos que você pode usar para definir a aparência. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina como data-type um dos seguintes valores.

Tipo de dados Contexto de dados Descrição
Padrão. A resposta do Microsoft Graph. O modelo padrão é necessário para renderizar os dados provenientes do Microsoft Graph.
valor Item de dados da matriz retornada value Use o value modelo em vez do default modelo quando esperar que a resposta do gráfico contenha uma matriz de itens, como mensagens, arquivos ou usuários. O value modelo é repetido automaticamente para cada item retornado pelo recurso. O value modelo também começa a renderizar os itens assim que eles estão prontos (ao contrário do modelo padrão).
erro O erro do Microsoft Graph. Esse modelo será usado se houver um erro ao fazer a solicitação.
carregando N/D Este modelo é usado enquanto a solicitação está sendo feita.
sem dados N/D Este modelo é usado quando a solicitação não retorna dados.

Permissões do Microsoft Graph

As permissões exigidas por este componente dependem dos dados que você deseja recuperar com ele do Microsoft Graph. O Microsoft Graph Toolkit verifica se o usuário atual consentiu com pelo menos um dos arquivos .scopes Para obter mais informações sobre permissões, consulte Referência de permissões do Microsoft Graph.

Autenticação

O controle usa o provedor de autenticação global descrito na documentação de autenticação para buscar os dados necessários.

Cache

Para habilitar e configurar o cache, use as cacheEnabled propriedades and cacheInvalidationPeriod . Por padrão, o mgt-get componente não armazena nenhuma resposta em cache.

Loja de objetos Dados armazenados em cache Comentários
response Resposta completa recuperada do Microsoft Graph para a consulta especificada na resource propriedade de mgt-get

Para obter mais informações, consulte Cache.

Localização

O controle não expõe nenhuma variável de localização.

  • Last updated on