blob: 8de4739207d9ce43e63b1520add5baa1e80f9284 [file] [log] [blame]
Scott Main95e7df92013-09-13 12:55:20 -07001page.title=<uses-sdk>
Scott Main1cd65b32013-05-06 16:51:39 -07002page.tags="api levels","sdk version","minsdkversion","targetsdkversion","maxsdkversion"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003@jd:body
4
Scott Main50e990c2012-06-21 17:14:39 -07005
6<div id="qv-wrapper">
7<div id="qv">
8
9<h2>In this document</h2>
10<ol>
11 <li><a href="#ApiLevels">What is API Level?</a></li>
12 <li><a href="#uses">Uses of API Level in Android</a></li>
13 <li><a href="#considerations">Development Considerations</a>
14 <ol>
15 <li><a href="#fc">Application forward compatibility</a></li>
16 <li><a href="#bc">Application backward compatibility</a></li>
17 <li><a href="#platform">Selecting a platform version and API Level</a></li>
18 <li><a href="#apilevel">Declaring a minimum API Level</a></li>
19 <li><a href="#testing">Testing against higher API Levels</a></li>
20 </ol>
21 </li>
22 <li><a href="#provisional">Using a Provisional API Level</a></li>
23 <li><a href="#filtering">Filtering the Reference Documentation by API Level</a></li>
24</ol>
25</div>
26</div>
27
Joe Fernandez8119f872013-02-13 14:03:27 -080028<div class="sidebox-wrapper">
Dirk Dougherty2b286bb2012-11-29 17:25:09 -080029<div class="sidebox">
Joe Fernandez8119f872013-02-13 14:03:27 -080030 <img src="{@docRoot}assets/images/icon_play.png" style="float:left;margin:0;padding:0;">
31 <p style="color:#669999;padding-top:1em;">Google Play Filtering</p>
Dirk Dougherty2b286bb2012-11-29 17:25:09 -080032 <p style="padding-top:1em;">Google Play uses the <code>&lt;uses-sdk&gt;</code>
Joe Fernandez8119f872013-02-13 14:03:27 -080033 attributes declared in your app manifest to filter your app from devices
Dirk Dougherty2b286bb2012-11-29 17:25:09 -080034 that do not meet it's platform version requirements. Before setting these
Joe Fernandez8119f872013-02-13 14:03:27 -080035 attributes, make sure that you understand
Dirk Dougherty2b286bb2012-11-29 17:25:09 -080036 <a href="{@docRoot}google/play/filters.html">Google Play filters</a>. </p>
37 </div>
38</div>
39
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080040<dl class="xml">
41<dt>syntax:</dt>
Scott Main4e60d012009-09-01 16:17:36 -070042<dd><pre>
Joe Fernandez8119f872013-02-13 14:03:27 -080043&lt;uses-sdk android:<a href="#min">minSdkVersion</a>="<i>integer</i>"
Dirk Dougherty7500f342009-12-01 16:45:14 -080044 android:<a href="#target">targetSdkVersion</a>="<i>integer</i>"
45 android:<a href="#max">maxSdkVersion</a>="<i>integer</i>" /&gt;</pre></dd>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080046
47<dt>contained in:</dt>
48<dd><code><a href="{@docRoot}guide/topics/manifest/manifest-element.html">&lt;manifest&gt;</a></code></dd>
49
50<dt>description:</dt>
Scott Main135d2332009-04-14 17:21:49 -070051<dd>Lets you express an application's compatibility with one or more versions of the Android platform,
52by means of an API Level integer. The API Level expressed by an application will be compared to the
Scott Main71d4b282009-08-13 12:45:31 -070053API Level of a given Android system, which may vary among different Android devices.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080054</p>
55
Dirk Dougherty7500f342009-12-01 16:45:14 -080056<p>Despite its name, this element is used to specify the API Level, <em>not</em>
Joe Fernandez8119f872013-02-13 14:03:27 -080057the version number of the SDK (software development kit) or Android platform.
Dirk Dougherty7500f342009-12-01 16:45:14 -080058The API Level is always a single integer. You cannot derive the API Level from
59its associated Android version number (for example, it is not the same as the
60major version or the sum of the major and minor versions).</p>
Scott Main135d2332009-04-14 17:21:49 -070061
Scott Main50e990c2012-06-21 17:14:39 -070062<p>Also read the document about
63<a href="{@docRoot}tools/publishing/versioning.html">Versioning Your Applications</a>.
Joe Fernandez8119f872013-02-13 14:03:27 -080064</p></dd>
Scott Main135d2332009-04-14 17:21:49 -070065
Scott Main71d4b282009-08-13 12:45:31 -070066<dt>attributes:</dt>
67
68<dd>
69<dl class="attr">
70 <dt><a name="min"></a>{@code android:minSdkVersion}</dt>
Scott Maind56760c2009-09-10 13:54:48 -070071 <dd>An integer designating the minimum API Level required
72 for the application to run. The Android system will prevent the user from installing
73 the application if the system's API Level is lower than the value specified in
74 this attribute. You should always declare this attribute.
Dirk Dougherty7500f342009-12-01 16:45:14 -080075
76 <p class="caution"><strong>Caution:</strong> If you do not declare this
77 attribute, the system assumes a default value of "1", which indicates that your
78 application is compatible with all versions of Android. If your application is
79 <em>not</em> compatible with all versions (for instance, it uses APIs introduced
Scott Maind4eb6822012-01-11 12:14:32 -080080 in API Level 3) and you have not declared the proper <code>minSdkVersion</code>,
Dirk Dougherty7500f342009-12-01 16:45:14 -080081 then when installed on a system with an API Level less than 3, the application
82 will crash during runtime when attempting to access the unavailable APIs. For
83 this reason, be certain to declare the appropriate API Level in the
84 <code>minSdkVersion</code> attribute.</p>
Scott Main71d4b282009-08-13 12:45:31 -070085 </dd>
Dirk Dougherty7500f342009-12-01 16:45:14 -080086
Scott Main71d4b282009-08-13 12:45:31 -070087 <dt><a name="target"></a>{@code android:targetSdkVersion}</dt>
Scott Maind4eb6822012-01-11 12:14:32 -080088 <dd>An integer designating the API Level that the application targets. If not set, the default
89value equals that given to {@code minSdkVersion}.
Dirk Dougherty7500f342009-12-01 16:45:14 -080090
Scott Maind4eb6822012-01-11 12:14:32 -080091 <p>This attribute informs the system that you have tested against the target version and the
92system should not enable any compatibility behaviors to maintain your app's forward-compatibility
93with the target version. The application is still able to run on older versions (down to {@code
94minSdkVersion}).</p>
95
96 <p>As Android evolves with each new version, some behaviors and even appearances might change.
97However, if the API level of the platform is higher than the version declared by your app's {@code
98targetSdkVersion}, the system may enable compatibility behaviors to ensure that your app
99continues to work the way you expect. You can disable such compatibility
100behaviors by specifying {@code targetSdkVersion} to match the API
101level of the platform on which it's running. For example, setting this value to "11" or higher
102allows the system to apply a new default theme (Holo) to your app when running on Android 3.0 or
103higher and also disables <a href="{@docRoot}guide/practices/screen-compat-mode.html">screen
104compatibility mode</a> when running on larger screens (because support for API level 11 implicitly
105supports larger screens).</p>
106
107 <p>There are many compatibility behaviors that the system may enable based on the value you set
108for this attribute. Several of these behaviors are described by the corresponding platform versions
109in the {@link android.os.Build.VERSION_CODES} reference.</p>
110
111 <p>To maintain your application along with each Android release, you should increase
112the value of this attribute to match the latest API level, then thoroughly test your application on
113the corresponding platform version.</p>
Dirk Dougherty7500f342009-12-01 16:45:14 -0800114
Scott Main71d4b282009-08-13 12:45:31 -0700115 <p>Introduced in: API Level 4</p>
116 </dd>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800117
Dirk Dougherty7500f342009-12-01 16:45:14 -0800118 <dt><a name="max"></a>{@code android:maxSdkVersion}</dt>
Joe Fernandez8119f872013-02-13 14:03:27 -0800119 <dd>An integer designating the maximum API Level on which the application is
120 designed to run.
Dirk Dougherty7500f342009-12-01 16:45:14 -0800121
122 <p>In Android 1.5, 1.6, 2.0, and 2.0.1, the system checks the value of this
Scott Maind4eb6822012-01-11 12:14:32 -0800123 attribute when installing an application and when re-validating the application
Dirk Dougherty7500f342009-12-01 16:45:14 -0800124 after a system update. In either case, if the application's
Scott Maind4eb6822012-01-11 12:14:32 -0800125 <code>maxSdkVersion</code> attribute is lower than the API Level used by
Dirk Dougherty7500f342009-12-01 16:45:14 -0800126 the system itself, then the system will not allow the application to be
Scott Maind4eb6822012-01-11 12:14:32 -0800127 installed. In the case of re-validation after system update, this effectively
Dirk Dougherty7500f342009-12-01 16:45:14 -0800128 removes your application from the device.
129
130 <p>To illustrate how this attribute can affect your application after system
131 updates, consider the following example: </p>
132
Scott Maind4eb6822012-01-11 12:14:32 -0800133 <p>An application declaring <code>maxSdkVersion="5"</code> in its
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -0800134 manifest is published on Google Play. A user whose device is running Android
Dirk Dougherty7500f342009-12-01 16:45:14 -0800135 1.6 (API Level 4) downloads and installs the app. After a few weeks, the user
136 receives an over-the-air system update to Android 2.0 (API Level 5). After the
137 update is installed, the system checks the application's
Scott Maind4eb6822012-01-11 12:14:32 -0800138 <code>maxSdkVersion</code> and successfully re-validates it. The
Dirk Dougherty7500f342009-12-01 16:45:14 -0800139 application functions as normal. However, some time later, the device receives
140 another system update, this time to Android 2.0.1 (API Level 6). After the
Scott Maind4eb6822012-01-11 12:14:32 -0800141 update, the system can no longer re-validate the application because the system's
Dirk Dougherty7500f342009-12-01 16:45:14 -0800142 own API Level (6) is now higher than the maximum supported by the application
143 (5). The system prevents the application from being visible to the user, in
144 effect removing it from the device.</p>
145
146 <p class="warning"><strong>Warning:</strong> Declaring this attribute is not
147 recommended. First, there is no need to set the attribute as means of blocking
148 deployment of your application onto new versions of the Android platform as they
149 are released. By design, new versions of the platform are fully
150 backward-compatible. Your application should work properly on new versions,
151 provided it uses only standard APIs and follows development best practices.
152 Second, note that in some cases, declaring the attribute can <strong>result in
153 your application being removed from users' devices after a system
Scott Maind4eb6822012-01-11 12:14:32 -0800154 update</strong> to a higher API Level. Most devices on which your application
Dirk Dougherty7500f342009-12-01 16:45:14 -0800155 is likely to be installed will receive periodic system updates over the air, so
156 you should consider their effect on your application before setting this
157 attribute.</p>
158
159 <p style="margin-bottom:1em;">Introduced in: API Level 4</p>
160
161 <div class="special">Future versions of Android (beyond Android 2.0.1) will no
Scott Maind4eb6822012-01-11 12:14:32 -0800162longer check or enforce the <code>maxSdkVersion</code> attribute during
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -0800163installation or re-validation. Google Play will continue to use the attribute
Dirk Dougherty7500f342009-12-01 16:45:14 -0800164as a filter, however, when presenting users with applications available for
165download. </div>
166 </dd>
Joe Fernandez8119f872013-02-13 14:03:27 -0800167
Dirk Dougherty7500f342009-12-01 16:45:14 -0800168
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800169</dl></dd>
170
Dirk Doughertydc523122009-04-16 14:28:14 -0700171<!-- ##api level indication## -->
172<dt>introduced in:</dt>
173<dd>API Level 1</dd>
174
175</dl>
Scott Main50e990c2012-06-21 17:14:39 -0700176
177
178
179
180
181<!--- CONTENT FROM OLD API LEVEL DOC ---->
182
183
184
185
186<h2 id="ApiLevels">What is API Level?</h2>
187
188<p>API Level is an integer value that uniquely identifies the framework API
189revision offered by a version of the Android platform.</p>
190
191<p>The Android platform provides a framework API that applications can use to
192interact with the underlying Android system. The framework API consists of:</p>
193
194<ul>
195<li>A core set of packages and classes</li>
196<li>A set of XML elements and attributes for declaring a manifest file</li>
197<li>A set of XML elements and attributes for declaring and accessing resources</li>
198<li>A set of Intents</li>
199<li>A set of permissions that applications can request, as well as permission
200enforcements included in the system</li>
201</ul>
202
203<p>Each successive version of the Android platform can include updates to the
204Android application framework API that it delivers. </p>
205
206<p>Updates to the framework API are designed so that the new API remains
207compatible with earlier versions of the API. That is, most changes in the API
208are additive and introduce new or replacement functionality. As parts of the API
209are upgraded, the older replaced parts are deprecated but are not removed, so
210that existing applications can still use them. In a very small number of cases,
211parts of the API may be modified or removed, although typically such changes are
212only needed to ensure API robustness and application or system security. All
213other API parts from earlier revisions are carried forward without
214modification.</p>
215
216<p>The framework API that an Android platform delivers is specified using an
217integer identifier called "API Level". Each Android platform version supports
218exactly one API Level, although support is implicit for all earlier API Levels
Joe Fernandez8119f872013-02-13 14:03:27 -0800219(down to API Level 1). The initial release of the Android platform provided
Scott Main50e990c2012-06-21 17:14:39 -0700220API Level 1 and subsequent releases have incremented the API Level.</p>
221
Dirk Dougherty2b286bb2012-11-29 17:25:09 -0800222<p>The table below specifies the API Level supported by each version of the
223Android platform. For information about the relative numbers of devices that
224are running each version, see the <a href="{@docRoot}about/dashboards/index.html">Platform
225Versions dashboards page</a>.</p>
Scott Main50e990c2012-06-21 17:14:39 -0700226
227<table>
228 <tr><th>Platform Version</th><th>API Level</th><th>VERSION_CODE</th><th>Notes</th></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800229
Joe Fernandez24a18f42013-10-23 09:47:07 -0700230 <tr><td><a href="{@docRoot}about/versions/android-4.4.html">Android 4.4</a></td>
231 <td><a href="{@docRoot}sdk/api_diff/19/changes.html" title="Diff Report">19</a></td>
232 <td>{@link android.os.Build.VERSION_CODES#KITKAT}</td>
233 <td><a href="{@docRoot}about/versions/kitkat.html">Platform
234Highlights</a></td></tr>
235
Joe Fernandezb5fff752013-06-14 11:53:33 -0700236 <tr><td><a href="{@docRoot}about/versions/android-4.3.html">Android 4.3</a></td>
237 <td><a href="{@docRoot}sdk/api_diff/18/changes.html" title="Diff Report">18</a></td>
238 <td>{@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}</td>
239 <td><a href="{@docRoot}about/versions/jelly-bean.html">Platform
240Highlights</a></td></tr>
241
Joe Fernandez8119f872013-02-13 14:03:27 -0800242 <tr><td><a href="{@docRoot}about/versions/android-4.2.html">Android 4.2, 4.2.2</a></td>
Dirk Dougherty2b286bb2012-11-29 17:25:09 -0800243 <td><a href="{@docRoot}sdk/api_diff/17/changes.html" title="Diff Report">17</a></td>
244 <td>{@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}</td>
Dirk Dougherty3ab04702013-07-07 14:10:16 -0700245 <td><a href="{@docRoot}about/versions/jelly-bean.html#android-42">Platform
Dirk Dougherty2b286bb2012-11-29 17:25:09 -0800246Highlights</a></td></tr>
247
Joe Fernandezcd940ef2012-07-17 16:45:58 -0700248 <tr><td><a href="{@docRoot}about/versions/android-4.1.html">Android 4.1, 4.1.1</a></td>
249 <td><a href="{@docRoot}sdk/api_diff/16/changes.html" title="Diff Report">16</a></td>
250 <td>{@link android.os.Build.VERSION_CODES#JELLY_BEAN}</td>
Dirk Dougherty3ab04702013-07-07 14:10:16 -0700251 <td><a href="{@docRoot}about/versions/jelly-bean.html#android-41">Platform
Joe Fernandezcd940ef2012-07-17 16:45:58 -0700252Highlights</a></td></tr>
253
254 <tr><td><a href="{@docRoot}about/versions/android-4.0.3.html">Android 4.0.3, 4.0.4</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700255 <td><a href="{@docRoot}sdk/api_diff/15/changes.html" title="Diff Report">15</a></td>
256 <td>{@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1}</td>
257 <td rowspan="2"><a href="{@docRoot}about/versions/android-4.0-highlights.html">Platform
258Highlights</a></td></tr>
259
260 <tr><td><a href="{@docRoot}about/versions/android-4.0.html">Android 4.0, 4.0.1, 4.0.2</a></td>
261 <td><a href="{@docRoot}sdk/api_diff/14/changes.html" title="Diff Report">14</a></td>
262 <td>{@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}</td>
263 </tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800264
Scott Main50e990c2012-06-21 17:14:39 -0700265 <tr><td><a href="{@docRoot}about/versions/android-3.2.html">Android 3.2</a></td>
266 <td><a href="{@docRoot}sdk/api_diff/13/changes.html" title="Diff Report">13</a></td>
267 <td>{@link android.os.Build.VERSION_CODES#HONEYCOMB_MR2}</td>
268 <td><!-- <a href="{@docRoot}about/versions/android-3.2-highlights.html">Platform
269Highlights</a>--></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800270
Scott Main50e990c2012-06-21 17:14:39 -0700271 <tr><td><a href="{@docRoot}about/versions/android-3.1.html">Android 3.1.x</a></td>
272 <td><a href="{@docRoot}sdk/api_diff/12/changes.html" title="Diff Report">12</a></td>
273 <td>{@link android.os.Build.VERSION_CODES#HONEYCOMB_MR1}</td>
274 <td><a href="{@docRoot}about/versions/android-3.1-highlights.html">Platform Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800275
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800276 <tr><td><a href="{@docRoot}about/versions/android-3.0.html">Android 3.0.x</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700277 <td><a href="{@docRoot}sdk/api_diff/11/changes.html" title="Diff Report">11</a></td>
278 <td>{@link android.os.Build.VERSION_CODES#HONEYCOMB}</td>
279 <td><a href="{@docRoot}about/versions/android-3.0-highlights.html">Platform Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800280
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800281 <tr><td><a href="{@docRoot}about/versions/android-2.3.3.html">Android 2.3.4<br>Android 2.3.3</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700282 <td><a href="{@docRoot}sdk/api_diff/10/changes.html" title="Diff Report">10</a></td>
283 <td>{@link android.os.Build.VERSION_CODES#GINGERBREAD_MR1}</td>
284 <td rowspan="2"><a href="{@docRoot}about/versions/android-2.3-highlights.html">Platform
285Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800286
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800287 <tr><td><a href="{@docRoot}about/versions/android-2.3.html">Android 2.3.2<br>Android 2.3.1<br>
288 Android 2.3</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700289 <td><a href="{@docRoot}sdk/api_diff/9/changes.html" title="Diff Report">9</a></td>
290 <td>{@link android.os.Build.VERSION_CODES#GINGERBREAD}</td>
291 </tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800292
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800293 <tr><td><a href="{@docRoot}about/versions/android-2.2.html">Android 2.2.x</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700294 <td ><a href="{@docRoot}sdk/api_diff/8/changes.html" title="Diff Report">8</a></td>
295 <td>{@link android.os.Build.VERSION_CODES#FROYO}</td>
296 <td><a href="{@docRoot}about/versions/android-2.2-highlights.html">Platform Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800297
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800298 <tr><td><a href="{@docRoot}about/versions/android-2.1.html">Android 2.1.x</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700299 <td><a href="{@docRoot}sdk/api_diff/7/changes.html" title="Diff Report">7</a></td>
300 <td>{@link android.os.Build.VERSION_CODES#ECLAIR_MR1}</td>
301 <td rowspan="3" ><a href="{@docRoot}about/versions/android-2.0-highlights.html">Platform
302Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800303
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800304 <tr><td><a href="{@docRoot}about/versions/android-2.0.1.html">Android 2.0.1</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700305 <td><a href="{@docRoot}sdk/api_diff/6/changes.html" title="Diff Report">6</a></td>
306 <td>{@link android.os.Build.VERSION_CODES#ECLAIR_0_1}</td>
307 </tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800308
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800309 <tr><td><a href="{@docRoot}about/versions/android-2.0.html">Android 2.0</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700310 <td><a href="{@docRoot}sdk/api_diff/5/changes.html" title="Diff Report">5</a></td>
311 <td>{@link android.os.Build.VERSION_CODES#ECLAIR}</td>
312 </tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800313
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800314 <tr><td><a href="{@docRoot}about/versions/android-1.6.html">Android 1.6</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700315 <td><a href="{@docRoot}sdk/api_diff/4/changes.html" title="Diff Report">4</a></td>
316 <td>{@link android.os.Build.VERSION_CODES#DONUT}</td>
317 <td><a href="{@docRoot}about/versions/android-1.6-highlights.html">Platform Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800318
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800319 <tr><td><a href="{@docRoot}about/versions/android-1.5.html">Android 1.5</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700320 <td><a href="{@docRoot}sdk/api_diff/3/changes.html" title="Diff Report">3</a></td>
321 <td>{@link android.os.Build.VERSION_CODES#CUPCAKE}</td>
322 <td><a href="{@docRoot}about/versions/android-1.5-highlights.html">Platform Highlights</a></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800323
Joe Fernandez3ffaadc2013-11-20 15:53:39 -0800324 <tr><td><a href="{@docRoot}about/versions/android-1.1.html">Android 1.1</a></td>
Scott Main50e990c2012-06-21 17:14:39 -0700325 <td>2</td>
326 <td>{@link android.os.Build.VERSION_CODES#BASE_1_1}</td><td></td></tr>
Joe Fernandez8119f872013-02-13 14:03:27 -0800327
Scott Main50e990c2012-06-21 17:14:39 -0700328 <tr><td>Android 1.0</td>
329 <td>1</td>
330 <td>{@link android.os.Build.VERSION_CODES#BASE}</td>
331 <td></td></tr>
332</table>
333
334
335<h2 id="uses">Uses of API Level in Android</h2>
336
337<p>The API Level identifier serves a key role in ensuring the best possible
Joe Fernandez8119f872013-02-13 14:03:27 -0800338experience for users and application developers:
Scott Main50e990c2012-06-21 17:14:39 -0700339
340<ul>
Joe Fernandez8119f872013-02-13 14:03:27 -0800341<li>It lets the Android platform describe the maximum framework API revision
Scott Main50e990c2012-06-21 17:14:39 -0700342that it supports</li>
343<li>It lets applications describe the framework API revision that they
344require</li>
345<li>It lets the system negotiate the installation of applications on the user's
346device, such that version-incompatible applications are not installed.</li>
347</ul>
348
349<p>Each Android platform version stores its API Level identifier internally, in
350the Android system itself. </p>
351
352<p>Applications can use a manifest element provided by the framework API &mdash;
353<code>&lt;uses-sdk&gt;</code> &mdash; to describe the minimum and maximum API
354Levels under which they are able to run, as well as the preferred API Level that
355they are designed to support. The element offers three key attributes:</p>
356
357<ul>
358<li><code>android:minSdkVersion</code> &mdash; Specifies the minimum API Level
359on which the application is able to run. The default value is "1".</li>
360<li><code>android:targetSdkVersion</code> &mdash; Specifies the API Level
361on which the application is designed to run. In some cases, this allows the
362application to use manifest elements or behaviors defined in the target
Joe Fernandez8119f872013-02-13 14:03:27 -0800363API Level, rather than being restricted to using only those defined
Scott Main50e990c2012-06-21 17:14:39 -0700364for the minimum API Level.</li>
365<li><code>android:maxSdkVersion</code> &mdash; Specifies the maximum API Level
366on which the application is able to run. <strong>Important:</strong> Please read the <a
367href="{@docRoot}guide/topics/manifest/uses-sdk-element.html"><code>&lt;uses-sdk&gt;</code></a>
368documentation before using this attribute. </li>
369</ul>
370
371<p>For example, to specify the minimum system API Level that an application
372requires in order to run, the application would include in its manifest a
373<code>&lt;uses-sdk&gt;</code> element with a <code>android:minSdkVersion</code>
374attribute. The value of <code>android:minSdkVersion</code> would be the integer
375corresponding to the API Level of the earliest version of the Android platform
376under which the application can run. </p>
377
378<p>When the user attempts to install an application, or when revalidating an
379appplication after a system update, the Android system first checks the
380<code>&lt;uses-sdk&gt;</code> attributes in the application's manifest and
381compares the values against its own internal API Level. The system allows the
382installation to begin only if these conditions are met:</p>
383
384<ul>
385<li>If a <code>android:minSdkVersion</code> attribute is declared, its value
386must be less than or equal to the system's API Level integer. If not declared,
387the system assumes that the application requires API Level 1. </li>
388<li>If a <code>android:maxSdkVersion</code> attribute is declared, its value
Joe Fernandez8119f872013-02-13 14:03:27 -0800389must be equal to or greater than the system's API Level integer.
Scott Main50e990c2012-06-21 17:14:39 -0700390If not declared, the system assumes that the application
391has no maximum API Level. Please read the <a
392href="{@docRoot}guide/topics/manifest/uses-sdk-element.html"><code>&lt;uses-sdk&gt;</code></a>
393documentation for more information about how the system handles this attribute.</li>
394</ul>
395
396<p>When declared in an application's manifest, a <code>&lt;uses-sdk&gt;</code>
397element might look like this: </p>
398
399<pre>&lt;manifest&gt;
400 &lt;uses-sdk android:minSdkVersion="5" /&gt;
401 ...
402&lt;/manifest&gt;</pre>
403
404<p>The principal reason that an application would declare an API Level in
405<code>android:minSdkVersion</code> is to tell the Android system that it is
406using APIs that were <em>introduced</em> in the API Level specified. If the
407application were to be somehow installed on a platform with a lower API Level,
408then it would crash at run-time when it tried to access APIs that don't exist.
409The system prevents such an outcome by not allowing the application to be
410installed if the lowest API Level it requires is higher than that of the
411platform version on the target device.</p>
412
413<p>For example, the {@link android.appwidget} package was introduced with API
414Level 3. If an application uses that API, it must declare a
415<code>android:minSdkVersion</code> attribute with a value of "3". The
416application will then be installable on platforms such as Android 1.5 (API Level
4173) and Android 1.6 (API Level 4), but not on the Android 1.1 (API Level 2) and
418Android 1.0 platforms (API Level 1).</p>
419
420<p>For more information about how to specify an application's API Level
421requirements, see the <a
422href="{@docRoot}guide/topics/manifest/uses-sdk-element.html"><code>&lt;uses-sdk&gt;</code></a>
423 section of the manifest file documentation.</p>
424
425
426<h2 id="considerations">Development Considerations</h2>
427
428<p>The sections below provide information related to API level that you should
429consider when developing your application.</p>
430
431<h3 id="fc">Application forward compatibility</h3>
432
433<p>Android applications are generally forward-compatible with new versions of
434the Android platform.</p>
435
436<p>Because almost all changes to the framework API are additive, an Android
437application developed using any given version of the API (as specified by its
438API Level) is forward-compatible with later versions of the Android platform and
439higher API levels. The application should be able to run on all later versions
440of the Android platform, except in isolated cases where the application uses a
441part of the API that is later removed for some reason. </p>
442
443<p>Forward compatibility is important because many Android-powered devices
444receive over-the-air (OTA) system updates. The user may install your
445application and use it successfully, then later receive an OTA update to a new
446version of the Android platform. Once the update is installed, your application
447will run in a new run-time version of the environment, but one that has the API
448and system capabilities that your application depends on. </p>
449
450<p>In some cases, changes <em>below</em> the API, such those in the underlying
451system itself, may affect your application when it is run in the new
452environment. For that reason it's important for you, as the application
453developer, to understand how the application will look and behave in each system
454environment. To help you test your application on various versions of the Android
455platform, the Android SDK includes multiple platforms that you can download.
456Each platform includes a compatible system image that you can run in an AVD, to
457test your application. </p>
458
459<h3 id="bc">Application backward compatibility</h3>
460
461<p>Android applications are not necessarily backward compatible with versions of
462the Android platform older than the version against which they were compiled.
463</p>
464
465<p>Each new version of the Android platform can include new framework APIs, such
466as those that give applications access to new platform capabilities or replace
467existing API parts. The new APIs are accessible to applications when running on
468the new platform and, as mentioned above, also when running on later versions of
469the platform, as specified by API Level. Conversely, because earlier versions of
470the platform do not include the new APIs, applications that use the new APIs are
471unable to run on those platforms.</p>
472
473<p>Although it's unlikely that an Android-powered device would be downgraded to
474a previous version of the platform, it's important to realize that there are
475likely to be many devices in the field that run earlier versions of the
476platform. Even among devices that receive OTA updates, some might lag and
477might not receive an update for a significant amount of time. </p>
478
479<h3 id="platform">Selecting a platform version and API Level</h3>
480
481<p>When you are developing your application, you will need to choose
482the platform version against which you will compile the application. In
483general, you should compile your application against the lowest possible
Joe Fernandez8119f872013-02-13 14:03:27 -0800484version of the platform that your application can support.
Scott Main50e990c2012-06-21 17:14:39 -0700485
486<p>You can determine the lowest possible platform version by compiling the
487application against successively lower build targets. After you determine the
488lowest version, you should create an AVD using the corresponding platform
489version (and API Level) and fully test your application. Make sure to declare a
490<code>android:minSdkVersion</code> attribute in the application's manifest and
491set its value to the API Level of the platform version. </p>
492
493<h3 id="apilevel">Declaring a minimum API Level</h3>
494
495<p>If you build an application that uses APIs or system features introduced in
496the latest platform version, you should set the
497<code>android:minSdkVersion</code> attribute to the API Level of the latest
498platform version. This ensures that users will only be able to install your
499application if their devices are running a compatible version of the Android
500platform. In turn, this ensures that your application can function properly on
501their devices. </p>
502
503<p>If your application uses APIs introduced in the latest platform version but
504does <em>not</em> declare a <code>android:minSdkVersion</code> attribute, then
505it will run properly on devices running the latest version of the platform, but
506<em>not</em> on devices running earlier versions of the platform. In the latter
507case, the application will crash at runtime when it tries to use APIs that don't
508exist on the earlier versions.</p>
509
510<h3 id="testing">Testing against higher API Levels</h3>
511
512<p>After compiling your application, you should make sure to test it on the
513platform specified in the application's <code>android:minSdkVersion</code>
514attribute. To do so, create an AVD that uses the platform version required by
515your application. Additionally, to ensure forward-compatibility, you should run
516and test the application on all platforms that use a higher API Level than that
517used by your application. </p>
518
519<p>The Android SDK includes multiple platform versions that you can use,
520including the latest version, and provides an updater tool that you can use to
521download other platform versions as necessary. </p>
522
523<p>To access the updater, use the <code>android</code> command-line tool,
524located in the &lt;sdk&gt;/tools directory. You can launch the SDK updater by
525executing <code>android sdk</code>. You can
526also simply double-click the android.bat (Windows) or android (OS X/Linux) file.
Joe Fernandez8119f872013-02-13 14:03:27 -0800527In ADT, you can also access the updater by selecting
Scott Main50e990c2012-06-21 17:14:39 -0700528<strong>Window</strong>&nbsp;>&nbsp;<strong>Android SDK
529Manager</strong>.</p>
530
531<p>To run your application against different platform versions in the emulator,
532create an AVD for each platform version that you want to test. For more
533information about AVDs, see <a
534href="{@docRoot}tools/devices/index.html">Creating and Managing Virtual Devices</a>. If
535you are using a physical device for testing, ensure that you know the API Level
536of the Android platform it runs. See the table at the top of this document for
537a list of platform versions and their API Levels. </p>
538
539<h2 id="provisional">Using a Provisional API Level</h2>
540
541<p>In some cases, an "Early Look" Android SDK platform may be available. To let
542you begin developing on the platform although the APIs may not be final, the
543platform's API Level integer will not be specified. You must instead use the
544platform's <em>provisional API Level</em> in your application manifest, in order
545to build applications against the platform. A provisional API Level is not an
546integer, but a string matching the codename of the unreleased platform version.
547The provisional API Level will be specified in the release notes for the Early
548Look SDK release notes and is case-sensitive.</p>
549
550<p>The use of a provisional API Level is designed to protect developers and
551device users from inadvertently publishing or installing applications based on
552the Early Look framework API, which may not run properly on actual devices
553running the final system image.</p>
554
555<p>The provisional API Level will only be valid while using the Early Look SDK
556and can only be used to run applications in the emulator. An application using
557the provisional API Level can never be installed on an Android device. At the
558final release of the platform, you must replace any instances of the provisional
559API Level in your application manifest with the final platform's actual API
560Level integer.</p>
561
562
563<h2 id="filtering">Filtering the Reference Documentation by API Level</h2>
564
565<p>Reference documentation pages on the Android Developers site offer a "Filter
Joe Fernandez8119f872013-02-13 14:03:27 -0800566by API Level" control in the top-right area of each page. You can use the
567control to show documentation only for parts of the API that are actually
568accessible to your application, based on the API Level that it specifies in
Scott Main50e990c2012-06-21 17:14:39 -0700569the <code>android:minSdkVersion</code> attribute of its manifest file. </p>
570
571<p>To use filtering, select the checkbox to enable filtering, just below the
572page search box. Then set the "Filter by API Level" control to the same API
573Level as specified by your application. Notice that APIs introduced in a later
574API Level are then grayed out and their content is masked, since they would not
575be accessible to your application. </p>
576
577<p>Filtering by API Level in the documentation does not provide a view
578of what is new or introduced in each API Level &mdash; it simply provides a way
579to view the entire API associated with a given API Level, while excluding API
580elements introduced in later API Levels.</p>
581
582<p>If you decide that you don't want to filter the API documentation, just
583disable the feature using the checkbox. By default, API Level filtering is
584disabled, so that you can view the full framework API, regardless of API Level.
585</p>
586
587<p>Also note that the reference documentation for individual API elements
Joe Fernandez8119f872013-02-13 14:03:27 -0800588specifies the API Level at which each element was introduced. The API Level
589for packages and classes is specified as "Since &lt;api level&gt;" at the
590top-right corner of the content area on each documentation page. The API Level
591for class members is specified in their detailed description headers,
Scott Main50e990c2012-06-21 17:14:39 -0700592at the right margin. </p>
593
594
595
596
597
598
599
600
601