fuchsia.modular.session

ENUMS

CloudProvider

Type: uint32

Defined in fuchsia.modular.session/modular_config.fidl

NameValueDescription
LET_LEDGER_DECIDE 1

Use a cloud provider configured by Ledger.

FROM_ENVIRONMENT 2

Use a cloud provider available in the incoming namespace, rather than initializing and instance within sessionmgr. This can be used to inject a custom cloud provider.

NONE 3

TABLES

BasemgrConfig

Defined in fuchsia.modular.session/modular_config.fidl

Descriptions and defaults for these configurations are echoed in peridot/docs/modular/guide/config.md.

OrdinalNameTypeDescription
1 enable_cobalt bool

When set to false, Cobalt statistics are disabled. Default: true

2 use_minfs bool

When set to true, wait for persistent data to initialize. Default: true

3 use_session_shell_for_story_shell_factory bool

Create story shells through StoryShellFactory exposed by the session shell instead of creating separate story shell components. When set, story_shell_url and any story shell args are ignored. Default: false

4 base_shell BaseShellConfig

Launch configurations specific to base shell.

5 session_shell_map vector<SessionShellMapEntry>

A map of launch configurations specific to session shells.

6 story_shell StoryShellConfig

Launch configurations specific to story shell.

7 sessionmgr AppConfig

Temporary placeholder to pass configurations to sessionmgr. Will be removed with the completion of MF-10.

BaseShellConfig

Defined in fuchsia.modular.session/modular_config.fidl

OrdinalNameTypeDescription
1 app_config AppConfig

Contains the fuchsia package url and arguments to pass to the shell.

2 keep_alive_after_login bool

When set to true, the base shell is kept alive after a log in. This is used for testing because current integration tests expect base shell to always be running. Default: false

SessionShellMapEntry

Defined in fuchsia.modular.session/modular_config.fidl

OrdinalNameTypeDescription
1 name string[4096]

The name of the session shell represented by its url.

2 config SessionShellConfig

The launch configurations for the session shell.

SessionShellConfig

Defined in fuchsia.modular.session/modular_config.fidl

OrdinalNameTypeDescription
1 app_config AppConfig

Contains the fuchsia package url and arguments to pass to the shell.

2 display_usage fuchsia.ui.policy/DisplayUsage

The display usage policy for this session shell.

Optional: defaults to DisplayUsage::kUnknown.

3 screen_height float32

The screen height in millimeters for the session shell's display.

Optional: defaults to full screen.

4 screen_width float32

The screen width in millimeters for the session shell's display.

Optional: defaults to full screen.

StoryShellConfig

Defined in fuchsia.modular.session/modular_config.fidl

OrdinalNameTypeDescription
1 app_config AppConfig

Contains the fuchsia package url and arguments to pass to the shell.

SessionmgrConfig

Defined in fuchsia.modular.session/modular_config.fidl

OrdinalNameTypeDescription
1 cloud_provider CloudProvider
2 enable_cobalt bool

When set to false, Cobalt statistics are disabled. This is used for testing. Default: true

3 enable_story_shell_preload bool

When set to false, StoryShell instances are not warmed up as a startup latency optimization. This is used for testing. Default: true

4 use_memfs_for_ledger bool

Tells the sessionmgr whether it should host+pass a memfs-backed directory to the ledger for the user's repository, or to use /data/LEDGER. Default: false

5 startup_agents vector<string>

A list of fuchsia package urls that specify which agents to launch at startup.

6 session_agents vector<string>

A list of fuchsia package urls that specify which agents to launch at startup with PuppetMaster and FocusProvider services.

7 story_shell_url string[4096]

The fuchsia package url for which story shell to use.

8 component_args vector<AppConfig>

A map of agents to the arguments they should be started with.

9 use_parent_runner_for_story_realm bool

Deprecated

10 agent_service_index vector<AgentServiceIndexEntry>

A list of supported services and the URL of the agent known to provide that service. Used by the Session Manager to implement ComponentContext method ConnectToAgentService().

AppConfig

Defined in fuchsia.modular.session/modular_config.fidl

Used to pass around configuration references to apps such as base shell, session shell, story shell, and agents.

OrdinalNameTypeDescription
1 url string[4096]

The fuchsia package url for app.

2 args vector<string>

The arguments for the app.

AgentServiceIndexEntry

Defined in fuchsia.modular.session/modular_config.fidl

A service and the URL of the agent known to provide that service.

OrdinalNameTypeDescription
1 service_name string

The service name.

2 agent_url fuchsia.sys/component_url

The fuchsia component url for agent.

ModularConfig

Defined in fuchsia.modular.session/modular_config.fidl

Contains the configurations for the modular framework components.

OrdinalNameTypeDescription
1 basemgr_config BasemgrConfig
2 sessionmgr_config SessionmgrConfig