频道资源类型

  • 项目

命名空间：microsoft.graph

重要

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

Teams 由频道组成，是你与团队成员的对话。 每个频道专用于特定主题、部门或项目。 频道是工作实际完成的地方 - 对整个团队开放的文本、音频和视频对话的位置、共享文件的位置以及添加标签的位置。

方法

方法 返回类型 说明
列出频道 频道集合 获取此团队中的频道列表。
列出传入通道 channel 集合 获取与某团队共享的频道列表。
示例 1：列出所有频道 channel 集合 获取此团队中的频道列表或与此团队（传入频道)）共享的频道列表。
创建频道 频道 通过包含显示名称和描述来新建频道。
获取频道 频道 读取频道的属性和关系。
获取主通道 频道 团队的常规频道。
更新频道 频道 更新频道属性。
删除频道 无 删除通道。
获取消息 Delta chatMessage 获取频道中的增量消息。
列出频道消息 chatMessage 获取频道中的消息
获取所有频道消息 channel 集合 获取用户参与的所有频道中的所有消息。
获取所有保留的频道消息 chatMessage 集合 获取团队中所有通道的保留消息。
创建频道消息发布 chatMessage 向频道发送消息。
创建回复频道消息发布 chatMessage 在频道中回复消息。
获取文件文件夹 driveItem 检索用于存储频道文件的 SharePoint 文件夹的详细信息。
列出选项卡 teamsTab 列出固定到频道的选项卡。
列出频道成员 conversationMember 集合 获取频道中的成员列表。
添加频道成员 conversationMember 向频道添加成员。 仅支持具有 private 或 sharedmembershipType 的频道。
获取频道成员 conversationMember 集合 获取频道中的成员。
存档通道 None 存档频道。
非存档通道 None 取消存档通道。
更新频道成员角色 conversationMember 更新频道成员的属性。 仅支持具有 private 或 sharedmembershipType 的频道。
删除频道成员 无 从频道中删除一个成员。 仅支持具有 private 或 sharedmembershipType 的频道。
完成迁移 频道 删除频道中的迁移模式，让用户可在频道中发布和阅读消息。
列出频道中的选项卡 teamsTab 列出固定到频道的选项卡。
将选项卡添加到频道 teamsTab 将选项卡添加（固定）到频道。
获取频道中的选项卡 teamsTab 获取固定到频道的特定选项卡。
更新频道中的选项卡 teamsTab 更新频道中的选项卡的属性。
从频道中删除选项卡 无 从频道中删除（取消固定）选项卡。
预配频道电子邮件地址 provisionChannelEmailResult 为频道预配电子邮件地址。
删除频道电子邮件地址 无 删除频道的电子邮件地址。
删除传入频道 无 从团队删除传入频道（从团队共享的频道）。
列出共享频道的团队 sharedWithChannelTeamInfo 集合 获取共享指定频道的团队列表。
获取团队共享频道 Get sharedWithChannelTeamInfo 获取共享指定频道的团队。
与团队取消共享频道 无 取消与团队共享频道。
列出允许的成员 conversationMember 集合 获取有权访问共享频道的团队成员的列表。
检查用户访问权限 Boolean 检查用户是否有权访问共享通道。

属性

属性 类型 说明
说明 String 频道的可选文本描述。
displayName String 在 Microsoft Teams 中向用户显示的频道名称。 最大长度为 50 个字符。
id String 频道的唯一标识符。 只读。
isFavoriteByDefault Boolean 指示是否应对团队的所有成员将频道自动标记到“收藏夹”。 仅可使用“创建团队”以编程方式设置。 默认值：false。
email String 用于向频道发送邮件的电子邮件地址。 只读。
webUrl String 指向 Microsoft Teams 中频道的超链接。 在 Microsoft Teams 中右键单击频道并选择“获取频道链接”时，会提供此 URL。 应将此 URL 视为不透明的 blob，而不对其进行解析。 只读。
membershipType channelMembershipType 频道的类型。 可在创建期间设置，但不可更改。 可能的值包括 standard、private、unknownFutureValue、shared。 默认值为 standard。 必须使用 Prefer: include-unknown-enum-members 请求标头来获取此 可演变枚举中的以下值： shared。
createdDateTime dateTimeOffset 只读。 创建频道的时间戳。
moderationSettings channelModerationSettings 配置频道审核，以控制谁能在此频道中发起新帖子并回复帖子的设置。
摘要 channelSummary 包含有关通道的摘要信息，包括来宾数、成员、所有者和其他租户成员的指示器。 仅当摘要属性出现在 Get 通道方法的 子句中$select时，才会返回该属性。
tenantId string Microsoft Entra租户的 ID。
isArchived Boolean 指示通道是否已存档。 此为只读属性。

channelMembershipType 值

成员 说明
标准 通道继承父团队的成员列表。
私人 通道可以具有成员，这些成员可以是父团队上所有成员的子集。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。
shared 可以直接将成员添加到频道，而无需将他们添加到团队。

实例属性

实例属性是具有特殊行为的属性。 这些属性是临时属性。 它们定义服务应执行的行为，或者提供短期属性值，例如过期项的下载 URL。

属性名称 类型 说明
@microsoft. graph channelCreationMode string 指示频道处于迁移状态，并且当前正用于迁移目的。 它接受一个值：migration。

注意： channelCreationMode 是一个枚举，它采用值 migration。

有关 POST 请求示例，请参阅请求（在迁移状态下创建频道）。

关系

关系 类型 说明
messages chatMessage 集合 频道中的所有消息集合。 一种导航属性。 可为 NULL。
选项卡 teamsTab 集合 频道中的所有选项卡集合。 一种导航属性。
成员 conversationMember 集合 与频道关联的成员资格记录的集合。
filesFolder driveItem 用于存储频道文件的位置的元数据。
operations teamsAsyncOperation 集合 在此团队中运行过或正在运行的异步操作。
sharedWithTeams sharedWithChannelTeamInfo 集合 与之共享频道的团队集合。

JSON 表示形式

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

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "isFavoriteByDefault": true,
  "email": "string",
  "webUrl": "string",
  "membershipType": "String",
  "isArchived": false,
  "createdDateTime": "string (timestamp)",
  "moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}

相关内容