Intent.java revision 749bd5d322e35b24d4a8fd42f40d865e1f88dac6
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import android.content.pm.ApplicationInfo;
20import android.util.ArraySet;
21
22import org.xmlpull.v1.XmlPullParser;
23import org.xmlpull.v1.XmlPullParserException;
24
25import android.annotation.IntDef;
26import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
28import android.content.pm.ActivityInfo;
29import static android.content.ContentProvider.maybeAddUserId;
30import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Resources;
33import android.content.res.TypedArray;
34import android.graphics.Rect;
35import android.net.Uri;
36import android.os.Bundle;
37import android.os.IBinder;
38import android.os.Parcel;
39import android.os.Parcelable;
40import android.os.StrictMode;
41import android.provider.DocumentsContract;
42import android.provider.DocumentsProvider;
43import android.provider.OpenableColumns;
44import android.util.AttributeSet;
45import android.util.Log;
46
47import com.android.internal.util.XmlUtils;
48import org.xmlpull.v1.XmlSerializer;
49
50import java.io.IOException;
51import java.io.Serializable;
52import java.lang.annotation.Retention;
53import java.lang.annotation.RetentionPolicy;
54import java.net.URISyntaxException;
55import java.util.ArrayList;
56import java.util.List;
57import java.util.Locale;
58import java.util.Objects;
59import java.util.Set;
60
61/**
62 * An intent is an abstract description of an operation to be performed.  It
63 * can be used with {@link Context#startActivity(Intent) startActivity} to
64 * launch an {@link android.app.Activity},
65 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
66 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
67 * and {@link android.content.Context#startService} or
68 * {@link android.content.Context#bindService} to communicate with a
69 * background {@link android.app.Service}.
70 *
71 * <p>An Intent provides a facility for performing late runtime binding between the code in
72 * different applications. Its most significant use is in the launching of activities, where it
73 * can be thought of as the glue between activities. It is basically a passive data structure
74 * holding an abstract description of an action to be performed.</p>
75 *
76 * <div class="special reference">
77 * <h3>Developer Guides</h3>
78 * <p>For information about how to create and resolve intents, read the
79 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
80 * developer guide.</p>
81 * </div>
82 *
83 * <a name="IntentStructure"></a>
84 * <h3>Intent Structure</h3>
85 * <p>The primary pieces of information in an intent are:</p>
86 *
87 * <ul>
88 *   <li> <p><b>action</b> -- The general action to be performed, such as
89 *     {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
90 *     etc.</p>
91 *   </li>
92 *   <li> <p><b>data</b> -- The data to operate on, such as a person record
93 *     in the contacts database, expressed as a {@link android.net.Uri}.</p>
94 *   </li>
95 * </ul>
96 *
97 *
98 * <p>Some examples of action/data pairs are:</p>
99 *
100 * <ul>
101 *   <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
102 *     information about the person whose identifier is "1".</p>
103 *   </li>
104 *   <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
105 *     the phone dialer with the person filled in.</p>
106 *   </li>
107 *   <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
108 *     the phone dialer with the given number filled in.  Note how the
109 *     VIEW action does what what is considered the most reasonable thing for
110 *     a particular URI.</p>
111 *   </li>
112 *   <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
113 *     the phone dialer with the given number filled in.</p>
114 *   </li>
115 *   <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
116 *     information about the person whose identifier is "1".</p>
117 *   </li>
118 *   <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
119 *     a list of people, which the user can browse through.  This example is a
120 *     typical top-level entry into the Contacts application, showing you the
121 *     list of people. Selecting a particular person to view would result in a
122 *     new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
123 *     being used to start an activity to display that person.</p>
124 *   </li>
125 * </ul>
126 *
127 * <p>In addition to these primary attributes, there are a number of secondary
128 * attributes that you can also include with an intent:</p>
129 *
130 * <ul>
131 *     <li> <p><b>category</b> -- Gives additional information about the action
132 *         to execute.  For example, {@link #CATEGORY_LAUNCHER} means it should
133 *         appear in the Launcher as a top-level application, while
134 *         {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
135 *         of alternative actions the user can perform on a piece of data.</p>
136 *     <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
137 *         intent data.  Normally the type is inferred from the data itself.
138 *         By setting this attribute, you disable that evaluation and force
139 *         an explicit type.</p>
140 *     <li> <p><b>component</b> -- Specifies an explicit name of a component
141 *         class to use for the intent.  Normally this is determined by looking
142 *         at the other information in the intent (the action, data/type, and
143 *         categories) and matching that with a component that can handle it.
144 *         If this attribute is set then none of the evaluation is performed,
145 *         and this component is used exactly as is.  By specifying this attribute,
146 *         all of the other Intent attributes become optional.</p>
147 *     <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
148 *         This can be used to provide extended information to the component.
149 *         For example, if we have a action to send an e-mail message, we could
150 *         also include extra pieces of data here to supply a subject, body,
151 *         etc.</p>
152 * </ul>
153 *
154 * <p>Here are some examples of other operations you can specify as intents
155 * using these additional parameters:</p>
156 *
157 * <ul>
158 *   <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
159 *     Launch the home screen.</p>
160 *   </li>
161 *   <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
162 *     <i>{@link android.provider.Contacts.Phones#CONTENT_URI
163 *     vnd.android.cursor.item/phone}</i></b>
164 *     -- Display the list of people's phone numbers, allowing the user to
165 *     browse through them and pick one and return it to the parent activity.</p>
166 *   </li>
167 *   <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
168 *     <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
169 *     -- Display all pickers for data that can be opened with
170 *     {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
171 *     allowing the user to pick one of them and then some data inside of it
172 *     and returning the resulting URI to the caller.  This can be used,
173 *     for example, in an e-mail application to allow the user to pick some
174 *     data to include as an attachment.</p>
175 *   </li>
176 * </ul>
177 *
178 * <p>There are a variety of standard Intent action and category constants
179 * defined in the Intent class, but applications can also define their own.
180 * These strings use java style scoping, to ensure they are unique -- for
181 * example, the standard {@link #ACTION_VIEW} is called
182 * "android.intent.action.VIEW".</p>
183 *
184 * <p>Put together, the set of actions, data types, categories, and extra data
185 * defines a language for the system allowing for the expression of phrases
186 * such as "call john smith's cell".  As applications are added to the system,
187 * they can extend this language by adding new actions, types, and categories, or
188 * they can modify the behavior of existing phrases by supplying their own
189 * activities that handle them.</p>
190 *
191 * <a name="IntentResolution"></a>
192 * <h3>Intent Resolution</h3>
193 *
194 * <p>There are two primary forms of intents you will use.
195 *
196 * <ul>
197 *     <li> <p><b>Explicit Intents</b> have specified a component (via
198 *     {@link #setComponent} or {@link #setClass}), which provides the exact
199 *     class to be run.  Often these will not include any other information,
200 *     simply being a way for an application to launch various internal
201 *     activities it has as the user interacts with the application.
202 *
203 *     <li> <p><b>Implicit Intents</b> have not specified a component;
204 *     instead, they must include enough information for the system to
205 *     determine which of the available components is best to run for that
206 *     intent.
207 * </ul>
208 *
209 * <p>When using implicit intents, given such an arbitrary intent we need to
210 * know what to do with it. This is handled by the process of <em>Intent
211 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
212 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
213 * more activities/receivers) that can handle it.</p>
214 *
215 * <p>The intent resolution mechanism basically revolves around matching an
216 * Intent against all of the &lt;intent-filter&gt; descriptions in the
217 * installed application packages.  (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
218 * objects explicitly registered with {@link Context#registerReceiver}.)  More
219 * details on this can be found in the documentation on the {@link
220 * IntentFilter} class.</p>
221 *
222 * <p>There are three pieces of information in the Intent that are used for
223 * resolution: the action, type, and category.  Using this information, a query
224 * is done on the {@link PackageManager} for a component that can handle the
225 * intent. The appropriate component is determined based on the intent
226 * information supplied in the <code>AndroidManifest.xml</code> file as
227 * follows:</p>
228 *
229 * <ul>
230 *     <li> <p>The <b>action</b>, if given, must be listed by the component as
231 *         one it handles.</p>
232 *     <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
233 *         already supplied in the Intent.  Like the action, if a type is
234 *         included in the intent (either explicitly or implicitly in its
235 *         data), then this must be listed by the component as one it handles.</p>
236 *     <li> For data that is not a <code>content:</code> URI and where no explicit
237 *         type is included in the Intent, instead the <b>scheme</b> of the
238 *         intent data (such as <code>http:</code> or <code>mailto:</code>) is
239 *         considered. Again like the action, if we are matching a scheme it
240 *         must be listed by the component as one it can handle.
241 *     <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
242 *         by the activity as categories it handles.  That is, if you include
243 *         the categories {@link #CATEGORY_LAUNCHER} and
244 *         {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
245 *         with an intent that lists <em>both</em> of those categories.
246 *         Activities will very often need to support the
247 *         {@link #CATEGORY_DEFAULT} so that they can be found by
248 *         {@link Context#startActivity Context.startActivity()}.</p>
249 * </ul>
250 *
251 * <p>For example, consider the Note Pad sample application that
252 * allows user to browse through a list of notes data and view details about
253 * individual items.  Text in italics indicate places were you would replace a
254 * name with one specific to your own package.</p>
255 *
256 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
257 *       package="<i>com.android.notepad</i>"&gt;
258 *     &lt;application android:icon="@drawable/app_notes"
259 *             android:label="@string/app_name"&gt;
260 *
261 *         &lt;provider class=".NotePadProvider"
262 *                 android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
263 *
264 *         &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
265 *             &lt;intent-filter&gt;
266 *                 &lt;action android:name="android.intent.action.MAIN" /&gt;
267 *                 &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
268 *             &lt;/intent-filter&gt;
269 *             &lt;intent-filter&gt;
270 *                 &lt;action android:name="android.intent.action.VIEW" /&gt;
271 *                 &lt;action android:name="android.intent.action.EDIT" /&gt;
272 *                 &lt;action android:name="android.intent.action.PICK" /&gt;
273 *                 &lt;category android:name="android.intent.category.DEFAULT" /&gt;
274 *                 &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
275 *             &lt;/intent-filter&gt;
276 *             &lt;intent-filter&gt;
277 *                 &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
278 *                 &lt;category android:name="android.intent.category.DEFAULT" /&gt;
279 *                 &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
280 *             &lt;/intent-filter&gt;
281 *         &lt;/activity&gt;
282 *
283 *         &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
284 *             &lt;intent-filter android:label="@string/resolve_edit"&gt;
285 *                 &lt;action android:name="android.intent.action.VIEW" /&gt;
286 *                 &lt;action android:name="android.intent.action.EDIT" /&gt;
287 *                 &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 *                 &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
289 *             &lt;/intent-filter&gt;
290 *
291 *             &lt;intent-filter&gt;
292 *                 &lt;action android:name="android.intent.action.INSERT" /&gt;
293 *                 &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 *                 &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
295 *             &lt;/intent-filter&gt;
296 *
297 *         &lt;/activity&gt;
298 *
299 *         &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
300 *                 android:theme="@android:style/Theme.Dialog"&gt;
301 *             &lt;intent-filter android:label="@string/resolve_title"&gt;
302 *                 &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
303 *                 &lt;category android:name="android.intent.category.DEFAULT" /&gt;
304 *                 &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
305 *                 &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
306 *                 &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
307 *             &lt;/intent-filter&gt;
308 *         &lt;/activity&gt;
309 *
310 *     &lt;/application&gt;
311 * &lt;/manifest&gt;</pre>
312 *
313 * <p>The first activity,
314 * <code>com.android.notepad.NotesList</code>, serves as our main
315 * entry into the app.  It can do three things as described by its three intent
316 * templates:
317 * <ol>
318 * <li><pre>
319 * &lt;intent-filter&gt;
320 *     &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
321 *     &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
322 * &lt;/intent-filter&gt;</pre>
323 * <p>This provides a top-level entry into the NotePad application: the standard
324 * MAIN action is a main entry point (not requiring any other information in
325 * the Intent), and the LAUNCHER category says that this entry point should be
326 * listed in the application launcher.</p>
327 * <li><pre>
328 * &lt;intent-filter&gt;
329 *     &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
330 *     &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
331 *     &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
332 *     &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
333 *     &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
334 * &lt;/intent-filter&gt;</pre>
335 * <p>This declares the things that the activity can do on a directory of
336 * notes.  The type being supported is given with the &lt;type&gt; tag, where
337 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
338 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
339 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
340 * The activity allows the user to view or edit the directory of data (via
341 * the VIEW and EDIT actions), or to pick a particular note and return it
342 * to the caller (via the PICK action).  Note also the DEFAULT category
343 * supplied here: this is <em>required</em> for the
344 * {@link Context#startActivity Context.startActivity} method to resolve your
345 * activity when its component name is not explicitly specified.</p>
346 * <li><pre>
347 * &lt;intent-filter&gt;
348 *     &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
349 *     &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
350 *     &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
351 * &lt;/intent-filter&gt;</pre>
352 * <p>This filter describes the ability return to the caller a note selected by
353 * the user without needing to know where it came from.  The data type
354 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
355 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
356 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
357 * The GET_CONTENT action is similar to the PICK action, where the activity
358 * will return to its caller a piece of data selected by the user.  Here,
359 * however, the caller specifies the type of data they desire instead of
360 * the type of data the user will be picking from.</p>
361 * </ol>
362 *
363 * <p>Given these capabilities, the following intents will resolve to the
364 * NotesList activity:</p>
365 *
366 * <ul>
367 *     <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
368 *         activities that can be used as top-level entry points into an
369 *         application.</p>
370 *     <li> <p><b>{ action=android.app.action.MAIN,
371 *         category=android.app.category.LAUNCHER }</b> is the actual intent
372 *         used by the Launcher to populate its top-level list.</p>
373 *     <li> <p><b>{ action=android.intent.action.VIEW
374 *          data=content://com.google.provider.NotePad/notes }</b>
375 *         displays a list of all the notes under
376 *         "content://com.google.provider.NotePad/notes", which
377 *         the user can browse through and see the details on.</p>
378 *     <li> <p><b>{ action=android.app.action.PICK
379 *          data=content://com.google.provider.NotePad/notes }</b>
380 *         provides a list of the notes under
381 *         "content://com.google.provider.NotePad/notes", from which
382 *         the user can pick a note whose data URL is returned back to the caller.</p>
383 *     <li> <p><b>{ action=android.app.action.GET_CONTENT
384 *          type=vnd.android.cursor.item/vnd.google.note }</b>
385 *         is similar to the pick action, but allows the caller to specify the
386 *         kind of data they want back so that the system can find the appropriate
387 *         activity to pick something of that data type.</p>
388 * </ul>
389 *
390 * <p>The second activity,
391 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
392 * note entry and allows them to edit it.  It can do two things as described
393 * by its two intent templates:
394 * <ol>
395 * <li><pre>
396 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
397 *     &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
398 *     &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
399 *     &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 *     &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
401 * &lt;/intent-filter&gt;</pre>
402 * <p>The first, primary, purpose of this activity is to let the user interact
403 * with a single note, as decribed by the MIME type
404 * <code>vnd.android.cursor.item/vnd.google.note</code>.  The activity can
405 * either VIEW a note or allow the user to EDIT it.  Again we support the
406 * DEFAULT category to allow the activity to be launched without explicitly
407 * specifying its component.</p>
408 * <li><pre>
409 * &lt;intent-filter&gt;
410 *     &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
411 *     &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
412 *     &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
413 * &lt;/intent-filter&gt;</pre>
414 * <p>The secondary use of this activity is to insert a new note entry into
415 * an existing directory of notes.  This is used when the user creates a new
416 * note: the INSERT action is executed on the directory of notes, causing
417 * this activity to run and have the user create the new note data which
418 * it then adds to the content provider.</p>
419 * </ol>
420 *
421 * <p>Given these capabilities, the following intents will resolve to the
422 * NoteEditor activity:</p>
423 *
424 * <ul>
425 *     <li> <p><b>{ action=android.intent.action.VIEW
426 *          data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
427 *         shows the user the content of note <var>{ID}</var>.</p>
428 *     <li> <p><b>{ action=android.app.action.EDIT
429 *          data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
430 *         allows the user to edit the content of note <var>{ID}</var>.</p>
431 *     <li> <p><b>{ action=android.app.action.INSERT
432 *          data=content://com.google.provider.NotePad/notes }</b>
433 *         creates a new, empty note in the notes list at
434 *         "content://com.google.provider.NotePad/notes"
435 *         and allows the user to edit it.  If they keep their changes, the URI
436 *         of the newly created note is returned to the caller.</p>
437 * </ul>
438 *
439 * <p>The last activity,
440 * <code>com.android.notepad.TitleEditor</code>, allows the user to
441 * edit the title of a note.  This could be implemented as a class that the
442 * application directly invokes (by explicitly setting its component in
443 * the Intent), but here we show a way you can publish alternative
444 * operations on existing data:</p>
445 *
446 * <pre>
447 * &lt;intent-filter android:label="@string/resolve_title"&gt;
448 *     &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
449 *     &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
450 *     &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
451 *     &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
452 *     &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
453 * &lt;/intent-filter&gt;</pre>
454 *
455 * <p>In the single intent template here, we
456 * have created our own private action called
457 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
458 * edit the title of a note.  It must be invoked on a specific note
459 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
460 * view and edit actions, but here displays and edits the title contained
461 * in the note data.
462 *
463 * <p>In addition to supporting the default category as usual, our title editor
464 * also supports two other standard categories: ALTERNATIVE and
465 * SELECTED_ALTERNATIVE.  Implementing
466 * these categories allows others to find the special action it provides
467 * without directly knowing about it, through the
468 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
469 * more often to build dynamic menu items with
470 * {@link android.view.Menu#addIntentOptions}.  Note that in the intent
471 * template here was also supply an explicit name for the template
472 * (via <code>android:label="@string/resolve_title"</code>) to better control
473 * what the user sees when presented with this activity as an alternative
474 * action to the data they are viewing.
475 *
476 * <p>Given these capabilities, the following intent will resolve to the
477 * TitleEditor activity:</p>
478 *
479 * <ul>
480 *     <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
481 *          data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
482 *         displays and allows the user to edit the title associated
483 *         with note <var>{ID}</var>.</p>
484 * </ul>
485 *
486 * <h3>Standard Activity Actions</h3>
487 *
488 * <p>These are the current standard actions that Intent defines for launching
489 * activities (usually through {@link Context#startActivity}.  The most
490 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
491 * {@link #ACTION_EDIT}.
492 *
493 * <ul>
494 *     <li> {@link #ACTION_MAIN}
495 *     <li> {@link #ACTION_VIEW}
496 *     <li> {@link #ACTION_ATTACH_DATA}
497 *     <li> {@link #ACTION_EDIT}
498 *     <li> {@link #ACTION_PICK}
499 *     <li> {@link #ACTION_CHOOSER}
500 *     <li> {@link #ACTION_GET_CONTENT}
501 *     <li> {@link #ACTION_DIAL}
502 *     <li> {@link #ACTION_CALL}
503 *     <li> {@link #ACTION_SEND}
504 *     <li> {@link #ACTION_SENDTO}
505 *     <li> {@link #ACTION_ANSWER}
506 *     <li> {@link #ACTION_INSERT}
507 *     <li> {@link #ACTION_DELETE}
508 *     <li> {@link #ACTION_RUN}
509 *     <li> {@link #ACTION_SYNC}
510 *     <li> {@link #ACTION_PICK_ACTIVITY}
511 *     <li> {@link #ACTION_SEARCH}
512 *     <li> {@link #ACTION_WEB_SEARCH}
513 *     <li> {@link #ACTION_FACTORY_TEST}
514 * </ul>
515 *
516 * <h3>Standard Broadcast Actions</h3>
517 *
518 * <p>These are the current standard actions that Intent defines for receiving
519 * broadcasts (usually through {@link Context#registerReceiver} or a
520 * &lt;receiver&gt; tag in a manifest).
521 *
522 * <ul>
523 *     <li> {@link #ACTION_TIME_TICK}
524 *     <li> {@link #ACTION_TIME_CHANGED}
525 *     <li> {@link #ACTION_TIMEZONE_CHANGED}
526 *     <li> {@link #ACTION_BOOT_COMPLETED}
527 *     <li> {@link #ACTION_PACKAGE_ADDED}
528 *     <li> {@link #ACTION_PACKAGE_CHANGED}
529 *     <li> {@link #ACTION_PACKAGE_REMOVED}
530 *     <li> {@link #ACTION_PACKAGE_RESTARTED}
531 *     <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
532 *     <li> {@link #ACTION_UID_REMOVED}
533 *     <li> {@link #ACTION_BATTERY_CHANGED}
534 *     <li> {@link #ACTION_POWER_CONNECTED}
535 *     <li> {@link #ACTION_POWER_DISCONNECTED}
536 *     <li> {@link #ACTION_SHUTDOWN}
537 * </ul>
538 *
539 * <h3>Standard Categories</h3>
540 *
541 * <p>These are the current standard categories that can be used to further
542 * clarify an Intent via {@link #addCategory}.
543 *
544 * <ul>
545 *     <li> {@link #CATEGORY_DEFAULT}
546 *     <li> {@link #CATEGORY_BROWSABLE}
547 *     <li> {@link #CATEGORY_TAB}
548 *     <li> {@link #CATEGORY_ALTERNATIVE}
549 *     <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
550 *     <li> {@link #CATEGORY_LAUNCHER}
551 *     <li> {@link #CATEGORY_INFO}
552 *     <li> {@link #CATEGORY_HOME}
553 *     <li> {@link #CATEGORY_PREFERENCE}
554 *     <li> {@link #CATEGORY_TEST}
555 *     <li> {@link #CATEGORY_CAR_DOCK}
556 *     <li> {@link #CATEGORY_DESK_DOCK}
557 *     <li> {@link #CATEGORY_LE_DESK_DOCK}
558 *     <li> {@link #CATEGORY_HE_DESK_DOCK}
559 *     <li> {@link #CATEGORY_CAR_MODE}
560 *     <li> {@link #CATEGORY_APP_MARKET}
561 * </ul>
562 *
563 * <h3>Standard Extra Data</h3>
564 *
565 * <p>These are the current standard fields that can be used as extra data via
566 * {@link #putExtra}.
567 *
568 * <ul>
569 *     <li> {@link #EXTRA_ALARM_COUNT}
570 *     <li> {@link #EXTRA_BCC}
571 *     <li> {@link #EXTRA_CC}
572 *     <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
573 *     <li> {@link #EXTRA_DATA_REMOVED}
574 *     <li> {@link #EXTRA_DOCK_STATE}
575 *     <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
576 *     <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
577 *     <li> {@link #EXTRA_DOCK_STATE_CAR}
578 *     <li> {@link #EXTRA_DOCK_STATE_DESK}
579 *     <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
580 *     <li> {@link #EXTRA_DONT_KILL_APP}
581 *     <li> {@link #EXTRA_EMAIL}
582 *     <li> {@link #EXTRA_INITIAL_INTENTS}
583 *     <li> {@link #EXTRA_INTENT}
584 *     <li> {@link #EXTRA_KEY_EVENT}
585 *     <li> {@link #EXTRA_ORIGINATING_URI}
586 *     <li> {@link #EXTRA_PHONE_NUMBER}
587 *     <li> {@link #EXTRA_REFERRER}
588 *     <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
589 *     <li> {@link #EXTRA_REPLACING}
590 *     <li> {@link #EXTRA_SHORTCUT_ICON}
591 *     <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
592 *     <li> {@link #EXTRA_SHORTCUT_INTENT}
593 *     <li> {@link #EXTRA_STREAM}
594 *     <li> {@link #EXTRA_SHORTCUT_NAME}
595 *     <li> {@link #EXTRA_SUBJECT}
596 *     <li> {@link #EXTRA_TEMPLATE}
597 *     <li> {@link #EXTRA_TEXT}
598 *     <li> {@link #EXTRA_TITLE}
599 *     <li> {@link #EXTRA_UID}
600 * </ul>
601 *
602 * <h3>Flags</h3>
603 *
604 * <p>These are the possible flags that can be used in the Intent via
605 * {@link #setFlags} and {@link #addFlags}.  See {@link #setFlags} for a list
606 * of all possible flags.
607 */
608public class Intent implements Parcelable, Cloneable {
609    private static final String ATTR_ACTION = "action";
610    private static final String TAG_CATEGORIES = "categories";
611    private static final String ATTR_CATEGORY = "category";
612    private static final String TAG_EXTRA = "extra";
613    private static final String ATTR_TYPE = "type";
614    private static final String ATTR_COMPONENT = "component";
615    private static final String ATTR_DATA = "data";
616    private static final String ATTR_FLAGS = "flags";
617
618    // ---------------------------------------------------------------------
619    // ---------------------------------------------------------------------
620    // Standard intent activity actions (see action variable).
621
622    /**
623     *  Activity Action: Start as a main entry point, does not expect to
624     *  receive data.
625     *  <p>Input: nothing
626     *  <p>Output: nothing
627     */
628    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
629    public static final String ACTION_MAIN = "android.intent.action.MAIN";
630
631    /**
632     * Activity Action: Display the data to the user.  This is the most common
633     * action performed on data -- it is the generic action you can use on
634     * a piece of data to get the most reasonable thing to occur.  For example,
635     * when used on a contacts entry it will view the entry; when used on a
636     * mailto: URI it will bring up a compose window filled with the information
637     * supplied by the URI; when used with a tel: URI it will invoke the
638     * dialer.
639     * <p>Input: {@link #getData} is URI from which to retrieve data.
640     * <p>Output: nothing.
641     */
642    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
643    public static final String ACTION_VIEW = "android.intent.action.VIEW";
644
645    /**
646     * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
647     * performed on a piece of data.
648     */
649    public static final String ACTION_DEFAULT = ACTION_VIEW;
650
651    /**
652     * Used to indicate that some piece of data should be attached to some other
653     * place.  For example, image data could be attached to a contact.  It is up
654     * to the recipient to decide where the data should be attached; the intent
655     * does not specify the ultimate destination.
656     * <p>Input: {@link #getData} is URI of data to be attached.
657     * <p>Output: nothing.
658     */
659    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
660    public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
661
662    /**
663     * Activity Action: Provide explicit editable access to the given data.
664     * <p>Input: {@link #getData} is URI of data to be edited.
665     * <p>Output: nothing.
666     */
667    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
668    public static final String ACTION_EDIT = "android.intent.action.EDIT";
669
670    /**
671     * Activity Action: Pick an existing item, or insert a new item, and then edit it.
672     * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
673     * The extras can contain type specific data to pass through to the editing/creating
674     * activity.
675     * <p>Output: The URI of the item that was picked.  This must be a content:
676     * URI so that any receiver can access it.
677     */
678    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
679    public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
680
681    /**
682     * Activity Action: Pick an item from the data, returning what was selected.
683     * <p>Input: {@link #getData} is URI containing a directory of data
684     * (vnd.android.cursor.dir/*) from which to pick an item.
685     * <p>Output: The URI of the item that was picked.
686     */
687    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
688    public static final String ACTION_PICK = "android.intent.action.PICK";
689
690    /**
691     * Activity Action: Creates a shortcut.
692     * <p>Input: Nothing.</p>
693     * <p>Output: An Intent representing the shortcut. The intent must contain three
694     * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
695     * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
696     * (value: ShortcutIconResource).</p>
697     *
698     * @see #EXTRA_SHORTCUT_INTENT
699     * @see #EXTRA_SHORTCUT_NAME
700     * @see #EXTRA_SHORTCUT_ICON
701     * @see #EXTRA_SHORTCUT_ICON_RESOURCE
702     * @see android.content.Intent.ShortcutIconResource
703     */
704    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
705    public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
706
707    /**
708     * The name of the extra used to define the Intent of a shortcut.
709     *
710     * @see #ACTION_CREATE_SHORTCUT
711     */
712    public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
713    /**
714     * The name of the extra used to define the name of a shortcut.
715     *
716     * @see #ACTION_CREATE_SHORTCUT
717     */
718    public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
719    /**
720     * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
721     *
722     * @see #ACTION_CREATE_SHORTCUT
723     */
724    public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
725    /**
726     * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
727     *
728     * @see #ACTION_CREATE_SHORTCUT
729     * @see android.content.Intent.ShortcutIconResource
730     */
731    public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
732            "android.intent.extra.shortcut.ICON_RESOURCE";
733
734    /**
735     * Represents a shortcut/live folder icon resource.
736     *
737     * @see Intent#ACTION_CREATE_SHORTCUT
738     * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
739     * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
740     * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
741     */
742    public static class ShortcutIconResource implements Parcelable {
743        /**
744         * The package name of the application containing the icon.
745         */
746        public String packageName;
747
748        /**
749         * The resource name of the icon, including package, name and type.
750         */
751        public String resourceName;
752
753        /**
754         * Creates a new ShortcutIconResource for the specified context and resource
755         * identifier.
756         *
757         * @param context The context of the application.
758         * @param resourceId The resource idenfitier for the icon.
759         * @return A new ShortcutIconResource with the specified's context package name
760         *         and icon resource idenfitier.
761         */
762        public static ShortcutIconResource fromContext(Context context, int resourceId) {
763            ShortcutIconResource icon = new ShortcutIconResource();
764            icon.packageName = context.getPackageName();
765            icon.resourceName = context.getResources().getResourceName(resourceId);
766            return icon;
767        }
768
769        /**
770         * Used to read a ShortcutIconResource from a Parcel.
771         */
772        public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
773            new Parcelable.Creator<ShortcutIconResource>() {
774
775                public ShortcutIconResource createFromParcel(Parcel source) {
776                    ShortcutIconResource icon = new ShortcutIconResource();
777                    icon.packageName = source.readString();
778                    icon.resourceName = source.readString();
779                    return icon;
780                }
781
782                public ShortcutIconResource[] newArray(int size) {
783                    return new ShortcutIconResource[size];
784                }
785            };
786
787        /**
788         * No special parcel contents.
789         */
790        public int describeContents() {
791            return 0;
792        }
793
794        public void writeToParcel(Parcel dest, int flags) {
795            dest.writeString(packageName);
796            dest.writeString(resourceName);
797        }
798
799        @Override
800        public String toString() {
801            return resourceName;
802        }
803    }
804
805    /**
806     * Activity Action: Display an activity chooser, allowing the user to pick
807     * what they want to before proceeding.  This can be used as an alternative
808     * to the standard activity picker that is displayed by the system when
809     * you try to start an activity with multiple possible matches, with these
810     * differences in behavior:
811     * <ul>
812     * <li>You can specify the title that will appear in the activity chooser.
813     * <li>The user does not have the option to make one of the matching
814     * activities a preferred activity, and all possible activities will
815     * always be shown even if one of them is currently marked as the
816     * preferred activity.
817     * </ul>
818     * <p>
819     * This action should be used when the user will naturally expect to
820     * select an activity in order to proceed.  An example if when not to use
821     * it is when the user clicks on a "mailto:" link.  They would naturally
822     * expect to go directly to their mail app, so startActivity() should be
823     * called directly: it will
824     * either launch the current preferred app, or put up a dialog allowing the
825     * user to pick an app to use and optionally marking that as preferred.
826     * <p>
827     * In contrast, if the user is selecting a menu item to send a picture
828     * they are viewing to someone else, there are many different things they
829     * may want to do at this point: send it through e-mail, upload it to a
830     * web service, etc.  In this case the CHOOSER action should be used, to
831     * always present to the user a list of the things they can do, with a
832     * nice title given by the caller such as "Send this photo with:".
833     * <p>
834     * If you need to grant URI permissions through a chooser, you must specify
835     * the permissions to be granted on the ACTION_CHOOSER Intent
836     * <em>in addition</em> to the EXTRA_INTENT inside.  This means using
837     * {@link #setClipData} to specify the URIs to be granted as well as
838     * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
839     * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
840     * <p>
841     * As a convenience, an Intent of this form can be created with the
842     * {@link #createChooser} function.
843     * <p>
844     * Input: No data should be specified.  get*Extra must have
845     * a {@link #EXTRA_INTENT} field containing the Intent being executed,
846     * and can optionally have a {@link #EXTRA_TITLE} field containing the
847     * title text to display in the chooser.
848     * <p>
849     * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
850     */
851    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
852    public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
853
854    /**
855     * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
856     *
857     * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
858     * target intent, also optionally supplying a title.  If the target
859     * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
860     * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
861     * set in the returned chooser intent, with its ClipData set appropriately:
862     * either a direct reflection of {@link #getClipData()} if that is non-null,
863     * or a new ClipData built from {@link #getData()}.
864     *
865     * @param target The Intent that the user will be selecting an activity
866     * to perform.
867     * @param title Optional title that will be displayed in the chooser.
868     * @return Return a new Intent object that you can hand to
869     * {@link Context#startActivity(Intent) Context.startActivity()} and
870     * related methods.
871     */
872    public static Intent createChooser(Intent target, CharSequence title) {
873        Intent intent = new Intent(ACTION_CHOOSER);
874        intent.putExtra(EXTRA_INTENT, target);
875        if (title != null) {
876            intent.putExtra(EXTRA_TITLE, title);
877        }
878
879        // Migrate any clip data and flags from target.
880        int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
881                | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
882                | FLAG_GRANT_PREFIX_URI_PERMISSION);
883        if (permFlags != 0) {
884            ClipData targetClipData = target.getClipData();
885            if (targetClipData == null && target.getData() != null) {
886                ClipData.Item item = new ClipData.Item(target.getData());
887                String[] mimeTypes;
888                if (target.getType() != null) {
889                    mimeTypes = new String[] { target.getType() };
890                } else {
891                    mimeTypes = new String[] { };
892                }
893                targetClipData = new ClipData(null, mimeTypes, item);
894            }
895            if (targetClipData != null) {
896                intent.setClipData(targetClipData);
897                intent.addFlags(permFlags);
898            }
899        }
900
901        return intent;
902    }
903
904    /**
905     * Activity Action: Allow the user to select a particular kind of data and
906     * return it.  This is different than {@link #ACTION_PICK} in that here we
907     * just say what kind of data is desired, not a URI of existing data from
908     * which the user can pick.  An ACTION_GET_CONTENT could allow the user to
909     * create the data as it runs (for example taking a picture or recording a
910     * sound), let them browse over the web and download the desired data,
911     * etc.
912     * <p>
913     * There are two main ways to use this action: if you want a specific kind
914     * of data, such as a person contact, you set the MIME type to the kind of
915     * data you want and launch it with {@link Context#startActivity(Intent)}.
916     * The system will then launch the best application to select that kind
917     * of data for you.
918     * <p>
919     * You may also be interested in any of a set of types of content the user
920     * can pick.  For example, an e-mail application that wants to allow the
921     * user to add an attachment to an e-mail message can use this action to
922     * bring up a list of all of the types of content the user can attach.
923     * <p>
924     * In this case, you should wrap the GET_CONTENT intent with a chooser
925     * (through {@link #createChooser}), which will give the proper interface
926     * for the user to pick how to send your data and allow you to specify
927     * a prompt indicating what they are doing.  You will usually specify a
928     * broad MIME type (such as image/* or {@literal *}/*), resulting in a
929     * broad range of content types the user can select from.
930     * <p>
931     * When using such a broad GET_CONTENT action, it is often desirable to
932     * only pick from data that can be represented as a stream.  This is
933     * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
934     * <p>
935     * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
936     * the launched content chooser only returns results representing data that
937     * is locally available on the device.  For example, if this extra is set
938     * to true then an image picker should not show any pictures that are available
939     * from a remote server but not already on the local device (thus requiring
940     * they be downloaded when opened).
941     * <p>
942     * If the caller can handle multiple returned items (the user performing
943     * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
944     * to indicate this.
945     * <p>
946     * Input: {@link #getType} is the desired MIME type to retrieve.  Note
947     * that no URI is supplied in the intent, as there are no constraints on
948     * where the returned data originally comes from.  You may also include the
949     * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
950     * opened as a stream.  You may use {@link #EXTRA_LOCAL_ONLY} to limit content
951     * selection to local data.  You may use {@link #EXTRA_ALLOW_MULTIPLE} to
952     * allow the user to select multiple items.
953     * <p>
954     * Output: The URI of the item that was picked.  This must be a content:
955     * URI so that any receiver can access it.
956     */
957    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
958    public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
959    /**
960     * Activity Action: Dial a number as specified by the data.  This shows a
961     * UI with the number being dialed, allowing the user to explicitly
962     * initiate the call.
963     * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
964     * is URI of a phone number to be dialed or a tel: URI of an explicit phone
965     * number.
966     * <p>Output: nothing.
967     */
968    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
969    public static final String ACTION_DIAL = "android.intent.action.DIAL";
970    /**
971     * Activity Action: Perform a call to someone specified by the data.
972     * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
973     * is URI of a phone number to be dialed or a tel: URI of an explicit phone
974     * number.
975     * <p>Output: nothing.
976     *
977     * <p>Note: there will be restrictions on which applications can initiate a
978     * call; most applications should use the {@link #ACTION_DIAL}.
979     * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
980     * numbers.  Applications can <strong>dial</strong> emergency numbers using
981     * {@link #ACTION_DIAL}, however.
982     */
983    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
984    public static final String ACTION_CALL = "android.intent.action.CALL";
985    /**
986     * Activity Action: Perform a call to an emergency number specified by the
987     * data.
988     * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
989     * tel: URI of an explicit phone number.
990     * <p>Output: nothing.
991     * @hide
992     */
993    public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
994    /**
995     * Activity action: Perform a call to any number (emergency or not)
996     * specified by the data.
997     * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
998     * tel: URI of an explicit phone number.
999     * <p>Output: nothing.
1000     * @hide
1001     */
1002    public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1003    /**
1004     * Activity Action: Send a message to someone specified by the data.
1005     * <p>Input: {@link #getData} is URI describing the target.
1006     * <p>Output: nothing.
1007     */
1008    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009    public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1010    /**
1011     * Activity Action: Deliver some data to someone else.  Who the data is
1012     * being delivered to is not specified; it is up to the receiver of this
1013     * action to ask the user where the data should be sent.
1014     * <p>
1015     * When launching a SEND intent, you should usually wrap it in a chooser
1016     * (through {@link #createChooser}), which will give the proper interface
1017     * for the user to pick how to send your data and allow you to specify
1018     * a prompt indicating what they are doing.
1019     * <p>
1020     * Input: {@link #getType} is the MIME type of the data being sent.
1021     * get*Extra can have either a {@link #EXTRA_TEXT}
1022     * or {@link #EXTRA_STREAM} field, containing the data to be sent.  If
1023     * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1024     * should be the MIME type of the data in EXTRA_STREAM.  Use {@literal *}/*
1025     * if the MIME type is unknown (this will only allow senders that can
1026     * handle generic data streams).  If using {@link #EXTRA_TEXT}, you can
1027     * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1028     * your text with HTML formatting.
1029     * <p>
1030     * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1031     * being sent can be supplied through {@link #setClipData(ClipData)}.  This
1032     * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1033     * content: URIs and other advanced features of {@link ClipData}.  If
1034     * using this approach, you still must supply the same data through the
1035     * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1036     * for compatibility with old applications.  If you don't set a ClipData,
1037     * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1038     * <p>
1039     * Optional standard extras, which may be interpreted by some recipients as
1040     * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1041     * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1042     * <p>
1043     * Output: nothing.
1044     */
1045    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046    public static final String ACTION_SEND = "android.intent.action.SEND";
1047    /**
1048     * Activity Action: Deliver multiple data to someone else.
1049     * <p>
1050     * Like {@link #ACTION_SEND}, except the data is multiple.
1051     * <p>
1052     * Input: {@link #getType} is the MIME type of the data being sent.
1053     * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
1054     * #EXTRA_STREAM} field, containing the data to be sent.  If using
1055     * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1056     * for clients to retrieve your text with HTML formatting.
1057     * <p>
1058     * Multiple types are supported, and receivers should handle mixed types
1059     * whenever possible. The right way for the receiver to check them is to
1060     * use the content resolver on each URI. The intent sender should try to
1061     * put the most concrete mime type in the intent type, but it can fall
1062     * back to {@literal <type>/*} or {@literal *}/* as needed.
1063     * <p>
1064     * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1065     * be image/jpg, but if you are sending image/jpg and image/png, then the
1066     * intent's type should be image/*.
1067     * <p>
1068     * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1069     * being sent can be supplied through {@link #setClipData(ClipData)}.  This
1070     * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1071     * content: URIs and other advanced features of {@link ClipData}.  If
1072     * using this approach, you still must supply the same data through the
1073     * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1074     * for compatibility with old applications.  If you don't set a ClipData,
1075     * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1076     * <p>
1077     * Optional standard extras, which may be interpreted by some recipients as
1078     * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1079     * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1080     * <p>
1081     * Output: nothing.
1082     */
1083    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1084    public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1085    /**
1086     * Activity Action: Handle an incoming phone call.
1087     * <p>Input: nothing.
1088     * <p>Output: nothing.
1089     */
1090    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091    public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1092    /**
1093     * Activity Action: Insert an empty item into the given container.
1094     * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1095     * in which to place the data.
1096     * <p>Output: URI of the new data that was created.
1097     */
1098    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1099    public static final String ACTION_INSERT = "android.intent.action.INSERT";
1100    /**
1101     * Activity Action: Create a new item in the given container, initializing it
1102     * from the current contents of the clipboard.
1103     * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1104     * in which to place the data.
1105     * <p>Output: URI of the new data that was created.
1106     */
1107    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108    public static final String ACTION_PASTE = "android.intent.action.PASTE";
1109    /**
1110     * Activity Action: Delete the given data from its container.
1111     * <p>Input: {@link #getData} is URI of data to be deleted.
1112     * <p>Output: nothing.
1113     */
1114    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115    public static final String ACTION_DELETE = "android.intent.action.DELETE";
1116    /**
1117     * Activity Action: Run the data, whatever that means.
1118     * <p>Input: ?  (Note: this is currently specific to the test harness.)
1119     * <p>Output: nothing.
1120     */
1121    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122    public static final String ACTION_RUN = "android.intent.action.RUN";
1123    /**
1124     * Activity Action: Perform a data synchronization.
1125     * <p>Input: ?
1126     * <p>Output: ?
1127     */
1128    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1129    public static final String ACTION_SYNC = "android.intent.action.SYNC";
1130    /**
1131     * Activity Action: Pick an activity given an intent, returning the class
1132     * selected.
1133     * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1134     * used with {@link PackageManager#queryIntentActivities} to determine the
1135     * set of activities from which to pick.
1136     * <p>Output: Class name of the activity that was selected.
1137     */
1138    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139    public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1140    /**
1141     * Activity Action: Perform a search.
1142     * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1143     * is the text to search for.  If empty, simply
1144     * enter your search results Activity with the search UI activated.
1145     * <p>Output: nothing.
1146     */
1147    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148    public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1149    /**
1150     * Activity Action: Start the platform-defined tutorial
1151     * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1152     * is the text to search for.  If empty, simply
1153     * enter your search results Activity with the search UI activated.
1154     * <p>Output: nothing.
1155     */
1156    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157    public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1158    /**
1159     * Activity Action: Perform a web search.
1160     * <p>
1161     * Input: {@link android.app.SearchManager#QUERY
1162     * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1163     * a url starts with http or https, the site will be opened. If it is plain
1164     * text, Google search will be applied.
1165     * <p>
1166     * Output: nothing.
1167     */
1168    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169    public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1170
1171    /**
1172     * Activity Action: Perform assist action.
1173     * <p>
1174     * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1175     * additional optional contextual information about where the user was when they
1176     * requested the assist.
1177     * Output: nothing.
1178     */
1179    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1180    public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1181
1182    /**
1183     * Activity Action: Perform voice assist action.
1184     * <p>
1185     * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1186     * additional optional contextual information about where the user was when they
1187     * requested the voice assist.
1188     * Output: nothing.
1189     * @hide
1190     */
1191    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192    public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1193
1194    /**
1195     * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1196     * application package at the time the assist was invoked.
1197     */
1198    public static final String EXTRA_ASSIST_PACKAGE
1199            = "android.intent.extra.ASSIST_PACKAGE";
1200
1201    /**
1202     * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1203     * information supplied by the current foreground app at the time of the assist request.
1204     * This is a {@link Bundle} of additional data.
1205     */
1206    public static final String EXTRA_ASSIST_CONTEXT
1207            = "android.intent.extra.ASSIST_CONTEXT";
1208
1209    /**
1210     * Activity Action: List all available applications
1211     * <p>Input: Nothing.
1212     * <p>Output: nothing.
1213     */
1214    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215    public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1216    /**
1217     * Activity Action: Show settings for choosing wallpaper
1218     * <p>Input: Nothing.
1219     * <p>Output: Nothing.
1220     */
1221    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1222    public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1223
1224    /**
1225     * Activity Action: Show activity for reporting a bug.
1226     * <p>Input: Nothing.
1227     * <p>Output: Nothing.
1228     */
1229    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230    public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1231
1232    /**
1233     *  Activity Action: Main entry point for factory tests.  Only used when
1234     *  the device is booting in factory test node.  The implementing package
1235     *  must be installed in the system image.
1236     *  <p>Input: nothing
1237     *  <p>Output: nothing
1238     */
1239    public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1240
1241    /**
1242     * Activity Action: The user pressed the "call" button to go to the dialer
1243     * or other appropriate UI for placing a call.
1244     * <p>Input: Nothing.
1245     * <p>Output: Nothing.
1246     */
1247    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1248    public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1249
1250    /**
1251     * Activity Action: Start Voice Command.
1252     * <p>Input: Nothing.
1253     * <p>Output: Nothing.
1254     */
1255    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1256    public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
1257
1258    /**
1259     * Activity Action: Start action associated with long pressing on the
1260     * search key.
1261     * <p>Input: Nothing.
1262     * <p>Output: Nothing.
1263     */
1264    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265    public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
1266
1267    /**
1268     * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1269     * This intent is delivered to the package which installed the application, usually
1270     * Google Play.
1271     * <p>Input: No data is specified. The bug report is passed in using
1272     * an {@link #EXTRA_BUG_REPORT} field.
1273     * <p>Output: Nothing.
1274     *
1275     * @see #EXTRA_BUG_REPORT
1276     */
1277    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1278    public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
1279
1280    /**
1281     * Activity Action: Show power usage information to the user.
1282     * <p>Input: Nothing.
1283     * <p>Output: Nothing.
1284     */
1285    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286    public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1287
1288    /**
1289     * Activity Action: Setup wizard to launch after a platform update.  This
1290     * activity should have a string meta-data field associated with it,
1291     * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1292     * the platform for setup.  The activity will be launched only if
1293     * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1294     * same value.
1295     * <p>Input: Nothing.
1296     * <p>Output: Nothing.
1297     * @hide
1298     */
1299    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1300    public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1301
1302    /**
1303     * Activity Action: Show settings for managing network data usage of a
1304     * specific application. Applications should define an activity that offers
1305     * options to control data usage.
1306     */
1307    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1308    public static final String ACTION_MANAGE_NETWORK_USAGE =
1309            "android.intent.action.MANAGE_NETWORK_USAGE";
1310
1311    /**
1312     * Activity Action: Launch application installer.
1313     * <p>
1314     * Input: The data must be a content: or file: URI at which the application
1315     * can be retrieved.  As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1316     * you can also use "package:<package-name>" to install an application for the
1317     * current user that is already installed for another user. You can optionally supply
1318     * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1319     * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1320     * <p>
1321     * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1322     * succeeded.
1323     *
1324     * @see #EXTRA_INSTALLER_PACKAGE_NAME
1325     * @see #EXTRA_NOT_UNKNOWN_SOURCE
1326     * @see #EXTRA_RETURN_RESULT
1327     */
1328    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1329    public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1330
1331    /**
1332     * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1333     * package.  Specifies the installer package name; this package will receive the
1334     * {@link #ACTION_APP_ERROR} intent.
1335     */
1336    public static final String EXTRA_INSTALLER_PACKAGE_NAME
1337            = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1338
1339    /**
1340     * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1341     * package.  Specifies that the application being installed should not be
1342     * treated as coming from an unknown source, but as coming from the app
1343     * invoking the Intent.  For this to work you must start the installer with
1344     * startActivityForResult().
1345     */
1346    public static final String EXTRA_NOT_UNKNOWN_SOURCE
1347            = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1348
1349    /**
1350     * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1351     * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
1352     * data field originated from.
1353     */
1354    public static final String EXTRA_ORIGINATING_URI
1355            = "android.intent.extra.ORIGINATING_URI";
1356
1357    /**
1358     * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1359     * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1360     * data field or {@link #EXTRA_ORIGINATING_URI}.
1361     */
1362    public static final String EXTRA_REFERRER
1363            = "android.intent.extra.REFERRER";
1364
1365    /**
1366     * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1367     * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1368     * @hide
1369     */
1370    public static final String EXTRA_ORIGINATING_UID
1371            = "android.intent.extra.ORIGINATING_UID";
1372
1373    /**
1374     * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1375     * package.  Tells the installer UI to skip the confirmation with the user
1376     * if the .apk is replacing an existing one.
1377     * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1378     * will no longer show an interstitial message about updating existing
1379     * applications so this is no longer needed.
1380     */
1381    @Deprecated
1382    public static final String EXTRA_ALLOW_REPLACE
1383            = "android.intent.extra.ALLOW_REPLACE";
1384
1385    /**
1386     * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1387     * {@link #ACTION_UNINSTALL_PACKAGE}.  Specifies that the installer UI should
1388     * return to the application the result code of the install/uninstall.  The returned result
1389     * code will be {@link android.app.Activity#RESULT_OK} on success or
1390     * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1391     */
1392    public static final String EXTRA_RETURN_RESULT
1393            = "android.intent.extra.RETURN_RESULT";
1394
1395    /**
1396     * Package manager install result code.  @hide because result codes are not
1397     * yet ready to be exposed.
1398     */
1399    public static final String EXTRA_INSTALL_RESULT
1400            = "android.intent.extra.INSTALL_RESULT";
1401
1402    /**
1403     * Activity Action: Launch application uninstaller.
1404     * <p>
1405     * Input: The data must be a package: URI whose scheme specific part is
1406     * the package name of the current installed package to be uninstalled.
1407     * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1408     * <p>
1409     * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1410     * succeeded.
1411     */
1412    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1413    public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1414
1415    /**
1416     * Activity Action: Prompt the user to confirm credentials (pin, pattern or password)
1417     * for the current user of the device. Launch this activity using
1418     * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
1419     * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
1420     * challenge.<p/>
1421     * This intent is handled by the system at a high priority and applications cannot intercept
1422     * it.<p/>
1423     * You can use {@link android.app.KeyguardManager#isKeyguardSecure()} to determine if the user will be
1424     * prompted.
1425     */
1426    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1427    public static final String ACTION_CONFIRM_DEVICE_CREDENTIAL = "android.intent.action.CONFIRM_DEVICE_CREDENTIAL";
1428
1429
1430    /**
1431     * Specify whether the package should be uninstalled for all users.
1432     * @hide because these should not be part of normal application flow.
1433     */
1434    public static final String EXTRA_UNINSTALL_ALL_USERS
1435            = "android.intent.extra.UNINSTALL_ALL_USERS";
1436
1437    /**
1438     * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1439     * describing the last run version of the platform that was setup.
1440     * @hide
1441     */
1442    public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1443
1444    // ---------------------------------------------------------------------
1445    // ---------------------------------------------------------------------
1446    // Standard intent broadcast actions (see action variable).
1447
1448    /**
1449     * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1450     * <p>
1451     * For historical reasons, the name of this broadcast action refers to the power
1452     * state of the screen but it is actually sent in response to changes in the
1453     * overall interactive state of the device.
1454     * </p><p>
1455     * This broadcast is sent when the device becomes non-interactive which may have
1456     * nothing to do with the screen turning off.  To determine the
1457     * actual state of the screen, use {@link android.view.Display#getState}.
1458     * </p><p>
1459     * See {@link android.os.PowerManager#isInteractive} for details.
1460     * </p>
1461     *
1462     * <p class="note">This is a protected intent that can only be sent
1463     * by the system.
1464     */
1465    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1466    public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1467
1468    /**
1469     * Broadcast Action: Sent when the device wakes up and becomes interactive.
1470     * <p>
1471     * For historical reasons, the name of this broadcast action refers to the power
1472     * state of the screen but it is actually sent in response to changes in the
1473     * overall interactive state of the device.
1474     * </p><p>
1475     * This broadcast is sent when the device becomes interactive which may have
1476     * nothing to do with the screen turning on.  To determine the
1477     * actual state of the screen, use {@link android.view.Display#getState}.
1478     * </p><p>
1479     * See {@link android.os.PowerManager#isInteractive} for details.
1480     * </p>
1481     *
1482     * <p class="note">This is a protected intent that can only be sent
1483     * by the system.
1484     */
1485    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1486    public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
1487
1488    /**
1489     * Broadcast Action: Sent after the system stops dreaming.
1490     *
1491     * <p class="note">This is a protected intent that can only be sent by the system.
1492     * It is only sent to registered receivers.</p>
1493     */
1494    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495    public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1496
1497    /**
1498     * Broadcast Action: Sent after the system starts dreaming.
1499     *
1500     * <p class="note">This is a protected intent that can only be sent by the system.
1501     * It is only sent to registered receivers.</p>
1502     */
1503    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504    public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1505
1506    /**
1507     * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
1508     * keyguard is gone).
1509     *
1510     * <p class="note">This is a protected intent that can only be sent
1511     * by the system.
1512     */
1513    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514    public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
1515
1516    /**
1517     * Broadcast Action: The current time has changed.  Sent every
1518     * minute.  You can <em>not</em> receive this through components declared
1519     * in manifests, only by explicitly registering for it with
1520     * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1521     * Context.registerReceiver()}.
1522     *
1523     * <p class="note">This is a protected intent that can only be sent
1524     * by the system.
1525     */
1526    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1527    public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1528    /**
1529     * Broadcast Action: The time was set.
1530     */
1531    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1532    public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1533    /**
1534     * Broadcast Action: The date has changed.
1535     */
1536    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1537    public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1538    /**
1539     * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1540     * <ul>
1541     *   <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1542     * </ul>
1543     *
1544     * <p class="note">This is a protected intent that can only be sent
1545     * by the system.
1546     */
1547    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1548    public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1549    /**
1550     * Clear DNS Cache Action: This is broadcast when networks have changed and old
1551     * DNS entries should be tossed.
1552     * @hide
1553     */
1554    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1555    public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1556    /**
1557     * Alarm Changed Action: This is broadcast when the AlarmClock
1558     * application's alarm is set or unset.  It is used by the
1559     * AlarmClock application and the StatusBar service.
1560     * @hide
1561     */
1562    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1563    public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1564    /**
1565     * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1566     * been failing for a long time.  It is used by the SyncManager and the StatusBar service.
1567     * @hide
1568     */
1569    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1570    public static final String ACTION_SYNC_STATE_CHANGED
1571            = "android.intent.action.SYNC_STATE_CHANGED";
1572    /**
1573     * Broadcast Action: This is broadcast once, after the system has finished
1574     * booting.  It can be used to perform application-specific initialization,
1575     * such as installing alarms.  You must hold the
1576     * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1577     * in order to receive this broadcast.
1578     *
1579     * <p class="note">This is a protected intent that can only be sent
1580     * by the system.
1581     */
1582    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1583    public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1584    /**
1585     * Broadcast Action: This is broadcast when a user action should request a
1586     * temporary system dialog to dismiss.  Some examples of temporary system
1587     * dialogs are the notification window-shade and the recent tasks dialog.
1588     */
1589    public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1590    /**
1591     * Broadcast Action: Trigger the download and eventual installation
1592     * of a package.
1593     * <p>Input: {@link #getData} is the URI of the package file to download.
1594     *
1595     * <p class="note">This is a protected intent that can only be sent
1596     * by the system.
1597     *
1598     * @deprecated This constant has never been used.
1599     */
1600    @Deprecated
1601    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602    public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1603    /**
1604     * Broadcast Action: A new application package has been installed on the
1605     * device. The data contains the name of the package.  Note that the
1606     * newly installed package does <em>not</em> receive this broadcast.
1607     * <p>May include the following extras:
1608     * <ul>
1609     * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1610     * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1611     * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1612     * </ul>
1613     *
1614     * <p class="note">This is a protected intent that can only be sent
1615     * by the system.
1616     */
1617    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1618    public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1619    /**
1620     * Broadcast Action: A new version of an application package has been
1621     * installed, replacing an existing version that was previously installed.
1622     * The data contains the name of the package.
1623     * <p>May include the following extras:
1624     * <ul>
1625     * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1626     * </ul>
1627     *
1628     * <p class="note">This is a protected intent that can only be sent
1629     * by the system.
1630     */
1631    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1632    public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1633    /**
1634     * Broadcast Action: A new version of your application has been installed
1635     * over an existing one.  This is only sent to the application that was
1636     * replaced.  It does not contain any additional data; to receive it, just
1637     * use an intent filter for this action.
1638     *
1639     * <p class="note">This is a protected intent that can only be sent
1640     * by the system.
1641     */
1642    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1643    public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1644    /**
1645     * Broadcast Action: An existing application package has been removed from
1646     * the device.  The data contains the name of the package.  The package
1647     * that is being installed does <em>not</em> receive this Intent.
1648     * <ul>
1649     * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1650     * to the package.
1651     * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1652     * application -- data and code -- is being removed.
1653     * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1654     * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1655     * </ul>
1656     *
1657     * <p class="note">This is a protected intent that can only be sent
1658     * by the system.
1659     */
1660    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1661    public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1662    /**
1663     * Broadcast Action: An existing application package has been completely
1664     * removed from the device.  The data contains the name of the package.
1665     * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1666     * {@link #EXTRA_DATA_REMOVED} is true and
1667     * {@link #EXTRA_REPLACING} is false of that broadcast.
1668     *
1669     * <ul>
1670     * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1671     * to the package.
1672     * </ul>
1673     *
1674     * <p class="note">This is a protected intent that can only be sent
1675     * by the system.
1676     */
1677    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1678    public static final String ACTION_PACKAGE_FULLY_REMOVED
1679            = "android.intent.action.PACKAGE_FULLY_REMOVED";
1680    /**
1681     * Broadcast Action: An existing application package has been changed (e.g.
1682     * a component has been enabled or disabled).  The data contains the name of
1683     * the package.
1684     * <ul>
1685     * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1686     * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1687     * of the changed components (or the package name itself).
1688     * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1689     * default action of restarting the application.
1690     * </ul>
1691     *
1692     * <p class="note">This is a protected intent that can only be sent
1693     * by the system.
1694     */
1695    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1696    public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1697    /**
1698     * @hide
1699     * Broadcast Action: Ask system services if there is any reason to
1700     * restart the given package.  The data contains the name of the
1701     * package.
1702     * <ul>
1703     * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1704     * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1705     * </ul>
1706     *
1707     * <p class="note">This is a protected intent that can only be sent
1708     * by the system.
1709     */
1710    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1711    public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1712    /**
1713     * Broadcast Action: The user has restarted a package, and all of its
1714     * processes have been killed.  All runtime state
1715     * associated with it (processes, alarms, notifications, etc) should
1716     * be removed.  Note that the restarted package does <em>not</em>
1717     * receive this broadcast.
1718     * The data contains the name of the package.
1719     * <ul>
1720     * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1721     * </ul>
1722     *
1723     * <p class="note">This is a protected intent that can only be sent
1724     * by the system.
1725     */
1726    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1727    public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1728    /**
1729     * Broadcast Action: The user has cleared the data of a package.  This should
1730     * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
1731     * its persistent data is erased and this broadcast sent.
1732     * Note that the cleared package does <em>not</em>
1733     * receive this broadcast. The data contains the name of the package.
1734     * <ul>
1735     * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1736     * </ul>
1737     *
1738     * <p class="note">This is a protected intent that can only be sent
1739     * by the system.
1740     */
1741    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1742    public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1743    /**
1744     * Broadcast Action: A user ID has been removed from the system.  The user
1745     * ID number is stored in the extra data under {@link #EXTRA_UID}.
1746     *
1747     * <p class="note">This is a protected intent that can only be sent
1748     * by the system.
1749     */
1750    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1751    public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1752
1753    /**
1754     * Broadcast Action: Sent to the installer package of an application
1755     * when that application is first launched (that is the first time it
1756     * is moved out of the stopped state).  The data contains the name of the package.
1757     *
1758     * <p class="note">This is a protected intent that can only be sent
1759     * by the system.
1760     */
1761    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1762    public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1763
1764    /**
1765     * Broadcast Action: Sent to the system package verifier when a package
1766     * needs to be verified. The data contains the package URI.
1767     * <p class="note">
1768     * This is a protected intent that can only be sent by the system.
1769     * </p>
1770     */
1771    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772    public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1773
1774    /**
1775     * Broadcast Action: Sent to the system package verifier when a package is
1776     * verified. The data contains the package URI.
1777     * <p class="note">
1778     * This is a protected intent that can only be sent by the system.
1779     */
1780    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781    public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1782
1783    /**
1784     * Broadcast Action: Resources for a set of packages (which were
1785     * previously unavailable) are currently
1786     * available since the media on which they exist is available.
1787     * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1788     * list of packages whose availability changed.
1789     * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1790     * list of uids of packages whose availability changed.
1791     * Note that the
1792     * packages in this list do <em>not</em> receive this broadcast.
1793     * The specified set of packages are now available on the system.
1794     * <p>Includes the following extras:
1795     * <ul>
1796     * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1797     * whose resources(were previously unavailable) are currently available.
1798     * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1799     * packages whose resources(were previously unavailable)
1800     * are  currently available.
1801     * </ul>
1802     *
1803     * <p class="note">This is a protected intent that can only be sent
1804     * by the system.
1805     */
1806    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1807    public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1808        "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
1809
1810    /**
1811     * Broadcast Action: Resources for a set of packages are currently
1812     * unavailable since the media on which they exist is unavailable.
1813     * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1814     * list of packages whose availability changed.
1815     * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1816     * list of uids of packages whose availability changed.
1817     * The specified set of packages can no longer be
1818     * launched and are practically unavailable on the system.
1819     * <p>Inclues the following extras:
1820     * <ul>
1821     * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1822     * whose resources are no longer available.
1823     * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1824     * whose resources are no longer available.
1825     * </ul>
1826     *
1827     * <p class="note">This is a protected intent that can only be sent
1828     * by the system.
1829     */
1830    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1831    public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
1832        "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
1833
1834    /**
1835     * Broadcast Action:  The current system wallpaper has changed.  See
1836     * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
1837     * This should <em>only</em> be used to determine when the wallpaper
1838     * has changed to show the new wallpaper to the user.  You should certainly
1839     * never, in response to this, change the wallpaper or other attributes of
1840     * it such as the suggested size.  That would be crazy, right?  You'd cause
1841     * all kinds of loops, especially if other apps are doing similar things,
1842     * right?  Of course.  So please don't do this.
1843     *
1844     * @deprecated Modern applications should use
1845     * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1846     * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1847     * shown behind their UI, rather than watching for this broadcast and
1848     * rendering the wallpaper on their own.
1849     */
1850    @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851    public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1852    /**
1853     * Broadcast Action: The current device {@link android.content.res.Configuration}
1854     * (orientation, locale, etc) has changed.  When such a change happens, the
1855     * UIs (view hierarchy) will need to be rebuilt based on this new
1856     * information; for the most part, applications don't need to worry about
1857     * this, because the system will take care of stopping and restarting the
1858     * application to make sure it sees the new changes.  Some system code that
1859     * can not be restarted will need to watch for this action and handle it
1860     * appropriately.
1861     *
1862     * <p class="note">
1863     * You can <em>not</em> receive this through components declared
1864     * in manifests, only by explicitly registering for it with
1865     * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1866     * Context.registerReceiver()}.
1867     *
1868     * <p class="note">This is a protected intent that can only be sent
1869     * by the system.
1870     *
1871     * @see android.content.res.Configuration
1872     */
1873    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1874    public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1875    /**
1876     * Broadcast Action: The current device's locale has changed.
1877     *
1878     * <p class="note">This is a protected intent that can only be sent
1879     * by the system.
1880     */
1881    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882    public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1883    /**
1884     * Broadcast Action:  This is a <em>sticky broadcast</em> containing the
1885     * charging state, level, and other information about the battery.
1886     * See {@link android.os.BatteryManager} for documentation on the
1887     * contents of the Intent.
1888     *
1889     * <p class="note">
1890     * You can <em>not</em> receive this through components declared
1891     * in manifests, only by explicitly registering for it with
1892     * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1893     * Context.registerReceiver()}.  See {@link #ACTION_BATTERY_LOW},
1894     * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1895     * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1896     * broadcasts that are sent and can be received through manifest
1897     * receivers.
1898     *
1899     * <p class="note">This is a protected intent that can only be sent
1900     * by the system.
1901     */
1902    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903    public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1904    /**
1905     * Broadcast Action:  Indicates low battery condition on the device.
1906     * This broadcast corresponds to the "Low battery warning" system dialog.
1907     *
1908     * <p class="note">This is a protected intent that can only be sent
1909     * by the system.
1910     */
1911    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912    public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1913    /**
1914     * Broadcast Action:  Indicates the battery is now okay after being low.
1915     * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1916     * gone back up to an okay state.
1917     *
1918     * <p class="note">This is a protected intent that can only be sent
1919     * by the system.
1920     */
1921    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922    public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1923    /**
1924     * Broadcast Action:  External power has been connected to the device.
1925     * This is intended for applications that wish to register specifically to this notification.
1926     * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1927     * stay active to receive this notification.  This action can be used to implement actions
1928     * that wait until power is available to trigger.
1929     *
1930     * <p class="note">This is a protected intent that can only be sent
1931     * by the system.
1932     */
1933    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1934    public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
1935    /**
1936     * Broadcast Action:  External power has been removed from the device.
1937     * This is intended for applications that wish to register specifically to this notification.
1938     * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1939     * stay active to receive this notification.  This action can be used to implement actions
1940     * that wait until power is available to trigger.
1941     *
1942     * <p class="note">This is a protected intent that can only be sent
1943     * by the system.
1944     */
1945    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1946    public static final String ACTION_POWER_DISCONNECTED =
1947            "android.intent.action.ACTION_POWER_DISCONNECTED";
1948    /**
1949     * Broadcast Action:  Device is shutting down.
1950     * This is broadcast when the device is being shut down (completely turned
1951     * off, not sleeping).  Once the broadcast is complete, the final shutdown
1952     * will proceed and all unsaved data lost.  Apps will not normally need
1953     * to handle this, since the foreground activity will be paused as well.
1954     *
1955     * <p class="note">This is a protected intent that can only be sent
1956     * by the system.
1957     * <p>May include the following extras:
1958     * <ul>
1959     * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1960     * shutdown is only for userspace processes.  If not set, assumed to be false.
1961     * </ul>
1962     */
1963    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964    public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
1965    /**
1966     * Activity Action:  Start this activity to request system shutdown.
1967     * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1968     * to request confirmation from the user before shutting down.
1969     *
1970     * <p class="note">This is a protected intent that can only be sent
1971     * by the system.
1972     *
1973     * {@hide}
1974     */
1975    public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1976    /**
1977     * Broadcast Action:  A sticky broadcast that indicates low memory
1978     * condition on the device
1979     *
1980     * <p class="note">This is a protected intent that can only be sent
1981     * by the system.
1982     */
1983    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1984    public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1985    /**
1986     * Broadcast Action:  Indicates low memory condition on the device no longer exists
1987     *
1988     * <p class="note">This is a protected intent that can only be sent
1989     * by the system.
1990     */
1991    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1992    public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1993    /**
1994     * Broadcast Action:  A sticky broadcast that indicates a memory full
1995     * condition on the device. This is intended for activities that want
1996     * to be able to fill the data partition completely, leaving only
1997     * enough free space to prevent system-wide SQLite failures.
1998     *
1999     * <p class="note">This is a protected intent that can only be sent
2000     * by the system.
2001     *
2002     * {@hide}
2003     */
2004    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005    public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2006    /**
2007     * Broadcast Action:  Indicates memory full condition on the device
2008     * no longer exists.
2009     *
2010     * <p class="note">This is a protected intent that can only be sent
2011     * by the system.
2012     *
2013     * {@hide}
2014     */
2015    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016    public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2017    /**
2018     * Broadcast Action:  Indicates low memory condition notification acknowledged by user
2019     * and package management should be started.
2020     * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2021     * notification.
2022     */
2023    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024    public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2025    /**
2026     * Broadcast Action:  The device has entered USB Mass Storage mode.
2027     * This is used mainly for the USB Settings panel.
2028     * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2029     * when the SD card file system is mounted or unmounted
2030     * @deprecated replaced by android.os.storage.StorageEventListener
2031     */
2032    @Deprecated
2033    public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2034
2035    /**
2036     * Broadcast Action:  The device has exited USB Mass Storage mode.
2037     * This is used mainly for the USB Settings panel.
2038     * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2039     * when the SD card file system is mounted or unmounted
2040     * @deprecated replaced by android.os.storage.StorageEventListener
2041     */
2042    @Deprecated
2043    public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2044
2045    /**
2046     * Broadcast Action:  External media has been removed.
2047     * The path to the mount point for the removed media is contained in the Intent.mData field.
2048     */
2049    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2050    public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2051
2052    /**
2053     * Broadcast Action:  External media is present, but not mounted at its mount point.
2054     * The path to the mount point for the unmounted media is contained in the Intent.mData field.
2055     */
2056    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2057    public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2058
2059    /**
2060     * Broadcast Action:  External media is present, and being disk-checked
2061     * The path to the mount point for the checking media is contained in the Intent.mData field.
2062     */
2063    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2064    public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2065
2066    /**
2067     * Broadcast Action:  External media is present, but is using an incompatible fs (or is blank)
2068     * The path to the mount point for the checking media is contained in the Intent.mData field.
2069     */
2070    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071    public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2072
2073    /**
2074     * Broadcast Action:  External media is present and mounted at its mount point.
2075     * The path to the mount point for the mounted media is contained in the Intent.mData field.
2076     * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2077     * media was mounted read only.
2078     */
2079    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080    public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2081
2082    /**
2083     * Broadcast Action:  External media is unmounted because it is being shared via USB mass storage.
2084     * The path to the mount point for the shared media is contained in the Intent.mData field.
2085     */
2086    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2087    public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2088
2089    /**
2090     * Broadcast Action:  External media is no longer being shared via USB mass storage.
2091     * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2092     *
2093     * @hide
2094     */
2095    public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2096
2097    /**
2098     * Broadcast Action:  External media was removed from SD card slot, but mount point was not unmounted.
2099     * The path to the mount point for the removed media is contained in the Intent.mData field.
2100     */
2101    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102    public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2103
2104    /**
2105     * Broadcast Action:  External media is present but cannot be mounted.
2106     * The path to the mount point for the unmountable media is contained in the Intent.mData field.
2107     */
2108    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109    public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2110
2111   /**
2112     * Broadcast Action:  User has expressed the desire to remove the external storage media.
2113     * Applications should close all files they have open within the mount point when they receive this intent.
2114     * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2115     */
2116    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117    public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2118
2119    /**
2120     * Broadcast Action:  The media scanner has started scanning a directory.
2121     * The path to the directory being scanned is contained in the Intent.mData field.
2122     */
2123    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124    public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2125
2126   /**
2127     * Broadcast Action:  The media scanner has finished scanning a directory.
2128     * The path to the scanned directory is contained in the Intent.mData field.
2129     */
2130    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2131    public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2132
2133   /**
2134     * Broadcast Action:  Request the media scanner to scan a file and add it to the media database.
2135     * The path to the file is contained in the Intent.mData field.
2136     */
2137    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2138    public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2139
2140   /**
2141     * Broadcast Action:  The "Media Button" was pressed.  Includes a single
2142     * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2143     * caused the broadcast.
2144     */
2145    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2146    public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2147
2148    /**
2149     * Broadcast Action:  The "Camera Button" was pressed.  Includes a single
2150     * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2151     * caused the broadcast.
2152     */
2153    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154    public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2155
2156    // *** NOTE: @todo(*) The following really should go into a more domain-specific
2157    // location; they are not general-purpose actions.
2158
2159    /**
2160     * Broadcast Action: A GTalk connection has been established.
2161     */
2162    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2163    public static final String ACTION_GTALK_SERVICE_CONNECTED =
2164            "android.intent.action.GTALK_CONNECTED";
2165
2166    /**
2167     * Broadcast Action: A GTalk connection has been disconnected.
2168     */
2169    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170    public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2171            "android.intent.action.GTALK_DISCONNECTED";
2172
2173    /**
2174     * Broadcast Action: An input method has been changed.
2175     */
2176    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177    public static final String ACTION_INPUT_METHOD_CHANGED =
2178            "android.intent.action.INPUT_METHOD_CHANGED";
2179
2180    /**
2181     * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2182     * more radios have been turned off or on. The intent will have the following extra value:</p>
2183     * <ul>
2184     *   <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2185     *   then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2186     *   turned off</li>
2187     * </ul>
2188     *
2189     * <p class="note">This is a protected intent that can only be sent
2190     * by the system.
2191     */
2192    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193    public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2194
2195    /**
2196     * Broadcast Action: Some content providers have parts of their namespace
2197     * where they publish new events or items that the user may be especially
2198     * interested in. For these things, they may broadcast this action when the
2199     * set of interesting items change.
2200     *
2201     * For example, GmailProvider sends this notification when the set of unread
2202     * mail in the inbox changes.
2203     *
2204     * <p>The data of the intent identifies which part of which provider
2205     * changed. When queried through the content resolver, the data URI will
2206     * return the data set in question.
2207     *
2208     * <p>The intent will have the following extra values:
2209     * <ul>
2210     *   <li><em>count</em> - The number of items in the data set. This is the
2211     *       same as the number of items in the cursor returned by querying the
2212     *       data URI. </li>
2213     * </ul>
2214     *
2215     * This intent will be sent at boot (if the count is non-zero) and when the
2216     * data set changes. It is possible for the data set to change without the
2217     * count changing (for example, if a new unread message arrives in the same
2218     * sync operation in which a message is archived). The phone should still
2219     * ring/vibrate/etc as normal in this case.
2220     */
2221    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2222    public static final String ACTION_PROVIDER_CHANGED =
2223            "android.intent.action.PROVIDER_CHANGED";
2224
2225    /**
2226     * Broadcast Action: Wired Headset plugged in or unplugged.
2227     *
2228     * You <em>cannot</em> receive this through components declared
2229     * in manifests, only by explicitly registering for it with
2230     * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2231     * Context.registerReceiver()}.
2232     *
2233     * <p>The intent will have the following extra values:
2234     * <ul>
2235     *   <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2236     *   <li><em>name</em> - Headset type, human readable string </li>
2237     *   <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
2238     * </ul>
2239     * </ul>
2240     */
2241    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242    public static final String ACTION_HEADSET_PLUG =
2243            "android.intent.action.HEADSET_PLUG";
2244
2245    /**
2246     * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2247     *
2248     * <p>The intent will have the following extra values:
2249     * <ul>
2250     *   <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2251     *   <li><em>name</em> - Headset type, human readable string </li>
2252     * </ul>
2253     * </ul>
2254     * @hide
2255     */
2256    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2257    public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2258            "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
2259
2260    /**
2261     * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
2262     *
2263     * <p>The intent will have the following extra values:
2264     * <ul>
2265     *   <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2266     *   <li><em>name</em> - Headset type, human readable string </li>
2267     * </ul>
2268     * </ul>
2269     * @hide
2270     */
2271    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2272    public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2273            "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
2274
2275    /**
2276     * Broadcast Action: A HMDI cable was plugged or unplugged
2277     *
2278     * <p>The intent will have the following extra values:
2279     * <ul>
2280     *   <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2281     *   <li><em>name</em> - HDMI cable, human readable string </li>
2282     * </ul>
2283     * </ul>
2284     * @hide
2285     */
2286    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287    public static final String ACTION_HDMI_AUDIO_PLUG =
2288            "android.intent.action.HDMI_AUDIO_PLUG";
2289
2290    /**
2291     * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2292     *
2293     * <p>The intent will have the following extra values:
2294     * <ul>
2295     *   <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2296     *   <li><em>card</em> - ALSA card number (integer) </li>
2297     *   <li><em>device</em> - ALSA device number (integer) </li>
2298     * </ul>
2299     * </ul>
2300     * @hide
2301     */
2302    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2303    public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2304            "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2305
2306    /**
2307     * Broadcast Action: A USB audio device was plugged in or unplugged.
2308     *
2309     * <p>The intent will have the following extra values:
2310     * <ul>
2311     *   <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2312     *   <li><em>card</em> - ALSA card number (integer) </li>
2313     *   <li><em>device</em> - ALSA device number (integer) </li>
2314     * </ul>
2315     * </ul>
2316     * @hide
2317     */
2318    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2319    public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2320            "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2321
2322    /**
2323     * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2324     * <ul>
2325     *   <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2326     * </ul>
2327     *
2328     * <p class="note">This is a protected intent that can only be sent
2329     * by the system.
2330     *
2331     * @hide
2332     */
2333    //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2334    public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2335            = "android.intent.action.ADVANCED_SETTINGS";
2336
2337    /**
2338     *  Broadcast Action: Sent after application restrictions are changed.
2339     *
2340     * <p class="note">This is a protected intent that can only be sent
2341     * by the system.</p>
2342     */
2343    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2344    public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2345            "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2346
2347    /**
2348     * Broadcast Action: An outgoing call is about to be placed.
2349     *
2350     * <p>The Intent will have the following extra value:</p>
2351     * <ul>
2352     *   <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
2353     *       the phone number originally intended to be dialed.</li>
2354     * </ul>
2355     * <p>Once the broadcast is finished, the resultData is used as the actual
2356     * number to call.  If  <code>null</code>, no call will be placed.</p>
2357     * <p>It is perfectly acceptable for multiple receivers to process the
2358     * outgoing call in turn: for example, a parental control application
2359     * might verify that the user is authorized to place the call at that
2360     * time, then a number-rewriting application might add an area code if
2361     * one was not specified.</p>
2362     * <p>For consistency, any receiver whose purpose is to prohibit phone
2363     * calls should have a priority of 0, to ensure it will see the final
2364     * phone number to be dialed.
2365     * Any receiver whose purpose is to rewrite phone numbers to be called
2366     * should have a positive priority.
2367     * Negative priorities are reserved for the system for this broadcast;
2368     * using them may cause problems.</p>
2369     * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2370     * abort the broadcast.</p>
2371     * <p>Emergency calls cannot be intercepted using this mechanism, and
2372     * other calls cannot be modified to call emergency numbers using this
2373     * mechanism.
2374     * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2375     * call to use their own service instead. Those apps should first prevent
2376     * the call from being placed by setting resultData to <code>null</code>
2377     * and then start their own app to make the call.
2378     * <p>You must hold the
2379     * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2380     * permission to receive this Intent.</p>
2381     *
2382     * <p class="note">This is a protected intent that can only be sent
2383     * by the system.
2384     */
2385    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2386    public static final String ACTION_NEW_OUTGOING_CALL =
2387            "android.intent.action.NEW_OUTGOING_CALL";
2388
2389    /**
2390     * Broadcast Action: Have the device reboot.  This is only for use by
2391     * system code.
2392     *
2393     * <p class="note">This is a protected intent that can only be sent
2394     * by the system.
2395     */
2396    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397    public static final String ACTION_REBOOT =
2398            "android.intent.action.REBOOT";
2399
2400    /**
2401     * Broadcast Action:  A sticky broadcast for changes in the physical
2402     * docking state of the device.
2403     *
2404     * <p>The intent will have the following extra values:
2405     * <ul>
2406     *   <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
2407     *       state, indicating which dock the device is physically in.</li>
2408     * </ul>
2409     * <p>This is intended for monitoring the current physical dock state.
2410     * See {@link android.app.UiModeManager} for the normal API dealing with
2411     * dock mode changes.
2412     */
2413    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414    public static final String ACTION_DOCK_EVENT =
2415            "android.intent.action.DOCK_EVENT";
2416
2417    /**
2418     * Broadcast Action: A broadcast when idle maintenance can be started.
2419     * This means that the user is not interacting with the device and is
2420     * not expected to do so soon. Typical use of the idle maintenance is
2421     * to perform somehow expensive tasks that can be postponed at a moment
2422     * when they will not degrade user experience.
2423     * <p>
2424     * <p class="note">In order to keep the device responsive in case of an
2425     * unexpected user interaction, implementations of a maintenance task
2426     * should be interruptible. In such a scenario a broadcast with action
2427     * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2428     * should not do the maintenance work in
2429     * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2430     * maintenance service by {@link Context#startService(Intent)}. Also
2431     * you should hold a wake lock while your maintenance service is running
2432     * to prevent the device going to sleep.
2433     * </p>
2434     * <p>
2435     * <p class="note">This is a protected intent that can only be sent by
2436     * the system.
2437     * </p>
2438     *
2439     * @see #ACTION_IDLE_MAINTENANCE_END
2440     *
2441     * @hide
2442     */
2443    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2444    public static final String ACTION_IDLE_MAINTENANCE_START =
2445            "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2446
2447    /**
2448     * Broadcast Action:  A broadcast when idle maintenance should be stopped.
2449     * This means that the user was not interacting with the device as a result
2450     * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2451     * was sent and now the user started interacting with the device. Typical
2452     * use of the idle maintenance is to perform somehow expensive tasks that
2453     * can be postponed at a moment when they will not degrade user experience.
2454     * <p>
2455     * <p class="note">In order to keep the device responsive in case of an
2456     * unexpected user interaction, implementations of a maintenance task
2457     * should be interruptible. Hence, on receiving a broadcast with this
2458     * action, the maintenance task should be interrupted as soon as possible.
2459     * In other words, you should not do the maintenance work in
2460     * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2461     * maintenance service that was started on receiving of
2462     * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2463     * lock you acquired when your maintenance service started.
2464     * </p>
2465     * <p class="note">This is a protected intent that can only be sent
2466     * by the system.
2467     *
2468     * @see #ACTION_IDLE_MAINTENANCE_START
2469     *
2470     * @hide
2471     */
2472    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2473    public static final String ACTION_IDLE_MAINTENANCE_END =
2474            "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2475
2476    /**
2477     * Broadcast Action: a remote intent is to be broadcasted.
2478     *
2479     * A remote intent is used for remote RPC between devices. The remote intent
2480     * is serialized and sent from one device to another device. The receiving
2481     * device parses the remote intent and broadcasts it. Note that anyone can
2482     * broadcast a remote intent. However, if the intent receiver of the remote intent
2483     * does not trust intent broadcasts from arbitrary intent senders, it should require
2484     * the sender to hold certain permissions so only trusted sender's broadcast will be
2485     * let through.
2486     * @hide
2487     */
2488    public static final String ACTION_REMOTE_INTENT =
2489            "com.google.android.c2dm.intent.RECEIVE";
2490
2491    /**
2492     * Broadcast Action: hook for permforming cleanup after a system update.
2493     *
2494     * The broadcast is sent when the system is booting, before the
2495     * BOOT_COMPLETED broadcast.  It is only sent to receivers in the system
2496     * image.  A receiver for this should do its work and then disable itself
2497     * so that it does not get run again at the next boot.
2498     * @hide
2499     */
2500    public static final String ACTION_PRE_BOOT_COMPLETED =
2501            "android.intent.action.PRE_BOOT_COMPLETED";
2502
2503    /**
2504     * Broadcast to a specific application to query any supported restrictions to impose
2505     * on restricted users. The broadcast intent contains an extra
2506     * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2507     * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2508     * String[] depending on the restriction type.<p/>
2509     * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
2510     * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2511     * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2512     * The activity specified by that intent will be launched for a result which must contain
2513     * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2514     * The keys and values of the returned restrictions will be persisted.
2515     * @see RestrictionEntry
2516     */
2517    public static final String ACTION_GET_RESTRICTION_ENTRIES =
2518            "android.intent.action.GET_RESTRICTION_ENTRIES";
2519
2520    /**
2521     * @hide
2522     * Activity to challenge the user for a PIN that was configured when setting up
2523     * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2524     * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2525     * Launch the activity using
2526     * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2527     * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2528     * challenge.<p/>
2529     * Before launching this activity, make sure that there is a PIN in effect, by calling
2530     * {@link android.os.UserManager#hasRestrictionsChallenge()}.
2531     */
2532    public static final String ACTION_RESTRICTIONS_CHALLENGE =
2533            "android.intent.action.RESTRICTIONS_CHALLENGE";
2534
2535    /**
2536     * Sent the first time a user is starting, to allow system apps to
2537     * perform one time initialization.  (This will not be seen by third
2538     * party applications because a newly initialized user does not have any
2539     * third party applications installed for it.)  This is sent early in
2540     * starting the user, around the time the home app is started, before
2541     * {@link #ACTION_BOOT_COMPLETED} is sent.  This is sent as a foreground
2542     * broadcast, since it is part of a visible user interaction; be as quick
2543     * as possible when handling it.
2544     */
2545    public static final String ACTION_USER_INITIALIZE =
2546            "android.intent.action.USER_INITIALIZE";
2547
2548    /**
2549     * Sent when a user switch is happening, causing the process's user to be
2550     * brought to the foreground.  This is only sent to receivers registered
2551     * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2552     * Context.registerReceiver}.  It is sent to the user that is going to the
2553     * foreground.  This is sent as a foreground
2554     * broadcast, since it is part of a visible user interaction; be as quick
2555     * as possible when handling it.
2556     */
2557    public static final String ACTION_USER_FOREGROUND =
2558            "android.intent.action.USER_FOREGROUND";
2559
2560    /**
2561     * Sent when a user switch is happening, causing the process's user to be
2562     * sent to the background.  This is only sent to receivers registered
2563     * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2564     * Context.registerReceiver}.  It is sent to the user that is going to the
2565     * background.  This is sent as a foreground
2566     * broadcast, since it is part of a visible user interaction; be as quick
2567     * as possible when handling it.
2568     */
2569    public static final String ACTION_USER_BACKGROUND =
2570            "android.intent.action.USER_BACKGROUND";
2571
2572    /**
2573     * Broadcast sent to the system when a user is added. Carries an extra
2574     * EXTRA_USER_HANDLE that has the userHandle of the new user.  It is sent to
2575     * all running users.  You must hold
2576     * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
2577     * @hide
2578     */
2579    public static final String ACTION_USER_ADDED =
2580            "android.intent.action.USER_ADDED";
2581
2582    /**
2583     * Broadcast sent by the system when a user is started. Carries an extra
2584     * EXTRA_USER_HANDLE that has the userHandle of the user.  This is only sent to
2585     * registered receivers, not manifest receivers.  It is sent to the user
2586     * that has been started.  This is sent as a foreground
2587     * broadcast, since it is part of a visible user interaction; be as quick
2588     * as possible when handling it.
2589     * @hide
2590     */
2591    public static final String ACTION_USER_STARTED =
2592            "android.intent.action.USER_STARTED";
2593
2594    /**
2595     * Broadcast sent when a user is in the process of starting.  Carries an extra
2596     * EXTRA_USER_HANDLE that has the userHandle of the user.  This is only
2597     * sent to registered receivers, not manifest receivers.  It is sent to all
2598     * users (including the one that is being started).  You must hold
2599     * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2600     * this broadcast.  This is sent as a background broadcast, since
2601     * its result is not part of the primary UX flow; to safely keep track of
2602     * started/stopped state of a user you can use this in conjunction with
2603     * {@link #ACTION_USER_STOPPING}.  It is <b>not</b> generally safe to use with
2604     * other user state broadcasts since those are foreground broadcasts so can
2605     * execute in a different order.
2606     * @hide
2607     */
2608    public static final String ACTION_USER_STARTING =
2609            "android.intent.action.USER_STARTING";
2610
2611    /**
2612     * Broadcast sent when a user is going to be stopped.  Carries an extra
2613     * EXTRA_USER_HANDLE that has the userHandle of the user.  This is only
2614     * sent to registered receivers, not manifest receivers.  It is sent to all
2615     * users (including the one that is being stopped).  You must hold
2616     * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2617     * this broadcast.  The user will not stop until all receivers have
2618     * handled the broadcast.  This is sent as a background broadcast, since
2619     * its result is not part of the primary UX flow; to safely keep track of
2620     * started/stopped state of a user you can use this in conjunction with
2621     * {@link #ACTION_USER_STARTING}.  It is <b>not</b> generally safe to use with
2622     * other user state broadcasts since those are foreground broadcasts so can
2623     * execute in a different order.
2624     * @hide
2625     */
2626    public static final String ACTION_USER_STOPPING =
2627            "android.intent.action.USER_STOPPING";
2628
2629    /**
2630     * Broadcast sent to the system when a user is stopped. Carries an extra
2631     * EXTRA_USER_HANDLE that has the userHandle of the user.  This is similar to
2632     * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2633     * specific package.  This is only sent to registered receivers, not manifest
2634     * receivers.  It is sent to all running users <em>except</em> the one that
2635     * has just been stopped (which is no longer running).
2636     * @hide
2637     */
2638    public static final String ACTION_USER_STOPPED =
2639            "android.intent.action.USER_STOPPED";
2640
2641    /**
2642     * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
2643     * the userHandle of the user.  It is sent to all running users except the
2644     * one that has been removed. The user will not be completely removed until all receivers have
2645     * handled the broadcast. You must hold
2646     * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
2647     * @hide
2648     */
2649    public static final String ACTION_USER_REMOVED =
2650            "android.intent.action.USER_REMOVED";
2651
2652    /**
2653     * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
2654     * the userHandle of the user to become the current one. This is only sent to
2655     * registered receivers, not manifest receivers.  It is sent to all running users.
2656     * You must hold
2657     * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
2658     * @hide
2659     */
2660    public static final String ACTION_USER_SWITCHED =
2661            "android.intent.action.USER_SWITCHED";
2662
2663    /**
2664     * Broadcast sent to the system when a user's information changes. Carries an extra
2665     * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2666     * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
2667     * @hide
2668     */
2669    public static final String ACTION_USER_INFO_CHANGED =
2670            "android.intent.action.USER_INFO_CHANGED";
2671
2672    /**
2673     * Broadcast sent to the primary user when an associated managed profile is added (the profile
2674     * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
2675     * the UserHandle of the profile that was added. Only applications (for example Launchers)
2676     * that need to display merged content across both primary and managed profiles need to
2677     * worry about this broadcast. This is only sent to registered receivers,
2678     * not manifest receivers.
2679     */
2680    public static final String ACTION_MANAGED_PROFILE_ADDED =
2681            "android.intent.action.MANAGED_PROFILE_ADDED";
2682
2683    /**
2684     * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
2685     * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2686     * Only applications (for example Launchers) that need to display merged content across both
2687     * primary and managed profiles need to worry about this broadcast. This is only sent to
2688     * registered receivers, not manifest receivers.
2689     */
2690    public static final String ACTION_MANAGED_PROFILE_REMOVED =
2691            "android.intent.action.MANAGED_PROFILE_REMOVED";
2692
2693    /**
2694     * Sent when the user taps on the clock widget in the system's "quick settings" area.
2695     */
2696    public static final String ACTION_QUICK_CLOCK =
2697            "android.intent.action.QUICK_CLOCK";
2698
2699    /**
2700     * Broadcast Action: This is broadcast when a user action should request the
2701     * brightness setting dialog.
2702     * @hide
2703     */
2704    public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2705            "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2706
2707    /**
2708     * Broadcast Action:  A global button was pressed.  Includes a single
2709     * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2710     * caused the broadcast.
2711     * @hide
2712     */
2713    public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2714
2715    /**
2716     * Activity Action: Allow the user to select and return one or more existing
2717     * documents. When invoked, the system will display the various
2718     * {@link DocumentsProvider} instances installed on the device, letting the
2719     * user interactively navigate through them. These documents include local
2720     * media, such as photos and video, and documents provided by installed
2721     * cloud storage providers.
2722     * <p>
2723     * Each document is represented as a {@code content://} URI backed by a
2724     * {@link DocumentsProvider}, which can be opened as a stream with
2725     * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2726     * {@link android.provider.DocumentsContract.Document} metadata.
2727     * <p>
2728     * All selected documents are returned to the calling application with
2729     * persistable read and write permission grants. If you want to maintain
2730     * access to the documents across device reboots, you need to explicitly
2731     * take the persistable permissions using
2732     * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2733     * <p>
2734     * Callers must indicate the acceptable document MIME types through
2735     * {@link #setType(String)}. For example, to select photos, use
2736     * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2737     * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2738     * {@literal *}/*.
2739     * <p>
2740     * If the caller can handle multiple returned items (the user performing
2741     * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2742     * to indicate this.
2743     * <p>
2744     * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2745     * returned URIs can be opened with
2746     * {@link ContentResolver#openFileDescriptor(Uri, String)}.
2747     * <p>
2748     * Output: The URI of the item that was picked, returned in
2749     * {@link #getData()}. This must be a {@code content://} URI so that any
2750     * receiver can access it. If multiple documents were selected, they are
2751     * returned in {@link #getClipData()}.
2752     *
2753     * @see DocumentsContract
2754     * @see #ACTION_OPEN_DOCUMENT_TREE
2755     * @see #ACTION_CREATE_DOCUMENT
2756     * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
2757     */
2758    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2759    public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2760
2761    /**
2762     * Activity Action: Allow the user to create a new document. When invoked,
2763     * the system will display the various {@link DocumentsProvider} instances
2764     * installed on the device, letting the user navigate through them. The
2765     * returned document may be a newly created document with no content, or it
2766     * may be an existing document with the requested MIME type.
2767     * <p>
2768     * Each document is represented as a {@code content://} URI backed by a
2769     * {@link DocumentsProvider}, which can be opened as a stream with
2770     * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2771     * {@link android.provider.DocumentsContract.Document} metadata.
2772     * <p>
2773     * Callers must indicate the concrete MIME type of the document being
2774     * created by setting {@link #setType(String)}. This MIME type cannot be
2775     * changed after the document is created.
2776     * <p>
2777     * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2778     * but the user may change this value before creating the file.
2779     * <p>
2780     * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2781     * returned URIs can be opened with
2782     * {@link ContentResolver#openFileDescriptor(Uri, String)}.
2783     * <p>
2784     * Output: The URI of the item that was created. This must be a
2785     * {@code content://} URI so that any receiver can access it.
2786     *
2787     * @see DocumentsContract
2788     * @see #ACTION_OPEN_DOCUMENT
2789     * @see #ACTION_OPEN_DOCUMENT_TREE
2790     * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
2791     */
2792    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2793    public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2794
2795    /**
2796     * Activity Action: Allow the user to pick a directory subtree. When
2797     * invoked, the system will display the various {@link DocumentsProvider}
2798     * instances installed on the device, letting the user navigate through
2799     * them. Apps can fully manage documents within the returned directory.
2800     * <p>
2801     * To gain access to descendant (child, grandchild, etc) documents, use
2802     * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2803     * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2804     * with the returned URI.
2805     * <p>
2806     * Output: The URI representing the selected directory tree.
2807     *
2808     * @see DocumentsContract
2809     */
2810    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2811    public static final String
2812            ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
2813
2814    // ---------------------------------------------------------------------
2815    // ---------------------------------------------------------------------
2816    // Standard intent categories (see addCategory()).
2817
2818    /**
2819     * Set if the activity should be an option for the default action
2820     * (center press) to perform on a piece of data.  Setting this will
2821     * hide from the user any activities without it set when performing an
2822     * action on some data.  Note that this is normally -not- set in the
2823     * Intent when initiating an action -- it is for use in intent filters
2824     * specified in packages.
2825     */
2826    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2827    public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2828    /**
2829     * Activities that can be safely invoked from a browser must support this
2830     * category.  For example, if the user is viewing a web page or an e-mail
2831     * and clicks on a link in the text, the Intent generated execute that
2832     * link will require the BROWSABLE category, so that only activities
2833     * supporting this category will be considered as possible actions.  By
2834     * supporting this category, you are promising that there is nothing
2835     * damaging (without user intervention) that can happen by invoking any
2836     * matching Intent.
2837     */
2838    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2839    public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2840    /**
2841     * Categories for activities that can participate in voice interaction.
2842     * An activity that supports this category must be prepared to run with
2843     * no UI shown at all (though in some case it may have a UI shown), and
2844     * rely on {@link android.app.VoiceInteractor} to interact with the user.
2845     */
2846    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2847    public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2848    /**
2849     * Set if the activity should be considered as an alternative action to
2850     * the data the user is currently viewing.  See also
2851     * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2852     * applies to the selection in a list of items.
2853     *
2854     * <p>Supporting this category means that you would like your activity to be
2855     * displayed in the set of alternative things the user can do, usually as
2856     * part of the current activity's options menu.  You will usually want to
2857     * include a specific label in the &lt;intent-filter&gt; of this action
2858     * describing to the user what it does.
2859     *
2860     * <p>The action of IntentFilter with this category is important in that it
2861     * describes the specific action the target will perform.  This generally
2862     * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2863     * a specific name such as "com.android.camera.action.CROP.  Only one
2864     * alternative of any particular action will be shown to the user, so using
2865     * a specific action like this makes sure that your alternative will be
2866     * displayed while also allowing other applications to provide their own
2867     * overrides of that particular action.
2868     */
2869    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2870    public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2871    /**
2872     * Set if the activity should be considered as an alternative selection
2873     * action to the data the user has currently selected.  This is like
2874     * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2875     * of items from which the user can select, giving them alternatives to the
2876     * default action that will be performed on it.
2877     */
2878    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879    public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2880    /**
2881     * Intended to be used as a tab inside of a containing TabActivity.
2882     */
2883    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2884    public static final String CATEGORY_TAB = "android.intent.category.TAB";
2885    /**
2886     * Should be displayed in the top-level launcher.
2887     */
2888    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2889    public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2890    /**
2891     * Indicates an activity optimized for Leanback mode, and that should
2892     * be displayed in the Leanback launcher.
2893     */
2894    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2895    public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2896    /**
2897     * Provides information about the package it is in; typically used if
2898     * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2899     * a front-door to the user without having to be shown in the all apps list.
2900     */
2901    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902    public static final String CATEGORY_INFO = "android.intent.category.INFO";
2903    /**
2904     * This is the home activity, that is the first activity that is displayed
2905     * when the device boots.
2906     */
2907    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2908    public static final String CATEGORY_HOME = "android.intent.category.HOME";
2909    /**
2910     * This activity is a preference panel.
2911     */
2912    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2913    public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2914    /**
2915     * This activity is a development preference panel.
2916     */
2917    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2918    public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2919    /**
2920     * Capable of running inside a parent activity container.
2921     */
2922    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2923    public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2924    /**
2925     * This activity allows the user to browse and download new applications.
2926     */
2927    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2928    public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2929    /**
2930     * This activity may be exercised by the monkey or other automated test tools.
2931     */
2932    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2933    public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2934    /**
2935     * To be used as a test (not part of the normal user experience).
2936     */
2937    public static final String CATEGORY_TEST = "android.intent.category.TEST";
2938    /**
2939     * To be used as a unit test (run through the Test Harness).
2940     */
2941    public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2942    /**
2943     * To be used as a sample code example (not part of the normal user
2944     * experience).
2945     */
2946    public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2947
2948    /**
2949     * Used to indicate that an intent only wants URIs that can be opened with
2950     * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2951     * must support at least the columns defined in {@link OpenableColumns} when
2952     * queried.
2953     *
2954     * @see #ACTION_GET_CONTENT
2955     * @see #ACTION_OPEN_DOCUMENT
2956     * @see #ACTION_CREATE_DOCUMENT
2957     */
2958    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2959    public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2960
2961    /**
2962     * To be used as code under test for framework instrumentation tests.
2963     */
2964    public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2965            "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
2966    /**
2967     * An activity to run when device is inserted into a car dock.
2968     * Used with {@link #ACTION_MAIN} to launch an activity.  For more
2969     * information, see {@link android.app.UiModeManager}.
2970     */
2971    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2972    public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2973    /**
2974     * An activity to run when device is inserted into a car dock.
2975     * Used with {@link #ACTION_MAIN} to launch an activity.  For more
2976     * information, see {@link android.app.UiModeManager}.
2977     */
2978    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2979    public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
2980    /**
2981     * An activity to run when device is inserted into a analog (low end) dock.
2982     * Used with {@link #ACTION_MAIN} to launch an activity.  For more
2983     * information, see {@link android.app.UiModeManager}.
2984     */
2985    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2986    public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2987
2988    /**
2989     * An activity to run when device is inserted into a digital (high end) dock.
2990     * Used with {@link #ACTION_MAIN} to launch an activity.  For more
2991     * information, see {@link android.app.UiModeManager}.
2992     */
2993    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2994    public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
2995
2996    /**
2997     * Used to indicate that the activity can be used in a car environment.
2998     */
2999    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3000    public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3001
3002    // ---------------------------------------------------------------------
3003    // ---------------------------------------------------------------------
3004    // Application launch intent categories (see addCategory()).
3005
3006    /**
3007     * Used with {@link #ACTION_MAIN} to launch the browser application.
3008     * The activity should be able to browse the Internet.
3009     * <p>NOTE: This should not be used as the primary key of an Intent,
3010     * since it will not result in the app launching with the correct
3011     * action and category.  Instead, use this with
3012     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3013     * Intent with this category in the selector.</p>
3014     */
3015    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3016    public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3017
3018    /**
3019     * Used with {@link #ACTION_MAIN} to launch the calculator application.
3020     * The activity should be able to perform standard arithmetic operations.
3021     * <p>NOTE: This should not be used as the primary key of an Intent,
3022     * since it will not result in the app launching with the correct
3023     * action and category.  Instead, use this with
3024     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3025     * Intent with this category in the selector.</p>
3026     */
3027    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3028    public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3029
3030    /**
3031     * Used with {@link #ACTION_MAIN} to launch the calendar application.
3032     * The activity should be able to view and manipulate calendar entries.
3033     * <p>NOTE: This should not be used as the primary key of an Intent,
3034     * since it will not result in the app launching with the correct
3035     * action and category.  Instead, use this with
3036     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3037     * Intent with this category in the selector.</p>
3038     */
3039    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3040    public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3041
3042    /**
3043     * Used with {@link #ACTION_MAIN} to launch the contacts application.
3044     * The activity should be able to view and manipulate address book entries.
3045     * <p>NOTE: This should not be used as the primary key of an Intent,
3046     * since it will not result in the app launching with the correct
3047     * action and category.  Instead, use this with
3048     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3049     * Intent with this category in the selector.</p>
3050     */
3051    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3052    public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3053
3054    /**
3055     * Used with {@link #ACTION_MAIN} to launch the email application.
3056     * The activity should be able to send and receive email.
3057     * <p>NOTE: This should not be used as the primary key of an Intent,
3058     * since it will not result in the app launching with the correct
3059     * action and category.  Instead, use this with
3060     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3061     * Intent with this category in the selector.</p>
3062     */
3063    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3064    public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3065
3066    /**
3067     * Used with {@link #ACTION_MAIN} to launch the gallery application.
3068     * The activity should be able to view and manipulate image and video files
3069     * stored on the device.
3070     * <p>NOTE: This should not be used as the primary key of an Intent,
3071     * since it will not result in the app launching with the correct
3072     * action and category.  Instead, use this with
3073     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3074     * Intent with this category in the selector.</p>
3075     */
3076    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3077    public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3078
3079    /**
3080     * Used with {@link #ACTION_MAIN} to launch the maps application.
3081     * The activity should be able to show the user's current location and surroundings.
3082     * <p>NOTE: This should not be used as the primary key of an Intent,
3083     * since it will not result in the app launching with the correct
3084     * action and category.  Instead, use this with
3085     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3086     * Intent with this category in the selector.</p>
3087     */
3088    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3089    public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3090
3091    /**
3092     * Used with {@link #ACTION_MAIN} to launch the messaging application.
3093     * The activity should be able to send and receive text messages.
3094     * <p>NOTE: This should not be used as the primary key of an Intent,
3095     * since it will not result in the app launching with the correct
3096     * action and category.  Instead, use this with
3097     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3098     * Intent with this category in the selector.</p>
3099     */
3100    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3101    public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3102
3103    /**
3104     * Used with {@link #ACTION_MAIN} to launch the music application.
3105     * The activity should be able to play, browse, or manipulate music files
3106     * stored on the device.
3107     * <p>NOTE: This should not be used as the primary key of an Intent,
3108     * since it will not result in the app launching with the correct
3109     * action and category.  Instead, use this with
3110     * {@link #makeMainSelectorActivity(String, String)} to generate a main
3111     * Intent with this category in the selector.</p>
3112     */
3113    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3114    public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3115
3116    // ---------------------------------------------------------------------
3117    // ---------------------------------------------------------------------
3118    // Standard extra data keys.
3119
3120    /**
3121     * The initial data to place in a newly created record.  Use with
3122     * {@link #ACTION_INSERT}.  The data here is a Map containing the same
3123     * fields as would be given to the underlying ContentProvider.insert()
3124     * call.
3125     */
3126    public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3127
3128    /**
3129     * A constant CharSequence that is associated with the Intent, used with
3130     * {@link #ACTION_SEND} to supply the literal data to be sent.  Note that
3131     * this may be a styled CharSequence, so you must use
3132     * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3133     * retrieve it.
3134     */
3135    public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3136
3137    /**
3138     * A constant String that is associated with the Intent, used with
3139     * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3140     * as HTML formatted text.  Note that you <em>must</em> also supply
3141     * {@link #EXTRA_TEXT}.
3142     */
3143    public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3144
3145    /**
3146     * A content: URI holding a stream of data associated with the Intent,
3147     * used with {@link #ACTION_SEND} to supply the data being sent.
3148     */
3149    public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3150
3151    /**
3152     * A String[] holding e-mail addresses that should be delivered to.
3153     */
3154    public static final String EXTRA_EMAIL       = "android.intent.extra.EMAIL";
3155
3156    /**
3157     * A String[] holding e-mail addresses that should be carbon copied.
3158     */
3159    public static final String EXTRA_CC       = "android.intent.extra.CC";
3160
3161    /**
3162     * A String[] holding e-mail addresses that should be blind carbon copied.
3163     */
3164    public static final String EXTRA_BCC      = "android.intent.extra.BCC";
3165
3166    /**
3167     * A constant string holding the desired subject line of a message.
3168     */
3169    public static final String EXTRA_SUBJECT  = "android.intent.extra.SUBJECT";
3170
3171    /**
3172     * An Intent describing the choices you would like shown with
3173     * {@link #ACTION_PICK_ACTIVITY}.
3174     */
3175    public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3176
3177    /**
3178     * A CharSequence dialog title to provide to the user when used with a
3179     * {@link #ACTION_CHOOSER} or {@link #ACTION_CONFIRM_DEVICE_CREDENTIAL}.
3180     */
3181    public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3182
3183    /**
3184     * A CharSequence description to provide to the user when used with
3185     * {@link #ACTION_CONFIRM_DEVICE_CREDENTIAL}.
3186     */
3187    public static final String EXTRA_DETAILS = "android.intent.extra.DETAILS";
3188
3189    /**
3190     * A Parcelable[] of {@link Intent} or
3191     * {@link android.content.pm.LabeledIntent} objects as set with
3192     * {@link #putExtra(String, Parcelable[])} of additional activities to place
3193     * a the front of the list of choices, when shown to the user with a
3194     * {@link #ACTION_CHOOSER}.
3195     */
3196    public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3197
3198    /**
3199     * A {@link android.view.KeyEvent} object containing the event that
3200     * triggered the creation of the Intent it is in.
3201     */
3202    public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3203
3204    /**
3205     * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3206     * before shutting down.
3207     *
3208     * {@hide}
3209     */
3210    public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3211
3212    /**
3213     * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3214     * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3215     * of restarting the application.
3216     */
3217    public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3218
3219    /**
3220     * A String holding the phone number originally entered in
3221     * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3222     * number to call in a {@link android.content.Intent#ACTION_CALL}.
3223     */
3224    public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
3225
3226    /**
3227     * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3228     * intents to supply the uid the package had been assigned.  Also an optional
3229     * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3230     * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3231     * purpose.
3232     */
3233    public static final String EXTRA_UID = "android.intent.extra.UID";
3234
3235    /**
3236     * @hide String array of package names.
3237     */
3238    public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3239
3240    /**
3241     * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3242     * intents to indicate whether this represents a full uninstall (removing
3243     * both the code and its data) or a partial uninstall (leaving its data,
3244     * implying that this is an update).
3245     */
3246    public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
3247
3248    /**
3249     * @hide
3250     * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3251     * intents to indicate that at this point the package has been removed for
3252     * all users on the device.
3253     */
3254    public static final String EXTRA_REMOVED_FOR_ALL_USERS
3255            = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3256
3257    /**
3258     * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3259     * intents to indicate that this is a replacement of the package, so this
3260     * broadcast will immediately be followed by an add broadcast for a
3261     * different version of the same package.
3262     */
3263    public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
3264
3265    /**
3266     * Used as an int extra field in {@link android.app.AlarmManager} intents
3267     * to tell the application being invoked how many pending alarms are being
3268     * delievered with the intent.  For one-shot alarms this will always be 1.
3269     * For recurring alarms, this might be greater than 1 if the device was
3270     * asleep or powered off at the time an earlier alarm would have been
3271     * delivered.
3272     */
3273    public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
3274
3275    /**
3276     * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3277     * intents to request the dock state.  Possible values are
3278     * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3279     * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
3280     * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3281     * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3282     * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
3283     */
3284    public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3285
3286    /**
3287     * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3288     * to represent that the phone is not in any dock.
3289     */
3290    public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3291
3292    /**
3293     * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3294     * to represent that the phone is in a desk dock.
3295     */
3296    public static final int EXTRA_DOCK_STATE_DESK = 1;
3297
3298    /**
3299     * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3300     * to represent that the phone is in a car dock.
3301     */
3302    public static final int EXTRA_DOCK_STATE_CAR = 2;
3303
3304    /**
3305     * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3306     * to represent that the phone is in a analog (low end) dock.
3307     */
3308    public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3309
3310    /**
3311     * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3312     * to represent that the phone is in a digital (high end) dock.
3313     */
3314    public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3315
3316    /**
3317     * Boolean that can be supplied as meta-data with a dock activity, to
3318     * indicate that the dock should take over the home key when it is active.
3319     */
3320    public static final String METADATA_DOCK_HOME = "android.dock_home";
3321
3322    /**
3323     * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3324     * the bug report.
3325     */
3326    public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3327
3328    /**
3329     * Used in the extra field in the remote intent. It's astring token passed with the
3330     * remote intent.
3331     */
3332    public static final String EXTRA_REMOTE_INTENT_TOKEN =
3333            "android.intent.extra.remote_intent_token";
3334
3335    /**
3336     * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
3337     * will contain only the first name in the list.
3338     */
3339    @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
3340            "android.intent.extra.changed_component_name";
3341
3342    /**
3343     * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
3344     * and contains a string array of all of the components that have changed.  If
3345     * the state of the overall package has changed, then it will contain an entry
3346     * with the package name itself.
3347     */
3348    public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3349            "android.intent.extra.changed_component_name_list";
3350
3351    /**
3352     * This field is part of
3353     * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3354     * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
3355     * and contains a string array of all of the components that have changed.
3356     */
3357    public static final String EXTRA_CHANGED_PACKAGE_LIST =
3358            "android.intent.extra.changed_package_list";
3359
3360    /**
3361     * This field is part of
3362     * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3363     * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
3364     * and contains an integer array of uids of all of the components
3365     * that have changed.
3366     */
3367    public static final String EXTRA_CHANGED_UID_LIST =
3368            "android.intent.extra.changed_uid_list";
3369
3370    /**
3371     * @hide
3372     * Magic extra system code can use when binding, to give a label for
3373     * who it is that has bound to a service.  This is an integer giving
3374     * a framework string resource that can be displayed to the user.
3375     */
3376    public static final String EXTRA_CLIENT_LABEL =
3377            "android.intent.extra.client_label";
3378
3379    /**
3380     * @hide
3381     * Magic extra system code can use when binding, to give a PendingIntent object
3382     * that can be launched for the user to disable the system's use of this
3383     * service.
3384     */
3385    public static final String EXTRA_CLIENT_INTENT =
3386            "android.intent.extra.client_intent";
3387
3388    /**
3389     * Extra used to indicate that an intent should only return data that is on
3390     * the local device. This is a boolean extra; the default is false. If true,
3391     * an implementation should only allow the user to select data that is
3392     * already on the device, not requiring it be downloaded from a remote
3393     * service when opened.
3394     *
3395     * @see #ACTION_GET_CONTENT
3396     * @see #ACTION_OPEN_DOCUMENT
3397     * @see #ACTION_OPEN_DOCUMENT_TREE
3398     * @see #ACTION_CREATE_DOCUMENT
3399     */
3400    public static final String EXTRA_LOCAL_ONLY =
3401            "android.intent.extra.LOCAL_ONLY";
3402
3403    /**
3404     * Extra used to indicate that an intent can allow the user to select and
3405     * return multiple items. This is a boolean extra; the default is false. If
3406     * true, an implementation is allowed to present the user with a UI where
3407     * they can pick multiple items that are all returned to the caller. When
3408     * this happens, they should be returned as the {@link #getClipData()} part
3409     * of the result Intent.
3410     *
3411     * @see #ACTION_GET_CONTENT
3412     * @see #ACTION_OPEN_DOCUMENT
3413     */
3414    public static final String EXTRA_ALLOW_MULTIPLE =
3415            "android.intent.extra.ALLOW_MULTIPLE";
3416
3417    /**
3418     * The integer userHandle carried with broadcast intents related to addition, removal and
3419     * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3420     * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3421     *
3422     * @hide
3423     */
3424    public static final String EXTRA_USER_HANDLE =
3425            "android.intent.extra.user_handle";
3426
3427    /**
3428     * The UserHandle carried with broadcasts intents related to addition and removal of managed
3429     * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3430     */
3431    public static final String EXTRA_USER =
3432            "android.intent.extra.user";
3433
3434    /**
3435     * Extra used in the response from a BroadcastReceiver that handles
3436     * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3437     * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
3438     */
3439    public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3440
3441    /**
3442     * Extra sent in the intent to the BroadcastReceiver that handles
3443     * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3444     * the restrictions as key/value pairs.
3445     */
3446    public static final String EXTRA_RESTRICTIONS_BUNDLE =
3447            "android.intent.extra.restrictions_bundle";
3448
3449    /**
3450     * Extra used in the response from a BroadcastReceiver that handles
3451     * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3452     */
3453    public static final String EXTRA_RESTRICTIONS_INTENT =
3454            "android.intent.extra.restrictions_intent";
3455
3456    /**
3457     * Extra used to communicate a set of acceptable MIME types. The type of the
3458     * extra is {@code String[]}. Values may be a combination of concrete MIME
3459     * types (such as "image/png") and/or partial MIME types (such as
3460     * "audio/*").
3461     *
3462     * @see #ACTION_GET_CONTENT
3463     * @see #ACTION_OPEN_DOCUMENT
3464     */
3465    public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3466
3467    /**
3468     * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3469     * this shutdown is only for the user space of the system, not a complete shutdown.
3470     * When this is true, hardware devices can use this information to determine that
3471     * they shouldn't do a complete shutdown of their device since this is not a
3472     * complete shutdown down to the kernel, but only user space restarting.
3473     * The default if not supplied is false.
3474     */
3475    public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3476            = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3477
3478    /**
3479     * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3480     * user has set their time format preferences to the 24 hour format.
3481     *
3482     * @hide for internal use only.
3483     */
3484    public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3485            "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3486
3487    // ---------------------------------------------------------------------
3488    // ---------------------------------------------------------------------
3489    // Intent flags (see mFlags variable).
3490
3491    /** @hide */
3492    @IntDef(flag = true, value = {
3493            FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3494            FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
3495    @Retention(RetentionPolicy.SOURCE)
3496    public @interface GrantUriMode {}
3497
3498    /** @hide */
3499    @IntDef(flag = true, value = {
3500            FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3501    @Retention(RetentionPolicy.SOURCE)
3502    public @interface AccessUriMode {}
3503
3504    /**
3505     * Test if given mode flags specify an access mode, which must be at least
3506     * read and/or write.
3507     *
3508     * @hide
3509     */
3510    public static boolean isAccessUriMode(int modeFlags) {
3511        return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3512                | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3513    }
3514
3515    /**
3516     * If set, the recipient of this Intent will be granted permission to
3517     * perform read operations on the URI in the Intent's data and any URIs
3518     * specified in its ClipData.  When applying to an Intent's ClipData,
3519     * all URIs as well as recursive traversals through data or other ClipData
3520     * in Intent items will be granted; only the grant flags of the top-level
3521     * Intent are used.
3522     */
3523    public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3524    /**
3525     * If set, the recipient of this Intent will be granted permission to
3526     * perform write operations on the URI in the Intent's data and any URIs
3527     * specified in its ClipData.  When applying to an Intent's ClipData,
3528     * all URIs as well as recursive traversals through data or other ClipData
3529     * in Intent items will be granted; only the grant flags of the top-level
3530     * Intent are used.
3531     */
3532    public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3533    /**
3534     * Can be set by the caller to indicate that this Intent is coming from
3535     * a background operation, not from direct user interaction.
3536     */
3537    public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3538    /**
3539     * A flag you can enable for debugging: when set, log messages will be
3540     * printed during the resolution of this intent to show you what has
3541     * been found to create the final resolved list.
3542     */
3543    public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
3544    /**
3545     * If set, this intent will not match any components in packages that
3546     * are currently stopped.  If this is not set, then the default behavior
3547     * is to include such applications in the result.
3548     */
3549    public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3550    /**
3551     * If set, this intent will always match any components in packages that
3552     * are currently stopped.  This is the default behavior when
3553     * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set.  If both of these
3554     * flags are set, this one wins (it allows overriding of exclude for
3555     * places where the framework may automatically set the exclude flag).
3556     */
3557    public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
3558
3559    /**
3560     * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3561     * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
3562     * persisted across device reboots until explicitly revoked with
3563     * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3564     * grant for possible persisting; the receiving application must call
3565     * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3566     * actually persist.
3567     *
3568     * @see ContentResolver#takePersistableUriPermission(Uri, int)
3569     * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3570     * @see ContentResolver#getPersistedUriPermissions()
3571     * @see ContentResolver#getOutgoingPersistedUriPermissions()
3572     */
3573    public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
3574
3575    /**
3576     * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3577     * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3578     * applies to any URI that is a prefix match against the original granted
3579     * URI. (Without this flag, the URI must match exactly for access to be
3580     * granted.) Another URI is considered a prefix match only when scheme,
3581     * authority, and all path segments defined by the prefix are an exact
3582     * match.
3583     */
3584    public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3585
3586    /**
3587     * If set, the new activity is not kept in the history stack.  As soon as
3588     * the user navigates away from it, the activity is finished.  This may also
3589     * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3590     * noHistory} attribute.
3591     */
3592    public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3593    /**
3594     * If set, the activity will not be launched if it is already running
3595     * at the top of the history stack.
3596     */
3597    public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3598    /**
3599     * If set, this activity will become the start of a new task on this
3600     * history stack.  A task (from the activity that started it to the
3601     * next task activity) defines an atomic group of activities that the
3602     * user can move to.  Tasks can be moved to the foreground and background;
3603     * all of the activities inside of a particular task always remain in
3604     * the same order.  See
3605     * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3606     * Stack</a> for more information about tasks.
3607     *
3608     * <p>This flag is generally used by activities that want
3609     * to present a "launcher" style behavior: they give the user a list of
3610     * separate things that can be done, which otherwise run completely
3611     * independently of the activity launching them.
3612     *
3613     * <p>When using this flag, if a task is already running for the activity
3614     * you are now starting, then a new activity will not be started; instead,
3615     * the current task will simply be brought to the front of the screen with
3616     * the state it was last in.  See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3617     * to disable this behavior.
3618     *
3619     * <p>This flag can not be used when the caller is requesting a result from
3620     * the activity being launched.
3621     */
3622    public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3623    /**
3624     * This flag is used to create a new task and launch an activity into it.
3625     * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3626     * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3627     * search through existing tasks for ones matching this Intent. Only if no such
3628     * task is found would a new task be created. When paired with
3629     * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3630     * the search for a matching task and unconditionally start a new task.
3631     *
3632     * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3633     * flag unless you are implementing your own
3634     * top-level application launcher.</strong>  Used in conjunction with
3635     * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3636     * behavior of bringing an existing task to the foreground.  When set,
3637     * a new task is <em>always</em> started to host the Activity for the
3638     * Intent, regardless of whether there is already an existing task running
3639     * the same thing.
3640     *
3641     * <p><strong>Because the default system does not include graphical task management,
3642     * you should not use this flag unless you provide some way for a user to
3643     * return back to the tasks you have launched.</strong>
3644     *
3645     * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3646     * creating new document tasks.
3647     *
3648     * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3649     * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
3650     *
3651     * <p>See
3652     * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3653     * Stack</a> for more information about tasks.
3654     *
3655     * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3656     * @see #FLAG_ACTIVITY_NEW_TASK
3657     */
3658    public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3659    /**
3660     * If set, and the activity being launched is already running in the
3661     * current task, then instead of launching a new instance of that activity,
3662     * all of the other activities on top of it will be closed and this Intent
3663     * will be delivered to the (now on top) old activity as a new Intent.
3664     *
3665     * <p>For example, consider a task consisting of the activities: A, B, C, D.
3666     * If D calls startActivity() with an Intent that resolves to the component
3667     * of activity B, then C and D will be finished and B receive the given
3668     * Intent, resulting in the stack now being: A, B.
3669     *
3670     * <p>The currently running instance of activity B in the above example will
3671     * either receive the new intent you are starting here in its
3672     * onNewIntent() method, or be itself finished and restarted with the
3673     * new intent.  If it has declared its launch mode to be "multiple" (the
3674     * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3675     * the same intent, then it will be finished and re-created; for all other
3676     * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3677     * Intent will be delivered to the current instance's onNewIntent().
3678     *
3679     * <p>This launch mode can also be used to good effect in conjunction with
3680     * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3681     * of a task, it will bring any currently running instance of that task
3682     * to the foreground, and then clear it to its root state.  This is
3683     * especially useful, for example, when launching an activity from the
3684     * notification manager.
3685     *
3686     * <p>See
3687     * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3688     * Stack</a> for more information about tasks.
3689     */
3690    public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3691    /**
3692     * If set and this intent is being used to launch a new activity from an
3693     * existing one, then the reply target of the existing activity will be
3694     * transfered to the new activity.  This way the new activity can call
3695     * {@link android.app.Activity#setResult} and have that result sent back to
3696     * the reply target of the original activity.
3697     */
3698    public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3699    /**
3700     * If set and this intent is being used to launch a new activity from an
3701     * existing one, the current activity will not be counted as the top
3702     * activity for deciding whether the new intent should be delivered to
3703     * the top instead of starting a new one.  The previous activity will
3704     * be used as the top, with the assumption being that the current activity
3705     * will finish itself immediately.
3706     */
3707    public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3708    /**
3709     * If set, the new activity is not kept in the list of recently launched
3710     * activities.
3711     */
3712    public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3713    /**
3714     * This flag is not normally set by application code, but set for you by
3715     * the system as described in the
3716     * {@link android.R.styleable#AndroidManifestActivity_launchMode
3717     * launchMode} documentation for the singleTask mode.
3718     */
3719    public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3720    /**
3721     * If set, and this activity is either being started in a new task or
3722     * bringing to the top an existing task, then it will be launched as
3723     * the front door of the task.  This will result in the application of
3724     * any affinities needed to have that task in the proper state (either
3725     * moving activities to or from it), or simply resetting that task to
3726     * its initial state if needed.
3727     */
3728    public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3729    /**
3730     * This flag is not normally set by application code, but set for you by
3731     * the system if this activity is being launched from history
3732     * (longpress home key).
3733     */
3734    public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
3735    /**
3736     * @deprecated As of API 21 this performs identically to
3737     * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
3738     */
3739    public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
3740    /**
3741     * This flag is used to open a document into a new task rooted at the activity launched
3742     * by this Intent. Through the use of this flag, or its equivalent attribute,
3743     * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3744     * containing different douments will appear in the recent tasks list.
3745     *
3746     * <p>The use of the activity attribute form of this,
3747     * {@link android.R.attr#documentLaunchMode}, is
3748     * preferred over the Intent flag described here. The attribute form allows the
3749     * Activity to specify multiple document behavior for all launchers of the Activity
3750     * whereas using this flag requires each Intent that launches the Activity to specify it.
3751     *
3752     * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3753     * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3754     * equivalent of the Activity manifest specifying {@link
3755     * android.R.attr#documentLaunchMode}="intoExisting". When used with
3756     * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3757     * {@link android.R.attr#documentLaunchMode}="always".
3758     *
3759     * Refer to {@link android.R.attr#documentLaunchMode} for more information.
3760     *
3761     * @see android.R.attr#documentLaunchMode
3762     * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3763     */
3764    public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
3765    /**
3766     * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
3767     * callback from occurring on the current frontmost activity before it is
3768     * paused as the newly-started activity is brought to the front.
3769     *
3770     * <p>Typically, an activity can rely on that callback to indicate that an
3771     * explicit user action has caused their activity to be moved out of the
3772     * foreground. The callback marks an appropriate point in the activity's
3773     * lifecycle for it to dismiss any notifications that it intends to display
3774     * "until the user has seen them," such as a blinking LED.
3775     *
3776     * <p>If an activity is ever started via any non-user-driven events such as
3777     * phone-call receipt or an alarm handler, this flag should be passed to {@link
3778     * Context#startActivity Context.startActivity}, ensuring that the pausing
3779     * activity does not think the user has acknowledged its notification.
3780     */
3781    public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
3782    /**
3783     * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3784     * this flag will cause the launched activity to be brought to the front of its
3785     * task's history stack if it is already running.
3786     *
3787     * <p>For example, consider a task consisting of four activities: A, B, C, D.
3788     * If D calls startActivity() with an Intent that resolves to the component
3789     * of activity B, then B will be brought to the front of the history stack,
3790     * with this resulting order:  A, C, D, B.
3791     *
3792     * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
3793     * specified.
3794     */
3795    public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
3796    /**
3797     * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3798     * this flag will prevent the system from applying an activity transition
3799     * animation to go to the next activity state.  This doesn't mean an
3800     * animation will never run -- if another activity change happens that doesn't
3801     * specify this flag before the activity started here is displayed, then
3802     * that transition will be used.  This flag can be put to good use
3803     * when you are going to do a series of activity operations but the
3804     * animation seen by the user shouldn't be driven by the first activity
3805     * change but rather a later one.
3806     */
3807    public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3808    /**
3809     * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3810     * this flag will cause any existing task that would be associated with the
3811     * activity to be cleared before the activity is started.  That is, the activity
3812     * becomes the new root of an otherwise empty task, and any old activities
3813     * are finished.  This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3814     */
3815    public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3816    /**
3817     * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3818     * this flag will cause a newly launching task to be placed on top of the current
3819     * home activity task (if there is one).  That is, pressing back from the task
3820     * will always return the user to home even if that was not the last activity they
3821     * saw.   This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3822     */
3823    public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3824    /**
3825     * If set and the new activity is the root of a new task, then the task
3826     * will remain in the list of recently launched tasks only until all of
3827     * the activities in it are finished.
3828     *
3829     * <p>This is equivalent to the attribute
3830     * {@link android.R.styleable#AndroidManifestActivity_autoRemoveFromRecents}.
3831     */
3832    public static final int FLAG_ACTIVITY_AUTO_REMOVE_FROM_RECENTS = 0x00002000;
3833    /**
3834     * If set along with FLAG_ACTIVITY_NEW_DOCUMENT then the task being launched will not be
3835     * presented to the user but will instead be only available through the recents task list.
3836     * In addition, the new task wil be affiliated with the launching activity's task.
3837     * Affiliated tasks are grouped together in the recents task list.
3838     *
3839     * <p>This behavior is not supported for activities with {@link
3840     * android.R.styleable#AndroidManifestActivity_launchMode launchMode} values of
3841     * <code>singleInstance</code> or <code>singleTask</code>.
3842     */
3843    public static final int FLAG_ACTIVITY_LAUNCH_BEHIND = 0x00001000;
3844
3845    /**
3846     * If set, when sending a broadcast only registered receivers will be
3847     * called -- no BroadcastReceiver components will be launched.
3848     */
3849    public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
3850    /**
3851     * If set, when sending a broadcast the new broadcast will replace
3852     * any existing pending broadcast that matches it.  Matching is defined
3853     * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3854     * true for the intents of the two broadcasts.  When a match is found,
3855     * the new broadcast (and receivers associated with it) will replace the
3856     * existing one in the pending broadcast list, remaining at the same
3857     * position in the list.
3858     *
3859     * <p>This flag is most typically used with sticky broadcasts, which
3860     * only care about delivering the most recent values of the broadcast
3861     * to their receivers.
3862     */
3863    public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3864    /**
3865     * If set, when sending a broadcast the recipient is allowed to run at
3866     * foreground priority, with a shorter timeout interval.  During normal
3867     * broadcasts the receivers are not automatically hoisted out of the
3868     * background priority class.
3869     */
3870    public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3871    /**
3872     * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3873     * They can still propagate results through to later receivers, but they can not prevent
3874     * later receivers from seeing the broadcast.
3875     */
3876    public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3877    /**
3878     * If set, when sending a broadcast <i>before boot has completed</i> only
3879     * registered receivers will be called -- no BroadcastReceiver components
3880     * will be launched.  Sticky intent state will be recorded properly even
3881     * if no receivers wind up being called.  If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3882     * is specified in the broadcast intent, this flag is unnecessary.
3883     *
3884     * <p>This flag is only for use by system sevices as a convenience to
3885     * avoid having to implement a more complex mechanism around detection
3886     * of boot completion.
3887     *
3888     * @hide
3889     */
3890    public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
3891    /**
3892     * Set when this broadcast is for a boot upgrade, a special mode that
3893     * allows the broadcast to be sent before the system is ready and launches
3894     * the app process with no providers running in it.
3895     * @hide
3896     */
3897    public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
3898
3899    /**
3900     * @hide Flags that can't be changed with PendingIntent.
3901     */
3902    public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3903            | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3904            | FLAG_GRANT_PREFIX_URI_PERMISSION;
3905
3906    // ---------------------------------------------------------------------
3907    // ---------------------------------------------------------------------
3908    // toUri() and parseUri() options.
3909
3910    /**
3911     * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3912     * always has the "intent:" scheme.  This syntax can be used when you want
3913     * to later disambiguate between URIs that are intended to describe an
3914     * Intent vs. all others that should be treated as raw URIs.  When used
3915     * with {@link #parseUri}, any other scheme will result in a generic
3916     * VIEW action for that raw URI.
3917     */
3918    public static final int URI_INTENT_SCHEME = 1<<0;
3919
3920    // ---------------------------------------------------------------------
3921
3922    private String mAction;
3923    private Uri mData;
3924    private String mType;
3925    private String mPackage;
3926    private ComponentName mComponent;
3927    private int mFlags;
3928    private ArraySet<String> mCategories;
3929    private Bundle mExtras;
3930    private Rect mSourceBounds;
3931    private Intent mSelector;
3932    private ClipData mClipData;
3933
3934    // ---------------------------------------------------------------------
3935
3936    /**
3937     * Create an empty intent.
3938     */
3939    public Intent() {
3940    }
3941
3942    /**
3943     * Copy constructor.
3944     */
3945    public Intent(Intent o) {
3946        this.mAction = o.mAction;
3947        this.mData = o.mData;
3948        this.mType = o.mType;
3949        this.mPackage = o.mPackage;
3950        this.mComponent = o.mComponent;
3951        this.mFlags = o.mFlags;
3952        if (o.mCategories != null) {
3953            this.mCategories = new ArraySet<String>(o.mCategories);
3954        }
3955        if (o.mExtras != null) {
3956            this.mExtras = new Bundle(o.mExtras);
3957        }
3958        if (o.mSourceBounds != null) {
3959            this.mSourceBounds = new Rect(o.mSourceBounds);
3960        }
3961        if (o.mSelector != null) {
3962            this.mSelector = new Intent(o.mSelector);
3963        }
3964        if (o.mClipData != null) {
3965            this.mClipData = new ClipData(o.mClipData);
3966        }
3967    }
3968
3969    @Override
3970    public Object clone() {
3971        return new Intent(this);
3972    }
3973
3974    private Intent(Intent o, boolean all) {
3975        this.mAction = o.mAction;
3976        this.mData = o.mData;
3977        this.mType = o.mType;
3978        this.mPackage = o.mPackage;
3979        this.mComponent = o.mComponent;
3980        if (o.mCategories != null) {
3981            this.mCategories = new ArraySet<String>(o.mCategories);
3982        }
3983    }
3984
3985    /**
3986     * Make a clone of only the parts of the Intent that are relevant for
3987     * filter matching: the action, data, type, component, and categories.
3988     */
3989    public Intent cloneFilter() {
3990        return new Intent(this, false);
3991    }
3992
3993    /**
3994     * Create an intent with a given action.  All other fields (data, type,
3995     * class) are null.  Note that the action <em>must</em> be in a
3996     * namespace because Intents are used globally in the system -- for
3997     * example the system VIEW action is android.intent.action.VIEW; an
3998     * application's custom action would be something like
3999     * com.google.app.myapp.CUSTOM_ACTION.
4000     *
4001     * @param action The Intent action, such as ACTION_VIEW.
4002     */
4003    public Intent(String action) {
4004        setAction(action);
4005    }
4006
4007    /**
4008     * Create an intent with a given action and for a given data url.  Note
4009     * that the action <em>must</em> be in a namespace because Intents are
4010     * used globally in the system -- for example the system VIEW action is
4011     * android.intent.action.VIEW; an application's custom action would be
4012     * something like com.google.app.myapp.CUSTOM_ACTION.
4013     *
4014     * <p><em>Note: scheme and host name matching in the Android framework is
4015     * case-sensitive, unlike the formal RFC.  As a result,
4016     * you should always ensure that you write your Uri with these elements
4017     * using lower case letters, and normalize any Uris you receive from
4018     * outside of Android to ensure the scheme and host is lower case.</em></p>
4019     *
4020     * @param action The Intent action, such as ACTION_VIEW.
4021     * @param uri The Intent data URI.
4022     */
4023    public Intent(String action, Uri uri) {
4024        setAction(action);
4025        mData = uri;
4026    }
4027
4028    /**
4029     * Create an intent for a specific component.  All other fields (action, data,
4030     * type, class) are null, though they can be modified later with explicit
4031     * calls.  This provides a convenient way to create an intent that is
4032     * intended to execute a hard-coded class name, rather than relying on the
4033     * system to find an appropriate class for you; see {@link #setComponent}
4034     * for more information on the repercussions of this.
4035     *
4036     * @param packageContext A Context of the application package implementing
4037     * this class.
4038     * @param cls The component class that is to be used for the intent.
4039     *
4040     * @see #setClass
4041     * @see #setComponent
4042     * @see #Intent(String, android.net.Uri , Context, Class)
4043     */
4044    public Intent(Context packageContext, Class<?> cls) {
4045        mComponent = new ComponentName(packageContext, cls);
4046    }
4047
4048    /**
4049     * Create an intent for a specific component with a specified action and data.
4050     * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
4051     * construct the Intent and then calling {@link #setClass} to set its
4052     * class.
4053     *
4054     * <p><em>Note: scheme and host name matching in the Android framework is
4055     * case-sensitive, unlike the formal RFC.  As a result,
4056     * you should always ensure that you write your Uri with these elements
4057     * using lower case letters, and normalize any Uris you receive from
4058     * outside of Android to ensure the scheme and host is lower case.</em></p>
4059     *
4060     * @param action The Intent action, such as ACTION_VIEW.
4061     * @param uri The Intent data URI.
4062     * @param packageContext A Context of the application package implementing
4063     * this class.
4064     * @param cls The component class that is to be used for the intent.
4065     *
4066     * @see #Intent(String, android.net.Uri)
4067     * @see #Intent(Context, Class)
4068     * @see #setClass
4069     * @see #setComponent
4070     */
4071    public Intent(String action, Uri uri,
4072            Context packageContext, Class<?> cls) {
4073        setAction(action);
4074        mData = uri;
4075        mComponent = new ComponentName(packageContext, cls);
4076    }
4077
4078    /**
4079     * Create an intent to launch the main (root) activity of a task.  This
4080     * is the Intent that is started when the application's is launched from
4081     * Home.  For anything else that wants to launch an application in the
4082     * same way, it is important that they use an Intent structured the same
4083     * way, and can use this function to ensure this is the case.
4084     *
4085     * <p>The returned Intent has the given Activity component as its explicit
4086     * component, {@link #ACTION_MAIN} as its action, and includes the
4087     * category {@link #CATEGORY_LAUNCHER}.  This does <em>not</em> have
4088     * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4089     * to do that through {@link #addFlags(int)} on the returned Intent.
4090     *
4091     * @param mainActivity The main activity component that this Intent will
4092     * launch.
4093     * @return Returns a newly created Intent that can be used to launch the
4094     * activity as a main application entry.
4095     *
4096     * @see #setClass
4097     * @see #setComponent
4098     */
4099    public static Intent makeMainActivity(ComponentName mainActivity) {
4100        Intent intent = new Intent(ACTION_MAIN);
4101        intent.setComponent(mainActivity);
4102        intent.addCategory(CATEGORY_LAUNCHER);
4103        return intent;
4104    }
4105
4106    /**
4107     * Make an Intent for the main activity of an application, without
4108     * specifying a specific activity to run but giving a selector to find
4109     * the activity.  This results in a final Intent that is structured
4110     * the same as when the application is launched from
4111     * Home.  For anything else that wants to launch an application in the
4112     * same way, it is important that they use an Intent structured the same
4113     * way, and can use this function to ensure this is the case.
4114     *
4115     * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4116     * category {@link #CATEGORY_LAUNCHER}.  This does <em>not</em> have
4117     * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4118     * to do that through {@link #addFlags(int)} on the returned Intent.
4119     *
4120     * @param selectorAction The action name of the Intent's selector.
4121     * @param selectorCategory The name of a category to add to the Intent's
4122     * selector.
4123     * @return Returns a newly created Intent that can be used to launch the
4124     * activity as a main application entry.
4125     *
4126     * @see #setSelector(Intent)
4127     */
4128    public static Intent makeMainSelectorActivity(String selectorAction,
4129            String selectorCategory) {
4130        Intent intent = new Intent(ACTION_MAIN);
4131        intent.addCategory(CATEGORY_LAUNCHER);
4132        Intent selector = new Intent();
4133        selector.setAction(selectorAction);
4134        selector.addCategory(selectorCategory);
4135        intent.setSelector(selector);
4136        return intent;
4137    }
4138
4139    /**
4140     * Make an Intent that can be used to re-launch an application's task
4141     * in its base state.  This is like {@link #makeMainActivity(ComponentName)},
4142     * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4143     * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4144     *
4145     * @param mainActivity The activity component that is the root of the
4146     * task; this is the activity that has been published in the application's
4147     * manifest as the main launcher icon.
4148     *
4149     * @return Returns a newly created Intent that can be used to relaunch the
4150     * activity's task in its root state.
4151     */
4152    public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4153        Intent intent = makeMainActivity(mainActivity);
4154        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4155                | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4156        return intent;
4157    }
4158
4159    /**
4160     * Call {@link #parseUri} with 0 flags.
4161     * @deprecated Use {@link #parseUri} instead.
4162     */
4163    @Deprecated
4164    public static Intent getIntent(String uri) throws URISyntaxException {
4165        return parseUri(uri, 0);
4166    }
4167
4168    /**
4169     * Create an intent from a URI.  This URI may encode the action,
4170     * category, and other intent fields, if it was returned by
4171     * {@link #toUri}.  If the Intent was not generate by toUri(), its data
4172     * will be the entire URI and its action will be ACTION_VIEW.
4173     *
4174     * <p>The URI given here must not be relative -- that is, it must include
4175     * the scheme and full path.
4176     *
4177     * @param uri The URI to turn into an Intent.
4178     * @param flags Additional processing flags.  Either 0 or
4179     * {@link #URI_INTENT_SCHEME}.
4180     *
4181     * @return Intent The newly created Intent object.
4182     *
4183     * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4184     * it bad (as parsed by the Uri class) or the Intent data within the
4185     * URI is invalid.
4186     *
4187     * @see #toUri
4188     */
4189    public static Intent parseUri(String uri, int flags) throws URISyntaxException {
4190        int i = 0;
4191        try {
4192            // Validate intent scheme for if requested.
4193            if ((flags&URI_INTENT_SCHEME) != 0) {
4194                if (!uri.startsWith("intent:")) {
4195                    Intent intent = new Intent(ACTION_VIEW);
4196                    try {
4197                        intent.setData(Uri.parse(uri));
4198                    } catch (IllegalArgumentException e) {
4199                        throw new URISyntaxException(uri, e.getMessage());
4200                    }
4201                    return intent;
4202                }
4203            }
4204
4205            // simple case
4206            i = uri.lastIndexOf("#");
4207            if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4208
4209            // old format Intent URI
4210            if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
4211
4212            // new format
4213            Intent intent = new Intent(ACTION_VIEW);
4214            Intent baseIntent = intent;
4215
4216            // fetch data part, if present
4217            String data = i >= 0 ? uri.substring(0, i) : null;
4218            String scheme = null;
4219            i += "#Intent;".length();
4220
4221            // loop over contents of Intent, all name=value;
4222            while (!uri.startsWith("end", i)) {
4223                int eq = uri.indexOf('=', i);
4224                if (eq < 0) eq = i-1;
4225                int semi = uri.indexOf(';', i);
4226                String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
4227
4228                // action
4229                if (uri.startsWith("action=", i)) {
4230                    intent.setAction(value);
4231                }
4232
4233                // categories
4234                else if (uri.startsWith("category=", i)) {
4235                    intent.addCategory(value);
4236                }
4237
4238                // type
4239                else if (uri.startsWith("type=", i)) {
4240                    intent.mType = value;
4241                }
4242
4243                // launch flags
4244                else if (uri.startsWith("launchFlags=", i)) {
4245                    intent.mFlags = Integer.decode(value).intValue();
4246                }
4247
4248                // package
4249                else if (uri.startsWith("package=", i)) {
4250                    intent.mPackage = value;
4251                }
4252
4253                // component
4254                else if (uri.startsWith("component=", i)) {
4255                    intent.mComponent = ComponentName.unflattenFromString(value);
4256                }
4257
4258                // scheme
4259                else if (uri.startsWith("scheme=", i)) {
4260                    scheme = value;
4261                }
4262
4263                // source bounds
4264                else if (uri.startsWith("sourceBounds=", i)) {
4265                    intent.mSourceBounds = Rect.unflattenFromString(value);
4266                }
4267
4268                // selector
4269                else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4270                    intent = new Intent();
4271                }
4272
4273                // extra
4274                else {
4275                    String key = Uri.decode(uri.substring(i + 2, eq));
4276                    // create Bundle if it doesn't already exist
4277                    if (intent.mExtras == null) intent.mExtras = new Bundle();
4278                    Bundle b = intent.mExtras;
4279                    // add EXTRA
4280                    if      (uri.startsWith("S.", i)) b.putString(key, value);
4281                    else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4282                    else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4283                    else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4284                    else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4285                    else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4286                    else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4287                    else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4288                    else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4289                    else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4290                }
4291
4292                // move to the next item
4293                i = semi + 1;
4294            }
4295
4296            if (intent != baseIntent) {
4297                // The Intent had a selector; fix it up.
4298                baseIntent.setSelector(intent);
4299                intent = baseIntent;
4300            }
4301
4302            if (data != null) {
4303                if (data.startsWith("intent:")) {
4304                    data = data.substring(7);
4305                    if (scheme != null) {
4306                        data = scheme + ':' + data;
4307                    }
4308                }
4309
4310                if (data.length() > 0) {
4311                    try {
4312                        intent.mData = Uri.parse(data);
4313                    } catch (IllegalArgumentException e) {
4314                        throw new URISyntaxException(uri, e.getMessage());
4315                    }
4316                }
4317            }
4318
4319            return intent;
4320
4321        } catch (IndexOutOfBoundsException e) {
4322            throw new URISyntaxException(uri, "illegal Intent URI format", i);
4323        }
4324    }
4325
4326    public static Intent getIntentOld(String uri) throws URISyntaxException {
4327        Intent intent;
4328
4329        int i = uri.lastIndexOf('#');
4330        if (i >= 0) {
4331            String action = null;
4332            final int intentFragmentStart = i;
4333            boolean isIntentFragment = false;
4334
4335            i++;
4336
4337            if (uri.regionMatches(i, "action(", 0, 7)) {
4338                isIntentFragment = true;
4339                i += 7;
4340                int j = uri.indexOf(')', i);
4341                action = uri.substring(i, j);
4342                i = j + 1;
4343            }
4344
4345            intent = new Intent(action);
4346
4347            if (uri.regionMatches(i, "categories(", 0, 11)) {
4348                isIntentFragment = true;
4349                i += 11;
4350                int j = uri.indexOf(')', i);
4351                while (i < j) {
4352                    int sep = uri.indexOf('!', i);
4353                    if (sep < 0) sep = j;
4354                    if (i < sep) {
4355                        intent.addCategory(uri.substring(i, sep));
4356                    }
4357                    i = sep + 1;
4358                }
4359                i = j + 1;
4360            }
4361
4362            if (uri.regionMatches(i, "type(", 0, 5)) {
4363                isIntentFragment = true;
4364                i += 5;
4365                int j = uri.indexOf(')', i);
4366                intent.mType = uri.substring(i, j);
4367                i = j + 1;
4368            }
4369
4370            if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
4371                isIntentFragment = true;
4372                i += 12;
4373                int j = uri.indexOf(')', i);
4374                intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4375                i = j + 1;
4376            }
4377
4378            if (uri.regionMatches(i, "component(", 0, 10)) {
4379                isIntentFragment = true;
4380                i += 10;
4381                int j = uri.indexOf(')', i);
4382                int sep = uri.indexOf('!', i);
4383                if (sep >= 0 && sep < j) {
4384                    String pkg = uri.substring(i, sep);
4385                    String cls = uri.substring(sep + 1, j);
4386                    intent.mComponent = new ComponentName(pkg, cls);
4387                }
4388                i = j + 1;
4389            }
4390
4391            if (uri.regionMatches(i, "extras(", 0, 7)) {
4392                isIntentFragment = true;
4393                i += 7;
4394
4395                final int closeParen = uri.indexOf(')', i);
4396                if (closeParen == -1) throw new URISyntaxException(uri,
4397                        "EXTRA missing trailing ')'", i);
4398
4399                while (i < closeParen) {
4400                    // fetch the key value
4401                    int j = uri.indexOf('=', i);
4402                    if (j <= i + 1 || i >= closeParen) {
4403                        throw new URISyntaxException(uri, "EXTRA missing '='", i);
4404                    }
4405                    char type = uri.charAt(i);
4406                    i++;
4407                    String key = uri.substring(i, j);
4408                    i = j + 1;
4409
4410                    // get type-value
4411                    j = uri.indexOf('!', i);
4412                    if (j == -1 || j >= closeParen) j = closeParen;
4413                    if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4414                    String value = uri.substring(i, j);
4415                    i = j;
4416
4417                    // create Bundle if it doesn't already exist
4418                    if (intent.mExtras == null) intent.mExtras = new Bundle();
4419
4420                    // add item to bundle
4421                    try {
4422                        switch (type) {
4423                            case 'S':
4424                                intent.mExtras.putString(key, Uri.decode(value));
4425                                break;
4426                            case 'B':
4427                                intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4428                                break;
4429                            case 'b':
4430                                intent.mExtras.putByte(key, Byte.parseByte(value));
4431                                break;
4432                            case 'c':
4433                                intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4434                                break;
4435                            case 'd':
4436                                intent.mExtras.putDouble(key, Double.parseDouble(value));
4437                                break;
4438                            case 'f':
4439                                intent.mExtras.putFloat(key, Float.parseFloat(value));
4440                                break;
4441                            case 'i':
4442                                intent.mExtras.putInt(key, Integer.parseInt(value));
4443                                break;
4444                            case 'l':
4445                                intent.mExtras.putLong(key, Long.parseLong(value));
4446                                break;
4447                            case 's':
4448                                intent.mExtras.putShort(key, Short.parseShort(value));
4449                                break;
4450                            default:
4451                                throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4452                        }
4453                    } catch (NumberFormatException e) {
4454                        throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4455                    }
4456
4457                    char ch = uri.charAt(i);
4458                    if (ch == ')') break;
4459                    if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4460                    i++;
4461                }
4462            }
4463
4464            if (isIntentFragment) {
4465                intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4466            } else {
4467                intent.mData = Uri.parse(uri);
4468            }
4469
4470            if (intent.mAction == null) {
4471                // By default, if no action is specified, then use VIEW.
4472                intent.mAction = ACTION_VIEW;
4473            }
4474
4475        } else {
4476            intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4477        }
4478
4479        return intent;
4480    }
4481
4482    /**
4483     * Retrieve the general action to be performed, such as
4484     * {@link #ACTION_VIEW}.  The action describes the general way the rest of
4485     * the information in the intent should be interpreted -- most importantly,
4486     * what to do with the data returned by {@link #getData}.
4487     *
4488     * @return The action of this intent or null if none is specified.
4489     *
4490     * @see #setAction
4491     */
4492    public String getAction() {
4493        return mAction;
4494    }
4495
4496    /**
4497     * Retrieve data this intent is operating on.  This URI specifies the name
4498     * of the data; often it uses the content: scheme, specifying data in a
4499     * content provider.  Other schemes may be handled by specific activities,
4500     * such as http: by the web browser.
4501     *
4502     * @return The URI of the data this intent is targeting or null.
4503     *
4504     * @see #getScheme
4505     * @see #setData
4506     */
4507    public Uri getData() {
4508        return mData;
4509    }
4510
4511    /**
4512     * The same as {@link #getData()}, but returns the URI as an encoded
4513     * String.
4514     */
4515    public String getDataString() {
4516        return mData != null ? mData.toString() : null;
4517    }
4518
4519    /**
4520     * Return the scheme portion of the intent's data.  If the data is null or
4521     * does not include a scheme, null is returned.  Otherwise, the scheme
4522     * prefix without the final ':' is returned, i.e. "http".
4523     *
4524     * <p>This is the same as calling getData().getScheme() (and checking for
4525     * null data).
4526     *
4527     * @return The scheme of this intent.
4528     *
4529     * @see #getData
4530     */
4531    public String getScheme() {
4532        return mData != null ? mData.getScheme() : null;
4533    }
4534
4535    /**
4536     * Retrieve any explicit MIME type included in the intent.  This is usually
4537     * null, as the type is determined by the intent data.
4538     *
4539     * @return If a type was manually set, it is returned; else null is
4540     *         returned.
4541     *
4542     * @see #resolveType(ContentResolver)
4543     * @see #setType
4544     */
4545    public String getType() {
4546        return mType;
4547    }
4548
4549    /**
4550     * Return the MIME data type of this intent.  If the type field is
4551     * explicitly set, that is simply returned.  Otherwise, if the data is set,
4552     * the type of that data is returned.  If neither fields are set, a null is
4553     * returned.
4554     *
4555     * @return The MIME type of this intent.
4556     *
4557     * @see #getType
4558     * @see #resolveType(ContentResolver)
4559     */
4560    public String resolveType(Context context) {
4561        return resolveType(context.getContentResolver());
4562    }
4563
4564    /**
4565     * Return the MIME data type of this intent.  If the type field is
4566     * explicitly set, that is simply returned.  Otherwise, if the data is set,
4567     * the type of that data is returned.  If neither fields are set, a null is
4568     * returned.
4569     *
4570     * @param resolver A ContentResolver that can be used to determine the MIME
4571     *                 type of the intent's data.
4572     *
4573     * @return The MIME type of this intent.
4574     *
4575     * @see #getType
4576     * @see #resolveType(Context)
4577     */
4578    public String resolveType(ContentResolver resolver) {
4579        if (mType != null) {
4580            return mType;
4581        }
4582        if (mData != null) {
4583            if ("content".equals(mData.getScheme())) {
4584                return resolver.getType(mData);
4585            }
4586        }
4587        return null;
4588    }
4589
4590    /**
4591     * Return the MIME data type of this intent, only if it will be needed for
4592     * intent resolution.  This is not generally useful for application code;
4593     * it is used by the frameworks for communicating with back-end system
4594     * services.
4595     *
4596     * @param resolver A ContentResolver that can be used to determine the MIME
4597     *                 type of the intent's data.
4598     *
4599     * @return The MIME type of this intent, or null if it is unknown or not
4600     *         needed.
4601     */
4602    public String resolveTypeIfNeeded(ContentResolver resolver) {
4603        if (mComponent != null) {
4604            return mType;
4605        }
4606        return resolveType(resolver);
4607    }
4608
4609    /**
4610     * Check if a category exists in the intent.
4611     *
4612     * @param category The category to check.
4613     *
4614     * @return boolean True if the intent contains the category, else false.
4615     *
4616     * @see #getCategories
4617     * @see #addCategory
4618     */
4619    public boolean hasCategory(String category) {
4620        return mCategories != null && mCategories.contains(category);
4621    }
4622
4623    /**
4624     * Return the set of all categories in the intent.  If there are no categories,
4625     * returns NULL.
4626     *
4627     * @return The set of categories you can examine.  Do not modify!
4628     *
4629     * @see #hasCategory
4630     * @see #addCategory
4631     */
4632    public Set<String> getCategories() {
4633        return mCategories;
4634    }
4635
4636    /**
4637     * Return the specific selector associated with this Intent.  If there is
4638     * none, returns null.  See {@link #setSelector} for more information.
4639     *
4640     * @see #setSelector
4641     */
4642    public Intent getSelector() {
4643        return mSelector;
4644    }
4645
4646    /**
4647     * Return the {@link ClipData} associated with this Intent.  If there is
4648     * none, returns null.  See {@link #setClipData} for more information.
4649     *
4650     * @see #setClipData
4651     */
4652    public ClipData getClipData() {
4653        return mClipData;
4654    }
4655
4656    /**
4657     * Sets the ClassLoader that will be used when unmarshalling
4658     * any Parcelable values from the extras of this Intent.
4659     *
4660     * @param loader a ClassLoader, or null to use the default loader
4661     * at the time of unmarshalling.
4662     */
4663    public void setExtrasClassLoader(ClassLoader loader) {
4664        if (mExtras != null) {
4665            mExtras.setClassLoader(loader);
4666        }
4667    }
4668
4669    /**
4670     * Returns true if an extra value is associated with the given name.
4671     * @param name the extra's name
4672     * @return true if the given extra is present.
4673     */
4674    public boolean hasExtra(String name) {
4675        return mExtras != null && mExtras.containsKey(name);
4676    }
4677
4678    /**
4679     * Returns true if the Intent's extras contain a parcelled file descriptor.
4680     * @return true if the Intent contains a parcelled file descriptor.
4681     */
4682    public boolean hasFileDescriptors() {
4683        return mExtras != null && mExtras.hasFileDescriptors();
4684    }
4685
4686    /** @hide */
4687    public void setAllowFds(boolean allowFds) {
4688        if (mExtras != null) {
4689            mExtras.setAllowFds(allowFds);
4690        }
4691    }
4692
4693    /**
4694     * Retrieve extended data from the intent.
4695     *
4696     * @param name The name of the desired item.
4697     *
4698     * @return the value of an item that previously added with putExtra()
4699     * or null if none was found.
4700     *
4701     * @deprecated
4702     * @hide
4703     */
4704    @Deprecated
4705    public Object getExtra(String name) {
4706        return getExtra(name, null);
4707    }
4708
4709    /**
4710     * Retrieve extended data from the intent.
4711     *
4712     * @param name The name of the desired item.
4713     * @param defaultValue the value to be returned if no value of the desired
4714     * type is stored with the given name.
4715     *
4716     * @return the value of an item that previously added with putExtra()
4717     * or the default value if none was found.
4718     *
4719     * @see #putExtra(String, boolean)
4720     */
4721    public boolean getBooleanExtra(String name, boolean defaultValue) {
4722        return mExtras == null ? defaultValue :
4723            mExtras.getBoolean(name, defaultValue);
4724    }
4725
4726    /**
4727     * Retrieve extended data from the intent.
4728     *
4729     * @param name The name of the desired item.
4730     * @param defaultValue the value to be returned if no value of the desired
4731     * type is stored with the given name.
4732     *
4733     * @return the value of an item that previously added with putExtra()
4734     * or the default value if none was found.
4735     *
4736     * @see #putExtra(String, byte)
4737     */
4738    public byte getByteExtra(String name, byte defaultValue) {
4739        return mExtras == null ? defaultValue :
4740            mExtras.getByte(name, defaultValue);
4741    }
4742
4743    /**
4744     * Retrieve extended data from the intent.
4745     *
4746     * @param name The name of the desired item.
4747     * @param defaultValue the value to be returned if no value of the desired
4748     * type is stored with the given name.
4749     *
4750     * @return the value of an item that previously added with putExtra()
4751     * or the default value if none was found.
4752     *
4753     * @see #putExtra(String, short)
4754     */
4755    public short getShortExtra(String name, short defaultValue) {
4756        return mExtras == null ? defaultValue :
4757            mExtras.getShort(name, defaultValue);
4758    }
4759
4760    /**
4761     * Retrieve extended data from the intent.
4762     *
4763     * @param name The name of the desired item.
4764     * @param defaultValue the value to be returned if no value of the desired
4765     * type is stored with the given name.
4766     *
4767     * @return the value of an item that previously added with putExtra()
4768     * or the default value if none was found.
4769     *
4770     * @see #putExtra(String, char)
4771     */
4772    public char getCharExtra(String name, char defaultValue) {
4773        return mExtras == null ? defaultValue :
4774            mExtras.getChar(name, defaultValue);
4775    }
4776
4777    /**
4778     * Retrieve extended data from the intent.
4779     *
4780     * @param name The name of the desired item.
4781     * @param defaultValue the value to be returned if no value of the desired
4782     * type is stored with the given name.
4783     *
4784     * @return the value of an item that previously added with putExtra()
4785     * or the default value if none was found.
4786     *
4787     * @see #putExtra(String, int)
4788     */
4789    public int getIntExtra(String name, int defaultValue) {
4790        return mExtras == null ? defaultValue :
4791            mExtras.getInt(name, defaultValue);
4792    }
4793
4794    /**
4795     * Retrieve extended data from the intent.
4796     *
4797     * @param name The name of the desired item.
4798     * @param defaultValue the value to be returned if no value of the desired
4799     * type is stored with the given name.
4800     *
4801     * @return the value of an item that previously added with putExtra()
4802     * or the default value if none was found.
4803     *
4804     * @see #putExtra(String, long)
4805     */
4806    public long getLongExtra(String name, long defaultValue) {
4807        return mExtras == null ? defaultValue :
4808            mExtras.getLong(name, defaultValue);
4809    }
4810
4811    /**
4812     * Retrieve extended data from the intent.
4813     *
4814     * @param name The name of the desired item.
4815     * @param defaultValue the value to be returned if no value of the desired
4816     * type is stored with the given name.
4817     *
4818     * @return the value of an item that previously added with putExtra(),
4819     * or the default value if no such item is present
4820     *
4821     * @see #putExtra(String, float)
4822     */
4823    public float getFloatExtra(String name, float defaultValue) {
4824        return mExtras == null ? defaultValue :
4825            mExtras.getFloat(name, defaultValue);
4826    }
4827
4828    /**
4829     * Retrieve extended data from the intent.
4830     *
4831     * @param name The name of the desired item.
4832     * @param defaultValue the value to be returned if no value of the desired
4833     * type is stored with the given name.
4834     *
4835     * @return the value of an item that previously added with putExtra()
4836     * or the default value if none was found.
4837     *
4838     * @see #putExtra(String, double)
4839     */
4840    public double getDoubleExtra(String name, double defaultValue) {
4841        return mExtras == null ? defaultValue :
4842            mExtras.getDouble(name, defaultValue);
4843    }
4844
4845    /**
4846     * Retrieve extended data from the intent.
4847     *
4848     * @param name The name of the desired item.
4849     *
4850     * @return the value of an item that previously added with putExtra()
4851     * or null if no String value was found.
4852     *
4853     * @see #putExtra(String, String)
4854     */
4855    public String getStringExtra(String name) {
4856        return mExtras == null ? null : mExtras.getString(name);
4857    }
4858
4859    /**
4860     * Retrieve extended data from the intent.
4861     *
4862     * @param name The name of the desired item.
4863     *
4864     * @return the value of an item that previously added with putExtra()
4865     * or null if no CharSequence value was found.
4866     *
4867     * @see #putExtra(String, CharSequence)
4868     */
4869    public CharSequence getCharSequenceExtra(String name) {
4870        return mExtras == null ? null : mExtras.getCharSequence(name);
4871    }
4872
4873    /**
4874     * Retrieve extended data from the intent.
4875     *
4876     * @param name The name of the desired item.
4877     *
4878     * @return the value of an item that previously added with putExtra()
4879     * or null if no Parcelable value was found.
4880     *
4881     * @see #putExtra(String, Parcelable)
4882     */
4883    public <T extends Parcelable> T getParcelableExtra(String name) {
4884        return mExtras == null ? null : mExtras.<T>getParcelable(name);
4885    }
4886
4887    /**
4888     * Retrieve extended data from the intent.
4889     *
4890     * @param name The name of the desired item.
4891     *
4892     * @return the value of an item that previously added with putExtra()
4893     * or null if no Parcelable[] value was found.
4894     *
4895     * @see #putExtra(String, Parcelable[])
4896     */
4897    public Parcelable[] getParcelableArrayExtra(String name) {
4898        return mExtras == null ? null : mExtras.getParcelableArray(name);
4899    }
4900
4901    /**
4902     * Retrieve extended data from the intent.
4903     *
4904     * @param name The name of the desired item.
4905     *
4906     * @return the value of an item that previously added with putExtra()
4907     * or null if no ArrayList<Parcelable> value was found.
4908     *
4909     * @see #putParcelableArrayListExtra(String, ArrayList)
4910     */
4911    public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4912        return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4913    }
4914
4915    /**
4916     * Retrieve extended data from the intent.
4917     *
4918     * @param name The name of the desired item.
4919     *
4920     * @return the value of an item that previously added with putExtra()
4921     * or null if no Serializable value was found.
4922     *
4923     * @see #putExtra(String, Serializable)
4924     */
4925    public Serializable getSerializableExtra(String name) {
4926        return mExtras == null ? null : mExtras.getSerializable(name);
4927    }
4928
4929    /**
4930     * Retrieve extended data from the intent.
4931     *
4932     * @param name The name of the desired item.
4933     *
4934     * @return the value of an item that previously added with putExtra()
4935     * or null if no ArrayList<Integer> value was found.
4936     *
4937     * @see #putIntegerArrayListExtra(String, ArrayList)
4938     */
4939    public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4940        return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4941    }
4942
4943    /**
4944     * Retrieve extended data from the intent.
4945     *
4946     * @param name The name of the desired item.
4947     *
4948     * @return the value of an item that previously added with putExtra()
4949     * or null if no ArrayList<String> value was found.
4950     *
4951     * @see #putStringArrayListExtra(String, ArrayList)
4952     */
4953    public ArrayList<String> getStringArrayListExtra(String name) {
4954        return mExtras == null ? null : mExtras.getStringArrayList(name);
4955    }
4956
4957    /**
4958     * Retrieve extended data from the intent.
4959     *
4960     * @param name The name of the desired item.
4961     *
4962     * @return the value of an item that previously added with putExtra()
4963     * or null if no ArrayList<CharSequence> value was found.
4964     *
4965     * @see #putCharSequenceArrayListExtra(String, ArrayList)
4966     */
4967    public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4968        return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4969    }
4970
4971    /**
4972     * Retrieve extended data from the intent.
4973     *
4974     * @param name The name of the desired item.
4975     *
4976     * @return the value of an item that previously added with putExtra()
4977     * or null if no boolean array value was found.
4978     *
4979     * @see #putExtra(String, boolean[])
4980     */
4981    public boolean[] getBooleanArrayExtra(String name) {
4982        return mExtras == null ? null : mExtras.getBooleanArray(name);
4983    }
4984
4985    /**
4986     * Retrieve extended data from the intent.
4987     *
4988     * @param name The name of the desired item.
4989     *
4990     * @return the value of an item that previously added with putExtra()
4991     * or null if no byte array value was found.
4992     *
4993     * @see #putExtra(String, byte[])
4994     */
4995    public byte[] getByteArrayExtra(String name) {
4996        return mExtras == null ? null : mExtras.getByteArray(name);
4997    }
4998
4999    /**
5000     * Retrieve extended data from the intent.
5001     *
5002     * @param name The name of the desired item.
5003     *
5004     * @return the value of an item that previously added with putExtra()
5005     * or null if no short array value was found.
5006     *
5007     * @see #putExtra(String, short[])
5008     */
5009    public short[] getShortArrayExtra(String name) {
5010        return mExtras == null ? null : mExtras.getShortArray(name);
5011    }
5012
5013    /**
5014     * Retrieve extended data from the intent.
5015     *
5016     * @param name The name of the desired item.
5017     *
5018     * @return the value of an item that previously added with putExtra()
5019     * or null if no char array value was found.
5020     *
5021     * @see #putExtra(String, char[])
5022     */
5023    public char[] getCharArrayExtra(String name) {
5024        return mExtras == null ? null : mExtras.getCharArray(name);
5025    }
5026
5027    /**
5028     * Retrieve extended data from the intent.
5029     *
5030     * @param name The name of the desired item.
5031     *
5032     * @return the value of an item that previously added with putExtra()
5033     * or null if no int array value was found.
5034     *
5035     * @see #putExtra(String, int[])
5036     */
5037    public int[] getIntArrayExtra(String name) {
5038        return mExtras == null ? null : mExtras.getIntArray(name);
5039    }
5040
5041    /**
5042     * Retrieve extended data from the intent.
5043     *
5044     * @param name The name of the desired item.
5045     *
5046     * @return the value of an item that previously added with putExtra()
5047     * or null if no long array value was found.
5048     *
5049     * @see #putExtra(String, long[])
5050     */
5051    public long[] getLongArrayExtra(String name) {
5052        return mExtras == null ? null : mExtras.getLongArray(name);
5053    }
5054
5055    /**
5056     * Retrieve extended data from the intent.
5057     *
5058     * @param name The name of the desired item.
5059     *
5060     * @return the value of an item that previously added with putExtra()
5061     * or null if no float array value was found.
5062     *
5063     * @see #putExtra(String, float[])
5064     */
5065    public float[] getFloatArrayExtra(String name) {
5066        return mExtras == null ? null : mExtras.getFloatArray(name);
5067    }
5068
5069    /**
5070     * Retrieve extended data from the intent.
5071     *
5072     * @param name The name of the desired item.
5073     *
5074     * @return the value of an item that previously added with putExtra()
5075     * or null if no double array value was found.
5076     *
5077     * @see #putExtra(String, double[])
5078     */
5079    public double[] getDoubleArrayExtra(String name) {
5080        return mExtras == null ? null : mExtras.getDoubleArray(name);
5081    }
5082
5083    /**
5084     * Retrieve extended data from the intent.
5085     *
5086     * @param name The name of the desired item.
5087     *
5088     * @return the value of an item that previously added with putExtra()
5089     * or null if no String array value was found.
5090     *
5091     * @see #putExtra(String, String[])
5092     */
5093    public String[] getStringArrayExtra(String name) {
5094        return mExtras == null ? null : mExtras.getStringArray(name);
5095    }
5096
5097    /**
5098     * Retrieve extended data from the intent.
5099     *
5100     * @param name The name of the desired item.
5101     *
5102     * @return the value of an item that previously added with putExtra()
5103     * or null if no CharSequence array value was found.
5104     *
5105     * @see #putExtra(String, CharSequence[])
5106     */
5107    public CharSequence[] getCharSequenceArrayExtra(String name) {
5108        return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5109    }
5110
5111    /**
5112     * Retrieve extended data from the intent.
5113     *
5114     * @param name The name of the desired item.
5115     *
5116     * @return the value of an item that previously added with putExtra()
5117     * or null if no Bundle value was found.
5118     *
5119     * @see #putExtra(String, Bundle)
5120     */
5121    public Bundle getBundleExtra(String name) {
5122        return mExtras == null ? null : mExtras.getBundle(name);
5123    }
5124
5125    /**
5126     * Retrieve extended data from the intent.
5127     *
5128     * @param name The name of the desired item.
5129     *
5130     * @return the value of an item that previously added with putExtra()
5131     * or null if no IBinder value was found.
5132     *
5133     * @see #putExtra(String, IBinder)
5134     *
5135     * @deprecated
5136     * @hide
5137     */
5138    @Deprecated
5139    public IBinder getIBinderExtra(String name) {
5140        return mExtras == null ? null : mExtras.getIBinder(name);
5141    }
5142
5143    /**
5144     * Retrieve extended data from the intent.
5145     *
5146     * @param name The name of the desired item.
5147     * @param defaultValue The default value to return in case no item is
5148     * associated with the key 'name'
5149     *
5150     * @return the value of an item that previously added with putExtra()
5151     * or defaultValue if none was found.
5152     *
5153     * @see #putExtra
5154     *
5155     * @deprecated
5156     * @hide
5157     */
5158    @Deprecated
5159    public Object getExtra(String name, Object defaultValue) {
5160        Object result = defaultValue;
5161        if (mExtras != null) {
5162            Object result2 = mExtras.get(name);
5163            if (result2 != null) {
5164                result = result2;
5165            }
5166        }
5167
5168        return result;
5169    }
5170
5171    /**
5172     * Retrieves a map of extended data from the intent.
5173     *
5174     * @return the map of all extras previously added with putExtra(),
5175     * or null if none have been added.
5176     */
5177    public Bundle getExtras() {
5178        return (mExtras != null)
5179                ? new Bundle(mExtras)
5180                : null;
5181    }
5182
5183    /**
5184     * Retrieve any special flags associated with this intent.  You will
5185     * normally just set them with {@link #setFlags} and let the system
5186     * take the appropriate action with them.
5187     *
5188     * @return int The currently set flags.
5189     *
5190     * @see #setFlags
5191     */
5192    public int getFlags() {
5193        return mFlags;
5194    }
5195
5196    /** @hide */
5197    public boolean isExcludingStopped() {
5198        return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5199                == FLAG_EXCLUDE_STOPPED_PACKAGES;
5200    }
5201
5202    /**
5203     * Retrieve the application package name this Intent is limited to.  When
5204     * resolving an Intent, if non-null this limits the resolution to only
5205     * components in the given application package.
5206     *
5207     * @return The name of the application package for the Intent.
5208     *
5209     * @see #resolveActivity
5210     * @see #setPackage
5211     */
5212    public String getPackage() {
5213        return mPackage;
5214    }
5215
5216    /**
5217     * Retrieve the concrete component associated with the intent.  When receiving
5218     * an intent, this is the component that was found to best handle it (that is,
5219     * yourself) and will always be non-null; in all other cases it will be
5220     * null unless explicitly set.
5221     *
5222     * @return The name of the application component to handle the intent.
5223     *
5224     * @see #resolveActivity
5225     * @see #setComponent
5226     */
5227    public ComponentName getComponent() {
5228        return mComponent;
5229    }
5230
5231    /**
5232     * Get the bounds of the sender of this intent, in screen coordinates.  This can be
5233     * used as a hint to the receiver for animations and the like.  Null means that there
5234     * is no source bounds.
5235     */
5236    public Rect getSourceBounds() {
5237        return mSourceBounds;
5238    }
5239
5240    /**
5241     * Return the Activity component that should be used to handle this intent.
5242     * The appropriate component is determined based on the information in the
5243     * intent, evaluated as follows:
5244     *
5245     * <p>If {@link #getComponent} returns an explicit class, that is returned
5246     * without any further consideration.
5247     *
5248     * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5249     * category to be considered.
5250     *
5251     * <p>If {@link #getAction} is non-NULL, the activity must handle this
5252     * action.
5253     *
5254     * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5255     * this type.
5256     *
5257     * <p>If {@link #addCategory} has added any categories, the activity must
5258     * handle ALL of the categories specified.
5259     *
5260     * <p>If {@link #getPackage} is non-NULL, only activity components in
5261     * that application package will be considered.
5262     *
5263     * <p>If there are no activities that satisfy all of these conditions, a
5264     * null string is returned.
5265     *
5266     * <p>If multiple activities are found to satisfy the intent, the one with
5267     * the highest priority will be used.  If there are multiple activities
5268     * with the same priority, the system will either pick the best activity
5269     * based on user preference, or resolve to a system class that will allow
5270     * the user to pick an activity and forward from there.
5271     *
5272     * <p>This method is implemented simply by calling
5273     * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5274     * true.</p>
5275     * <p> This API is called for you as part of starting an activity from an
5276     * intent.  You do not normally need to call it yourself.</p>
5277     *
5278     * @param pm The package manager with which to resolve the Intent.
5279     *
5280     * @return Name of the component implementing an activity that can
5281     *         display the intent.
5282     *
5283     * @see #setComponent
5284     * @see #getComponent
5285     * @see #resolveActivityInfo
5286     */
5287    public ComponentName resolveActivity(PackageManager pm) {
5288        if (mComponent != null) {
5289            return mComponent;
5290        }
5291
5292        ResolveInfo info = pm.resolveActivity(
5293            this, PackageManager.MATCH_DEFAULT_ONLY);
5294        if (info != null) {
5295            return new ComponentName(
5296                    info.activityInfo.applicationInfo.packageName,
5297                    info.activityInfo.name);
5298        }
5299
5300        return null;
5301    }
5302
5303    /**
5304     * Resolve the Intent into an {@link ActivityInfo}
5305     * describing the activity that should execute the intent.  Resolution
5306     * follows the same rules as described for {@link #resolveActivity}, but
5307     * you get back the completely information about the resolved activity
5308     * instead of just its class name.
5309     *
5310     * @param pm The package manager with which to resolve the Intent.
5311     * @param flags Addition information to retrieve as per
5312     * {@link PackageManager#getActivityInfo(ComponentName, int)
5313     * PackageManager.getActivityInfo()}.
5314     *
5315     * @return PackageManager.ActivityInfo
5316     *
5317     * @see #resolveActivity
5318     */
5319    public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5320        ActivityInfo ai = null;
5321        if (mComponent != null) {
5322            try {
5323                ai = pm.getActivityInfo(mComponent, flags);
5324            } catch (PackageManager.NameNotFoundException e) {
5325                // ignore
5326            }
5327        } else {
5328            ResolveInfo info = pm.resolveActivity(
5329                this, PackageManager.MATCH_DEFAULT_ONLY | flags);
5330            if (info != null) {
5331                ai = info.activityInfo;
5332            }
5333        }
5334
5335        return ai;
5336    }
5337
5338    /**
5339     * Special function for use by the system to resolve service
5340     * intents to system apps.  Throws an exception if there are
5341     * multiple potential matches to the Intent.  Returns null if
5342     * there are no matches.
5343     * @hide
5344     */
5345    public ComponentName resolveSystemService(PackageManager pm, int flags) {
5346        if (mComponent != null) {
5347            return mComponent;
5348        }
5349
5350        List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5351        if (results == null) {
5352            return null;
5353        }
5354        ComponentName comp = null;
5355        for (int i=0; i<results.size(); i++) {
5356            ResolveInfo ri = results.get(i);
5357            if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5358                continue;
5359            }
5360            ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5361                    ri.serviceInfo.name);
5362            if (comp != null) {
5363                throw new IllegalStateException("Multiple system services handle " + this
5364                        + ": " + comp + ", " + foundComp);
5365            }
5366            comp = foundComp;
5367        }
5368        return comp;
5369    }
5370
5371    /**
5372     * Set the general action to be performed.
5373     *
5374     * @param action An action name, such as ACTION_VIEW.  Application-specific
5375     *               actions should be prefixed with the vendor's package name.
5376     *
5377     * @return Returns the same Intent object, for chaining multiple calls
5378     * into a single statement.
5379     *
5380     * @see #getAction
5381     */
5382    public Intent setAction(String action) {
5383        mAction = action != null ? action.intern() : null;
5384        return this;
5385    }
5386
5387    /**
5388     * Set the data this intent is operating on.  This method automatically
5389     * clears any type that was previously set by {@link #setType} or
5390     * {@link #setTypeAndNormalize}.
5391     *
5392     * <p><em>Note: scheme matching in the Android framework is
5393     * case-sensitive, unlike the formal RFC. As a result,
5394     * you should always write your Uri with a lower case scheme,
5395     * or use {@link Uri#normalizeScheme} or
5396     * {@link #setDataAndNormalize}
5397     * to ensure that the scheme is converted to lower case.</em>
5398     *
5399     * @param data The Uri of the data this intent is now targeting.
5400     *
5401     * @return Returns the same Intent object, for chaining multiple calls
5402     * into a single statement.
5403     *
5404     * @see #getData
5405     * @see #setDataAndNormalize
5406     * @see android.net.Uri#normalizeScheme()
5407     */
5408    public Intent setData(Uri data) {
5409        mData = data;
5410        mType = null;
5411        return this;
5412    }
5413
5414    /**
5415     * Normalize and set the data this intent is operating on.
5416     *
5417     * <p>This method automatically clears any type that was
5418     * previously set (for example, by {@link #setType}).
5419     *
5420     * <p>The data Uri is normalized using
5421     * {@link android.net.Uri#normalizeScheme} before it is set,
5422     * so really this is just a convenience method for
5423     * <pre>
5424     * setData(data.normalize())
5425     * </pre>
5426     *
5427     * @param data The Uri of the data this intent is now targeting.
5428     *
5429     * @return Returns the same Intent object, for chaining multiple calls
5430     * into a single statement.
5431     *
5432     * @see #getData
5433     * @see #setType
5434     * @see android.net.Uri#normalizeScheme
5435     */
5436    public Intent setDataAndNormalize(Uri data) {
5437        return setData(data.normalizeScheme());
5438    }
5439
5440    /**
5441     * Set an explicit MIME data type.
5442     *
5443     * <p>This is used to create intents that only specify a type and not data,
5444     * for example to indicate the type of data to return.
5445     *
5446     * <p>This method automatically clears any data that was
5447     * previously set (for example by {@link #setData}).
5448     *
5449     * <p><em>Note: MIME type matching in the Android framework is
5450     * case-sensitive, unlike formal RFC MIME types.  As a result,
5451     * you should always write your MIME types with lower case letters,
5452     * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5453     * to ensure that it is converted to lower case.</em>
5454     *
5455     * @param type The MIME type of the data being handled by this intent.
5456     *
5457     * @return Returns the same Intent object, for chaining multiple calls
5458     * into a single statement.
5459     *
5460     * @see #getType
5461     * @see #setTypeAndNormalize
5462     * @see #setDataAndType
5463     * @see #normalizeMimeType
5464     */
5465    public Intent setType(String type) {
5466        mData = null;
5467        mType = type;
5468        return this;
5469    }
5470
5471    /**
5472     * Normalize and set an explicit MIME data type.
5473     *
5474     * <p>This is used to create intents that only specify a type and not data,
5475     * for example to indicate the type of data to return.
5476     *
5477     * <p>This method automatically clears any data that was
5478     * previously set (for example by {@link #setData}).
5479     *
5480     * <p>The MIME type is normalized using
5481     * {@link #normalizeMimeType} before it is set,
5482     * so really this is just a convenience method for
5483     * <pre>
5484     * setType(Intent.normalizeMimeType(type))
5485     * </pre>
5486     *
5487     * @param type The MIME type of the data being handled by this intent.
5488     *
5489     * @return Returns the same Intent object, for chaining multiple calls
5490     * into a single statement.
5491     *
5492     * @see #getType
5493     * @see #setData
5494     * @see #normalizeMimeType
5495     */
5496    public Intent setTypeAndNormalize(String type) {
5497        return setType(normalizeMimeType(type));
5498    }
5499
5500    /**
5501     * (Usually optional) Set the data for the intent along with an explicit
5502     * MIME data type.  This method should very rarely be used -- it allows you
5503     * to override the MIME type that would ordinarily be inferred from the
5504     * data with your own type given here.
5505     *
5506     * <p><em>Note: MIME type and Uri scheme matching in the
5507     * Android framework is case-sensitive, unlike the formal RFC definitions.
5508     * As a result, you should always write these elements with lower case letters,
5509     * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
5510     * {@link #setDataAndTypeAndNormalize}
5511     * to ensure that they are converted to lower case.</em>
5512     *
5513     * @param data The Uri of the data this intent is now targeting.
5514     * @param type The MIME type of the data being handled by this intent.
5515     *
5516     * @return Returns the same Intent object, for chaining multiple calls
5517     * into a single statement.
5518     *
5519     * @see #setType
5520     * @see #setData
5521     * @see #normalizeMimeType
5522     * @see android.net.Uri#normalizeScheme
5523     * @see #setDataAndTypeAndNormalize
5524     */
5525    public Intent setDataAndType(Uri data, String type) {
5526        mData = data;
5527        mType = type;
5528        return this;
5529    }
5530
5531    /**
5532     * (Usually optional) Normalize and set both the data Uri and an explicit
5533     * MIME data type.  This method should very rarely be used -- it allows you
5534     * to override the MIME type that would ordinarily be inferred from the
5535     * data with your own type given here.
5536     *
5537     * <p>The data Uri and the MIME type are normalize using
5538     * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
5539     * before they are set, so really this is just a convenience method for
5540     * <pre>
5541     * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5542     * </pre>
5543     *
5544     * @param data The Uri of the data this intent is now targeting.
5545     * @param type The MIME type of the data being handled by this intent.
5546     *
5547     * @return Returns the same Intent object, for chaining multiple calls
5548     * into a single statement.
5549     *
5550     * @see #setType
5551     * @see #setData
5552     * @see #setDataAndType
5553     * @see #normalizeMimeType
5554     * @see android.net.Uri#normalizeScheme
5555     */
5556    public Intent setDataAndTypeAndNormalize(Uri data, String type) {
5557        return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
5558    }
5559
5560    /**
5561     * Add a new category to the intent.  Categories provide additional detail
5562     * about the action the intent performs.  When resolving an intent, only
5563     * activities that provide <em>all</em> of the requested categories will be
5564     * used.
5565     *
5566     * @param category The desired category.  This can be either one of the
5567     *               predefined Intent categories, or a custom category in your own
5568     *               namespace.
5569     *
5570     * @return Returns the same Intent object, for chaining multiple calls
5571     * into a single statement.
5572     *
5573     * @see #hasCategory
5574     * @see #removeCategory
5575     */
5576    public Intent addCategory(String category) {
5577        if (mCategories == null) {
5578            mCategories = new ArraySet<String>();
5579        }
5580        mCategories.add(category.intern());
5581        return this;
5582    }
5583
5584    /**
5585     * Remove a category from an intent.
5586     *
5587     * @param category The category to remove.
5588     *
5589     * @see #addCategory
5590     */
5591    public void removeCategory(String category) {
5592        if (mCategories != null) {
5593            mCategories.remove(category);
5594            if (mCategories.size() == 0) {
5595                mCategories = null;
5596            }
5597        }
5598    }
5599
5600    /**
5601     * Set a selector for this Intent.  This is a modification to the kinds of
5602     * things the Intent will match.  If the selector is set, it will be used
5603     * when trying to find entities that can handle the Intent, instead of the
5604     * main contents of the Intent.  This allows you build an Intent containing
5605     * a generic protocol while targeting it more specifically.
5606     *
5607     * <p>An example of where this may be used is with things like
5608     * {@link #CATEGORY_APP_BROWSER}.  This category allows you to build an
5609     * Intent that will launch the Browser application.  However, the correct
5610     * main entry point of an application is actually {@link #ACTION_MAIN}
5611     * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5612     * used to specify the actual Activity to launch.  If you launch the browser
5613     * with something different, undesired behavior may happen if the user has
5614     * previously or later launches it the normal way, since they do not match.
5615     * Instead, you can build an Intent with the MAIN action (but no ComponentName
5616     * yet specified) and set a selector with {@link #ACTION_MAIN} and
5617     * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5618     *
5619     * <p>Setting a selector does not impact the behavior of
5620     * {@link #filterEquals(Intent)} and {@link #filterHashCode()}.  This is part of the
5621     * desired behavior of a selector -- it does not impact the base meaning
5622     * of the Intent, just what kinds of things will be matched against it
5623     * when determining who can handle it.</p>
5624     *
5625     * <p>You can not use both a selector and {@link #setPackage(String)} on
5626     * the same base Intent.</p>
5627     *
5628     * @param selector The desired selector Intent; set to null to not use
5629     * a special selector.
5630     */
5631    public void setSelector(Intent selector) {
5632        if (selector == this) {
5633            throw new IllegalArgumentException(
5634                    "Intent being set as a selector of itself");
5635        }
5636        if (selector != null && mPackage != null) {
5637            throw new IllegalArgumentException(
5638                    "Can't set selector when package name is already set");
5639        }
5640        mSelector = selector;
5641    }
5642
5643    /**
5644     * Set a {@link ClipData} associated with this Intent.  This replaces any
5645     * previously set ClipData.
5646     *
5647     * <p>The ClipData in an intent is not used for Intent matching or other
5648     * such operations.  Semantically it is like extras, used to transmit
5649     * additional data with the Intent.  The main feature of using this over
5650     * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5651     * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5652     * items included in the clip data.  This is useful, in particular, if
5653     * you want to transmit an Intent containing multiple <code>content:</code>
5654     * URIs for which the recipient may not have global permission to access the
5655     * content provider.
5656     *
5657     * <p>If the ClipData contains items that are themselves Intents, any
5658     * grant flags in those Intents will be ignored.  Only the top-level flags
5659     * of the main Intent are respected, and will be applied to all Uri or
5660     * Intent items in the clip (or sub-items of the clip).
5661     *
5662     * <p>The MIME type, label, and icon in the ClipData object are not
5663     * directly used by Intent.  Applications should generally rely on the
5664     * MIME type of the Intent itself, not what it may find in the ClipData.
5665     * A common practice is to construct a ClipData for use with an Intent
5666     * with a MIME type of "*&#47;*".
5667     *
5668     * @param clip The new clip to set.  May be null to clear the current clip.
5669     */
5670    public void setClipData(ClipData clip) {
5671        mClipData = clip;
5672    }
5673
5674    /**
5675     * Add extended data to the intent.  The name must include a package
5676     * prefix, for example the app com.android.contacts would use names
5677     * like "com.android.contacts.ShowAll".
5678     *
5679     * @param name The name of the extra data, with package prefix.
5680     * @param value The boolean data value.
5681     *
5682     * @return Returns the same Intent object, for chaining multiple calls
5683     * into a single statement.
5684     *
5685     * @see #putExtras
5686     * @see #removeExtra
5687     * @see #getBooleanExtra(String, boolean)
5688     */
5689    public Intent putExtra(String name, boolean value) {
5690        if (mExtras == null) {
5691            mExtras = new Bundle();
5692        }
5693        mExtras.putBoolean(name, value);
5694        return this;
5695    }
5696
5697    /**
5698     * Add extended data to the intent.  The name must include a package
5699     * prefix, for example the app com.android.contacts would use names
5700     * like "com.android.contacts.ShowAll".
5701     *
5702     * @param name The name of the extra data, with package prefix.
5703     * @param value The byte data value.
5704     *
5705     * @return Returns the same Intent object, for chaining multiple calls
5706     * into a single statement.
5707     *
5708     * @see #putExtras
5709     * @see #removeExtra
5710     * @see #getByteExtra(String, byte)
5711     */
5712    public Intent putExtra(String name, byte value) {
5713        if (mExtras == null) {
5714            mExtras = new Bundle();
5715        }
5716        mExtras.putByte(name, value);
5717        return this;
5718    }
5719
5720    /**
5721     * Add extended data to the intent.  The name must include a package
5722     * prefix, for example the app com.android.contacts would use names
5723     * like "com.android.contacts.ShowAll".
5724     *
5725     * @param name The name of the extra data, with package prefix.
5726     * @param value The char data value.
5727     *
5728     * @return Returns the same Intent object, for chaining multiple calls
5729     * into a single statement.
5730     *
5731     * @see #putExtras
5732     * @see #removeExtra
5733     * @see #getCharExtra(String, char)
5734     */
5735    public Intent putExtra(String name, char value) {
5736        if (mExtras == null) {
5737            mExtras = new Bundle();
5738        }
5739        mExtras.putChar(name, value);
5740        return this;
5741    }
5742
5743    /**
5744     * Add extended data to the intent.  The name must include a package
5745     * prefix, for example the app com.android.contacts would use names
5746     * like "com.android.contacts.ShowAll".
5747     *
5748     * @param name The name of the extra data, with package prefix.
5749     * @param value The short data value.
5750     *
5751     * @return Returns the same Intent object, for chaining multiple calls
5752     * into a single statement.
5753     *
5754     * @see #putExtras
5755     * @see #removeExtra
5756     * @see #getShortExtra(String, short)
5757     */
5758    public Intent putExtra(String name, short value) {
5759        if (mExtras == null) {
5760            mExtras = new Bundle();
5761        }
5762        mExtras.putShort(name, value);
5763        return this;
5764    }
5765
5766    /**
5767     * Add extended data to the intent.  The name must include a package
5768     * prefix, for example the app com.android.contacts would use names
5769     * like "com.android.contacts.ShowAll".
5770     *
5771     * @param name The name of the extra data, with package prefix.
5772     * @param value The integer data value.
5773     *
5774     * @return Returns the same Intent object, for chaining multiple calls
5775     * into a single statement.
5776     *
5777     * @see #putExtras
5778     * @see #removeExtra
5779     * @see #getIntExtra(String, int)
5780     */
5781    public Intent putExtra(String name, int value) {
5782        if (mExtras == null) {
5783            mExtras = new Bundle();
5784        }
5785        mExtras.putInt(name, value);
5786        return this;
5787    }
5788
5789    /**
5790     * Add extended data to the intent.  The name must include a package
5791     * prefix, for example the app com.android.contacts would use names
5792     * like "com.android.contacts.ShowAll".
5793     *
5794     * @param name The name of the extra data, with package prefix.
5795     * @param value The long data value.
5796     *
5797     * @return Returns the same Intent object, for chaining multiple calls
5798     * into a single statement.
5799     *
5800     * @see #putExtras
5801     * @see #removeExtra
5802     * @see #getLongExtra(String, long)
5803     */
5804    public Intent putExtra(String name, long value) {
5805        if (mExtras == null) {
5806            mExtras = new Bundle();
5807        }
5808        mExtras.putLong(name, value);
5809        return this;
5810    }
5811
5812    /**
5813     * Add extended data to the intent.  The name must include a package
5814     * prefix, for example the app com.android.contacts would use names
5815     * like "com.android.contacts.ShowAll".
5816     *
5817     * @param name The name of the extra data, with package prefix.
5818     * @param value The float data value.
5819     *
5820     * @return Returns the same Intent object, for chaining multiple calls
5821     * into a single statement.
5822     *
5823     * @see #putExtras
5824     * @see #removeExtra
5825     * @see #getFloatExtra(String, float)
5826     */
5827    public Intent putExtra(String name, float value) {
5828        if (mExtras == null) {
5829            mExtras = new Bundle();
5830        }
5831        mExtras.putFloat(name, value);
5832        return this;
5833    }
5834
5835    /**
5836     * Add extended data to the intent.  The name must include a package
5837     * prefix, for example the app com.android.contacts would use names
5838     * like "com.android.contacts.ShowAll".
5839     *
5840     * @param name The name of the extra data, with package prefix.
5841     * @param value The double data value.
5842     *
5843     * @return Returns the same Intent object, for chaining multiple calls
5844     * into a single statement.
5845     *
5846     * @see #putExtras
5847     * @see #removeExtra
5848     * @see #getDoubleExtra(String, double)
5849     */
5850    public Intent putExtra(String name, double value) {
5851        if (mExtras == null) {
5852            mExtras = new Bundle();
5853        }
5854        mExtras.putDouble(name, value);
5855        return this;
5856    }
5857
5858    /**
5859     * Add extended data to the intent.  The name must include a package
5860     * prefix, for example the app com.android.contacts would use names
5861     * like "com.android.contacts.ShowAll".
5862     *
5863     * @param name The name of the extra data, with package prefix.
5864     * @param value The String data value.
5865     *
5866     * @return Returns the same Intent object, for chaining multiple calls
5867     * into a single statement.
5868     *
5869     * @see #putExtras
5870     * @see #removeExtra
5871     * @see #getStringExtra(String)
5872     */
5873    public Intent putExtra(String name, String value) {
5874        if (mExtras == null) {
5875            mExtras = new Bundle();
5876        }
5877        mExtras.putString(name, value);
5878        return this;
5879    }
5880
5881    /**
5882     * Add extended data to the intent.  The name must include a package
5883     * prefix, for example the app com.android.contacts would use names
5884     * like "com.android.contacts.ShowAll".
5885     *
5886     * @param name The name of the extra data, with package prefix.
5887     * @param value The CharSequence data value.
5888     *
5889     * @return Returns the same Intent object, for chaining multiple calls
5890     * into a single statement.
5891     *
5892     * @see #putExtras
5893     * @see #removeExtra
5894     * @see #getCharSequenceExtra(String)
5895     */
5896    public Intent putExtra(String name, CharSequence value) {
5897        if (mExtras == null) {
5898            mExtras = new Bundle();
5899        }
5900        mExtras.putCharSequence(name, value);
5901        return this;
5902    }
5903
5904    /**
5905     * Add extended data to the intent.  The name must include a package
5906     * prefix, for example the app com.android.contacts would use names
5907     * like "com.android.contacts.ShowAll".
5908     *
5909     * @param name The name of the extra data, with package prefix.
5910     * @param value The Parcelable data value.
5911     *
5912     * @return Returns the same Intent object, for chaining multiple calls
5913     * into a single statement.
5914     *
5915     * @see #putExtras
5916     * @see #removeExtra
5917     * @see #getParcelableExtra(String)
5918     */
5919    public Intent putExtra(String name, Parcelable value) {
5920        if (mExtras == null) {
5921            mExtras = new Bundle();
5922        }
5923        mExtras.putParcelable(name, value);
5924        return this;
5925    }
5926
5927    /**
5928     * Add extended data to the intent.  The name must include a package
5929     * prefix, for example the app com.android.contacts would use names
5930     * like "com.android.contacts.ShowAll".
5931     *
5932     * @param name The name of the extra data, with package prefix.
5933     * @param value The Parcelable[] data value.
5934     *
5935     * @return Returns the same Intent object, for chaining multiple calls
5936     * into a single statement.
5937     *
5938     * @see #putExtras
5939     * @see #removeExtra
5940     * @see #getParcelableArrayExtra(String)
5941     */
5942    public Intent putExtra(String name, Parcelable[] value) {
5943        if (mExtras == null) {
5944            mExtras = new Bundle();
5945        }
5946        mExtras.putParcelableArray(name, value);
5947        return this;
5948    }
5949
5950    /**
5951     * Add extended data to the intent.  The name must include a package
5952     * prefix, for example the app com.android.contacts would use names
5953     * like "com.android.contacts.ShowAll".
5954     *
5955     * @param name The name of the extra data, with package prefix.
5956     * @param value The ArrayList<Parcelable> data value.
5957     *
5958     * @return Returns the same Intent object, for chaining multiple calls
5959     * into a single statement.
5960     *
5961     * @see #putExtras
5962     * @see #removeExtra
5963     * @see #getParcelableArrayListExtra(String)
5964     */
5965    public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5966        if (mExtras == null) {
5967            mExtras = new Bundle();
5968        }
5969        mExtras.putParcelableArrayList(name, value);
5970        return this;
5971    }
5972
5973    /**
5974     * Add extended data to the intent.  The name must include a package
5975     * prefix, for example the app com.android.contacts would use names
5976     * like "com.android.contacts.ShowAll".
5977     *
5978     * @param name The name of the extra data, with package prefix.
5979     * @param value The ArrayList<Integer> data value.
5980     *
5981     * @return Returns the same Intent object, for chaining multiple calls
5982     * into a single statement.
5983     *
5984     * @see #putExtras
5985     * @see #removeExtra
5986     * @see #getIntegerArrayListExtra(String)
5987     */
5988    public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5989        if (mExtras == null) {
5990            mExtras = new Bundle();
5991        }
5992        mExtras.putIntegerArrayList(name, value);
5993        return this;
5994    }
5995
5996    /**
5997     * Add extended data to the intent.  The name must include a package
5998     * prefix, for example the app com.android.contacts would use names
5999     * like "com.android.contacts.ShowAll".
6000     *
6001     * @param name The name of the extra data, with package prefix.
6002     * @param value The ArrayList<String> data value.
6003     *
6004     * @return Returns the same Intent object, for chaining multiple calls
6005     * into a single statement.
6006     *
6007     * @see #putExtras
6008     * @see #removeExtra
6009     * @see #getStringArrayListExtra(String)
6010     */
6011    public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6012        if (mExtras == null) {
6013            mExtras = new Bundle();
6014        }
6015        mExtras.putStringArrayList(name, value);
6016        return this;
6017    }
6018
6019    /**
6020     * Add extended data to the intent.  The name must include a package
6021     * prefix, for example the app com.android.contacts would use names
6022     * like "com.android.contacts.ShowAll".
6023     *
6024     * @param name The name of the extra data, with package prefix.
6025     * @param value The ArrayList<CharSequence> data value.
6026     *
6027     * @return Returns the same Intent object, for chaining multiple calls
6028     * into a single statement.
6029     *
6030     * @see #putExtras
6031     * @see #removeExtra
6032     * @see #getCharSequenceArrayListExtra(String)
6033     */
6034    public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6035        if (mExtras == null) {
6036            mExtras = new Bundle();
6037        }
6038        mExtras.putCharSequenceArrayList(name, value);
6039        return this;
6040    }
6041
6042    /**
6043     * Add extended data to the intent.  The name must include a package
6044     * prefix, for example the app com.android.contacts would use names
6045     * like "com.android.contacts.ShowAll".
6046     *
6047     * @param name The name of the extra data, with package prefix.
6048     * @param value The Serializable data value.
6049     *
6050     * @return Returns the same Intent object, for chaining multiple calls
6051     * into a single statement.
6052     *
6053     * @see #putExtras
6054     * @see #removeExtra
6055     * @see #getSerializableExtra(String)
6056     */
6057    public Intent putExtra(String name, Serializable value) {
6058        if (mExtras == null) {
6059            mExtras = new Bundle();
6060        }
6061        mExtras.putSerializable(name, value);
6062        return this;
6063    }
6064
6065    /**
6066     * Add extended data to the intent.  The name must include a package
6067     * prefix, for example the app com.android.contacts would use names
6068     * like "com.android.contacts.ShowAll".
6069     *
6070     * @param name The name of the extra data, with package prefix.
6071     * @param value The boolean array data value.
6072     *
6073     * @return Returns the same Intent object, for chaining multiple calls
6074     * into a single statement.
6075     *
6076     * @see #putExtras
6077     * @see #removeExtra
6078     * @see #getBooleanArrayExtra(String)
6079     */
6080    public Intent putExtra(String name, boolean[] value) {
6081        if (mExtras == null) {
6082            mExtras = new Bundle();
6083        }
6084        mExtras.putBooleanArray(name, value);
6085        return this;
6086    }
6087
6088    /**
6089     * Add extended data to the intent.  The name must include a package
6090     * prefix, for example the app com.android.contacts would use names
6091     * like "com.android.contacts.ShowAll".
6092     *
6093     * @param name The name of the extra data, with package prefix.
6094     * @param value The byte array data value.
6095     *
6096     * @return Returns the same Intent object, for chaining multiple calls
6097     * into a single statement.
6098     *
6099     * @see #putExtras
6100     * @see #removeExtra
6101     * @see #getByteArrayExtra(String)
6102     */
6103    public Intent putExtra(String name, byte[] value) {
6104        if (mExtras == null) {
6105            mExtras = new Bundle();
6106        }
6107        mExtras.putByteArray(name, value);
6108        return this;
6109    }
6110
6111    /**
6112     * Add extended data to the intent.  The name must include a package
6113     * prefix, for example the app com.android.contacts would use names
6114     * like "com.android.contacts.ShowAll".
6115     *
6116     * @param name The name of the extra data, with package prefix.
6117     * @param value The short array data value.
6118     *
6119     * @return Returns the same Intent object, for chaining multiple calls
6120     * into a single statement.
6121     *
6122     * @see #putExtras
6123     * @see #removeExtra
6124     * @see #getShortArrayExtra(String)
6125     */
6126    public Intent putExtra(String name, short[] value) {
6127        if (mExtras == null) {
6128            mExtras = new Bundle();
6129        }
6130        mExtras.putShortArray(name, value);
6131        return this;
6132    }
6133
6134    /**
6135     * Add extended data to the intent.  The name must include a package
6136     * prefix, for example the app com.android.contacts would use names
6137     * like "com.android.contacts.ShowAll".
6138     *
6139     * @param name The name of the extra data, with package prefix.
6140     * @param value The char array data value.
6141     *
6142     * @return Returns the same Intent object, for chaining multiple calls
6143     * into a single statement.
6144     *
6145     * @see #putExtras
6146     * @see #removeExtra
6147     * @see #getCharArrayExtra(String)
6148     */
6149    public Intent putExtra(String name, char[] value) {
6150        if (mExtras == null) {
6151            mExtras = new Bundle();
6152        }
6153        mExtras.putCharArray(name, value);
6154        return this;
6155    }
6156
6157    /**
6158     * Add extended data to the intent.  The name must include a package
6159     * prefix, for example the app com.android.contacts would use names
6160     * like "com.android.contacts.ShowAll".
6161     *
6162     * @param name The name of the extra data, with package prefix.
6163     * @param value The int array data value.
6164     *
6165     * @return Returns the same Intent object, for chaining multiple calls
6166     * into a single statement.
6167     *
6168     * @see #putExtras
6169     * @see #removeExtra
6170     * @see #getIntArrayExtra(String)
6171     */
6172    public Intent putExtra(String name, int[] value) {
6173        if (mExtras == null) {
6174            mExtras = new Bundle();
6175        }
6176        mExtras.putIntArray(name, value);
6177        return this;
6178    }
6179
6180    /**
6181     * Add extended data to the intent.  The name must include a package
6182     * prefix, for example the app com.android.contacts would use names
6183     * like "com.android.contacts.ShowAll".
6184     *
6185     * @param name The name of the extra data, with package prefix.
6186     * @param value The byte array data value.
6187     *
6188     * @return Returns the same Intent object, for chaining multiple calls
6189     * into a single statement.
6190     *
6191     * @see #putExtras
6192     * @see #removeExtra
6193     * @see #getLongArrayExtra(String)
6194     */
6195    public Intent putExtra(String name, long[] value) {
6196        if (mExtras == null) {
6197            mExtras = new Bundle();
6198        }
6199        mExtras.putLongArray(name, value);
6200        return this;
6201    }
6202
6203    /**
6204     * Add extended data to the intent.  The name must include a package
6205     * prefix, for example the app com.android.contacts would use names
6206     * like "com.android.contacts.ShowAll".
6207     *
6208     * @param name The name of the extra data, with package prefix.
6209     * @param value The float array data value.
6210     *
6211     * @return Returns the same Intent object, for chaining multiple calls
6212     * into a single statement.
6213     *
6214     * @see #putExtras
6215     * @see #removeExtra
6216     * @see #getFloatArrayExtra(String)
6217     */
6218    public Intent putExtra(String name, float[] value) {
6219        if (mExtras == null) {
6220            mExtras = new Bundle();
6221        }
6222        mExtras.putFloatArray(name, value);
6223        return this;
6224    }
6225
6226    /**
6227     * Add extended data to the intent.  The name must include a package
6228     * prefix, for example the app com.android.contacts would use names
6229     * like "com.android.contacts.ShowAll".
6230     *
6231     * @param name The name of the extra data, with package prefix.
6232     * @param value The double array data value.
6233     *
6234     * @return Returns the same Intent object, for chaining multiple calls
6235     * into a single statement.
6236     *
6237     * @see #putExtras
6238     * @see #removeExtra
6239     * @see #getDoubleArrayExtra(String)
6240     */
6241    public Intent putExtra(String name, double[] value) {
6242        if (mExtras == null) {
6243            mExtras = new Bundle();
6244        }
6245        mExtras.putDoubleArray(name, value);
6246        return this;
6247    }
6248
6249    /**
6250     * Add extended data to the intent.  The name must include a package
6251     * prefix, for example the app com.android.contacts would use names
6252     * like "com.android.contacts.ShowAll".
6253     *
6254     * @param name The name of the extra data, with package prefix.
6255     * @param value The String array data value.
6256     *
6257     * @return Returns the same Intent object, for chaining multiple calls
6258     * into a single statement.
6259     *
6260     * @see #putExtras
6261     * @see #removeExtra
6262     * @see #getStringArrayExtra(String)
6263     */
6264    public Intent putExtra(String name, String[] value) {
6265        if (mExtras == null) {
6266            mExtras = new Bundle();
6267        }
6268        mExtras.putStringArray(name, value);
6269        return this;
6270    }
6271
6272    /**
6273     * Add extended data to the intent.  The name must include a package
6274     * prefix, for example the app com.android.contacts would use names
6275     * like "com.android.contacts.ShowAll".
6276     *
6277     * @param name The name of the extra data, with package prefix.
6278     * @param value The CharSequence array data value.
6279     *
6280     * @return Returns the same Intent object, for chaining multiple calls
6281     * into a single statement.
6282     *
6283     * @see #putExtras
6284     * @see #removeExtra
6285     * @see #getCharSequenceArrayExtra(String)
6286     */
6287    public Intent putExtra(String name, CharSequence[] value) {
6288        if (mExtras == null) {
6289            mExtras = new Bundle();
6290        }
6291        mExtras.putCharSequenceArray(name, value);
6292        return this;
6293    }
6294
6295    /**
6296     * Add extended data to the intent.  The name must include a package
6297     * prefix, for example the app com.android.contacts would use names
6298     * like "com.android.contacts.ShowAll".
6299     *
6300     * @param name The name of the extra data, with package prefix.
6301     * @param value The Bundle data value.
6302     *
6303     * @return Returns the same Intent object, for chaining multiple calls
6304     * into a single statement.
6305     *
6306     * @see #putExtras
6307     * @see #removeExtra
6308     * @see #getBundleExtra(String)
6309     */
6310    public Intent putExtra(String name, Bundle value) {
6311        if (mExtras == null) {
6312            mExtras = new Bundle();
6313        }
6314        mExtras.putBundle(name, value);
6315        return this;
6316    }
6317
6318    /**
6319     * Add extended data to the intent.  The name must include a package
6320     * prefix, for example the app com.android.contacts would use names
6321     * like "com.android.contacts.ShowAll".
6322     *
6323     * @param name The name of the extra data, with package prefix.
6324     * @param value The IBinder data value.
6325     *
6326     * @return Returns the same Intent object, for chaining multiple calls
6327     * into a single statement.
6328     *
6329     * @see #putExtras
6330     * @see #removeExtra
6331     * @see #getIBinderExtra(String)
6332     *
6333     * @deprecated
6334     * @hide
6335     */
6336    @Deprecated
6337    public Intent putExtra(String name, IBinder value) {
6338        if (mExtras == null) {
6339            mExtras = new Bundle();
6340        }
6341        mExtras.putIBinder(name, value);
6342        return this;
6343    }
6344
6345    /**
6346     * Copy all extras in 'src' in to this intent.
6347     *
6348     * @param src Contains the extras to copy.
6349     *
6350     * @see #putExtra
6351     */
6352    public Intent putExtras(Intent src) {
6353        if (src.mExtras != null) {
6354            if (mExtras == null) {
6355                mExtras = new Bundle(src.mExtras);
6356            } else {
6357                mExtras.putAll(src.mExtras);
6358            }
6359        }
6360        return this;
6361    }
6362
6363    /**
6364     * Add a set of extended data to the intent.  The keys must include a package
6365     * prefix, for example the app com.android.contacts would use names
6366     * like "com.android.contacts.ShowAll".
6367     *
6368     * @param extras The Bundle of extras to add to this intent.
6369     *
6370     * @see #putExtra
6371     * @see #removeExtra
6372     */
6373    public Intent putExtras(Bundle extras) {
6374        if (mExtras == null) {
6375            mExtras = new Bundle();
6376        }
6377        mExtras.putAll(extras);
6378        return this;
6379    }
6380
6381    /**
6382     * Completely replace the extras in the Intent with the extras in the
6383     * given Intent.
6384     *
6385     * @param src The exact extras contained in this Intent are copied
6386     * into the target intent, replacing any that were previously there.
6387     */
6388    public Intent replaceExtras(Intent src) {
6389        mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6390        return this;
6391    }
6392
6393    /**
6394     * Completely replace the extras in the Intent with the given Bundle of
6395     * extras.
6396     *
6397     * @param extras The new set of extras in the Intent, or null to erase
6398     * all extras.
6399     */
6400    public Intent replaceExtras(Bundle extras) {
6401        mExtras = extras != null ? new Bundle(extras) : null;
6402        return this;
6403    }
6404
6405    /**
6406     * Remove extended data from the intent.
6407     *
6408     * @see #putExtra
6409     */
6410    public void removeExtra(String name) {
6411        if (mExtras != null) {
6412            mExtras.remove(name);
6413            if (mExtras.size() == 0) {
6414                mExtras = null;
6415            }
6416        }
6417    }
6418
6419    /**
6420     * Set special flags controlling how this intent is handled.  Most values
6421     * here depend on the type of component being executed by the Intent,
6422     * specifically the FLAG_ACTIVITY_* flags are all for use with
6423     * {@link Context#startActivity Context.startActivity()} and the
6424     * FLAG_RECEIVER_* flags are all for use with
6425     * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6426     *
6427     * <p>See the
6428     * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6429     * Stack</a> documentation for important information on how some of these options impact
6430     * the behavior of your application.
6431     *
6432     * @param flags The desired flags.
6433     *
6434     * @return Returns the same Intent object, for chaining multiple calls
6435     * into a single statement.
6436     *
6437     * @see #getFlags
6438     * @see #addFlags
6439     *
6440     * @see #FLAG_GRANT_READ_URI_PERMISSION
6441     * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6442     * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6443     * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
6444     * @see #FLAG_DEBUG_LOG_RESOLUTION
6445     * @see #FLAG_FROM_BACKGROUND
6446     * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
6447     * @see #FLAG_ACTIVITY_CLEAR_TASK
6448     * @see #FLAG_ACTIVITY_CLEAR_TOP
6449     * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
6450     * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6451     * @see #FLAG_ACTIVITY_FORWARD_RESULT
6452     * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
6453     * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6454     * @see #FLAG_ACTIVITY_NEW_DOCUMENT
6455     * @see #FLAG_ACTIVITY_NEW_TASK
6456     * @see #FLAG_ACTIVITY_NO_ANIMATION
6457     * @see #FLAG_ACTIVITY_NO_HISTORY
6458     * @see #FLAG_ACTIVITY_NO_USER_ACTION
6459     * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6460     * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
6461     * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
6462     * @see #FLAG_ACTIVITY_SINGLE_TOP
6463     * @see #FLAG_ACTIVITY_TASK_ON_HOME
6464     * @see #FLAG_RECEIVER_REGISTERED_ONLY
6465     */
6466    public Intent setFlags(int flags) {
6467        mFlags = flags;
6468        return this;
6469    }
6470
6471    /**
6472     * Add additional flags to the intent (or with existing flags
6473     * value).
6474     *
6475     * @param flags The new flags to set.
6476     *
6477     * @return Returns the same Intent object, for chaining multiple calls
6478     * into a single statement.
6479     *
6480     * @see #setFlags
6481     */
6482    public Intent addFlags(int flags) {
6483        mFlags |= flags;
6484        return this;
6485    }
6486
6487    /**
6488     * (Usually optional) Set an explicit application package name that limits
6489     * the components this Intent will resolve to.  If left to the default
6490     * value of null, all components in all applications will considered.
6491     * If non-null, the Intent can only match the components in the given
6492     * application package.
6493     *
6494     * @param packageName The name of the application package to handle the
6495     * intent, or null to allow any application package.
6496     *
6497     * @return Returns the same Intent object, for chaining multiple calls
6498     * into a single statement.
6499     *
6500     * @see #getPackage
6501     * @see #resolveActivity
6502     */
6503    public Intent setPackage(String packageName) {
6504        if (packageName != null && mSelector != null) {
6505            throw new IllegalArgumentException(
6506                    "Can't set package name when selector is already set");
6507        }
6508        mPackage = packageName;
6509        return this;
6510    }
6511
6512    /**
6513     * (Usually optional) Explicitly set the component to handle the intent.
6514     * If left with the default value of null, the system will determine the
6515     * appropriate class to use based on the other fields (action, data,
6516     * type, categories) in the Intent.  If this class is defined, the
6517     * specified class will always be used regardless of the other fields.  You
6518     * should only set this value when you know you absolutely want a specific
6519     * class to be used; otherwise it is better to let the system find the
6520     * appropriate class so that you will respect the installed applications
6521     * and user preferences.
6522     *
6523     * @param component The name of the application component to handle the
6524     * intent, or null to let the system find one for you.
6525     *
6526     * @return Returns the same Intent object, for chaining multiple calls
6527     * into a single statement.
6528     *
6529     * @see #setClass
6530     * @see #setClassName(Context, String)
6531     * @see #setClassName(String, String)
6532     * @see #getComponent
6533     * @see #resolveActivity
6534     */
6535    public Intent setComponent(ComponentName component) {
6536        mComponent = component;
6537        return this;
6538    }
6539
6540    /**
6541     * Convenience for calling {@link #setComponent} with an
6542     * explicit class name.
6543     *
6544     * @param packageContext A Context of the application package implementing
6545     * this class.
6546     * @param className The name of a class inside of the application package
6547     * that will be used as the component for this Intent.
6548     *
6549     * @return Returns the same Intent object, for chaining multiple calls
6550     * into a single statement.
6551     *
6552     * @see #setComponent
6553     * @see #setClass
6554     */
6555    public Intent setClassName(Context packageContext, String className) {
6556        mComponent = new ComponentName(packageContext, className);
6557        return this;
6558    }
6559
6560    /**
6561     * Convenience for calling {@link #setComponent} with an
6562     * explicit application package name and class name.
6563     *
6564     * @param packageName The name of the package implementing the desired
6565     * component.
6566     * @param className The name of a class inside of the application package
6567     * that will be used as the component for this Intent.
6568     *
6569     * @return Returns the same Intent object, for chaining multiple calls
6570     * into a single statement.
6571     *
6572     * @see #setComponent
6573     * @see #setClass
6574     */
6575    public Intent setClassName(String packageName, String className) {
6576        mComponent = new ComponentName(packageName, className);
6577        return this;
6578    }
6579
6580    /**
6581     * Convenience for calling {@link #setComponent(ComponentName)} with the
6582     * name returned by a {@link Class} object.
6583     *
6584     * @param packageContext A Context of the application package implementing
6585     * this class.
6586     * @param cls The class name to set, equivalent to
6587     *            <code>setClassName(context, cls.getName())</code>.
6588     *
6589     * @return Returns the same Intent object, for chaining multiple calls
6590     * into a single statement.
6591     *
6592     * @see #setComponent
6593     */
6594    public Intent setClass(Context packageContext, Class<?> cls) {
6595        mComponent = new ComponentName(packageContext, cls);
6596        return this;
6597    }
6598
6599    /**
6600     * Set the bounds of the sender of this intent, in screen coordinates.  This can be
6601     * used as a hint to the receiver for animations and the like.  Null means that there
6602     * is no source bounds.
6603     */
6604    public void setSourceBounds(Rect r) {
6605        if (r != null) {
6606            mSourceBounds = new Rect(r);
6607        } else {
6608            mSourceBounds = null;
6609        }
6610    }
6611
6612    /** @hide */
6613    @IntDef(flag = true,
6614            value = {
6615                    FILL_IN_ACTION,
6616                    FILL_IN_DATA,
6617                    FILL_IN_CATEGORIES,
6618                    FILL_IN_COMPONENT,
6619                    FILL_IN_PACKAGE,
6620                    FILL_IN_SOURCE_BOUNDS,
6621                    FILL_IN_SELECTOR,
6622                    FILL_IN_CLIP_DATA
6623            })
6624    @Retention(RetentionPolicy.SOURCE)
6625    public @interface FillInFlags {}
6626
6627    /**
6628     * Use with {@link #fillIn} to allow the current action value to be
6629     * overwritten, even if it is already set.
6630     */
6631    public static final int FILL_IN_ACTION = 1<<0;
6632
6633    /**
6634     * Use with {@link #fillIn} to allow the current data or type value
6635     * overwritten, even if it is already set.
6636     */
6637    public static final int FILL_IN_DATA = 1<<1;
6638
6639    /**
6640     * Use with {@link #fillIn} to allow the current categories to be
6641     * overwritten, even if they are already set.
6642     */
6643    public static final int FILL_IN_CATEGORIES = 1<<2;
6644
6645    /**
6646     * Use with {@link #fillIn} to allow the current component value to be
6647     * overwritten, even if it is already set.
6648     */
6649    public static final int FILL_IN_COMPONENT = 1<<3;
6650
6651    /**
6652     * Use with {@link #fillIn} to allow the current package value to be
6653     * overwritten, even if it is already set.
6654     */
6655    public static final int FILL_IN_PACKAGE = 1<<4;
6656
6657    /**
6658     * Use with {@link #fillIn} to allow the current bounds rectangle to be
6659     * overwritten, even if it is already set.
6660     */
6661    public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6662
6663    /**
6664     * Use with {@link #fillIn} to allow the current selector to be
6665     * overwritten, even if it is already set.
6666     */
6667    public static final int FILL_IN_SELECTOR = 1<<6;
6668
6669    /**
6670     * Use with {@link #fillIn} to allow the current ClipData to be
6671     * overwritten, even if it is already set.
6672     */
6673    public static final int FILL_IN_CLIP_DATA = 1<<7;
6674
6675    /**
6676     * Copy the contents of <var>other</var> in to this object, but only
6677     * where fields are not defined by this object.  For purposes of a field
6678     * being defined, the following pieces of data in the Intent are
6679     * considered to be separate fields:
6680     *
6681     * <ul>
6682     * <li> action, as set by {@link #setAction}.
6683     * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
6684     * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6685     * <li> categories, as set by {@link #addCategory}.
6686     * <li> package, as set by {@link #setPackage}.
6687     * <li> component, as set by {@link #setComponent(ComponentName)} or
6688     * related methods.
6689     * <li> source bounds, as set by {@link #setSourceBounds}.
6690     * <li> selector, as set by {@link #setSelector(Intent)}.
6691     * <li> clip data, as set by {@link #setClipData(ClipData)}.
6692     * <li> each top-level name in the associated extras.
6693     * </ul>
6694     *
6695     * <p>In addition, you can use the {@link #FILL_IN_ACTION},
6696     * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
6697     * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6698     * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6699     * the restriction where the corresponding field will not be replaced if
6700     * it is already set.
6701     *
6702     * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6703     * is explicitly specified.  The selector will only be copied if
6704     * {@link #FILL_IN_SELECTOR} is explicitly specified.
6705     *
6706     * <p>For example, consider Intent A with {data="foo", categories="bar"}
6707     * and Intent B with {action="gotit", data-type="some/thing",
6708     * categories="one","two"}.
6709     *
6710     * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6711     * containing: {action="gotit", data-type="some/thing",
6712     * categories="bar"}.
6713     *
6714     * @param other Another Intent whose values are to be used to fill in
6715     * the current one.
6716     * @param flags Options to control which fields can be filled in.
6717     *
6718     * @return Returns a bit mask of {@link #FILL_IN_ACTION},
6719     * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
6720     * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6721     * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6722     * changed.
6723     */
6724    @FillInFlags
6725    public int fillIn(Intent other, @FillInFlags int flags) {
6726        int changes = 0;
6727        if (other.mAction != null
6728                && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
6729            mAction = other.mAction;
6730            changes |= FILL_IN_ACTION;
6731        }
6732        if ((other.mData != null || other.mType != null)
6733                && ((mData == null && mType == null)
6734                        || (flags&FILL_IN_DATA) != 0)) {
6735            mData = other.mData;
6736            mType = other.mType;
6737            changes |= FILL_IN_DATA;
6738        }
6739        if (other.mCategories != null
6740                && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
6741            if (other.mCategories != null) {
6742                mCategories = new ArraySet<String>(other.mCategories);
6743            }
6744            changes |= FILL_IN_CATEGORIES;
6745        }
6746        if (other.mPackage != null
6747                && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
6748            // Only do this if mSelector is not set.
6749            if (mSelector == null) {
6750                mPackage = other.mPackage;
6751                changes |= FILL_IN_PACKAGE;
6752            }
6753        }
6754        // Selector is special: it can only be set if explicitly allowed,
6755        // for the same reason as the component name.
6756        if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6757            if (mPackage == null) {
6758                mSelector = new Intent(other.mSelector);
6759                mPackage = null;
6760                changes |= FILL_IN_SELECTOR;
6761            }
6762        }
6763        if (other.mClipData != null
6764                && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6765            mClipData = other.mClipData;
6766            changes |= FILL_IN_CLIP_DATA;
6767        }
6768        // Component is special: it can -only- be set if explicitly allowed,
6769        // since otherwise the sender could force the intent somewhere the
6770        // originator didn't intend.
6771        if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
6772            mComponent = other.mComponent;
6773            changes |= FILL_IN_COMPONENT;
6774        }
6775        mFlags |= other.mFlags;
6776        if (other.mSourceBounds != null
6777                && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6778            mSourceBounds = new Rect(other.mSourceBounds);
6779            changes |= FILL_IN_SOURCE_BOUNDS;
6780        }
6781        if (mExtras == null) {
6782            if (other.mExtras != null) {
6783                mExtras = new Bundle(other.mExtras);
6784            }
6785        } else if (other.mExtras != null) {
6786            try {
6787                Bundle newb = new Bundle(other.mExtras);
6788                newb.putAll(mExtras);
6789                mExtras = newb;
6790            } catch (RuntimeException e) {
6791                // Modifying the extras can cause us to unparcel the contents
6792                // of the bundle, and if we do this in the system process that
6793                // may fail.  We really should handle this (i.e., the Bundle
6794                // impl shouldn't be on top of a plain map), but for now just
6795                // ignore it and keep the original contents. :(
6796                Log.w("Intent", "Failure filling in extras", e);
6797            }
6798        }
6799        return changes;
6800    }
6801
6802    /**
6803     * Wrapper class holding an Intent and implementing comparisons on it for
6804     * the purpose of filtering.  The class implements its
6805     * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6806     * simple calls to {@link Intent#filterEquals(Intent)}  filterEquals()} and
6807     * {@link android.content.Intent#filterHashCode()}  filterHashCode()}
6808     * on the wrapped Intent.
6809     */
6810    public static final class FilterComparison {
6811        private final Intent mIntent;
6812        private final int mHashCode;
6813
6814        public FilterComparison(Intent intent) {
6815            mIntent = intent;
6816            mHashCode = intent.filterHashCode();
6817        }
6818
6819        /**
6820         * Return the Intent that this FilterComparison represents.
6821         * @return Returns the Intent held by the FilterComparison.  Do
6822         * not modify!
6823         */
6824        public Intent getIntent() {
6825            return mIntent;
6826        }
6827
6828        @Override
6829        public boolean equals(Object obj) {
6830            if (obj instanceof FilterComparison) {
6831                Intent other = ((FilterComparison)obj).mIntent;
6832                return mIntent.filterEquals(other);
6833            }
6834            return false;
6835        }
6836
6837        @Override
6838        public int hashCode() {
6839            return mHashCode;
6840        }
6841    }
6842
6843    /**
6844     * Determine if two intents are the same for the purposes of intent
6845     * resolution (filtering). That is, if their action, data, type,
6846     * class, and categories are the same.  This does <em>not</em> compare
6847     * any extra data included in the intents.
6848     *
6849     * @param other The other Intent to compare against.
6850     *
6851     * @return Returns true if action, data, type, class, and categories
6852     *         are the same.
6853     */
6854    public boolean filterEquals(Intent other) {
6855        if (other == null) {
6856            return false;
6857        }
6858        if (!Objects.equals(this.mAction, other.mAction)) return false;
6859        if (!Objects.equals(this.mData, other.mData)) return false;
6860        if (!Objects.equals(this.mType, other.mType)) return false;
6861        if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6862        if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6863        if (!Objects.equals(this.mCategories, other.mCategories)) return false;
6864
6865        return true;
6866    }
6867
6868    /**
6869     * Generate hash code that matches semantics of filterEquals().
6870     *
6871     * @return Returns the hash value of the action, data, type, class, and
6872     *         categories.
6873     *
6874     * @see #filterEquals
6875     */
6876    public int filterHashCode() {
6877        int code = 0;
6878        if (mAction != null) {
6879            code += mAction.hashCode();
6880        }
6881        if (mData != null) {
6882            code += mData.hashCode();
6883        }
6884        if (mType != null) {
6885            code += mType.hashCode();
6886        }
6887        if (mPackage != null) {
6888            code += mPackage.hashCode();
6889        }
6890        if (mComponent != null) {
6891            code += mComponent.hashCode();
6892        }
6893        if (mCategories != null) {
6894            code += mCategories.hashCode();
6895        }
6896        return code;
6897    }
6898
6899    @Override
6900    public String toString() {
6901        StringBuilder b = new StringBuilder(128);
6902
6903        b.append("Intent { ");
6904        toShortString(b, true, true, true, false);
6905        b.append(" }");
6906
6907        return b.toString();
6908    }
6909
6910    /** @hide */
6911    public String toInsecureString() {
6912        StringBuilder b = new StringBuilder(128);
6913
6914        b.append("Intent { ");
6915        toShortString(b, false, true, true, false);
6916        b.append(" }");
6917
6918        return b.toString();
6919    }
6920
6921    /** @hide */
6922    public String toInsecureStringWithClip() {
6923        StringBuilder b = new StringBuilder(128);
6924
6925        b.append("Intent { ");
6926        toShortString(b, false, true, true, true);
6927        b.append(" }");
6928
6929        return b.toString();
6930    }
6931
6932    /** @hide */
6933    public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6934        StringBuilder b = new StringBuilder(128);
6935        toShortString(b, secure, comp, extras, clip);
6936        return b.toString();
6937    }
6938
6939    /** @hide */
6940    public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6941            boolean clip) {
6942        boolean first = true;
6943        if (mAction != null) {
6944            b.append("act=").append(mAction);
6945            first = false;
6946        }
6947        if (mCategories != null) {
6948            if (!first) {
6949                b.append(' ');
6950            }
6951            first = false;
6952            b.append("cat=[");
6953            for (int i=0; i<mCategories.size(); i++) {
6954                if (i > 0) b.append(',');
6955                b.append(mCategories.valueAt(i));
6956            }
6957            b.append("]");
6958        }
6959        if (mData != null) {
6960            if (!first) {
6961                b.append(' ');
6962            }
6963            first = false;
6964            b.append("dat=");
6965            if (secure) {
6966                b.append(mData.toSafeString());
6967            } else {
6968                b.append(mData);
6969            }
6970        }
6971        if (mType != null) {
6972            if (!first) {
6973                b.append(' ');
6974            }
6975            first = false;
6976            b.append("typ=").append(mType);
6977        }
6978        if (mFlags != 0) {
6979            if (!first) {
6980                b.append(' ');
6981            }
6982            first = false;
6983            b.append("flg=0x").append(Integer.toHexString(mFlags));
6984        }
6985        if (mPackage != null) {
6986            if (!first) {
6987                b.append(' ');
6988            }
6989            first = false;
6990            b.append("pkg=").append(mPackage);
6991        }
6992        if (comp && mComponent != null) {
6993            if (!first) {
6994                b.append(' ');
6995            }
6996            first = false;
6997            b.append("cmp=").append(mComponent.flattenToShortString());
6998        }
6999        if (mSourceBounds != null) {
7000            if (!first) {
7001                b.append(' ');
7002            }
7003            first = false;
7004            b.append("bnds=").append(mSourceBounds.toShortString());
7005        }
7006        if (mClipData != null) {
7007            if (!first) {
7008                b.append(' ');
7009            }
7010            first = false;
7011            if (clip) {
7012                b.append("clip={");
7013                mClipData.toShortString(b);
7014                b.append('}');
7015            } else {
7016                b.append("(has clip)");
7017            }
7018        }
7019        if (extras && mExtras != null) {
7020            if (!first) {
7021                b.append(' ');
7022            }
7023            first = false;
7024            b.append("(has extras)");
7025        }
7026        if (mSelector != null) {
7027            b.append(" sel={");
7028            mSelector.toShortString(b, secure, comp, extras, clip);
7029            b.append("}");
7030        }
7031    }
7032
7033    /**
7034     * Call {@link #toUri} with 0 flags.
7035     * @deprecated Use {@link #toUri} instead.
7036     */
7037    @Deprecated
7038    public String toURI() {
7039        return toUri(0);
7040    }
7041
7042    /**
7043     * Convert this Intent into a String holding a URI representation of it.
7044     * The returned URI string has been properly URI encoded, so it can be
7045     * used with {@link Uri#parse Uri.parse(String)}.  The URI contains the
7046     * Intent's data as the base URI, with an additional fragment describing
7047     * the action, categories, type, flags, package, component, and extras.
7048     *
7049     * <p>You can convert the returned string back to an Intent with
7050     * {@link #getIntent}.
7051     *
7052     * @param flags Additional operating flags.  Either 0 or
7053     * {@link #URI_INTENT_SCHEME}.
7054     *
7055     * @return Returns a URI encoding URI string describing the entire contents
7056     * of the Intent.
7057     */
7058    public String toUri(int flags) {
7059        StringBuilder uri = new StringBuilder(128);
7060        String scheme = null;
7061        if (mData != null) {
7062            String data = mData.toString();
7063            if ((flags&URI_INTENT_SCHEME) != 0) {
7064                final int N = data.length();
7065                for (int i=0; i<N; i++) {
7066                    char c = data.charAt(i);
7067                    if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7068                            || c == '.' || c == '-') {
7069                        continue;
7070                    }
7071                    if (c == ':' && i > 0) {
7072                        // Valid scheme.
7073                        scheme = data.substring(0, i);
7074                        uri.append("intent:");
7075                        data = data.substring(i+1);
7076                        break;
7077                    }
7078
7079                    // No scheme.
7080                    break;
7081                }
7082            }
7083            uri.append(data);
7084
7085        } else if ((flags&URI_INTENT_SCHEME) != 0) {
7086            uri.append("intent:");
7087        }
7088
7089        uri.append("#Intent;");
7090
7091        toUriInner(uri, scheme, flags);
7092        if (mSelector != null) {
7093            uri.append("SEL;");
7094            // Note that for now we are not going to try to handle the
7095            // data part; not clear how to represent this as a URI, and
7096            // not much utility in it.
7097            mSelector.toUriInner(uri, null, flags);
7098        }
7099
7100        uri.append("end");
7101
7102        return uri.toString();
7103    }
7104
7105    private void toUriInner(StringBuilder uri, String scheme, int flags) {
7106        if (scheme != null) {
7107            uri.append("scheme=").append(scheme).append(';');
7108        }
7109        if (mAction != null) {
7110            uri.append("action=").append(Uri.encode(mAction)).append(';');
7111        }
7112        if (mCategories != null) {
7113            for (int i=0; i<mCategories.size(); i++) {
7114                uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
7115            }
7116        }
7117        if (mType != null) {
7118            uri.append("type=").append(Uri.encode(mType, "/")).append(';');
7119        }
7120        if (mFlags != 0) {
7121            uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7122        }
7123        if (mPackage != null) {
7124            uri.append("package=").append(Uri.encode(mPackage)).append(';');
7125        }
7126        if (mComponent != null) {
7127            uri.append("component=").append(Uri.encode(
7128                    mComponent.flattenToShortString(), "/")).append(';');
7129        }
7130        if (mSourceBounds != null) {
7131            uri.append("sourceBounds=")
7132                    .append(Uri.encode(mSourceBounds.flattenToString()))
7133                    .append(';');
7134        }
7135        if (mExtras != null) {
7136            for (String key : mExtras.keySet()) {
7137                final Object value = mExtras.get(key);
7138                char entryType =
7139                        value instanceof String    ? 'S' :
7140                        value instanceof Boolean   ? 'B' :
7141                        value instanceof Byte      ? 'b' :
7142                        value instanceof Character ? 'c' :
7143                        value instanceof Double    ? 'd' :
7144                        value instanceof Float     ? 'f' :
7145                        value instanceof Integer   ? 'i' :
7146                        value instanceof Long      ? 'l' :
7147                        value instanceof Short     ? 's' :
7148                        '\0';
7149
7150                if (entryType != '\0') {
7151                    uri.append(entryType);
7152                    uri.append('.');
7153                    uri.append(Uri.encode(key));
7154                    uri.append('=');
7155                    uri.append(Uri.encode(value.toString()));
7156                    uri.append(';');
7157                }
7158            }
7159        }
7160    }
7161
7162    public int describeContents() {
7163        return (mExtras != null) ? mExtras.describeContents() : 0;
7164    }
7165
7166    public void writeToParcel(Parcel out, int flags) {
7167        out.writeString(mAction);
7168        Uri.writeToParcel(out, mData);
7169        out.writeString(mType);
7170        out.writeInt(mFlags);
7171        out.writeString(mPackage);
7172        ComponentName.writeToParcel(mComponent, out);
7173
7174        if (mSourceBounds != null) {
7175            out.writeInt(1);
7176            mSourceBounds.writeToParcel(out, flags);
7177        } else {
7178            out.writeInt(0);
7179        }
7180
7181        if (mCategories != null) {
7182            final int N = mCategories.size();
7183            out.writeInt(N);
7184            for (int i=0; i<N; i++) {
7185                out.writeString(mCategories.valueAt(i));
7186            }
7187        } else {
7188            out.writeInt(0);
7189        }
7190
7191        if (mSelector != null) {
7192            out.writeInt(1);
7193            mSelector.writeToParcel(out, flags);
7194        } else {
7195            out.writeInt(0);
7196        }
7197
7198        if (mClipData != null) {
7199            out.writeInt(1);
7200            mClipData.writeToParcel(out, flags);
7201        } else {
7202            out.writeInt(0);
7203        }
7204
7205        out.writeBundle(mExtras);
7206    }
7207
7208    public static final Parcelable.Creator<Intent> CREATOR
7209            = new Parcelable.Creator<Intent>() {
7210        public Intent createFromParcel(Parcel in) {
7211            return new Intent(in);
7212        }
7213        public Intent[] newArray(int size) {
7214            return new Intent[size];
7215        }
7216    };
7217
7218    /** @hide */
7219    protected Intent(Parcel in) {
7220        readFromParcel(in);
7221    }
7222
7223    public void readFromParcel(Parcel in) {
7224        setAction(in.readString());
7225        mData = Uri.CREATOR.createFromParcel(in);
7226        mType = in.readString();
7227        mFlags = in.readInt();
7228        mPackage = in.readString();
7229        mComponent = ComponentName.readFromParcel(in);
7230
7231        if (in.readInt() != 0) {
7232            mSourceBounds = Rect.CREATOR.createFromParcel(in);
7233        }
7234
7235        int N = in.readInt();
7236        if (N > 0) {
7237            mCategories = new ArraySet<String>();
7238            int i;
7239            for (i=0; i<N; i++) {
7240                mCategories.add(in.readString().intern());
7241            }
7242        } else {
7243            mCategories = null;
7244        }
7245
7246        if (in.readInt() != 0) {
7247            mSelector = new Intent(in);
7248        }
7249
7250        if (in.readInt() != 0) {
7251            mClipData = new ClipData(in);
7252        }
7253
7254        mExtras = in.readBundle();
7255    }
7256
7257    /**
7258     * Parses the "intent" element (and its children) from XML and instantiates
7259     * an Intent object.  The given XML parser should be located at the tag
7260     * where parsing should start (often named "intent"), from which the
7261     * basic action, data, type, and package and class name will be
7262     * retrieved.  The function will then parse in to any child elements,
7263     * looking for <category android:name="xxx"> tags to add categories and
7264     * <extra android:name="xxx" android:value="yyy"> to attach extra data
7265     * to the intent.
7266     *
7267     * @param resources The Resources to use when inflating resources.
7268     * @param parser The XML parser pointing at an "intent" tag.
7269     * @param attrs The AttributeSet interface for retrieving extended
7270     * attribute data at the current <var>parser</var> location.
7271     * @return An Intent object matching the XML data.
7272     * @throws XmlPullParserException If there was an XML parsing error.
7273     * @throws IOException If there was an I/O error.
7274     */
7275    public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7276            throws XmlPullParserException, IOException {
7277        Intent intent = new Intent();
7278
7279        TypedArray sa = resources.obtainAttributes(attrs,
7280                com.android.internal.R.styleable.Intent);
7281
7282        intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7283
7284        String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7285        String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7286        intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7287
7288        String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7289        String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7290        if (packageName != null && className != null) {
7291            intent.setComponent(new ComponentName(packageName, className));
7292        }
7293
7294        sa.recycle();
7295
7296        int outerDepth = parser.getDepth();
7297        int type;
7298        while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7299               && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7300            if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7301                continue;
7302            }
7303
7304            String nodeName = parser.getName();
7305            if (nodeName.equals(TAG_CATEGORIES)) {
7306                sa = resources.obtainAttributes(attrs,
7307                        com.android.internal.R.styleable.IntentCategory);
7308                String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7309                sa.recycle();
7310
7311                if (cat != null) {
7312                    intent.addCategory(cat);
7313                }
7314                XmlUtils.skipCurrentTag(parser);
7315
7316            } else if (nodeName.equals(TAG_EXTRA)) {
7317                if (intent.mExtras == null) {
7318                    intent.mExtras = new Bundle();
7319                }
7320                resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
7321                XmlUtils.skipCurrentTag(parser);
7322
7323            } else {
7324                XmlUtils.skipCurrentTag(parser);
7325            }
7326        }
7327
7328        return intent;
7329    }
7330
7331    /** @hide */
7332    public void saveToXml(XmlSerializer out) throws IOException {
7333        if (mAction != null) {
7334            out.attribute(null, ATTR_ACTION, mAction);
7335        }
7336        if (mData != null) {
7337            out.attribute(null, ATTR_DATA, mData.toString());
7338        }
7339        if (mType != null) {
7340            out.attribute(null, ATTR_TYPE, mType);
7341        }
7342        if (mComponent != null) {
7343            out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7344        }
7345        out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7346
7347        if (mCategories != null) {
7348            out.startTag(null, TAG_CATEGORIES);
7349            for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7350                out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7351            }
7352            out.endTag(null, TAG_CATEGORIES);
7353        }
7354    }
7355
7356    /** @hide */
7357    public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7358            XmlPullParserException {
7359        Intent intent = new Intent();
7360        final int outerDepth = in.getDepth();
7361
7362        int attrCount = in.getAttributeCount();
7363        for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7364            final String attrName = in.getAttributeName(attrNdx);
7365            final String attrValue = in.getAttributeValue(attrNdx);
7366            if (ATTR_ACTION.equals(attrName)) {
7367                intent.setAction(attrValue);
7368            } else if (ATTR_DATA.equals(attrName)) {
7369                intent.setData(Uri.parse(attrValue));
7370            } else if (ATTR_TYPE.equals(attrName)) {
7371                intent.setType(attrValue);
7372            } else if (ATTR_COMPONENT.equals(attrName)) {
7373                intent.setComponent(ComponentName.unflattenFromString(attrValue));
7374            } else if (ATTR_FLAGS.equals(attrName)) {
7375                intent.setFlags(Integer.valueOf(attrValue, 16));
7376            } else {
7377                Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7378            }
7379        }
7380
7381        int event;
7382        String name;
7383        while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7384                (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7385            if (event == XmlPullParser.START_TAG) {
7386                name = in.getName();
7387                if (TAG_CATEGORIES.equals(name)) {
7388                    attrCount = in.getAttributeCount();
7389                    for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7390                        intent.addCategory(in.getAttributeValue(attrNdx));
7391                    }
7392                } else {
7393                    Log.w("Intent", "restoreFromXml: unknown name=" + name);
7394                    XmlUtils.skipCurrentTag(in);
7395                }
7396            }
7397        }
7398
7399        return intent;
7400    }
7401
7402    /**
7403     * Normalize a MIME data type.
7404     *
7405     * <p>A normalized MIME type has white-space trimmed,
7406     * content-type parameters removed, and is lower-case.
7407     * This aligns the type with Android best practices for
7408     * intent filtering.
7409     *
7410     * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7411     * "text/x-vCard" becomes "text/x-vcard".
7412     *
7413     * <p>All MIME types received from outside Android (such as user input,
7414     * or external sources like Bluetooth, NFC, or the Internet) should
7415     * be normalized before they are used to create an Intent.
7416     *
7417     * @param type MIME data type to normalize
7418     * @return normalized MIME data type, or null if the input was null
7419     * @see #setType
7420     * @see #setTypeAndNormalize
7421     */
7422    public static String normalizeMimeType(String type) {
7423        if (type == null) {
7424            return null;
7425        }
7426
7427        type = type.trim().toLowerCase(Locale.ROOT);
7428
7429        final int semicolonIndex = type.indexOf(';');
7430        if (semicolonIndex != -1) {
7431            type = type.substring(0, semicolonIndex);
7432        }
7433        return type;
7434    }
7435
7436    /**
7437     * Prepare this {@link Intent} to leave an app process.
7438     *
7439     * @hide
7440     */
7441    public void prepareToLeaveProcess() {
7442        setAllowFds(false);
7443
7444        if (mSelector != null) {
7445            mSelector.prepareToLeaveProcess();
7446        }
7447        if (mClipData != null) {
7448            mClipData.prepareToLeaveProcess();
7449        }
7450
7451        if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7452            // There are several ACTION_MEDIA_* broadcasts that send file://
7453            // Uris, so only check common actions.
7454            if (ACTION_VIEW.equals(mAction) ||
7455                    ACTION_EDIT.equals(mAction) ||
7456                    ACTION_ATTACH_DATA.equals(mAction)) {
7457                mData.checkFileUriExposed("Intent.getData()");
7458            }
7459        }
7460    }
7461
7462    /**
7463     * Prepare this {@link Intent} to be sent to another user
7464     *
7465     * @hide
7466     */
7467    public void prepareToLeaveUser(int userId) {
7468        Uri data = getData();
7469        if (data != null) {
7470            mData = maybeAddUserId(data, userId);
7471        }
7472        if (mSelector != null) {
7473            mSelector.prepareToLeaveUser(userId);
7474        }
7475        if (mClipData != null) {
7476            mClipData.prepareToLeaveUser(userId);
7477        }
7478        String action = getAction();
7479        if (ACTION_SEND.equals(action)) {
7480            final Uri stream = getParcelableExtra(EXTRA_STREAM);
7481            if (stream != null) {
7482                putExtra(EXTRA_STREAM, maybeAddUserId(stream, userId));
7483            }
7484        }
7485        if (ACTION_SEND_MULTIPLE.equals(action)) {
7486            final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7487            if (streams != null) {
7488                ArrayList<Uri> newStreams = new ArrayList<Uri>();
7489                for (int i = 0; i < streams.size(); i++) {
7490                    newStreams.add(maybeAddUserId(streams.get(i), userId));
7491                }
7492                putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7493            }
7494        }
7495    }
7496
7497    /**
7498     * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
7499     * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7500     * intents in {@link #ACTION_CHOOSER}.
7501     *
7502     * @return Whether any contents were migrated.
7503     * @hide
7504     */
7505    public boolean migrateExtraStreamToClipData() {
7506        // Refuse to touch if extras already parcelled
7507        if (mExtras != null && mExtras.isParcelled()) return false;
7508
7509        // Bail when someone already gave us ClipData
7510        if (getClipData() != null) return false;
7511
7512        final String action = getAction();
7513        if (ACTION_CHOOSER.equals(action)) {
7514            try {
7515                // Inspect target intent to see if we need to migrate
7516                final Intent target = getParcelableExtra(EXTRA_INTENT);
7517                if (target != null && target.migrateExtraStreamToClipData()) {
7518                    // Since we migrated in child, we need to promote ClipData
7519                    // and flags to ourselves to grant.
7520                    setClipData(target.getClipData());
7521                    addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7522                            | FLAG_GRANT_WRITE_URI_PERMISSION
7523                            | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7524                            | FLAG_GRANT_PREFIX_URI_PERMISSION));
7525                    return true;
7526                } else {
7527                    return false;
7528                }
7529            } catch (ClassCastException e) {
7530            }
7531
7532        } else if (ACTION_SEND.equals(action)) {
7533            try {
7534                final Uri stream = getParcelableExtra(EXTRA_STREAM);
7535                final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7536                final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7537                if (stream != null || text != null || htmlText != null) {
7538                    final ClipData clipData = new ClipData(
7539                            null, new String[] { getType() },
7540                            new ClipData.Item(text, htmlText, null, stream));
7541                    setClipData(clipData);
7542                    addFlags(FLAG_GRANT_READ_URI_PERMISSION);
7543                    return true;
7544                }
7545            } catch (ClassCastException e) {
7546            }
7547
7548        } else if (ACTION_SEND_MULTIPLE.equals(action)) {
7549            try {
7550                final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7551                final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7552                final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7553                int num = -1;
7554                if (streams != null) {
7555                    num = streams.size();
7556                }
7557                if (texts != null) {
7558                    if (num >= 0 && num != texts.size()) {
7559                        // Wha...!  F- you.
7560                        return false;
7561                    }
7562                    num = texts.size();
7563                }
7564                if (htmlTexts != null) {
7565                    if (num >= 0 && num != htmlTexts.size()) {
7566                        // Wha...!  F- you.
7567                        return false;
7568                    }
7569                    num = htmlTexts.size();
7570                }
7571                if (num > 0) {
7572                    final ClipData clipData = new ClipData(
7573                            null, new String[] { getType() },
7574                            makeClipItem(streams, texts, htmlTexts, 0));
7575
7576                    for (int i = 1; i < num; i++) {
7577                        clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7578                    }
7579
7580                    setClipData(clipData);
7581                    addFlags(FLAG_GRANT_READ_URI_PERMISSION);
7582                    return true;
7583                }
7584            } catch (ClassCastException e) {
7585            }
7586        }
7587
7588        return false;
7589    }
7590
7591    private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7592            ArrayList<String> htmlTexts, int which) {
7593        Uri uri = streams != null ? streams.get(which) : null;
7594        CharSequence text = texts != null ? texts.get(which) : null;
7595        String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7596        return new ClipData.Item(text, htmlText, null, uri);
7597    }
7598
7599    /** @hide */
7600    public boolean isDocument() {
7601        return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7602    }
7603}
7604