тип ресурса chat
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет чат, представляющий собой коллекцию chatMessages между одним или несколькими участниками . Участниками могут быть пользователи или приложения.
Примечание. Если чат связан с экземпляром onlineMeeting , некоторые из перечисленных методов транзитивно влияют на собрание.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Управление чатом | ||
| Вывод списка чатов | коллекция chat | Получение списка чатов, в которые входит пользователь. |
| Создание чата | chat | Создайте чат. |
| Получение чата | chat | Чтение свойств и связей чата. |
| Обновление чата | chat | Обновление свойств чата. |
| удаление; | Нет | Удаление чата. |
| Удаление всех доступа для пользователя | Нет | Удаление доступа к чату для пользователя. |
| Перечисление участников | Коллекция conversationMember | Получение списка всех пользователей в чате. |
| Добавление участника | Заголовок Location | Добавьте пользователя в чат. |
| Получение участника | conversationMember | Получение одного пользователя в чате. |
| Удаление участника | Нет | Удалите пользователя из чата. |
| Общение в чате между пользователем и приложением | chat | Получите единый чат между пользователем и приложением. |
| Пометка чата как прочитанного | Нет | Пометить чат как прочитанное для пользователя. |
| Пометка чата как непрочитанных | Нет | Пометить чат как непрочитанное для пользователя. |
| Скрыть чат | Нет | Скрыть чат для пользователя. |
| Отображение чата | Нет | Отображение чата для пользователя. |
| Сообщения | ||
| Список сообщений в чате | chatMessage | Получение сообщений в чате. |
| Получение ответа на сообщение | chatMessage | Получение одного сообщения в чате. |
| Получение сообщений во всех чатах | коллекция chat | Получение сообщений из всех чатах, в которых пользователь является участником. |
| Получение сохраненных сообщений во всех чатах | Коллекция chatMessage | Получение всех сохраненных сообщений из всех чатов , участником которых является пользователь, включая чаты по отдельности, групповые чаты и чаты собраний. |
| Получение сообщений разностного чата для пользователя | Коллекция chatMessage | Получите список сообщений из всех чатов , участником которых является пользователь, включая чаты с одним на один, групповые чаты и чаты собраний. |
| Приложения | ||
| Список приложений в каталоге | teamsAppInstallation collection | Вывод списка приложений, установленных в чате (и связанном собрании). |
| Установка приложения в чате | teamsAppInstallation | Получение определенного приложения, установленного в чате (и связанном собрании). |
| Добавление приложения в чат | Добавление (установка) приложения в чате (и связанном собрании). | |
| Обновление приложения, установленного в чате | Нет | Обновите приложение до последней версии, установленной в чате (и связанном с ним собрании). |
| Удаление приложения из чата | Нет | Удалите приложение из чата (и связанного с ним собрания). |
| Перечисление предоставленных разрешений | Коллекция resourceSpecificPermissionGrant | Список разрешений, предоставленных приложениям в этом чате. |
| Вкладки | ||
| Вывод списка вкладок в чате | teamsTab | Список вкладок, закрепленных в чате (и связанном собрании). |
| Вкладка "Получить" в чате | teamsTab | Получение определенной вкладки, закрепленной в чате (и связанном с ним собрании). |
| Добавление вкладки в чат | teamsTab | Добавление (закрепление) вкладки в чат (и связанное с ним собрание). |
| Вкладка "Обновление" в чате | teamsTab | Обновление свойств вкладки в чате (и связанном собрании). |
| Удаление вкладки из чата | Нет | Удалите (открепить) вкладку из чата (и связанного собрания). |
| Операции | ||
| Операции со списком | Коллекция teamsAsyncOperation | Получите список асинхронных операций, которые выполнялись или выполняются в чате. |
| Получение операции в чате | teamsAsyncOperation | Получите одну асинхронную операцию, которая выполняется или выполняется в чате. |
| Закрепленные сообщения | ||
| Вывод списка закрепленных сообщений | Коллекция pinnedChatMessageInfo | Получение списка закрепленных сообщений в чате. |
| Сообщение о закреплении | pinnedChatMessageInfo | Закрепление сообщения чата в чате. |
| Открепить сообщение | Нет | Открепить сообщение из чата. |
Заметка: При использовании разрешений приложения убедитесь, что вы знаете, как получить идентификатор чата. Так как перечисление чатов с разрешениями приложений не поддерживается, возможны не все сценарии. Можно получать идентификаторы чатов с делегированными разрешениями и уведомления об изменениях для /chats/getAllMessages с разрешениями приложения.
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| chatType | chatType | Указывает тип чата. Возможные значения: group, oneOnOne, meeting, unknownFutureValue. |
| createdBy | identitySet | Пользователь или приложение, создавший чат. Только для чтения. |
| createdDateTime | dateTimeOffset | Дата и время создания чата. Только для чтения. |
| id | String | Уникальный идентификатор чата. Только для чтения. |
| isHiddenForAllMembers | Логический | Указывает, скрыт ли чат для всех его участников. Только для чтения. |
| lastUpdatedDateTime | dateTimeOffset | Дата и время переименования чата или последнего изменения списка участников. Только для чтения. |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | Представляет сведения о собрании по сети. Если чат не связан с собранием по сети, свойство будет пустым. Только для чтения. |
| tenantId | String | Идентификатор клиента, в котором был создан чат. Только для чтения. |
| topic | String | (Необязательно) Тема или тема для чата. Доступно только для групповых чатов. |
| точка зрения | chatViewpoint | Представляет сведения о чате, относящиеся к звонящей, например дата и время чтения последнего сообщения. Это свойство заполняется только в том случае, если запрос выполняется в делегированном контексте. |
| webUrl | String | URL-адрес чата в Microsoft Teams. URL-адрес должен рассматриваться как непрозрачный BLOB-объект, а не анализироваться. Только для чтения. |
значения chatType
| Member | Описание |
|---|---|
| oneOnOne | Указывает, что чат является чатом 1:1. Размер списка фиксированный для этого типа чата; элементы не могут быть удалены или добавлены. |
| group | Указывает, что чат является групповым чатом. Размер списка (не менее двух человек) можно обновить для этого типа чата. Члены могут быть удалены или добавлены позже. |
| встреча | Указывает, что чат связан с собранием по сети. Этот тип чата создается только при создании собрания по сети. |
| unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
Связи
| Связь | Тип | Описание |
|---|---|---|
| installedApps | teamsAppInstallation collection | Коллекция всех приложений в чате. Допускается значение null. |
| lastMessagePreview | chatMessageInfo | Предварительный просмотр последнего сообщения, отправленного в чате.
Null Значение , если сообщения не отправляются в чате. В настоящее время только операция со списком чатов поддерживает это свойство. |
| members | Коллекция conversationMember | Коллекция всех участников в чате. Допускается значение null. |
| messages | Коллекция chatMessage | Коллекция всех сообщений в чате. Допускается значение null. |
| operations | Коллекция teamsAsyncOperation | Коллекция всех асинхронных операций Teams, которые выполнялись или выполняются в чате. Допускается значение null. |
| permissionGrants | Коллекция resourceSpecificPermissionGrant | Коллекция разрешений, предоставленных приложениям для чата. |
| pinnedMessages | Коллекция pinnedChatMessageInfo | Коллекция всех закрепленных сообщений в чате. Допускается значение null. |
| tabs | Коллекция teamsTab | Коллекция всех вкладок в чате. Допускается значение null. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"chatType": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "string (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "String (timestamp)",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "String",
"topic": "String",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "String"
}