Launcher.LaunchUriAsync(Uri) | launchUriAsync(Uri) method
Starts the default app associated with the URI scheme name for the specified URI.
Syntax
Windows.System.Launcher.launchUriAsync(uri).done( /* Your success and error handlers */ );
Parameters
- uri
-
Type: Uri [JavaScript] | System.Uri [.NET] | Windows::Foundation::Uri [C++]
The URI.
Return value
Type: IAsyncOperation<Boolean>
The launch operation.
Remarks
The calling app must be visible to the user when the API is invoked.
You must specify the privateNetworkClientServer capability in the manifest in order to launch intranet URIs, for example a file:/// URI pointing to a network location.
You cannot use this method to launch a URI in the local zone. For example, apps cannot use the file:/// protocol to access files on the local computer. Instead, you must use the Storage APIs to access files.
When the launch fails for any of the above reasons, the API will succeed and return FALSE from its asynchronous operation.
To enable the user to choose an app instead of launching the default app, set the LauncherOptions.DisplayApplicationPicker | displayApplicationPicker property.
To display a warning that the URI is potentially unsafe, set the LauncherOptions.TreatAsUntrusted | treatAsUntrusted property.
The URI is passed to the associated app. If the associated app is a desktop app, the URI is passed using shell execution mechanisms.
Examples
This example uses LaunchUriAsync(Uri) | launchUriAsync(Uri) to launch a URI.
// The URI to launch var uriToLaunch = "http://www.bing.com"; // Create a Uri object from a URI string var uri = new Windows.Foundation.Uri(uriToLaunch); // Launch the URI Windows.System.Launcher.launchUriAsync(uri).then( function (success) { if (success) { // URI launched } else { // URI launch failed } });
Requirements
|
Minimum supported client | Windows 8 |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Minimum supported phone | Windows Phone 8 |
|
Namespace |
|
|
Metadata |
|
See also
- Samples
- Association launching sample
- Guidelines
- Guidelines and checklist for file types and URIs
- Tasks
- How to launch the default app for a URI (JavaScript)
- How to launch the default app for a URI (C#/VB/C++)
- Reference
- Launcher
- LauncherOptions
Build date: 2/25/2013
