Obter componente no Microsoft Graph Toolkit
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 exige 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 propriedades e 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 estiver usando a propriedade ou um escopo delimitado por vírgula se estiver usando o atributo. O componente e um provedor com suporte garantem que o usuário consenta com pelo menos uma das permissões fornecidas. |
| versão | versão | Versão opcional da API a ser usada ao fazer a solicitação GET . O padrão é v1.0. |
| páginas máximas | maxPages | Número opcional de páginas (para recursos que dão suporte à paginação). O padrão é 3. Definir esse valor como 0 recupera todas as páginas. |
| taxa de sondagem | pollingRate | Número opcional de milissegundos. Quando definido, o componente sonda o URI de solicitação para atualizações no intervalo definido. Se usar uma consulta delta, a sondagem sempre consultará a API delta. O modelo só é atualizado quando os dados são alterados. |
| Habilitado para cache | cacheEnabled | Booliano opcional. Quando definido, ele indica que a resposta do recurso é armazenada em cache. Substitua se refresh() for chamado ou se pollingRate estiver em uso. O padrão é false. |
| cache-invalidation-period | 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.
json Dá suporte ou image (só há 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?: booleano) | 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 o componente a ser atualizado. |
Eventos
| Evento | Quando ele é emitido | Dados personalizados | Cancelável | Bolhas | Funciona com modelo personalizado |
|---|---|---|---|---|---|
dataChange |
Acionado depois que o componente carregou 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 response propriedade, consulte a referência de 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 dá suporte a vários modelos que você pode usar para definir a aparência e a aparência. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina o data-type como um dos valores a seguir.
| 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 ao esperar que a resposta do grafo 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 estiverem 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. |
| Carregar | N/D | Esse modelo é usado enquanto a solicitação está sendo feita. |
| sem dados | N/D | Esse modelo é usado quando a solicitação não retorna dados. |
Permissões do Microsoft Graph
As permissões necessárias por esse 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 fornecidos 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 e cacheInvalidationPeriod . Por padrão, o mgt-get componente não armazena em cache respostas.
| Repositório 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.