Office.NotificationMessageDetails interface
NotificationMessageDetails オブジェクトの配列は、NotificationMessages.getAllAsync メソッドによって返されます。
注釈
最小アクセス許可レベル: 読み取り項目
適用できる 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);
});
プロパティ
| actions | メッセージのアクションを指定します。 制限: 1 アクション。 この制限では、既定で含まれている "無視" アクションはカウントされません。 型が
重要: 最新の Outlook on the web および新しい Outlook on Windows では、 |
| icon | マニフェストで定義されているアイコンへの参照。 情報バー領域に表示されます。 型が 注: 現時点では、カスタム アイコンは Outlook on Windows でのみ表示され、他のクライアント (Mac、Web ブラウザーなど) には表示されません。 |
| key | 通知メッセージの識別子。 |
| message | 通知メッセージのテキスト。 最大の長さは 150 文字です。 開発者が、長めの文字列を渡した場合、 |
| persistent | メッセージを永続的にするかどうかを指定します。 型が |
| type | メッセージの 型が 型が
重要: Outlook on Android と iOS では、 |
プロパティの詳細
actions
メッセージのアクションを指定します。 制限: 1 アクション。 この制限では、既定で含まれている "無視" アクションはカウントされません。 型が InsightMessageされている場合にのみ適用されます。 サポートされていない型に対してこのプロパティを指定するか、アクションの数が多すぎる場合、エラーがスローされます。
重要: 最新の Outlook on the web および新しい Outlook on Windows では、actions プロパティは新規作成モードでのみ使用できます。
actions?: NotificationMessageAction[];プロパティ値
注釈
適用できる 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 の場合、ユーザーが別の項目に移動すると削除されます。 エラーの通知の場合、メッセージはユーザーが 1 回表示するまで残されます。 このパラメーターをサポートされない型に指定すると、例外がスローされます。
persistent?: Boolean;プロパティ値
Boolean
type
メッセージの ItemNotificationMessageType を指定します。
型が ProgressIndicator または ErrorMessageの場合は、アイコンが自動的に指定され、メッセージは永続的ではありません。 したがって、icon プロパティと persistent プロパティは、これらの型のメッセージでは無効になります。 それらを含めると、 ArgumentExceptionが発生します。
型が ProgressIndicatorの場合、開発者はアクションが完了したときに進行状況インジケーターを削除または置き換える必要があります。
重要: Outlook on Android と iOS では、 InformationalMessage の種類のみがサポートされています。
type: MailboxEnums.ItemNotificationMessageType | string;プロパティ値
Office Add-ins