Office.NotificationMessageDetails interface

  • リファレンス
パッケージ:
outlook

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

マニフェストで定義されているアイコンへの参照。 情報バー領域に表示されます。 型が の場合は適用可能であり、型が InformationalMessageの場合は 必須です InsightMessage。 サポートされていない型にこのパラメーターを指定すると例外が生じます。

注: 現時点では、カスタム アイコンは Outlook on Windows でのみ表示され、他のクライアント (Mac、Web ブラウザーなど) には表示されません。
key

通知メッセージの識別子。
message

通知メッセージのテキスト。 最大の長さは 150 文字です。 開発者が、長めの文字列を渡した場合、ArgumentOutOfRange 例外がスローされます。
persistent

メッセージを永続的にするかどうかを指定します。 型 InformationalMessageが である場合にのみ適用されます。 true の場合、メッセージは、このアドインによって削除されるか、ユーザーによって無視されるまで残ります。 false の場合、ユーザーが別の項目に移動すると削除されます。 エラーの通知の場合、メッセージはユーザーが 1 回表示するまで残されます。 このパラメーターをサポートされない型に指定すると、例外がスローされます。
type

メッセージの を ItemNotificationMessageType 指定します。

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

型が の場合、開発者は ProgressIndicatorアクションが完了したときに進行状況インジケーターを削除または置き換える必要があります。

重要: Outlook on Android と iOS では、型のみが InformationalMessage サポートされています。

プロパティの詳細

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 指定します。

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

型が の場合、開発者は ProgressIndicatorアクションが完了したときに進行状況インジケーターを削除または置き換える必要があります。

重要: Outlook on Android と iOS では、型のみが InformationalMessage サポートされています。

type: MailboxEnums.ItemNotificationMessageType | string;

プロパティ値

Office.MailboxEnums.ItemNotificationMessageType | string