blob: b4c6138671be876f585b886007b1b3f9557501a9 [file] [log] [blame]
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -07001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16syntax = "proto2";
17
18option java_package = "com.android.launcher3.logger";
19option java_outer_classname = "LauncherAtom";
20
thiruramcbeb13d2021-01-27 14:45:58 -080021import "launcher_atom_extension.proto";
22
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070023//
24// ItemInfos
25message ItemInfo {
26 oneof Item {
27 Application application = 1;
thiruramacbd7ef2020-04-17 19:10:49 -070028 Task task = 2;
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070029 Shortcut shortcut = 3;
thiruramf81e8b02020-04-15 10:22:28 -070030 Widget widget = 4;
thiruram5a01f0e2020-05-04 17:49:37 -070031 FolderIcon folder_icon = 9;
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070032 }
33 // When used for launch event, stores the global predictive rank
34 optional int32 rank = 5;
35
36 // Stores whether the Item belows to non primary user
37 optional bool is_work = 6;
38
39 // Item can be child node to parent container or parent containers (nested)
thiruramacbd7ef2020-04-17 19:10:49 -070040 optional ContainerInfo container_info = 7;
41
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070042 // Stores the origin of the Item
Hyunyoung Song90c58732020-06-08 17:42:10 -070043 optional Attribute attribute = 8;
thiruramacbd7ef2020-04-17 19:10:49 -070044}
45
46// Represents various launcher surface where items are placed.
47message ContainerInfo {
48 oneof Container {
49 WorkspaceContainer workspace = 1;
50 HotseatContainer hotseat = 2;
51 FolderContainer folder = 3;
52 AllAppsContainer all_apps_container = 4;
thiruram6bf68482020-05-06 22:19:43 -070053 WidgetsContainer widgets_container = 5;
thiruram62c7b5c2020-05-19 09:31:38 -070054 PredictionContainer prediction_container = 6;
55 SearchResultContainer search_result_container = 7;
thiruram63bf8ee2020-06-01 12:03:19 -070056 ShortcutsContainer shortcuts_container = 8;
Hyunyoung Songf26c7932020-06-06 14:44:27 -070057 SettingsContainer settings_container = 9;
thiruram18c24952020-06-10 10:44:58 -070058 PredictedHotseatContainer predicted_hotseat_container = 10;
Hyunyoung Song13c2bc72020-06-10 00:35:35 -070059 TaskSwitcherContainer task_switcher_container = 11;
thiruramcbeb13d2021-01-27 14:45:58 -080060 ExtendedContainers extended_containers = 20;
thiruramacbd7ef2020-04-17 19:10:49 -070061 }
62}
63
thiruram62c7b5c2020-05-19 09:31:38 -070064// Represents the apps list sorted alphabetically inside the all-apps view.
thiruramacbd7ef2020-04-17 19:10:49 -070065message AllAppsContainer {
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070066}
67
thiruram6bf68482020-05-06 22:19:43 -070068message WidgetsContainer {
69}
70
thiruram62c7b5c2020-05-19 09:31:38 -070071// Represents the predicted apps row(top row) in the all-apps view.
72message PredictionContainer {
73}
74
75// Represents the apps container within search results.
76message SearchResultContainer {
thiruramdbd61d42020-06-22 16:30:58 -070077
78 // Length of search term.
79 optional int32 query_length = 1;
80
81 // Container from where search was invoked.
82 oneof ParentContainer {
83 WorkspaceContainer workspace = 2;
84 AllAppsContainer all_apps_container = 3;
85 }
thiruram62c7b5c2020-05-19 09:31:38 -070086}
87
thiruram63bf8ee2020-06-01 12:03:19 -070088// Container for package specific shortcuts to deep links and notifications.
89// Typically shown as popup window by longpressing on an icon.
90message ShortcutsContainer {
91}
92
Hyunyoung Songf26c7932020-06-06 14:44:27 -070093// Container for generic system shortcuts for launcher specific settings.
94// Typically shown up as popup window by longpressing on empty space on workspace.
95message SettingsContainer {
96}
97
Hyunyoung Song13c2bc72020-06-10 00:35:35 -070098message TaskSwitcherContainer {
99}
100
Hyunyoung Song90c58732020-06-08 17:42:10 -0700101enum Attribute {
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700102 UNKNOWN = 0;
103 DEFAULT_LAYOUT = 1; // icon automatically placed in workspace, folder, hotseat
104 BACKUP_RESTORE = 2; // icon layout restored from backup
105 PINITEM = 3; // from another app (e.g., Chrome's "Add to Home screen")
106 ALLAPPS_ATOZ = 4; // within launcher surface, all aps a-z
107 WIDGETS = 5; // within launcher, widgets tray
108 ADD_TO_HOMESCREEN = 6; // play install + launcher home setting
109 ALLAPPS_PREDICTION = 7; // from prediction bar in all apps container
110 HOTSEAT_PREDICTION = 8; // from prediction bar in hotseat container
thiruramec75cbd2020-06-19 20:10:58 -0700111
112 // Folder's label is one of the non-empty suggested values.
113 SUGGESTED_LABEL = 9;
114
115 // Folder's label is non-empty, manually entered by the user
116 // and different from any of suggested values.
117 MANUAL_LABEL = 10;
118
119 // Folder's label is not yet assigned( i.e., title == null).
120 // Eligible for auto-labeling.
121 UNLABELED = 11;
122
123 // Folder's label is empty(i.e., title == "").
124 // Not eligible for auto-labeling.
125 EMPTY_LABEL = 12;
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700126}
127
128// Main app icons
129message Application {
130 optional string package_name = 1;
131 optional string component_name = 2;
132}
133
134// Legacy shortcuts and shortcuts handled by ShortcutManager
135message Shortcut {
136 optional string shortcut_name = 1;
Sunny Goyal35376a352020-07-15 17:02:16 -0700137 optional string shortcut_id = 2;
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700138}
139
140// AppWidgets handled by AppWidgetManager
141message Widget {
thiruramacbd7ef2020-04-17 19:10:49 -0700142 optional int32 span_x = 1 [default = 1];
143 optional int32 span_y = 2 [default = 1];
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700144 optional int32 app_widget_id = 3;
145 optional string package_name = 4; // only populated during snapshot if from workspace
146 optional string component_name = 5; // only populated during snapshot if from workspace
147}
148
149// Tasks handled by PackageManager
150message Task {
151 optional string package_name = 1;
152 optional string component_name = 2;
153 optional int32 index = 3;
154}
155
thiruram5a01f0e2020-05-04 17:49:37 -0700156// Represents folder in a closed state.
157message FolderIcon {
thiruram6524cc72020-05-08 11:04:32 -0700158 // Number of items inside folder.
thiruram5a01f0e2020-05-04 17:49:37 -0700159 optional int32 cardinality = 1;
thiruram6524cc72020-05-08 11:04:32 -0700160
161 // State of the folder label before the event.
thiruramf95f1522020-05-08 17:53:19 -0700162 optional FromState from_label_state = 2;
thiruram6524cc72020-05-08 11:04:32 -0700163
164 // State of the folder label after the event.
thiruramf95f1522020-05-08 17:53:19 -0700165 optional ToState to_label_state = 3;
thiruram6524cc72020-05-08 11:04:32 -0700166
thiruramf95f1522020-05-08 17:53:19 -0700167 // Details about actual folder label.
168 // Populated when folder label is not a PII.
169 optional string label_info = 4;
thiruram5a01f0e2020-05-04 17:49:37 -0700170}
171
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700172//////////////////////////////////////////////
173// Containers
174
175message WorkspaceContainer {
thiruramacbd7ef2020-04-17 19:10:49 -0700176 optional int32 page_index = 1 [default = -2]; // range [-1, l], 0 is the index of the main homescreen
177 optional int32 grid_x = 2 [default = -1]; // [0, m], m varies based on the display density and resolution
178 optional int32 grid_y = 3 [default = -1]; // [0, n], n varies based on the display density and resolution
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700179}
180
181message HotseatContainer {
182 optional int32 index = 1;
183}
184
thiruram18c24952020-06-10 10:44:58 -0700185// Represents hotseat container with prediction feature enabled.
186message PredictedHotseatContainer {
187 optional int32 index = 1;
188
189 // No of hotseat positions filled with predicted items.
190 optional int32 cardinality = 2;
191}
192
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700193message FolderContainer {
thiruramacbd7ef2020-04-17 19:10:49 -0700194 optional int32 page_index = 1 [default = -1];
195 optional int32 grid_x = 2 [default = -1];
196 optional int32 grid_y = 3 [default = -1];
197 oneof ParentContainer {
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700198 WorkspaceContainer workspace = 4;
199 HotseatContainer hotseat = 5;
200 }
201}
thiruram6524cc72020-05-08 11:04:32 -0700202
thiruramf95f1522020-05-08 17:53:19 -0700203// Represents state of EditText field before update.
thiruram6524cc72020-05-08 11:04:32 -0700204enum FromState {
205 // Default value.
thiruramf95f1522020-05-08 17:53:19 -0700206 // Used when a FromState is not applicable, for example, during folder creation.
thiruram6524cc72020-05-08 11:04:32 -0700207 FROM_STATE_UNSPECIFIED = 0;
208
thiruramf95f1522020-05-08 17:53:19 -0700209 // EditText was empty.
210 // Eg: When a folder label is updated from empty string.
thiruram6524cc72020-05-08 11:04:32 -0700211 FROM_EMPTY = 1;
212
thiruramf95f1522020-05-08 17:53:19 -0700213 // EditText was non-empty and manually entered by the user.
214 // Eg: When a folder label is updated from a user-entered value.
thiruram6524cc72020-05-08 11:04:32 -0700215 FROM_CUSTOM = 2;
216
thiruramf95f1522020-05-08 17:53:19 -0700217 // EditText was non-empty and one of the suggestions.
218 // Eg: When a folder label is updated from a suggested value.
thiruram6524cc72020-05-08 11:04:32 -0700219 FROM_SUGGESTED = 3;
220}
221
thiruramf95f1522020-05-08 17:53:19 -0700222// Represents state of EditText field after update.
thiruram6524cc72020-05-08 11:04:32 -0700223enum ToState {
224 // Default value.
thiruramf95f1522020-05-08 17:53:19 -0700225 // Used when ToState is not applicable, for example, when folder label is updated to a different
226 // value when folder label suggestion feature is disabled.
thiruram6524cc72020-05-08 11:04:32 -0700227 TO_STATE_UNSPECIFIED = 0;
thiruramf95f1522020-05-08 17:53:19 -0700228
229 // User attempted to change the EditText, but was not changed.
thiruram6524cc72020-05-08 11:04:32 -0700230 UNCHANGED = 1;
231
232 // New label matches with primary(aka top) suggestion.
233 TO_SUGGESTION0 = 2;
234
thiruramf95f1522020-05-08 17:53:19 -0700235 // New value matches with second top suggestion even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700236 TO_SUGGESTION1_WITH_VALID_PRIMARY = 3;
237
thiruramf95f1522020-05-08 17:53:19 -0700238 // New value matches with second top suggestion given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700239 TO_SUGGESTION1_WITH_EMPTY_PRIMARY = 4;
240
thiruramf95f1522020-05-08 17:53:19 -0700241 // New value matches with third top suggestion even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700242 TO_SUGGESTION2_WITH_VALID_PRIMARY = 5;
243
thiruramf95f1522020-05-08 17:53:19 -0700244 // New value matches with third top suggestion given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700245 TO_SUGGESTION2_WITH_EMPTY_PRIMARY = 6;
246
thiruramf95f1522020-05-08 17:53:19 -0700247 // New value matches with 4th top suggestion even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700248 TO_SUGGESTION3_WITH_VALID_PRIMARY = 7;
249
thiruramf95f1522020-05-08 17:53:19 -0700250 // New value matches with 4th top suggestion given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700251 TO_SUGGESTION3_WITH_EMPTY_PRIMARY = 8;
252
thiruramf95f1522020-05-08 17:53:19 -0700253 // New value is empty even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700254 TO_EMPTY_WITH_VALID_PRIMARY = 9;
255
thiruramf95f1522020-05-08 17:53:19 -0700256 // New value is empty given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700257 TO_EMPTY_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 10;
258
thiruramf95f1522020-05-08 17:53:19 -0700259 // New value is empty given that no suggestions were provided.
thiruram6524cc72020-05-08 11:04:32 -0700260 TO_EMPTY_WITH_EMPTY_SUGGESTIONS = 11;
261
thiruramf95f1522020-05-08 17:53:19 -0700262 // New value is empty given that suggestions feature was disabled.
thiruram6524cc72020-05-08 11:04:32 -0700263 TO_EMPTY_WITH_SUGGESTIONS_DISABLED = 12;
264
thiruramf95f1522020-05-08 17:53:19 -0700265 // New value is non-empty and does not match with any of the suggestions even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700266 TO_CUSTOM_WITH_VALID_PRIMARY = 13;
267
thiruramf95f1522020-05-08 17:53:19 -0700268 // New value is non-empty and not match with any suggestions given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700269 TO_CUSTOM_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 14;
270
thiruramf95f1522020-05-08 17:53:19 -0700271 // New value is non-empty and also no suggestions were provided.
thiruram6524cc72020-05-08 11:04:32 -0700272 TO_CUSTOM_WITH_EMPTY_SUGGESTIONS = 15;
273
thiruramf95f1522020-05-08 17:53:19 -0700274 // New value is non-empty and also suggestions feature was disable.
thiruram6524cc72020-05-08 11:04:32 -0700275 TO_CUSTOM_WITH_SUGGESTIONS_DISABLED = 16;
276}