培训
模块
使用 Microsoft Graph 工具包时提高应用的性能 - Training
了解 Microsoft Graph 工具包提供的缓存功能,并了解如何在 Microsoft Graph 工具包组件中快速显示可能需要的任何更多数据。
可以使用 mgt-get
在 HTML 中直接从 Microsoft Graph 进行任何 GET 查询。 组件不提供默认 UI,需要编写模板。
以下示例演示如何使用 mgt-get
组件来显示用户的电子邮件。 可以使用代码编辑器查看 属性和属性 如何更改组件的行为。
可以使用多个属性来更改组件的行为。 唯一必需的属性是 resource
。
属性 | 属性 | 说明 |
---|---|---|
资源 | resource | 要从 Microsoft Graph (获取的资源, /me 例如,) 。 |
scopes | scopes | 可选的字符串数组(如果使用 属性)或逗号分隔的范围(如果使用 属性)。 组件和支持的提供程序确保用户同意至少一个提供的权限。 |
version | version | 发出 GET 请求时要使用的可选 API 版本。 默认值为“v1.0 ”。 |
max-pages | maxPages | 支持分页) 的资源的可选页数 (。 默认值为 3。 将此值设置为 0 将检索所有页面。 |
polling-rate | pollingRate | 可选的毫秒数。 设置后,组件在定义的间隔内轮询更新的请求 URI。 如果使用增量查询,轮询始终查询增量 API。 模板仅在数据更改时刷新。 |
已启用缓存 | cacheEnabled | 可选属性,类型为 Boolean。 设置后,它指示缓存了来自资源的响应。 如果 refresh() 调用 或 正在使用,则 pollingRate 重写。 默认值为“false ”。 |
cache-invalidation-period | cacheInvalidationPeriod | 可选的毫秒数。 当与 cacheEnabled 组合设置时,缓存达到其失效期限之前的延迟会修改值。 默认值为 0 ,并使用默认无效期限。 |
type | type | 所需响应的可选类型。 默认值为“json ”。 支持 json 或 image (仅在以 /photo/value$ ) 结尾的终结点上受支持。 |
不适用 | 响应 | 如果请求成功,则提供来自 Microsoft Graph 的只读响应。 |
不适用 | error | 如果请求不成功,则来自 Microsoft Graph 的只读错误。 |
方法 | 说明 |
---|---|
刷新 (force?:布尔) | 调用 方法以刷新数据。 默认情况下,仅当数据发生更改时,UI 才会更新。 传递 true 以强制更新组件。 |
事件 | 何时发出 | 自定义数据 | 可取消 | 泡沫 | 使用自定义模板 |
---|---|---|---|---|---|
dataChange |
组件加载其数据后触发。 |
{ response: any, error: any } . 属性 response 包含从 Microsoft Graph 检索的响应。 属性 error 包含有关错误的信息(如果发生错误) |
否 | 否 | 是 |
提示
有关 属性中 response
返回的数据的详细信息,请参阅在 Get 组件的 属性中使用的 resource
API 的 API 参考。
有关处理事件的详细信息,请参阅 事件。
组件 mgt-get
支持多个 模板 ,可用于定义外观。 若要指定模板,请在组件中包含元素 <template>
,并将 设置为 data-type
以下值之一。
数据类型 | 数据上下文 | 说明 |
---|---|---|
默认 | 来自 Microsoft Graph 的响应。 | 需要默认模板来呈现来自 Microsoft Graph 的数据。 |
值 | 返回 value 数组中的数据项 |
value 当希望图形中的响应包含一组项(如消息、文件或用户)时,请使用模板而不是default 模板。 对于 value 资源返回的每个项,模板会自动重复。 模板 value 还会在项准备就绪后立即开始呈现, (与默认模板) 不同。 |
error | 来自 Microsoft Graph 的错误。 | 如果发出请求时出错,则使用此模板。 |
加载 | 不适用 | 发出请求时使用此模板。 |
no-data | 不适用 | 请求未返回任何数据时使用此模板。 |
此组件所需的权限取决于要从 Microsoft Graph 中检索的数据。 Microsoft Graph 工具包验证当前用户是否同意至少一个提供的 scopes
。 有关权限的详细信息,请参阅 Microsoft Graph 权限参考。
控件使用 身份验证文档中 所述的全局身份验证提供程序来提取所需的数据。
若要启用和配置缓存,请使用 cacheEnabled
和 cacheInvalidationPeriod
属性。 默认情况下, mgt-get
组件不缓存任何响应。
对象存储 | 缓存的数据 | 备注 |
---|---|---|
response |
为 的 属性中指定的 resource 查询从 Microsoft Graph 检索到的完整响应 mgt-get |
有关详细信息,请参阅 缓存。
控件不公开任何本地化变量。
培训
模块
使用 Microsoft Graph 工具包时提高应用的性能 - Training
了解 Microsoft Graph 工具包提供的缓存功能,并了解如何在 Microsoft Graph 工具包组件中快速显示可能需要的任何更多数据。