Obtener componente en microsoft Graph Toolkit

Puede usar para mgt-get realizar cualquier consulta GET de Microsoft Graph directamente en su HTML. El componente no proporciona una interfaz de usuario predeterminada y requiere que escriba una plantilla.

Ejemplo

En el ejemplo siguiente se muestra el uso del mgt-get componente para mostrar los correos electrónicos de un usuario. Puede usar el editor de código para ver cómo cambian las propiedades y los atributos el comportamiento del componente.

Abra este ejemplo en mgt.dev

Propiedades y atributos

Puede usar varios atributos para cambiar el comportamiento del componente. El único atributo requerido es resource .

Atributo Propiedad Descripción
resource resource El recurso que se obtiene de Microsoft Graph (por ejemplo, /me ).
ámbitos ámbitos Matriz opcional de cadenas si se usa la propiedad o un ámbito delimitado por comas si se usa el atributo. El componente usará estos ámbitos (con un proveedor compatible) para asegurarse de que el usuario ha dado su consentimiento al permiso correcto.
version version Versión de API opcional que se usará al realizar la solicitud GET. El valor predeterminado es v1.0.
max-pages maxPages Número opcional de páginas (para recursos que admiten paginación). El valor predeterminado es 3. Si se establece este valor en 0, se obtienen todas las páginas.
tasa de sondeo pollingRate Número opcional de milisegundos. Cuando se establece, el componente sondeará el URI de solicitud para obtener actualizaciones en el intervalo definido. Si se usa una consulta delta, el sondeo siempre consultará la API delta. La plantilla solo se actualizará cuando cambien los datos.
habilitado para caché cacheEnabled Boolean opcional. Cuando se establece, indica que la respuesta del recurso se almacenará en caché. Invalida si refresh() se llama o si está en pollingRate uso. El valor predeterminado es false.
cache-invalidation-period cacheInvalidationPeriod Número opcional de milisegundos. Cuando se establece en combinación con , este valor modificará el retraso antes de que la memoria caché alcance su período de cacheEnabled invalidación. El valor 0 predeterminado es y usará el período de invalidación predeterminado.
type type Tipo opcional de la respuesta esperada. El valor predeterminado es json. Admite json o image (solo se admite en puntos de conexión que terminan con /photo/value$ ).
N/D response Respuesta de solo lectura de Microsoft Graph si la solicitud se ha realizado correctamente.
N/D error Error de solo lectura de Microsoft Graph si la solicitud no se ha realizado correctamente.

Métodos

Método Descripción
refresh(force?:boolean) Llame al método para actualizar los datos. De forma predeterminada, la interfaz de usuario solo se actualizará si cambian los datos. Pase true para forzar la actualización del componente.

Events

Evento Cuándo se emite Datos personalizados Cancelable Burbujas Funciona con plantilla personalizada
dataChange Se desencadena después de que el componente haya cargado sus datos. { response: any, error: any }. La response propiedad contiene la respuesta recuperada de Microsoft Graph. La error propiedad contiene información sobre el error si se produjo una No No

Sugerencia

Para obtener más información acerca de los datos devueltos en la propiedad, vea la referencia a la API de la API que usó en la propiedad response resource del componente Get.

Para obtener más información acerca del control de eventos, vea eventos.

Plantillas

El mgt-get componente admite varias plantillas que puede usar para definir el aspecto. Para especificar una plantilla, incluya un elemento dentro de un componente y <template> establezca el valor en uno de los siguientes data-type elementos.

Tipo de datos Contexto de datos Descripción
Es el valor predeterminado. La respuesta de Microsoft Graph. La plantilla predeterminada es necesaria para representar los datos procedentes de Microsoft Graph.
valor Elemento de datos de la matriz value devuelta Use la plantilla en lugar de la plantilla al esperar que la respuesta del gráfico contenga una matriz de elementos, como value default mensajes, archivos o usuarios. La value plantilla se repetirá automáticamente para cada elemento devuelto por el recurso. La value plantilla también empezará a representar los elementos tan pronto como estén listos (a diferencia de la plantilla predeterminada).
error Error de Microsoft Graph. Esta plantilla se usará si se produce un error al realizar la solicitud.
carga N/D Esta plantilla se usa mientras se realiza la solicitud.

Permisos de Microsoft Graph

Los permisos requeridos por este componente dependen de los datos que desee recuperar con él de Microsoft Graph. Para obtener más información acerca de los permisos, vea la referencia Graph permisos deMicrosoft .

Autenticación

El control usa el proveedor de autenticación global descrito en la documentación de autenticación para capturar los datos necesarios.

Caché

Para habilitar y configurar la memoria caché, use las cacheEnabled propiedades cacheInvalidationPeriod y. De forma predeterminada, mgt-get el componente no almacena en caché ninguna respuesta.

Almacén de objetos Datos almacenados en caché Comentarios
response Respuesta completa recuperada de Microsoft Graph para la consulta especificada en la resource propiedad demgt-get

Consulta Almacenamiento en caché para obtener más información.