Office.NotificationMessageAction interface

パッケージ:

outlook

通知メッセージのアクションの定義。

注釈

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

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

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

重要: 最新のOutlook on the webおよび新しい Outlook on Windows ではNotificationMessageAction オブジェクトはCompose モードでのみ使用できます。

例

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

// Adds an informational message with actions to the mail item.
const id = $("#notificationId").val().toString();

const itemId = Office.context.mailbox.item.itemId;
const details = {
  type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
  message: "This is an insight notification with id = " + id,
  icon: "icon1",
  actions: [
    {
      actionText: "Open insight",
      actionType: Office.MailboxEnums.ActionType.ShowTaskPane,
      // Identify whether the current mail item is in read or compose mode to set the appropriate commandId value.
      commandId: (itemId == undefined ? "PG.HelpCommand.Compose" : "PG.HelpCommand.Read"),
      contextData: { a: "aValue", b: "bValue" }
    }
  ]
};

Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

プロパティ

actionText	アクション リンクのテキスト。
actionType	実行するアクションの種類。 ActionType.ShowTaskPane は、サポートされている唯一のアクションです。
commandId	マニフェストで定義されているボタン。
contextData	アクション ボタンがアドインに渡す必要がある JSON データ。

プロパティの詳細

actionText

アクション リンクのテキスト。

actionText: string;

プロパティ値

string

actionType

実行するアクションの種類。 ActionType.ShowTaskPane は、サポートされている唯一のアクションです。

actionType: string | MailboxEnums.ActionType;

プロパティ値

string | Office.MailboxEnums.ActionType

commandId

マニフェストで定義されているボタン。

commandId: string;

プロパティ値

string

contextData

アクション ボタンがアドインに渡す必要がある JSON データ。

contextData: any;

プロパティ値

any

注釈

重要:

• Outlook on Windows では、バージョン 2402 (ビルド 17308.20000) 以降、 any の種類がサポートされています。 以前のバージョンの Outlook on Windows では、 string の種類のみがサポートされています。

• JSON データを取得するには、 Office.context.mailboxitem.getInitializationContextAsyncを呼び出します。 JSON.stringify()を使用して JSON 文字列を作成し、contextData プロパティに割り当てる場合は、取得後に JSON.parse() を使用して文字列を解析する必要があります。