Поделиться через

Тип ресурса channel

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Команды состоят из каналов, являющихся беседами с сотрудниками. Каждый канал предназначен для определенной темы, отдела или проекта. Каналы — это место, где фактически выполняется работа. В них проходят командные обсуждения с помощью текста, аудио и видео, а также выполняется обмен файлами и добавление вкладок.

Методы

Метод Возвращаемый тип Описание
Перечисление каналов Коллекция channel Получение списка каналов в команде.
Перечисление входящих каналов Коллекция channel Получение списка каналов, к которым предоставлен общий доступ в команде.
Перечисление всех каналов Коллекция channel Получение списка каналов в команде или каналов, к которым предоставлен общий доступ в команде (входящие каналы).
Создание канала channel Создание нового канала путем добавления отображаемого имени и описания.
Получение канала channel Чтение свойств и связей канала.
Получение основного канала channel Общий канал для команды.
Обновление канала channel Обновление свойств канала.
Удаление канала Нет Удаление канала.
Перечисление сообщений в каналах chatMessage Получение сообщений в канале
Получение всех сообщений в канале Коллекция channel Получайте все сообщения каналов, в которые входит пользователь.
Получение всех сохраненных сообщений канала Коллекция chatMessage Получение всех сохраненных сообщений по всем каналам в команде.
Создание сообщения канала chatMessage Отправка сообщения в канал.
Создание ответа на сообщение канала chatMessage Ответ на сообщение в канале.
Получение папки с файлами driveItem Получение сведений о папке SharePoint, в которой хранятся файлы канала.
Перечисление вкладок teamsTab Перечисление вкладок, закрепленных в канале.
Перечисление участников канала Коллекция conversationMember Получение списка участников канала.
Добавление участника канала conversationMember Добавление участника в канал. Поддерживается только для каналов, у которых membershipType имеет значение private или shared.
Получение участника канала Коллекция conversationMember Получение участника канала.
Архивный канал Нет Архивирование канала.
Неархивный канал Нет Отмена иерархии канала.
Обновление роли участника канала conversationMember Обновление свойства участника канала. Поддерживается только для каналов, у которых membershipType имеет значение private или shared.
Удаление участника канала Нет Удаление участника канала. Поддерживается только для каналов, у которых membershipType имеет значение private или shared.
Завершение миграции channel Удаление режима миграции из канала, после чего канал становится доступным для публикации и чтения сообщений пользователями.
Перечисление вкладок в канале teamsTab Перечисление вкладок, закрепленных на канале.
Добавление вкладки в канал teamsTab Добавление (закрепление) вкладки на канал.
Получение вкладки на канале teamsTab Получение определенной вкладки, закрепленной на канале.
Вкладка "обновление" на канале teamsTab Обновляет свойства вкладки на канале.
Удаление вкладки из канала Нет Удаление (открепление) вкладки из канала.
Подготовка адреса электронной почты канала provisionChannelEmailResult Подготовка адреса электронной почты для канала.
Удаление адреса электронной почты канала Нет Удаление адреса электронной почты канала.
Удаление входящего канала Нет Удаление входящего канала (канал с общим доступом длякоманды) из команды.
Перечисление команд с общим доступом к каналу Коллекция sharedWithChannelTeamInfo Получите список команд, которые совместно используют указанный канал.
Получение команды с общим доступом к каналу sharedWithChannelTeamInfo Получите команду, которая предоставляет общий доступ к указанному каналу.
Отмена общего доступа к каналу для команды Нет Отмена общего доступа к каналу для команды.
Перечисление разрешенных участников Коллекция conversationMember Получение списка участников команды, у которых есть доступ к общему каналу.
Проверка доступа пользователей Boolean Проверка того, есть ли у пользователя доступ к общему каналу.

Свойства

Свойство Тип Описание
description String Необязательное текстовое описание канала.
displayName String Имя канала, отображаемого для пользователя в Microsoft Teams. Максимальная длина — 50 символов.
id String Уникальный идентификатор канала. Только для чтения.
isFavoriteByDefault Логический Указывает, следует ли пометить канал как рекомендуемый, чтобы все участники команды отображались в списке каналов. Заметка: Все рекомендуемые каналы автоматически отображаются в списке каналов для образовательных и внешних рабочих пользователей. Свойство можно задать только программным способом с помощью метода Create team . Значение по умолчанию — false.
email String Адрес электронной почты для отправки сообщений в канал. Только для чтения.
webUrl String Гиперссылка на канал в Microsoft Teams. Этот URL-адрес предоставляется при щелчке правой кнопкой мыши канала в Microsoft Teams и выборе команды Получить ссылку на канал. Этот URL-адрес должен обрабатываться как непрозрачный BLOB-объект и не должен анализироваться. Только для чтения.
membershipType channelMembershipType Тип канала. Можно настроить во время создания и нельзя изменить. Допустимые значения: standard, private, unknownFutureValue, shared. Значение по умолчанию — standard. Необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующее значение в этой развиваемой перечислении: shared.
createdDateTime dateTimeOffset Только для чтения. Метка времени создания канала.
moderationSettings channelModerationSettings Настройки модерации канала, чтобы контролировать, кто может создавать новые сообщения и отвечать на сообщения в этом канале.
summary channelSummary Содержит сводную информацию о канале, включая количество гостей, участников, владельцев и индикатор для участников из других клиентов. Свойство summary возвращается только в том случае, если оно отображается в предложении $select метода Get channel .
tenantId string Идентификатор клиента Microsoft Entra.
isArchived Boolean Указывает, архивирован ли канал. Только для чтения.

значения channelMembershipType

Member Описание
стандарт Канал наследует список членов родительская команда.
частный В канале могут быть члены, которые являются подмножеством всех членов на родительская команда.
unknownFutureValue Изменяемое значение перечисления sentinel. Не следует использовать.
общие Участники могут быть напрямую добавлены в канал, не добавляя их в команду.

Атрибуты экземпляра

Атрибуты экземпляра — это свойства с особым поведением. Эти свойства являются временными. Они определяют поведение, которое должна выполнять служба, или предоставляют краткосрочные значения свойств, например URL-адрес для скачивания элемента, срок действия которого истекает.

Имя свойства Тип Описание
@microsoft.graph.channelCreationMode Строка Указывает, что канал находится в состоянии миграции и в настоящее время используется для миграции. Принимает одно значение: migration.

Примечание. channelCreationMode — это перечисление, которое принимает значение migration.

Пример запроса POST см. в разделе Запрос (создание канала в состоянии миграции).

Связи

Связь Тип Описание
messages Коллекция chatMessage Коллекция всех сообщений в канале. Свойство навигации. Допускается значение null.
tabs Коллекция teamsTab Коллекция всех вкладок в канале. Свойство навигации.
members Коллекция 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" }
}

Связанные материалы