File: enterprise_remote_apps.idl

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (87 lines) | stat: -rw-r--r-- 3,058 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// 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")]
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);
  };
};