outlookCategory 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
警告
Outlook 任务在 2022 年 8 月 10 日已弃用并停止返回数据。 通过 Outlook 任务更新使用此功能的现有应用。
表示用户可以对 Outlook 项目(如邮件和事件)进行分组的类别依据。 在 Outlook 中,用户定义主列表中的类别,并且可以将这些用户定义的一个或多个类别应用于项目。
使用 REST API,可以在用户类别的主列表中创建和定义类别。 还可以获取主类别列表、获取特定类别、更新与类别相关联的颜色,或删除类别。 可以通过将类别的 displayName 属性分配给项目的 categories 集合,将类别应用到项目。 可分配类别的资源包括 联系人、 事件、 邮件、 outlookTask、 post 和 todoTask。
每个类别由两个属性进行特性化: displayName 和 color。 displayName 值在用户的主列表中必须是唯一的。 但是 ,颜色 不一定是唯一的:主控列表中的多个类别可以映射到同一颜色。 可以在用户的主列表中将多达 25 种不同的颜色映射到类别。
方法
方法 | 返回类型 | Description |
---|---|---|
List | outlookCategory 集合 | 获取为用户定义的所有类别。 |
Get | outlookCategory | 获取指定的 outlookCategory 对象的属性和关系。 |
Create | outlookCategory | 在用户主类别列表中创建 outlookCategory 对象。 |
Update | outlookCategory | 更新指定 outlookCategory 对象的可写属性 color。 |
Delete | None | 删除指定的 outlookCategory 对象。 |
属性
属性 | 类型 | 说明 |
---|---|---|
color | String | 一个预设颜色常量,用于描述类别的特征,并映射到 25 种预定义颜色之一。 有关详细信息,请参阅以下说明。 |
displayName | String | 标识用户邮箱中的类别的唯一名称。 创建类别后,无法更改名称。 此为只读属性。 |
注意颜色的可能值为预设常量,例如
None
、preset0
和preset1
。 每个预设常量进一步映射到一种颜色;实际颜色取决于显示类别的 Outlook 客户端。 下表显示了映射到 Outlook (桌面客户端) 的每个预设常量的颜色。
预设常量 | Outlook 中映射的颜色 |
---|---|
None | 没有映射的颜色 |
Preset0 | 红色 |
Preset1 | 橙色 |
Preset2 | 褐色 |
Preset3 | 黄色 |
Preset4 | 绿色 |
Preset5 | 青色 |
Preset6 | 橄榄绿 |
Preset7 | 蓝色 |
Preset8 | 紫色 |
Preset9 | 蔓越橘色 |
Preset10 | 青灰色 |
Preset11 | 深青灰 |
Preset12 | 灰色 |
Preset13 | 深灰 |
Preset14 | 黑色 |
Preset15 | 深红 |
Preset16 | 暗橙 |
Preset17 | 深褐 |
Preset18 | 深黄 |
Preset19 | 深绿 |
Preset20 | 深青 |
Preset21 | 深橄榄色 |
Preset22 | 深蓝 |
Preset23 | 深紫 |
Preset24 | 深蔓越橘色 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"color": "String",
"displayName": "String"
}