teamworkSection 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

表示用户的 Microsoft Teams 聊天列表中的一个部分,该部分将聊天、频道和会议组织到自定义或系统定义的组中。 分区可以是用户定义的,允许用户创建、重命名和删除它们,也可以是系统定义的,由服务管理。

方法

方法 返回类型 Description
List teamworkSection 集合 获取用户团队合作中的分区列表。
创建 teamworkSection 在用户的团队合作中创建新分区。
Get teamworkSection 读取用户团队合作中某个部分的属性。
更新 teamworkSection 更新用户团队合作中分区的属性。
删除 无 从用户的团队合作中删除用户定义的分区。
重新排序 teamworkSection 集合 对用户团队合作中的所有分区重新排序。
列表项 teamworkSectionItem 集合 获取用户团队合作某个部分中的项目列表。

属性

属性 类型 说明
createdDateTime DateTimeOffset 创建节的日期和时间。 只读。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2024 年 1 月 1 日的午夜 UTC 时间为 2024-01-01T00:00:00Z。
displayIcon sectionDisplayIcon 为分区显示的图标。
displayName String 分区的显示名称。 必填。 最大长度为 50 个字符。 显示名称区分大小写,并且在用户的部分中必须是唯一的。 以下名称是为系统定义的部分保留的,在创建用户定义的部分时不能使用: RecentChats、、EngageCommunitiesQuickViewsTeamsAndChannelsMutedChatsMeetingChats、、。
id String 节的唯一标识符。 只读。
isExpanded 布尔值 指示该部分是否在用户界面中展开。 默认值为 true。
isHierarchicalViewEnabled 布尔值 指示是否为分层视图启用了分层视图。 只读。
lastModifiedDateTime DateTimeOffset 上次修改节的日期和时间。 只读。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2024 年 1 月 1 日的午夜 UTC 时间为 2024-01-01T00:00:00Z。
sectionType sectionType 节的类型。 可能的值包括 userDefined、systemDefined、unknownFutureValue。 只读。
sortType sectionSortType 节中项目的排序顺序。 有效值取决于 sectionType。 可能的值包括 mostRecent、unreadThenMostRecent、nameAlphabetical、userDefinedCustomOrder、unknownFutureValue。

sectionType 值

成员 说明
userDefined 用户创建的可重命名、重新排序和删除的部分。
systemDefined 由服务管理的无法删除的部分。 只能更新 sortType 属性。
unknownFutureValue 可进化枚举哨兵值。 请勿使用。

系统定义的节

系统定义的分区由服务预配,并显示在每个用户的分区列表中。 其 displayName 值是保留的,不能用于用户定义的部分。

displayName 说明
最近聊天室 默认聊天部分。
概览 “快速视图”部分。
TeamsAndChannels 团队和频道部分。
MutedChats 静音聊天部分。
MeetingChats 会议聊天部分。
EngageCommunities 社区部分。

无法删除系统定义的部分,并且只能更新 sortType 属性。 尝试更新其他属性或删除系统定义的分区 403 Forbiddenreturn . 不支持通过调用 List 项列出系统定义的节上的项,并且返回 400 Bad Request。 使用 ?$expand=items调用 List sections 或 Get teamworkSection 时,系统定义的分区将使用空项数组返回,因为系统定义的节内容不会通过公共图形 API 公开。

sectionSortType 值

成员 说明
mostRecent 按最近活动对项目进行排序。 对用户定义和大多数系统定义的部分有效。
unreadThenMostRecent 首先对未读项目进行排序,然后按最近的活动排序。 对用户定义和大多数系统定义的部分有效。
名称按字母顺序 按名称字母顺序对项目进行排序。 仅对特定的系统定义部分有效,例如 Teams 和 频道。 对用户定义的节无效。
userDefinedCustomOrder 根据用户定义的自定义顺序对项目进行排序。 仅对用户定义的部分有效。 这是用户定义的新节的默认排序类型。
unknownFutureValue 可进化枚举哨兵值。 请勿使用。

注意

系统定义的分区的有效排序类型取决于特定分区。 例如, Teams 和 频道 部分支持 nameAlphabetical,但 RecentChats 和 MutedChats 部分仅 mostRecent 支持 和 unreadThenMostRecent。 当“团队和频道”部分的属性 isHierarchicalViewEnabled 设置为true“仅”有效“时。nameAlphabetical 设置不受支持的排序类型将返回 400 Bad Request 错误。

实例属性

实例属性是具有特殊行为的属性。 这些属性是临时的,并且 a) 定义服务应执行的行为或 b) 提供短期的属性值,例如过期项目的下载 URL。

属性名称 类型 说明
@microsoft.graph.sectionsOrder 字符串集合 表示用户首选的节顺序的节 ID 的有序数组。
@microsoft.graph.sectionsVersion String 当前分区层次结构版本。 每当修改节或节项时,值都会更改。

关系

关系 类型 说明
items teamworkSectionItem 集合 聊天、频道、会议或社区 (项目) 在该部分中组织。

JSON 表示形式

以下 JSON 表示形式显示资源类型。

{
  "@odata.type": "#microsoft.graph.teamworkSection",
  "createdDateTime": "String (timestamp)",
  "displayIcon": {"@odata.type": "microsoft.graph.sectionDisplayIcon"},
  "displayName": "String",
  "id": "String (identifier)",
  "isExpanded": "Boolean",
  "isHierarchicalViewEnabled": "Boolean",
  "lastModifiedDateTime": "String (timestamp)",
  "sectionType": "String",
  "sortType": "String"
}