Copy page

puter.ui.launchApp()

Websites Puter Apps Node.js Workers

Allows you to dynamically launch another app from within your app.

Syntax 

puter.ui.launchApp()
puter.ui.launchApp(appName)
puter.ui.launchApp(appName, args)
puter.ui.launchApp(options)

Parameters

appName (String)

Name of the app. If not provided, a new instance of the current app will be launched.

args (Object)

Arguments to pass to the app. If appName is not provided, these arguments will be passed to the current app.

options (Object)

options.name (String)

Name of the app. If not provided, a new instance of the current app will be launched.

options.args (Object)

Arguments to pass to the app.

options.file_paths (Array<String>)

Paths of existing files to open with the launched app.

options.items (Array<FSItem>)

FSItem objects to open with the launched app.

options.pseudonym (String)

A pseudonym to launch the app under.

Return value

A Promise that will resolve to an AppConnection once the app is launched.

When private-access routing applies, the resolved connection may include connection.response.launchResult with fields such as:

  • requestedAppName
  • openedAppName
  • redirectedToFallback
  • deniedPrivateAccess

Examples 

<html>
<body>
    <script src="https://js.puter.com/v2/"></script>
    <script>
        // launches the Editor app
        puter.ui.launchApp('editor');
    </script>
</body>
</html>

NEXT

on()

PREVIOUS

hideWindow()