通过

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(asyncResult.value);
});

属性

icon

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

通知邮件标识符。
message

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

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

指定 ItemNotificationMessageType 消息的 。

属性详细信息

icon

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

icon?: string;

属性值

string

注解

重要说明：

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

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

  • 如果外接程序使用仅外接程序清单，则必须在清单“资源”部分的“图像”元素中指定图标。

  • 如果外接程序使用 Microsoft 365 的统一清单，则当前无法自定义 或 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 ，应在作完成后删除或替换进度指示器。

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

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