1 <html devsite> 2 <head> 3 <title>App Shortcuts</title> 4 <meta name="project_path" value="/_project.yaml" /> 5 <meta name="book_path" value="/_book.yaml" /> 6 </head> 7 <body> 8 <!-- 9 Copyright 2017 The Android Open Source Project 10 11 Licensed under the Apache License, Version 2.0 (the "License"); 12 you may not use this file except in compliance with the License. 13 You may obtain a copy of the License at 14 15 http://www.apache.org/licenses/LICENSE-2.0 16 17 Unless required by applicable law or agreed to in writing, software 18 distributed under the License is distributed on an "AS IS" BASIS, 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20 See the License for the specific language governing permissions and 21 limitations under the License. 22 --> 23 24 25 26 27 <p> 28 The Android 7.1.1 release allows developers to define action-specific 29 shortcuts in their apps that can be displayed in a launcher. These <a 30 href="https://developer.android.com/guide/topics/ui/shortcuts.html">app 31 shortcuts</a> let users quickly start common or recommended tasks within an 32 app. 33 </p> 34 35 <h2 id="overview">Overview</h2> 36 37 <p> 38 Each shortcut references an intent that launches a specific action in the app 39 when users select the shortcut. Examples of actions you can express as app 40 shortcuts include: 41 </p> 42 43 <ul> 44 <li>Navigating users to a particular location in a mapping app 45 <li>Sending messages to a friend in a communication app 46 <li>Playing the next episode of a TV show in a media app 47 <li>Loading the last save point in a gaming app</li></ul> 48 49 <h2 id="examples-and-source">Examples and source</h2> 50 51 <p> 52 You can find the primary implementation of this feature in the following files: 53 </p> 54 55 <pre class="devsite-click-to-copy"> 56 frameworks/base/services/core/java/com/android/server/policy/ShortcutManager.java 57 frameworks/base/services/core/java/com/android/server/pm/ShortcutPackage.java 58 frameworks/base/services/core/java/com/android/server/pm/ShortcutUser.java 59 frameworks/base/services/core/java/com/android/server/pm/ShortcutPackageInfo.java 60 frameworks/base/services/core/java/com/android/server/pm/ShortcutLauncher.java 61 frameworks/base/services/core/java/com/android/server/pm/ShortcutParser.java 62 frameworks/base/services/core/java/com/android/server/pm/ShortcutService.java 63 frameworks/base/services/core/java/com/android/server/pm/LauncherAppsService.java 64 frameworks/base/services/core/java/com/android/server/pm/ShortcutPackageItem.java 65 frameworks/base/core/java/com/android/server/backup/ShortcutBackupHelper.java 66 frameworks/base/core/java/android/content/pm/ShortcutManager.java 67 frameworks/base/core/java/android/content/pm/ShortcutServiceInternal.java 68 frameworks/base/core/java/android/content/pm/ShortcutInfo.java 69 frameworks/base/core/java/android/content/pm/LauncherApps.java 70 </pre> 71 72 <p> 73 With the following files providing supporting features (called hidden APIs in 74 <code>ShortcutManager.java</code>): 75 </p> 76 77 <pre class="devsite-click-to-copy"> 78 packages/apps/Settings/src/com/android/settings/DevelopmentSettings.java 79 frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/policy/RemoteInputView.java 80 </pre> 81 82 <p> 83 And, for an example, the Android Open Source Project Launcher version 3 supports 84 shortcuts: 85 </p> 86 87 <pre class="devsite-click-to-copy"> 88 packages/apps/Launcher3/ 89 </pre> 90 91 <p> 92 Finally, see the following files for public Javadoc. 93 </p> 94 95 <pre class="devsite-click-to-copy"> 96 frameworks/base/core/java/android/content/pm/ShortcutManager.java 97 frameworks/base/core/java/android/content/pm/ShortcutInfo.java 98 frameworks/base/core/java/android/content/pm/LauncherApps.java 99 </pre> 100 101 <h2 id="implementation">Implementation</h2> 102 103 <p> 104 The AOSP Launcher3 supports shortcuts already. In cases where a partner has its 105 own launcher, that launcher should support shortcuts too. 106 </p> 107 108 <ul> 109 <li>When the user performs a certain gesture (e.g. long press) on an app icon, 110 the launcher should show the dynamic and manifest shortcuts associated with each 111 launcher activity icon.<br> 112 The shortcut sort order is defined in the ShorctutManager Javadoc within 113 the "Shortcut Display Order" section. For example, show the manifest shortcuts 114 first, then the dynamic shortcuts. The shortcuts are sorted by rank in 115 ascending order within each group. 116 <li>The user should be able to drag each dynamic/manifest shortcut and "pin" it 117 to the home screen. 118 <li>Pinned shortcuts should be backed up and restored. (See ShortcutManager's 119 javadoc for details) 120 <li>Doing an "Inline reply" on Notification should internally call 121 ShortcutManager.onApplicationActive. 122 </ul> 123 124 <p> 125 In addition, some Google Mobile Services (GMS) apps have shortcuts. The OEM 126 launcher should show shortcuts for them and ideally support "<a 127 href="https://support.google.com/nexus/answer/6118421">pinning</a>" (or creating 128 a shortcut icon) too. 129 </p> 130 131 <p> 132 See the Launcher3 source for details on how to interact with the framework for 133 the above operations. 134 </p> 135 136 <h2 id="validation">Validation</h2> 137 138 <p> 139 Use the following Android Compatibility Test Suite (CTS) tests to ensure your 140 version of the feature (ShortcutManager and LauncherApps) works as intended: 141 </p> 142 143 <pre class="devsite-click-to-copy"> 144 cts/tests/tests/shortcutmanager/ 145 cts/hostsidetests/shortcuts/ 146 </pre> 147 148 <p> 149 And find the unit tests for the AOSP implementation here: 150 </p> 151 152 <pre class="devsite-click-to-copy"> 153 frameworks/base/services/tests/servicestests/ 154 </pre> 155 156 <p> 157 Which includes: 158 </p> 159 160 <pre class="devsite-click-to-copy"> 161 src/com/android/server/pm/ShortcutManagerTest*.java 162 </pre> 163 <p> 164 You may also employ the CTS Verifier test for shortcut manager: 165 </p> 166 167 <pre class="devsite-click-to-copy"> 168 cts/apps/CtsVerifier/src/com/android/cts/verifier/notifications/ShortcutThrottlingResetActivity.java 169 </pre> 170 171 </body> 172 </html> 173
