Búsqueda componente de resultados en Microsoft Graph Toolkit
Puede usar mgt-search-results para realizar consultas de búsqueda en Microsoft Graph directamente en su HTML. El componente proporciona algunas representaciones de tipo de resultado predeterminadas, pero también ofrece una personalización completa de las plantillas.
Ejemplo
En el ejemplo siguiente se muestra el uso del mgt-search-results componente en los documentos más relevantes. 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. Los atributos necesarios son query-string y entity-types.
| Atributo | Propiedad | Descripción |
|---|---|---|
| query-string | Querystring | Consulta que se va a enviar a Microsoft Búsqueda. |
| entity-types | entityTypes | Se esperan uno o varios tipos de recursos en la respuesta. Los valores posibles son: list, site, listItem, message, event, drive, driveItem, person, externalItem, acronym, bookmark, chatMessage. El valor predeterminado es driveItem, listItem, site. |
| content-sources | contentSources | Orígenes de contenido que se van a usar con elementos externos. |
| paging-max | pagingMax | Número máximo de páginas en las que se puede hacer clic en el control de paginación. El valor predeterminado es 7. |
| query-template | queryTemplate | Plantilla de consulta que se usará en escenarios de búsqueda complejos. Actualmente, las plantillas de consulta solo se admiten en el punto de conexión beta. |
| fetch-thumbnail | fetchThumbnail | Establece si se debe capturar la miniatura del resultado de Microsoft Graph. El valor predeterminado es false. |
| enable-top-results | enableTopResults | Esto desencadena la ordenación híbrida de los mensajes: los tres primeros mensajes son los más relevantes. Esta propiedad solo es aplicable a entityType=message. El valor predeterminado es false. |
| ámbitos | ámbitos | Matriz opcional de cadenas si se usa la propiedad o un ámbito delimitado por comas si se usa el atributo . El componente usa estos ámbitos (con un proveedor compatible) para asegurarse de que el usuario da su consentimiento al permiso adecuado. |
| size | size | Tamaño de la página que se va a recuperar. El valor máximo es 1000. El valor predeterminado es 10. |
| fields | fields | Contiene los campos que se devolverán para cada recurso. |
| version | version | Versión de API opcional que se usará al realizar la solicitud. El valor predeterminado es v1.0. |
| 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, este valor modifica el retraso antes de que la memoria caché alcance su período de invalidación. El valor predeterminado es 30000 y usa el período de invalidación predeterminado. |
| N/D | error | Error de solo lectura de Microsoft Graph si la solicitud no se realizó correctamente. |
Propiedades personalizadas css
El mgt-search-results componente define las siguientes propiedades personalizadas CSS.
<mgt-search-results
class="search-results"
query-string="contoso"
entity-types="driveItem"
></mgt-search-results>
.search-results {
--answer-border-radius: 10px;
--answer-box-shadow: 0px 2px 30px pink;
--answer-border: dotted 2px white;
--answer-padding: 8px 0px;
}
Para obtener más información, consulte Componentes de estilo.
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í |
Para obtener más información sobre el control de eventos, vea eventos.
Plantillas
El mgt-search-results 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. | El valor predeterminado se puede usar para representar toda la respuesta procedente de Microsoft Graph. |
| Resultado-* | Elemento de datos de la matriz devuelta value |
Use la result-* plantilla en lugar de la default plantilla al esperar que la respuesta del gráfico contenga una matriz de elementos. La result-* plantilla se repite automáticamente para cada elemento devuelto por el recurso. La result-* plantilla comienza a representar los elementos en cuanto están listos (a diferencia de la plantilla predeterminada). Puede tener varias result-* plantillas, una por entityType (consulte las disponibles entity-type en propiedades y atributos) |
| 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. Para obtener más información sobre los permisos, consulte Uso de microsoft Búsqueda API para consultar datos.
Subcomponentes
El mgt-search-results componente consta de uno o varios subcomponentes que pueden requerir permisos distintos de los necesarios para este componente. Para obtener más información, consulte la documentación de cada subcomponente:
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-search-results 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 ejecutada por mgt-search-results |
Para obtener más información, consulte Almacenamiento en caché.
Localización
El control expone las siguientes variables que se pueden localizar. Para obtener más información sobre cómo configurar la localización, consulte Localización de componentes.
| Nombre de cadena | Valor predeterminado |
|---|---|
| modificado | modified on |
| Atrás | Back |
| next | Next |
| páginas | pages |
| page | Page |