SecondaryTile.RequestCreateAsync() | requestCreateAsync() method

Displays a preview of the secondary tile with a confirmation dialog to create the tile.

Note  It is a best practice to display the confirmation dialog near the button that invoked the request to create the tile. Therefore, we recommend that you use the RequestCreateAsync(point) form of this method overload.

Syntax

secondaryTile.requestCreateAsync().done( /* Your success and error handlers */ );

Parameters

This method has no parameters.

Return value

Type: IAsyncOperation<Boolean>

An object used to launch the asynchronous create operation as well as to retrieve information about it.

Remarks

After a secondary tile is created, you must provide the following properties before it is displayed:

• tileId
• shortName
• displayName
• arguments
• tileOptions
• logo

This method returns an asynchronous Boolean value through its IAsyncOperation object as shown here. A value of true indicates that the secondary tile was created and pinned to the Start screen.

  
[JavaScript]  
secondaryTile.requestCreateAsync().then( function (isPinned) { } );

Examples

The following example creates and pins a previously defined SecondaryTile object "tile" to the Start screen.

tile.requestCreateAsync().then(function (isCreated) {
    if (isCreated) {
        // Secondary tile successfully pinned.
    } else {
        // Secondary tile not pinned.
    }
});

Requirements

See also

SecondaryTile

RequestCreateAsync(Point)

Secondary tiles sample

Build date: 12/4/2012