Office.NotificationMessageDetails interface

Пакет:
outlook

Массив объектов NotificationMessageDetails, возвращаемых методом NotificationMessages.getAllAsync.

Комментарии

Набор API: Почтовый ящик 1.3

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Важно! Дополнительные сведения о различных типах уведомлений, которые можно реализовать, см. в статье "Создание уведомлений для надстройки Outlook".

Используется

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }
  console.log(JSON.stringify(asyncResult.value));
});

Свойства

actions

Указывает действия для сообщения. Лимит: 1 действие. В это ограничение не учитывается действие "Закрыть", включенное по умолчанию. Применимо только в том случае, если типом является InsightMessage. Указание этого свойства для неподдерживаемого типа или включение слишком большого количества действий вызывает ошибку.

Важно! В современной Outlook в Интернете и новой версии Outlook для Windows свойство actions доступно только в режиме Compose.
icon

Ссылка на настраиваемый значок, определенный в манифесте. Значок появится перед сообщением уведомления в области информационной панели. Для и уведомлений должен быть указан InformationalMessageInsightMessage значок.
key

Идентификатор для сообщения уведомления.
message

Текст сообщения уведомления. Максимальная длина составляет 150 символов. Если разработчик передает строку большей длины, возвращается исключение ArgumentOutOfRange.
persistent

Указывает, должно ли сообщение быть постоянным. Применимо только для типа .InformationalMessage Если значение равно true, сообщение остается до тех пор, пока не будет удалено этой надстройкой или закрыто пользователем. Если false, оно удаляется при переходе к другому элементу. Что касается уведомлений об ошибках, сообщение сохраняется, пока пользователь не увидит его. Если указать для этого параметра неподдерживаемый тип, будет возвращено исключение.
type

Определяет сообщение.ItemNotificationMessageType

Сведения о свойстве

actions

Указывает действия для сообщения. Лимит: 1 действие. В это ограничение не учитывается действие "Закрыть", включенное по умолчанию. Применимо только в том случае, если типом является InsightMessage. Указание этого свойства для неподдерживаемого типа или включение слишком большого количества действий вызывает ошибку.

Важно! В современной Outlook в Интернете и новой версии Outlook для Windows свойство actions доступно только в режиме Compose.

actions?: NotificationMessageAction[];

Значение свойства

Office.NotificationMessageAction[]

Комментарии

Набор API: почтовый ящик 1.10

Применимый режим Outlook: Compose или чтение

icon

Ссылка на настраиваемый значок, определенный в манифесте. Значок появится перед сообщением уведомления в области информационной панели. Для и уведомлений должен быть указан InformationalMessageInsightMessage значок.

icon?: string;

Значение свойства

string

Комментарии

Важно!

  • В настоящее время настраиваемый значок отображается только в классической версии Outlook для Windows.

  • Настраиваемый значок поддерживается только в InformationalMessageInsightMessage уведомлениях. Указание значка для других типов уведомлений приводит к исключению.

  • Если ваша надстройка использует манифест только надстройки, значок должен быть указан в элементе Images раздела Ресурсы манифеста.

  • Если ваша надстройка использует единый манифест для Microsoft 365, в настоящее время вы не можете настроить значок InformationalMessage или уведомления InsightMessage . В уведомлении используется первое изображение, указанное в массиве "icons" первого объекта extensions.ribbons.tabs.groups.controls манифеста. Хотя это так, вы все равно должны указать строку в свойстве icon (например, «icon-16»).

key

Идентификатор для сообщения уведомления.

key?: string;

Значение свойства

string

message

Текст сообщения уведомления. Максимальная длина составляет 150 символов. Если разработчик передает строку большей длины, возвращается исключение ArgumentOutOfRange.

message: string;

Значение свойства

string

persistent

Указывает, должно ли сообщение быть постоянным. Применимо только для типа .InformationalMessage Если значение равно true, сообщение остается до тех пор, пока не будет удалено этой надстройкой или закрыто пользователем. Если false, оно удаляется при переходе к другому элементу. Что касается уведомлений об ошибках, сообщение сохраняется, пока пользователь не увидит его. Если указать для этого параметра неподдерживаемый тип, будет возвращено исключение.

persistent?: Boolean;

Значение свойства

Boolean

type

Определяет сообщение.ItemNotificationMessageType

type: MailboxEnums.ItemNotificationMessageType | string;

Значение свойства

Office.MailboxEnums.ItemNotificationMessageType | string

Комментарии

Важно!

  • Для типов " ProgressIndicator или ErrorMessage " значок предоставляется автоматически, но сообщение не является постоянным. Поэтому свойства "значок" и "сохраняемый" недопустимы для таких типов сообщений. Их включение приведет к созданию файла .ArgumentException

  • Для ProgressIndicator типа сообщения необходимо удалить или заменить индикатор выполнения после завершения действия.

  • В Outlook для Android и iOS поддерживаются только ProgressIndicatorтипы , InformationalMessageи ErrorMessage уведомления.

  • В режиме создания, хотя стиль каждого типа уведомлений различается в других клиентах Outlook, все уведомления в Outlook для Android и iOS используют один и тот же стиль. Сообщению всегда предшествует информационный значок.