Office.AddinCommands.EventCompletedOptions interface
Outlook でイベントの処理が完了したときに、送信時アドイン、オンライン会議プロバイダー アドイン、またはノート ログ モバイル アドインの動作を指定します。
注釈
最小アクセス許可レベル: 制限あり
適用される Outlook モード: Compose
重要:
Outlook on Android および iOS ではメールボックス 1.5 までサポートされていますが、
EventCompletedOptions
オブジェクトはオンライン会議プロバイダーとノート ログ モバイル アドインでサポートされています。モバイル デバイスでの Outlook での API サポートの詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。イベント ベースのアクティブ化 と 統合されたスパムレポート アドインでは、別のイベント オブジェクトを使用して、イベントの処理が完了したことを通知します。 詳細については、「 Office.MailboxEvent」を参照してください。
プロパティ
allow |
完了したメソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、処理されたイベントが実行を続行するか、取り消されるかを示します。 たとえば、 |
プロパティの詳細
allowEvent
完了したメソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、処理されたイベントが実行を続行するか、取り消されるかを示します。 たとえば、 ItemSend
イベントを処理する送信時アドインは、 allowEvent
を false
に設定してメッセージの送信を取り消すことができます。
allowEvent: boolean;
プロパティ値
boolean
注釈
最小アクセス許可レベル (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 });
});
}