Office.SmartAlertsEventCompletedOptions interface

リファレンス

パッケージ:: outlook

OnMessageSendまたはOnAppointmentSend イベントの処理が完了したときのスマートアラートアドインの動作を指定します。

注釈

例

// The following example checks whether a location is specified in an appointment before it's sent.
function onAppointmentSendHandler(event) {
    Office.context.mailbox.item.location.getAsync({ asyncContext: event }, asyncResult => {
        const event = asyncResult.asyncContext;
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            // If the add-in is unable to retrieve the appointment's location, the appointment isn't sent.
            event.completed({ allowEvent: false, errorMessage: "Failed to get the appointment's location." });
            return;
        }

        if (asyncResult.value === "") {
            // If no location is specified, the appointment isn't sent and the user is alerted to include a location.
            event.completed(
                {
                    allowEvent: false,
                    cancelLabel: "Add a location",
                    commandId: "msgComposeOpenPaneButton",
                    contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
                    errorMessage: "Don't forget to add a meeting location.",
                    errorMessageMarkdown: `
                        Don't forget to add a meeting location.\n\n
                        **Tip**: For a list of locations,
                        see [Meeting Locations]("https://www.contoso.com/meeting-locations).`,
                    sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
                }
            );
        } else {
            // If a location is specified, the appointment is sent.
            event.completed({ allowEvent: true });
        }
    });
}

プロパティ

allowEvent

完了したメソッドを使用してイベントハンドラーの完了を通知する場合、この値は、処理されたイベントが実行を続行するか、取り消されるかを示します。たとえば、 OnMessageSend または OnAppointmentSend イベントを処理するアドインでは、 allowEvent を false に設定してアイテムの送信を取り消すことができます。完全なサンプルについては、スマートアラートのチュートリアルを参照してください。

errorMessage

完了したメソッドを使用してイベントハンドラーの完了を通知し、そのallowEvent プロパティを false に設定すると、ユーザーに表示されるエラーメッセージが設定されます。例については、スマートアラートのチュートリアルを参照してください。