Office.NotificationMessageDetails interface

パッケージ:

outlook

NotificationMessageDetails オブジェクトの配列は、NotificationMessages.getAllAsync メソッドによって返されます。

注釈

API セット: メールボックス 1.3

最小アクセス許可レベル: 項目の読み取り

適用可能な Outlook モード: Composeまたは読み取り

重要: 実装できるさまざまな種類の通知メッセージの詳細については、「 Outlook アドインの通知を作成する」を参照してください。

使用元

• Office.NotificationMessages: addAsync、 getAllAsync、 replaceAsync

例

// 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 on the web と新しい Outlook on Windows では、actions プロパティは Compose モードでのみ使用できます。
icon	マニフェストで定義されているカスタム アイコンへの参照。 このアイコンは、情報バー領域の通知メッセージの前に表示されます。 InformationalMessage通知とInsightMessage通知にはアイコンを指定する必要があります。
key	通知メッセージの識別子。
message	通知メッセージのテキスト。 最大の長さは 150 文字です。 開発者が、長めの文字列を渡した場合、ArgumentOutOfRange 例外がスローされます。
persistent	メッセージを永続化するかどうかを指定します。 タイプが InformationalMessage の場合にのみ適用されます。 true の場合、メッセージは、このアドインによって削除されるか、ユーザーによって閉じられるまで残ります。 false の場合、ユーザーが別の項目に移動すると削除されます。 エラーの通知の場合、メッセージはユーザーが 1 回表示するまで残されます。 このパラメーターをサポートされない型に指定すると、例外がスローされます。
type	メッセージの ItemNotificationMessageType を指定します。

プロパティの詳細

actions

メッセージのアクションを指定します。 制限: 1 アクション。 この制限には、既定で含まれている "閉じる" 操作はカウントされません。 種類が InsightMessageの場合にのみ適用されます。 サポートされていない型にこのプロパティを指定するか、アクションが多すぎると、エラーがスローされます。

重要: 最新の Outlook on the web と新しい Outlook on Windows では、actions プロパティは Compose モードでのみ使用できます。

actions?: NotificationMessageAction[];

プロパティ値

Office.NotificationMessageAction[]

注釈

API セット: メールボックス 1.10

適用可能な Outlook モード: Composeまたは読み取り

icon

マニフェストで定義されているカスタム アイコンへの参照。 このアイコンは、情報バー領域の通知メッセージの前に表示されます。 InformationalMessage通知とInsightMessage通知にはアイコンを指定する必要があります。

icon?: string;

プロパティ値

string

注釈

重要:

• 現在、カスタム アイコンは Windows 上の従来の Outlook にのみ表示されます。

• カスタム アイコンは、 InformationalMessage 通知と InsightMessage 通知でのみサポートされます。 他の通知の種類にアイコンを指定すると、例外が発生します。

• アドインがアドインのみのマニフェストを使用する場合、マニフェストの Resources セクションの 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;

プロパティ値

Office.MailboxEnums.ItemNotificationMessageType | string

注釈

重要:

• ProgressIndicatorまたはErrorMessageの種類の場合、アイコンが自動的に提供され、メッセージは永続的ではありません。 したがって、icon プロパティと永続プロパティは、これらの種類のメッセージに対して無効です。 それらを含めると、 ArgumentExceptionになります。

• ProgressIndicatorの種類の場合は、アクションが完了したら、進行状況インジケーターを削除または交換する必要があります。

• Android 版および iOS 版の Outlook では、 ProgressIndicator、 InformationalMessage、 ErrorMessage の通知の種類のみがサポートされています。

• 作成モードでは、各通知の種類のスタイルは他の Outlook クライアントでは異なりますが、Android と iOS の Outlook の通知はすべて同じスタイルを使用します。 通知メッセージには、常に情報アイコンがプレフィックスとして付きます。