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