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