Compartilhar via

Obter componente no Microsoft Graph Toolkit

Cuidado

O Toolkit do Microsoft Graph foi preterido. O período de reforma começa a 1 de setembro de 2025, com a reforma completa prevista para 28 de agosto de 2026. Os programadores devem migrar para utilizar os SDKs do Microsoft Graph ou outras ferramentas suportadas do Microsoft Graph para criar experiências Web. Para obter mais informações, veja o anúncio de preterição.

Pode utilizar mgt-get para efetuar qualquer consulta GET a partir do Microsoft Graph diretamente no seu HTML. O componente não fornece uma IU predefinida e requer que escreva um modelo.

Exemplo

O exemplo seguinte mostra a utilização do componente para apresentar os mgt-get e-mails de um utilizador. Pode utilizar o editor de código para ver como as propriedades e os atributos alteram o comportamento do componente.

Propriedades e atributos

Pode utilizar vários atributos para alterar o comportamento do componente. O único atributo necessário é resource.

Atributo Propriedade Descrição
recurso recurso O recurso a obter do Microsoft Graph (por exemplo, /me).
escopos escopos Matriz opcional de cadeias se utilizar a propriedade ou um âmbito delimitado por vírgulas se utilizar o atributo . O componente e um fornecedor suportado garantem que o utilizador concorda com, pelo menos, uma das permissões fornecidas.
versão versão Versão opcional da API a utilizar ao fazer o GET pedido. O padrão é v1.0.
max-pages maxPages Número opcional de páginas (para recursos que suportam paginação). A predefinição é 3. Definir este valor como 0 obtém todas as páginas.
taxa de consulta taxa de consulta Número opcional de milissegundos. Quando definido, o componente consulta o URI do pedido para obter atualizações no intervalo definido. Se utilizar uma consulta delta, a consulta consulta sempre a API delta. O modelo só é atualizado quando os dados são alterados.
com cache ativada cacheEnabled Booleano opcional. Quando definido, indica que a resposta do recurso é colocada em cache. Substitua se refresh() for chamado ou se pollingRate estiver a ser utilizado. O padrão é false.
cache-invalidation-period cacheInvalidationPeriod Número opcional de milissegundos. Quando definido em combinação com cacheEnabled, o atraso antes de a cache atingir o período de invalidação modifica o valor. A predefinição é 0 e utiliza o período de invalidação predefinido.
type type Tipo opcional da resposta esperada. O padrão é json. json Suporta ou image (só é suportado em pontos finais que terminem com /photo/value$).
N/D response Resposta só de leitura do Microsoft Graph se o pedido tiver sido efetuado com êxito.
N/D erro Erro só de leitura do Microsoft Graph se o pedido não tiver sido bem-sucedido.

Métodos

Método Descrição
refresh(force?: booleano) Chame o método para atualizar os dados. Por predefinição, a IU só é 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 um modelo personalizado
dataChange Acionado após o componente carregar os dados. { response: any, error: any }. A response propriedade contém a resposta obtida do Microsoft Graph. A error propriedade contém informações sobre o erro, caso tenha ocorrido um Não Não Sim

Dica

Para obter mais informações sobre os dados devolvidos na response propriedade, veja a Referência da API da API que utilizou na resource propriedade do componente Obter.

Para obter mais informações sobre o processamento de eventos, veja eventos.

Modelos

O mgt-get componente suporta vários modelos que pode utilizar para definir o aspeto e funcionalidade. 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 predefinido é necessário para compor os dados provenientes do Microsoft Graph.
valor Item de dados da matriz devolvida value Utilize o value modelo em vez do default modelo quando espera que a resposta do gráfico contenha uma matriz de itens, como mensagens, ficheiros ou utilizadores. O value modelo é repetido automaticamente para cada item devolvido pelo recurso. O value modelo também começa a compor os itens assim que estiverem prontos (ao contrário do modelo predefinido).
erro O erro do Microsoft Graph. Este modelo é utilizado se ocorrer um erro ao fazer o pedido.
a carregar N/D Este modelo é utilizado enquanto o pedido está a ser feito.
sem dados N/D Este modelo é utilizado quando o pedido não devolveu dados.

Permissões do Microsoft Graph

As permissões exigidas por este componente dependem dos dados que pretende obter com o mesmo a partir do Microsoft Graph. O Microsoft Graph Toolkit verifica se o utilizador atual deu consentimento a, pelo menos, um dos fornecidos scopes. Para obter mais informações sobre permissões, consulte Referência de permissões do Microsoft Graph.

Autenticação

O controlo utiliza o fornecedor de autenticação global descrito na documentação de autenticação para obter os dados necessários.

Cache

Para ativar e configurar a cache, utilize as cacheEnabled propriedades e cacheInvalidationPeriod . Por predefinição, o mgt-get componente não coloca em cache quaisquer respostas.

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

Para obter mais informações, veja Colocação em cache.

Localização

O controlo não expõe variáveis de localização.

  • Last updated on