Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Represents the apps list sorted alphabetically inside the all-apps view.

Used in: ContainerInfo, SearchResultContainer

(message has no fields)

Main app icons

Used in: ItemInfo

• optional string package_name = 1

• optional string component_name = 2

Used in: ItemInfo

• UNKNOWN = 0

• DEFAULT_LAYOUT = 1

  icon automatically placed in workspace, folder, hotseat

• BACKUP_RESTORE = 2

  icon layout restored from backup

• PINITEM = 3

  from another app (e.g., Chrome's "Add to Home screen")

• ALLAPPS_ATOZ = 4

  within launcher surface, all aps a-z

• WIDGETS = 5

  within launcher, widgets tray

• ADD_TO_HOMESCREEN = 6

  play install + launcher home setting

• ALLAPPS_PREDICTION = 7

  from prediction bar in all apps container

• HOTSEAT_PREDICTION = 8

  from prediction bar in hotseat container

• SUGGESTED_LABEL = 9

  Folder's label is one of the non-empty suggested values.

• MANUAL_LABEL = 10

  Folder's label is non-empty, manually entered by the user and different from any of suggested values.

• UNLABELED = 11

  Folder's label is not yet assigned( i.e., title == null). Eligible for auto-labeling.

• EMPTY_LABEL = 12

  Folder's label is empty(i.e., title == ""). Not eligible for auto-labeling.

Represents various launcher surface where items are placed.

Used in: ItemInfo

• oneof Container

  • WorkspaceContainer workspace = 1

  • HotseatContainer hotseat = 2

  • FolderContainer folder = 3

  • AllAppsContainer all_apps_container = 4

  • WidgetsContainer widgets_container = 5

  • PredictionContainer prediction_container = 6

  • SearchResultContainer search_result_container = 7

  • ShortcutsContainer shortcuts_container = 8

  • SettingsContainer settings_container = 9

  • PredictedHotseatContainer predicted_hotseat_container = 10

  • TaskSwitcherContainer task_switcher_container = 11

  • TaskForegroundContainer task_foreground_container = 12

Used in: ContainerInfo

• optional int32 page_index = 1

• optional int32 grid_x = 2

• optional int32 grid_y = 3

• oneof ParentContainer

  • WorkspaceContainer workspace = 4

  • HotseatContainer hotseat = 5

Represents folder in a closed state.

Used in: ItemInfo

• optional int32 cardinality = 1

  Number of items inside folder.

• optional FromState from_label_state = 2

  State of the folder label before the event.

• optional ToState to_label_state = 3

  State of the folder label after the event.

• optional string label_info = 4

  Details about actual folder label. Populated when folder label is not a PII.

Represents state of EditText field before update.

Used in: FolderIcon

• FROM_STATE_UNSPECIFIED = 0

  Default value. Used when a FromState is not applicable, for example, during folder creation.

• FROM_EMPTY = 1

  EditText was empty. Eg: When a folder label is updated from empty string.

• FROM_CUSTOM = 2

  EditText was non-empty and manually entered by the user. Eg: When a folder label is updated from a user-entered value.

• FROM_SUGGESTED = 3

  EditText was non-empty and one of the suggestions. Eg: When a folder label is updated from a suggested value.

Used in: ContainerInfo, FolderContainer

• optional int32 index = 1

ItemInfos

• oneof Item

  • Application application = 1

  • Task task = 2

  • Shortcut shortcut = 3

  • Widget widget = 4

  • FolderIcon folder_icon = 9

• optional int32 rank = 5

  When used for launch event, stores the global predictive rank

• optional bool is_work = 6

  Stores whether the Item belows to non primary user

• optional ContainerInfo container_info = 7

  Item can be child node to parent container or parent containers (nested)

• optional Attribute attribute = 8

  Stores the origin of the Item

Represents hotseat container with prediction feature enabled.

Used in: ContainerInfo

• optional int32 index = 1

• optional int32 cardinality = 2

  No of hotseat positions filled with predicted items.

Represents the predicted apps row(top row) in the all-apps view.

Used in: ContainerInfo

(message has no fields)

Represents the apps container within search results.

Used in: ContainerInfo

• optional int32 query_length = 1

  Length of search term.

• oneof ParentContainer

  Container from where search was invoked.

  • WorkspaceContainer workspace = 2

  • AllAppsContainer all_apps_container = 3

Container for generic system shortcuts for launcher specific settings. Typically shown up as popup window by longpressing on empty space on workspace.

Used in: ContainerInfo

(message has no fields)

Legacy shortcuts and shortcuts handled by ShortcutManager

Used in: ItemInfo

• optional string shortcut_name = 1

Container for package specific shortcuts to deep links and notifications. Typically shown as popup window by longpressing on an icon.

Used in: ContainerInfo

(message has no fields)

Tasks handled by PackageManager

Used in: ItemInfo

• optional string package_name = 1

• optional string component_name = 2

• optional int32 index = 3

Container for tasks from another foreground app, when not on launcher screen. Typically home gesture or overview gesture can be triggered from this container.

Used in: ContainerInfo

(message has no fields)

Container for tasks in the Overview UI. Typically entered using either the overview gesture or overview button.

Used in: ContainerInfo

(message has no fields)

Represents state of EditText field after update.

Used in: FolderIcon

• TO_STATE_UNSPECIFIED = 0

  Default value. Used when ToState is not applicable, for example, when folder label is updated to a different value when folder label suggestion feature is disabled.

• UNCHANGED = 1

  User attempted to change the EditText, but was not changed.

• TO_SUGGESTION0 = 2

  New label matches with primary(aka top) suggestion.

• TO_SUGGESTION1_WITH_VALID_PRIMARY = 3

  New value matches with second top suggestion even though the top suggestion was non-empty.

• TO_SUGGESTION1_WITH_EMPTY_PRIMARY = 4

  New value matches with second top suggestion given that top suggestion was empty.

• TO_SUGGESTION2_WITH_VALID_PRIMARY = 5

  New value matches with third top suggestion even though the top suggestion was non-empty.

• TO_SUGGESTION2_WITH_EMPTY_PRIMARY = 6

  New value matches with third top suggestion given that top suggestion was empty.

• TO_SUGGESTION3_WITH_VALID_PRIMARY = 7

  New value matches with 4th top suggestion even though the top suggestion was non-empty.

• TO_SUGGESTION3_WITH_EMPTY_PRIMARY = 8

  New value matches with 4th top suggestion given that top suggestion was empty.

• TO_EMPTY_WITH_VALID_PRIMARY = 9

  New value is empty even though the top suggestion was non-empty.

• TO_EMPTY_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 10

  New value is empty given that top suggestion was empty.

• TO_EMPTY_WITH_EMPTY_SUGGESTIONS = 11

  New value is empty given that no suggestions were provided.

• TO_EMPTY_WITH_SUGGESTIONS_DISABLED = 12

  New value is empty given that suggestions feature was disabled.

• TO_CUSTOM_WITH_VALID_PRIMARY = 13

  New value is non-empty and does not match with any of the suggestions even though the top suggestion was non-empty.

• TO_CUSTOM_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 14

  New value is non-empty and not match with any suggestions given that top suggestion was empty.

• TO_CUSTOM_WITH_EMPTY_SUGGESTIONS = 15

  New value is non-empty and also no suggestions were provided.

• TO_CUSTOM_WITH_SUGGESTIONS_DISABLED = 16

  New value is non-empty and also suggestions feature was disable.

AppWidgets handled by AppWidgetManager

Used in: ItemInfo

• optional int32 span_x = 1

• optional int32 span_y = 2

• optional int32 app_widget_id = 3

• optional string package_name = 4

  only populated during snapshot if from workspace

• optional string component_name = 5

  only populated during snapshot if from workspace

Used in: ContainerInfo

(message has no fields)

Used in: ContainerInfo, FolderContainer, SearchResultContainer

• optional int32 page_index = 1

  range [-1, l], 0 is the index of the main homescreen

• optional int32 grid_x = 2

  [0, m], m varies based on the display density and resolution

• optional int32 grid_y = 3

  [0, n], n varies based on the display density and resolution