本文将通过一个示例逐步介绍如何使用 开放扩展。
假设你正在构建一个可在许多不同客户端平台(例如桌面和移动设备)上使用的应用程序。你希望让用户配置自己的 UI 体验,这样无论用户使用何种设备登录你的应用都能获得相同的体验。这是对大多数应用的常见要求。
在此情况下,本文将介绍如何:
- 添加代表有关用户的一些漫游配置文件信息的开放扩展。
- 查询用户并返回漫游配置文件。
- 更改用户的漫游配置文件信息(开放扩展值)。
- 删除用户的漫游配置文件信息。
Note: 本主题介绍如何在 用户 资源上添加、读取、更新、删除开放扩展。 开放扩展也受支持,可以针对其他资源类型进行管理。
1.添加漫游配置文件信息
用户登录到应用并配置应用的外观。这些应用设置应可以漫游,这样用户不管从何种设备登录应用都可以获得相同的体验。在这里,我们将了解如何将漫游配置文件信息添加到用户资源。
请求
POST https://graph.microsoft.com/v1.0/me/extensions
Content-type: application/json
{
"@odata.type":"microsoft.graph.openTypeExtension",
"extensionName":"com.contoso.roamingSettings",
"theme":"dark",
"color":"purple",
"lang":"Japanese"
}
响应
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.openTypeExtension",
"extensionName": "com.contoso.roamingSettings",
"id": "com.contoso.roamingSettings",
"theme": "dark",
"color": "purple",
"lang": "Japanese"
}
2.检索漫游配置文件信息
当用户从其他设备登录应用时,该应用可以检索用户配置文件详细信息及其漫游设置。这可以通过获取用户的资源,以及对扩展导航属性进行扩展的方式完成。
请求
GET https://graph.microsoft.com/v1.0/me?$select=id,displayName,mail,mobilePhone&$expand=extensions
响应
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "84b80893-8749-40a3-97b7-68513b600544",
"displayName": "John Smith",
"mail": "john@contoso.com",
"mobilePhone": "1-555-6589",
"extensions": [
{
"@odata.type": "#microsoft.graph.openTypeExtension",
"extensionName": "com.contoso.roamingSettings",
"id": "com.contoso.roamingSettings",
"theme": "dark",
"color": "purple",
"lang": "Japanese"
}
]
}
Note: 如果你有多个扩展,则可以按 ID 筛选,以获取感兴趣的扩展。
3.更改漫游配置文件信息
用户可以选择更改其漫游配置文件信息。此更新可以通过开放扩展值上的 PATCH 完成。
请求
PATCH https://graph.microsoft.com/v1.0/me/extensions/com.contoso.roamingSettings
Content-type: application/json
{
"theme":"light",
"color":"yellow",
"lang":"Swahili"
}
响应
HTTP/1.1 204 No content
4.删除用户漫游配置文件
用户决定不再使用漫游配置文件,因此将其删除。这可以通过开放扩展值上的 DELETE 请求完成。
请求
DELETE https://graph.microsoft.com/v1.0/me/extensions/com.contoso.roamingSettings
响应
HTTP/1.1 204 No content
另请参阅
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 dkershaw10)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
