chromium/chrome/common/apps/platform_apps/api/enterprise_remote_apps.idl

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Use the <code>chrome.enterprise.remoteApps</code> API to add remote apps to
// the ChromeOS launcher.
[platforms=("chromeos", "lacros")]
namespace enterprise.remoteApps {
  callback VoidCallback = void ();
  callback StringCallback = void (DOMString result);

  // Options for $(ref:addFolder).
  // |name|: Name of the folder
  // |addToFront|: When true, the folder is added to the front of the launcher.
  //               Defaults to false.
  dictionary AddFolderOptions {
    DOMString name;
    boolean? addToFront;
  };

  // Options for $(ref:addApp).
  // |name|: Name of the app
  // |folderId|: The ID of the app's parent folder. Has to be an ID of a folder
  //             added by $(ref:addFolder). If undefined or empty, the app
  //             will be added to the top-level.
  // |iconUrl|: A URL pointing to an image which represents the app's icon. If
  //            undefined, the app's icon will be the default placeholder.
  // |addToFront|: When true, the app is added to the front of the launcher.
  //               Defaults to false.
  dictionary AddAppOptions {
    DOMString name;
    boolean? addToFront;
    DOMString? folderId;
    DOMString? iconUrl;
  };

  // Possible sort order positions for $(ref:sortLauncher).
  enum RemoteAppsPosition {
    // Before native apps, in alphabetical, case insensitive, order.
    REMOTE_APPS_FIRST
  };

  // Options for $(ref:sortLauncher).
  // |position|: Remote apps and folders sort order position.
  dictionary SortLauncherOptions {
    RemoteAppsPosition position;
  };

  interface Functions {
    // Adds a Remote Apps folder to the launcher. Empty folders are not shown
    // in the launcher.
    // |callback|: Called with the ID of the newly added folder.
    static void addFolder(
        AddFolderOptions options,
        optional StringCallback callback);

    // Adds a Remote App to the launcher.
    // |callback|: Called with the ID of the newly added app.
    static void addApp(
        AddAppOptions options,
        optional StringCallback callback);

    // Deletes a Remote App added by $(ref:addApp).
    static void deleteApp(
        DOMString appId,
        optional VoidCallback callback);

    // Sorts the Remote apps and folders according to the position specified in
    // the SortLauncherOptions.
    static void sortLauncher(
        SortLauncherOptions options,
        optional VoidCallback callback);

    // Set the list of apps to be pinned on the shelf. Any apps that are
    // currently pinned and not present in `appIds` will be unpinned. Can be
    // called with an empty list to unpin all the apps.
    [nodoc] static void setPinnedApps(
        DOMString[] appIds,
        optional VoidCallback callback);
  };

  interface Events {
    // Invoked when a remote app is launched. |appId| is the ID of the app
    // which was launched.
    static void onRemoteAppLaunched(DOMString appId);
  };
};