Office.NotificationMessageAction interface

Пакет:

outlook

Определение действия для сообщения уведомления.

Комментарии

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

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

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

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

Примеры

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

// Adds an informational message with actions to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;

const itemId = Office.context.mailbox.item.itemId;
const details = {
  type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
  message: "This is an insight notification with id = " + id,
  icon: "PG.Icon.16",
  actions: [
    {
      actionText: "Open insight",
      actionType: Office.MailboxEnums.ActionType.ShowTaskPane,
      // Identify whether the current mail item is in read or compose mode to set the appropriate commandId value.
      commandId: (itemId == undefined ? "PG.HelpCommand.Compose" : "PG.HelpCommand.Read"),
      contextData: { a: "aValue", b: "bValue" }
    }
  ]
};

Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add insight notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added insight notification with id = ${id}.`);
});

Свойства

actionText	Текст ссылки на действие.
actionType	Тип выполняемого действия. ActionType.ShowTaskPane является единственным поддерживаемым действием.
commandId	Кнопка, определенная в манифесте.
contextData	Все данные JSON, которые нужно передать кнопке действия в надстройку.

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

actionText

Текст ссылки на действие.

actionText: string;

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

string

actionType

Тип выполняемого действия. ActionType.ShowTaskPane является единственным поддерживаемым действием.

actionType: string | MailboxEnums.ActionType;

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

string | Office.MailboxEnums.ActionType

commandId

Кнопка, определенная в манифесте.

commandId: string;

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

string

contextData

Все данные JSON, которые нужно передать кнопке действия в надстройку.

contextData: any;

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

any

Комментарии

Важно!

• В Outlook для Windows тип поддерживается начиная any с версии 2402 (сборка 17308.20000). В более ранних версиях Outlook в Windows поддерживался только string тип .

• Чтобы получить данные JSON, вызовите .Office.context.mailboxitem.getInitializationContextAsync Если вы создаете строку JSON с помощью JSON.stringify() и присваиваете ее свойству contextData , необходимо проанализировать строку с помощью JSON.parse() после ее извлечения.

• Чтобы предотвратить перезапуск области задач уведомления, если оно уже открыто, реализуйте обработчик для Office.EventType.InitializationContextChanged события. Затем можно передать аргументы события в contextData свойство .