Obter componente no Microsoft Graph ToolkitGet component in the Microsoft Graph Toolkit

Você pode usar mgt-get o para tornar qualquer consulta Get do Microsoft Graph diretamente no HTML.You can use mgt-get to make any GET query from Microsoft Graph directly in your HTML. O componente não fornece uma interface do usuário padrão e requer que você escreva um modelo.The component does not provide a default UI and requires that you write a template.

ExemploExample

O exemplo a seguir mostra o uso do mgt-get componente para exibir os emails de um usuário.The following example shows the use of the mgt-get component to display a user's emails. Você pode usar o editor de código para ver como as propriedades e os atributos alteram o comportamento do componente.You can use the code editor to see how properties and attributes change the behavior of the component.

Abra este exemplo em gerenciamento de. devOpen this example in mgt.dev

Propriedades e atributosProperties and attributes

Você pode usar vários atributos para alterar o comportamento do componente.You can use several attributes to change the behavior of the component. O único atributo obrigatório é resource.The only required attribute is resource.

AtributoAttribute PropriedadeProperty DescriçãoDescription
recursoresource recursoresource O recurso a ser obtido do Microsoft Graph (por exemplo /me,).The resource to get from Microsoft Graph (for example, /me).
escoposscopes escoposscopes Matriz opcional de cadeias de caracteres se você usar a propriedade ou um escopo delimitado por vírgula se estiver usando o atributo.Optional array of strings if using the property or a comma delimited scope if using the attribute. O componente usará esses escopos (com um provedor suportado) para garantir que o usuário tenha sido aceito para a permissão correta.The component will use these scopes (with a supported provider) to ensure that the user has consented to the right permission.
versãoversion versãoversion Versão da API opcional a ser usada ao fazer a solicitação GET.Optional API version to use when making the GET request. O padrão é v1.0.Default is v1.0.
Max-Pagesmax-pages maxPagesmaxPages Número opcional de páginas (para recursos que dão suporte à paginação).Optional number of pages (for resources that support paging). O padrão é 3.Default is 3. Definir esse valor como 0 receberá todas as páginas.Setting this value to 0 will get all pages.
taxa de sondagempolling-rate pollingRatepollingRate Número opcional de miliseconds.Optional number of miliseconds. Quando definido, o componente irá sondar o URI de solicitação para atualizações no intervalo definido.When set, the component will poll the request URI for updates in the defined interval. Se você estiver usando uma consulta Delta, a pesquisa sempre consultará a API Delta.If using a delta query, polling will always query the delta API. O modelo só será atualizado quando os dados forem alterados.The template will only refresh when the data changes.
Não disponívelN/A responseresponse Somente leitura resposta do Microsoft Graph se a solicitação tiver sido bem-sucedida.Read-only response from Microsoft Graph if request was successful.
Não disponívelN/A erroerror Somente leitura erro do Microsoft Graph se a solicitação não tiver sido bem-sucedida.Read-only error from Microsoft Graph if request was not successful.

MétodosMethods

MétodoMethod DescriçãoDescription
atualizar (forçar?: Boolean)refresh(force?:boolean) Chame o método para atualizar os dados.Call the method to refresh the data. Por padrão, a interface do usuário só será atualizada se os dados forem alterados.By default, the UI will only update if the data changes. Passe true para forçar o componente a atualizar.Pass true to force the component to update.

EventosEvents

EventoEvent DetalheDetail DescriçãoDescription
dataChangedataChange O detalhe contém os response objetos error e.The detail contains the response and error objects. Acionado quando a resposta ou erro é alterada.Fired when the response or error change.

ModelosTemplates

O mgt-get componente suporta vários modelos que você pode usar para definir a aparência.The mgt-get component supports several templates that you can use to define the look and feel. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina data-type o valor como um dos seguintes.To specify a template, include a <template> element inside a component and set the data-type value to one of the following.

Tipo de dadosData type Contexto de dadosData context DescriçãoDescription
Padrão.default A resposta do Microsoft Graph.The response from Microsoft Graph. O modelo padrão é necessário para renderizar os dados provenientes do Microsoft Graph.The default template is required to render the data coming from Microsoft Graph.
valorvalue Item de dados da matriz value retornadaData item from the returned value array Use o value modelo em vez do default modelo ao esperar a resposta do gráfico para conter uma matriz de itens, como mensagens, arquivosou usuários.Use the value template instead of the default template when expecting the response from the graph to contain an array of items - such as messages, files, or users. O value modelo será repetido automaticamente para cada item retornado pelo recurso.The value template will automatically be repeated for each item returned by the resource. O value modelo também começará a renderizar os itens assim que eles estiverem prontos (ao contrário do modelo padrão).The value template will also start rendering the items as soon as they are ready (unlike the default template).
erroerror O erro do Microsoft Graph.The error from Microsoft Graph. Este modelo será usado se houver um erro ao fazer a solicitação.This template will be used if there is an error making the request.
carregandoloading Não disponívelN/A Este modelo é usado enquanto a solicitação é feita.This template is used while the request is being made.

Permissões do Microsoft GraphMicrosoft Graph permissions

Para obter mais informações sobre permissões, consulte a referência de permissõesdo Microsoft Graph.For more information about permissions, see the Microsoft Graph permissions reference.

AutenticaçãoAuthentication

O controle usa o provedor de autenticação global descrito na documentação de autenticação para buscar os dados necessários.The control uses the global authentication provider described in the authentication documentation to fetch the required data.