setPromise method
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 |
See also
For developers
Your first app - Part 3: PageControl objects and navigation
Quickstart: Using single-page navigation
Quickstart: Adding a nav bar (NavBar)
Quickstart: Using a hub control for layout and navigation
Navigation and navigation history sample
For designers
Top app bar
Guidelines for the hub control
Guidelines for app bars