тип ресурса chat

  • Статья

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

Чат — это коллекция chatMessagesages между одним или несколькими участниками . Участниками могут быть пользователи или приложения.

Примечание. Если чат связан с экземпляром onlineMeeting , то некоторые из перечисленных методов будут транзитивно влиять на собрание.

Методы

Метод Возвращаемый тип Описание
Управление чатом
Создание чата chat Создайте чат.
Получение чата chat Чтение свойств и связей чата.
Обновление чата chat Обновление свойств чата.
Удаление чата Нет Удаление чата.
Перечисление участников чата Коллекция conversationMember Получение списка всех пользователей в чате.
Добавление участника в чат Заголовок размещения Добавьте пользователя в чат.
Получение участника чата conversationMember Получение одного пользователя в чате.
Удаление участника чата Нет Удалите пользователя из чата.
Общение в чате между пользователем и приложением chat Получение единого чата между пользователем и приложением
Сообщения
Вывод списка сообщений в чате chatMessage Получение сообщений в чате.
Получение сообщения в чате chatMessage Получение одного сообщения в чате.
Получение сообщений во всех чатах для пользователя коллекция chat Получение сообщений из всех чатах, в которых пользователь является участником.
Приложения
Список приложений в каталоге teamsAppInstallation collection Вывод списка приложений, установленных в чате (и связанном собрании).
Получение приложения в чате teamsAppInstallation Получение определенного приложения, установленного в чате (и связанном собрании).
Добавление приложения в чат Добавление (установка) приложения в чате (и связанном собрании).
Обновление приложения в чате Нет Обновите приложение до последней версии, установленной в чате (и связанном с ним собрании).
Удаление приложения из чата Нет Удалите приложение из чата (и связанного с ним собрания).
Перечисление предоставленных разрешений Коллекция resourceSpecificPermissionGrant Список разрешений, предоставленных приложениям в этом чате.
Вкладки
Вывод списка вкладок в чате teamsTab Список вкладок, закрепленных в чате (и связанном собрании).
Вкладка "Получить" в чате teamsTab Получение определенной вкладки, закрепленной в чате (и связанном с ним собрании).
Добавление вкладки в чат teamsTab Добавление (закрепление) вкладки в чат (и связанное с ним собрание).
Вкладка "Обновление" в чате teamsTab Обновление свойств вкладки в чате (и связанном собрании).
Удаление вкладки из чата Нет Удалите (открепить) вкладку из чата (и связанного собрания).
Закрепленные сообщения
Вывод списка закрепленных сообщений Коллекция pinnedChatMessageInfo Получение списка закрепленных сообщений в чате.
Закрепление сообщения pinnedChatMessageInfo Закрепление сообщения чата в чате.
Открепить сообщение Нет Открепить сообщение из чата.

Примечание: При использовании разрешений приложения убедитесь, что вы знаете, как получить идентификатор чата. Так как перечисление чатов с разрешениями приложений не поддерживается, возможны не все сценарии. Можно получать идентификаторы чатов с делегированными разрешениями и уведомления об изменениях для /chats/getAllMessages с разрешениями приложения.

Свойства

Свойство Тип Описание
chatType chatType Указывает тип чата. Возможные значения: group, oneOnOne, meeting, unknownFutureValue.
createdDateTime dateTimeOffset Дата и время создания чата. Только для чтения.
id String Уникальный идентификатор чата. Только для чтения.
lastUpdatedDateTime dateTimeOffset Дата и время переименования чата или последнего изменения списка участников. Только для чтения.
onlineMeetingInfo teamworkOnlineMeetingInfo Представляет сведения о собрании по сети. Если чат не связан с собранием по сети, свойство будет пустым. Только для чтения.
tenantId String Идентификатор клиента, в котором был создан чат. Только для чтения.
topic String (Необязательно) Тема или тема для чата. Доступно только для групповых чатов.
Точки обзора chatViewpoint Представляет сведения о чате, относящиеся к звонящей, например дату и время последнего чтения сообщения. Это свойство заполняется только в том случае, если запрос выполняется в делегированном контексте.
webUrl String URL-адрес чата в Microsoft Teams. URL-адрес должен рассматриваться как непрозрачный BLOB-объект, а не анализироваться. Только для чтения.

значения chatType

Элемент Значение Описание
oneOnOne 0 Указывает, что чат является чатом 1:1. Размер списка фиксированный для этого типа чата; элементы не могут быть удалены или добавлены.
group 1 Указывает, что чат является групповым чатом. Размер списка (не менее двух человек) можно обновить для этого типа чата. Члены могут быть удалены или добавлены позже.
Конференц 2 Указывает, что чат связан с собранием по сети. Этот тип чата создается только при создании собрания по сети.
unknownFutureValue 3 Изменяемое значение перечисления sentinel. Не используйте.

Связи

Связь Тип Описание
installedApps teamsAppInstallation collection Коллекция всех приложений в чате. Допускается значение null.
lastMessagePreview chatMessageInfo Предварительный просмотр последнего сообщения, отправленного в чате. Значение NULL, если сообщения не были отправлены в чате. В настоящее время только операция со списком чатов поддерживает это свойство.
members Коллекция conversationMember Коллекция всех участников в чате. Допускается значение null.
messages Коллекция chatMessage Коллекция всех сообщений в чате. Допускается значение null.
permissionGrants Коллекция resourceSpecificPermissionGrant Коллекция разрешений, предоставленных приложениям для чата.
pinnedMessages Коллекция pinnedChatMessageInfo Коллекция всех закрепленных сообщений в чате. Допускается значение null.
tabs Коллекция teamsTab Коллекция всех вкладок в чате. Допускается значение null.

Представление JSON

Ниже указано представление ресурса в формате JSON.

{
  "createdDateTime": "dateTimeOffset",
  "chatType": "string",
  "id": "string (identifier)",
  "lastUpdatedDateTime": "dateTimeOffset",
  "onlineMeetingInfo": {
    "@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
  },
  "tenantId": "string",
  "topic": "string",
  
  "viewpoint": {
    "@odata.type": "microsoft.graph.chatViewpoint"
  },
  "webUrl": "string",
}

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