fuchsia.modular

ControlStory

Request

Name	Type
`story_name`	`string`
`request`	`server_end<StoryPuppetMaster>`

DeleteStory

Request

Name	Type
`story_name`	`string`

Response

<EMPTY>

GetStories

Request

<EMPTY>

Response

Name	Type
`story_names`	`vector<string>`

SessionRestartController

Defined in fuchsia.modular/session_restart_controller.fidl

A capability, typically offered from sessionmgr to select child components, allowing them to request the session to be restarted.

Restart

Requests to cleanly terminate and then immediately restart the session.

Request

<EMPTY>

SessionShell

Defined in fuchsia.modular/session_shell.fidl

This interface is implemented by a session shell and is used by the sessionmgr to hand to the session shell views of stories, or to notify that the view of a story is about to be closed.

AttachView

Displays the given story view. The story this view belongs to is identified by view_id.story_id. DEPRECATED. For transitional purposes only.

Request

Name	Type
`view_id`	`ViewIdentifier`
`view_holder_token`	`fuchsia.ui.views/ViewHolderToken`

AttachView2

Request

Name	Type
`view_id`	`ViewIdentifier`
`view_holder_token`	`fuchsia.ui.views/ViewHolderToken`

AttachView3

Added: 9

Request

Name	Type
`view_id`	`ViewIdentifier`
`viewport_creation_token`	`fuchsia.ui.views/ViewportCreationToken`

DetachView

Instructs the session shell to detach the view identified by view_id that was previously provided by AttachView() from the UI of the session shell. The view will be closed soon after DetachView() returns, or when a timeout is reached.

It is customary for the session shell to display a placeholder before a view is attached for a given view identifier, or after it was detached.

If the story identified by view_id.story_id is about to be deleted, the Shell will observe a call to StoryProviderWatcher.OnDelete() sometime after DetachView() returns.

If the session for which this session shell is responsible for is being terminated, or the session shell is stopped because it's replaced by another session shell, DetachView() will not be called at all, and the shell will rather observe a call to Lifecycle.Terminate().

Request

Name	Type
`view_id`	`ViewIdentifier`

Response

<EMPTY>

SessionShellContext

Defined in fuchsia.modular/session_shell.fidl

This interface allows a SessionShell to request capabilities from its creator in a way that is more explicit about the services that are offered than a generic ServiceProvider.

GetComponentContext

Request

Name	Type
`request`	`server_end<ComponentContext>`

GetPresentation

Request

Name	Type
`request`	`server_end<fuchsia.ui.policy/Presentation>`

GetStoryProvider

Request

Name	Type
`request`	`server_end<StoryProvider>`

Logout

Deprecated: Equivalent to Restart().

Request

<EMPTY>

Restart

Restarts the session.

Request

<EMPTY>

StoryController

Used by the clients of StoryProvider (SessionShell) to interact with a single story. Created by StoryProvider.

If StoryController is closed, the StoryState associated with this story does not change.

Annotate

Attach the annotations to the story.

Existing annotations with the same key will be overwritten.

Request

Name	Type
`annotations`	`vector<Annotation>[50]`

Response

Name	Type
`result`	`StoryController_Annotate_Result`

GetInfo

Gets information associated with the story.

Request

<EMPTY>

Response

Name	Type
`info`	`StoryInfo`
`state`	`StoryState`

GetInfo2

For transition purposes only.

Request

<EMPTY>

Response

Name	Type
`info`	`StoryInfo2`
`state`	`StoryState`

RequestStart

Requests to run the story controlled by this StoryController instance. When the story starts, if not yet running, the view of the newly started story shell will be passed in a call to SessionShell.AttachView().

Request

<EMPTY>

Stop

Requests to stop the story controlled by this StoryController. If Start() requests are pending when this request is issued, the request is queued until the Start() requests complete. Before stopping the story, a snapshot of the story will be taken and saved. Returns when the story is stopped.

Request

<EMPTY>

Response

<EMPTY>

Watch

Registers a watcher for changes of the story state.

Note that stories can stop themselves at any time and it is advisable for the holder of a StoryController to provide a watcher.

Request

Name	Type
`watcher`	`StoryWatcher`

StoryProvider

Defined in fuchsia.modular/story_provider.fidl

Sessionmgr passes a connection to this service to the SessionShell so it can operate on stories for the user.

Closing a StoryProvider connection has no effect on the state of the framework.

GetController

Obtains a controller for a previously created story identified by its story ID. Obtaining the controller doesn't run it yet. If the story doesn't exist, the interface request is closed.

Request

Name	Type
`story_id`	`string`
`request`	`server_end<StoryController>`

GetStories

Returns a list of existing stories. If watcher is provided, the client will be notified of story changes (new stories, deleted stories, runtime state changes).

Request

Name	Type
`watcher`	`StoryProviderWatcher?`

Response

Name	Type
`story_infos`	`vector<StoryInfo>`

GetStories2

For transition purposes only.

Request

Name	Type
`watcher`	`StoryProviderWatcher?`

Response

Name	Type
`story_infos`	`vector<StoryInfo2>`

GetStoryInfo

Requests detailed information about the given story. If the story doesn't exist, returns null.

Request

Name	Type
`story_id`	`string`

Response

Name	Type
`story_info`	`StoryInfo?`

GetStoryInfo2

For transition purposes only.

Request

Name	Type
`story_id`	`string`

Response

Name	Type
`story_info`	`StoryInfo2`

Watch

Registers a watcher for changes in the story collection. DEPRECATED: In favor of GetStories().

Request

Name	Type
`watcher`	`StoryProviderWatcher`

StoryProviderWatcher

Defined in fuchsia.modular/story_provider.fidl

Implemented by clients of StoryProvider.

OnChange

Called in three different situations:

Immediately when a new watcher is registered with one OnChange() invocation with the current infor and state of each story known on the current device.
Every time a change to StoryInfo is applied to the record of the story.
Every time the StoryState of the story changes.

The ID of the story the notifications are about are part of StoryInfo.

story_state is STOPPED if the story was just created or just became known on this device and was not yet started on the current device. It's RUNNING when the story is started on the current device.

story_visibility_state is deprecated and will always have a value of DEFAULT.

Request

Name	Type
`story_info`	`StoryInfo`
`story_state`	`StoryState`
`story_visibility_state`	`StoryVisibilityState`

OnChange2

For transition purposes only.

Request

Name	Type
`story_info`	`StoryInfo2`
`story_state`	`StoryState`
`story_visibility_state`	`StoryVisibilityState`

OnDelete

Called when a story record is permanently deleted. The deletion could have originated on this or on another device.

If the story is running on this device at the time it is deleted, OnChange() will not be called first.

Request

Name	Type
`story_id`	`string`

StoryPuppetMaster

Annotate

Attach the annotations to the story. If the story does not yet exist, it will be created.

Existing annotations with the same key will be overwritten, or deleted if new value is null.

Request

Name	Type
`annotations`	`vector<Annotation>[50]`

Response

Name	Type
`result`	`StoryPuppetMaster_Annotate_Result`

Enqueue

Request

Name	Type
`commands`	`vector<StoryCommand>`

Execute

Request

<EMPTY>

Response

Name	Type
`result`	`ExecuteResult`

WatchAnnotations

Returns the annotations attached to this story.

This is a "hanging get" that returns the current annotations on first call, and on subsequent calls returns the full set of annotations once they are updated.

Returns AnnotationError.NOT_FOUND if the story does not exist.

Request

<EMPTY>

Response

Name	Type
`result`	`StoryPuppetMaster_WatchAnnotations_Result`

StoryShell

This interface is implemented by a story shell. Dependencies are passed to it in Initialize() on startup. The story shell is also expected to implement Lifecycle in order to receive a Terminate() call on teardown.

In one component instance there can only be one StoryShell service instance. The view token is sent to the separate View service. This way, the story shell may be implemented as a flutter component.

Teardown may occur via the session shell calling StoryController.Stop(), the sessionmgr being terminated, or by the system shutting down.

AddSurface

Adds a new Surface and its corresponding view to be displayed by the StoryShell. More context that allows the story shell to decide how to layout will be added later. Also, interface to influence life cycle and focus is obviously missing. view_connection the new view and the associated Surface ID. surface_info metadata relating to the Surface.

Request

Name	Type
`view_connection`	`ViewConnection`
`surface_info`	`SurfaceInfo`

AddSurface2

DEPRECATED. For transition purposes only.

Request

Name	Type
`view_connection`	`ViewConnection2`
`surface_info`	`SurfaceInfo`

AddSurface3

For transition purposes only.

Request

Name	Type
`view_connection`	`ViewConnection`
`surface_info`	`SurfaceInfo2`

DefocusSurface

Defocuses the surface with surface_id, dismissing it to the background.

Request

Name	Type
`surface_id`	`string`

Response

<EMPTY>

FocusSurface

Focuses the surface with surface_id, bringing it to the foreground.

Request

Name	Type
`surface_id`	`string`

Initialize

Request

Name	Type
`story_shell_context`	`StoryShellContext`

OnSurfaceFocused

Notify when a Surface is focused in the story. The focus could be from a user interaction or requested by the framework through StoryController#FocusModule. EXPERIMENTAL

Response

Name	Type
`surface_id`	`string`

RemoveSurface

Remove the Surface with surface_id from the StoryShell entirely. This is final. The Surface is removed from the graph. If necessary, the associated Surface is defocused. There is no expectation that DefocusSurface is called before this.

Request

Name	Type
`surface_id`	`string`

UpdateSurface

Update the surface This is called when the intent is to update the surface metadata in the story graph in place. Any fields, except for the surface_id can be updated. If no value or null is passed for a field it remains unchanged. This includes the view_holder_token inside the connection.

E.g called when an intent resolves to a module that is known by the caller to already be running, to update associated metadata.

Request

Name	Type
`view_connection`	`ViewConnection`
`surface_info`	`SurfaceInfo`

UpdateSurface2

DEPRECATED. For transition purposes only.

Request

Name	Type
`view_connection`	`ViewConnection2`
`surface_info`	`SurfaceInfo`

UpdateSurface3

For transition purposes only.

Request

Name	Type
`view_connection`	`ViewConnection`
`surface_info`	`SurfaceInfo2`

StoryShellContext

The story shell receives this protocol upon initialization.

StoryShellFactory

Defined in fuchsia.modular/story_shell_factory.fidl

StoryShellFactory creates or returns an existing StoryShell for a particular story. This is intended to be implemented by session shells that want to implement StoryShell functionality themselves.

AttachStory

Requests a StoryShell for the story with the given story_id.

Request

Name	Type
`story_id`	`string`
`story_shell`	`server_end<StoryShell>`

DetachStory

Instructs the session shell to teardown the story shell with the given story_id. This will be called before the story is stopped.

Request

Name	Type
`story_id`	`string`

Response

<EMPTY>

StoryWatcher

Implemented by the client calling StoryController.Watch().

OnModuleAdded

DEPRECATED

Request

Name	Type
`module_data`	`ModuleData`

OnModuleFocused

DEPRECATED

Request

Name	Type
`module_path`	`vector<string>`

OnStateChange

Called with the current state right after registration, and subsequently when the state changes.

Request

Name	Type
`new_state`	`StoryState`

STRUCTS

AddMod resource

Defined in fuchsia.modular/story_command.fidl

Adds a mod described by intent to the story with name mod_name. If mod_name already exists in the story, the mod is updated.

Field	Type	Description	Default
`mod_name`	`vector<string>`	The name of the mod within the story. The mod's name acts as the unique ID of the mod, scoped to the story in which it is contained. Since AddMod is reused for observation and mod names are vectorstring:MAX inside the framework, they are vectorstring:MAX:MAX here as well. Clients should treat the full vector as a single opaque value. Clients should provide `mod_name_transitional` instead. If both are provided, `mod_name` is ignored.	No default
`mod_name_transitional`	`string?`	The name of the mod within the story. This should be used instead of `mod_name`. If provided, it is equivalent to passing `mod_name` with a single item. If both are provided, `mod_name` is ignored.	No default
`intent`	`Intent`		No default
`surface_relation`	`SurfaceRelation`	`surface_relation` defines the visual relationship between this mod and the mod at `surface_parent_mod_name`.	No default
`surface_parent_mod_name`	`vector<string>?`		No default

Annotation resource

Defined in fuchsia.modular/annotation.fidl

A user-defined annotation for a story or module.

Field	Type	Description	Default
`key`	`AnnotationKey`	An identfier for this annotation.	No default
`value`	`AnnotationValue?`	The contents of this annotation.	No default

ExecuteResult

Field	Type	Default
`status`	`ExecuteStatus`	No default
`story_id`	`string?`	No default
`error_message`	`string?`	No default

Intent resource

Defined in fuchsia.modular/intent.fidl

The Intent struct is a runtime descriptor for an abstract action to be initiated in Fuchsia. For details please see docs/intent.md.

Field Type Description Default

action

string?

The name of the action represented by this Intent.

This is nullable for backwards compatibility.

No default

handler

string?

An explicit handler for the Intent. Specified as the component URL of the module.

No default

parameters

vector<IntentParameter>?

NON-FUNCTIONAL: parameters is no longer supported but must remain for ABI compatibility.

No default

IntentFilter

This struct is used to describe an intent that a module is able to handle.

Field	Type	Description	Default
`action`	`string`	The action this module is able to handle.	No default
`parameter_constraints`	`vector<ParameterConstraint>`	Includes the name and types of entities for the parameters required to execute specified [action].	No default
`action_display`	`ActionDisplay`	Defines presentation properties for suggestions of this action.	No default

IntentParameter resource

Defined in fuchsia.modular/intent.fidl

NON-FUNCTIONAL: IntentParameter is no longer supported but must remain for ABI compatibility. A struct representing a parameter that is passed to the handler of an Intent's Action.

Field	Type	Description	Default
`name`	`string?`	The name of the parameter. The handler (i.e. selected mod) will be provided with the data for this parameter under a link called `name`.	No default
`data`	`IntentParameterData`	The data that will be passed to the intent handler.	No default

ModuleManifest

Metadata that define the runtime properties of a Module.

Field	Type	Description	Default
`binary`	`string`	The relative path from the root of the package where the Module executable file can be found. TODO(fxbug.dev/16039): Extract a module's URL from its cmx manifest instead of here.	No default
`suggestion_headline`	`string?`	A human-readable string:MAX that can be used when suggesting this Module. DEPRECATED.	No default
`intent_filters`	`vector<IntentFilter>?`	A list of intents that this module is able to handle.	No default
`composition_pattern`	`string?`	Identifies the pattern with which to compose this module with others.	No default
`placeholder_color`	`string?`	Defines the color of the placeholder widget used while the module loads.	No default

ParameterConstraint

Field	Type	Description	Default
`name`	`string`		No default
`type`	`string`	The entity type that is valid for this parameter.	No default

RemoveMod

Defined in fuchsia.modular/story_command.fidl

Removes the mod under mod_name from the story.

Field Type Description Default

mod_name

vector<string>

The name of the mod within the story.

Clients should provide mod_name_transitional instead. If both are provided, mod_name is ignored.

No default

mod_name_transitional

string?

The name of the mod within the story. This should be used instead of mod_name. If provided, it is equivalent to passing mod_name with a single item. If both are provided, mod_name is ignored.

No default

StoryController_Annotate_Response

<EMPTY>

StoryInfo

Defined in fuchsia.modular/story_info.fidl

Information about a story as provided to the SessionShell.

Field	Type	Description	Default
`url`	`string?`	URL of the first module run in this story. This module is free to run more modules in the story. Used for display purposes only.	No default
`id`	`string`	The ID of the Story, used to reference it in method arguments.	No default
`last_focus_time`	`int64`	Wallclock time when the story was last focused. A UTC time in nanoseconds since UNIX epoch (1970-01-01 00:00). A value of zero means the story has never been focused.	No default
`extra`	`vector<StoryInfoExtraEntry>?`	Data the SessionShell wants to keep associated with this Story, like title, a color, or a display rank.	No default

StoryInfoExtraEntry

Defined in fuchsia.modular/story_info.fidl

Field	Type	Description	Default
`key`	`string`		No default
`value`	`string`		No default

StoryOptions

Defined in fuchsia.modular/story_options.fidl

Field	Type	Description	Default
`kind_of_proto_story`	`bool`	Whether or not the story will be hidden on a call to StoryProvider#GetStories.	No default

StoryPuppetMaster_Annotate_Response

<EMPTY>

StoryPuppetMaster_WatchAnnotations_Response resource

Field	Type	Description	Default
`annotations`	`vector<Annotation>[100]`		No default

SurfaceInfo

Contains metadata for a Surface.

Field	Type	Description	Default
`parent_id`	`string`	ID of the view that is parent of this Surface.	No default
`surface_relation`	`SurfaceRelation?`	The relationship between the parent Surface and this new Surface. Used for layout optimization.	No default
`module_manifest`	`ModuleManifest?`	Information about the module populates the view.	No default
`module_source`	`ModuleSource`	How the Surface was generated. By an action internal to the story or by an external action.	No default

SurfaceRelation

Defined in fuchsia.modular/surface.fidl

Describes the relationship between two Surfaces. Provides information to the StoryShell for layout optimization.

Field	Type	Description	Default
`arrangement`	`SurfaceArrangement`	Advice on arranging these surfaces on the screen together.	SurfaceArrangement.NONE
`dependency`	`SurfaceDependency`	Advice for dismissal of surfaces to be linked.	SurfaceDependency.NONE
`emphasis`	`float32`	Relative emphasis of the child surface, relative to the parent. Influences relative areas of surfaces on screen.	1

ViewConnection resource

A pair mapping a surface ID to a view (via view_holder_token).

Field	Type	Description	Default
`surface_id`	`string`	The ID for the surface	No default
`view_holder_token`	`fuchsia.ui.views/ViewHolderToken`	Token for embedding the new view corresponding to the surface.	No default

ViewConnection2 resource

DEPRECATED, for transition purposes only.

Field	Type	Description	Default
`surface_id`	`string`	The ID for the surface	No default
`view_holder_token`	`fuchsia.ui.views/ViewHolderToken`	Token for embedding the new view corresponding to the surface.	No default

ViewIdentifier

Defined in fuchsia.modular/session_shell.fidl

Identifies a view provided to a session shell. The values of the story_id field match those used in the StoryProvider interface, allowing identification of the same story across interfaces.

This is a struct rather than a naked string:MAX to allow for future evolution of the identifier without changing the SessionShell API itself.

Field	Type	Description	Default
`story_id`	`string`		No default

ENUMS

AnnotationError strict

Type: uint32

Defined in fuchsia.modular/annotation.fidl

Error returned from calls to Annotate().

Name	Value	Description
VALUE_TOO_BIG	`1`	The `AnnotationValue.buffer` size exceeds the maximum length, `MAX_ANNOTATION_VALUE_BUFFER_LENGTH_BYTES`.
TOO_MANY_ANNOTATIONS	`2`	The total number of annotations on the story or module being annotated exceeds `MAX_ANNOTATIONS_PER_STORY` or `MAX_ANNOTATIONS_PER_MODULE`.
NOT_FOUND	`3`	The resource to be annotated was not found and could not be resolved by, for example, waiting, or creating the missing resource automatically. This error may be returned by StoryPuppetMaster.AnnotateModule(), which can wait for a missing Module, but requires the Module's Story exist.

ConfigureStoryError strict

Type: int32

Name	Value	Description
ERR_STORY_ALREADY_CREATED	`1`	The story cannot be (re)configured because it was already created.

ExecuteStatus strict

Type: uint32

Name	Value	Description
OK	`0`
INVALID_COMMAND	`1`
INVALID_STORY_ID	`2`
STORY_MUST_HAVE_MODS	`3`
INVALID_MOD	`4`
NO_MODULES_FOUND	`5`
INTERNAL_ERROR	`6`

ModuleSource strict

Type: uint32

Defined in fuchsia.modular/module_data.fidl

Name	Value	Description
INTERNAL	`0`	Module that was added to the story from within the story by another module using ModuleContext.AddModuleToStory() or ModuleContext.EmbedModule().
EXTERNAL	`1`	Module that was added to the story from outside the story using PuppetMaster.

ModuleState strict

Type: uint32

Defined in fuchsia.modular/module_state.fidl

State used to notify about state transitions of a Module instance. This is very similar to the StoryState, however it's not entirely the same and hence a separate type. A module cannot have an INITIAL state, because it's started as soon as it is created, and it gets deleted as soon as it reaches the STOPPED state, whileas a story can be restarted.

Currently possible state transitions (and the events that cause them) are:

        -> RUNNING     ModuleContext.AddModuleToStory() or
                       ModuleContext.EmbedModule() or
                       StoryController.AddModule()

RUNNING -> STOPPED ModuleController.Stop() or StoryController.Stop() RUNNING -> ERROR application exits

Name	Value	Description
RUNNING	`2`	Module instance was created.
STOPPED	`4`	Module instance is stopped after Module.Stop(). No further transitions are to be expected.
ERROR	`5`	Connection to the Module instance was closed without Stop() request. No further transitions are to be expected.

OngoingActivityType strict

Type: uint32

Defined in fuchsia.modular/module_context.fidl

Name	Value	Description
UNSPECIFIED	`0`
VIDEO	`1`
AUDIO	`2`

StoryState strict

Type: uint32

Defined in fuchsia.modular/story_state.fidl

State of a Story. A story is either running, stopping, or stopped, separately on every device of the user. If it's running, it can also be focused, but that's tracked in a separate service, cf. FocusProvider in focus.fidl.

Possible state transitions are:

STOPPED -> RUNNING RUNNING -> STOPPING STOPPING -> STOPPED

Name	Value	Description
RUNNING	`1`	Story was started using StoryController.Start().
STOPPING	`2`	Story is in the middle of stopping after StoryController.Stop() was called.
STOPPED	`3`	Story was not yet run, or Story was stopped after StoryController.Stop() was called.

StoryVisibilityState strict

Type: uint32

Defined in fuchsia.modular/story_provider.fidl

Name	Value	Description
DEFAULT	`1`
IMMERSIVE	`2`

StoryVisualState strict

Type: uint32

Defines the visual state of the Story shell.

Name	Value	Description
MINIMIZED	`0`
MAXIMIZED	`1`
MAXIMIZED_OVERLAYED	`2`

SurfaceArrangement strict

Type: uint32

Defined in fuchsia.modular/surface.fidl

Expresses arrangement type.

Name	Value	Description
NONE	`0`	No arrangement specified.
COPRESENT	`1`	Desire to present simultaneously.
SEQUENTIAL	`2`	The parent prefers to not be presented simultaneously with its child. (The child may still become part of a simultaneous presentation depending on the relationships between it and subsequently added surfaces).
ONTOP	`3`	Place this surface on top of and obscuring the parent surface. This is a complete replacement, not a modal or inset presentation.

SurfaceDependency strict

Type: uint32

Defined in fuchsia.modular/surface.fidl

Links surface dismissal.

Name	Value	Description
NONE	`0`	No dependency specified.
DEPENDENT	`1`	Child is dependent on parent. If parent is dismissed, child is dismissed as well.

TABLES

ActionDisplay

Defines how a suggestion of an action will be presented.

Ordinal	Field	Type	Description
1	`display_info`	`DisplayInfo`	Defines presentation fields for a suggestion. The string:MAX fields might be templated and will be filled from data in `parameter_mapping`. For example: "Listen to $artistName"
2	`parameter_mapping`	`vector<ParameterMapping>`	Fields to be replaced in the given `display_info` templated strings. In the example above, we would map name=artistName to the intent field artist.name where artist is the intent parameter name and name a field of it.

AgentServiceRequest resource

Defined in fuchsia.modular/component_context.fidl

Used by ComponentContext.ConnectToAgentService

Ordinal	Field	Type	Description
1	`service_name`	`string`	The name of the requested service.
2	`channel`	`handle<channel>`	The channel that will be used to communicate with the requested service.
3	`handler`	`fuchsia.sys/component_url`	The component URL of the Agent that is to provide the specified service. If no handler is specified, the framework will perform resolution to find an appropriate handler.
4	`agent_controller`	`server_end<AgentController>`	The AgentController handle is optional. If provided, the channel will be kept open until the agent providing `service_name` is terminated.

DisplayInfo

Presentation information about the suggestion.

Ordinal	Field	Type	Description
1	`title`	`string`	The title of the suggestion.
2	`subtitle`	`string`	A subtitle for the suggestion.
3	`icon`	`string`	A url from which to fetch the icon of the suggestion.

ModuleData resource

Defined in fuchsia.modular/module_data.fidl

Information about a Module instance in a story.

Ordinal	Field	Type	Description
1	`module_url`	`string`	The URL of the Module binary.
2	`module_path`	`vector<string>`	The named path leading up to this Module instance. The last name in this array is the name by which the Module was started by the parent Module instance calling StartModule().
3	`RESERVED`
4	`module_source`	`ModuleSource`	The way in which this Module instance was first started in the story, either by request from another Module instance (INTERNAL) or by request from outside the story (i.e. by suggestion from an agent - EXTERNAL).
5	`surface_relation`	`SurfaceRelation`	The `surface_relation` that was used to start this Module instance with. The same is used when re-inflating the Module instance when the story is resumed. A SurfaceRelation value of null represents an embedded Module instance (started by EmbedModule()) that is not managed by the story shell.
6	`module_deleted`	`bool`	True if this module was removed from its story either through ModuleController.Stop() or ModuleContext.RemoveSelfFromStory().
7	`intent`	`Intent`	The intent that was issued to start add this Module instance to the story. Some Module instances may have been added not by an Intent, for example as the initial module of a story. For those the field may be null. TODO(thatguy,mesch): This field should now always be set, so make it required once the framework is cleaned up enough to guarantee this statement.
8	`is_embedded`	`bool`	If true, this module was started by a parent module using ModuleContext.EmbedModule(), and its view is not managed by the StoryShell.
9	`annotations`	`vector<Annotation>[100]`	Collection of user-defined key-value attributes that describe this surface (module). The `Annotation.value` field of each `Annotation` is always set.
10	`additional_services`	`fuchsia.sys/ServiceList`	Services passed to the module. This is only set for modules that represent elements.

ParameterMapping

Defines pairs that will be replaced in the DisplayInfo.

Ordinal	Field	Type	Description
1	`name`	`string`	The name of the variable to be replaced in the template.
2	`parameter_property`	`string`	The path in the intent parameter to get that name. `PARAMETER_PROPERTY` = string:MAX \| string:MAX . `PARAMETER_PROPERTY` The first string:MAX in the dot-separated string:MAX is the name of the intent parameter and the following are nested subfields.

StoryInfo2 resource

Defined in fuchsia.modular/story_info.fidl

Information about a story as provided to the SessionShell. For transition purposes only.

Ordinal Field Type Description

1

id

string

The ID of the Story, used to reference it in method arguments.

2

last_focus_time

int64

Wallclock time when the story was last focused. A UTC time in nanoseconds since UNIX epoch (1970-01-01 00:00).

A value of zero means the story has never been focused.

3

annotations

vector<Annotation>[100]

Collection of user-defined key-value attributes that describe this story.

The Annotation.value field of each Annotation is always set.

SurfaceInfo2 resource

Contains metadata for a Surface.

Ordinal	Field	Type	Description
1	`parent_id`	`string`	ID of the view that is parent of this Surface.
2	`surface_relation`	`SurfaceRelation`	The relationship between the parent Surface and this new Surface. Used for layout optimization.
3	`module_manifest`	`ModuleManifest`	Information about the module populates the view.
4	`module_source`	`ModuleSource`	How the Surface was generated. By an action internal to the story or by an external action.
5	`annotations`	`vector<Annotation>[100]`	Collection of user-defined key-value attributes that describe this surface (module). The `Annotation.value` field of each `Annotation` is always set.
6	`view_ref`	`fuchsia.ui.views/ViewRef`	The view ref associated with the surface, if one is present.

UNIONS

AnnotationValue flexible resource

Defined in fuchsia.modular/annotation.fidl

The value of a fuchsia.modular/Annotation.

The actual field used depends on the type of annotation, which is user-defined, and not enforced by the framework.

The size of buffer is limited to MAX_ANNOTATION_VALUE_BUFFER_LENGTH_BYTES bytes.

Ordinal	Variant	Type
1	`text`	`string[1024]`
2	`bytes`	`vector<uint8>[1024]`
3	`buffer`	`fuchsia.mem/Buffer`

IntentParameterData strict resource

Defined in fuchsia.modular/intent.fidl

NON-FUNCTIONAL: IntentParameterData is no longer supported but must remain defined for IntentParameter's ABI compatibility.

Ordinal Variant Type Description

1

entity_reference

string

Set this if you already have an Entity reference at runtime. Entity.getTypes() will be used to set the constraints for this noun during resolution.

2

json

fuchsia.mem/Buffer

Set this if you have structured JSON data. Values typically are a JSON object with a "@type" attribute and other associated data. TODO(thatguy): We need to decide if we want to keep this in place, or deprecate this eventually and move entirely to using Entity references.

DEPRECATED: Use entity_reference.

3

entity_type

vector<string>

Set this if you want to explicitly define this noun's allowed types. This is also useful in the cases where the noun has a 'direction' of type 'output', and you wish to set the allowable output types from the Module (see docs/modular/manifests/action_template.md for a definition of 'direction').

Only one entry in entity_type must match the constraint specified by the Module for the constraint to be considered satisfied.

StoryCommand strict resource

Defined in fuchsia.modular/story_command.fidl

StoryCommands are POD structures that describe the set of operations that can be performed on a story by components outside the modular framework. All commands are:

(1) Scoped to a single story (2) Idempotent: issuing the same command twice yields the same result (3) Symmetrical with observation: the same structures are used to describe operations to watchers of a story (through SessionWatcher) as are used to control a story.

Ordinal	Variant	Type	Description
1
2	`add_mod`	`AddMod`	Adds a Mod.
3	`remove_mod`	`RemoveMod`	Removes an existing Mod.
4
5
6

StoryController_Annotate_Result strict

Ordinal	Variant	Type	Description
1	`response`	`StoryController_Annotate_Response`
2	`err`	`AnnotationError`

StoryPuppetMaster_Annotate_Result strict

Ordinal	Variant	Type	Description
1	`response`	`StoryPuppetMaster_Annotate_Response`
2	`err`	`AnnotationError`

StoryPuppetMaster_WatchAnnotations_Result strict resource