Office.NotificationMessageDetails interface
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);
});
属性
icon | 对清单中定义的图标的引用。 它将显示在信息栏区域。 如果类型为 注意:目前,自定义图标仅显示在 Outlook on Windows 中,而不显示在其他客户端 (,例如 Mac、Web 浏览器) 。 |
key | 通知邮件标识符。 |
message | 通知邮件的文本。 最大长度为 150 个字符。 如果开发人员传入更长的字符串,则会引发 |
persistent | 指定消息是否应持久。 仅当类型为 |
type | 指定 如果类型为 如果 type 为
重要提示:Android 版和 iOS 版 Outlook 仅 |
属性详细信息
icon
对清单中定义的图标的引用。 它将显示在信息栏区域。 如果类型为 InformationalMessage
,则适用;如果类型为 InsightMessage
,则是必需的。 为不受支持的类型指定此参数将导致异常。
注意:目前,自定义图标仅显示在 Outlook on Windows 中,而不显示在其他客户端 (,例如 Mac、Web 浏览器) 。
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
。
如果 type 为 ProgressIndicator
,则开发人员应在操作完成后删除或替换进度指示器。
重要提示:Android 版和 iOS 版 Outlook 仅 InformationalMessage
支持该类型。
type: MailboxEnums.ItemNotificationMessageType | string;