Тип ресурса упоминания

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

Важно!

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

Представляет уведомление для пользователя на основе его адреса электронной почты. Этот тип уведомлений также называется @-упоминаниями.

Ресурс сообщения поддерживает упоминание. Он содержит свойство упоминанияPreview , указывающее, упоминается ли вошедшего пользователя в этот экземпляр сообщения. Он также включает свойство навигации упоминаний , которое поддерживает получение сведений об упоминании или удаление упоминания в этом экземпляре.

При создании сообщения приложение может создать упоминание в том же запросе POST , включив его в свойство упоминания . GET Используя запрос с параметром $filter запроса, приложение может возвращать все сообщения в почтовом ящике вошедшего пользователя, в которые упоминается пользователь. Запрос GET с параметром $expand запроса позволяет приложению развернуть все упоминания в определенном сообщении.

Этот механизм, позволяющий приложению задавать и получать упоминания в сообщениях, позволяет легко получать уведомления, когда пользователь, создающий упоминание, может оставаться в существующем контексте (например, при создании текста сообщения), а приложение задает базовое свойство упоминания . Упомянутые лица могут легко узнать, упоминаются ли они и где, с помощью GET запросов с параметром $filter запроса или $expand .

Например, в почтовом клиенте Outlook, когда пользователь вводит @ текст при написании сообщения, Outlook позволяет пользователю выбрать или ввести имя для завершения @-упоминания. Outlook задает свойство упоминания перед созданием и отправкой сообщения или события. Outlook также использует GET операции с $filter вошедшего пользователя и $expand для поиска сообщений, в которых упоминается пользователь, предупреждая пользователя о действиях или обсуждениях, что позволяет быстрее отвечать на них.

Методы

Метод	Возвращаемый тип	Описание
Публикация и отправка	Нет	Создание и отправка упоминаний в составе нового сообщения.
Публикация в новом черновике	сообщение , содержащее один или несколько объектов упоминания .	Создайте черновик нового сообщения и включите один или несколько объектов упоминания .
Получение сообщений, упоминающих меня	Коллекция message	Получите все сообщения в почтовом ящике вошедшего пользователя, содержащие упоминание этого пользователя.
Получение сообщения и его упоминания	Коллекция message	Получите сообщение и разверните сведения о каждом упоминании в сообщении.
Удаление упоминания	Нет	Удалите указанное упоминание в указанном сообщении в почтовом ящике пользователя, выполнившего вход.

Свойства

Свойство	Тип	Описание
приложение	String	Имя приложения, в котором создается упоминание. Необязательный параметр. Не используется и по умолчанию имеет значение NULL для сообщения.
clientReference	String	Уникальный идентификатор, представляющий родительский объект экземпляра ресурса. Необязательный параметр. Не используется и по умолчанию имеет значение NULL для сообщения.
createdBy	emailAddress	Сведения об адресе электронной почты пользователя, который сделал это упоминание.
createdDateTime	DateTimeOffset	Дата и время создания упоминания на клиенте.
deepLink	String	Прямая веб-ссылка на контекст упоминания в экземпляре ресурса. Необязательный параметр. Не используется и по умолчанию имеет значение NULL для сообщения.
id	String	Уникальный идентификатор упоминания в экземпляре ресурса.
упомянутый	emailAddress	Сведения об адресе электронной почты указанного человека. Обязательно.
mentionText	String	Необязательный параметр. Не используется и по умолчанию имеет значение NULL для сообщения. Чтобы получить упоминания в сообщении, см. свойство bodyPreview сообщения.
serverCreatedDateTime	DateTimeOffset	Дата и время создания упоминания на сервере. Необязательный параметр. Не используется и по умолчанию имеет значение NULL для сообщения.

Связи

Отсутствуют.

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

В следующем представлении JSON показан тип ресурса.

{
  "application": "string",
  "clientReference": "string",
  "createdBy": {"@odata.type": "microsoft.graph.emailAddress"},
  "createdDateTime": "DateTimeOffset",
  "deepLink": "string",
  "id": "string (identifier)",
  "mentioned": {"@odata.type": "microsoft.graph.emailAddress"},
  "mentionText": "string",
  "serverCreatedDateTime": "DateTimeOffset"
}