Obtener componente en Microsoft Graph Toolkit
Puede usar mgt-get para 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 componente para mostrar los mgt-get 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.
Propiedades y atributos
Puede usar varios atributos para cambiar el comportamiento del componente. El único atributo necesario es resource.
| Atributo | Propiedad | Descripción |
|---|---|---|
| resource | resource | Recurso que se va a obtener 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 y un proveedor admitido garantizan que el usuario da su consentimiento a al menos uno de los permisos proporcionados. |
| version | version | Versión de API opcional que se usará al realizar la GET solicitud. El valor predeterminado es v1.0. |
| max-pages | maxPages | Número opcional de páginas (para los recursos que admiten la paginación). El valor predeterminado es 3. Al establecer este valor en 0, se recuperan todas las páginas. |
| tasa de sondeo | pollingRate | Número opcional de milisegundos. Cuando se establece, el componente sondea el URI de solicitud para obtener actualizaciones en el intervalo definido. Si usa una consulta delta, el sondeo siempre consulta la API delta. La plantilla solo se actualiza cuando cambian los datos. |
| habilitado para caché | cacheEnabled | Boolean opcional. Cuando se establece, indica que la respuesta del recurso se almacena en caché. Invalide si refresh() se llama a o si pollingRate está en uso. El valor predeterminado es false. |
| cache-invalidation-period | cacheInvalidationPeriod | Número opcional de milisegundos. Cuando se establece en combinación con cacheEnabled, el retraso antes de que la memoria caché alcance su período de invalidación modifica el valor. El valor predeterminado es 0 y usa 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 realizó correctamente. |
| N/D | error | Error de solo lectura de Microsoft Graph si la solicitud no se realizó 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 actualiza si cambian los datos. Pase true para forzar la actualización del componente. |
Eventos
| Evento | Cuándo se emite | Datos personalizados | Cancelable | Burbujas | Funciona con una 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 uno |
No | No | Sí |
Sugerencia
Para obtener más información sobre los datos devueltos en la response propiedad, consulte la referencia de API de la API que usó en la resource propiedad del componente Get.
Para obtener más información sobre el control de eventos, vea eventos.
Plantillas
El mgt-get componente admite varias plantillas que puede usar para definir la apariencia. Para especificar una plantilla, incluya un <template> elemento dentro de un componente y establezca en data-type uno de los siguientes valores.
| Tipo de datos | Contexto de datos | Descripción |
|---|---|---|
| Es el valor predeterminado. | Respuesta de Microsoft Graph. | La plantilla predeterminada es necesaria para representar los datos procedentes de Microsoft Graph. |
| valor | Elemento de datos de la matriz devuelta value |
Use la value plantilla en lugar de la default plantilla al esperar que la respuesta del gráfico contenga una matriz de elementos, como mensajes, archivos o usuarios. La value plantilla se repite automáticamente para cada elemento devuelto por el recurso. La value plantilla también comienza a representar los elementos en cuanto están listos (a diferencia de la plantilla predeterminada). |
| error | Error de Microsoft Graph. | Esta plantilla se usa si se produce un error al realizar la solicitud. |
| Carga | N/D | Esta plantilla se usa mientras se realiza la solicitud. |
| sin datos | N/D | Esta plantilla se usa cuando la solicitud no devuelve datos. |
Permisos de Microsoft Graph
Los permisos requeridos por este componente dependen de los datos que quiera recuperar con él de Microsoft Graph. Microsoft Graph Toolkit comprueba que el usuario actual ha dado su consentimiento a al menos uno de los proporcionados scopes. Para obtener más información sobre los permisos, consulte Referencia de permisos de Microsoft Graph.
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 y cacheInvalidationPeriod . De forma predeterminada, el mgt-get 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 de mgt-get |
Para obtener más información, consulte Almacenamiento en caché.
Localización
El control no expone ninguna variable de localización.