Office.NotificationMessageDetails interface

  • Ссылка
Пакет:
outlook

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

Комментарии

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

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

Применимый режим 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(asyncResult.value);
});

Свойства

actions

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

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

Ссылка на значок, определенный в манифесте. Он появляется на информационной панели. Это применимо, если тип — InformationalMessage, и является обязательным, если тип — InsightMessage. Если указать для этого параметра неподдерживаемый тип, будет возвращено исключение.

Примечание. В настоящее время настраиваемый значок отображается только в Outlook для Windows, но не на других клиентах (например, Mac, веб-браузере).
key

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

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

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

Указывает значение ItemNotificationMessageType сообщения.

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

Если тип имеет значение ProgressIndicator, разработчик должен удалить или заменить индикатор хода выполнения по завершении действия.

Важно! В Outlook для Android и iOS поддерживается только InformationalMessage тип.

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

actions

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

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

actions?: NotificationMessageAction[];

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

Office.NotificationMessageAction[]

Комментарии

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

Применимый режим Outlook: создание или чтение

icon

Ссылка на значок, определенный в манифесте. Он появляется на информационной панели. Это применимо, если тип — InformationalMessage, и является обязательным, если тип — InsightMessage. Если указать для этого параметра неподдерживаемый тип, будет возвращено исключение.

Примечание. В настоящее время настраиваемый значок отображается только в Outlook для Windows, но не на других клиентах (например, Mac, веб-браузере).

icon?: string;

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

string

key

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

key?: string;

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

string

message

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

message: string;

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

string

persistent

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

persistent?: Boolean;

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

Boolean

type

Указывает значение ItemNotificationMessageType сообщения.

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

Если тип имеет значение ProgressIndicator, разработчик должен удалить или заменить индикатор хода выполнения по завершении действия.

Важно! В Outlook для Android и iOS поддерживается только InformationalMessage тип.

type: MailboxEnums.ItemNotificationMessageType | string;

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

Office.MailboxEnums.ItemNotificationMessageType | string