Office.NotificationMessages interface

向项目添加通知。

addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要说明：

• 在 Outlook 网页版 中，在 Windows (新) 和经典) ，在 Mac 上，每条消息最多可以设置五个通知。 设置“更多”将返回错误 NumberOfNotificationMessagesExceeded 。 在 Android 版 Outlook 和 iOS 版中，每封邮件只能设置一条通知。 设置其他通知将替换上一个通知。

• 每个加载项只允许一个 类型为 InsightMessage 的通知。 尝试添加更多将引发错误。

• 在新式Outlook 网页版和新的 Outlook on Windows 中，只能在Compose模式下添加InsightMessage通知。

• 在 Outlook on Android 和 iOS 中，仅 ProgressIndicator支持 、 InformationalMessage和 ErrorMessage 通知类型。

• 在撰写模式下，虽然每种通知类型的样式在其他 Outlook 客户端上有所不同，但 Android 版 Outlook 和 iOS 上的通知都使用相同的样式。 通知消息始终带有信息性图标的前缀。

• 当前 addAsync 使用 loadItemByIdAsync 方法加载的消息不支持 方法。 有关详细信息，请参阅 在多条消息上激活 Outlook 加载项。

示例

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

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an error notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

向项目添加通知。

addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要说明：

• 在 Outlook 网页版 中，在 Windows (新) 和经典) ，在 Mac 上，每条消息最多可以设置五个通知。 设置“更多”将返回错误 NumberOfNotificationMessagesExceeded 。 在 Android 版 Outlook 和 iOS 版中，每封邮件只能设置一条通知。 设置其他通知将替换上一个通知。

• 每个加载项只允许一个 类型为 InsightMessage 的通知。 尝试添加更多将引发错误。

• 在新式Outlook 网页版和新的 Outlook on Windows 中，只能在Compose模式下添加InsightMessage通知。

• 在 Outlook on Android 和 iOS 中，仅 ProgressIndicator支持 、 InformationalMessage和 ErrorMessage 通知类型。

• 在撰写模式下，虽然每种通知类型的样式在其他 Outlook 客户端上有所不同，但 Android 版 Outlook 和 iOS 上的通知都使用相同的样式。 通知消息始终带有信息性图标的前缀。

• 当前 addAsync 使用 loadItemByIdAsync 方法加载的消息不支持 方法。 有关详细信息，请参阅 在多条消息上激活 Outlook 加载项。

返回某个项目的所有项和邮件。

getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

示例

// 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);
});

返回某个项目的所有项和邮件。

getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

删除某个项目的通知邮件。

removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要提示：当前 removeAsync 使用 loadItemByIdAsync 方法加载的消息不支持方法。 有关详细信息，请参阅 在多条消息上激活 Outlook 加载项。

示例

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

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

删除某个项目的通知邮件。

removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要提示：当前 removeAsync 使用 loadItemByIdAsync 方法加载的消息不支持方法。 有关详细信息，请参阅 在多条消息上激活 Outlook 加载项。

将带有给定项的通知邮件替换为另一封邮件。

如果带有指定项的通知邮件不存在，replaceAsync 将添加通知。

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要提示：当前 replaceAsync 使用 loadItemByIdAsync 方法加载的消息不支持方法。 有关详细信息，请参阅 在多条消息上激活 Outlook 加载项。

示例

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

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

将带有给定项的通知邮件替换为另一封邮件。

如果带有指定项的通知邮件不存在，replaceAsync 将添加通知。

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

返回

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要提示：当前 replaceAsync 使用 loadItemByIdAsync 方法加载的消息不支持方法。 有关详细信息，请参阅 在多条消息上激活 Outlook 加载项。