Launcher Launcher Launcher Launcher Launcher Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Starts the default app associated with the specified file or URI.

public : static class Launcher
static struct winrt::Windows::System::Launcher
public static class Launcher
Public Shared Class Launcher
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

Launch a file contained in the app package

See the code example in the LaunchFileAsync(IStorageFile) topic.

Launch a URI

See the code example in the LaunchUriAsync(Uri) topic.

Launch with a warning dialog

This example calls launchUriAsync(Uri, LauncherOptions) to launch a URI with a warning. Use the treatAsUntrusted property to indicate that the system should display a warning.

Note

For a Windows app using JavaScript, call preventDefault in your event handler if the treatAsUntrusted property is set and you are using an anchor element to launch the URI.

function linkClickHandler(eventInfo) {
    var link = eventInfo.target;
    if (eventInfo.srcElement && (
        (eventInfo.type === "click") ||
        (eventInfo.type === "keydown" && (
        eventInfo.keyCode === WinJS.Utilities.Key.enter ||
        eventInfo.keyCode === WinJS.Utilities.Key.space)))) {
        eventInfo.preventDefault();
        if (link.href.indexOf("ms-appx") > -1) {
            WinJS.Navigation.navigate(link.href);
        }
        else if (link.href.indexOf("http") > -1) {
            // Create a Uri object from a URI string 
            var uri = new Windows.Foundation.Uri(link.href);
            var options = new Windows.System.LauncherOptions();
            // Launch the URI with a warning prompt
            options.treatAsUntrusted = true;
            // Launch the URI
            Windows.System.Launcher.launchUriAsync(uri, options).then(
                function (success) {
                    if (success) {
                        // URI launched
                    } else {
                        // URI launch failed
                    }
                });
        }
    }
}

Remarks

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

Methods

FindAppUriHandlersAsync(Uri) FindAppUriHandlersAsync(Uri) FindAppUriHandlersAsync(Uri) FindAppUriHandlersAsync(Uri) FindAppUriHandlersAsync(Uri)

Enumerate the Uniform Resource Identifiers (URI) handlers on the device.

FindFileHandlersAsync(String) FindFileHandlersAsync(String) FindFileHandlersAsync(String) FindFileHandlersAsync(String) FindFileHandlersAsync(String)

Enumerate the file handlers on the device.

FindUriSchemeHandlersAsync(String) FindUriSchemeHandlersAsync(String) FindUriSchemeHandlersAsync(String) FindUriSchemeHandlersAsync(String) FindUriSchemeHandlersAsync(String)

Enumerate the scheme handlers on the device.

FindUriSchemeHandlersAsync(String, LaunchQuerySupportType) FindUriSchemeHandlersAsync(String, LaunchQuerySupportType) FindUriSchemeHandlersAsync(String, LaunchQuerySupportType) FindUriSchemeHandlersAsync(String, LaunchQuerySupportType) FindUriSchemeHandlersAsync(String, LaunchQuerySupportType)

Enumerate the scheme handlers on the device.

LaunchFileAsync(IStorageFile) LaunchFileAsync(IStorageFile) LaunchFileAsync(IStorageFile) LaunchFileAsync(IStorageFile) LaunchFileAsync(IStorageFile)

Starts the default app associated with the specified file.

LaunchFileAsync(IStorageFile, LauncherOptions) LaunchFileAsync(IStorageFile, LauncherOptions) LaunchFileAsync(IStorageFile, LauncherOptions) LaunchFileAsync(IStorageFile, LauncherOptions) LaunchFileAsync(IStorageFile, LauncherOptions)

Starts the default app associated with the specified file, using the specified options.

LaunchFolderAsync(IStorageFolder) LaunchFolderAsync(IStorageFolder) LaunchFolderAsync(IStorageFolder) LaunchFolderAsync(IStorageFolder) LaunchFolderAsync(IStorageFolder)

Launches File Explorer and displays the contents of the specified folder.

LaunchFolderAsync(IStorageFolder, FolderLauncherOptions) LaunchFolderAsync(IStorageFolder, FolderLauncherOptions) LaunchFolderAsync(IStorageFolder, FolderLauncherOptions) LaunchFolderAsync(IStorageFolder, FolderLauncherOptions) LaunchFolderAsync(IStorageFolder, FolderLauncherOptions)

Launches File Explorer with the specified options and displays the contents of the specified folder.

LaunchUriAsync(Uri) LaunchUriAsync(Uri) LaunchUriAsync(Uri) LaunchUriAsync(Uri) LaunchUriAsync(Uri)

Starts the default app associated with the URI scheme name for the specified URI.

LaunchUriAsync(Uri, LauncherOptions) LaunchUriAsync(Uri, LauncherOptions) LaunchUriAsync(Uri, LauncherOptions) LaunchUriAsync(Uri, LauncherOptions) LaunchUriAsync(Uri, LauncherOptions)

Starts the default app associated with the URI scheme name or the one specified by the ContentType for the specified URI, using the specified options.

LaunchUriAsync(Uri, LauncherOptions, ValueSet) LaunchUriAsync(Uri, LauncherOptions, ValueSet) LaunchUriAsync(Uri, LauncherOptions, ValueSet) LaunchUriAsync(Uri, LauncherOptions, ValueSet) LaunchUriAsync(Uri, LauncherOptions, ValueSet)

Starts the default app associated with the URI scheme name for the specified URI, using the specified options and input data.

LaunchUriForResultsAsync(Uri, LauncherOptions) LaunchUriForResultsAsync(Uri, LauncherOptions) LaunchUriForResultsAsync(Uri, LauncherOptions) LaunchUriForResultsAsync(Uri, LauncherOptions) LaunchUriForResultsAsync(Uri, LauncherOptions)

Asynchronously starts the default app associated with the URI scheme name for the specified URI, using the specified options.

LaunchUriForResultsAsync(Uri, LauncherOptions, ValueSet) LaunchUriForResultsAsync(Uri, LauncherOptions, ValueSet) LaunchUriForResultsAsync(Uri, LauncherOptions, ValueSet) LaunchUriForResultsAsync(Uri, LauncherOptions, ValueSet) LaunchUriForResultsAsync(Uri, LauncherOptions, ValueSet)

Asynchronously starts the default app associated with the URI scheme name for the specified URI, using the specified options and input data.

LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions)

Asynchronously starts the default app associated with the URI scheme name for the specified URI using the specified options, and provides a specific User as context.

LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForResultsForUserAsync(User, Uri, LauncherOptions, ValueSet)

Asynchronously starts the default app associated with the URI scheme name for the specified URI using the specified options and input data, and provides a specific User as context.

LaunchUriForUserAsync(User, Uri) LaunchUriForUserAsync(User, Uri) LaunchUriForUserAsync(User, Uri) LaunchUriForUserAsync(User, Uri) LaunchUriForUserAsync(User, Uri)

Starts the default multi-user app associated with the URI scheme name for the specified URI and provides a specific User as context.

LaunchUriForUserAsync(User, Uri, LauncherOptions) LaunchUriForUserAsync(User, Uri, LauncherOptions) LaunchUriForUserAsync(User, Uri, LauncherOptions) LaunchUriForUserAsync(User, Uri, LauncherOptions) LaunchUriForUserAsync(User, Uri, LauncherOptions)

Starts the default multi-user app associated with the URI scheme name for the specified URI using the specified options, and provides a specific User as context.

LaunchUriForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForUserAsync(User, Uri, LauncherOptions, ValueSet) LaunchUriForUserAsync(User, Uri, LauncherOptions, ValueSet)

Starts the default multi-user app associated with the URI scheme name for the specified URI, using the specified options and input data, and provides a specific User as context.

QueryAppUriSupportAsync(Uri) QueryAppUriSupportAsync(Uri) QueryAppUriSupportAsync(Uri) QueryAppUriSupportAsync(Uri) QueryAppUriSupportAsync(Uri)

Asynchronously query whether there is an app that can handle the specified URI.

QueryAppUriSupportAsync(Uri, String) QueryAppUriSupportAsync(Uri, String) QueryAppUriSupportAsync(Uri, String) QueryAppUriSupportAsync(Uri, String) QueryAppUriSupportAsync(Uri, String)

Asynchronously query whether the specified app can handle the specified URI.

QueryFileSupportAsync(StorageFile) QueryFileSupportAsync(StorageFile) QueryFileSupportAsync(StorageFile) QueryFileSupportAsync(StorageFile) QueryFileSupportAsync(StorageFile)

Asynchronously query whether an app can be activated for the specified file.

QueryFileSupportAsync(StorageFile, String) QueryFileSupportAsync(StorageFile, String) QueryFileSupportAsync(StorageFile, String) QueryFileSupportAsync(StorageFile, String) QueryFileSupportAsync(StorageFile, String)

Asynchronously query whether an app with the specified package name can be activated for the specified file.

QueryUriSupportAsync(Uri, LaunchQuerySupportType) QueryUriSupportAsync(Uri, LaunchQuerySupportType) QueryUriSupportAsync(Uri, LaunchQuerySupportType) QueryUriSupportAsync(Uri, LaunchQuerySupportType) QueryUriSupportAsync(Uri, LaunchQuerySupportType)

Asynchronously query whether an app can be activated for the specified URI and launch type.

QueryUriSupportAsync(Uri, LaunchQuerySupportType, String) QueryUriSupportAsync(Uri, LaunchQuerySupportType, String) QueryUriSupportAsync(Uri, LaunchQuerySupportType, String) QueryUriSupportAsync(Uri, LaunchQuerySupportType, String) QueryUriSupportAsync(Uri, LaunchQuerySupportType, String)

Asynchronously query whether an app can be activated for the specified URI, launch type, and package name.

See Also