1/* 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 21import "launcher_atom_extension.proto"; 22 23// 24// ItemInfos 25message ItemInfo { 26 oneof Item { 27 Application application = 1; 28 Task task = 2; 29 Shortcut shortcut = 3; 30 Widget widget = 4; 31 FolderIcon folder_icon = 9; 32 Slice slice = 10; 33 SearchActionItem search_action_item = 11; 34 } 35 // When used for launch event, stores the global predictive rank 36 optional int32 rank = 5; 37 38 // Stores whether the Item belows to non primary user 39 optional bool is_work = 6; 40 41 // Item can be child node to parent container or parent containers (nested) 42 optional ContainerInfo container_info = 7; 43 44 // Stores the origin of the Item 45 optional Attribute attribute = 8; 46} 47 48// Represents various launcher surface where items are placed. 49message ContainerInfo { 50 oneof Container { 51 WorkspaceContainer workspace = 1; 52 HotseatContainer hotseat = 2; 53 FolderContainer folder = 3; 54 AllAppsContainer all_apps_container = 4; 55 WidgetsContainer widgets_container = 5; 56 PredictionContainer prediction_container = 6; 57 SearchResultContainer search_result_container = 7; 58 ShortcutsContainer shortcuts_container = 8; 59 SettingsContainer settings_container = 9; 60 PredictedHotseatContainer predicted_hotseat_container = 10; 61 TaskSwitcherContainer task_switcher_container = 11; 62 ExtendedContainers extended_containers = 20; 63 } 64} 65 66// Represents the apps list sorted alphabetically inside the all-apps view. 67message AllAppsContainer { 68} 69 70message WidgetsContainer { 71} 72 73// Represents the predicted apps row(top row) in the all-apps view. 74message PredictionContainer { 75} 76 77// Represents the apps container within search results. 78message SearchResultContainer { 79 80 // Length of search term. 81 optional int32 query_length = 1; 82 83 // Container from where search was invoked. 84 oneof ParentContainer { 85 WorkspaceContainer workspace = 2; 86 AllAppsContainer all_apps_container = 3; 87 } 88} 89 90// Container for package specific shortcuts to deep links and notifications. 91// Typically shown as popup window by longpressing on an icon. 92message ShortcutsContainer { 93} 94 95// Container for generic system shortcuts for launcher specific settings. 96// Typically shown up as popup window by longpressing on empty space on workspace. 97message SettingsContainer { 98} 99 100message TaskSwitcherContainer { 101} 102 103enum Attribute { 104 UNKNOWN = 0; 105 DEFAULT_LAYOUT = 1; // icon automatically placed in workspace, folder, hotseat 106 BACKUP_RESTORE = 2; // icon layout restored from backup 107 PINITEM = 3; // from another app (e.g., Chrome's "Add to Home screen") 108 ALLAPPS_ATOZ = 4; // within launcher surface, all aps a-z 109 WIDGETS = 5; // within launcher, widgets tray 110 ADD_TO_HOMESCREEN = 6; // play install + launcher home setting 111 ALLAPPS_PREDICTION = 7; // from prediction bar in all apps container 112 HOTSEAT_PREDICTION = 8; // from prediction bar in hotseat container 113 114 // Folder's label is one of the non-empty suggested values. 115 SUGGESTED_LABEL = 9; 116 117 // Folder's label is non-empty, manually entered by the user 118 // and different from any of suggested values. 119 MANUAL_LABEL = 10; 120 121 // Folder's label is not yet assigned( i.e., title == null). 122 // Eligible for auto-labeling. 123 UNLABELED = 11; 124 125 // Folder's label is empty(i.e., title == ""). 126 // Not eligible for auto-labeling. 127 EMPTY_LABEL = 12; 128 129 ALL_APPS_SEARCH_RESULT_APPLICATION = 13; 130 ALL_APPS_SEARCH_RESULT_SHORTCUT = 14; 131 ALL_APPS_SEARCH_RESULT_PEOPLE = 15; 132 ALL_APPS_SEARCH_RESULT_ACTION = 16; 133 ALL_APPS_SEARCH_RESULT_SETTING = 17; 134 ALL_APPS_SEARCH_RESULT_SCREENSHOT = 18; 135 ALL_APPS_SEARCH_RESULT_SLICE = 19; 136 ALL_APPS_SEARCH_RESULT_WIDGETS = 20; 137 ALL_APPS_SEARCH_RESULT_PLAY = 21; 138 ALL_APPS_SEARCH_RESULT_SUGGEST = 22; 139 ALL_APPS_SEARCH_RESULT_ASSISTANT = 23; 140 ALL_APPS_SEARCH_RESULT_CHROMETAB = 24; 141 ALL_APPS_SEARCH_RESULT_NAVVYSITE = 25; 142 ALL_APPS_SEARCH_RESULT_TIPS = 26; 143 ALL_APPS_SEARCH_RESULT_PEOPLE_TILE = 27; 144 145 WIDGETS_BOTTOM_TRAY = 28; 146 WIDGETS_TRAY_PREDICTION = 29; 147} 148 149// Main app icons 150message Application { 151 optional string package_name = 1; 152 optional string component_name = 2; 153} 154 155// Legacy shortcuts and shortcuts handled by ShortcutManager 156message Shortcut { 157 optional string shortcut_name = 1; 158 optional string shortcut_id = 2; 159} 160 161// AppWidgets handled by AppWidgetManager 162message Widget { 163 optional int32 span_x = 1 [default = 1]; 164 optional int32 span_y = 2 [default = 1]; 165 optional int32 app_widget_id = 3; 166 optional string package_name = 4; // only populated during snapshot if from workspace 167 optional string component_name = 5; // only populated during snapshot if from workspace 168 optional int32 widget_features = 6; 169} 170 171// Tasks handled by PackageManager 172message Task { 173 optional string package_name = 1; 174 optional string component_name = 2; 175 optional int32 index = 3; 176} 177 178// Represents folder in a closed state. 179message FolderIcon { 180 // Number of items inside folder. 181 optional int32 cardinality = 1; 182 183 // State of the folder label before the event. 184 optional FromState from_label_state = 2; 185 186 // State of the folder label after the event. 187 optional ToState to_label_state = 3; 188 189 // Details about actual folder label. 190 // Populated when folder label is not a PII. 191 optional string label_info = 4; 192} 193 194// Contains Slice details for logging. 195message Slice{ 196 optional string uri = 1; 197} 198 199// Represents SearchAction with in launcher 200message SearchActionItem{ 201 optional string package_name = 1; 202 optional string title = 2; 203} 204 205////////////////////////////////////////////// 206// Containers 207 208message WorkspaceContainer { 209 optional int32 page_index = 1 [default = -2]; // range [-1, l], 0 is the index of the main homescreen 210 optional int32 grid_x = 2 [default = -1]; // [0, m], m varies based on the display density and resolution 211 optional int32 grid_y = 3 [default = -1]; // [0, n], n varies based on the display density and resolution 212} 213 214message HotseatContainer { 215 optional int32 index = 1; 216} 217 218// Represents hotseat container with prediction feature enabled. 219message PredictedHotseatContainer { 220 optional int32 index = 1; 221 222 // No of hotseat positions filled with predicted items. 223 optional int32 cardinality = 2; 224} 225 226message FolderContainer { 227 optional int32 page_index = 1 [default = -1]; 228 optional int32 grid_x = 2 [default = -1]; 229 optional int32 grid_y = 3 [default = -1]; 230 oneof ParentContainer { 231 WorkspaceContainer workspace = 4; 232 HotseatContainer hotseat = 5; 233 } 234} 235 236// Represents state of EditText field before update. 237enum FromState { 238 // Default value. 239 // Used when a FromState is not applicable, for example, during folder creation. 240 FROM_STATE_UNSPECIFIED = 0; 241 242 // EditText was empty. 243 // Eg: When a folder label is updated from empty string. 244 FROM_EMPTY = 1; 245 246 // EditText was non-empty and manually entered by the user. 247 // Eg: When a folder label is updated from a user-entered value. 248 FROM_CUSTOM = 2; 249 250 // EditText was non-empty and one of the suggestions. 251 // Eg: When a folder label is updated from a suggested value. 252 FROM_SUGGESTED = 3; 253} 254 255// Represents state of EditText field after update. 256enum ToState { 257 // Default value. 258 // Used when ToState is not applicable, for example, when folder label is updated to a different 259 // value when folder label suggestion feature is disabled. 260 TO_STATE_UNSPECIFIED = 0; 261 262 // User attempted to change the EditText, but was not changed. 263 UNCHANGED = 1; 264 265 // New label matches with primary(aka top) suggestion. 266 TO_SUGGESTION0 = 2; 267 268 // New value matches with second top suggestion even though the top suggestion was non-empty. 269 TO_SUGGESTION1_WITH_VALID_PRIMARY = 3; 270 271 // New value matches with second top suggestion given that top suggestion was empty. 272 TO_SUGGESTION1_WITH_EMPTY_PRIMARY = 4; 273 274 // New value matches with third top suggestion even though the top suggestion was non-empty. 275 TO_SUGGESTION2_WITH_VALID_PRIMARY = 5; 276 277 // New value matches with third top suggestion given that top suggestion was empty. 278 TO_SUGGESTION2_WITH_EMPTY_PRIMARY = 6; 279 280 // New value matches with 4th top suggestion even though the top suggestion was non-empty. 281 TO_SUGGESTION3_WITH_VALID_PRIMARY = 7; 282 283 // New value matches with 4th top suggestion given that top suggestion was empty. 284 TO_SUGGESTION3_WITH_EMPTY_PRIMARY = 8; 285 286 // New value is empty even though the top suggestion was non-empty. 287 TO_EMPTY_WITH_VALID_PRIMARY = 9; 288 289 // New value is empty given that top suggestion was empty. 290 TO_EMPTY_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 10; 291 292 // New value is empty given that no suggestions were provided. 293 TO_EMPTY_WITH_EMPTY_SUGGESTIONS = 11; 294 295 // New value is empty given that suggestions feature was disabled. 296 TO_EMPTY_WITH_SUGGESTIONS_DISABLED = 12; 297 298 // New value is non-empty and does not match with any of the suggestions even though the top suggestion was non-empty. 299 TO_CUSTOM_WITH_VALID_PRIMARY = 13; 300 301 // New value is non-empty and not match with any suggestions given that top suggestion was empty. 302 TO_CUSTOM_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 14; 303 304 // New value is non-empty and also no suggestions were provided. 305 TO_CUSTOM_WITH_EMPTY_SUGGESTIONS = 15; 306 307 // New value is non-empty and also suggestions feature was disable. 308 TO_CUSTOM_WITH_SUGGESTIONS_DISABLED = 16; 309} 310