LifecycleManagement Module

Version LifecycleManagement 1.1.0-next.1

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • closeError
  • closeResponse
  • finishedError
  • finishedResponse
  • launchError
  • launchResponse
  • listen
  • once
  • provide
  • readyError
  • readyResponse
  • session
  • setState
• Events
  • onRequestClose
  • onRequestFinished
  • onRequestLaunch
  • onRequestReady
  • sessionTransitionCanceled
  • sessionTransitionCompleted
• Provider Interfaces
  • LaunchProvider
  • StateLifecycleProvider
• Types
  • AppDescription
  • AppSession
  • LifecycleLaunchResponse
  • LifecycleLaunchParameters
  • LifecycleReadyParameters
  • LifecycleCloseParameters
  • LifecycleFinishedParameters
  • Runtime
  • SecondScreenEvent
  • AppLaunch
  • LifecycleLaunchRequest
  • LifecycleReadyRequest
  • LifecycleCloseRequest
  • LifecycleFinishedRequest
  • AppSessionRequest

Usage

To use the LifecycleManagement module, you can import it into your project from the Firebolt SDK:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

Overview

A module for managing application lifecycle.

Methods

closeError

This is an private RPC method.

Internal API for Close Provider to send back error.

Parameters:

Result:

Capabilities:

Examples

Example 1

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.closeError",
  "params": {
    "correlationId": "123",
    "error": {
      "code": 1,
      "message": "Error"
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

closeResponse

This is an private RPC method.

Internal API for Close Provider to send back response.

Parameters:

Result:

Capabilities:

Examples

Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.closeResponse",
  "params": {
    "correlationId": "123",
    "result": null
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

finishedError

This is an private RPC method.

Internal API for Finished Provider to send back error.

Parameters:

Result:

Capabilities:

Examples

Example 1

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.finishedError",
  "params": {
    "correlationId": "123",
    "error": {
      "code": 1,
      "message": "Error"
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

finishedResponse

This is an private RPC method.

Internal API for Finished Provider to send back response.

Parameters:

Result:

Capabilities:

Examples

Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.finishedResponse",
  "params": {
    "correlationId": "123",
    "result": null
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

launchError

This is an private RPC method.

Internal API for Launch Provider to send back error.

Parameters:

Result:

Capabilities:

Examples

Example 1

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.launchError",
  "params": {
    "correlationId": "123",
    "error": {
      "code": 1,
      "message": "Error"
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

launchResponse

This is an private RPC method.

Internal API for Launch Provider to send back response.

Parameters:

Result:

Capabilities:

Examples

Example #1

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.launchResponse",
  "params": {
    "correlationId": "123",
    "result": {
      "success": true
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

Example #2

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.launchResponse",
  "params": {
    "correlationId": "123",
    "result": {
      "success": false
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

listen

To listen to a specific event pass the event name as the first parameter:

listen(event: string, callback: (data: any) => void): Promise<number>

Parameters:

Promise resolution:

Callback parameters:

To listen to all events from this module pass only a callback, without specifying an event name:

listen(callback: (event: string, data: any) => void): Promise<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

once

To listen to a single instance of a specific event pass the event name as the first parameter:

once(event: string, callback: (data: any) => void): Promise<number>

The once method will only pass the next instance of this event, and then dicard the listener you provided.

Parameters:

Promise resolution:

Callback parameters:

To listen to the next instance only of any events from this module pass only a callback, without specifying an event name:

once(callback: (event: string, data: any) => void): Promise<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

provide

To provide a specific capability to the platform. See Provider Interfaces for a list of interfaces available to provide in this module.

provide(capability: string, provider: any): void

Parameters:

See Provider Interfaces for each capabilities interface definition.

readyError

This is an private RPC method.

Internal API for Ready Provider to send back error.

Parameters:

Result:

Capabilities:

Examples

Example 1

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.readyError",
  "params": {
    "correlationId": "123",
    "error": {
      "code": 1,
      "message": "Error"
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

readyResponse

This is an private RPC method.

Internal API for Ready Provider to send back response.

Parameters:

Result:

Capabilities:

Examples

Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.readyResponse",
  "params": {
    "correlationId": "123",
    "result": null
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

session

Called before an app is launched in order to set up the lifecycle session. The session should be given an intent that will be passed to the application. This will behave differently depending on the current state of the application. If the application is already loaded but not active then a new active session is started. The intent is given to the application via the onNavigateTo event. If the app is not loaded, then it is considered a 'cold start'. A new loaded session will be created and the intent will be stored for the app to access via Parameters.initialization. Before a session is created for the application some checks may take place. For instance, if a user grant is required for the application then the user grant will be resolved before the session is transitions to the active status. In this case, this API will return immediately with a transitionPending=true flag. The updated session will then be sent as an event in the LifecycleManagement.onSessionTransitionCompleted event. If the pre-session checks fail, such as a user deferring a grant, then the LifecycleManagement.onSessionTransitionCanceled event will be emitted.

function session(session: AppSessionRequest): Promise<AppSession>;

Parameters:

Promise resolution:

AppSession

Capabilities:

Examples

Starts or updates an app session

JavaScript:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

let result = await LifecycleManagement.session({
  app: {
    id: "SomeApp",
    url: "https://some-app.firebolt.rdkcentral.com",
  },
  runtime: {
    id: "WebBrowser-1",
  },
  launch: {
    intent: {
      action: "search",
      data: {
        query: "Dog videos",
      },
      context: {
        source: "voice",
      },
    },
  },
});
console.log(result);

Value of result:

{
	"appId": "SomeApp",
	"sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
	"loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
	"activeSessionId": "05b6f6af-c2f8-4761-beeb-6029590b8e8c",
	"transitionPending": false
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.session",
  "params": {
    "session": {
      "app": {
        "id": "SomeApp",
        "url": "https://some-app.firebolt.rdkcentral.com"
      },
      "runtime": {
        "id": "WebBrowser-1"
      },
      "launch": {
        "intent": {
          "action": "search",
          "data": {
            "query": "Dog videos"
          },
          "context": {
            "source": "voice"
          }
        }
      }
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "SomeApp",
    "sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
    "loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
    "activeSessionId": "05b6f6af-c2f8-4761-beeb-6029590b8e8c",
    "transitionPending": false
  }
}

Starts an inactive app session

JavaScript:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

let result = await LifecycleManagement.session({
  app: {
    id: "SomeApp",
    url: "https://some-app.firebolt.rdkcentral.com",
  },
  runtime: {
    id: "WebBrowser-1",
  },
  launch: {
    inactive: true,
  },
});
console.log(result);

Value of result:

{
	"appId": "SomeApp",
	"sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
	"loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
	"activeSessionId": "05b6f6af-c2f8-4761-beeb-6029590b8e8c",
	"transitionPending": false
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.session",
  "params": {
    "session": {
      "app": {
        "id": "SomeApp",
        "url": "https://some-app.firebolt.rdkcentral.com"
      },
      "runtime": {
        "id": "WebBrowser-1"
      },
      "launch": {
        "inactive": true
      }
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "SomeApp",
    "sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
    "loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
    "transitionPending": false
  }
}

Start a session that results in a pending session

JavaScript:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

let result = await LifecycleManagement.session({
  app: {
    id: "SomeApp",
    url: "https://some-app.firebolt.rdkcentral.com",
  },
  runtime: {
    id: "WebBrowser-1",
  },
  launch: {
    inactive: false,
  },
});
console.log(result);

Value of result:

{
	"appId": "SomeApp",
	"sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
	"loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
	"activeSessionId": "05b6f6af-c2f8-4761-beeb-6029590b8e8c",
	"transitionPending": false
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.session",
  "params": {
    "session": {
      "app": {
        "id": "SomeApp",
        "url": "https://some-app.firebolt.rdkcentral.com"
      },
      "runtime": {
        "id": "WebBrowser-1"
      },
      "launch": {
        "inactive": false
      }
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "SomeApp",
    "transitionPending": true
  }
}

setState

Used by provider to update the state of an application so that the state can be emitted to apps.

function setState(appId: string, state: LifecycleState): Promise<void>;

Parameters:

Promise resolution:

Capabilities:

Examples

Set application lifecycle state to inactive

JavaScript:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

let result = await LifecycleManagement.setState("SomeAppId", "inactive");
console.log(result);

Value of result:

null;

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.setState",
  "params": {
    "state": "inactive",
    "appId": "SomeAppId"
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

Events

onRequestClose

This is an private RPC method.

Tells the provider that an app has requested closing itself

Parameters:

Result:

LifecycleCloseRequest

Capabilities:

Examples

Default Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.onRequestClose",
  "params": {
    "listen": true
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "correlationId": "123",
    "parameters": {
      "appId": "SomeAppId",
      "reason": "userExit"
    }
  }
}

onRequestFinished

This is an private RPC method.

Tells the provider that an app has said they are finished cleaning up while unloading

Parameters:

Result:

LifecycleFinishedRequest

Capabilities:

Examples

Default Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.onRequestFinished",
  "params": {
    "listen": true
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "correlationId": "123",
    "parameters": {
      "appId": "SomeAppId"
    }
  }
}

onRequestLaunch

This is an private RPC method.

Tells the provider that an app should be launched

Parameters:

Result:

LifecycleLaunchRequest

Capabilities:

Examples

Default Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.onRequestLaunch",
  "params": {
    "listen": true
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "correlationId": "123",
    "parameters": {
      "appId": "SomeAppId",
      "intent": {
        "action": "home",
        "context": {
          "source": "voice"
        }
      }
    }
  }
}

onRequestReady

This is an private RPC method.

Tells the provider that an app has said they are ready

Parameters:

Result:

LifecycleReadyRequest

Capabilities:

Examples

Default Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.onRequestReady",
  "params": {
    "listen": true
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "correlationId": "123",
    "parameters": {
      "appId": "SomeAppId"
    }
  }
}

sessionTransitionCanceled

function listen('sessionTransitionCanceled', () => void): Promise<number>

See also: listen(), once(), clear().

Event value:

Capabilities:

Examples

Default Example

JavaScript:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

LifecycleManagement.listen("sessionTransitionCanceled", (canceled) => {
  console.log(canceled);
});

Value of canceled:

{
	"appId": "SomeApp"
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.onSessionTransitionCanceled",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "SomeApp"
  }
}

sessionTransitionCompleted

function listen('sessionTransitionCompleted', () => void): Promise<number>

See also: listen(), once(), clear().

Event value:

AppSession

Capabilities:

Examples

Default Example

JavaScript:

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

LifecycleManagement.listen("sessionTransitionCompleted", (completed) => {
  console.log(completed);
});

Value of completed:

{
	"appId": "SomeAppId",
	"sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
	"loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
	"activeSessionId": "05b6f6af-c2f8-4761-beeb-6029590b8e8c",
	"transitionPending": false
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "LifecycleManagement.onSessionTransitionCompleted",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "SomeAppId",
    "sessionId": "c0d012b4-0854-4bbc-82d5-ab52ac29dd94",
    "loadedSessionId": "612f307e-8b32-412e-bcec-831779bc07ae",
    "activeSessionId": "05b6f6af-c2f8-4761-beeb-6029590b8e8c",
    "transitionPending": false
  }
}

Provider Interfaces

LaunchProvider

The provider interface for the xrn:firebolt:capability:lifecycle:launch capability.

interface LaunchProvider {
  launch(
    parameters: LifecycleLaunchParameters,
    session: ProviderSession,
  ): Promise<LifecycleLaunchResponse>;
}

Usage:

LifecycleManagement.provide('xrn:firebolt:capability:lifecycle:launch', provider: LaunchProvider | object)

Examples

Register your app to provide the xrn:firebolt:capability:lifecycle:launch capability.

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

class MyLaunchProvider {
  async launch(parameters, session) {
    return {
      success: true,
    };
  }
}

LifecycleManagement.provide(
  "xrn:firebolt:capability:lifecycle:launch",
  new MyLaunchProvider(),
);

{
  "id": 1,
  "method": "LifecycleManagement.onRequestLaunch",
  "params": {
    "listen": true
  }
}

{
  "id": 1,
  "result": {
    "listening": true,
    "event": "LifecycleManagement.onRequestLaunch"
  }
}

{
  "id": 1,
  "result": {
    "correlationId": undefined,
    "parameters": {
      "appId": "SomeAppId",
      "intent": {
        "action": "home",
        "context": {
          "source": "voice"
        }
      }
    }
  }
}

{
  "id": 2,
  "method": "LifecycleManagement.launchResponse",
  "params": {
    "correlationId": undefined,
    "result": {
      "success": true
    }
  }
}

{
  "id": 2,
  "result": true
}

StateLifecycleProvider

The provider interface for the xrn:firebolt:capability:lifecycle:state capability.

interface StateLifecycleProvider {
  ready(
    parameters: LifecycleReadyParameters,
    session: ProviderSession,
  ): Promise<void>;
  close(
    parameters: LifecycleCloseParameters,
    session: ProviderSession,
  ): Promise<void>;
  finished(
    parameters: LifecycleFinishedParameters,
    session: ProviderSession,
  ): Promise<void>;
}

Usage:

LifecycleManagement.provide('xrn:firebolt:capability:lifecycle:state', provider: StateLifecycleProvider | object)

Examples

Register your app to provide the xrn:firebolt:capability:lifecycle:state capability.

import { LifecycleManagement } from "@firebolt-extn-js/ripple-sdk";

class MyStateLifecycleProvider {
  async ready(parameters, session) {
    return null;
  }

  async close(parameters, session) {
    return null;
  }

  async finished(parameters, session) {
    return null;
  }
}

LifecycleManagement.provide(
  "xrn:firebolt:capability:lifecycle:state",
  new MyStateLifecycleProvider(),
);

{
    "id": 1,
    "method": "LifecycleManagement.onRequestReady",
    "params": {
        "listen": true
    }
}

{
    "id": 2,
    "method": "LifecycleManagement.onRequestClose",
    "params": {
        "listen": true
    }
}

{
    "id": 3,
    "method": "LifecycleManagement.onRequestFinished",
    "params": {
        "listen": true
    }
}

{
    "id": 1,
    "result": {
        "listening": true,
        "event": "LifecycleManagement.onRequestReady"
    }

}

{
    "id": 2,
    "result": {
        "listening": true,
        "event": "LifecycleManagement.onRequestClose"
    }

}

{
    "id": 3,
    "result": {
        "listening": true,
        "event": "LifecycleManagement.onRequestFinished"
    }

}

{
  "id": 1,
  "result": {
    "correlationId": undefined,
    "parameters": {
      "appId": "SomeAppId"
    }
  }
}

{
  "id": 4,
  "method": "LifecycleManagement.readyResponse",
  "params": {
    "correlationId": undefined,
    "result": null
  }
}

{
  "id": 4,
  "result": true
}

{
  "id": 2,
  "result": {
    "correlationId": undefined,
    "parameters": {
      "appId": "SomeAppId",
      "reason": "userExit"
    }
  }
}

{
  "id": 5,
  "method": "LifecycleManagement.closeResponse",
  "params": {
    "correlationId": undefined,
    "result": null
  }
}

{
  "id": 5,
  "result": true
}

{
  "id": 3,
  "result": {
    "correlationId": undefined,
    "parameters": {
      "appId": "SomeAppId"
    }
  }
}

{
  "id": 6,
  "method": "LifecycleManagement.finishedResponse",
  "params": {
    "correlationId": undefined,
    "result": null
  }
}

{
  "id": 6,
  "result": true
}

Types

AppDescription

Information about the application

type AppDescription = {
  id: string; // The identifier for the app
  url?: string; // The url that the app will be launched with
  title?: string; // The display title of the app
  catalog?: string; // The catalog id that this app's content metadata comes from
};

AppSession

type AppSession = {
  appId: string; // The id of the app that this session is for
  sessionId?: string; // An id representing the the app's gateway access to Firebolt for this loaded session. This sessionId can be used by the application to connect via websocket to Firebolt.
  loadedSessionId?: string; // The sessionId scoped to the app loaded in any state. Firebolt should clear this sessionId whenever the app moves to unloading state.
  activeSessionId?: string; // The sessionId scoped to the current active session. Firebolt should clear this sessionId whenever the app moves to the inactive state. Firebolt should generate a new one anytime the app moves from inactive to active. This may be undefined for any inactive sessions.
  transitionPending: boolean; // Set to true if the session is currently pending a transition to a new status. A status can be before a session exists, an inactive session, or an active session. If this session is currently pending transition clients can subscribe to onSessionTransitionCompleted to know when the transition is complete. That event will give the new session ids that are associated with this session status. Clients should also subscribe to onSessionTransitionCanceled to know that the transition will never complete and was canceled.
};

LifecycleLaunchResponse

type LifecycleLaunchResponse = {
  success: boolean; // Whether the launch succeeded
};

LifecycleLaunchParameters

type LifecycleLaunchParameters = {
  appId: string; // The application ID
  intent?: NavigationIntent; // A Firebolt compliant representation of a user intention to navigate to a specific place in an app.
};

See also:

NavigationIntent

LifecycleReadyParameters

type LifecycleReadyParameters = {
  appId: string; // The application ID
};

LifecycleCloseParameters

type LifecycleCloseParameters = {
  appId: string; // The application ID
  reason: CloseReason; // The application close reason
};

See also:

CloseReason

LifecycleFinishedParameters

type LifecycleFinishedParameters = {
  appId: string; // The application ID
};

Runtime

Information about the runtime that the application is running in

type Runtime = {
  id?: string; // The identifier for the runtime
  transport?: "bridge" | "websocket"; // The type of transport the application container will use to communicate to Firebolt
};

SecondScreenEvent

An a message notification from a second screen device

type SecondScreenEvent = {
  type: "dial";
  version?: string;
  data?: string;
};

AppLaunch

Launch information for this app that will be loaded

type AppLaunch = {
  intent?: NavigationIntent; // A Firebolt compliant representation of a user intention to navigate to a specific place in an app.
  secondScreen?: SecondScreenEvent; // An a message notification from a second screen device
  inactive?: boolean; // Flag on whether or not the session is meant to remain in the inactive state for this session. This will instruct Firebolt on whether to start an activeSession. Default is false.
};

See also:

NavigationIntent SecondScreenEvent

LifecycleLaunchRequest

type LifecycleLaunchRequest = {
  parameters: LifecycleLaunchParameters; // The associated launch parameters
};

See also:

LifecycleLaunchParameters

LifecycleReadyRequest

type LifecycleReadyRequest = {
  parameters: LifecycleReadyParameters; // The associated lifecycle parameters
};

See also:

LifecycleReadyParameters

LifecycleCloseRequest

type LifecycleCloseRequest = {
  parameters: LifecycleCloseParameters; // The associated lifecycle parameters
};

See also:

LifecycleCloseParameters

LifecycleFinishedRequest

type LifecycleFinishedRequest = {
  parameters: LifecycleFinishedParameters; // The associated lifecycle parameters
};

See also:

LifecycleFinishedParameters

AppSessionRequest

type AppSessionRequest = {
  app: AppDescription; // Information about the application
  runtime?: Runtime; // Information about the runtime that the application is running in
  launch?: AppLaunch; // Launch information for this app that will be loaded
};

See also:

AppDescription Runtime AppLaunch