diff options
Diffstat (limited to 'docs/html/preview')
32 files changed, 4199 insertions, 451 deletions
diff --git a/docs/html/preview/api-changes.jd b/docs/html/preview/api-changes.jd new file mode 100644 index 0000000..8ea91dd --- /dev/null +++ b/docs/html/preview/api-changes.jd @@ -0,0 +1,338 @@ +page.title=Behavior Changes +page.keywords=preview,sdk,compatibility +page.tags=previewresources, androidm +@jd:body + +<div id="qv-wrapper"> +<div id="qv"> + +<h2>In this document</h2> + +<ol id="toc44" class="hide-nested"> + <li><a href="#behavior-runtime-permissions">Runtime Permissions</a></li> + <li><a href="#behavior-notifications">Notifications</a></li> + <li><a href="#behavior-openssl">OpenSSL</a></li> + <li><a href="#behavior-project-volta">Project Volta</a> + <ol> + <li><a href="#behavior-doze">Doze Mode</a></li> + <li><a href="#behavior-app-standby">App Standby Mode</a></li> + </ol> + </li> + <li><a href="#behavior-adoptable-storage">Adoptable Storage Devices</a></li> + <li><a href="#behavior-apache-http-client">Apache HTTP Client Removal</a></li> + <li><a href="#behavior-audiomanager-Changes">AudioManager Changes</a></li> + <li><a href="#behavior-test-selection">Text Selection</a></li> + <li><a href="#behavior-keystore">Android Keystore Changes</a></li> + <li><a href="#behavior-themeable-colorstatelists">Themeable ColorStateLists</a></li> + <li><a href="#night-mode">Night Mode</a></li> + <li><a href="#behavior-art-runtime">ART Runtime</a></li> + <li><a href="#behavior-afw">Android for Work Changes</a></li> +</ol> + +<h2>API Differences</h2> +<ol> +<li><a href="">API level 22 to M »</a> </li> +</ol> + + +<h2>See Also</h2> +<ol> +<li><a href="{@docRoot}preview/api-overview.html">M Developer Preview API Overview</a> </li> +</ol> + +</div> +</div> + +<p>API Level: M</p> +<p>Along with new features and capabilities, M includes a variety of +system changes and API behavior changes. This document highlights +some of the key changes that you should be understand and account for in your apps.</p> + +<p>If you have previously published an app for Android, be aware that your app + might be affected by these changes in M.</p> + +<h2 id="behavior-runtime-permissions">Runtime Permissions</h1> +<p>This release introduces a new runtime permissions model, where users can now directly manage +their app permissions at runtime. This model gives users improved visibility and control over +permissions, while streamlining the installation and auto-update processes for app developers. +Users can set permissions on or off for all apps running on Android M. However, apps that don’t +target M cannot request permissions at runtime.</p> + +<p>On your apps that target M, make sure to check and request for permissions at +runtime. To determine if your app has been granted a permission, call the +new {@code Context.checkSelfPermission()} method. To request for a permission, call the new +{@code Activity.requestPermission()} method.</p> + +<p>For more information on supporting the new permissions model in your app, see the +<a href="{@docRoot}preview/features/runtime-permissions.html"> +Android M Runtime Permissions guide</a>.</p> + +<h2 id="behavior-openssl">OpenSSL</h2> +<p>Android is moving away from OpenSSL to the +<a href="https://boringssl.googlesource.com/boringssl/" class="external-link">BoringSSL</a> +library. If you’re using the Android NDK in your app, don't link against cryptographic libraries +that are not a part of the NDK API, such as {@code libcrypto.so} and {@code libssl.so}. These +libraries are not public APIs, and may change or break without notice across releases and devices. +In addition, you may expose yourself to security vulnerabilities. Instead, modify your +native code to call the Java cryptography APIs via JNI or to statically link against a +cryptography library of your choice.</p> + +<h2 id="behavior-project-volta">Project Volta</h2> +<p>This release introduces new power-saving optimizations for idle devices and apps.</p> + +<h3 id="behavior-doze">Doze mode</h3> +<p>If a device is unplugged and not used for up to an hour, it goes into <em>doze</em> mode where +it attempts to keep the system in a sleep state. In this mode, devices may briefly resume normal +operations for up to 5 minutes every few hours so that app syncing can occur and the system can +perform any pending operations.</p> + +<p>The following restrictions apply to your apps while in device doze mode:</p> +<ul> +<li>Network access is disabled</li> +<li>Alarms scheduled with the {@link android.app.AlarmManager} class are disabled, except for +alarms that you've set with the +{@link android.app.AlarmManager#setAlarmClock(android.app.AlarmManager.AlarmClockInfo,android.app.PendingIntent) setAlarmClock()} +method</li> +<li>WiFi scans are not performed</li> +<li>Syncs and jobs for your sync adapters and {@link android.app.job.JobScheduler} are not +permitted to run</li> +</ul> +</p> +<p>When the system comes out of doze mode, it executes jobs and syncs that are pending.</p> + +<h3 id="behavior-app-standby">App standby mode</h3> +<p>In M, the system may determine that apps are idle when they are not in active use by the user. +Your app goes into <em>app standby</em> mode after two days unless the system detects any of these +signals:</p> + +<ul> +<li>The app has a process currently in the foreground (either as an activity or foreground service, +or in use by another activity or foreground service)</li> +<li>The app generates a notification that the user can see</li> +<li>The user explicitly asks for the app to remain running</li> +</ul> + +<p>If the system is running on battery power, apps that are in standby mode will have their +network access disabled and their syncs and jobs suspended. When the system is plugged into a power +supply, it brings an app out of standby mode and executes any jobs and syncs that are pending.</p> + +<p>Apps that use <a href="{@docRoot}google/gcm/index.html">Google Cloud Messaging</a> will +continue to receive messages even if they are idle. When the system is plugged into a power +supply, apps resume normal operations and can run any pending syncs and jobs.</p> + +<p>You can test this feature by connecting a device running M to your development machine and +calling the following commands: +</p> +<pre> +$ adb shell am broadcast -a android.os.action.DISCHARGING +$ adb shell am set-idle <packageName> true +$ adb shell am set-idle <packageName> false +$ adb shell am get-idle <packageName> +</pre> + +<h2 id="behavior-adoptable-storage">Adoptable Storage Devices</h2> +<p> +In M, users can adopt external storage devices such as SD cards. Adopting an external storage +device encrypts and formats the device to behave like internal storage. This feature allows users +to move both apps and private data of those apps between storage devices. When moving apps, the +system respects the <a href="{@docRoot}guide/topics/manifest/manifest-element.html#install"> +{@code android:installLocation}</a> preference in the manifest.</p> + +<p>If your app accesses the following APIs or fields, be aware that the file paths they return +will dynamically change when the app is moved between internal and external storage devices. +When building file paths, it is strongly recommended that you always call these APIs dynamically. +Don’t use hardcoded file paths or persist fully-qualified file paths that were built previously.</p> + +<ul> +<li>{@link android.content.Context} methods: + <ul> + <li>{@link android.content.Context#getFilesDir() getFilesDir()}</li> + <li>{@link android.content.Context#getCacheDir() getCacheDir()}</li> + <li>{@link android.content.Context#getCodeCacheDir() getCodeCacheDir()}</li> + <li>{@link android.content.Context#getDatabasePath(java.lang.String) getDatabasePath()}</li> + <li>{@link android.content.Context#getDir(java.lang.String,int) getDir()}</li> + <li>{@link android.content.Context#getNoBackupFilesDir() getNoBackupFilesDir()}</li> + <li>{@link android.content.Context#getFileStreamPath(java.lang.String) getFileStreamPath()}</li> + <li>{@link android.content.Context#getPackageCodePath() getPackageCodePath()}</li> + <li>{@link android.content.Context#getPackageResourcePath() getPackageResourcePath()}</li> + </ul> +</li> +<li>{@link android.content.pm.ApplicationInfo} fields: + <ul> + <li>{@link android.content.pm.ApplicationInfo#dataDir dataDir}</li> + <li>{@link android.content.pm.ApplicationInfo#sourceDir sourceDir}</li> + <li>{@link android.content.pm.ApplicationInfo#nativeLibraryDir nativeLibraryDir}</li> + <li>{@link android.content.pm.ApplicationInfo#publicSourceDir publicSourceDir}</li> + <li>{@link android.content.pm.ApplicationInfo#splitSourceDirs splitSourceDirs}</li> + <li>{@link android.content.pm.ApplicationInfo#splitPublicSourceDirs splitPublicSourceDirs}</li> + </ul> +</li> +</ul> + +<p>To debug this feature in the developer preview, you can enable adoption of a USB drive that is +connected to an Android device through a USB On-The-Go (OTG) cable, by running these +commands:</p> + +<pre> +$ adb root +$ sleep 2 +$ adb shell setprop persist.fw.force_adoptable 1 +$ adb reboot +</pre> + +<h2 id="behavior-apache-http-client">Apache HTTP Client Removal</h2> +<p>This release removes support for the Apache HTTP client. If your app is using this client and +targets Android 2.3 (API level 9) or higher, use the {@link java.net.HttpURLConnection} class +instead. This API is more efficient because it reduces network use through transparent compression +and response caching, and minimizes power consumption. To continue using the Apache HTTP APIs, you +must first declare the following compile-time dependency in your {@code build.gradle} file: +</p> +<pre> +android { + compileSdkVersion M + useLibrary 'org.apache.http.legacy' +} +</pre> + +<h2 id="behavior-audiomanager-Changes">AudioManager Changes</h2> +<p>Setting the volume directly or muting specific streams via the {@link android.media.AudioManager} +class is no longer supported. The {@link android.media.AudioManager#setStreamSolo(int,boolean) +setStreamSolo()} method is deprecated, and you should call the +{@code AudioManager.requestAudioFocus()} method instead. Similarly, the +{@link android.media.AudioManager#setStreamMute(int,boolean) setStreamMute()} method is +deprecated; instead, call the {@code AudioManager.adjustStreamVolume()} method +and pass in the direction value {@code ADJUST_MUTE} or {@code ADJUST_UNMUTE}.</p> + +<h2 id="behavior-test-selection">Text Selection</h2> + +<img src="{@docRoot}preview/images/text-selection.gif" +style="float:right; margin:0 0 20px 30px" width="270" height="480" /> + +<p>When users selects text in your app, you can now display text selection actions such as +<em>Cut</em>, <em>Copy</em>, and <em>Paste</em> in a +<a href="http://www.google.com/design/spec/patterns/selection.html#selection-text-selection" +class="external-link">floating toolbar</a>. The user interaction implementation is similar to that +for the contextual action bar, as described in +<a href="{@docRoot}guide/topics/ui/menus.html#CABforViews"> +Enabling the contextual action mode for individual views</a>.</p> + +<p>To implement a floating toolbar for text selection, make the following changes in your existing +apps:</p> +<ol> +<li>In your {@link android.view.View} or {@link android.app.Activity} object, change your +{@link android.view.ActionMode} calls from +{@code startActionMode(Callback)} to {@code startActionMode(Callback, ActionMode.TYPE_FLOATING)}.</li> +<li>Take your existing implementation of ActionMode.Callback and make it extend +{@code ActionMode.Callback2} instead.</li> +<li>Override the {@code Callback2.onGetContentRect()} method to provide the coordinates of the +content {@link android.graphics.Rect} object (such as a text selection rectangle) in the view.</li> +<li>If the rectangle positioning is no longer valid, and this is the only element to be invalidated, +call the {@code ActionMode.invalidateContentRect()} method.</li> +</ol> + +<p>If you are using <a href="{@docRoot}tools/support-library/index.html"> +Android Support Library</a> revision 22.2, be aware that floating toolbars are not +backward-compatible and appcompat takes control over {@link android.view.ActionMode} objects by +default. This prevents floating toolbars from being displayed in M. To enable +{@link android.view.ActionMode} support in an +{@link android.support.v7.app.AppCompatActivity}, call +{@code android.support.v7.app.AppCompatActivity.getDelegate()}, then call +{@code android.support.v7.app.AppCompatDelegate.setHandleNativeActionModesEnabled()} on the returned +{@link android.support.v7.app.AppCompatDelegate} object and set the input +parameter to {@code false}. This call returns control of {@link android.view.ActionMode} objects to +the framework. In devices running M, that allows the framework to support +{@link android.support.v7.app.ActionBar} or floating toolbar modes, while on pre-M devices, only the +{@link android.support.v7.app.ActionBar} modes are supported.</p> + +<h2 id="behavior-keystore">Android Keystore Changes</h2> +<p>Starting this release, the +<a href="{@docRoot}training/articles/keystore.html">Android Keystore provider</a> no longer supports +DSA. ECDSA is still supported.</p> + +<p>Keys which do not require encryption at rest will no longer be deleted when secure lock screen +is disabled or reset (for example, by the user or a Device Administrator). Keys which require +encryption at rest will be deleted during these events.</p> + +<h2 id="behavior-themeable-colorstatelists">Themeable ColorStateLists</h2> +<p>Theme attributes are now supported in +{@link android.content.res.ColorStateList} for devices running M. The +{@link android.content.res.Resources#getColorStateList(int) getColorStateList()} and +{@link android.content.res.Resources#getColor(int) getColor()} methods have been deprecated. If +you are calling these APIs, call the new {@code Context.getColorStateList()} or +{@code Context.getColor()} methods instead. These methods are also available in the +v4 appcompat library via {@link android.support.v4.content.ContextCompat}.</p> + +<h2 id="night-mode">Night Mode (User-configurable Dark Theme)</h2> +<p> +Support for the {@code -night} resource qualifier has been updated in M. Previously, night mode was +only available when a device was docked and in car mode. Starting in M, night mode is available on +all devices and is user-configurable via <em>Settings > Display > Theme</em>. You can adjust this +setting globally using {@link android.app.UiModeManager#setNightMode(int) setNightMode()}. The +Dark theme corresponds to {@link android.app.UiModeManager#MODE_NIGHT_YES}. When the device is in +night mode, the resource framework will prefer resources that have the -night qualifier. To +take advantage of user-configurable Dark mode in your app, extend from the +{@code Theme.Material.DayNight} set of themes rather than {@code Theme.Material} or +{@code Theme.Material.Light}. +</p> + +<h2 id="behavior-art-runtime">ART Runtime</h2> +<p>The ART runtime now properly implements access rules for the +{@link java.lang.reflect.Constructor#newInstance(java.lang.Object...) newInstance()} method. This +change fixes a problem where Dalvik was checking access rules incorrectly in previous versions. +If your app uses the +{@link java.lang.reflect.Constructor#newInstance(java.lang.Object...) newInstance()} method and you +want to override access checks, call the +{@link java.lang.reflect.Constructor#setAccessible(boolean) setAccessible()} method with the input +parameter set to {@code true}. If your app uses the +<a href="{@docRoot}tools/support-library/features.html#v7">v7 appcompat library</a> or the +<a href="{@docRoot}tools/support-library/features.html#v7-recyclerview">v7 recyclerview library</a>, +you must update your app to use to the latest versions of these libraries. Otherwise, make sure that +any custom classes referenced from XML are updated so that their class constructors are accessible.</p> + +<p>The M release updates the behavior of the dynamic linker. The dynamic linker now understands the +difference between a library’s {@code soname} and its path +(<a href="https://code.google.com/p/android/issues/detail?id=6670" class="external-link"> +public bug 6670</a>), and search by {@code soname} is now +implemented. Apps which previously worked that have bad {@code DT_NEEDED} entries +(usually absolute paths on the build machine’s file system) may fail when loaded on M.</p> + +<p>The {@code dlopen(3) RTLD_LOCAL} flag is now correctly implemented in M. Note that +{@code RTLD_LOCAL} is the default, so calls to {@code dlopen(3)} that didn’t explicitly use +{@code RTLD_LOCAL} will be affected (unless your app explicitly used {@code RTLD_GLOBAL}). With +{@code RTLD_LOCAL}, symbols will not be made available to libraries loaded by later calls to +{@code dlopen(3)} (as opposed to being referenced by {@code DT_NEEDED} entries).</p> +</p> + +<h2 id="behavior-afw">Android for Work Changes</h2> +<p>This release includes the following behavior changes for Android for Work:</p> +<ul> +<li><strong>Work contacts in personal contexts.</strong> Google Messenger and the Google Dialer +Call Log now display work contacts when the user views past messages or calls. Furthermore, both +work and personal contacts are now available to devices over Bluetooth, but you can hide work +profile contacts through a device policy by calling the new +{@code DevicePolicyManager.setBluetoothContactSharingDisabled()} method. Initiating a call or +creating a new message will only show personal contacts, as consistent with the experience in +Android 5.0. +</li> +<li><strong>WiFi configuration removal:</strong> WiFi configurations added by a Profile Owner +(for example, through calls to the +{@link android.net.wifi.WifiManager#addNetwork(android.net.wifi.WifiConfiguration) +addNetwork()} method) are now removed if that work profile is deleted.</li> +<li><strong>WiFi configuration lockdown:</strong> Any WiFi configuration created by an active Device +Owner can no longer be modified or deleted by the user. The user can still create and +modify their own WiFi configurations, so long as the {@link android.os.UserManager} constant +{@link android.os.UserManager#DISALLOW_CONFIG_WIFI} has not been set for that user.</li> +<li><strong>VPN in Settings:</strong> VPN apps are now visible in <em>Settings > More > VPN</em>. +Additionally, the notifications that accompany VPN usage are now specific to whether that VPN is +configured for a managed profile or the entire device.</li> +<li><strong>Work status notification:</strong> A status bar briefcase icon now appears whenever +an app from the managed profile has an activity in the foreground. Furthermore, if the device is +unlocked directly to the activity of an app in the managed profile, a toast is displayed notifying +the user that they are within the work profile. +</li> +<li><strong>Download Work Policy Controller via Google account addition:</strong> When a Google +account that requires management via a Work Policy Controller (WPC) app is added to a device +outside of a managed context, the add account flow now prompts the user to install the +appropriate WPC. This behavior also applies to accounts added via +<em>Settings > Accounts</em> in the initial device setup wizard.</li> +</ul> diff --git a/docs/html/preview/api-overview.jd b/docs/html/preview/api-overview.jd index dde3c7b..bf5eec4 100644 --- a/docs/html/preview/api-overview.jd +++ b/docs/html/preview/api-overview.jd @@ -1,6 +1,8 @@ page.title=API Overview page.keywords=preview,sdk,compatibility -sdk.platform.apiLevel=22 +page.tags=previewresources, androidm +sdk.platform.apiLevel=22-mnc +page.image=images/cards/card-api-overview_16-9_2x.png @jd:body @@ -13,24 +15,36 @@ sdk.platform.apiLevel=22 <span class="less" style="display:none">show less</span></a></h2> <ol id="toc44" class="hide-nested"> - <li><a href="#">Important Behavior Changes</a> - <ol> - <li><a href="#">change 1</a></li> - <li><a href="#">change 2</a></li> - </ol> + <li><a href="#backup">Automatic App Data Backup</a></li> + <li><a href="#authentication">Authentication</a> + <ul> + <li><a href="#fingerprint-authentication">Fingerprint Authentication</a></li> + <li><a href="#confirm-credentials">Confirm Credentials</a></li> + </ul> </li> - <li><a href="#">Feature Group 1</a> - <ol> - <li><a href="#">change 1</a></li> - <li><a href="#">change 2</a></li> - </ol> - </li> - <li><a href="#">Feature Group 2</a> - <ol> - <li><a href="#">change 1</a></li> - <li><a href="#">change 2</a></li> - </ol> + <li><a href="#direct-share">Direct Share</a></li> + <li><a href="#voice-interactions">Voice Interactions</a></li> + <li><a href="#assist">Assist API</a></li> + <li><a href="#notifications">Notifications</a></li> + <li><a href="#bluetooth-stylus">Bluetooth Stylus Support</a></li> + <li><a href="#ble-scanning">Improved Bluetooth Low Energy Scanning</a></li> + <li><a href="#hotspot">Hotspot 2.0 Release 1 Support</a></li> + <li><a href="#4K-display">4K Display Mode</a></li> + <li><a href="#behavior-themeable-colorstatelists">Themeable ColorStateLists</a></li> + <li><a href="#audio">Audio Features</a></li> + <li><a href="#video">Video Features</a></li> + <li><a href="#camera">Camera Features</a> + <ul> + <li><a href="#flashlight">Flashlight API</a></li> + <li><a href="#reprocessing">Camera Reprocessing</a></li> + </ul> </li> + <li><a href="#afw">Android for Work Features</a></li> +</ol> + +<h2>API Differences</h2> +<ol> +<li><a href="{@docRoot}preview/download.html">API level 22 to M Preview »</a> </li> </ol> </div> @@ -54,67 +68,465 @@ methods that do not yet have reference material available on <a href="{@docRoot}">developer.android.com</a>. These API elements are formatted in {@code code style} in this document (without hyperlinks). For the preliminary API documentation for these elements, download the <a -href="http://storage.googleapis.com/androiddevelopers/preview/l-developer-preview-reference.zip">preview -reference</a>.</p> +href="{@docRoot}preview/download.html#docs"> preview reference</a>.</p> -<h2 id="Behaviors">Important Behavior Changes</h2> +<h3>Important behavior changes</h3> -<p>If you have previously published an app for Android, be aware that your app - might be affected by changes in the upcoming release.</p> +<p>If you have previously published an app for Android, be aware that your app might be affected +by changes in the platform.</p> -<h3 id="id">Behavior Change 1</h3> +<p>Please see <a href="behavior-changes.html">Behavior Changes</a> for complete information.</p> -<p> - Bacon ipsum dolor amet biltong picanha t-bone, jowl salami tri-tip jerky kielbasa sirloin boudin - porchetta fatback cow meatloaf capicola. Short ribs kielbasa pig drumstick rump boudin jowl chuck - beef ribs doner tenderloin biltong swine. +<h2 id="backup">Automatic App Data Backup</h2> +<p>The system now performs automatic full data backup and restore for apps. This behavior is +enabled by default for apps targeting M Preview; you do not need to add any additional code. If +users delete their Google accounts, their backup data is deleted as well. To learn how this feature +works and how to configure what to back up on the file system, see +<a href="{@docRoot}preview/backup/index.html">Automatic App Data Backup</a>.</p> + +<h2 id="authentication">Authentication</h2> +<p>This preview offers new APIs to let you authenticate users by using their fingerprint scans on +supported devices, and check how recently the user was last authenticated using a device unlocking +mechanism (such as a lockscreen password). Use these APIs in conjunction with +the <a href="{@docRoot}training/articles/keystore.html">Android Keystore system</a>.</p> + +<h3 id="fingerprint-authentication">Fingerprint Authentication</h3> + +<p>To authenticate users via fingerprint scan, get an instance of the new +{@code android.hardware.fingerprint.FingerprintManager} class and call the +{@code FingerprintManager.authenticate()} method. Your app must be running on a compatible +device with a fingerprint sensor. You must implement the user interface for the fingerprint +authentication flow on your app, and use the standard Android fingerprint icon in your UI. +The Android fingerprint icon ({@code c_fp_40px.png}) is included in the +<a href="https://github.com/googlesamples/android-FingerprintDialog" +class="external-link">sample app</a>. If you are developing multiple apps that use fingerprint +authentication, note that each app must authenticate the user’s fingerprint independently. </p> +<p>To use this feature in your app, first add the {@code USE_FINGERPRINT} permission in your +manifest.</p> +<pre> +<uses-permission + android:name="android.permission.USE_FINGERPRINT" /> +</pre> -<h2 id="id">Feature Group 1</h2> +<img src="{@docRoot}preview/images/fingerprint-screen.png" +srcset="{@docRoot}preview/images/fingerprint-screen.png 1x, {@docRoot}preview/images/fingerprint-screen_2x.png 2x" +style="float:right; margin:0 0 10px 20px" width="282" height="476" /> -<h3 id="id">Feature item 1</h3> +<p>To see an app implementation of fingerprint authentication, refer to the +<a href="https://github.com/googlesamples/android-FingerprintDialog" class="external-link"> + Fingerprint Dialog sample</a>.</p> -<p> - Bacon ipsum dolor amet landjaeger capicola tail sausage shank swine biltong pork andouille t-bone - alcatra chicken. Strip steak bacon tongue beef bresaola landjaeger. Shankle boudin pork belly - jowl pig. Rump swine ham hock frankfurter pork shankle. Shank corned beef alcatra doner flank - turducken. Tongue brisket ham shoulder: +<p>If you are testing this feature, follow these steps:</p> +<ol> +<li>Enroll a new fingerprint in the emulator by going to +<strong>Settings > Security > Fingerprint</strong>, then follow the enrollment instructions.</li> +<li>Install Android SDK Tools Revision 24.3, if you have not done so.</li> +<li>Use an emulator to emulate fingerprint touch events with the +following command. Use the same command to emulate fingerprint touch events on the lockscreen or +in your app. +<pre class="no-prettyprint"> +adb -e emu finger touch <finger_id> +</pre> +<p>On Windows, you may have to run {@code telnet 127.0.0.1 <emulator-id>} followed by + {@code finger touch <finger_id>}. </p> +</li> +</ol> -<h3 id="id">Feature item 2</h3> +<h3 id="confirm-credentials">Confirm Credentials</h3> +<p>Your app can authenticate users based on how recently they last unlocked their device. You can +use the same public or secret key to authenticate users. This feature frees +users from having to remember additional app-specific passwords, and avoids the need for you to +implement your own authentication user interface.</p> -<p> - Bacon ipsum dolor amet landjaeger capicola tail sausage shank swine biltong pork andouille t-bone - alcatra chicken. Strip steak bacon tongue beef bresaola landjaeger. Shankle boudin pork belly - jowl pig. Rump swine ham hock frankfurter pork shankle. Shank corned beef alcatra doner flank - turducken. Tongue brisket ham shoulder: +<p>You can set your own authentication policy by setting constraints against the key that you are +generating or importing. To set the constraints for using a key, use the +{@code android.security.KeyPairGeneratorSpec.Builder} and +{@code android.security.KeyGeneratorSpec.Builder} classes for public key pairs and secret keys +respectively. If you are importing keys, use the {@link android.security.KeyStoreParameter.Builder} +class to set your constraints. You can use the +{@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent(java.lang.CharSequence, java.lang.CharSequence) createConfirmDeviceCredentialIntent()} +method to re-authenticate the user within your app if the timeout expired. +</p> + +<p>To see an app implementation of this feature, refer to the +<a href="https://github.com/googlesamples/android-ConfirmDeviceCredentials" class="external-link"> + Confirm Device Credentials sample</a>.</p> + +<h2 id="direct-share">Direct Share</h2> + +<img src="{@docRoot}preview/images/direct-share-screen_2x.png" +srcset="{@docRoot}preview/images/direct-share-screen.png 1x, preview/images/direct-share-screen_2x.png 2x" +style="float:right; margin:0 0 20px 30px" width="312" height="385" /> + +<p>This preview provides you with APIs to makes sharing intuitive and quick for users. You can now +define <em>deep links</em> that target a specific activity in your app. These deep links are +exposed to users via the <em>Share</em> menu. This feature allows users to share content to +targets, such as contacts, within other apps. For example, the deep link might launch an +activity in another social network app, which lets the user share content directly to a specific +friend or community in that app.</p> + +<p>To enable sharing via deep links, you must define a class that extends the +{@code android.service.} <br> +{@code chooser.ChooserTargetService} class. Declare your +{@code ChooserTargetService} in the manifest. Within that declaration, specify the +{@code BIND_CHOOSER_TARGET_SERVICE} permission and an intent filter with the +{@code SERVICE_INTERFACE} action.</p> +<p>The following example shows how you might declare the {@code ChooserTargetService} in your +manifest.</p> +<pre> +<service android:name=".ChooserTargetService" + android:label="@string/service_name" + android:permission="android.permission.BIND_CHOOSER_TARGET_SERVICE"> + <intent-filter> + <action android:name="android.service.chooser.ChooserTargetService" /> + </intent-filter> +</service> +</pre> + +<p>For each activity that you want to expose to the {@code ChooserTargetService}, add a +{@code <meta-data>} element with the name +{@code "android.service.chooser.chooser_target_service"} in your app manifest. </p> -<h2 id="id">Feature Group 2</h2> +<pre> +<activity android:name=".MyShareActivity” + android:label="@string/share_activity_label"> + <intent-filter> + <action android:name="android.intent.action.SEND" /> + </intent-filter> +<meta-data + android:name="android.service.chooser.chooser_target_service" + android:value=".ChooserTargetService" /> +</activity> +</pre> +<p>To see an app implementation of this feature, refer to the +<a href="https://github.com/googlesamples/android-DeepLinkSharing" class="external-link"> + Deep Link Sharing sample</a>.</p> -<h3 id="id">Feature item 1</h3> +<h2 id="voice-interactions">Voice Interactions</h2> <p> - Bacon ipsum dolor amet landjaeger capicola tail sausage shank swine biltong pork andouille t-bone - alcatra chicken. Strip steak bacon tongue beef bresaola landjaeger. Shankle boudin pork belly - jowl pig. Rump swine ham hock frankfurter pork shankle. Shank corned beef alcatra doner flank - turducken. Tongue brisket ham shoulder: +This preview provides a new voice interaction API which, together with +<a href="https://developers.google.com/voice-actions/" class="external-link">Voice Actions</a>, +allows you to build conversational voice experiences into your apps. Call the +{@code android.app.Activity.isVoiceInteraction()} method to determine if your activity was +started in response to a voice action. If so, your app can use the +{@code android.app.VoiceInteractor} class to request a voice confirmation from the user, select +from a list of options, and more. To learn more about implementing voice actions, see the +<a href="https://developers.google.com/voice-actions/interaction/" +class="external-link">Voice Actions developer site</a>. </p> -<h3 id="id">Feature item 2</h3> +<h2 id="assist">Assist API</h2> +<p> +This preview offers a new way for users to engage with your apps through an assistant. To use this +feature, the user must enable the assistant to use the current context. Once enabled, the user +can summon the assistant within any app, by long-pressing on the <strong>Home</strong> button.</p> +<p>The platform passes the current context to the assistant. In addition to the standard set of +information that the platform passes to the assistant, your app can share additional information +by using the new {@code android.app.Activity.AssistContent} class.</p> + +<p>To provide the assistant with additional context from your app, follow these steps:</p> + +<ol> +<li>Implement the {@link android.app.Application.OnProvideAssistDataListener} interface.</li> +<li>Register this listener by using +{@link android.app.Application#registerOnProvideAssistDataListener(android.app.Application.OnProvideAssistDataListener) registerOnProvideAssistDataListener()}.</li> +<li>In order to provide activity-specific contextual information, override the +{@link android.app.Activity#onProvideAssistData(android.os.Bundle) onProvideAssistData()} +callback and, optionally, the new {@code Activity.onProvideAssistContent()} callback. +</ol> + +<h2 id="notifications">Notifications</h2> +<p>This preview adds the following API changes for notifications:</p> +<ul> + <li>New {@code NotificationListenerService.INTERRUPTION_FILTER_ALARMS} filter level that + corresponds to the new <em>Alarms only</em> do not disturb mode.</li> + <li>New {@code Notification.CATEGORY_REMINDER} category value that is used to distinguish + user-scheduled reminders from other events + ({@link android.app.Notification#CATEGORY_EVENT}) and alarms + ({@link android.app.Notification#CATEGORY_ALARM}).</li> + <li>New {@code android.graphics.drawable.Icon} class which can be attached to your notifications + via the {@code Notification.Builder.setSmallIcon(Icon)} and + {@code Notification.Builder.setLargeIcon(Icon)} methods.</li> + <li>New {@code NotificationManager.getActiveNotifications()} method that allows your apps to + find out which of their notifications are currently alive. To see an app implementation that + uses this feature, see the <a href="https://github.com/googlesamples/android-ActiveNotifications" + class="external-link">Active Notifications sample</a>.</li> +</ul> +<h2 id="bluetooth-stylus">Bluetooth Stylus Support</h2> +<p>This preview provides improved support for user input using a Bluetooth stylus. Users can pair +and connect a compatible Bluetooth stylus with their phone or tablet. While connected, position +information from the touch screen is fused with pressure and button information from the stylus to +provide a greater range of expression than with the touch screen alone. Your app can listen for +stylus button presses and perform secondary actions, by registering the new +{@code View.onStylusButtonPressListener} and {@code GestureDetector.OnStylusButtonPressListener} +callbacks in your activity.</p> + +<p>Use the {@link android.view.MotionEvent} methods and constants to detect stylus button +interactions:</p> +<ul> +<li>If the user touches a stylus with a button on the screen of your app, the +{@link android.view.MotionEvent#getToolType(int) getTooltype()} method returns +{@link android.view.MotionEvent#TOOL_TYPE_STYLUS}.</li> +<li>For apps targeting M Preview, the +{@link android.view.MotionEvent#getButtonState() getButtonState()} +method returns {@code MotionEvent.STYLUS_BUTTON_PRIMARY} when the user +presses the primary stylus button. If the stylus has a second button, the same method returns +{@code MotionEvent.STYLUS_BUTTON_SECONDARY} when the user presses it. If the user presses +both buttons simultaneously, the method returns both values OR'ed together +({@code STYLUS_BUTTON_PRIMARY|STYLUS_BUTTON_SECONDARY}).</li> +<li> +For apps targeting a lower platform version, the +{@link android.view.MotionEvent#getButtonState() getButtonState()} method returns +{@link android.view.MotionEvent#BUTTON_SECONDARY} (for primary stylus button press), +{@link android.view.MotionEvent#BUTTON_TERTIARY} (for secondary stylus button press), or both. +</li> +</ul> + +<h2 id="ble-scanning">Improved Bluetooth Low Energy Scanning</h2> +<p> +If your app performs performs Bluetooth Low Energy scans, you can use the new +{@code android.bluetooth.le.ScanSettings.Builder.setCallbackType()} method to specify that +you want callbacks to only be notified when an advertisement packet matching the set +{@link android.bluetooth.le.ScanFilter} is first found, and when it is not seen for a period of +time. This approach to scanning is more power-efficient than what’s provided in the previous +platform version. +</p> + +<h2 id="hotspot">Hotspot 2.0 Release 1 Support</h2> <p> - Bacon ipsum dolor amet landjaeger capicola tail sausage shank swine biltong pork andouille t-bone - alcatra chicken. Strip steak bacon tongue beef bresaola landjaeger. Shankle boudin pork belly - jowl pig. Rump swine ham hock frankfurter pork shankle. Shank corned beef alcatra doner flank - turducken. Tongue brisket ham shoulder: +This preview adds support for the Hotspot 2.0 Release 1 spec on Nexus 6 and Nexus 9 devices. To +provision Hotspot 2.0 credentials in your app, use the new methods of the +{@link android.net.wifi.WifiEnterpriseConfig} class, such as {@code setPlmn()} and +{@code setRealm()}. In the {@link android.net.wifi.WifiConfiguration} object, you can set the +{@link android.net.wifi.WifiConfiguration#FQDN} and the {@code providerFriendlyName} fields. +The new {@code ScanResult.PasspointNetwork} property indicates if a detected +network represents a Hotspot 2.0 access point. </p> +<h2 id="4K-display">4K Display Mode</h2> +<p>The platform now allows apps to request that the display resolution be upgraded to 4K rendering +on compatible hardware. To query the current physical resolution, use the new +{@code android.view.Display.Mode} APIs. If the UI is drawn at a lower logical resolution and is +upscaled to a larger physical resolution, be aware that the physical resolution the +{@code Display.Mode.getPhysicalWidth()} method returns may differ from the logical +resolution reported by {@link android.view.Display#getSize(android.graphics.Point) getSize()}.</p> + +<p>You can request the system to change the physical resolution in your app as it runs, by setting +the {@code WindowManager.LayoutParams.preferredDisplayModeId} property of your app’s window. This +feature is useful if you want to switch to 4K display resolution. While in 4K display mode, the +UI continues to be rendered at the original resolution (such as 1080p) and is upscaled to 4K, but +{@link android.view.SurfaceView} objects may show content at the native resolution.</p> + +<p>To test the new 4K display mode, simulate a secondary display of a larger resolution using the +<strong>Developer Options</strong> settings.</p> + +<h2 id="behavior-themeable-colorstatelists">Themeable ColorStateLists</h2> +<p>Theme attributes are now supported in +{@link android.content.res.ColorStateList} for devices running the M Preview. The +{@link android.content.res.Resources#getColorStateList(int) getColorStateList()} and +{@link android.content.res.Resources#getColor(int) getColor()} methods have been deprecated. If +you are calling these APIs, call the new {@code Context.getColorStateList()} or +{@code Context.getColor()} methods instead. These methods are also available in the +v4 appcompat library via {@link android.support.v4.content.ContextCompat}.</p> + +<h2 id="audio">Audio Features</h2> + +<p>This preview adds enhancements to audio processing on Android, including: </p> +<ul> + <li>Support for the <a href="http://en.wikipedia.org/wiki/MIDI" class="external-link">MIDI</a> +protocol, with the new {@code android.media.midi} APIs. Use these APIs to send and receive MIDI +events.</li> + <li>New {@code android.media.AudioRecord.Builder} and {@code android.media.AudioTrack.Builder} +classes to create digital audio capture and playback objects respectively, and configure audio +source and sink properties to override the system defaults.</li> + <li>API hooks for associating audio and input devices. This is particularly useful if your app +allows users to start a voice search from a game controller or remote control connected to Android +TV. The system invokes the new {@code android.app.Activity.onSearchRequested()} callback when the +user starts a search. To determine if the user's input device has a built-in microphone, retrieve +the {@link android.view.InputDevice} object from that callback, then call the new +{@code InputDevice.hasMic()} method.</li> + <li>New {@code android.media.AudioDevicesManager} class which lets you retrieve a list of all +attached source and sink audio devices. You can also specify an +{@code android.media.OnAudioDeviceConnectionListener} object if you want your app to be notified +when an audio device is connected or disconnected.</li> +</ul> + +<h2 id="video">Video Features</h2> +<p>This preview adds new capabilities to the video processing APIs, including:</p> +<ul> +<li>New {@code android.media.MediaSync} class which helps applications to synchronously render +audio and video streams. The audio buffers are submitted in non-blocking fashion and are +returned via a callback. It also supports dynamic playback rate. +</li> +<li>New {@code MediaDrm.EVENT_SESSION_RECLAIMED} event, which indicates that a session opened by +the app has been reclaimed by the resource manager. If your app uses DRM sessions, you should +handle this event and make sure not to use a reclaimed session. +</li> +<li>New {@code MediaCodec.CodecException.ERROR_RECLAIMED} error code, which indicates that the +resource manager reclaimed the media resource used by the codec. With this exception, the codec +must be released, as it has moved to terminal state. +</li> +<li>New {@code MediaCodecInfo.CodecCapabilities.getMaxSupportedInstances()} interface to get a +hint for the max number of the supported concurrent codec instances. +</li> +<li>New {@code MediaPlayer.setPlaybackParams()} method to set the media playback rate for fast or +slow motion playback. It also stretches or speeds up the audio playback automatically in +conjunction with the video.</li> +</ul> +<h2 id="camera">Camera Features</h2> +<p>This preview includes the following new APIs for accessing the camera’s flashlight and for +camera reprocessing of images:</p> + +<h3 id="flashlight">Flashlight API</h3> +<p>If a camera device has a flash unit, you can call the {@code CameraManager.setTorchMode()} +method to switch the flash unit’s torch mode on or off without opening the camera device. The app +does not have exclusive ownership of the flash unit or the camera device. The torch mode is turned +off and becomes unavailable whenever the camera device becomes unavailable, or when other camera +resources keeping the torch on become unavailable. Other apps can also call {@code setTorchMode()} +to turn off the torch mode. When the last app that turned on the torch mode is closed, the torch +mode is turned off.</p> + +<p>You can register a callback to be notified about torch mode status by calling the +{@code CameraManager.registerTorchCallback()} method. The first time the callback is registered, +it is immediately called with the torch mode status of all currently known camera devices with a +flash unit. If the torch mode is turned on or off successfully, the +{@code CameraManager.TorchCallback.onTorchModeChanged()} method is invoked.</p> + +<h3 id="reprocessing">Reprocessing API</h3> +<p>The {@link android.hardware.camera2 Camera2} API is extended to support YUV and private +opaque format image reprocessing. Your app determine if the reprocessing capabilities are available +via {@code CameraCharacteristics.REQUEST_AVAILABLE_CAPABILITIES}. If a device supports reprocessing, +you can create a reprocessable camera capture session by calling +{@code CameraDevice.createReprocessableCaptureSession()}, and create requests for input +buffer reprocessing.</p> + +<p>Use the {@code ImageWriter} class to connect the input buffer flow to the camera reprocessing +input. To get an empty buffer, follow this programming model:</p> + +<ol> +<li>Call the {@code ImageWriter.dequeueInputImage()} method.</li> +<li>Fill the data into the input buffer.</li> +<li>Send the buffer to the camera by calling the {@code ImageWriter.queueInputImage()} method.</li> +</ol> + +<p>If you are using a {@code ImageWriter} object together with an +{@code android.graphics.ImageFormat.PRIVATE} image, your app cannot access the image +data directly. Instead, pass the {@code ImageFormat.PRIVATE} image directly to the +{@code ImageWriter} by calling the {@code ImageWriter.queueInputImage()} method without any +buffer copy.</p> + +<p>The {@code ImageReader} class now supports {@code android.graphics.ImageFormat.PRIVATE} format +image streams. This support allows your app to maintain a circular image queue of +{@code ImageReader} output images, select one or more images, and send them to the +{@code ImageWriter} for camera reprocessing.</p> + +<h2 id="afw">Android for Work Features</h2> +<p>This preview includes the following new APIs for Android for Work:</p> +<ul> + <li><strong>Enhanced controls for Corporate-Owned, Single-Use devices:</strong> The Device Owner +can now control the following settings to improve management of +Corporate-Owned, Single-Use (COSU) devices: + <ul> + <li>Disable or re-enable the keyguard with the +{@code DevicePolicyManager.setKeyguardEnabledState()} method.</li> + <li>Disable or re-enable the status bar (including quick settings, notifications, and the +navigation swipe-up gesture that launches Google Now) with the +{@code DevicePolicyManager.setStatusBarEnabledState()} method.</li> + <li>Disable or re-enable safe boot with the {@link android.os.UserManager} constant +{@code DISALLOW_SAFE_BOOT}.</li> + <li>Prevent the screen from turning off while plugged in with the + {@link android.provider.Settings.Global} constant {@code STAY_ON_WHILE_PLUGGED_IN}.</li> + </ul> + </li> + <li><strong>Silent install and uninstall of apps by Device Owner:</strong> A Device Owner can now +silently install and uninstall applications using the {@link android.content.pm.PackageInstaller} +APIs, independent of Google Play for Work. You can now provision devices through a Device Owner that +fetches and installs apps without user interaction. This feature is useful for enabling one-touch +provisioning of kiosks or other such devices without activating a Google account.</li> +<li><strong>Silent enterprise certificate access: </strong> When an app calls +{@link android.security.KeyChain#choosePrivateKeyAlias(android.app.Activity,android.security.KeyChainAliasCallback,java.lang.String[],java.security.Principal[],java.lang.String,int,java.lang.String) choosePrivateKeyAlias()}, +prior to the user being prompted to select a certificate, the Profile or Device Owner can now call +the {@code DeviceAdminReceiver.onChoosePrivateKeyAlias()} method to provide the alias silently to +the requesting application. This feature lets you grant managed apps access to certificates +without user interaction.</li> +<li><strong>Auto-acceptance of system updates.</strong> By setting a system update policy with +{@code DevicePolicyManager.setSystemUpdatePolicy()}, a Device Owner can now auto-accept a system +update, for instance in the case of a kiosk device, or postpone the update and prevent it being +taken by the user for up to 30 days. Furthermore, an administrator can set a daily time window in +which an update must be taken, for example during the hours when a kiosk device is not in use. When +a system update is available, the system checks if the Work Policy Controller app has set a system +update policy, and behaves accordingly. +</li> +<li> +<strong>Delegated certificate installation:</strong> A Profile or Device Owner can now grant a +third-party app the ability to call these {@link android.app.admin.DevicePolicyManager} certificate +management APIs: +<ul> + <li>{@link android.app.admin.DevicePolicyManager#getInstalledCaCerts(android.content.ComponentName) +getInstalledCaCerts()}</li> + <li>{@link android.app.admin.DevicePolicyManager#hasCaCertInstalled(android.content.ComponentName,byte[]) +hasCaCertInstalled()}</li> + <li>{@link android.app.admin.DevicePolicyManager#installCaCert(android.content.ComponentName,byte[]) +installCaCert()}</li> + <li>{@link android.app.admin.DevicePolicyManager#uninstallCaCert(android.content.ComponentName,byte[]) +uninstallCaCert()}</li> + <li>{@link android.app.admin.DevicePolicyManager#uninstallAllUserCaCerts(android.content.ComponentName) +uninstallAllUserCaCerts()}</li> + <li>{@link android.app.admin.DevicePolicyManager#installKeyPair(android.content.ComponentName,java.security.PrivateKey,java.security.cert.Certificate,java.lang.String) +installKeyPair()}</li> +</ul> +</li> +<li><strong>Enterprise factory reset protection:</strong> When provisioning a Device Owner, you can +now configure parameters to unlock Factory Reset Protection (FRP) by setting the +{@code DeviceManagerPolicy.EXTRA_PROVISIONING_RESET_PROTECTION_PARAMETERS} bundle. An NFC Programmer +app can provide these parameters after a device has been reset to unlock FRP and provision the device, +without requiring the previously configured Google account. If you don't modify these parameters, +FRP remains in-place and prevents the device from being activated without the previously activated +Google credentials. +<p>Additionally, by setting app restrictions on Google Play services, Device Owners can specify +alternative Google accounts for unlocking FRP to replace the ones activated on the device.</p> +</li> +<li><strong>Data usage tracking.</strong> A Profile or Device Owner can now query for the +data usage statistics visible in <strong>Settings > Data</strong> usage by using the new +{@code android.app.usage.NetworkStatsManager} methods. Profile Owners are automatically granted +permission to query data on the profile they manage, while Device Owners get access to usage data +of the managed primary user.</li> +<li><strong>Runtime permission management:</strong> With the new runtime permissions model, a +Profile or Device Owner can now silently grant or revoke an app’s permissions by calling +{@code DevicePolicyManager.setPermissionGranted()}. Granting or revoking a single permission applies +that setting to all permissions within that runtime permission group; the user is not prompted +at runtime when any permission from that runtime permission group is required. Furthermore, the +user cannot modify the selection made by the Profile or Device Owner within the app’s permissions +screen in <strong>Settings</strong>. +<img src="{@docRoot}preview/images/work-profile-screen_2x.png" +srcset="{@docRoot}preview/images/work-profile-screen.png 1x, preview/images/work-profile-screen_2x.png 2x" +style="float:right; margin:0 0 10px 20px" width="282" height="476" /> +<p>A Profile or Device Owner can also set a permission policy +for all runtime requests of all applications using +{@code DevicePolicyManager.setPermissionPolicy()}, to either prompt the user to grant the +permission as normal or automatically grant or deny the permission silently. If the latter policy +is set, the user cannot modify the selection made by the Profile or Device Owner within the +app’s permissions screen in <strong>Settings</strong>.</p></li> +<li><strong>VPN in Settings:</strong> VPN apps are now visible in + <strong>Settings > More > VPN</strong>. +Additionally, the notifications that accompany VPN usage are now specific to whether that VPN is +configured for a managed profile or the entire device.</li> +<li><strong>Work status notification:</strong> A status bar briefcase icon now appears whenever +an app from the managed profile has an activity in the foreground. Furthermore, if the device is +unlocked directly to the activity of an app in the managed profile, a toast is displayed notifying +the user that they are within the work profile. +</li> +</ul> <p class="note"> For a detailed view of all API changes in the M Developer Preview, see the <a href= - "{@docRoot}preview/reference.html">API Differences Report</a>. + "{@docRoot}preview/download.html">API Differences Report</a>. </p>
\ No newline at end of file diff --git a/docs/html/preview/backup/index.jd b/docs/html/preview/backup/index.jd new file mode 100644 index 0000000..5953e30 --- /dev/null +++ b/docs/html/preview/backup/index.jd @@ -0,0 +1,327 @@ +page.title=Auto Backup for Apps +page.tags=backup, previewresources, androidm +page.keywords=backup, autobackup, preview + +@jd:body + +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol> + <li><a href="#overview">Overview</a></li> + <li><a href="#configuring">Configuring Data Backup</a></li> + <li><a href="#testing">Testing Backup Configuration</a></li> + <li><a href="#issues">Known Issues</a></li> + </ol> + </div> +</div> + +<p> + Users often invest significant time and effort creating data and setting preferences within + apps. Preserving that data for users if they replace a broken device or upgrade to a new one is + an important part of ensuring a great user experience. Devices running the Android M Preview + system help ensure a good experience for users in these circumstances by automatically backing up + app data to Google Drive. The app data is automatically restored if a user changes or upgrades a + device. +</p> + +<p> + Automatic backups are enabled for all apps installed on devices running the Android M Preview. No + additional app code is required. The system provides users with the ability opt out of automatic + data backups. You can also choose to limit what data from your app is backed up. +</p> + +<p> + This document describes the new system behavior and how to specify what data is backed up for + your app. +</p> + +<h2 id="overview">Overview</h2> + +<p> + The automatic backup feature preserves the data your app creates on a user device by uploading it + to the user’s Google Drive account and encrypting it. There is no charge to you or the user for + data storage and the saved data does not count towards the user's personal Drive quota. During + the M Preview period, users can store up to 25MB per Android app. +</p> + +<p> + Automatic backups occur every 24 hours, when the device is idle, charging, and connected to a + Wi-Fi network. When these conditions are met, the Backup Manager service uploads all available + backup data to the cloud. When the user transitions to a new device, or uninstalls and reinstalls + the backed up app, a restore operation copies the backed up data into the newly installed + app’s data directory. +</p> + +<p class="note"> + <strong>Note:</strong> If your app uses the legacy + <a href="{@docRoot}google/backup/index.html">Android Backup service</a>, this new behavior + does not apply and the existing backup behavior works as usual. +</p> + + +<h3 id="auto-exclude">Automatically Excluded Data Files</h3> + +<p> + Not all app data should be backed up, such as temporary files and caches, so the automatic backup + service excludes certain data files by default: +</p> + +<ul> + <li>Files in the directories referred to by the {@link android.content.Context#getCacheDir + getCacheDir()} and {@link android.content.ContextWrapper#getCodeCacheDir getCodeCacheDir()} + methods. + </li> + + <li>Files located on external storage, unless they reside in the directory referred to by the + {@link android.content.Context#getExternalFilesDir getExternalFilesDir()} + method. + </li> + + <li>Files located in the directory referred to by the + {@link android.content.Context#getNoBackupFilesDir getNoBackupFilesDir()} method. + </li> +</ul> + +<h2 id="configuring">Configuring Data Backup</h2> + +<p> + The data created by any app installed on an M Preview device is backed up, except for the + automatically excluded files listed in the previous section. You can further limit and configure + what data gets backed up from your app using settings in your app manifest. +</p> + +<h3 id="include-exclude">Including or Excluding Data</h3> + +<p> + Depending on what data your app needs and how you save it, you may need to set specific + rules for including or excluding certain files or directories. The automatic backup service + supports setting these backup rules through use of an XML configuration file and the app + manifest. In the app manifest, you can specify a backup scheme configuration file as shown in the + following example: +</p> + +<pre> +<?xml version="1.0" encoding="utf-8"?> +<manifest xmlns:android="http://schemas.android.com/apk/res/android" + xmlns:tools="http://schemas.android.com/tools" + package="com.my.appexample"> + <uses-sdk android:minSdkVersion="9"/> + <uses-sdk android:targetSdkVersion="android-MNC"/> + <app ... +<strong> android:fullBackupContent="@xml/mybackupscheme"></strong> + </app> + ... +</manifest> +</pre> + +<p> + In this example code, the <code>android:fullBackupContent</code> attribute specifies an XML file, + located in the <code>res/xml/</code> directory of your app development project, named + <code>mybackupscheme.xml</code>. This configuration file includes rules for what files are backed + up. The following example code shows a configuration file that excludes a specific file from + backups: +</p> + +<pre> +<?xml version="1.0" encoding="utf-8"?> +<full-backup-content> + <exclude domain="database" path="device_info.db"/> +</full-backup-content> +</pre> + +<p> + This example backup configuration only excludes a specific database file from being backed up. + All other files are backed up. +</p> + +<h4>Backup Configuration Syntax</h4> + +<p> + The backup service configuration allows you to specify what files to include or exclude from + backup. The syntax for the data backup configuration xml file is as follows: +</p> + +<pre> +<full-backup-content> + <include domain=["file" | "database" | "sharedpref" | "external" | "root"] path="string" /> + <exclude domain=["file" | "database" | "sharedpref" | "external" | "root"] path="string" /> +</full-backup-content> +</pre> + +<p> + The following elements and attributes allow you to specify the files to include and exclude from + backup: +</p> + +<ul> + <li> + <code><include></code>. Use this element if you want to specify a set of resources to + back up, instead of having the system back up all data in your app by default. When you specify + an <code><include></code> tag, the system backs up <em>only the resources specified</em> + with this element. + </li> + + <li> + <code><exclude></code>. Use this element to specify a set of resources to exclude from + backup. The system backs up all data in your app, except for resources specified with this + element. + </li> + + <li> + <code>domain.</code> The type of resource you want to include or exclude from backup. The valid + values you can specify for this attribute include: + </li> + + <li style="list-style: none"> + <ul> + <li> + <code>root</code>. Specifies that the resource is in the app’s root directory. + </li> + + <li> + <code>file</code>. Corresponds to a resource in the directory returned by the + {@link android.content.Context#getFilesDir getFilesDir()} method. + </li> + + <li> + <code>database</code>. Corresponds to a database returned by the + {@link android.content.Context#getDatabasePath getDatabasePath()} method or by using the + {@link android.database.sqlite.SQLiteOpenHelper} class. + </li> + + <li> + <code>sharedpref</code>. Corresponds to a {@link android.content.SharedPreferences} object + returned by the {@link android.content.Context#getSharedPreferences getSharedPreferences()} + method. + </li> + + <li> + <code>external</code>. Specifies that the resource is in external storage, and corresponds + to a file in the directory returned by the + {@link android.content.Context#getExternalFilesDir getExternalFilesDir()} method. + </li> + + <li> + <code>path</code>. The file path to a resource that you want to include or exclude from + backup. + </li> + </ul> + </li> +</ul> + + +<h3 id="prohibit">Prohibiting Data Backups</h3> + +<p> + You can choose to prevent automatic backups of any of your app data by setting the + <code>android:allowBackup</code> attribute to <code>false</code> in the app element of + your manifest. This setting is illustrated in the following example code: +</p> + +<pre> +<?xml version="1.0" encoding="utf-8"?> +<manifest xmlns:android="http://schemas.android.com/apk/res/android" + xmlns:tools="http://schemas.android.com/tools" + package="com.my.appexample"> + <uses-sdk android:minSdkVersion="9"/> + <uses-sdk android:targetSdkVersion="android-MNC"/> + <app ... +<strong> android:allowBackup="false"></strong> + </app> + ... +</manifest> +</pre> + + +<h2 id="testing">Testing Backup Configuration</h2> + +<p> + Once you have created a backup configuration, you should test it to make sure your app saves data + and can be restored properly. +</p> + + +<h4>Enabling Backup Logging</h4> + +<p> + To help determine how the backup feature is parsing your XML file, enable logging before + performing a test backup: +</p> + +<pre class="noprettyprint"> +$ adb shell setprop log.tag.BackupXmlParserLogging VERBOSE +</pre> + +<h4>Testing Backup</h4> + +<p>To manually run a backup, first you must initialize the Backup Manager by calling the following + command: +</p> + +<pre class="noprettyprint"> +$ adb shell bmgr run +</pre> + +<p> + Next, you manually backup your application using the following command, specifying the package + name for your app as the <code><PACKAGE></code> parameter: +</p> + +<pre class="noprettyprint"> +$ adb shell bmgr fullbackup <PACKAGE></pre> + + +<h4>Testing Restore</h4> + +<p> + To manually initiate a restore after your app data is backed up, call the following command, + specifying the package name for your app as the <code><PACKAGE></code> parameter: +</p> + +<pre class="noprettyprint"> +$ adb shell bmgr restore <PACKAGE> +</pre> + +<p class="warning"> + <b>Warning:</b> This action stops your app and wipes its data before performing the restore + operation. +</p> + +<p> + You initiate the restore process for your app by uninstalling and reinstalling your app. The app + data is automatically restored from the cloud once the app installation is complete. +</p> + + +<h4>Troubleshooting Backups</h4> + +<p> + If you run into issues, you can clear the backup data and associated metadata by turning backup + off and on in the <strong>Settings > Backup</strong>, factory resetting the device, or by + calling this command: +</p> + +<pre>$ adb shell bmgr wipe <TRANSPORT> <PACKAGE></pre> + +<p> + The <code><TRANSPORT></code> value must be prefixed by <code>com.google.android.gms</code>. + To get the list of transports, call the following command: +</p> + +<pre>$ adb shell bmgr list transports</pre> + +<h2 id="issues">Known Issues</h2> + +<p>The following are known issues with the automatic backup service:</p> + +<ul> + <li><strong>Google Cloud Messaging</strong> - + For apps that use Google Cloud Messaging for push notifications, there is a known issue where + backing up the registration ID returned by Google Cloud Messaging registration can break push + notifications for the restored app. It is important to query the API for a new + registration ID after being installed on a new device, which is not be the case if the old + registration ID was backed up. To avoid this, exclude the registration id from the set of backed + up files. + </li> +</ul> diff --git a/docs/html/preview/behavior-changes.jd b/docs/html/preview/behavior-changes.jd new file mode 100644 index 0000000..0dd549b --- /dev/null +++ b/docs/html/preview/behavior-changes.jd @@ -0,0 +1,407 @@ +page.title=Behavior Changes +page.keywords=preview,sdk,compatibility +sdk.platform.apiLevel=23 +@jd:body + +<div id="qv-wrapper"> +<div id="qv"> + +<h2>In this document</h2> + +<ol id="toc44" class="hide-nested"> + <li><a href="#behavior-runtime-permissions">Runtime Permissions</a></li> + <li><a href="#behavior-project-volta">Project Volta</a> + <ol> + <li><a href="#behavior-doze">Doze mode</a></li> + <li><a href="#behavior-app-standby">App Standby</a></li> + </ol> + </li> + <li><a href="#behavior-adoptable-storage">Adoptable Storage Devices</a></li> + <li><a href="#behavior-apache-http-client">Apache HTTP Client Removal</a></li> + <li><a href="#behavior-audiomanager-Changes">AudioManager Changes</a></li> + <li><a href="#behavior-test-selection">Text Selection</a></li> + <li><a href="#behavior-keystore">Android Keystore Changes</a></li> + <li><a href="#night-mode">Night Mode</a></li> + <li><a href="#behavior-network">Wi-Fi and Networking Changes</a></li> + <li><a href="#behavior-camera">Camera Service Changes</a></li> + <li><a href="#behavior-art-runtime">ART Runtime</a></li> + <li><a href="#behavior-apk-validation">APK Validation</a></li> + <li><a href="#behavior-afw">Android for Work Changes</a></li> +</ol> + +<h2>API Differences</h2> +<ol> +<li><a href="{@docRoot}preview/download.html">API level 22 to M Preview »</a> </li> +</ol> + + +<h2>See Also</h2> +<ol> +<li><a href="{@docRoot}preview/api-overview.html">M Developer Preview API Overview</a> </li> +</ol> + +</div> +</div> + +<p>API Level: M</p> +<p>Along with new features and capabilities, the M Developer Preview includes a variety of +system changes and API behavior changes. This document highlights +some of the key changes that you should be understand and account for in your apps.</p> + +<p>If you have previously published an app for Android, be aware that your app + might be affected by these changes in the platform.</p> + +<h2 id="behavior-runtime-permissions">Runtime Permissions</h1> +<p>This preview introduces a new runtime permissions model, where users can now directly manage +their app permissions at runtime. This model gives users improved visibility and control over +permissions, while streamlining the installation and auto-update processes for app developers. +Users can set permissions on or off for all apps running on the M Preview. However, apps that +don’t target the M Preview cannot request permissions at runtime.</p> + +<p>On your apps that target the M Preview, make sure to check and request for permissions at +runtime. To determine if your app has been granted a permission, call the +new {@code Context.checkSelfPermission()} method. To request for a permission, call the new +{@code Activity.requestPermission()} method.</p> + +<p>For more information on supporting the new permissions model in your app, see +<a href="{@docRoot}preview/features/runtime-permissions.html"> +Android M Preview Runtime Permissions</a>.</p> + +<h2 id="behavior-project-volta">Project Volta</h2> +<p>This preview introduces new power-saving optimizations for idle devices and apps.</p> + +<h3 id="behavior-doze">Doze mode</h3> +<p>If a device is unplugged and left stationary with the screen off for a period of time, it +goes into <em>Doze</em> mode where it attempts to keep the system in a sleep state. In this mode, +devices periodically resume normal operations for brief periods of time so that app syncing can +occur and the system can perform any pending operations.</p> + +<p>The following restrictions apply to your apps while in Doze mode:</p> +<ul> +<li>Network access is disabled, unless your app receives a high priority Google Cloud Messaging +tickle.</li> +<li><a href="{@docRoot}reference/android/os/PowerManager.WakeLock.html">Wake locks</a> are ignored.</li> +<li>Alarms scheduled with the {@link android.app.AlarmManager} class are disabled, except for +alarms that you've set with the {@link android.app.AlarmManager#setAlarmClock setAlarmClock()} +method and {@code AlarmManager.setAndAllowWhileIdle()}.</li> +<li>WiFi scans are not performed.</li> +<li>Syncs and jobs for your sync adapters and {@link android.app.job.JobScheduler} are not +permitted to run.</li> +</ul> +</p> +<p>When the device exists doze mode, it executes any jobs and syncs that are pending.</p> +<p>You can test this feature by connecting a device running the M Preview to your development +machine and calling the following commands: +</p> +<pre class="no-prettyprint"> +$ adb shell dumpsys battery unplug +$ adb shell dumpsys deviceidle step +$ adb shell dumpsys deviceidle -h +</pre> +<p class="note"><strong>Note</strong>: The upcmoning +<a href="{@docRoot}google/gcm/index.html">Google Cloud Messaging</a> release lets you designate +high-priority messages. If your app receives high-priority GCM messages, it’s granted +brief network access even when the device is in doze mode. +</p> + +<h3 id="behavior-app-standby">App standby</h3> +<p>With this preview, the system may determine that apps are idle when they are not in active +use. Your app is considered idle after a period of time, unless the system detects +any of these signals:</p> + +<ul> +<li>The app has a process currently in the foreground (either as an activity or foreground service, +or in use by another activity or foreground service).</li> +<li>The app generates a notification that users see on the lock screen or in the +notification tray.</li> +<li>The user explicitly asks for the app to be exempt from optimizations, +via <strong>Settings</strong>.</li> +</ul> + +<p>If the device is unplugged, apps deemed idle will have their network access disabled +and their syncs and jobs suspended. When the device is plugged into a power supply, these apps are +allowed network access and can execute any jobs and syncs that are pending. If the +device is idle for long periods of time, idle apps are allowed network access around once a day.</p> + +<p>You can test this feature by connecting a device running the M Preview to your development +machine and calling the following commands: +</p> +<pre class="no-prettyprint"> +$ adb shell am broadcast -a android.os.action.DISCHARGING +$ adb shell am set-idle <packageName> true +$ adb shell am set-idle <packageName> false +$ adb shell am get-idle <packageName> +</pre> + +<p class="note"><strong>Note</strong>: The upcoming +<a href="{@docRoot}google/gcm/index.html">Google Cloud Messaging</a> (GCM) release lets you +designate high-priority messages. If your app receives high-priority GCM messages, it’s granted +brief network access even when the app is idle. +</p> + +<h2 id="behavior-adoptable-storage">Adoptable Storage Devices</h2> +<p> +With this preview, users can <em>adopt</em> external storage devices such as SD cards. Adopting an +external storage device encrypts and formats the device to behave like internal storage. This +feature allows users to move both apps and private data of those apps between storage devices. When +moving apps, the system respects the +<a href="{@docRoot}guide/topics/manifest/manifest-element.html#install">{@code android:installLocation}</a> +preference in the manifest.</p> + +<p>If your app accesses the following APIs or fields, be aware that the file paths they return +will dynamically change when the app is moved between internal and external storage devices. +When building file paths, it is strongly recommended that you always call these APIs dynamically. +Don’t use hardcoded file paths or persist fully-qualified file paths that were built previously.</p> + +<ul> +<li>{@link android.content.Context} methods: + <ul> + <li>{@link android.content.Context#getFilesDir() getFilesDir()}</li> + <li>{@link android.content.Context#getCacheDir() getCacheDir()}</li> + <li>{@link android.content.Context#getCodeCacheDir() getCodeCacheDir()}</li> + <li>{@link android.content.Context#getDatabasePath(java.lang.String) getDatabasePath()}</li> + <li>{@link android.content.Context#getDir(java.lang.String,int) getDir()}</li> + <li>{@link android.content.Context#getNoBackupFilesDir() getNoBackupFilesDir()}</li> + <li>{@link android.content.Context#getFileStreamPath(java.lang.String) getFileStreamPath()}</li> + <li>{@link android.content.Context#getPackageCodePath() getPackageCodePath()}</li> + <li>{@link android.content.Context#getPackageResourcePath() getPackageResourcePath()}</li> + </ul> +</li> +<li>{@link android.content.pm.ApplicationInfo} fields: + <ul> + <li>{@link android.content.pm.ApplicationInfo#dataDir dataDir}</li> + <li>{@link android.content.pm.ApplicationInfo#sourceDir sourceDir}</li> + <li>{@link android.content.pm.ApplicationInfo#nativeLibraryDir nativeLibraryDir}</li> + <li>{@link android.content.pm.ApplicationInfo#publicSourceDir publicSourceDir}</li> + <li>{@link android.content.pm.ApplicationInfo#splitSourceDirs splitSourceDirs}</li> + <li>{@link android.content.pm.ApplicationInfo#splitPublicSourceDirs splitPublicSourceDirs}</li> + </ul> +</li> +</ul> + +<p>To debug this feature in the developer preview, you can enable adoption of a USB drive that is +connected to an Android device through a USB On-The-Go (OTG) cable, by running this command:</p> + +<pre class="no-prettyprint"> +$ adb shell sm set-force-adoptable true +</pre> + +<h2 id="behavior-apache-http-client">Apache HTTP Client Removal</h2> +<p>This preview removes support for the Apache HTTP client. If your app is using this client and +targets Android 2.3 (API level 9) or higher, use the {@link java.net.HttpURLConnection} class +instead. This API is more efficient because it reduces network use through transparent compression +and response caching, and minimizes power consumption. To continue using the Apache HTTP APIs, you +must first declare the following compile-time dependency in your {@code build.gradle} file: +</p> +<pre> +android { + useLibrary 'org.apache.http.legacy' +} +</pre> +<p>Android is moving away from OpenSSL to the +<a href="https://boringssl.googlesource.com/boringssl/" class="external-link">BoringSSL</a> +library. If you’re using the Android NDK in your app, don't link against cryptographic libraries +that are not a part of the NDK API, such as {@code libcrypto.so} and {@code libssl.so}. These +libraries are not public APIs, and may change or break without notice across releases and devices. +In addition, you may expose yourself to security vulnerabilities. Instead, modify your +native code to call the Java cryptography APIs via JNI or to statically link against a +cryptography library of your choice.</p> + +<h2 id="behavior-audiomanager-Changes">AudioManager Changes</h2> +<p>Setting the volume directly or muting specific streams via the {@link android.media.AudioManager} +class is no longer supported. The {@link android.media.AudioManager#setStreamSolo(int,boolean) +setStreamSolo()} method is deprecated, and you should call the +{@code AudioManager.requestAudioFocus()} method instead. Similarly, the +{@link android.media.AudioManager#setStreamMute(int,boolean) setStreamMute()} method is +deprecated; instead, call the {@code AudioManager.adjustStreamVolume()} method +and pass in the direction value {@code ADJUST_MUTE} or {@code ADJUST_UNMUTE}.</p> + +<h2 id="behavior-test-selection">Text Selection</h2> + +<img src="{@docRoot}preview/images/text-selection.gif" +style="float:right; margin:0 0 20px 30px" width="360" height="640" /> + +<p>When users select text in your app, you can now display text selection actions such as +<em>Cut</em>, <em>Copy</em>, and <em>Paste</em> in a +<a href="http://www.google.com/design/spec/patterns/selection.html#selection-text-selection" +class="external-link">floating toolbar</a>. The user interaction implementation is similar to that +for the contextual action bar, as described in +<a href="{@docRoot}guide/topics/ui/menus.html#CABforViews"> +Enabling the contextual action mode for individual views</a>.</p> + +<p>To implement a floating toolbar for text selection, make the following changes in your existing +apps:</p> +<ol> +<li>In your {@link android.view.View} or {@link android.app.Activity} object, change your +{@link android.view.ActionMode} calls from +{@code startActionMode(Callback)} to {@code startActionMode(Callback, ActionMode.TYPE_FLOATING)}.</li> +<li>Take your existing implementation of {@code ActionMode.Callback} and make it extend +{@code ActionMode.Callback2} instead.</li> +<li>Override the {@code Callback2.onGetContentRect()} method to provide the coordinates of the +content {@link android.graphics.Rect} object (such as a text selection rectangle) in the view.</li> +<li>If the rectangle positioning is no longer valid, and this is the only element to be invalidated, +call the {@code ActionMode.invalidateContentRect()} method.</li> +</ol> + +<p>If you are using <a href="{@docRoot}tools/support-library/index.html"> +Android Support Library</a> revision 22.2, be aware that floating toolbars are not +backward-compatible and appcompat takes control over {@link android.view.ActionMode} objects by +default. This prevents floating toolbars from being displayed. To enable +{@link android.view.ActionMode} support in an +{@link android.support.v7.app.AppCompatActivity}, call +{@code android.support.v7.app.AppCompatActivity.getDelegate()}, then call +{@code android.support.v7.app.AppCompatDelegate.setHandleNativeActionModesEnabled()} on the returned +{@link android.support.v7.app.AppCompatDelegate} object and set the input +parameter to {@code false}. This call returns control of {@link android.view.ActionMode} objects to +the framework. In devices running the M Preview, that allows the framework to support +{@link android.support.v7.app.ActionBar} or floating toolbar modes, while on pre-M Preview devices, +only the {@link android.support.v7.app.ActionBar} modes are supported.</p> + +<h2 id="behavior-keystore">Android Keystore Changes</h2> +<p>With this preview, the +<a href="{@docRoot}training/articles/keystore.html">Android Keystore provider</a> no longer supports +DSA. ECDSA is still supported.</p> + +<p>Keys which do not require encryption at rest will no longer be deleted when secure lock screen +is disabled or reset (for example, by the user or a Device Administrator). Keys which require +encryption at rest will be deleted during these events.</p> + +<h2 id="night-mode">Night Mode (User-configurable Dark Theme)</h2> +<p> +Support for the {@code -night} resource qualifier has been updated. Previously, night mode was +only available when a device was docked and in car mode. With this preview, night mode is +available on +all devices and is user-configurable via <strong>Settings > Display > Theme</strong>. You can adjust +this setting globally using {@link android.app.UiModeManager#setNightMode(int) setNightMode()}. The +Dark theme corresponds to {@link android.app.UiModeManager#MODE_NIGHT_YES}. When the device is in +night mode, the resource framework prefers resources that have the {@code -night} qualifier. To +take advantage of user-configurable Dark mode in your app, extend from the +{@code Theme.Material.DayNight} set of themes rather than {@code Theme.Material} or +{@code Theme.Material.Light}. +</p> + +<h2 id="behavior-network">Wi-Fi and Networking Changes</h2> + +<p>This preview introduces the following behavior changes to the Wi-Fi and networking APIs.</p> +<ul> +<li>Your apps can now change the state of {@link android.net.wifi.WifiConfiguration} objects only +if you created these objects. You are not permitted to modify or delete +{@link android.net.wifi.WifiConfiguration} objects created by the user or by other apps. +</li> +<li> +Previously, if an app forced the device to connect to a specific Wi-Fi network by using +{@link android.net.wifi.WifiManager#enableNetwork(int,boolean) enableNetwork()} with the +{@code disableAllOthers=true} setting, the device disconnected from other networks such as +cellular data. In this preview, the device no longer disconnects from such other networks. If +your app’s {@code targetSdkVersion} is {@code “20”} or lower, it is pinned to the selected +Wi-Fi network. If your app’s {@code targetSdkVersion} is {@code “21”} or higher, use the +multinetwork APIs (such as +{@link android.net.Network#openConnection(java.net.URL) openConnection()}, +{@link android.net.Network#bindSocket(java.net.Socket) bindSocket()}, and the new +{@code ConnectivityManager.bindProcessToNetwork()} method) to ensure that its network traffic is +sent on the selected network.</li> +</ul> + +<h2 id="behavior-camera">Camera Service Changes</h2> +<p>In this preview, the model for accessing shared resources in the camera service has been changed +from the previous “first come, first serve” access model to an access model where high-priority +processes are favored. Changes to the service behavior include:</p> +<ul> +<li>Access to camera subsystem resources, including opening and configuring a camera device, is +awarded based on the “priority” of the client application process. Application processes with +user-visible or foreground activities are generally given a higher-priority, making camera resource +acquisition and use more dependable.</li> +<li>Active camera clients for lower priority apps may be “evicted” when a higher priority +application attempts to use the camera. In the deprecated {@link android.hardware.Camera} API, +this results in +{@link android.hardware.Camera.ErrorCallback#onError(int,android.hardware.Camera) onError()} being +called for the evicted client. In the {@link android.hardware.camera2 Camera2} API, it results in +{@link android.hardware.camera2.CameraDevice.StateCallback#onDisconnected(android.hardware.camera2.CameraDevice) onDisconnected()} +being called for the evicted client.</li> +<li>On devices with appropriate camera hardware, separate application processes are able to +independently open and use separate camera devices simultaneously. However, multi-process use +cases, where simultaneous access causes significant degradation of performance or capabilities of +any of the open camera devices, are now detected and disallowed by the camera service. This change +may result in “evictions” for lower priority clients even when no other app is directly +attempting to access the same camera device. +</li> +<li> +Changing the current user causes active camera clients in apps owned by the previous user account +to be evicted. Access to the camera is limited to user profiles owned by the current device user. +In practice, this means that a “Guest” account, for example, will not be able to leave running +processes that use the camera subsystem when the user has switched to a different account. +</li> +</ul> + +<h2 id="behavior-art-runtime">ART Runtime</h2> +<p>The ART runtime now properly implements access rules for the +{@link java.lang.reflect.Constructor#newInstance(java.lang.Object...) newInstance()} method. This +change fixes a problem where Dalvik was checking access rules incorrectly in previous versions. +If your app uses the +{@link java.lang.reflect.Constructor#newInstance(java.lang.Object...) newInstance()} method and you +want to override access checks, call the +{@link java.lang.reflect.Constructor#setAccessible(boolean) setAccessible()} method with the input +parameter set to {@code true}. If your app uses the +<a href="{@docRoot}tools/support-library/features.html#v7-appcompat">v7 appcompat library</a> or the +<a href="{@docRoot}tools/support-library/features.html#v7-recyclerview">v7 recyclerview library</a>, +you must update your app to use to the latest versions of these libraries. Otherwise, make sure that +any custom classes referenced from XML are updated so that their class constructors are accessible.</p> + +<p>This preview updates the behavior of the dynamic linker. The dynamic linker now understands the +difference between a library’s {@code soname} and its path +(<a href="https://code.google.com/p/android/issues/detail?id=6670" class="external-link"> +public bug 6670</a>), and search by {@code soname} is now +implemented. Apps which previously worked that have bad {@code DT_NEEDED} entries +(usually absolute paths on the build machine’s file system) may fail when loaded.</p> + +<p>The {@code dlopen(3) RTLD_LOCAL} flag is now correctly implemented. Note that +{@code RTLD_LOCAL} is the default, so calls to {@code dlopen(3)} that didn’t explicitly use +{@code RTLD_LOCAL} will be affected (unless your app explicitly used {@code RTLD_GLOBAL}). With +{@code RTLD_LOCAL}, symbols will not be made available to libraries loaded by later calls to +{@code dlopen(3)} (as opposed to being referenced by {@code DT_NEEDED} entries).</p> +</p> + +<h2 id="behavior-apk-validation">APK Validation</h2> +<p>The platform now performs stricter validation of APKs. An APK is considered corrupt if a file is +declared in the manifest but not present in the APK itself. An APK must be re-signed if any of the +contents are removed.</p> + +<h2 id="behavior-afw">Android for Work Changes</h2> +<p>This preview includes the following behavior changes for Android for Work:</p> +<ul> +<li><strong>Work contacts in personal contexts.</strong> The Google Dialer +Call Log now displays work contacts when the user views past calls. Both +work and personal contacts are now available to devices over Bluetooth, but you can hide work +profile contacts through a device policy by calling the new +{@code DevicePolicyManager.setBluetoothContactSharingDisabled()} method. Initiating a call still +shows personal contacts, as consistent with the experience in Android 5.0. +</li> +<li><strong>WiFi configuration removal:</strong> WiFi configurations added by a Profile Owner +(for example, through calls to the +{@link android.net.wifi.WifiManager#addNetwork(android.net.wifi.WifiConfiguration) +addNetwork()} method) are now removed if that work profile is deleted.</li> +<li><strong>WiFi configuration lockdown:</strong> Any WiFi configuration created by an active Device +Owner can no longer be modified or deleted by the user. The user can still create and +modify their own WiFi configurations, so long as the {@link android.os.UserManager} constant +{@link android.os.UserManager#DISALLOW_CONFIG_WIFI} has not been set for that user.</li> +<li><strong>Download Work Policy Controller via Google account addition:</strong> When a Google +account that requires management via a Work Policy Controller (WPC) app is added to a device +outside of a managed context, the add account flow now prompts the user to install the +appropriate WPC. This behavior also applies to accounts added via +<strong>Settings > Accounts</strong> in the initial device setup wizard.</li> +<li><strong>Changes to specific DevicePolicyManager API behaviors:</strong> +Calling the {@link android.app.admin.DevicePolicyManager#setCameraDisabled(android.content.ComponentName,boolean) setCameraDisabled()} +method affects the camera for the calling user only; calling it from the managed profile doesn’t +affect camera apps running on the primary user. In addition, the +{@link android.app.admin.DevicePolicyManager#setKeyguardDisabledFeatures(android.content.ComponentName,int) setKeyguardDisabledFeatures()} +method is now available for Profile Owners, in addition to Device Owners. A Profile Owner can set +these keyguard restrictions: +<ul> +<li>{@link android.app.admin.DevicePolicyManager#KEYGUARD_DISABLE_TRUST_AGENTS} and + {@link android.app.admin.DevicePolicyManager#KEYGUARD_DISABLE_FINGERPRINT}, which affect the + keyguard settings for the profile’s parent user.</li> +<li>{@link android.app.admin.DevicePolicyManager#KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, which + only affects notifications generated by applications in the managed profile.</li> +</ul> +</li> +</ul> diff --git a/docs/html/preview/download.jd b/docs/html/preview/download.jd new file mode 100644 index 0000000..8a67a9a --- /dev/null +++ b/docs/html/preview/download.jd @@ -0,0 +1,352 @@ +page.title=Downloads +page.image=images/cards/card-download_16-9_2x.png + +@jd:body + +<div style="position:relative; min-height:600px"> + + <div class="wrap" id="tos" style="position:absolute;display:none;width:inherit;"> + + <p class="sdk-terms-intro">Before downloading and installing components of the Android Preview + SDK, you must agree to the following terms and conditions.</p> + + <h2 class="norule">Terms and Conditions</h2> + + <div class="sdk-terms" onfocus="this.blur()" style="width:678px"> +This is the Android SDK Preview License Agreement (the “License Agreement”). + +1. Introduction + +1.1 The Android SDK Preview (referred to in the License Agreement as the “Preview” and specifically including the Android system files, packaged APIs, and Preview library files, if and when they are made available) is licensed to you subject to the terms of the License Agreement. The License Agreement forms a legally binding contract between you and Google in relation to your use of the Preview. + +1.2 "Android" means the Android software stack for devices, as made available under the Android Open Source Project, which is located at the following URL: http://source.android.com/, as updated from time to time. + +1.3 "Google" means Google Inc., a Delaware corporation with principal place of business at 1600 Amphitheatre Parkway, Mountain View, CA 94043, United States. + +2. Accepting the License Agreement + +2.1 In order to use the Preview, you must first agree to the License Agreement. You may not use the Preview if you do not accept the License Agreement. + +2.2 By clicking to accept and/or using the Preview, you hereby agree to the terms of the License Agreement. + +2.3 You may not use the Preview and may not accept the License Agreement if you are a person barred from receiving the Preview under the laws of the United States or other countries including the country in which you are resident or from which you use the Preview. + +2.4 If you will use the Preview internally within your company or organization you agree to be bound by the License Agreement on behalf of your employer or other entity, and you represent and warrant that you have full legal authority to bind your employer or such entity to the License Agreement. If you do not have the requisite authority, you may not accept the License Agreement or use the Preview on behalf of your employer or other entity. + +3. Preview License from Google + +3.1 Subject to the terms of the License Agreement, Google grants you a royalty-free, non-assignable, non-exclusive, non-sublicensable, limited, revocable license to use the Preview, personally or internally within your company or organization, solely to develop applications to run on the Android platform. + +3.2 You agree that Google or third parties owns all legal right, title and interest in and to the Preview, including any Intellectual Property Rights that subsist in the Preview. "Intellectual Property Rights" means any and all rights under patent law, copyright law, trade secret law, trademark law, and any and all other proprietary rights. Google reserves all rights not expressly granted to you. + +3.3 You may not use the Preview for any purpose not expressly permitted by the License Agreement. Except to the extent required by applicable third party licenses, you may not: (a) copy (except for backup purposes), modify, adapt, redistribute, decompile, reverse engineer, disassemble, or create derivative works of the Preview or any part of the Preview; or (b) load any part of the Preview onto a mobile handset or any other hardware device except a personal computer, combine any part of the Preview with other software, or distribute any software or device incorporating a part of the Preview. + +3.4 You agree that you will not take any actions that may cause or result in the fragmentation of Android, including but not limited to distributing, participating in the creation of, or promoting in any way a software development kit derived from the Preview. + +3.5 Use, reproduction and distribution of components of the Preview licensed under an open source software license are governed solely by the terms of that open source software license and not the License Agreement. You agree to remain a licensee in good standing in regard to such open source software licenses under all the rights granted and to refrain from any actions that may terminate, suspend, or breach such rights. + +3.6 You agree that the form and nature of the Preview that Google provides may change without prior notice to you and that future versions of the Preview may be incompatible with applications developed on previous versions of the Preview. You agree that Google may stop (permanently or temporarily) providing the Preview (or any features within the Preview) to you or to users generally at Google's sole discretion, without prior notice to you. + +3.7 Nothing in the License Agreement gives you a right to use any of Google's trade names, trademarks, service marks, logos, domain names, or other distinctive brand features. + +3.8 You agree that you will not remove, obscure, or alter any proprietary rights notices (including copyright and trademark notices) that may be affixed to or contained within the Preview. + +4. Use of the Preview by You + +4.1 Google agrees that nothing in the License Agreement gives Google any right, title or interest from you (or your licensors) under the License Agreement in or to any software applications that you develop using the Preview, including any intellectual property rights that subsist in those applications. + +4.2 You agree to use the Preview and write applications only for purposes that are permitted by (a) the License Agreement, and (b) any applicable law, regulation or generally accepted practices or guidelines in the relevant jurisdictions (including any laws regarding the export of data or software to and from the United States or other relevant countries). + +4.3 You agree that if you use the Preview to develop applications, you will protect the privacy and legal rights of users. If users provide you with user names, passwords, or other login information or personal information, you must make the users aware that the information will be available to your application, and you must provide legally adequate privacy notice and protection for those users. If your application stores personal or sensitive information provided by users, it must do so securely. If users provide you with Google Account information, your application may only use that information to access the user's Google Account when, and for the limited purposes for which, each user has given you permission to do so. + +4.4 You agree that you will not engage in any activity with the Preview, including the development or distribution of an application, that interferes with, disrupts, damages, or accesses in an unauthorized manner the servers, networks, or other properties or services of Google or any third party. + +4.5 You agree that you are solely responsible for (and that Google has no responsibility to you or to any third party for) any data, content, or resources that you create, transmit or display through Android and/or applications for Android, and for the consequences of your actions (including any loss or damage which Google may suffer) by doing so. + +4.6 You agree that you are solely responsible for (and that Google has no responsibility to you or to any third party for) any breach of your obligations under the License Agreement, any applicable third party contract or Terms of Service, or any applicable law or regulation, and for the consequences (including any loss or damage which Google or any third party may suffer) of any such breach. + +4.7 The Preview is in development, and your testing and feedback are an important part of the development process. By using the Preview, you acknowledge that implementation of some features are still under development and that you should not rely on the Preview having the full functionality of a stable release. You agree not to publicly distribute or ship any application using this Preview as this Preview will no longer be supported after the official Android SDK is released. + +5. Your Developer Credentials + +5.1 You agree that you are responsible for maintaining the confidentiality of any developer credentials that may be issued to you by Google or which you may choose yourself and that you will be solely responsible for all applications that are developed under your developer credentials. + +6. Privacy and Information + +6.1 In order to continually innovate and improve the Preview, Google may collect certain usage statistics from the software including but not limited to a unique identifier, associated IP address, version number of the software, and information on which tools and/or services in the Preview are being used and how they are being used. Before any of this information is collected, the Preview will notify you and seek your consent. If you withhold consent, the information will not be collected. + +6.2 The data collected is examined in the aggregate to improve the Preview and is maintained in accordance with Google's Privacy Policy located at http://www.google.com/policies/privacy/. + +7. Third Party Applications + +7.1 If you use the Preview to run applications developed by a third party or that access data, content or resources provided by a third party, you agree that Google is not responsible for those applications, data, content, or resources. You understand that all data, content or resources which you may access through such third party applications are the sole responsibility of the person from which they originated and that Google is not liable for any loss or damage that you may experience as a result of the use or access of any of those third party applications, data, content, or resources. + +7.2 You should be aware the data, content, and resources presented to you through such a third party application may be protected by intellectual property rights which are owned by the providers (or by other persons or companies on their behalf). You may not modify, rent, lease, loan, sell, distribute or create derivative works based on these data, content, or resources (either in whole or in part) unless you have been specifically given permission to do so by the relevant owners. + +7.3 You acknowledge that your use of such third party applications, data, content, or resources may be subject to separate terms between you and the relevant third party. + +8. Using Google APIs + +8.1 Google APIs + +8.1.1 If you use any API to retrieve data from Google, you acknowledge that the data may be protected by intellectual property rights which are owned by Google or those parties that provide the data (or by other persons or companies on their behalf). Your use of any such API may be subject to additional Terms of Service. You may not modify, rent, lease, loan, sell, distribute or create derivative works based on this data (either in whole or in part) unless allowed by the relevant Terms of Service. + +8.1.2 If you use any API to retrieve a user's data from Google, you acknowledge and agree that you shall retrieve data only with the user's explicit consent and only when, and for the limited purposes for which, the user has given you permission to do so. + +9. Terminating the License Agreement + +9.1 the License Agreement will continue to apply until terminated by either you or Google as set out below. + +9.2 If you want to terminate the License Agreement, you may do so by ceasing your use of the Preview and any relevant developer credentials. + +9.3 Google may at any time, terminate the License Agreement, with or without cause, upon notice to you. + +9.4 The License Agreement will automatically terminate without notice or other action upon the earlier of: +(A) when Google ceases to provide the Preview or certain parts of the Preview to users in the country in which you are resident or from which you use the service; and +(B) Google issues a final release version of the Android SDK. + +9.5 When the License Agreement is terminated, the license granted to you in the License Agreement will terminate, you will immediately cease all use of the Preview, and the provisions of paragraphs 10, 11, 12 and 14 shall survive indefinitely. + +10. DISCLAIMERS + +10.1 YOU EXPRESSLY UNDERSTAND AND AGREE THAT YOUR USE OF THE PREVIEW IS AT YOUR SOLE RISK AND THAT THE PREVIEW IS PROVIDED "AS IS" AND "AS AVAILABLE" WITHOUT WARRANTY OF ANY KIND FROM GOOGLE. + +10.2 YOUR USE OF THE PREVIEW AND ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE USE OF THE PREVIEW IS AT YOUR OWN DISCRETION AND RISK AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR COMPUTER SYSTEM OR OTHER DEVICE OR LOSS OF DATA THAT RESULTS FROM SUCH USE. WITHOUT LIMITING THE FOREGOING, YOU UNDERSTAND THAT THE PREVIEW IS NOT A STABLE RELEASE AND MAY CONTAIN ERRORS, DEFECTS AND SECURITY VULNERABILITIES THAT CAN RESULT IN SIGNIFICANT DAMAGE, INCLUDING THE COMPLETE, IRRECOVERABLE LOSS OF USE OF YOUR COMPUTER SYSTEM OR OTHER DEVICE. + +10.3 GOOGLE FURTHER EXPRESSLY DISCLAIMS ALL WARRANTIES AND CONDITIONS OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. + +11. LIMITATION OF LIABILITY + +11.1 YOU EXPRESSLY UNDERSTAND AND AGREE THAT GOOGLE, ITS SUBSIDIARIES AND AFFILIATES, AND ITS LICENSORS SHALL NOT BE LIABLE TO YOU UNDER ANY THEORY OF LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES THAT MAY BE INCURRED BY YOU, INCLUDING ANY LOSS OF DATA, WHETHER OR NOT GOOGLE OR ITS REPRESENTATIVES HAVE BEEN ADVISED OF OR SHOULD HAVE BEEN AWARE OF THE POSSIBILITY OF ANY SUCH LOSSES ARISING. + +12. Indemnification + +12.1 To the maximum extent permitted by law, you agree to defend, indemnify and hold harmless Google, its affiliates and their respective directors, officers, employees and agents from and against any and all claims, actions, suits or proceedings, as well as any and all losses, liabilities, damages, costs and expenses (including reasonable attorneys’ fees) arising out of or accruing from (a) your use of the Preview, (b) any application you develop on the Preview that infringes any Intellectual Property Rights of any person or defames any person or violates their rights of publicity or privacy, and (c) any non-compliance by you of the License Agreement. + +13. Changes to the License Agreement + +13.1 Google may make changes to the License Agreement as it distributes new versions of the Preview. When these changes are made, Google will make a new version of the License Agreement available on the website where the Preview is made available. + +14. General Legal Terms + +14.1 the License Agreement constitutes the whole legal agreement between you and Google and governs your use of the Preview (excluding any services which Google may provide to you under a separate written agreement), and completely replaces any prior agreements between you and Google in relation to the Preview. + +14.2 You agree that if Google does not exercise or enforce any legal right or remedy which is contained in the License Agreement (or which Google has the benefit of under any applicable law), this will not be taken to be a formal waiver of Google's rights and that those rights or remedies will still be available to Google. + +14.3 If any court of law, having the jurisdiction to decide on this matter, rules that any provision of the License Agreement is invalid, then that provision will be removed from the License Agreement without affecting the rest of the License Agreement. The remaining provisions of the License Agreement will continue to be valid and enforceable. + +14.4 You acknowledge and agree that each member of the group of companies of which Google is the parent shall be third party beneficiaries to the License Agreement and that such other companies shall be entitled to directly enforce, and rely upon, any provision of the License Agreement that confers a benefit on (or rights in favor of) them. Other than this, no other person or company shall be third party beneficiaries to the License Agreement. + +14.5 EXPORT RESTRICTIONS. THE PREVIEW IS SUBJECT TO UNITED STATES EXPORT LAWS AND REGULATIONS. YOU MUST COMPLY WITH ALL DOMESTIC AND INTERNATIONAL EXPORT LAWS AND REGULATIONS THAT APPLY TO THE PREVIEW. THESE LAWS INCLUDE RESTRICTIONS ON DESTINATIONS, END USERS AND END USE. + +14.6 The License Agreement may not be assigned or transferred by you without the prior written approval of Google, and any attempted assignment without such approval will be void. You shall not delegate your responsibilities or obligations under the License Agreement without the prior written approval of Google. + +14.7 The License Agreement, and your relationship with Google under the License Agreement, shall be governed by the laws of the State of California without regard to its conflict of laws provisions. You and Google agree to submit to the exclusive jurisdiction of the courts located within the county of Santa Clara, California to resolve any legal matter arising from the License Agreement. Notwithstanding this, you agree that Google shall still be allowed to apply for injunctive remedies (or an equivalent type of urgent legal relief) in any jurisdiction. + </div><!-- sdk terms --> + + + + <div id="sdk-terms-form"> + <p> + <input id="agree" type="checkbox" name="agree" value="1" onclick="onAgreeChecked()" /> + <label id="agreeLabel" for="agree">I have read and agree with the above terms and conditions</label> + </p> + <p><a href="" class="button disabled" id="downloadForRealz" onclick="return onDownloadForRealz(this);"></a></p> + </div> + + + </div><!-- end TOS --> + + + <div id="landing"> + +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol> + <li><a href="#sdk">Preview SDK</a></li> + <li><a href="#docs">Developer Documentation</a></li> + <li><a href="#images">Hardware System Images</a></li> + </ol> + </div> +</div> + + +<p> + The Android M Preview SDK includes development tools, Android system files, and library files to + help you test your app and the new APIs coming in the next release of the platform. This document + describes how to get the downloadable components of the preview for testing your app. +</p> + + +<h2 id="sdk">Preview SDK</h2> + +<p> + The Preview SDK is available for download through the <a href= + "{@docRoot}tools/help/sdk-manager.html">Android SDK Manager</a>. For more information on + downloading and configuring the Preview SDK, see <a href= + "{@docRoot}preview/setup-sdk.html#downloadSdk">Set Up the Preview SDK</a>. +</p> + + +<h2 id="#docs">Developer Documentation</h2> + +<p> + The developer documentation download package provides detailed API reference information and an API difference report for the preview. +</p> + +<table> + <tr> + <th scope="col">Description</th> + <th scope="col">Download / Checksums</th> + </tr> + <tr id="docs-dl"> + <td>Android M Preview<br>Developer Docs</td> + <td><a href="#top" onclick="onDownload(this)" + >m-preview-devdocs-r1.zip</a><br> + MD5: 5a6ae77217978cb7b958a240c2e80b57<br> + SHA-1: ac1d8a8e4f4a1dca5864dc733caa940bffc28616 + </td> + </tr> +<table> + + +<h2 id="images">Hardware System Images</h2> + +<p> + These system images allow you install a preview version of the platform on a physical device for + testing. By configuring a device with one of these images, you can install and test your app to + see how it performs on the next version of the platform. The process of installing a system image + on a device <em>removes all data from the device</em>, so you should backup your data before + installing a system image. +</p> + +<p class="warning"> + <b>Warning:</b> The following Android system images are previews and are subject to change. Your + use of these system images is governed by the Android SDK Preview License Agreement. The Android + preview system images are not stable releases, and may contain errors and defects that can result + in damage to your computer systems, devices, and data. The preview Android system images are not + subject to the same testing as the factory OS and can cause your phone and installed services and + applications to stop working. +</p> + +<table> + <tr> + <th scope="col">Device</th> + <th scope="col">Download / Checksums</th> + </tr> + <tr id="hammerhead"> + <td>Nexus 5 (GSM/LTE) <br>"hammerhead"</td> + <td><a href="#top" onclick="onDownload(this)" + >hammerhead-mpv79-preview-ac1d8a8e.tgz</a><br> + MD5: 5a6ae77217978cb7b958a240c2e80b57<br> + SHA-1: ac1d8a8e4f4a1dca5864dc733caa940bffc28616 + </td> + </tr> + <tr id="shamu"> + <td>Nexus 6 <br>"shamu"</td> + <td><a href="#top" onclick="onDownload(this)" + >shamu-mpv79-preview-ac1d8a8e.tgz</a><br> + MD5: 5a6ae77217978cb7b958a240c2e80b57<br> + SHA-1: ac1d8a8e4f4a1dca5864dc733caa940bffc28616 + </td> + </tr> + <tr id="volantis"> + <td>Nexus 9 <br>"volantis"</td> + <td><a href="#top" onclick="onDownload(this)" + >volantis-mpv79-preview-ac1d8a8e.tgz</a><br> + MD5: 5a6ae77217978cb7b958a240c2e80b57<br> + SHA-1: ac1d8a8e4f4a1dca5864dc733caa940bffc28616 + </td> + </tr> + <tr id="fugu"> + <td>Nexus Player <br>"fugu"</td> + <td><a href="#top" onclick="onDownload(this)" + >fugu-mpv79-preview-d0ddf8ce.tgz</a><br> + MD5: b293a5d3a4e07beabebcc0be85ad68a2<br> + SHA-1: d0ddf8ce733ba2a34279cdff8827fd604762c2342d + </td> + </tr> +</table> + +<h3 id="install-image">Install an Image to a Device</h3> + +<p> + In order to use a device image for testing, you must install it on a compatible device. Follow + the instructions below to install a system image: +</p> + +<ol> + <li>Download and uncompress one of the system image packages listed here.</li> + <li>Backup any data you want to preserve from the device.</li> + <li>Follow the instructions at + <a href="https://developers.google.com/android/nexus/images#instructions">developers.google.com/android</a> + to flash the image onto your device.</li> +</ol> + +<p class="note"> + <strong>Note:</strong> Once you have flashed a development device the preview system image, + it is upgraded automatically with the next preview release through over-the-air (OTA) updates. +</p> + +<h3 id="revertDevice">Revert a Device to Factory Specifications</h3> + +<p> + If you want to uninstall the Preview and revert the device to factory specifications, go to + <a href="http://developers.google.com/android/nexus/images">developers.google.com/android</a> and + download the image you want to flash to for your device. Follow the instructions on that page to + flash the image to your device. +</p> + + </div><!-- landing --> + +</div><!-- relative wrapper --> + + + +<script> + var urlRoot = "http://storage.googleapis.com/androiddevelopers/preview/"; + function onDownload(link) { + + $("#downloadForRealz").html("Download " + $(link).text()); + $("#downloadForRealz").attr('href', urlRoot + $(link).text()); + + $("#tos").fadeIn('fast'); + $("#landing").fadeOut('fast'); + + return true; + } + + + function onAgreeChecked() { + /* verify that the TOS is agreed */ + if ($("input#agree").is(":checked")) { + /* reveal the download button */ + $("a#downloadForRealz").removeClass('disabled'); + } else { + $("a#downloadForRealz").addClass('disabled'); + } + } + + function onDownloadForRealz(link) { + if ($("input#agree").is(':checked')) { + $("#tos").fadeOut('fast'); + $("#landing").fadeIn('fast'); + ga('send', 'event', 'M Preview', 'System Image', $("#downloadForRealz").html()); + location.hash = ""; + return true; + } else { + $("label#agreeLabel").parent().stop().animate({color: "#258AAF"}, 200, + function() {$("label#agreeLabel").parent().stop().animate({color: "#222"}, 200)} + ); + return false; + } + } + + $(window).hashchange( function(){ + if (location.hash == "") { + location.reload(); + } + }); + +</script> diff --git a/docs/html/preview/features/app-linking.jd b/docs/html/preview/features/app-linking.jd new file mode 100644 index 0000000..c516f35 --- /dev/null +++ b/docs/html/preview/features/app-linking.jd @@ -0,0 +1,112 @@ +page.title=App Linking + +@jd:body + + +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol> + <li><a href="#web-assoc">Declare a Website Association</a></li> + <li><a href="#verfy-links">Request App Link Verification</a></li> + <li><a href="#user-manage">Managing App Link Settings</a></li> + </ol> + </div> +</div> + +<p> + The Android Intent system is a flexible mechanism to enable apps to handle content and requests. + Multiple apps may declare matching URI patterns in their intent filters. When a user clicks on a + web link that does not have default launch handler, the platform may show a dialog for the user + to select from a list of apps that have declared matching intent filters. +</p> + +<p> + The Android M Developer Preview introduces support for app linking, which improves upon existing + link handling by allowing app developers to associate an app with a web domain they own. When + developers create this association, the platform can automatically determine the default app used + to handle a particular web link and skip asking users. +</p> + + +<h2 id="web-assoc">Declare a Website Association</h2> + +<p> + Website owners must declare associations with apps to establish an app link. The site owner + declares the relationship to an app by hosting a JSON file, named {@code statements.json}, at the + well-known location on the domain: +</p> + +<pre>http://<domain>:<optional port>/.well-known/statements.json</pre> + +<p class="note"> + <strong>Note:</strong> + During the M Developer Preview period, the JSON file is verified via http protocol. For + the official release of the platform, the file is verified over encrypted, https protocol. +</p> + +<p> + This JSON file indicates the Android app that should be used as the default handler for the URLs + under this domain. It identifies the app based on these fields: +</p> + +<ul> + <li>{@code package_name}: The package name declared in the app's manifest.</li> + + <li>{@code sha256_cert_fingerprints}: The SHA256 fingerprint of your app’s signing certificate. + You can use the Java keytool to generate the fingerprint using the following command: + <pre>keytool -list -v -keystore my-release-key.keystore</pre> + </li> +</ul> + +<p> + The following file listing shows an example of the contents and format of a + {@code statements.json} file: +</p> + +<pre> +[{ + "relation": ["delegate_permission/common.handle_all_urls"], + "target": { + "namespace": "android_app", + "package_name": "<strong><package name></strong>", + "sha256_cert_fingerprints": ["<strong>6C:EC:C5:0E:34:AE....EB:0C:9B</strong>"] + } +}] +</pre> + + +<h2 id="verfy-links">Request App Link Verification</h2> + +<p> + An app can indicate to the platform to verify app links against the {@code statements.json} files + hosted on the sites defined by the host names in the <data> elements of the intent filters. + To do this, add an {@code android:autoVerify} attribute to the appropriate intent filters in the + manifest, as shown in the following manifest code snippet: +</p> + +<pre> +<activity ...> + <intent-filter <strong>android:autoVerify="true"</strong>> + <action android:name="android.intent.action.VIEW" /> + <category android:name="android.intent.category.DEFAULT" /> + <category android:name="android.intent.category.BROWSABLE" /> + <data android:scheme="http" android:host="www.android.com" /> + <data android:scheme="https" android:host="www.android.com" /> + </intent-filter> +</activity> +</pre> + +<p> + When an app is installed, the platform attempts to verify the app links. If the platform cannot + successfully verify app links, it falls back to prompting the user the next time they open a link + that the app handles, or they will need to explicitly enable the app in the App Info settings UI. +</p> + +<h2 id="user-manage">Managing App Link Settings</h2> + +<p> + Users can change app link settings so URLs are handled the way they prefer. You can review and + manage app links in the system Settings app, under <strong>Settings > Apps > App Info > + Open by default</strong>. +</p> diff --git a/docs/html/preview/features/images/app-permissions-screen.png b/docs/html/preview/features/images/app-permissions-screen.png Binary files differnew file mode 100644 index 0000000..679b7ad --- /dev/null +++ b/docs/html/preview/features/images/app-permissions-screen.png diff --git a/docs/html/preview/features/images/app-permissions-screen@2x.png b/docs/html/preview/features/images/app-permissions-screen@2x.png Binary files differnew file mode 100644 index 0000000..e3eb13f --- /dev/null +++ b/docs/html/preview/features/images/app-permissions-screen@2x.png diff --git a/docs/html/preview/features/runtime-permissions.jd b/docs/html/preview/features/runtime-permissions.jd new file mode 100644 index 0000000..2ee44ef --- /dev/null +++ b/docs/html/preview/features/runtime-permissions.jd @@ -0,0 +1,795 @@ +page.title=Runtime Permissions +page.tags=previewresources, androidm +page.keywords=permissions, runtime, preview +@jd:body + + +<div id="qv-wrapper"> + <div id="qv"> + <h2>Quickview</h2> + <ul> + <li>If your app targets the M Preview SDK, it prompts users to grant + permissions at runtime, instead of install time.</li> + <li>Users can revoke permissions at any time from the app Settings + screen.</li> + <li>Your app needs to check that it has the permissions it needs every + time it runs.</li> + </ul> + + <h2>In this document</h2> + <ol> + <li><a href="#overview">Overview</a></li> + <li><a href="#coding">Coding for Runtime Permissions</a></li> + <li><a href="#testing">Testing Runtime Permissions</a></li> + <li><a href="#best-practices">Best Practices</a></li> + </ol> + +<!-- + <h2>Related Samples</h2> + <ol> + <li></li> + </ol> +--> + +<!-- + <h2>See also</h2> + <ol> + <li></li> + </ol> +--> + </div> <!-- qv --> +</div> <!-- qv-wrapper --> + + +<p> + The M Developer Preview introduces a new app permissions model which + streamlines the process for users to install and upgrade apps. If an app + running on the M Preview supports the new permissions model, the user does not have to + grant any permissions when they install or upgrade the app. Instead, the app + requests permissions as it needs them, and the system shows a dialog to the + user asking for the permission. +</p> + +<p> + If an app supports the new permissions model, it can still be installed and + run on devices running older versions of Android, using the old permissions + model on those devices. +</p> + +<h2 id="overview"> + Overview +</h2> + +<p> + With the M Developer Preview, the platform introduces a new app permissions + model. Here's a summary of the key components of this new model: +</p> + +<ul> + <li> + <strong>Declaring Permissions:</strong> The app declares all the + permissions it needs in the manifest, as in earlier Android platforms. + </li> + + <li> + <strong>Permission Groups:</strong> Permissions are divided into + <em>permission groups</em>, based on their functionality. For example, the + <code>CONTACTS</code> permission group contains permissions to read and + write the user's contacts and profile information. + </li> + + <li> + <p><strong>Limited Permissions Granted at Install Time:</strong> When the + user installs or updates the app, the system grants the app all + permissions that the app requests that fall under {@link + android.content.pm.PermissionInfo#PROTECTION_NORMAL PROTECTION_NORMAL}. + For example, alarm clock and internet permissions fall under {@link + android.content.pm.PermissionInfo#PROTECTION_NORMAL PROTECTION_NORMAL}, so + they are automatically granted at install time. + </p> + + <p>The system may also grant the app signature and system permissions, as + described in <a href="#system-apps">System apps and signature + permissions</a>. The user is <em>not</em> prompted to grant any permissions + at install time.</p> + </li> + + <li> + <strong>User Grants Permissions at Run-Time:</strong> When the app requests + a permission, the system shows a dialog to the user, then calls the app's + callback function to notify it whether the permission was granted. If a + user grants a permission, the app is given all permissions in that + permission's functional area that were declared in the app manifest. + </li> + +</ul> + +<p> + This permission model changes the way your app behaves for features that + require permissions. Here's a summary of the development practices you should + follow to adjust to this model: +</p> + +<ul> + + <li> + <strong>Always Check for Permissions:</strong> When the app needs to + perform any action that requires a permission, it should first check + whether it has that permission already. If it does not, it requests to be + granted that permission. + </li> + + <li> + <strong>Handle Lack of Permissions Gracefully:</strong> If the app is not + granted an appropriate permission, it should handle the failure cleanly. + For example, if the permission is just needed for an added feature, the app + can disable that feature. If the permission is essential for the app to + function, the app might disable all its functionality and inform the user + that they need to grant that permission. + </li> + + <div class="figure" style="width:220px"> + <img src="images/app-permissions-screen.png" srcset= + "images/app-permissions-screen@2x.png 2x" alt="" width="220" height= + "375"> + <p class="img-caption"> + <strong>Figure 2.</strong> Permission screen in the app's Settings. + </p> + </div> + + <li> + <strong>Permissions are Revocable:</strong> Users can revoke an app's + permissions at any time. If a user turns off an app's permissions, the app + is <em>not</em> notified. Once again, your app should verify that it has + needed permissions before performing any restricted actions. + </li> +</ul> + +<p class="note"> + <strong>Note:</strong> If an app targets the M Developer Preview, it + <em>must</em> use the new permissions model. +</p> + +<p> + As of the launch of the M Developer Preview, not all Google apps fully + implement the new permissions model. Google is updating these apps over + the course of the M Developer Preview to properly respect Permissions toggle + settings. +</p> + +<p class="note"> + <strong>Note:</strong> If your app has its own API surface, do not proxy + permissions without first ensuring the caller has the requisite permissions + to access that data. +</p> + +<h3 id="system-apps"> + System apps and signature permissions +</h3> + +<p> + Ordinarily, when the user installs an app, the system only grants the app the + {@link android.content.pm.PermissionInfo#PROTECTION_NORMAL + PROTECTION_NORMAL}. However, under some circumstances the system grants the + app more permissions: +</p> + +<ul> + <li>If an app is part of the system image, it is automatically granted all + the permissions listed in its manifest. + </li> + + <li>If the app requests permissions in the manifest that fall under {@link + android.content.pm.PermissionInfo#PROTECTION_SIGNATURE PROTECTION_SIGNATURE}, + and the app is signed with the same certificate as the app that declared + those permissions, the system grants the requesting app those permissions on + installation. + </li> +</ul> + +<p> + In both cases, the user can still revoke permissions at any time by going to + the system's <strong>Settings</strong> screen and choosing <strong>Apps + ></strong> <i>app_name</i> <strong>> Permissions</strong>. The app + should continue to check for permissions at run time and request them if + necessary. +</p> + +<h3 id="compatibility"> + Forwards and backwards compatibility +</h3> + +<p> + If an app does not target the M Developer Preview, the app continues to use + the old permissions model even on M Preview devices. When the user installs + the app, the system asks the user to grant all permissions listed in the + app's manifest. +</p> + +<p class="note"> + <strong>Note:</strong> On devices running the M Developer Preview, a user can + turn off permissions for any app (including legacy apps) from the app's + Settings screen. If a user turns off permissions for a legacy app, the system + silently disables the appropriate functionality. When the app attempts to + perform an operation that requires that permission, the operation will not + necessarily cause an exception. Instead, it might return an empty data set, + signal an error, or otherwise exhibit unexpected behavior. For example, if you + query a calendar without permission, the method returns an empty data set. +</p> + +<p> + If you install an app using the new permissions model on a device that is not + running the M Preview, + the system treats it the same as any other app: the system asks + the user to grant all declared permissions at install time. +</p> + +<p class="note"> + <strong>Note:</strong> For the preview release, you must set the minimum SDK + version to the M Preview SDK to compile with the preview SDK. This means you + will not be able to test such apps on older platforms during the developer + preview. +</p> + +<h3 id="perms-vs-intents">Permissions versus intents</h3> + +<p> + In many cases, you can choose between two ways for your app to perform a + task. You can have your app ask for permission to perform the operation + itself. Alternatively, you can have the app use an intent to have another app + perform the task. +</p> + +<p> + For example, suppose your app needs to be able to take pictures with the + device camera. Your app can request the + <code>android.permission.CAMERA</code> permission, which allows your app to + access the camera directly. Your app would then use the camera APIs + to control the camera and take a picture. This approach gives your app full + control over the photography process, and lets you incorporate the camera UI + into your app. +</p> + +<p> + However, if you don't need such control, you can just use an {@link + android.provider.MediaStore#ACTION_IMAGE_CAPTURE ACTION_IMAGE_CAPTURE} intent + to request an image. When you start the intent, the user is prompted to + choose a camera app (if there isn't already a default camera app), and that + app takes the picture. The camera app returns the picture to your app's {@link + android.app.Activity#onActivityResult onActivityResult()} method. +</p> + +<p> + Similarly, if you need to make a phone call, access the user's contacts, and + so on, you can do that by creating an appropriate intent, or you can request + the permission and access the appropriate objects directly. There are + advantages and disadvantages to each approach. +</p> + +<p> + If you use permissions: +</p> + +<ul> + <li>Your app has full control over the user experience when you perform the + operation. However, such broad control adds to the complexity of your task, + since you need to design an appropriate UI. + </li> + + <li>The user is prompted to give permission once, the first time you perform + the operation. After that, your app can perform the operation without + requiring additional interaction from the user. However, if the user doesn't + grant the permission (or revokes it later on), your app becomes unable to + perform the operation at all. + </li> +</ul> + +<p> + If you use an intent: +</p> + +<ul> + <li>You do not have to design the UI for the operation. The app that handles + the intent provides the UI. However, this means you have + no control over the user experience. The user could be interacting with an + app you've never seen. + </li> + + <li>If the user does not have a default app for the operation, the system + prompts the user to choose an app. If the user does not designate a default + handler, they may have to go + through an extra dialog every time they perform the operation. + </li> +</ul> + +<h2 id="coding">Coding for Runtime Permissions</h2> + +<p> + If your app targets the new M Developer Preview, you must use the new + permissions model. This means that in addition to declaring your needed + permissions in the manifest, you must also check to see if you have the + permissions at run time, and request the permissions if you do not already + have them. +</p> + +<h3 id="enabling"> + Enabling the new permissions model +</h3> + +<p> + To enable the new M Developer Preview permissions model, set the app's + <code>targetSdkVersion</code> attribute to <code>"MNC"</code>, and + <code>compileSdkVersion</code> to <code>"android-MNC"</code>. Doing so + enables all the new permissions features. +</p> + +<p> + For the preview release, you must set <code>minSdkVersion</code> to + <code>"MNC"</code> to compile with the preview SDK. +</p> + +<h3 id="m-only-perm"> + Designating a permission for the M Preview only +</h3> + +<p> + You can use the new <code><uses-permission-sdk-m></code> element in the app manifest + to indicate that a permission is only needed on the M Developer Preview. If + you declare a permission this way, then whenever the app is installed on an + older device, the system does not prompt the user or grant the + permission to the app. By using the <code><uses-permission-sdk-m></code> + element, you can add new permissions + to updated versions of your app without forcing users to grant permissions + when they install the update. +</p> + +<p> + If the app is running on a device with the M Developer Preview, + <code><uses-permission-sdk-m></code> behaves the same as + <code><a href="{@docRoot}guide/topics/manifest/uses-permission-element.html"><uses-permission></a></code>. + The system does not prompt the user to grant any permissions when they install + the app, and the app requests permissions as they are needed. +</p> + +<h3 id="prompting"> + Prompting for permissions +</h3> + +<p> + If your app uses the new M Developer Preview permissions model, the user is + not asked to grant all permissions when the app is first launched on a device + running the M Preview. Instead, your app requests permissions as they are + needed. When your app requests a permission, the system shows a dialog to the + user. +</p> + +<p> + If your app runs on a device that has SDK 22 or lower, the app uses the old + permissions model. When the user installs the app, they are prompted to grant + all the permissions your app requests in its manifest, except for those + permissions which are labeled with <code><uses-permission-sdk-m></code>. +</p> + +<h4 id="check-platform">Check what platform the app is running on</h4> + +<p> + This permissions model is only supported on devices running the M Developer + Preview. Before calling any of these methods, the app should verify + what platform it's running on + by checking the value of {@link android.os.Build.VERSION#CODENAME + Build.VERSION.CODENAME}. If the device is running the M Developer Preview, + {@link android.os.Build.VERSION#CODENAME CODENAME} is <code>"MNC"</code>. +</p> + +<h4 id="check-for-permission">Check if the app has the needed permission</h4> + +<p>When the user tries to do something that requires a permission, the app + checks to see if it currently has permission to perform this operation. To do + this, the app calls + <code>Context.checkSelfPermission(<i>permission_name</i>)</code>. The app + should perform this check even if it knows the user has already granted that + permission, + since the user can revoke an app's permissions at any time. For example, if a + user wants to use an app to take a picture, the app calls + <code>Context.checkSelfPermission(Manifest.permission.CAMERA)</code>.</p> + +<p class="table-caption" id="permission-groups"> + <strong>Table 1.</strong> Permissions and permission groups.</p> +<table> + <tr> + <th scope="col">Permission Group</th> + <th scope="col">Permissions</th> + </tr> + + <tr> + <td><code>android.permission-group.CALENDAR</code></td> + <td> + <ul> + <li> + <code>android.permission.READ_CALENDAR</code> + </li> + </ul> + <ul> + <li> + <code>android.permission.WRITE_CALENDAR</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.CAMERA</code></td> + <td> + <ul> + <li> + <code>android.permission.CAMERA</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.CONTACTS</code></td> + <td> + <ul> + <li> + <code>android.permission.READ_CONTACTS</code> + </li> + <li> + <code>android.permission.WRITE_CONTACTS</code> + </li> + <li> + <code>android.permission.READ_PROFILE</code> + </li> + <li> + <code>android.permission.WRITE_PROFILE</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.LOCATION</code></td> + <td> + <ul> + <li> + <code>android.permission.ACCESS_FINE_LOCATION</code> + </li> + <li> + <code>android.permission.ACCESS_COARSE_LOCATION</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.MICROPHONE</code></td> + <td> + <ul> + <li> + <code>android.permission.RECORD_AUDIO</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.PHONE</code></td> + <td> + <ul> + <li> + <code>android.permission.READ_PHONE_STATE</code> + </li> + <li> + <code>android.permission.CALL_PHONE</code> + </li> + <li> + <code>android.permission.READ_CALL_LOG</code> + </li> + <li> + <code>android.permission.WRITE_CALL_LOG</code> + </li> + <li> + <code>com.android.voicemail.permission.ADD_VOICEMAIL</code> + </li> + <li> + <code>android.permission.USE_SIP</code> + </li> + <li> + <code>android.permission.PROCESS_OUTGOING_CALLS</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.SENSORS</code></td> + <td> + <ul> + <li> + <code>android.permission.BODY_SENSORS</code> + </li> + </ul> + <ul> + <li> + <code>android.permission.USE_FINGERPRINT</code> + </li> + </ul> + </td> + </tr> + + <tr> + <td><code>android.permission-group.SMS</code></td> + <td> + <ul> + <li> + <code>android.permission.SEND_SMS</code> + </li> + <li> + <code>android.permission.RECEIVE_SMS</code> + </li> + <li> + <code>android.permission.READ_SMS</code> + </li> + <li> + <code>android.permission.RECEIVE_WAP_PUSH</code> + </li> + <li> + <code>android.permission.RECEIVE_MMS</code> + </li> + <li> + <code>android.permission.READ_CELL_BROADCASTS</code> + </li> + </ul> + </td> + </tr> + +</table> + +<h4 id="request-permissions">Request permissions if necessary</h4> + +<p>If the app doesn't already have the permission it needs, the app calls the + <code>Activity.requestPermissions(String[], int)</code> method to + request the appropriate permission or permissions. The app passes the + permission or permissions it wants, and also an integer "request code". + This method functions asynchronously: it returns right away, and after + the user responds to the dialog box, the system calls the app's callback + method with the results, passing the same "request code" that the app passed + to <code>requestPermissions()</code>.</p> + + <p>The following code code checks if the app has permission to read the + user's contacts, and requests the permission if necessary:</p> + +<pre> +if (checkSelfPermission(Manifest.permission.READ_CONTACTS) + != PackageManager.PERMISSION_GRANTED) { + requestPermissions(new String[]{Manifest.permission.READ_CONTACTS}, + MY_PERMISSIONS_REQUEST_READ_CONTACTS); + + // MY_PERMISSIONS_REQUEST_READ_CONTACTS is an + // app-defined int constant + + return; +} +</pre> + +<h4 id="handle-response">Handle the permissions request response</h4> + +<p> + When an app requests permissions, the system presents a dialog box to the + user. When the user responds, the system invokes your app's + <code>Activity.onRequestPermissionsResult(int, String[], int[])</code> + passing it the user response. Your app needs to override that method. The + callback is passed the same request code you passed to + <code>requestPermissions()</code>. For example, if an app requests + <code>READ_CONTACTS</code> access it might have the following callback + method: +</p> + +<pre> +@Override +public void onRequestPermissionsResult(int requestCode, + String permissions[], int[] grantResults) { + switch (requestCode) { + case MY_PERMISSIONS_REQUEST_READ_CONTACTS: { + if (grantResults[0] == PackageManager.PERMISSION_GRANTED) { + + // permission was granted, yay! do the + // calendar task you need to do. + + } else { + + // permission denied, boo! Disable the + // functionality that depends on this permission. + } + return; + } + + // other 'switch' lines to check for other + // permissions this app might request + } +} +</pre> + + <p>If the user grants a permission, the system gives the app all permissions + that the app manifest lists for that functional area. If the user denies the + request, you should take appropriate action. For example, you might disable + any menu actions that depend on this permission. + </li> +</p> + +<p> + When the system asks the user to grant a permission, the user has the option + of telling the system not to ask for that permission again. In that case, + when an app uses <code>requestPermissions()</code> to ask for that permission, + the system immediately denies the request. In this case, the system calls + your <code>onRequestPermissionsResult()</code> the same way it would if the + user had explicitly rejected your request again. For this reason, your app + cannot assume that any direct interaction with the user has taken place. +</p> + +<h2 id="testing">Testing Runtime Permissions</h2> + + +<p> + If your app targets the M Developer Preview, you must test that it + handles permissions properly. You cannot assume that your app has any + particular permissions when it runs. When the app is first launched, it is + likely to have no permissions, and the user can revoke or restore permissions + at any time. +</p> + +<p> + You should test your app to make sure it behaves properly under all + permission situations. With the M Preview SDK, we have provided new + <a href="{@docRoot}tools/help/adb.html">Android + Debug Bridge (adb)</a> commands to enable you to test your app with whatever + permissions settings you need to try. +</p> + +<h3> + New adb commands and options +</h3> + +<p> + The M Preview SDK Platform-tools provides several new commands to let you test + how your app handles permissions. +</p> + +<h4> + Install with permissions +</h4> + +<p> + You can use the <a href="{@docRoot}tools/help/adb.html#move"><code>adb + install</code></a> command's new <code>-g</code> option, which installs the + app and grants all permissions listed in its manifest: +</p> + +<pre class="no-pretty-print"> +$ adb install -g <path_to_apk> +</pre> + +<h4> + Grant and revoke permissions +</h4> + +<p> + You can use new ADB <a href="{@docRoot}tools/help/adb.html#pm">package manager + (pm)</a> commands to grant and revoke permissions to an installed app. + This functionality can be useful for automated testing. +</p> + +<p> + To grant a permission, use the package manager's <code>grant</code> command: +</p> + +<pre class="no-pretty-print"> +$ adb pm grant <package_name> <permission_name> +</pre> + +<p> + For example, to grant the com.example.myapp package permission to record + audio, use this command: +</p> + +<pre class="no-pretty-print"> +$ adb pm grant com.example.myapp android.permission.RECORD_AUDIO +</pre> + +<p> + To revoke a permission, use the package manager's <code>revoke</code> command: +</p> + +<pre class="no-pretty-print"> +$ adb pm revoke <package_name> <permission_name> +</pre> + +<h2 id="best-practices">Best Practices</h2> + +<p> + The new permissions model gives users a smoother experience, and makes it + easier for them to install apps and feel comfortable with what the apps are + doing. We recommend the following best practices to take full advantage of + the new model. +</p> + + +<h3 id="bp-what-you-need">Only ask for permissions you need</h3> + +<p> + Every time you ask for a permission, you force the user to make a decision. + If the user turns down the request, that reduces your app's functionality. + You should minimize the number of times you make these requests. +</p> + +<p> + For example, quite often your app can get needed functionality by using an + <a href="{@docRoot}guide/components/intents-filters.html">intent</a> instead + of asking for permissions. If your app needs to take pictures with the + phone's camera, your app can use a {@link + android.provider.MediaStore#ACTION_IMAGE_CAPTURE + MediaStore.ACTION_IMAGE_CAPTURE} intent. When your app executes the intent, the + system prompts the user to choose an already-installed camera app to take the + picture. +</p> + +<h3 id="bp-dont-overwhelm"> + Don't overwhelm the user +</h3> + +<p> + If you confront the user with a lot of requests for permissions at once, you may + overwhelm the user and cause them to quit your app. Instead, you should ask + for permissions as you need them. +</p> + +<p> + In some cases, one or more permissions might be absolutely essential to your + app. In that case, it might make sense to ask for all the permissions as soon + as the app launches. For example, if you make a photography app, the app + would need access to the device camera. When the user launches the app for + the first time, they won't be surprised to be asked for permission to use + the camera. But if the same app also had a feature to share photos with the + user's contacts, you probably should <em>not</em> ask for that permission at + first launch. Instead, wait until the user tries to use the "sharing" feature + and ask for the permission then. +</p> + +<p> + If your app provides a tutorial, it may make sense to request the app's essential + permissions at the end of the tutorial sequence. +</p> + +<h3 id="bp-explain"> + Explain why you need permissions +</h3> + +<p> + The permissions dialog shown by the system when you call + <code>requestPermissions()</code> says what permission your app wants, but + doesn't say why. In some cases, the user may find that puzzling. + It's a good idea to explain to the user why your app wants the permissions + before calling <code>requestPermissions()</code>. +</p> + +<p> + For example, a photography app might want to use location services, so it can + geotag the photos. A typical user might not understand that a photo can + contain location information, and would be puzzled why their photography app + wanted to know the location. So in this case, it's a good idea for the app to + tell the user about this feature <em>before</em> calling + <code>requestPermissions()</code>. +</p> + +<p> + One way to do this is to incorporate these requests into an app tutorial. The + tutorial can show each of the app's features in turn, and as it does this, it + can explain what permissions are needed. For example, the photography app's + tutorial can demonstrate its "share photos with your contacts" feature, then + tell the user that they need to give permission for the app to see the user's + contacts. The app can then call <code>requestPermissions()</code> to ask the + user for that access. Of course, not every user is going to follow the + tutorial, so you still need to check for and request permissions during the + app's normal operation. +</p> diff --git a/docs/html/preview/images/bugs.png b/docs/html/preview/images/bugs.png Binary files differdeleted file mode 100644 index 46adf05..0000000 --- a/docs/html/preview/images/bugs.png +++ /dev/null diff --git a/docs/html/preview/images/dev-prev.png b/docs/html/preview/images/dev-prev.png Binary files differdeleted file mode 100644 index eae6ede..0000000 --- a/docs/html/preview/images/dev-prev.png +++ /dev/null diff --git a/docs/html/preview/images/direct-share-screen.png b/docs/html/preview/images/direct-share-screen.png Binary files differnew file mode 100644 index 0000000..9e879e0 --- /dev/null +++ b/docs/html/preview/images/direct-share-screen.png diff --git a/docs/html/preview/images/direct-share-screen_2x.png b/docs/html/preview/images/direct-share-screen_2x.png Binary files differnew file mode 100644 index 0000000..3bbfa7d --- /dev/null +++ b/docs/html/preview/images/direct-share-screen_2x.png diff --git a/docs/html/preview/images/fingerprint-screen.png b/docs/html/preview/images/fingerprint-screen.png Binary files differnew file mode 100644 index 0000000..0bb49ef --- /dev/null +++ b/docs/html/preview/images/fingerprint-screen.png diff --git a/docs/html/preview/images/fingerprint-screen_2x.png b/docs/html/preview/images/fingerprint-screen_2x.png Binary files differnew file mode 100644 index 0000000..25ce51a --- /dev/null +++ b/docs/html/preview/images/fingerprint-screen_2x.png diff --git a/docs/html/preview/images/m-preview-timeline-crop.png b/docs/html/preview/images/m-preview-timeline-crop.png Binary files differnew file mode 100644 index 0000000..724a6af --- /dev/null +++ b/docs/html/preview/images/m-preview-timeline-crop.png diff --git a/docs/html/preview/images/m-preview-timeline.png b/docs/html/preview/images/m-preview-timeline.png Binary files differindex a065c21..e9a339e 100644 --- a/docs/html/preview/images/m-preview-timeline.png +++ b/docs/html/preview/images/m-preview-timeline.png diff --git a/docs/html/preview/images/perf-test-frame-latency.png b/docs/html/preview/images/perf-test-frame-latency.png Binary files differnew file mode 100644 index 0000000..87d1cfc --- /dev/null +++ b/docs/html/preview/images/perf-test-frame-latency.png diff --git a/docs/html/preview/images/perf-test-framestats.png b/docs/html/preview/images/perf-test-framestats.png Binary files differnew file mode 100644 index 0000000..589a923 --- /dev/null +++ b/docs/html/preview/images/perf-test-framestats.png diff --git a/docs/html/preview/images/text-selection.gif b/docs/html/preview/images/text-selection.gif Binary files differnew file mode 100644 index 0000000..1d82fc6 --- /dev/null +++ b/docs/html/preview/images/text-selection.gif diff --git a/docs/html/preview/images/updates.png b/docs/html/preview/images/updates.png Binary files differdeleted file mode 100644 index f165c5a..0000000 --- a/docs/html/preview/images/updates.png +++ /dev/null diff --git a/docs/html/preview/images/work-profile-screen.png b/docs/html/preview/images/work-profile-screen.png Binary files differnew file mode 100644 index 0000000..c3e4e44 --- /dev/null +++ b/docs/html/preview/images/work-profile-screen.png diff --git a/docs/html/preview/images/work-profile-screen_2x.png b/docs/html/preview/images/work-profile-screen_2x.png Binary files differnew file mode 100644 index 0000000..5dcf610 --- /dev/null +++ b/docs/html/preview/images/work-profile-screen_2x.png diff --git a/docs/html/preview/index.jd b/docs/html/preview/index.jd index c6c2068..c5644cc 100644 --- a/docs/html/preview/index.jd +++ b/docs/html/preview/index.jd @@ -1,47 +1,35 @@ -page.title=M Developer Preview -page.tags=preview -meta.tags="preview" +page.title=Android M Developer Preview +page.tags="preview", +meta.tags="preview, M preview" fullpage=true -page.viewport_width=970 section.landing=true header.hide=1 footer.hide=1 @jd:body -<section class="dac-expand dac-hero dac-light"> +<section class="dac-expand dac-hero dac-light" > <div class="wrap"> <div class="cols dac-hero-content"> - <div class="col-1of2 col-push-1of2 dac-hero-figure"> - <img class="dac-hero-image" src="/design/media/hero-material-design.png"> + <div class="col-9of16 col-push-7of16 dac-hero-figure"> + <img class="dac-hero-image" src="{@docRoot}images/home/devices-hero_620px_2x.png" + srcset="{@docRoot}images/home/devices-hero_620px.png 1x, + {@docRoot}images/home/devices-hero_620px_2x.png 2x"> </div> - <div class="col-1of2 col-pull-1of2"> - <h1 class="dac-hero-title">M Developer Preview</h1> + <div class="col-7of16 col-pull-9of16"> + <h1 class="dac-hero-title">Android M Developer Preview</h1> <p class="dac-hero-description"> - Get ready for the next official release of the platform. The preview program gives - you an advance look at new APIs, features, and behaviors coming to Android. - Test your apps and give us feedback! + Get ready for the next version of Android. Test your apps on Nexus 5, 6, 9, and + Player. Explore what's new — a <strong>runtime permissions</strong> model, + power-saving <strong>Doze</strong> and <strong>Standby Mode</strong>, new + <strong>assist technology</strong>, and more. </p> <a class="dac-hero-cta" href="{@docRoot}preview/overview.html"> <span class="dac-sprite dac-auto-chevron"></span> - Preview Program Overview + Get Started! </a><br> - <a class="dac-hero-cta" href="{@docRoot}preview/api-overview.html"> - <span class="dac-sprite dac-auto-chevron"></span> - Review the API changes - </a><br> - <a class="dac-hero-cta" href="{@docRoot}preview/setup-sdk.html"> - <span class="dac-sprite dac-auto-chevron"></span> - Set up the Preview SDK - </a><br> - <a class="dac-hero-cta" href="https://code.google.com/p/android-developer-preview/"> - <span class="dac-sprite dac-auto-chevron"></span> - Report issues - </a><br> - </div> </div> - <div class="dac-section dac-small"> <div class="resource-widget resource-flow-layout col-16" data-query="collection:preview/landing/resources" @@ -49,4 +37,34 @@ footer.hide=1 data-maxResults="6"></div> </div> </div> -</section>
\ No newline at end of file +</section> + + +<div class="wrap dac-offset-parent"> + <a class="dac-fab dac-scroll-button" data-scroll-button href="#latest"> + <i class="dac-sprite dac-arrow-down-gray"></i> + </a> +</div> + +<section class="dac-section dac-gray dac-small dac-invert" id="latest"><div class="wrap"> + <h2 class="norule">Latest</h2> + <div class="resource-widget resource-flow-layout col-16" + data-query="type:blog+tag:androidm,type:youtube+tag:androidm" + data-cardSizes="6x6" + data-maxResults="6" + data-initial-results="3"</div> +</div></section> + + +<section class="dac-section dac-light"><div class="wrap"> + <h1 class="dac-section-title">Resources</h1> + <div class="dac-section-subtitle"> + Essential information to help you get your apps ready for Android M. + </div> + <div class="resource-widget resource-flow-layout col-16" + data-query="tag:previewresources" + data-cardSizes="6x6" + data-initial-results="6" + data-maxResults="16"></div> +</div></section> + diff --git a/docs/html/preview/overview.jd b/docs/html/preview/overview.jd index 0c8931d..4c13fbc 100644 --- a/docs/html/preview/overview.jd +++ b/docs/html/preview/overview.jd @@ -1,56 +1,370 @@ -page.title=Preview Program Overview +page.title=Program Overview +page.metaDescription=Welcome to the Android M Developer Preview, a program that gives you everything you need to test and optimize your apps for the next version of Android. +page.image=images/cards/card-preview_16-9_2x.png +page.tags="preview", "developer", "android" @jd:body <p> - The M Developer Preview program is an opportunity for you to test the compatibility of your apps - with the next platform release, try out early versions of new API features, and provide feedback - to the Android team. The program includes update releases during course of the program to allow - you to follow the progress of feature development and fixes, leading up to the official release - of the platform, as shown in Figure 1. + Welcome to the <strong>Android M Developer Preview</strong>, a program that gives you + everything you need to test and optimize your apps for the next version of + Android. It's free, and you can get started right away just by downloading + the M Developer Preview tools. </p> -<img src="{@docRoot}preview/images/m-preview-timeline.png" - alt="Preview program timeline" id="figure1" style="margin-top: 15px;"> -<p class="img-caption"> - <b>Figure 1.</b> Timeline for the M Developer Preview program. +<div style="background-color:#eceff1;padding:1em;"> +<div class="wrap"> + <div class="cols"> + <div class="col-4of12"> + <h5> + Hardware and emulator system images + </h5> + + <p> + Run and test your apps on Nexus 5, 6, 9, and Player (for TV), as well + as emulator. + </p> + </div> + + <div class="col-4of12"> + <h5> + Latest platform code + </h5> + + <p> + We’ll provide multiple updates during the Preview, so you’ll be testing + against the latest platform changes. + </p> + </div> + + <div class="col-4of12"> + <h5> + Updates delivered by OTA + </h5> + + <p> + You can get updates over the air, once you’ve flashed a + device to the initial preview. + </p> + </div> + </div> + + <div class="cols"> + +<!--<div class="col-4of12"> +<h5>Early access to new APIs</h5> +<p>Explore the new capabilities and APIs offered in the new platform and give us +feedback. Note that APIs and capabilities may change during the Preview +program.</p> +</div>--> + + <div class="col-4of12"> + <h5> + New behaviors and capabilities + </h5> + + <p> + Start work early to support new platform behaviors such as + the new runtime permissions model and power-saving features. + </p> + </div> + + <div class="col-4of12"> + <h5> + Priority window for developer-reported issues + </h5> + + <p> + During the first several weeks we’ll give priority to developer-reported + issues, so test and give feedback as soon as possible. + </p> + </div> + + <div class="col-4of12"> + <h5> + Feedback and support channels + </h5> + + <p> + Report issues and give us feedback using our <a href= + "https://code.google.com/p/android-developer-preview/">issue tracker</a>. + Connect with other developers in the <a + href="http://g.co/dev/AndroidMDevPreview">M Developer Community</a>. + </p> + </div> + </div> +</div> +</div> + +<!-- +<p> + With the M Developer Preview, you'll get an early start on testing your apps, + with enough time to make adjustments before the public platform release later + in the year. We'll provide several updates to the Preview tools in the weeks + ahead, so you can keep in sync with the latest changes as the platform moves + toward launch. </p> +<img src="{@docRoot}preview/images/m-preview-timeline.png" alt= +"Preview program timeline" id="timeline"> +<p> + You can help us improve the platform by <a href= + "https://code.google.com/p/android-developer-preview/">reporting issues</a> + through our feedback channels. This is especially + critical in the first month of the preview, when we’ll be giving priority to + developer-reported issues and feedback. +</p> --> + +<h2 id="timeline"> + Timeline and updates +</h2> +<img src="{@docRoot}preview/images/m-preview-timeline-crop.png" alt= +"Preview program timeline" id="timeline"> <p> - We strongly encourage you to provide feedback for the M Preview releases through our <a href= - "https://code.google.com/p/android-developer-preview/">issue tracker</a>. Issues reported early - in the program have a better chance of being addressed before the official release, so reports - provided by June 30, 2015 receive priority processing by the Android team. + The M Developer Preview runs from May 27 until the final Android M SDK, which + we’ll release shortly before the public release during Q3 + 2015. </p> <p> - To get started testing your app: + At key development milestones, we’ll deliver updates for your test devices. + The tentative milestones are </p> <ul> - <li>Review the <a href="{@docRoot}preview/api-overview.html"> - API Overview</a> and <a href= - "{@docRoot}preview/api-changes.html">Behavior Changes</a> to - get an idea of what's new and how it affects your app. + <li> + <strong>Preview 1</strong> (initial Preview release, late May), </li> - <li>Setup for testing and development by following the instructions for <a href= - "{@docRoot}preview/setup-sdk.html">Setting up the Preview - SDK</a> and configuring test devices. + <li> + <strong>Preview 2</strong> (late June/early July), and </li> - <li>Review the <a href="{@docRoot}preview/reference.html">M - Preview API Reference</a> and <a href= - "{@docRoot}preview/samples.html">M Preview samples</a> to - gain more insight into new API features and how to use them in your app. + <li> + <strong>Preview 3</strong> (near final, late July) </li> +</ul> + +<p> + These updates culminate in the <strong>final SDK</strong> (later in Q3), + which delivers the official APIs for the new version of Android, as well + as the final system behaviors and features. +</p> - <li>Join the <a href="https://plus.google.com/communities/101985907812750684586">M Preview - Google+ developer community</a> to get the latest developer updates and connect with other - developers working with the preview. +<p> + As you test and develop on Android M, we strongly recommend <strong>keeping + your development environment up-to-date</strong> as Preview updates are released. + To make the process easier, we'll deliver <strong>updates over the air + (OTA)</strong> to devices already flashed to a Preview build, as well as + providing system images that you can download and flash manually. +</p> +<p class="note"> + <strong>Note:</strong> The final SDK and system images can not be delivered + by OTA, but will instead need to be <strong>flashed manually</strong> to + your test devices.</strong> +</p> + +<p> + We’ll notify you when Preview updates are available via the <a href= + "http://android-developers.blogspot.com/">Android Developers Blog</a>, as + well as this site and the + <a href="http://g.co/dev/AndroidMDevPreview">Android M Developer Community</a>. +</p> + +<h2 id="preview_tools"> + What’s in the Preview? +</h2> + +<p> + The M Developer Preview includes everything you need to test your existing + apps on a variety of screen sizes, network technologies, CPU/GPU chipsets, + and hardware architectures. +</p> + +<h4> + SDK tools +</h4> + +<p> + You can download these components through the SDK Manager in <a href= + "{@docRoot}sdk/installing/adding-packages.html">Android Studio</a>: +</p> + +<ul> + <li>M Developer Preview <strong>SDK tools</strong> + </li> + + <li>M Developer Preview <strong>emulator system image</strong> (32-bit & + 64-bit) + </li> + + <li>M Developer Preview <strong>emulator system Image for Android TV</strong> + (32-bit) </li> </ul> +<h4> + Hardware system images +</h4> + <p> - Thanks in advance for your participation in the developer preview program! + You can download these hardware system images for Nexus devices from the + <a href="downloads.html">Downloads page</a>: </p> + +<ul> + <li> + <strong>Nexus 5</strong> (GSM/LTE) “hammerhead” device system image + </li> + + <li> + <strong>Nexus 6</strong> “shamu” device system image + </li> + + <li> + <strong>Nexus 9</strong> (Wi-Fi) “volantis” device system image + </li> + + <li> + <strong>Nexus Player</strong> (Android TV) “fugu” device system image + </li> +</ul> + +<h4> + Documentation and sample code +</h4> + +<p> + These documentation resources help you learn about the Preview: +</p> + +<ul> + <li> + <a href="setup-sdk.html">Set Up the SDK</a> has step-by-step instructions + for getting started. + </li> + + <li> + <a href="testing.html">Testing Guide</a> and <a href= + "api-changes.html">Behavior Changes</a> point you to key areas to test. + </li> + + <li>Documentation of new APIs, including an <a href="api-overview.html">API Overview</a>, + downloadable <a href="">API Reference</a>, and detailed developer guides on + key features such as <a href="">permissions</a>, <a href="">app backup</a>, + and others. + </li> + + <li> + <a href="">Sample code</a> that demonstrates how support + permissions and other new features. + </li> + + <li> + <a href="">Release notes</a> for the current version of the M Developer + Preview, including change notes and diff reports. + </li> +</ul> + +<h4> + Support resources +</h4> + +<p> + Use these support resources as you test and develop on the M + Developer Preview: +</p> + +<ul> + <li><a href="https://code.google.com/p/android-developer-preview/">M + Developer Preview Issue Tracker</a> is your <strong>primary feedback + channel.</strong> You can report bugs, performance issues, and general + feedback through the issue tracker. You can also check for known issues + and find workaround steps, if available. + </li> + + <li>The <a href="http://g.co/dev/AndroidMDevPreview">Android M Developer + Community</a> is a Google+ community where you can <strong>connect with + other developers</strong> working with Android M. You can share + observations or ideas or find answers to questions about Android M. + </li> +</ul> + + +<h2 id="preview_apis_and_publishing"> + Targeting, preview APIs, and publishing +</h2> + +<p> + The Android M Developer Preview is a development-only release and + <strong>does not have a standard API level</strong>. If you want to opt out + of compatibility behaviors to test your app (which is strongly recommended), + you can target the M Developer Preview by setting your app's <code><a href= + "/guide/topics/manifest/uses-sdk-element.html">targetSdkVersion</a></code> + to <code>“MNC”</code>. +</p> + +<p> + The Android M Developer Preview delivers <strong>preview APIs</strong> + — the APIs will not be official until the final SDK is released, + currently planned for the third quarter of 2015. This means that you can + <strong>expect minor API changes</strong> over time, especially during + initial weeks of the program. We’ll provide a summary of changes to you with + each update of the Android M Developer Preview. +</p> + +<p class="note"> + Note that although preview APIs may change, underlying system behaviors such + as runtime permissions and power-saving features are stable and ready for + testing right away. +</p> + +<p> + In terms of publishing, Google Play <strong>prevents publishing of apps + targeting the M Developer Preview</strong>. When the Android M final SDK is + available, you’ll be able to target the official Android M API level and + publish your app to Google Play. Meanwhile, if you want to distribute an app + targeting Android M to testers, you can do so via email or by direct download + from your site. +</p> + +<h2 id="get_started"> + How to get started? +</h2> + +<p> + To get started testing your app: +</p> + +<ol> + <li>Review the <a href="{@docRoot}preview/api-overview.html">API Overview</a> + and <a href="{@docRoot}preview/behavior.html">Behavior Changes</a> to get an + idea of what's new and how it affects your apps. + </li> + + <li>Setup for testing and development by following the instructions for + <a href="{@docRoot}preview/setup-sdk.html">Setting up the Preview SDK</a> + and configuring test devices. + </li> + + <li>Follow the <a href="https://developers.google.com/android/nexus/images"> + flashing instructions</a> to flash the latest M developer preview system image + for Nexus 5, 6, 9, and Player. Once you've flashed your development device, + Preview updates will be delivered through over-the-air (OTA) updates.</a> + </li> + + <li>Download the <a href="{@docRoot}preview/reference.html">M Preview API + Reference</a> and <a href="{@docRoot}preview/samples.html">M Preview + samples</a> to gain more insight into new API features and how to use them in + your app. + </li> + + <li>Join the <a href="http://g.co/dev/AndroidMDevPreview">Android M + Developer Community</a> to get the latest news and connect with other + developers working with the new platform. + </li> +</ol> + +<p> + Thank you for your participation in the Android M Developer Preview program! +</p>
\ No newline at end of file diff --git a/docs/html/preview/preview_toc.cs b/docs/html/preview/preview_toc.cs index fbf73f6..76dfef5 100644 --- a/docs/html/preview/preview_toc.cs +++ b/docs/html/preview/preview_toc.cs @@ -6,22 +6,44 @@ </li> <li class="nav-section"> + <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/download.html"> + Downloads</a></div> + </li> + + <li class="nav-section"> <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/setup-sdk.html"> Set up the SDK</a></div> </li> <li class="nav-section"> - <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/api-overview.html"> + <div class="nav-section-header"><a href="<?cs var:toroot ?>preview/testing/guide.html"> + Testing Guide</a></div> + <ul> + <li><a href="<?cs var:toroot ?>preview/testing/performance.html"> + Performance Testing</a></li> + </ul> + </li> + + <li class="nav-section"> + <div class="nav-section-header"><a href="<?cs var:toroot ?>preview/api-overview.html"> API Overview</a></div> + <ul> + <li><a href="<?cs var:toroot ?>preview/features/runtime-permissions.html"> + Runtime Permissions</a></li> + <li><a href="<?cs var:toroot ?>preview/features/app-linking.html"> + App Linking</a></li> + <li><a href="<?cs var:toroot ?>preview/backup/index.html"> + Automatic Backups</a></li> + </ul> </li> <li class="nav-section"> - <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/samples.html"> - Samples</a></div> + <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/behavior-changes.html"> + Behavior Changes</a></div> </li> <li class="nav-section"> - <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/reference.html"> - Reference</a></div> + <div class="nav-section-header empty"><a href="<?cs var:toroot ?>preview/samples.html"> + Samples</a></div> </li> <li class="nav-section"> diff --git a/docs/html/preview/reference.jd b/docs/html/preview/reference.jd deleted file mode 100644 index 2d30c62..0000000 --- a/docs/html/preview/reference.jd +++ /dev/null @@ -1,15 +0,0 @@ -page.title=Reference - -@jd:body - -<p> - The reference documentation and API difference report for the Developer Preview are available in - this downloadable package. -</p> - -<ul> - <li> - <a href="http://storage.googleapis.com/androiddevelopers/preview/m-developer-preview-reference.zip"> - M Developer Preview reference</a> - </li> -</ul>
\ No newline at end of file diff --git a/docs/html/preview/samples.jd b/docs/html/preview/samples.jd index fb80e30..21d4215 100644 --- a/docs/html/preview/samples.jd +++ b/docs/html/preview/samples.jd @@ -1,5 +1,5 @@ page.title=Samples - +page.image=images/cards/samples-new_2x.png @jd:body <p> @@ -7,31 +7,85 @@ page.title=Samples Android SDK Manager under the <b>SDK Samples</b> component for the M Developer Preview. </p> +<img src="{@docRoot}images/cards/card-google-cloud-messaging_16-9_2x" class="figure"> <p class="note"> <strong>Note:</strong> These downloadable projects are designed for use with Gradle and Android Studio. </p> -<h3 id="id">Sample 1</h3> +<h3 id="RuntimePermissions">Runtime Permissions</h3> + +<p> + Android M changes the way system permissions work. Users are asked to approve permission + requests at runtime instead of during installation. This sample shows how to request these + permissions. +</p> + +<p><a href="https://github.com/googlesamples/android-RuntimePermissions">Get it on GitHub</a></p> + +<h3 id="ConfirmCredentials">Confirm Device Credentials</h3> + +<p> + This sample demonstrates how to use device credentials as an authentication method in your app. +</p> + +<p><a href="https://github.com/googlesamples/android-ConfirmDeviceCredentials">Get it on +GitHub</a></p> + +<h3 id="FingerprintDialog">Fingerprint Dialog</h3> + +<p> + This sample demonstrates how to recognize registered fingerprints to authenticate the user + in your app. +</p> + +<p><a href="https://github.com/googlesamples/android-FingerprintDialog">Get it on GitHub</a></p> + +<h3 id="AutomaticBackup">Automatic Backup</h3> + +<p> + Android M introduces automatic backup for app settings. This sample demonstrates how to add + filtering rules to an app in order to manage settings backup. +</p> + +<p><a href="https://github.com/googlesamples/android-AutomaticBackup">Get it on GitHub</a></p> + +<h3 id="VoiceCamera">Voice Camera</h3> <p> - This sample demonstrates how to turducken frankfurter boudin, ham brisket alcatra kielbasa pork - loin pork. Jowl kielbasa kevin, sausage landjaeger corned beef cow spare ribs pastrami leberkas - drumstick. + This sample demonstrates how to implement the "OK Google, take a selfie" voice command and confirm + the user intent with the <code>VoiceInteraction</code> API. </p> -<p><a href="#">Get it on GitHub</a></p> +<p><a href="https://github.com/googlesamples/android-VoiceCamera">Get it on GitHub</a></p> + +<h3 id="CameraRaw">Camera 2 Raw</h3> + +<p> + Demonstrates how to use the <code>Camera2</code> API to capture RAW camera buffers and save + them as <code>DNG</code> files. +</p> + +<p><a href="https://github.com/googlesamples/android-Camera2Raw">Get it on GitHub</a></p> + +<h3 id="ActiveNotification">Active Notification</h3> + +<p> + This sample demonstrates how the + <a href="{@docRoot}reference/android/app/NotificationManager.html"><code>NotificationManager</code></a> + can tell you how many notifications your app is currently showing. +</p> +<p><a href="https://github.com/googlesamples/android-ActiveNotification">Get it on GitHub</a></p> -<h3 id="id">Sample 2</h3> +<h3 id="VoiceSynthesizer">Voice Synthesizer</h3> <p> - This sample demonstrates how to turducken frankfurter boudin, ham brisket alcatra kielbasa pork - loin pork. Jowl kielbasa kevin, sausage landjaeger corned beef cow spare ribs pastrami leberkas - drumstick. + This sample demonstrates how to use the <code>NativeAudio</code> APIs to demonstrate low-latency + audio processing. </p> -<p><a href="#">Get it on GitHub</a></p> +<p><a href="https://github.com/googlesamples/android-VoiceSynthesizer">Get it on GitHub</a></p> diff --git a/docs/html/preview/setup-sdk.jd b/docs/html/preview/setup-sdk.jd index 11b009e..f0def9b 100644 --- a/docs/html/preview/setup-sdk.jd +++ b/docs/html/preview/setup-sdk.jd @@ -1,272 +1,110 @@ -page.title=Setting Up the Preview SDK -@jd:body - - - - - - - -<div style="position:relative; min-height:600px"> - - <div class="wrap" id="tos" style="position:absolute;display:none;width:inherit;"> - - <p class="sdk-terms-intro">Before installing the Android SDK, you must agree to the following terms and conditions.</p> - - <h2 class="norule">Terms and Conditions</h2> - <div class="sdk-terms" onfocus="this.blur()" style="width:678px"> -This is the Android SDK Preview License Agreement (the “License Agreement”). - -1. Introduction - -1.1 The Android SDK Preview (referred to in the License Agreement as the “Preview” and specifically including the Android system files, packaged APIs, and Preview library files, if and when they are made available) is licensed to you subject to the terms of the License Agreement. The License Agreement forms a legally binding contract between you and Google in relation to your use of the Preview. - -1.2 "Android" means the Android software stack for devices, as made available under the Android Open Source Project, which is located at the following URL: http://source.android.com/, as updated from time to time. - -1.3 "Google" means Google Inc., a Delaware corporation with principal place of business at 1600 Amphitheatre Parkway, Mountain View, CA 94043, United States. - -2. Accepting the License Agreement - -2.1 In order to use the Preview, you must first agree to the License Agreement. You may not use the Preview if you do not accept the License Agreement. - -2.2 By clicking to accept and/or using the Preview, you hereby agree to the terms of the License Agreement. - -2.3 You may not use the Preview and may not accept the License Agreement if you are a person barred from receiving the Preview under the laws of the United States or other countries including the country in which you are resident or from which you use the Preview. - -2.4 If you will use the Preview internally within your company or organization you agree to be bound by the License Agreement on behalf of your employer or other entity, and you represent and warrant that you have full legal authority to bind your employer or such entity to the License Agreement. If you do not have the requisite authority, you may not accept the License Agreement or use the Preview on behalf of your employer or other entity. - -3. Preview License from Google - -3.1 Subject to the terms of the License Agreement, Google grants you a royalty-free, non-assignable, non-exclusive, non-sublicensable, limited, revocable license to use the Preview, personally or internally within your company or organization, solely to develop applications to run on the Android platform. - -3.2 You agree that Google or third parties owns all legal right, title and interest in and to the Preview, including any Intellectual Property Rights that subsist in the Preview. "Intellectual Property Rights" means any and all rights under patent law, copyright law, trade secret law, trademark law, and any and all other proprietary rights. Google reserves all rights not expressly granted to you. - -3.3 You may not use the Preview for any purpose not expressly permitted by the License Agreement. Except to the extent required by applicable third party licenses, you may not: (a) copy (except for backup purposes), modify, adapt, redistribute, decompile, reverse engineer, disassemble, or create derivative works of the Preview or any part of the Preview; or (b) load any part of the Preview onto a mobile handset or any other hardware device except a personal computer, combine any part of the Preview with other software, or distribute any software or device incorporating a part of the Preview. - -3.4 You agree that you will not take any actions that may cause or result in the fragmentation of Android, including but not limited to distributing, participating in the creation of, or promoting in any way a software development kit derived from the Preview. - -3.5 Use, reproduction and distribution of components of the Preview licensed under an open source software license are governed solely by the terms of that open source software license and not the License Agreement. You agree to remain a licensee in good standing in regard to such open source software licenses under all the rights granted and to refrain from any actions that may terminate, suspend, or breach such rights. - -3.6 You agree that the form and nature of the Preview that Google provides may change without prior notice to you and that future versions of the Preview may be incompatible with applications developed on previous versions of the Preview. You agree that Google may stop (permanently or temporarily) providing the Preview (or any features within the Preview) to you or to users generally at Google's sole discretion, without prior notice to you. - -3.7 Nothing in the License Agreement gives you a right to use any of Google's trade names, trademarks, service marks, logos, domain names, or other distinctive brand features. - -3.8 You agree that you will not remove, obscure, or alter any proprietary rights notices (including copyright and trademark notices) that may be affixed to or contained within the Preview. - -4. Use of the Preview by You - -4.1 Google agrees that nothing in the License Agreement gives Google any right, title or interest from you (or your licensors) under the License Agreement in or to any software applications that you develop using the Preview, including any intellectual property rights that subsist in those applications. - -4.2 You agree to use the Preview and write applications only for purposes that are permitted by (a) the License Agreement, and (b) any applicable law, regulation or generally accepted practices or guidelines in the relevant jurisdictions (including any laws regarding the export of data or software to and from the United States or other relevant countries). - -4.3 You agree that if you use the Preview to develop applications, you will protect the privacy and legal rights of users. If users provide you with user names, passwords, or other login information or personal information, you must make the users aware that the information will be available to your application, and you must provide legally adequate privacy notice and protection for those users. If your application stores personal or sensitive information provided by users, it must do so securely. If users provide you with Google Account information, your application may only use that information to access the user's Google Account when, and for the limited purposes for which, each user has given you permission to do so. - -4.4 You agree that you will not engage in any activity with the Preview, including the development or distribution of an application, that interferes with, disrupts, damages, or accesses in an unauthorized manner the servers, networks, or other properties or services of Google or any third party. - -4.5 You agree that you are solely responsible for (and that Google has no responsibility to you or to any third party for) any data, content, or resources that you create, transmit or display through Android and/or applications for Android, and for the consequences of your actions (including any loss or damage which Google may suffer) by doing so. - -4.6 You agree that you are solely responsible for (and that Google has no responsibility to you or to any third party for) any breach of your obligations under the License Agreement, any applicable third party contract or Terms of Service, or any applicable law or regulation, and for the consequences (including any loss or damage which Google or any third party may suffer) of any such breach. - -4.7 The Preview is in development, and your testing and feedback are an important part of the development process. By using the Preview, you acknowledge that implementation of some features are still under development and that you should not rely on the Preview having the full functionality of a stable release. You agree not to publicly distribute or ship any application using this Preview as this Preview will no longer be supported after the official Android SDK is released. - -5. Your Developer Credentials - -5.1 You agree that you are responsible for maintaining the confidentiality of any developer credentials that may be issued to you by Google or which you may choose yourself and that you will be solely responsible for all applications that are developed under your developer credentials. - -6. Privacy and Information - -6.1 In order to continually innovate and improve the Preview, Google may collect certain usage statistics from the software including but not limited to a unique identifier, associated IP address, version number of the software, and information on which tools and/or services in the Preview are being used and how they are being used. Before any of this information is collected, the Preview will notify you and seek your consent. If you withhold consent, the information will not be collected. - -6.2 The data collected is examined in the aggregate to improve the Preview and is maintained in accordance with Google's Privacy Policy located at http://www.google.com/policies/privacy/. - -7. Third Party Applications - -7.1 If you use the Preview to run applications developed by a third party or that access data, content or resources provided by a third party, you agree that Google is not responsible for those applications, data, content, or resources. You understand that all data, content or resources which you may access through such third party applications are the sole responsibility of the person from which they originated and that Google is not liable for any loss or damage that you may experience as a result of the use or access of any of those third party applications, data, content, or resources. - -7.2 You should be aware the data, content, and resources presented to you through such a third party application may be protected by intellectual property rights which are owned by the providers (or by other persons or companies on their behalf). You may not modify, rent, lease, loan, sell, distribute or create derivative works based on these data, content, or resources (either in whole or in part) unless you have been specifically given permission to do so by the relevant owners. - -7.3 You acknowledge that your use of such third party applications, data, content, or resources may be subject to separate terms between you and the relevant third party. - -8. Using Google APIs - -8.1 Google APIs - -8.1.1 If you use any API to retrieve data from Google, you acknowledge that the data may be protected by intellectual property rights which are owned by Google or those parties that provide the data (or by other persons or companies on their behalf). Your use of any such API may be subject to additional Terms of Service. You may not modify, rent, lease, loan, sell, distribute or create derivative works based on this data (either in whole or in part) unless allowed by the relevant Terms of Service. - -8.1.2 If you use any API to retrieve a user's data from Google, you acknowledge and agree that you shall retrieve data only with the user's explicit consent and only when, and for the limited purposes for which, the user has given you permission to do so. - -9. Terminating the License Agreement - -9.1 the License Agreement will continue to apply until terminated by either you or Google as set out below. - -9.2 If you want to terminate the License Agreement, you may do so by ceasing your use of the Preview and any relevant developer credentials. - -9.3 Google may at any time, terminate the License Agreement, with or without cause, upon notice to you. - -9.4 The License Agreement will automatically terminate without notice or other action upon the earlier of: -(A) when Google ceases to provide the Preview or certain parts of the Preview to users in the country in which you are resident or from which you use the service; and -(B) Google issues a final release version of the Android SDK. - -9.5 When the License Agreement is terminated, the license granted to you in the License Agreement will terminate, you will immediately cease all use of the Preview, and the provisions of paragraphs 10, 11, 12 and 14 shall survive indefinitely. - -10. DISCLAIMERS - -10.1 YOU EXPRESSLY UNDERSTAND AND AGREE THAT YOUR USE OF THE PREVIEW IS AT YOUR SOLE RISK AND THAT THE PREVIEW IS PROVIDED "AS IS" AND "AS AVAILABLE" WITHOUT WARRANTY OF ANY KIND FROM GOOGLE. - -10.2 YOUR USE OF THE PREVIEW AND ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE USE OF THE PREVIEW IS AT YOUR OWN DISCRETION AND RISK AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR COMPUTER SYSTEM OR OTHER DEVICE OR LOSS OF DATA THAT RESULTS FROM SUCH USE. WITHOUT LIMITING THE FOREGOING, YOU UNDERSTAND THAT THE PREVIEW IS NOT A STABLE RELEASE AND MAY CONTAIN ERRORS, DEFECTS AND SECURITY VULNERABILITIES THAT CAN RESULT IN SIGNIFICANT DAMAGE, INCLUDING THE COMPLETE, IRRECOVERABLE LOSS OF USE OF YOUR COMPUTER SYSTEM OR OTHER DEVICE. - -10.3 GOOGLE FURTHER EXPRESSLY DISCLAIMS ALL WARRANTIES AND CONDITIONS OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. - -11. LIMITATION OF LIABILITY - -11.1 YOU EXPRESSLY UNDERSTAND AND AGREE THAT GOOGLE, ITS SUBSIDIARIES AND AFFILIATES, AND ITS LICENSORS SHALL NOT BE LIABLE TO YOU UNDER ANY THEORY OF LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES THAT MAY BE INCURRED BY YOU, INCLUDING ANY LOSS OF DATA, WHETHER OR NOT GOOGLE OR ITS REPRESENTATIVES HAVE BEEN ADVISED OF OR SHOULD HAVE BEEN AWARE OF THE POSSIBILITY OF ANY SUCH LOSSES ARISING. - -12. Indemnification - -12.1 To the maximum extent permitted by law, you agree to defend, indemnify and hold harmless Google, its affiliates and their respective directors, officers, employees and agents from and against any and all claims, actions, suits or proceedings, as well as any and all losses, liabilities, damages, costs and expenses (including reasonable attorneys’ fees) arising out of or accruing from (a) your use of the Preview, (b) any application you develop on the Preview that infringes any Intellectual Property Rights of any person or defames any person or violates their rights of publicity or privacy, and (c) any non-compliance by you of the License Agreement. - -13. Changes to the License Agreement - -13.1 Google may make changes to the License Agreement as it distributes new versions of the Preview. When these changes are made, Google will make a new version of the License Agreement available on the website where the Preview is made available. - -14. General Legal Terms - -14.1 the License Agreement constitutes the whole legal agreement between you and Google and governs your use of the Preview (excluding any services which Google may provide to you under a separate written agreement), and completely replaces any prior agreements between you and Google in relation to the Preview. - -14.2 You agree that if Google does not exercise or enforce any legal right or remedy which is contained in the License Agreement (or which Google has the benefit of under any applicable law), this will not be taken to be a formal waiver of Google's rights and that those rights or remedies will still be available to Google. - -14.3 If any court of law, having the jurisdiction to decide on this matter, rules that any provision of the License Agreement is invalid, then that provision will be removed from the License Agreement without affecting the rest of the License Agreement. The remaining provisions of the License Agreement will continue to be valid and enforceable. - -14.4 You acknowledge and agree that each member of the group of companies of which Google is the parent shall be third party beneficiaries to the License Agreement and that such other companies shall be entitled to directly enforce, and rely upon, any provision of the License Agreement that confers a benefit on (or rights in favor of) them. Other than this, no other person or company shall be third party beneficiaries to the License Agreement. - -14.5 EXPORT RESTRICTIONS. THE PREVIEW IS SUBJECT TO UNITED STATES EXPORT LAWS AND REGULATIONS. YOU MUST COMPLY WITH ALL DOMESTIC AND INTERNATIONAL EXPORT LAWS AND REGULATIONS THAT APPLY TO THE PREVIEW. THESE LAWS INCLUDE RESTRICTIONS ON DESTINATIONS, END USERS AND END USE. - -14.6 The License Agreement may not be assigned or transferred by you without the prior written approval of Google, and any attempted assignment without such approval will be void. You shall not delegate your responsibilities or obligations under the License Agreement without the prior written approval of Google. - -14.7 The License Agreement, and your relationship with Google under the License Agreement, shall be governed by the laws of the State of California without regard to its conflict of laws provisions. You and Google agree to submit to the exclusive jurisdiction of the courts located within the county of Santa Clara, California to resolve any legal matter arising from the License Agreement. Notwithstanding this, you agree that Google shall still be allowed to apply for injunctive remedies (or an equivalent type of urgent legal relief) in any jurisdiction. - </div><!-- sdk terms --> - - - - <div id="sdk-terms-form"> - <p> - <input id="agree" type="checkbox" name="agree" value="1" onclick="onAgreeChecked()" /> - <label id="agreeLabel" for="agree">I have read and agree with the above terms and conditions</label> - </p> - <p><a href="" class="button disabled" id="downloadForRealz" onclick="return onDownloadForRealz(this);"></a></p> - </div> - - - </div><!-- end TOS --> - - - - - - +page.title=Set Up the Preview SDK +page.image=images/cards/card-set-up_16-9_2x.png +@jd:body - <div id="landing"> +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol> + <li><a href="#get-sdk">Get the Preview SDK</a></li> + <li><a href="#create-update">Create or Update a Project</a></li> + <li><a href="#setup-test">Set Up for Testing</a></li> + </ol> + </div> +</div> <p>The Preview SDK is available from the Android SDK Manager. This document assumes that you are familiar with Android app development, such -as using the Android SDK Manager and creating projects. If you're new to +as using the Android SDK Manager and creating projects. If you are new to Android, see <a href="{@docRoot}training/basics/firstapp/index.html">Building Your First App</a> training lesson first.</a></p> -<h2 id="downloadSdk">Download the SDK</h2> +<h2 id="get-sdk">Get the Preview SDK</h2> + +<p>To add the Android Preview SDK components to your development environment:</p> <ol> <li>Start the <a href="{@docRoot}tools/help/sdk-manager.html">Android SDK Manager</a>.</li> - <li>In the <b>Tools</b> section, select the latest Android <b>SDK Tools</b>, - <b>Platform-tools</b>, and <b>Build-tools</b>.</li> - <li>Select everything under the <b>Android M Developer Preview</b> section and - click <b>Install packages...</b></li> + <li>In the <strong>Tools</strong> section, select the latest Android <strong>SDK Tools</strong>, + <strong>Platform-tools</strong>, and <strong>Build-tools</strong>.</li> + <li>Select everything under the <strong>Android M Developer Preview</strong> section and + click <strong>Install packages...</strong></li> <li>Accept the Licensing Agreement for all of the packages and click - <b>Install</b>.</li> + <strong>Install</strong>.</li> </ol> -<p class="note"><strong>Note:</strong> The Eclipse ADT plug-in requires Java 7 - if your compilation target is the M Developer Preview.</p> +<p>After completing these steps, the preview components are available in your development + environment. </p> -<h2 id="setupHardware">Set Up Hardware and AVDs</h2> -<p>The Android M Developer Preview provides you with 32-bit system images -to flash the following devices: +<h2 id="create-update">Create or Update a Project</h2> + +<p> + In order to use the preview APIs, you must create or update a development project to use + the preview components. </p> -<ul> - <li>Nexus 5</li> - <li>Nexus 7 Wi-Fi (version 2, released in 2013)</li> -</ul> -<p>In addition, you also get the emulator system images, which includes -experimental 64-bit system images along with standard 32-bit system images. +<h3 id="create">Create a new project</h3> + +<p> + We recommend using Android Studio for create a project with the preview. Follow the steps + described in <a href="{@docRoot}sdk/installing/create-project.html">Creating a Project</a> + until you arrive at the <em>Form Factors</em> screen in the project wizard. Then perform + the following steps to create a project configured for the preview. </p> -<p class="note"><strong>Note:</strong> The 64-bit system images require the -Intel x86 Emulator Accelerator (HAXM) Rev.5 which can be downloaded from the -<a href="{@docRoot}tools/help/sdk-manager.html">SDK Manager</a> <em>Extras</em> -folder.</p> +<ul> + <li>Check <strong>Phone and Tablet</strong>.</li> + <li>Select <strong>API 22+: Android M (Preview)</strong> in <strong>Minimum SDK</strong>.</li> +</ul> -<h3 id="installImage">Install the M Preview System Image</h3> +<h3 id="update">Update an existing project</h3> -<p class="warning"><b>Warning:</b> This is a preview version of the Android -system image, and is subject to change. Your use of this system image is -governed by the Android SDK Preview License Agreement. The Android preview -system image is not a stable release, and may contain errors and defects that -can result in damage to your computer systems, devices, and data. The preview -Android system image is not subject to the same testing as the factory OS and -can cause your phone and installed services and applications to stop working. +<p> + For existing projects, you must modify the project configuration to enable the preview APIs. In + your the development environment, open the <code>build.gradle</code> file for your module and + set these values as follows: </p> +<ul> + <li><code>compileSdkVersion</code> is set to <code>'android-MNC'</code></li> + <li><code>minSdkVersion</code> is set to <code>'MNC'</code></li> + <li><code>targetSdkVersion</code> is set to <code>'MNC'</code></li> +</ul> -<ol> - <li>Download and uncompress the Android Developer Preview package. - <table style="width:860px"> - <tr> - <th scope="col">Device</th> - <th scope="col">Download</th> - <th scope="col">Checksum</th> - </tr> - <tr id="hammerhead"> - <td>Nexus 5 (GSM/LTE) <br>"hammerhead"</td> - <td><a href="#top" onclick="onDownload(this)" - >hammerhead-lpv79-preview-ac1d8a8e.tgz</a></td> - <td>MD5: <code>5a6ae77217978cb7b958a240c2e80b57</code> - <br>SHA-1: <code>ac1d8a8e4f4a1dca5864dc733caa940bffc28616</code></td> - </tr> - <tr id="razor"> - <td>Nexus 7 (Wifi) <br>"razor"</td> - <td><a href="#top" onclick="onDownload(this)" - >razor-lpv79-preview-d0ddf8ce.tgz</a></td> - <td>MD5: <code>b293a5d3a4e07beabebcc0be85ad68a2</code> - <br><nobr>SHA-1: <code>d0ddf8ce733ba2a34279cdff8827fd604762c2342d</nobr></td> - </tr> - </table> - </li> - <li>Follow the instructions at - <a href="https://developers.google.com/android/nexus/images#instructions">developers.google.com/android</a> - to flash the image onto your device.</li> -</ol> +<h2 id="setup-test">Set Up for Testing</h2> +<p> + Testing app with the preview requires that you have a device or virtual device configured with + the preview version of the platform. If you have a compatible device, you can install the preview + platform for testing. Otherwise, you can configure a virtual device for testing. +</p> -<h3 id="revertDevice">Revert a Device to Factory Specifications</h3> +<h3 id="setup-device">Set up a Physical Device</h3> - <p>If you want to uninstall the Preview and revert the device to factory -specifications, go to <a href="http://developers.google.com/android -/nexus/images">developers.google.com/android</a> and download the image you want -to flash to for your device. Follow the instructions on that page to flash the -image to your device.</p> +<p> + If you have a Nexus 5, Nexus 6, Nexus 9, or Nexus Player, you can install a preview + system image on these devices for testing your app. + You can set up virtual device with the preview version of the platform from within Android Studio + using the Android Virtual Device Manager tool. +</p> +<p class="caution"> + <strong>Important:</strong> Installing a preview image on a device <em>removes all data from + it</em>, so you should backup any data before installing a preview image. +</p> -<h3 id="setupAVD">Set up an AVD</h3> +<h3 id="setupAVD">Set up a Virtual Device</h3> -<p>You can set up <a href="{@docRoot}tools/devices/">Android Virtual Devices -(AVD)</a> and use the emulator to build and test apps with the M Preview.</p> +<p> + You can set up virtual device with the preview version of the platform from within Android Studio + using the Android Virtual Device Manager tool. +</p> <p>To create an AVD with the AVD Manager:</p> @@ -278,84 +116,14 @@ image to your device.</p> <a href="{@docRoot}tools/devices/managing-avds.html">Managing AVDs with AVD Manager</a>. Use the following settings: <ul> - <li><b>Device:</b> Either Nexus 5 or Nexus 7</li> - <li><b>Target:</b> <!-- Confirm exact text when we have final distro --> + <li><strong>Device:</strong> Nexus 5, Nexus 6, Nexus 9, or Nexus Player</li> + <li><strong>Target:</strong> Android M (Preview) - API Level M</li> </ul> - <!-- Confirm this works when you can download image through SDK manager! --> </li> </ol> - -<h2 id="createProject">Create a Project</h2> - -<p>Android Studio makes it easy to create a project for the M Developer Preview. Follow -the steps described in <a href="{@docRoot}sdk/installing/create-project.html">Creating a -Project</a>. In the <strong>Form Factors</strong> screen:</p> - -<ul> - <li>Check <strong>Phone and Tablet</strong>.</li> - <li>Select <strong>API 22+: Android M (Preview)</strong> in <strong>Minimum SDK</strong>.</li> -</ul> - -<p>On the development environment, open the <code>build.gradle</code> file for your module -and make sure that:</p> - -<ul> - <li><code>compileSdkVersion</code> is set to <code>'android-M'</code></li> - <li><code>minSdkVersion</code> is set to <code>'M'</code></li> - <li><code>targetSdkVersion</code> is set to <code>'M'</code></li> -</ul> - - </div><!-- landing --> - -</div><!-- relative wrapper --> - - - -<script> - var urlRoot = "http://storage.googleapis.com/androiddevelopers/preview/"; - function onDownload(link) { - - $("#downloadForRealz").html("Download " + $(link).text()); - $("#downloadForRealz").attr('href', urlRoot + $(link).text()); - - $("#tos").fadeIn('fast'); - $("#landing").fadeOut('fast'); - - return true; - } - - - function onAgreeChecked() { - /* verify that the TOS is agreed */ - if ($("input#agree").is(":checked")) { - /* reveal the download button */ - $("a#downloadForRealz").removeClass('disabled'); - } else { - $("a#downloadForRealz").addClass('disabled'); - } - } - - function onDownloadForRealz(link) { - if ($("input#agree").is(':checked')) { - $("#tos").fadeOut('fast'); - $("#landing").fadeIn('fast'); - ga('send', 'event', 'M Preview', 'System Image', $("#downloadForRealz").html()); - location.hash = ""; - return true; - } else { - $("label#agreeLabel").parent().stop().animate({color: "#258AAF"}, 200, - function() {$("label#agreeLabel").parent().stop().animate({color: "#222"}, 200)} - ); - return false; - } - } - - $(window).hashchange( function(){ - if (location.hash == "") { - location.reload(); - } - }); - -</script> +<p> + For more information about creating virtual devices for testing, see <a href= + "{@docRoot}tools/devices/index.html">Managing Virtual Devices</a>. +</p> diff --git a/docs/html/preview/support.jd b/docs/html/preview/support.jd index 4be6dd7..3ed1487 100644 --- a/docs/html/preview/support.jd +++ b/docs/html/preview/support.jd @@ -1,4 +1,5 @@ page.title=Support +page.image=images/cards/card-support_16-9_2x.png @jd:body diff --git a/docs/html/preview/testing/guide.jd b/docs/html/preview/testing/guide.jd new file mode 100644 index 0000000..1879268 --- /dev/null +++ b/docs/html/preview/testing/guide.jd @@ -0,0 +1,176 @@ +page.title=Testing Guide +page.image=images/cards/card-set-up_16-9_2x.png + +@jd:body + +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol> + <li><a href="#runtime-permissions">Testing Runtime Permissions</a></li> + <li><a href="#doze-standby">Testing Doze and App Standby</a></li> + </ol> + </div> +</div> + +<p> + The Android M Developer Preview gives you an opportunity to ensure your apps work with the next + version of the platform. This preview includes a number of APIs and behavior changes that can + impact your app, as described in the <a href="{@docRoot}preview/api-overview.html">API + Overview</a> and <a href="{@docRoot}preview/api-changes.html">Behavior Changes</a>. In testing + your app with the preview, there are some specific system changes that you should focus on to + ensure that users have a good experience. +</p> + +<p> + This guide describes the what and how to test preview features with your app. You should + prioritize testing of these specific preview features, due to their high potential impact on your + app's behavior: +</p> + +<ul> + <li><a href="#runtime-permissions">Runtime Permissions</a> + </li> + <li><a href="#doze-mode">Doze and App Standby</a> + </li> +</ul> + +<p> + For more information about how to set up devices or virtual devices with a preview system image + for testing, see <a href="{@docRoot}preview/setup-sdk.html">Set up the Preview SDK</a>. +</p> + + +<h2 id="runtime-permissions">Testing Runtime Permissions</h2> + +<p> + The <a href="{@docRoot}preview/features/runtime-permissions.html">Runtime Permissions</a> feature + changes the way that permissions are allocated to your app by the user. Instead of granting all + permissions during the install procedure, your app must ask the user for individual permissions + at runtime. For users this behavior provides more granular control over each app’s activities, as + well as better context for understanding why the app is requesting a specific permission. Users + can grant or revoke the permissions granted to an app individually at any time. This feature of + the preview is most likely to have an impact on your app's behavior and may prevent some of your + app features from working, or they may work in a degraded state. +</p> + +<p> + This change that affects all apps running on the new platform, even those not targeting the new + platform version. The platform provides a limited compatibility behavior for legacy apps, but you + should begin planning your app’s migration to the new permissions model now, with a goal of + publishing an updated version of your app at the official platform launch. +</p> + + +<h3 id="permission-test-tips">Test tips</h3> + +<p> + Use the following test tips to help you plan and execute testing of your app with the new + permissions behavior. +</p> + +<ul> + <li>Identify your app’s current permissions and the related code paths.</li> + <li>Test user flows across permission-protected services and data.</li> + <li>Test with various combinations of granted/revoked permission.</li> + <li>Use the {@code adb} tool to manage permssions from the command line: + <ul> + <li>List permissions and status by group: + <pre>adb shell pm list permissions -d -g</pre> + </li> + <li>Grant or revoke one or more permissions using the following syntax:<br> + <pre>adb shell pm [grant|revoke] <permission.name> ...</pre> + </li> + </ul> + </li> + <li>Analyze your app for services that use permissions.</li> +</ul> + +<h3 id="permission-test-strategy">Test strategy</h3> + +<p> + The Runtime Permissions change affects the structure and design of your app, as well as + the user experience and flows you provide to users. You should assess your app’s current + permissions use and start planning for the new flows you want to offer. The official release of + the platform provides compatibility behavior, but you should plan on updating your app and not + rely on these behaviors. +</p> + +<p> + Identify the permissions that your app actually needs and uses, and then find the various code + paths that use the permission-protected services. You can do this through a combination of + testing on the new platform and code analysis. In testing, you should focus on opting in to + runtime permissions by changing the app’s {@code targetSdkVersion} to the preview version. For + more information, see <a href="{@docRoot}preview/setup-sdk.html#">Set up the Preview SDK</a>. +</p> + +<p> + Test with various combinations of permissions revoked and added, to highlight the user flows that + depend on permissions. Where a dependency is not obvious or logical you should consider + refactoring or compartmentalizing that flow to eliminate the dependency or make it clear why the + permission is needed. +</p> + +<p> + For more information on the behavior of Runtime Permissions, testing, and best practices, see the + <a href="{@docRoot}preview/features/runtime-permissions.html">Runtime Permissions</a> developer + preview page. +</p> + + +<h2 id="doze-standby">Testing Doze and App Standby</h2> + +<p> + The power saving features of Doze and App Standby limits the amount of background processing that + your app can perform when a device is in an idle state or while your app is not in focus. The + restrictions the system may impose on apps include limited or no network access, + suspended background tasks, suspended Notifications, ignored wake requests, and alarms. To ensure + that your app behaves properly with these power saving optimizations, you should test your app by + simulating these low power states. +</p> + +<h4 id="doze">Testing your app with Doze</h4> + +<p>To test Doze with your app:</p> + +<ol> +<li>Configure a hardware device or virtual device with a M Preview system image.</li> +<li>Connect the device to your development machine and install your app.</li> +<li>Run your app and leave it active.</li> +<li>Simulate the device going into Doze mode by running the following commands: + +<pre> +$ adb shell dumpsys battery unplug +$ adb shell dumpsys deviceidle step +$ adb shell dumpsys deviceidle -h +</pre> + + </li> + <li>Observe the behavior of your app when the device is re-activated. Make sure it + recovers gracefully when the device exits Doze.</li> +</ol> + + +<h4 id="standby">Testing apps with App Standby</h4> + +<p>To test the App Standby mode with your app:</p> + +<ol> + <li>Configure a hardware device or virtual device with a M Preview system image.</li> + <li>Connect the device to your development machine and install your app.</li> + <li>Run your app and leave it active.</li> + <li>Simulate the app going into standby mode by running the following commands: + +<pre> +$ adb shell am broadcast -a android.os.action.DISCHARGING +$ adb shell am set-idle <packageName> true +</pre> + + </li> + <li>Simulate waking your app using the following command: + <pre>$ adb shell am set-idle <packageName> false</pre> + </li> + <li>Observe the behavior of your app when it is woken. Make sure it recovers gracefully + from standby mode. In particular, you should check if your app's Notifications and background + jobs continue to function as expected.</li> +</ol> diff --git a/docs/html/preview/testing/performance.jd b/docs/html/preview/testing/performance.jd new file mode 100644 index 0000000..a61091f --- /dev/null +++ b/docs/html/preview/testing/performance.jd @@ -0,0 +1,667 @@ +page.title=Testing Display Performance + +@jd:body + + +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol> + <li><a href="#measure">Measuring UI Performance</a> + <ul> + <li><a href="#aggregate">Aggregate frame stats</a></li> + <li><a href="#timing-info">Precise frame timing info</a></li> + <li><a href="#timing-dump">Simple frame timing dump</a></li> + <li><a href="#collection-window">Controlling the window of stat collection</a></li> + <li><a href="#diagnose">Diagnosing performance regressions</a></li> + <li><a href="#resources">Additional resources</a></li> + </ul> + </li> + <li><a href="#automate">Automating UI Perfomance Tests</a> + <ul> + <li><a href="#ui-tests">Setting up UI tests</a></li> + <li><a href="#automated-tests">Setting up automated UI testing</a></li> + <li><a href="#triage">Triaging and fixing observed problems</a></li> + </ul> + </li> + </ol> + </div> +</div> + + +<p> + User interface (UI) performance testing ensures that your app not only meets its functional + requirements, but that user interactions with your app are buttery smooth, running at a + consistent 60 frames per second (<a href= + "https://www.youtube.com/watch?v=CaMTIgxCSqU&index=25&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">why + 60fps?</a>), without any dropped or delayed frames, or as we like to call it, <em>jank</em>. This + document explains tools available to measure UI performance, and lays out an approach to + integrate UI performance measurements into your testing practices. +</p> + + +<h2 id="measure">Measuring UI Performance</h2> + +<p> + In order to improve performance you first need the ability to measure the performance of + your system, and then diagnose and identify problems that may arrive from various parts of your + pipeline. +</p> + +<p> + <em><a href="https://source.android.com/devices/tech/debug/dumpsys.html">dumpsys</a></em> is an + Android tool that runs on the device and dumps interesting information about the status of system + services. Passing the <em>gfxinfo</em> command to dumpsys provides an output in logcat with + performance information relating to frames of animation that are occurring during the recording + phase. +</p> + +<pre> +> adb shell dumpsys gfxinfo <PACKAGE_NAME> +</pre> + +<p> + This command can produce multiple different variants of frame timing data. +</p> + +<h3 id="aggregate">Aggregate frame stats</h3> + +<p> + With the M Preview the command prints out aggregated analysis of frame data to logcat, collected + across the entire lifetime of the process. For example: +</p> + +<pre class="noprettyprint"> +Stats since: 752958278148ns +Total frames rendered: 82189 +Janky frames: 35335 (42.99%) +90th percentile: 34ms +95th percentile: 42ms +99th percentile: 69ms +Number Missed Vsync: 4706 +Number High input latency: 142 +Number Slow UI thread: 17270 +Number Slow bitmap uploads: 1542 +Number Slow draw: 23342 +</pre> + +<p> + These high level statistics convey at a high level the rendering performance of the app, as well + as its stability across many frames. +</p> + + +<h3 id="timing-info">Precise frame timing info</h3> + +<p> + With the M Preview comes a new command for gfxinfo, and that’s <em>framestats</em> which provides + extremely detailed frame timing information from recent frames, so that you can track down and + debug problems more accurately. +</p> + +<pre> +>adb shell dumpsys gfxinfo <PACKAGE_NAME> framestats +</pre> + +<p> + This command prints out frame timing information, with nanosecond timestamps, from the last 120 + frames produced by the app. Below is example raw output from adb dumpsys gfxinfo + <PACKAGE_NAME> framestats: +</p> + +<pre class="noprettyprint"> +0,49762224585003,49762241251670,9223372036854775807,0,49762257627204,49762257646058,49762257969704,49762258002100,49762265541631,49762273951162,49762300914808,49762303675954, +0,49762445152142,49762445152142,9223372036854775807,0,49762446678818,49762446705589,49762447268818,49762447388037,49762453551527,49762457134131,49762474889027,49762476150120, +0,49762462118845,49762462118845,9223372036854775807,0,49762462595381,49762462619287,49762462919964,49762462968454,49762476194547,49762476483454,49762480214964,49762480911527, +0,49762479085548,49762479085548,9223372036854775807,0,49762480066370,49762480099339,49762481013089,49762481085850,49762482232152,49762482478350,49762485657620,49762486116683, +</pre> + +<p> + Each line of this output represents a frame produced by the app. Each line has a fixed number of + columns describing time spent in each stage of the frame-producing pipeline. The next section + describes this format in detail, including what each column represents. +</p> + + +<h4 id="fs-data-format">Framestats data format</h4> + +<p> + Since the block of data is output in CSV format, it's very straightforward to paste it to your + spreadsheet tool of choice, or collect and parse with a script. The following table explains the + format of the output data columns. All timestamps are in nanoseconds. +</p> + +<ul> + <li>FLAGS + <ul> + <li>Rows with a ‘0’ for the FLAGS column can have their total frame time computed by + subtracting the INTENDED_VSYNC column from the FRAME_COMPLETED column. + </li> + + <li>If this is non-zero the row should be ignored, as the frame has been determined as being + an outlier from normal performance, where it is expected that layout & draw take longer + than 16ms. Here are a few reasons this could occur: + <ul> + <li>The window layout changed (such as the first frame of the application or after a + rotation) + </li> + + <li>It is also possible the frame was skipped in which case some of the values will have + garbage timestamps. A frame can be skipped if for example it is out-running 60fps or if + nothing on-screen ended up being dirty, this is not necessarily a sign of a problem in + the app. + </li> + </ul> + </li> + </ul> + </li> + + <li>VSYNC + <ul> + <li>The time value that was used in all the vsync listeners and drawing for the frame + (Choreographer frame callbacks, animations, View.getDrawingTime(), etc…) + </li> + + <li>To understand more about VSYNC and how it influences your application, check out the + <a href= + "https://www.youtube.com/watch?v=1iaHxmfZGGc&list=PLOU2XLYxmsIKEOXh5TwZEv89aofHzNCiu&index=23"> + Understanding VSYNC</a> video. + </li> + </ul> + </li> + + + <li>INTENDED_VSYNC + <ul> + <li>The intended start point for the frame. If this value is different from VSYNC, there + was work occurring on the UI thread that prevented it from responding to the vsync signal + in a timely fashion. + </li> + </ul> + </li> + + <li>OLDEST_INPUT_EVENT + <ul> + <li>The timestamp of the oldest input event in the input queue, or Long.MAX_VALUE if + there were no input events for the frame. + </li> + + <li>This value is primarily intended for platform work and has limited usefulness to app + developers. + </li> + </ul> + </li> + + <li>NEWEST_INPUT_EVENT + <ul> + <li>The timestamp of the newest input event in the input queue, or 0 if there were no + input events for the frame. + </li> + + <li>This value is primarily intended for platform work and has limited usefulness to app + developers. + </li> + + <li>However it’s possible to get a rough idea of how much latency the app is adding by + looking at (FRAME_COMPLETED - NEWEST_INPUT_EVENT). + </li> + </ul> + </li> + + <li>HANDLE_INPUT_START + <ul> + <li>The timestamp at which input events were dispatched to the application. + </li> + + <li>By looking at the time between this and ANIMATION_START it is possible to measure how + long the application spent handling input events. + </li> + + <li>If this number is high (>2ms), this indicates the app is spending an unusually + long time processing input events, such as View.onTouchEvent(), which may indicate this + work needs to be optimized, or offloaded to a different thread. Note that there are some + scenarios, such as click events that launch new activities or similar, where it is + expected and acceptable that this number is large. + </li> + </ul> + </li> + + <li>ANIMATION_START + <ul> + <li>The timestamp at which animations registered with Choreographer were run. + </li> + + <li>By looking at the time between this and PERFORM_TRANVERSALS_START it is possible to + determine how long it took to evaluate all the animators (ObjectAnimator, + ViewPropertyAnimator, and Transitions being the common ones) that are running. + </li> + + <li>If this number is high (>2ms), check to see if your app has written any custom + animators or what fields ObjectAnimators are animating and ensure they are appropriate + for an animation. + </li> + + <li>To learn more about Choreographer, check out the <a href= + "https://developers.google.com/events/io/sessions/325418001">For Butter or Worse</a> + video. + </li> + </ul> + </li> + + <li>PERFORM_TRAVERSALS_START + <ul> + <li>If you subtract out DRAW_START from this value, you can extract how long the layout + & measure phases took to complete. (note, during a scroll, or animation, you would + hope this should be close to zero..) + </li> + + <li>To learn more about the measure & layout phases of the rendering pipeline, check + out the <a href= + "https://www.youtube.com/watch?v=we6poP0kw6E&list=PLOU2XLYxmsIKEOXh5TwZEv89aofHzNCiu&index=27"> + Invalidations, Layouts and Performance</a> video + </li> + </ul> + </li> + + <li>DRAW_START + <ul> + <li>The time at which the draw phase of performTraversals started. This is the start + point of recording the display lists of any views that were invalidated. + </li> + + <li>The time between this and SYNC_START is how long it took to call View.draw() on all + the invalidated views in the tree. + </li> + + <li>For more information on the drawing model, see <a href= + "{@docRoot}guide/topics/graphics/hardware-accel.html#hardware-model">Hardware Acceleration</a> + or the <a href= + "https://www.youtube.com/watch?v=we6poP0kw6E&list=PLOU2XLYxmsIKEOXh5TwZEv89aofHzNCiu&index=27"> + Invalidations, Layouts and Performance</a> video + </li> + </ul> + </li> + + <li>SYNC_START + <ul> + <li>The time at which the sync phase of the drawing started. + </li> + + <li>If the time between this and ISSUE_DRAW_COMMANDS_START is substantial (>0.4ms or + so), it typically indicates a lot of new Bitmaps were drawn which must be uploaded to the + GPU. + </li> + + <li>To understand more about the sync phase, check out the <a href= + "https://www.youtube.com/watch?v=VzYkVL1n4M8&index=24&list=PLOU2XLYxmsIKEOXh5TwZEv89aofHzNCiu"> + Profile GPU Rendering</a> video + </li> + </ul> + </li> + + <li>ISSUE_DRAW_COMMANDS_START + <ul> + <li>The time at which the hardware renderer started issuing drawing commands to the GPU. + </li> + + <li>The time between this and FRAME_COMPLETED gives a rough idea of how much GPU work the + app is producing. Problems like too much overdraw or inefficient rendering effects show + up here. + </li> + </ul> + </li> + + <li>SWAP_BUFFERS + <ul> + <li>The time at which eglSwapBuffers was called, relatively uninteresting outside of + platform work. + </li> + </ul> + </li> + + <li>FRAME_COMPLETED + <ul> + <li>All done! The total time spent working on this frame can be computed by doing + FRAME_COMPLETED - INTENDED_VSYNC. + </li> + </ul> + </li> + +</ul> + +<p> + You can use this data in different ways. One simple but useful visualization is a + histogram showing the distribution of frames times (FRAME_COMPLETED - INTENDED_VSYNC) in + different latency buckets, see figure below. This graph tells us at a glance that most + frames were very good - well below the 16ms deadline (depicted in red), but a few frames + were significantly over the deadline. We can look at changes in this histogram over time + to see wholesale shifts or new outliers being created. You can also graph input latency, + time spent in layout, or other similar interesting metrics based on the many timestamps + in the data. +</p> + +<img src="{@docRoot}preview/images/perf-test-framestats.png"> + + +<h3 id="timing-dump">Simple frame timing dump</h3> + +<p> + If <strong>Profile GPU rendering</strong> is set to <strong>In adb shell dumpsys gfxinfo</strong> + in Developer Options, the <code>adb shell dumpsys gfxinfo</code> command prints out timing + information for the most recent 120 frames, broken into a few different categories with + tab-separated-values. This data can be useful for indicating which parts of the drawing pipeline + may be slow at a high level. +</p> + +<p> + Similar to <a href="#fs-data-format">framestats</a> above, it's very + straightforward to paste it to your spreadsheet tool of choice, or collect and parse with + a script. The following graph shows a breakdown of where many frames produced by the app + were spending their time. +</p> + +<img src="{@docRoot}preview/images/perf-test-frame-latency.png"> + +<p> + The result of running gfxinfo, copying the output, pasting it into a spreadsheet + application, and graphing the data as stacked bars. +</p> + +<p> + Each vertical bar represents one frame of animation; its height represents the number of + milliseconds it took to compute that frame of animation. Each colored segment of the bar + represents a different stage of the rendering pipeline, so that you can see what parts of + your application may be creating a bottleneck. For more information on understanding the + rendering pipeline, and how to optimize for it, see the <a href= + "https://www.youtube.com/watch?v=we6poP0kw6E&index=27&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE"> + Invalidations Layouts and Performance</a> video. +</p> + + +<h3 id="collection-window">Controlling the window of stat collection</h3> + +<p> + Both the framestats and simple frame timings gather data over a very short window - about + two seconds worth of rendering. In order to precisely control this window of time - for + example, to constrain the data to a particular animation - you can reset all counters, + and aggregate statistics gathered. +</p> + +<pre> +>adb shell dumpsys gfxinfo <PACKAGE_NAME> reset +</pre> + +<p> + This can also be used in conjunction with the dumping commands themselves to collect and + reset at a regular cadence, capturing less-than-two-second windows of frames + continuously. +</p> + + +<h3 id="diagnose">Diagnosing performance regressions</h3> + +<p> + Identification of regressions is a good first step to tracking down problems, and + maintaining high application health. However, dumpsys just identifies the existence and + relative severity of problems. You still need to diagnose the particular cause of the + performance problems, and find appropriate ways to fix them. For that, it’s highly + recommended to use the <a href="{@docRoot}tools/help/systrace.html">systrace</a> tool. +</p> + + +<h3 id="resources">Additional resources</h3> + +<p> + For more information on how Android’s rendering pipeline works, common problems that you + can find there, and how to fix them, some of the following resources may be useful to + you: +</p> + +<ul> + <li>Rendering Performance 101 + </li> + <li>Why 60fps? + </li> + <li>Android UI and the GPU + </li> + <li>Invalidations Layouts and performance + </li> + <li>Analyzing UI Performance with Systrace + </li> +</ul> + + +<h2 id="automate">Automating UI Perfomance Tests</h2> + +<p> + One approach to UI Performance testing is to simply have a human tester perform a set of + user operations on the target app, and either visually look for jank, or spend an very + large amount of time using a tool-driven approach to find it. But this manual approach is + fraught with peril - human ability to perceive frame rate changes varies tremendously, + and this is also time consuming, tedious, and error prone. +</p> + +<p> + A more efficient approach is to log and analyze key performance metrics from automated UI + tests. The Android M developer preview includes new logging capabilities which make it + easy to determine the amount and severity of jank in your application’s animations, and + that can be used to build a rigorous process to determine your current performance and + track future performance objectives. +</p> + +<p> + This article walks you through a recommended approach to using that data to automate your + performance testing. +</p> + +<p> + This is mostly broken down into two key actions. Firstly, identifying what you're + testing, and how you’re testing it. and Secondly, setting up, and maintaining an + automated testing environment. +</p> + + +<h3 id="ui-tests">Setting up UI tests</h3> + +<p> + Before you can get started with automated testing, it’s important to determine a few high + level decisions, in order to properly understand your test space, and needs you may have. +</p> + +<h4> + Identify key animations / flows to test +</h4> + +<p> + Remember that bad performance is most visible to users when it interrupts a smooth + animation. As such, when identifying what types of UI actions to test for, it’s useful to + focus on the key animations that users see most, or are most important to their + experience. For example, here are some common scenarios that may be useful to identify: +</p> + +<ul> + <li>Scrolling a primary ListView or RecyclerView + </li> + + <li>Animations during async wait cycles + </li> + + <li>Any animation that may have bitmap loading / manipulation in it + </li> + + <li>Animations including Alpha Blending + </li> + + <li>Custom View drawing with Canvas + </li> +</ul> + +<p> + Work with engineers, designers, and product managers on your team to prioritize these key + product animations for test coverage. +</p> + +<h4> + Define your future objectives and track against them +</h4> + +<p> + From a high-level, it may be critical to identify your specific performance goals, and + focus on writing tests, and collecting data around them. For example: +</p> + +<ul> + <li>Do you just want to begin tracking UI performance for the first time to learn more? + </li> + + <li>Do you want to prevent regressions that might be introduced in the future? + </li> + + <li>Are you at 90% of smooth frames today and want to get to 98% this quarter? + </li> + + <li>Are you at 98% smooth frames and don’t want to regress? + </li> + + <li>Is your goal to improve performance on low end devices? + </li> +</ul> + +<p> + In all of these cases, you’ll want historical tracking which shows performance across + multiple versions of your application. +</p> + +<h4> + Identify devices to test on +</h4> + +<p> + Application performance varies depending on the device it's running on. Some devices may + contain less memory, less powerful GPUs, or slower CPU chips. This means that animations + which may perform well on one set of hardware, may not on others, and worse, may be a + result of a bottleneck in a different part of the pipeline. So, to account for this + variation in what a user might see, pick a range of devices to execute tests on, both + current high end devices, low end devices, tablets, etc. Look for variation in CPU + performance, RAM, screen density, size, and so on. Tests that pass on a high end device + may fail on a low end device. +</p> + +<h4> + Basic frameworks for UI Testing +</h4> + +<p> + Tool suites like <a href= + "https://developer.android.com/tools/testing-support-library/index.html">UIAutomator</a>, + and <a href="https://code.google.com/p/android-test-kit/">Espresso</a> are built to help + automate the action of a user moving through your application. These are simple + frameworks which mimic user interaction with your device. To use these frameworks, you + effectively create unique scripts, which run through a set of user-actions, and play them + out on the device itself. +</p> + +<p> + By combining these automated tests, alongside <code>dumpsys gfxinfo</code> you can quickly + create a reproducible system that allows you to execute a test, and measure the + performance information of that particular condition. +</p> + + +<h3 id="automated-tests">Setting up automated UI testing</h3> + +<p> + Once you have the ability to execute a UI test, and a pipeline to gather the data from a + single test, the next important step is to embrace a framework which can execute that + test multiple times, across multiple devices, and aggregate the resulting performance + data for further analysis by your development team. +</p> + +<h4> + A framework for test automation +</h4> + +<p> + It’s worth noting that UI testing frameworks (like <a href= + "https://developer.android.com/tools/testing-support-library/index.html">UIAutomator</a>) + run on the target device/emulator directly. While performance gathering information done + by <em>dumpsys gfxinfo</em> is driven by a host machine, sending commands over ADB. To + help bridge the automation of these separate entities, <a href= + "{@docRoot}tools/help/monkeyrunner_concepts.html">MonkeyRunner</a> framework was + developed; A scripting system that runs on your host machine, which can issue commands to + a set of connected devices, as well as receive data from them. +</p> + +<p> + Building a set of scripts for proper Automation of UI Performance testing, at a minimum, + should be able to utilize monkeyRunner to accomplish the following tasks: +</p> + +<ul> + <li>Load & Launch a desired APK to a target device, devices, or emulator. + </li> + + <li>Launch a UIAutomator UI test, and allow it to be executed + </li> + + <li>Collect performance information through <em>dumpsys gfxinfo</em><em>.</em> + </li> + + <li>Aggregate information and display it back in a useful fashion to the developer. + </li> +</ul> + + +<h3 id="triage">Triaging and fixing observed problems</h3> + +<p> + Once problem patterns or regressions are identified, the next step is identifying and + applying the fix. If your automated test framework preserves precise timing breakdowns + for frames, it can help you scrutinize recent suspicious code/layout changes (in the case + of regression), or narrow down the part of the system you’re analyzing when you switch to + manual investigation. For manual investigation, <a href= + "{@docRoot}tools/help/systrace.html">systrace</a> is a great place to start, showing + precise timing information about every stage of the rendering pipeline, every thread and + core in the system, as well as any custom event markers you define. +</p> + +<h4> + Properly profiling temporal timings +</h4> + +<p> + It is important to note the difficulties in obtaining and measuring timings that come from + rendering performance. These numbers are, by nature, non deterministic, and often + fluctuate depending on the state of the system, amount of memory available, thermal + throttling, and the last time a sun flare hit your area of the earth. The point is that + you can run the same test, twice and get slightly different numbers that may be close to + each other, but not exact. +</p> + +<p> + Properly gathering and profiling data in this manner means running the same test, + multiple times, and accumulating the results as an average, or median value. (for the + sake of simplicity, let’s call this a ‘batch’) This gives you the rough approximation of + the performance of the test, while not needing exact timings. +</p> + +<p> + Batches can be used between code changes to see the relative impact of those changes on + performance. If the average frame rate for the pre-change Batch is larger than the + post-change batch, then you generally have an overall win wrt performance for that + particular change. +</p> + +<p> + This means that any Automated UI testing you do should take this concept into + consideration, and also account for any anomalies that might occur during a test. For + example, if your application performance suddenly dips, due to some device issue (that + isn’t caused by your application) then you may want to re-run the batch in order to get + less chaotic timings. +</p> + +<p> + So, how many times should you run a test, before the measurements become meaningful? 10 + times should be the minimum, with higher numbers like 50 or 100 yielding more accurate + results (of course, you’re now trading off time for accuracy) +</p> |
