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 в Windowsactions свойство доступно только в режиме Compose.
icon	Ссылка на пользовательский значок, определенный в манифесте. Значок отображается перед сообщением уведомления в области информационной панели. Для уведомлений и InsightMessage должен быть указан InformationalMessage значок.
key	Идентификатор для сообщения уведомления.
message	Текст сообщения уведомления. Максимальная длина составляет 150 символов. Если разработчик передает строку большей длины, возвращается исключение ArgumentOutOfRange.
persistent	Указывает, должно ли сообщение быть постоянным. Применимо только в том случае, если тип имеет значение InformationalMessage. Если задано значение true, сообщение остается до тех пор, пока не будет удалено этой надстройкой или не будет отклонено пользователем. Если false, оно удаляется при переходе к другому элементу. Что касается уведомлений об ошибках, сообщение сохраняется, пока пользователь не увидит его. Если указать для этого параметра неподдерживаемый тип, будет возвращено исключение.
type	Указывает значение ItemNotificationMessageType сообщения.

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

actions

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

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

actions?: NotificationMessageAction[];

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

Office.NotificationMessageAction[]

Комментарии

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

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

icon

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

icon?: string;

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

string

Комментарии

Важно!

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

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

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

• Если ваша надстройка использует унифицированный манифест для Microsoft 365, в настоящее время вы не можете настроить значок InformationalMessage или InsightMessage уведомление. В уведомлении используется первое изображение, указанное в массиве значков первого объекта 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 используют один и тот же стиль. Уведомление всегда имеет префикс с информационным значком.