setPromise method

Article
01/26/2017

Informs the application object that asynchronous work is being performed, and that this event handler should not be considered complete until the promise completes. This function can be called inside the handlers for all WinJS.Navigation events:

Syntax

ev.detail.setPromise(promise);

Parameters

promise
Type: Promise**

The promise that should complete before processing is complete.

Return value

This method does not return a value.

Examples

The following code shows how to use this method inside an event handler.

WinJS.Navigation.onbeforenavigate = function (ev) {
    ev.detail.setPromise(
        WinJS.Application.roaming.writeText("navfile.txt", "starting navigation at: " + new Date())
    );
};

Requirements

Minimum WinJS version	WinJS 1.0
Namespace	WinJS.Navigation