Macros

Pattern that matches an unknown AnnotationValue member.

Structs

Defines how a suggestion of an action will be presented.
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.
A Stream of incoming requests for AgentController
A Stream of incoming requests for Agent
Used by ComponentContext.ConnectToAgentService
A user-defined annotation for a story or module.
A Stream of incoming requests for ComponentContext
Presentation information about the suggestion.
The Intent struct is a runtime descriptor for an abstract action to be initiated in Fuchsia. For details please see docs/intent.md.
This struct is used to describe an intent that a module is able to handle.
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.
A Stream of incoming requests for Lifecycle
A Stream of incoming requests for ModuleContext
Information about a Module instance in a story.
Metadata that define the runtime properties of a Module.
A Stream of incoming requests for OngoingActivity
Defines pairs that will be replaced in the DisplayInfo.
A Stream of incoming requests for PuppetMaster
Removes the mod under mod_name from the story.
A Stream of incoming requests for SessionRestartController
A Stream of incoming requests for SessionShellContext
A Stream of incoming requests for SessionShell
A Stream of incoming requests for StoryController
Information about a story as provided to the SessionShell.
Information about a story as provided to the SessionShell. For transition purposes only.
A Stream of incoming requests for StoryProvider
A Stream of incoming requests for StoryProviderWatcher
A Stream of incoming requests for StoryPuppetMaster
A Stream of incoming requests for StoryShellContext
A Stream of incoming requests for StoryShellFactory
A Stream of incoming requests for StoryShell
A Stream of incoming requests for StoryWatcher
Contains metadata for a Surface.
Contains metadata for a Surface.
Describes the relationship between two Surfaces. Provides information to the StoryShell for layout optimization.
A pair mapping a surface ID to a view (via view_holder_token).
DEPRECATED, for transition purposes only.
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.

Enums

This interface is used by the caller of ComponentContext::DeprecatedConnectToAgent() to tell the framework that it is still interested in keeping this Agent running.
An agent is a component whose lifecycle is not tied to any Story.
Error returned from calls to Annotate().
The value of a [fuchsia.modular/Annotation].
Provided to all component instances in their incoming namespace.
NON-FUNCTIONAL: IntentParameterData is no longer supported but must remain defined for IntentParameter’s ABI compatibility.
An interface implemented by applications that wish to terminate gracefully.
This interface is exposed to all Module instances in a story. It allows to create Link instances and run more Module instances.
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.
This interface defines the protocol over which a Module can communicate about an ongoing activity to the framework. It is provided to Modules via ModuleContext.StartOngoingActivity().
A capability, typically offered from sessionmgr to select child components, allowing them to request the session to be restarted.
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.
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.
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:
Used by the clients of StoryProvider (SessionShell) to interact with a single story. Created by StoryProvider.
Sessionmgr passes a connection to this service to the SessionShell so it can operate on stories for the user.
Implemented by clients of StoryProvider.
The story shell receives this protocol upon initialization.
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.
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.
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.
Defines the visual state of the Story shell.
Implemented by the client calling StoryController.Watch().
Expresses arrangement type.
Links surface dismissal.

Constants

Maximum number of annotations on a single module.
Maximum number of annotations on a single story.
Maximum number of annotations that can be passed to either method Annotate() AnnotateModule() in fuchsia.modular protocols that support annotations.
Maximum length of [fuchsia.modular/AnnotationKey].
Maximum length of the [fuchsia.modular/AnnotationValue.buffer] field, in bytes.
Maximum length of [fuchsia.modular/AnnotationValue] fields: text and bytes.

Traits

Type Definitions