Obtener el componente en el kit de herramientas de Microsoft GraphGet component in the Microsoft Graph Toolkit

Puede usar mgt-get para realizar cualquier consulta Get desde Microsoft Graph directamente en el HTML.You can use mgt-get to make any GET query from Microsoft Graph directly in your HTML. El componente no proporciona una interfaz de usuario predeterminada y requiere que escriba una plantilla.The component does not provide a default UI and requires that you write a template.

EjemploExample

En el ejemplo siguiente se muestra el uso mgt-get del componente para mostrar los correos electrónicos de un usuario.The following example shows the use of the mgt-get component to display a user's emails. Puede usar el editor de código para ver cómo las propiedades y los atributos cambian el comportamiento del componente.You can use the code editor to see how properties and attributes change the behavior of the component.

Abra este ejemplo en manits. devOpen this example in mgt.dev

Propiedades y atributosProperties and attributes

Puede usar varios atributos para cambiar el comportamiento del componente.You can use several attributes to change the behavior of the component. El único atributo necesario es resource.The only required attribute is resource.

AtributoAttribute PropiedadProperty DescripciónDescription
resourceresource resourceresource Recurso que se va a obtener de Microsoft Graph (por /meejemplo,).The resource to get from Microsoft Graph (for example, /me).
ámbitosscopes ámbitosscopes Matriz opcional de cadenas si se usa la propiedad o un ámbito delimitado por comas si se usa el atributo.Optional array of strings if using the property or a comma delimited scope if using the attribute. El componente usará estos ámbitos (con un proveedor admitido) para asegurarse de que el usuario haya aceptado el permiso adecuado.The component will use these scopes (with a supported provider) to ensure that the user has consented to the right permission.
versionversion versionversion Versión de API opcional que se debe usar al realizar la solicitud GET.Optional API version to use when making the GET request. El valor predeterminado es v1.0.Default is v1.0.
Max-pagesmax-pages maxPagesmaxPages Número de páginas opcional (para los recursos que admiten paginación).Optional number of pages (for resources that support paging). El valor predeterminado es 3.Default is 3. Si este valor se establece en 0, se obtendrán todas las páginas.Setting this value to 0 will get all pages.
intervalo de sondeopolling-rate pollingRatepollingRate Número opcional de miliseconds.Optional number of miliseconds. Cuando se establece, el componente sondea el URI de la solicitud para obtener las actualizaciones en el intervalo definido.When set, the component will poll the request URI for updates in the defined interval. Si se usa una consulta Delta, el sondeo siempre consultará la API Delta.If using a delta query, polling will always query the delta API. La plantilla solo se actualizará cuando cambien los datos.The template will only refresh when the data changes.
N/DN/A responseresponse Respuesta de solo lectura de Microsoft Graph si la solicitud se ha realizado correctamente.Read-only response from Microsoft Graph if request was successful.
N/DN/A errorerror Error de solo lectura de Microsoft Graph si la solicitud no se ha realizado correctamente.Read-only error from Microsoft Graph if request was not successful.

MétodosMethods

MétodoMethod DescripciónDescription
Refresh (forzar?: Boolean)refresh(force?:boolean) Llame al método para actualizar los datos.Call the method to refresh the data. De forma predeterminada, la interfaz de usuario solo se actualizará si los datos cambian.By default, the UI will only update if the data changes. Se true pasa para forzar la actualización del componente.Pass true to force the component to update.

EventosEvents

EventoEvent DetalleDetail DescripciónDescription
dataChangedataChange El detalle contiene los response objetos error y.The detail contains the response and error objects. Se desencadena cuando cambia la respuesta o el error.Fired when the response or error change.

PlantillasTemplates

El mgt-get componente admite varias plantillas que puede usar para definir la apariencia.The mgt-get component supports several templates that you can use to define the look and feel. Para especificar una plantilla, incluya un <template> elemento dentro de un componente y establezca data-type el valor en uno de los siguientes valores.To specify a template, include a <template> element inside a component and set the data-type value to one of the following.

Tipo de datosData type Contexto de datosData context DescripciónDescription
Es el valor predeterminado.default Respuesta de Microsoft Graph.The response from Microsoft Graph. La plantilla predeterminada es necesaria para representar los datos procedentes de Microsoft Graph.The default template is required to render the data coming from Microsoft Graph.
valuevalue Elemento de datos de la value matriz devueltaData item from the returned value array Use la value plantilla en lugar de la default plantilla cuando se espera que la respuesta del gráfico contenga una matriz de elementos, como mensajes, archivoso usuarios.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. La value plantilla se repetirá automáticamente para cada elemento devuelto por el recurso.The value template will automatically be repeated for each item returned by the resource. La value plantilla también empezará a representar los elementos en cuanto estén listos (a diferencia de lo que ocurre con la plantilla predeterminada).The value template will also start rendering the items as soon as they are ready (unlike the default template).
errorerror El error de Microsoft Graph.The error from Microsoft Graph. Esta plantilla se usará si se produce un error al realizar la solicitud.This template will be used if there is an error making the request.
cargamentoloading N/DN/A Esta plantilla se usa mientras se realiza la solicitud.This template is used while the request is being made.

Permisos de Microsoft GraphMicrosoft Graph permissions

Para obtener más información acerca de los permisos, consulte la referencia de permisosde Microsoft Graph.For more information about permissions, see the Microsoft Graph permissions reference.

AutenticaciónAuthentication

El control utiliza el proveedor de autenticación global que se describe en la documentación de autenticación para capturar los datos necesarios.The control uses the global authentication provider described in the authentication documentation to fetch the required data.