Microsoft Graph 工具包中的搜索结果组件
可以使用 mgt-search-results 在 HTML 中直接对 Microsoft Graph 进行搜索查询。 该组件提供一些默认的结果类型呈现，但也提供模板的完全自定义。
示例
以下示例演示如何将 组件用于 mgt-search-results 最相关的文档。 可以使用代码编辑器查看 属性和属性 如何更改组件的行为。
属性和属性
可以使用多个属性来更改组件的行为。 所需的属性为 query-string 和 entity-types。
| 属性 | 属性 | 说明 |
|---|---|---|
| query-string | queryString | 要发送到 Microsoft 搜索 的查询。 |
| entity-types | entityTypes | 响应中预期的一个或多个资源类型。 可能的值包括：list、site、listItem、message、event、drive、driveItem、person、externalItem、acronym、bookmark、chatMessage。 默认值为 driveItem、 listItem、 site。 |
| content-sources | contentSources | 用于外部项的内容源。 |
| paging-max | pagingMax | 在分页控件中可单击的最大页数。 默认值为“7”。 |
| query-template | queryTemplate | 用于复杂搜索方案的查询模板。 查询模板目前仅在 beta 终结点上受支持。 |
| fetch-thumbnail | fetchThumbnail | 设置是否应从 Microsoft Graph 提取结果缩略图。 默认值为“false”。 |
| enable-top-results | enableTopResults | 这会触发消息的混合排序：前三条消息最相关。 此属性仅适用于 entityType=message。 默认值为“false”。 |
| scopes | scopes | 可选的字符串数组（如果使用 属性）或逗号分隔的范围（如果使用 属性）。 组件将这些范围 (与受支持的提供程序) 一起使用，以确保用户同意正确的权限。 |
| size | size | 要检索的页面的大小。 最大值为 1000。 默认值为“10”。 |
| fields | fields | 包含要为每个资源返回的字段。 |
| version | version | 发出请求时要使用的可选 API 版本。 默认值为“v1.0”。 |
| 已启用缓存 | cacheEnabled | 可选属性，类型为 Boolean。 设置后，它指示缓存了来自资源的响应。 如果 refresh() 调用 或 正在使用，则 pollingRate 重写。 默认值为“false”。 |
| cache-invalidation-period | cacheInvalidationPeriod | 可选的毫秒数。 当与 cacheEnabled组合设置时，缓存达到其失效期限之前的延迟由此值修改。 默认值为 30000 ，并使用默认无效期限。 |
| 不适用 | error | 如果请求不成功，则来自 Microsoft Graph 的只读错误。 |
CSS 自定义属性
组件 mgt-search-results 定义以下 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;
}
若要了解详细信息，请参阅 设置组件样式。
方法
| 方法 | 说明 |
|---|---|
| 刷新 (force？：布尔) | 调用 方法以刷新数据。 默认情况下，仅当数据发生更改时，UI 才会更新。 传递 true 以强制更新组件。 |
事件
| 事件 | 何时发出 | 自定义数据 | 可取消 | 泡沫 | 使用自定义模板 |
|---|---|---|---|---|---|
dataChange |
组件加载其数据后触发。 |
{ response: any, error: any }. 属性 response 包含从 Microsoft Graph 检索的响应。 属性 error 包含有关发生错误的信息。 |
否 | 否 | 是 |
有关处理事件的详细信息，请参阅 事件。
模板
组件 mgt-search-results 支持多个 模板 ，可用于定义外观。 若要指定模板，请在组件中包含元素 <template> ，并将 设置为 data-type 以下值之一。
| 数据类型 | 数据上下文 | 说明 |
|---|---|---|
| 默认 | 来自 Microsoft Graph 的响应。 | 默认值可用于呈现来自 Microsoft Graph 的整个响应。 |
| 结果-* | 返回 value 数组中的数据项 |
result-*当希望图形中的响应包含项数组时，请使用模板而不是default模板。 对于 result-* 资源返回的每个项，模板会自动重复。 模板 result-* 在项准备就绪后立即开始呈现， (与默认模板) 不同。 可以有多个result-*模板，每个entityType模板一个 (请参阅属性和属性中的可用 entity-type) |
| error | 来自 Microsoft Graph 的错误。 | 如果发出请求时出错，则使用此模板。 |
| 加载 | 不适用 | 发出请求时使用此模板。 |
| no-data | 不适用 | 请求未返回任何数据时使用此模板。 |
Microsoft Graph 权限
此组件所需的权限取决于要从 Microsoft Graph 中检索的数据。 有关权限的详细信息，请参阅使用 Microsoft 搜索 API 查询数据。
子组件
组件 mgt-search-results 由一个或多个子组件组成，这些子组件可能需要除此组件所需的权限以外的其他权限。 有关详细信息，请参阅每个子组件的文档：
身份验证
控件使用 身份验证文档中 所述的全局身份验证提供程序来提取所需的数据。
缓存
若要启用和配置缓存，请使用 cacheEnabled 和 cacheInvalidationPeriod 属性。 默认情况下， mgt-search-results 组件不缓存任何响应。
| 对象存储 | 缓存的数据 | 备注 |
|---|---|---|
response |
从 Microsoft Graph 检索到的查询执行者的完整响应 mgt-search-results |
有关详细信息，请参阅 缓存。
本地化
控件公开以下可本地化的变量。 有关如何设置本地化的详细信息，请参阅 本地化组件。
| 字符串名称 | 默认值 |
|---|---|
| 修改内容 | modified on |
| 返回 | Back |
| next | Next |
| pages | pages |
| page | Page |