Office.NotificationMessageDetails interface

程序包:
outlook

NotificationMessageDetails 对象的数组由 NotificationMessages.getAllAsync 方法返回。

注解

API 集：邮箱 1.3

最低权限级别： 读取项目

适用的 Outlook 模式：Compose 或 Read

重要提示： 若要了解可以实现的不同类型的通知消息，请参阅为 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 on Windows 中，该actions属性仅在 Compose 模式下可用。
icon

对清单中定义的自定义图标的引用。 该图标显示在信息栏区域的通知消息前面。 必须为 InformationalMessage 和 InsightMessage 通知指定图标。
key

通知邮件标识符。
message

通知邮件的文本。 最大长度为 150 个字符。 如果开发人员传入更长的字符串，则会引发 ArgumentOutOfRange 异常。
persistent

指定消息是否应持久。 仅当类型为 InformationalMessage. 如果为 true，则该消息将一直保留，直到被此加载项删除或被用户消除。 如果为 false，则在用户导航到其他项目时将其删除。 对于错误通知，邮件将一直保留，直到用户看过一次。 为不受支持的类型指定此参数将引发异常。
type

指定 ItemNotificationMessageType 消息的。

属性详细信息

actions

指定对邮件的操作。 限制：1 个操作。 此限制不包括默认包含的“关闭”操作。 仅适用于类型为 InsightMessage. 为不受支持的类型指定此属性或包含太多操作会引发错误。

重要提示： 在新式 Outlook 网页版和新版 Outlook on Windows 中，该actions属性仅在 Compose 模式下可用。

actions?: NotificationMessageAction[];

属性值

Office.NotificationMessageAction[]

注解

API 集：邮箱 1.10

适用的 Outlook 模式：Compose 或 Read

icon

对清单中定义的自定义图标的引用。 该图标显示在信息栏区域的通知消息前面。 必须为 InformationalMessage 和 InsightMessage 通知指定图标。

icon?: string;

属性值

string

注解

重要说明：

  • 目前，自定义图标仅显示在 Windows 上的经典 Outlook 中。

  • 仅 和 InsightMessage 通知支持自定义InformationalMessage图标。 为其他通知类型指定图标会导致异常。

  • 如果加载项使用仅加载项清单，则必须在清单的“资源”部分的“图像”元素中指定该图标。

  • 如果你的加载项使用 Microsoft 365 的统一清单，则你当前无法自定义 OR InsightMessage 通知的InformationalMessage图标。 通知使用清单的第一个 extensions.ribbons.tabs.groups.controls 对象的“icons”数组中指定的第一个图像。 即使如此，仍必须在属性 (中 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 类型，应在操作完成后删除或替换进度指示器。

  • 在 Android 和 iOS 上的 Outlook 中，仅ProgressIndicator支持 、 和InformationalMessageErrorMessage通知类型。

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