Office.NotificationMessages interface

アイテムに通知を追加します。

addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

重要:

• Outlook on the web、Windows (新規およびクラシック) と Mac では、メッセージごとに最大 5 つの通知を設定できます。 more を設定すると、 NumberOfNotificationMessagesExceeded エラーが返されます。 Outlook on Android と iOS では、メッセージごとに 1 つの通知のみを設定できます。 追加の通知を設定すると、前の通知が置き換えられます。

• アドインごとに許可される InsightMessage 型の通知は 1 つだけです。 さらに追加しようとすると、エラーがスローされます。

• 最新のOutlook on the webおよび新しい Outlook on Windows ではCompose モードでのみInsightMessage通知を追加できます。

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

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

• addAsync メソッドは、loadItemByIdAsync メソッドを使用して現在読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an error notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

アイテムに通知を追加します。

addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

重要:

• Outlook on the web、Windows (新規およびクラシック) と Mac では、メッセージごとに最大 5 つの通知を設定できます。 more を設定すると、 NumberOfNotificationMessagesExceeded エラーが返されます。 Outlook on Android と iOS では、メッセージごとに 1 つの通知のみを設定できます。 追加の通知を設定すると、前の通知が置き換えられます。

• アドインごとに許可される InsightMessage 型の通知は 1 つだけです。 さらに追加しようとすると、エラーがスローされます。

• 最新のOutlook on the webおよび新しい Outlook on Windows ではCompose モードでのみInsightMessage通知を追加できます。

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

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

• addAsync メソッドは、loadItemByIdAsync メソッドを使用して現在読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。

アイテムのすべてのキーとメッセージを返します。

getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

例

// 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);
});

アイテムのすべてのキーとメッセージを返します。

getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

アイテムの通知メッセージを削除します。

removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

重要: removeAsync メソッドは、 loadItemByIdAsync メソッドを使用して現在読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

アイテムの通知メッセージを削除します。

removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

重要: removeAsync メソッドは、 loadItemByIdAsync メソッドを使用して現在読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。

指定のキーが含まれる通知メッセージを別のメッセージに置換します。

指定したキーを持つ通知メッセージが存在しない場合は、replaceAsync が通知を追加します。

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

重要: replaceAsync メソッドは、 loadItemByIdAsync メソッドを使用して現在読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

指定のキーが含まれる通知メッセージを別のメッセージに置換します。

指定したキーを持つ通知メッセージが存在しない場合は、replaceAsync が通知を追加します。

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: Composeまたは読み取り

重要: replaceAsync メソッドは、 loadItemByIdAsync メソッドを使用して現在読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。