Office.AddinCommands.EventCompletedOptions interface

パッケージ:
office

Outlook でイベントの処理が完了したときの、 送信時アドインオンライン 会議プロバイダー アドインまたは メモ ログ モバイル アドイン の動作を指定します。

注釈

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

最小アクセス許可レベル: 制限付き

適用可能な Outlook モード: Compose

重要:

使用元

プロパティ

allowEvent

completed メソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、処理されたイベントの実行を続行するかキャンセルするかを示します。 たとえば、 ItemSend イベントを処理する送信時アドインは、 allowEvent を false に設定して、メッセージの送信を取り消すことができます。

プロパティの詳細

allowEvent

completed メソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、処理されたイベントの実行を続行するかキャンセルするかを示します。 たとえば、 ItemSend イベントを処理する送信時アドインは、 allowEvent を false に設定して、メッセージの送信を取り消すことができます。

allowEvent?: boolean;

プロパティ値

boolean

注釈

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

最小アクセス許可レベル (Outlook): 制限付き

適用可能な Outlook モード: Compose

例

// In this example, the checkMessage function was registered as an event handler for ItemSend.
function checkMessage(event) {
    // Get the item being sent.
    const outgoingMsg = Office.context.mailbox.item;

    // Check if subject contains "BLOCK".
    outgoingMsg.subject.getAsync(function (result) {
        // Subject is in `result.value`.
        // If search term "BLOCK" is found, don't send the message.
        const notFound = -1;
        const allowEvent = (result.value.indexOf('BLOCK') === notFound);
        event.completed({ allowEvent: allowEvent });
    });
}