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 set inside the handlers for all WinJS.Application events:

• onactivated

• oncheckpoint

• onerror

• onloaded

• onready

• onsettings

• onunload

Syntax

ev.detail.setPromise(promise);

Parameters

promise

Type: WinJS.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 function inside an event handler.

app.onready = function (ev) {
    ev.detail.setPromise(
       WinJS.Application.roaming.writeText("dataFile.txt", “ready at: “ + new Date())
    );
};

Requirements

Build date: 12/5/2012