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