Office.NotificationMessages interface

リファレンス

パッケージ:: outlook

NotificationMessages オブジェクトは、アイテムの notificationMessages プロパティとして返されます。

注釈

メソッド

addAsync(key, JSONmessage, options, callback)	アイテムに通知を追加します。メッセージあたりの最大通知数は 5 です。その数より多く設定すると、`NumberOfNotificationMessagesExceeded` エラーが返されます。
addAsync(key, JSONmessage, callback)	アイテムに通知を追加します。メッセージあたりの最大通知数は 5 です。その数より多く設定すると、`NumberOfNotificationMessagesExceeded` エラーが返されます。
getAllAsync(options, callback)	アイテムのすべてのキーとメッセージを返します。
getAllAsync(callback)	アイテムのすべてのキーとメッセージを返します。
removeAsync(key, options, callback)	アイテムの通知メッセージを削除します。
removeAsync(key, callback)	アイテムの通知メッセージを削除します。
replaceAsync(key, JSONmessage, options, callback)	指定のキーが含まれる通知メッセージを別のメッセージに置換します。指定したキーを持つ通知メッセージが存在しない場合は、`replaceAsync` が通知を追加します。
replaceAsync(key, JSONmessage, callback)	指定のキーが含まれる通知メッセージを別のメッセージに置換します。指定したキーを持つ通知メッセージが存在しない場合は、`replaceAsync` が通知を追加します。

メソッドの詳細

addAsync(key, JSONmessage, options, callback)

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

メッセージあたりの最大通知数は 5 です。その数より多く設定すると、NumberOfNotificationMessagesExceeded エラーが返されます。

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

パラメーター

key: string

この通知メッセージを参照するために使用される、開発者が指定したキー。開発者は、このキーを使用して後ほどこのメッセージを変更できます。 32 文字以内にしてください。

JSONmessage: Office.NotificationMessageDetails

アイテムに追加される通知メッセージを格納する JSON オブジェクト。オブジェクトが NotificationMessageDetails 含まれています。

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<void>) => void

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

重要:

アドインごとに許可される InsightMessage 型の通知は 1 つだけです。さらに追加しようとすると、エラーがスローされます。
モダン Outlook on the webでは、新規作成モードでのみ通知をInsightMessage追加できます。
InformationalMessage Outlook on Android と iOS では、型のみがサポートされています。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
const id = $("#notificationId").val();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...
const id = $("#notificationId").val();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...
const id = $("#notificationId").val();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...
const id = $("#notificationId").val();
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, JSONmessage, callback)

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

メッセージあたりの最大通知数は 5 です。その数より多く設定すると、NumberOfNotificationMessagesExceeded エラーが返されます。

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

パラメーター

key: string

JSONmessage: Office.NotificationMessageDetails

アイテムに追加される通知メッセージを格納する JSON オブジェクト。オブジェクトが NotificationMessageDetails 含まれています。

callback: (asyncResult: Office.AsyncResult<void>) => void

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

重要:

アドインごとに許可される InsightMessage 型の通知は 1 つだけです。さらに追加しようとすると、エラーがスローされます。
モダン Outlook on the webでは、新規作成モードでのみ通知をInsightMessage追加できます。
InformationalMessage Outlook on Android と iOS では、型のみがサポートされています。

getAllAsync(options, callback)

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

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

パラメーター

options: Office.AsyncContextOptions

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

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。結果のプロパティは value 、オブジェクトの NotificationMessageDetails 配列です。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

例

// Get all notifications.
Office.context.mailbox.item.notificationMessages.getAllAsync(function (asyncResult) {
    if (asyncResult.status != "failed") {
        Office.context.mailbox.item.notificationMessages.replaceAsync( "notifications", {
            type: "informationalMessage",
            message : "Found " + asyncResult.value.length + " notifications.",
            icon : "iconid",
            persistent: false
        });
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
Office.context.mailbox.item.notificationMessages.getAllAsync(handleResult);

getAllAsync(callback)

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

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

パラメーター

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

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

removeAsync(key, options, callback)

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

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

パラメーター

key: string

通知メッセージを削除するためのキー。

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => void

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ 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
const id = $("#notificationId").val();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

removeAsync(key, callback)

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

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

パラメーター

key: string

通知メッセージを削除するためのキー。

callback: (asyncResult: Office.AsyncResult<void>) => void

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

replaceAsync(key, JSONmessage, options, callback)

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

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

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

パラメーター

key: string

置換する通知メッセージのキー。 32 文字以内にする必要があります。

JSONmessage: Office.NotificationMessageDetails

既存のメッセージを置換する新しい通知メッセージを格納する JSON オブジェクト。オブジェクトが NotificationMessageDetails 含まれています。

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => void

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

例

// Replace a notification with an informational notification.
Office.context.mailbox.item.notificationMessages.replaceAsync("progress", {
    type: "informationalMessage",
    message : "The message was processed successfully.",
    icon : "iconid",
    persistent: false
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
const id = $("#notificationId").val();
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(key, JSONmessage, callback)

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

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

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

パラメーター

key: string

置換する通知メッセージのキー。 32 文字以内にする必要があります。

JSONmessage: Office.NotificationMessageDetails

既存のメッセージを置換する新しい通知メッセージを格納する JSON オブジェクト。オブジェクトが NotificationMessageDetails 含まれています。

callback: (asyncResult: Office.AsyncResult<void>) => void

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成または読み取り

Office.NotificationMessages interface

注釈

メソッド

メソッドの詳細

addAsync(key, JSONmessage, options, callback)

パラメーター

戻り値

注釈

例

addAsync(key, JSONmessage, callback)

パラメーター

戻り値

注釈

getAllAsync(options, callback)

パラメーター

戻り値

注釈

例

getAllAsync(callback)

パラメーター

戻り値

注釈

removeAsync(key, options, callback)

パラメーター

戻り値

注釈

例

removeAsync(key, callback)

パラメーター

戻り値

注釈

replaceAsync(key, JSONmessage, options, callback)

パラメーター

戻り値

注釈

例

replaceAsync(key, JSONmessage, callback)

パラメーター

戻り値

注釈

フィードバック

その他のリソース