blob: bc7ee48e9aaf1a9c73c9c6b6daf28554db966fac [file] [log] [blame]
// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
using zx;
/// Sessions contain a model describing the set of stories and modules contained within.
/// SessionController allows clients to mutate and observe the session's model. Observed changes
/// may originate from other local clients, or from the same session running on a different device.
protocol SessionController {
/// Requests a story controller for the story identified by |id|. |id| may be any
/// client-supplied value. A previously unused |id|, or one identifying a story that has been
/// deleted (using DeleteStory()) will create a new story record.
/// |id|s are scoped to the requesting client's Component URL: two different clients
/// which use the same |id| will be controlling different story instances.
/// In some system configurations, the results of mutating a story's state are durable across
/// reboots and devices.
/// |request| is closed if control cannot be granted, or when DeleteStory() is called for the
/// same |id| on any device.
// TODO(MF-322): Enforce the above |id| isolation.
GetStoryController( id, request<StoryController> request);
/// Permanently deletes the story identified by |id|. Any StoryControllers
/// obtained through GetStoryController() will be closed.
DeleteStory( id);
/// Immediately returns the list of existing stories on the first call. On
/// subsequent calls, waits and returns the list of stories only once the
/// list has changed.
WatchStories() -> (vector<StoryInfo> stories);
/// Metadata about a single Story.
table StoryInfo {
/// The ID of the story as supplied to SessionController/GetStoryController().
1: id;
/// True if the story is currently focused on this device.
2: bool is_focused;
/// The timestamp at which this story was most recently focused across all
/// devices. If unset, the story has never been focused.
3: zx.time last_focus_time;