How to handle event.completed() in Dialog API Office JS

Question

I am currently invoking a dialog from a button on the ribbon in Outlook. The dialog works fine without any issues, but the message "...add-in is working on your request" appears even after the dialog is opened/closed.

Here is how the dialog is invoked..

function openDialog(event) {
    Office.context.ui.displayDialogAsync('https://xxxx.azurewebsites.net', { height: 80, width: 92 },
        function (asyncResult) {
            dialog = asyncResult.value;
            dialog.addEventHandler(Office.EventType.DialogMessageReceived, processMessage);
            event.completed();
        }
    );
}

function processMessage(event) {
    event.completed();
}

How to avoid this message ? Tried to close the event in the EventHandler callback(processMessage) as well but didn't work.

On which Outlook platform are you seeing this behavior (Windows, Mac, or Web)? — Outlook Add-ins Team - MSFT, Jan 22 '20 at 23:50
I was unable to repro the issue you are seeing. Would you be able to share your processMessage function? Calling event.completed() inside processMessage should dismiss the infobar even if the dialog is open. Does this issue repro acorss clients (i.e. in OWA as well)? — Outlook Add-ins Team - MSFT, Jan 28 '20 at 23:35
Even if add only event.completed() statement in the processMessage, the issue still exists. It is the same in OWA as well. — AhmedVali, Jan 30 '20 at 09:13

score 0 · Accepted Answer · answered Jan 30 '20 at 22:22

For addEventHandler, if you would like to complete the event when the dialog is closed, you can use the DialogEventReceived event, which is triggered when the dialog box has been closed or otherwise unloaded. Also, the handler function (processMessage) should use a different parameter name from event as to not overwrite the variable.

function openDialog(event) {
    Office.context.ui.displayDialogAsync('https://xxxx.azurewebsites.net', { height: 80, width: 92 },
        function (asyncResult) {
            dialog = asyncResult.value;
            dialog.addEventHandler(Office.EventType.DialogEventReceived, processMessage);
            event.completed();
        }
    );
}

function processMessage(args) {
    event.completed();
}

How to handle event.completed() in Dialog API Office JS

1 Answers1