blob: c514df754cef7bc4bf1d73fab13ce70fa9cd349f [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
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 org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
29import android.net.Uri;
30import android.os.Bundle;
31import android.os.IBinder;
32import android.os.Parcel;
33import android.os.Parcelable;
34import android.util.AttributeSet;
35import android.util.Log;
36import com.android.internal.util.XmlUtils;
37
38import java.io.IOException;
39import java.io.Serializable;
40import java.net.URISyntaxException;
41import java.util.ArrayList;
42import java.util.HashSet;
43import java.util.Iterator;
44import java.util.Set;
45
46/**
47 * An intent is an abstract description of an operation to be performed. It
48 * can be used with {@link Context#startActivity(Intent) startActivity} to
49 * launch an {@link android.app.Activity},
50 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
51 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
52 * and {@link android.content.Context#startService} or
53 * {@link android.content.Context#bindService} to communicate with a
54 * background {@link android.app.Service}.
55 *
56 * <p>An Intent provides a facility for performing late runtime binding between
57 * the code in different applications. Its most significant use is in the
58 * launching of activities, where it can be thought of as the glue between
59 * activities. It is
60 * basically a passive data structure holding an abstract description of an
61 * action to be performed. The primary pieces of information in an intent
62 * are:</p>
63 *
64 * <ul>
65 * <li> <p><b>action</b> -- The general action to be performed, such as
66 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
67 * etc.</p>
68 * </li>
69 * <li> <p><b>data</b> -- The data to operate on, such as a person record
70 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
71 * </li>
72 * </ul>
73 *
74 *
75 * <p>Some examples of action/data pairs are:</p>
76 *
77 * <ul>
78 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/1</i></b> -- Display
79 * information about the person whose identifier is "1".</p>
80 * </li>
81 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/1</i></b> -- Display
82 * the phone dialer with the person filled in.</p>
83 * </li>
84 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
85 * the phone dialer with the given number filled in. Note how the
86 * VIEW action does what what is considered the most reasonable thing for
87 * a particular URI.</p>
88 * </li>
89 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
90 * the phone dialer with the given number filled in.</p>
91 * </li>
92 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/1</i></b> -- Edit
93 * information about the person whose identifier is "1".</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/</i></b> -- Display
96 * a list of people, which the user can browse through. This example is a
97 * typical top-level entry into the Contacts application, showing you the
98 * list of people. Selecting a particular person to view would result in a
99 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
100 * being used to start an activity to display that person.</p>
101 * </li>
102 * </ul>
103 *
104 * <p>In addition to these primary attributes, there are a number of secondary
105 * attributes that you can also include with an intent:</p>
106 *
107 * <ul>
108 * <li> <p><b>category</b> -- Gives additional information about the action
109 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
110 * appear in the Launcher as a top-level application, while
111 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
112 * of alternative actions the user can perform on a piece of data.</p>
113 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
114 * intent data. Normally the type is inferred from the data itself.
115 * By setting this attribute, you disable that evaluation and force
116 * an explicit type.</p>
117 * <li> <p><b>component</b> -- Specifies an explicit name of a component
118 * class to use for the intent. Normally this is determined by looking
119 * at the other information in the intent (the action, data/type, and
120 * categories) and matching that with a component that can handle it.
121 * If this attribute is set then none of the evaluation is performed,
122 * and this component is used exactly as is. By specifying this attribute,
123 * all of the other Intent attributes become optional.</p>
124 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
125 * This can be used to provide extended information to the component.
126 * For example, if we have a action to send an e-mail message, we could
127 * also include extra pieces of data here to supply a subject, body,
128 * etc.</p>
129 * </ul>
130 *
131 * <p>Here are some examples of other operations you can specify as intents
132 * using these additional parameters:</p>
133 *
134 * <ul>
135 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
136 * Launch the home screen.</p>
137 * </li>
138 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
139 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
140 * vnd.android.cursor.item/phone}</i></b>
141 * -- Display the list of people's phone numbers, allowing the user to
142 * browse through them and pick one and return it to the parent activity.</p>
143 * </li>
144 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
145 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
146 * -- Display all pickers for data that can be opened with
147 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
148 * allowing the user to pick one of them and then some data inside of it
149 * and returning the resulting URI to the caller. This can be used,
150 * for example, in an e-mail application to allow the user to pick some
151 * data to include as an attachment.</p>
152 * </li>
153 * </ul>
154 *
155 * <p>There are a variety of standard Intent action and category constants
156 * defined in the Intent class, but applications can also define their own.
157 * These strings use java style scoping, to ensure they are unique -- for
158 * example, the standard {@link #ACTION_VIEW} is called
159 * "android.app.action.VIEW".</p>
160 *
161 * <p>Put together, the set of actions, data types, categories, and extra data
162 * defines a language for the system allowing for the expression of phrases
163 * such as "call john smith's cell". As applications are added to the system,
164 * they can extend this language by adding new actions, types, and categories, or
165 * they can modify the behavior of existing phrases by supplying their own
166 * activities that handle them.</p>
167 *
168 * <a name="IntentResolution"></a>
169 * <h3>Intent Resolution</h3>
170 *
171 * <p>There are two primary forms of intents you will use.
172 *
173 * <ul>
174 * <li> <p><b>Explicit Intents</b> have specified a component (via
175 * {@link #setComponent} or {@link #setClass}), which provides the exact
176 * class to be run. Often these will not include any other information,
177 * simply being a way for an application to launch various internal
178 * activities it has as the user interacts with the application.
179 *
180 * <li> <p><b>Implicit Intents</b> have not specified a component;
181 * instead, they must include enough information for the system to
182 * determine which of the available components is best to run for that
183 * intent.
184 * </ul>
185 *
186 * <p>When using implicit intents, given such an arbitrary intent we need to
187 * know what to do with it. This is handled by the process of <em>Intent
188 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
189 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
190 * more activities/receivers) that can handle it.</p>
191 *
192 * <p>The intent resolution mechanism basically revolves around matching an
193 * Intent against all of the &lt;intent-filter&gt; descriptions in the
194 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
195 * objects explicitly registered with {@link Context#registerReceiver}.) More
196 * details on this can be found in the documentation on the {@link
197 * IntentFilter} class.</p>
198 *
199 * <p>There are three pieces of information in the Intent that are used for
200 * resolution: the action, type, and category. Using this information, a query
201 * is done on the {@link PackageManager} for a component that can handle the
202 * intent. The appropriate component is determined based on the intent
203 * information supplied in the <code>AndroidManifest.xml</code> file as
204 * follows:</p>
205 *
206 * <ul>
207 * <li> <p>The <b>action</b>, if given, must be listed by the component as
208 * one it handles.</p>
209 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
210 * already supplied in the Intent. Like the action, if a type is
211 * included in the intent (either explicitly or implicitly in its
212 * data), then this must be listed by the component as one it handles.</p>
213 * <li> For data that is not a <code>content:</code> URI and where no explicit
214 * type is included in the Intent, instead the <b>scheme</b> of the
215 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
216 * considered. Again like the action, if we are matching a scheme it
217 * must be listed by the component as one it can handle.
218 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
219 * by the activity as categories it handles. That is, if you include
220 * the categories {@link #CATEGORY_LAUNCHER} and
221 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
222 * with an intent that lists <em>both</em> of those categories.
223 * Activities will very often need to support the
224 * {@link #CATEGORY_DEFAULT} so that they can be found by
225 * {@link Context#startActivity Context.startActivity()}.</p>
226 * </ul>
227 *
228 * <p>For example, consider the Note Pad sample application that
229 * allows user to browse through a list of notes data and view details about
230 * individual items. Text in italics indicate places were you would replace a
231 * name with one specific to your own package.</p>
232 *
233 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
234 * package="<i>com.android.notepad</i>"&gt;
235 * &lt;application android:icon="@drawable/app_notes"
236 * android:label="@string/app_name"&gt;
237 *
238 * &lt;provider class=".NotePadProvider"
239 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
240 *
241 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
242 * &lt;intent-filter&gt;
243 * &lt;action android:value="android.intent.action.MAIN" /&gt;
244 * &lt;category android:value="android.intent.category.LAUNCHER" /&gt;
245 * &lt;/intent-filter&gt;
246 * &lt;intent-filter&gt;
247 * &lt;action android:value="android.intent.action.VIEW" /&gt;
248 * &lt;action android:value="android.intent.action.EDIT" /&gt;
249 * &lt;action android:value="android.intent.action.PICK" /&gt;
250 * &lt;category android:value="android.intent.category.DEFAULT" /&gt;
251 * &lt;type android:value="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
252 * &lt;/intent-filter&gt;
253 * &lt;intent-filter&gt;
254 * &lt;action android:value="android.intent.action.GET_CONTENT" /&gt;
255 * &lt;category android:value="android.intent.category.DEFAULT" /&gt;
256 * &lt;type android:value="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
257 * &lt;/intent-filter&gt;
258 * &lt;/activity&gt;
259 *
260 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
261 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
262 * &lt;action android:value="android.intent.action.VIEW" /&gt;
263 * &lt;action android:value="android.intent.action.EDIT" /&gt;
264 * &lt;category android:value="android.intent.category.DEFAULT" /&gt;
265 * &lt;type android:value="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
266 * &lt;/intent-filter&gt;
267 *
268 * &lt;intent-filter&gt;
269 * &lt;action android:value="android.intent.action.INSERT" /&gt;
270 * &lt;category android:value="android.intent.category.DEFAULT" /&gt;
271 * &lt;type android:value="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
272 * &lt;/intent-filter&gt;
273 *
274 * &lt;/activity&gt;
275 *
276 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
277 * android:theme="@android:style/Theme.Dialog"&gt;
278 * &lt;intent-filter android:label="@string/resolve_title"&gt;
279 * &lt;action android:value="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
280 * &lt;category android:value="android.intent.category.DEFAULT" /&gt;
281 * &lt;category android:value="android.intent.category.ALTERNATIVE" /&gt;
282 * &lt;category android:value="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
283 * &lt;type android:value="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
284 * &lt;/intent-filter&gt;
285 * &lt;/activity&gt;
286 *
287 * &lt;/application&gt;
288 * &lt;/manifest&gt;</pre>
289 *
290 * <p>The first activity,
291 * <code>com.android.notepad.NotesList</code>, serves as our main
292 * entry into the app. It can do three things as described by its three intent
293 * templates:
294 * <ol>
295 * <li><pre>
296 * &lt;intent-filter&gt;
297 * &lt;action android:value="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
298 * &lt;category android:value="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
299 * &lt;/intent-filter&gt;</pre>
300 * <p>This provides a top-level entry into the NotePad application: the standard
301 * MAIN action is a main entry point (not requiring any other information in
302 * the Intent), and the LAUNCHER category says that this entry point should be
303 * listed in the application launcher.</p>
304 * <li><pre>
305 * &lt;intent-filter&gt;
306 * &lt;action android:value="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
307 * &lt;action android:value="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
308 * &lt;action android:value="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
309 * &lt;category android:value="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
310 * &lt;type android:value="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
311 * &lt;/intent-filter&gt;</pre>
312 * <p>This declares the things that the activity can do on a directory of
313 * notes. The type being supported is given with the &lt;type&gt; tag, where
314 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
315 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
316 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
317 * The activity allows the user to view or edit the directory of data (via
318 * the VIEW and EDIT actions), or to pick a particular note and return it
319 * to the caller (via the PICK action). Note also the DEFAULT category
320 * supplied here: this is <em>required</em> for the
321 * {@link Context#startActivity Context.startActivity} method to resolve your
322 * activity when its component name is not explicitly specified.</p>
323 * <li><pre>
324 * &lt;intent-filter&gt;
325 * &lt;action android:value="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
326 * &lt;category android:value="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
327 * &lt;type android:value="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
328 * &lt;/intent-filter&gt;</pre>
329 * <p>This filter describes the ability return to the caller a note selected by
330 * the user without needing to know where it came from. The data type
331 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
332 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
333 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
334 * The GET_CONTENT action is similar to the PICK action, where the activity
335 * will return to its caller a piece of data selected by the user. Here,
336 * however, the caller specifies the type of data they desire instead of
337 * the type of data the user will be picking from.</p>
338 * </ol>
339 *
340 * <p>Given these capabilities, the following intents will resolve to the
341 * NotesList activity:</p>
342 *
343 * <ul>
344 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
345 * activities that can be used as top-level entry points into an
346 * application.</p>
347 * <li> <p><b>{ action=android.app.action.MAIN,
348 * category=android.app.category.LAUNCHER }</b> is the actual intent
349 * used by the Launcher to populate its top-level list.</p>
350 * <li> <p><b>{ action=android.app.action.VIEW
351 * data=content://com.google.provider.NotePad/notes }</b>
352 * displays a list of all the notes under
353 * "content://com.google.provider.NotePad/notes", which
354 * the user can browse through and see the details on.</p>
355 * <li> <p><b>{ action=android.app.action.PICK
356 * data=content://com.google.provider.NotePad/notes }</b>
357 * provides a list of the notes under
358 * "content://com.google.provider.NotePad/notes", from which
359 * the user can pick a note whose data URL is returned back to the caller.</p>
360 * <li> <p><b>{ action=android.app.action.GET_CONTENT
361 * type=vnd.android.cursor.item/vnd.google.note }</b>
362 * is similar to the pick action, but allows the caller to specify the
363 * kind of data they want back so that the system can find the appropriate
364 * activity to pick something of that data type.</p>
365 * </ul>
366 *
367 * <p>The second activity,
368 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
369 * note entry and allows them to edit it. It can do two things as described
370 * by its two intent templates:
371 * <ol>
372 * <li><pre>
373 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
374 * &lt;action android:value="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
375 * &lt;action android:value="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
376 * &lt;category android:value="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
377 * &lt;type android:value="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
378 * &lt;/intent-filter&gt;</pre>
379 * <p>The first, primary, purpose of this activity is to let the user interact
380 * with a single note, as decribed by the MIME type
381 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
382 * either VIEW a note or allow the user to EDIT it. Again we support the
383 * DEFAULT category to allow the activity to be launched without explicitly
384 * specifying its component.</p>
385 * <li><pre>
386 * &lt;intent-filter&gt;
387 * &lt;action android:value="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
388 * &lt;category android:value="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;type android:value="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
390 * &lt;/intent-filter&gt;</pre>
391 * <p>The secondary use of this activity is to insert a new note entry into
392 * an existing directory of notes. This is used when the user creates a new
393 * note: the INSERT action is executed on the directory of notes, causing
394 * this activity to run and have the user create the new note data which
395 * it then adds to the content provider.</p>
396 * </ol>
397 *
398 * <p>Given these capabilities, the following intents will resolve to the
399 * NoteEditor activity:</p>
400 *
401 * <ul>
402 * <li> <p><b>{ action=android.app.action.VIEW
403 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
404 * shows the user the content of note <var>{ID}</var>.</p>
405 * <li> <p><b>{ action=android.app.action.EDIT
406 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
407 * allows the user to edit the content of note <var>{ID}</var>.</p>
408 * <li> <p><b>{ action=android.app.action.INSERT
409 * data=content://com.google.provider.NotePad/notes }</b>
410 * creates a new, empty note in the notes list at
411 * "content://com.google.provider.NotePad/notes"
412 * and allows the user to edit it. If they keep their changes, the URI
413 * of the newly created note is returned to the caller.</p>
414 * </ul>
415 *
416 * <p>The last activity,
417 * <code>com.android.notepad.TitleEditor</code>, allows the user to
418 * edit the title of a note. This could be implemented as a class that the
419 * application directly invokes (by explicitly setting its component in
420 * the Intent), but here we show a way you can publish alternative
421 * operations on existing data:</p>
422 *
423 * <pre>
424 * &lt;intent-filter android:label="@string/resolve_title"&gt;
425 * &lt;action android:value="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
426 * &lt;category android:value="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;category android:value="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
428 * &lt;category android:value="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
429 * &lt;type android:value="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
430 * &lt;/intent-filter&gt;</pre>
431 *
432 * <p>In the single intent template here, we
433 * have created our own private action called
434 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
435 * edit the title of a note. It must be invoked on a specific note
436 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
437 * view and edit actions, but here displays and edits the title contained
438 * in the note data.
439 *
440 * <p>In addition to supporting the default category as usual, our title editor
441 * also supports two other standard categories: ALTERNATIVE and
442 * SELECTED_ALTERNATIVE. Implementing
443 * these categories allows others to find the special action it provides
444 * without directly knowing about it, through the
445 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
446 * more often to build dynamic menu items with
447 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
448 * template here was also supply an explicit name for the template
449 * (via <code>android:label="@string/resolve_title"</code>) to better control
450 * what the user sees when presented with this activity as an alternative
451 * action to the data they are viewing.
452 *
453 * <p>Given these capabilities, the following intent will resolve to the
454 * TitleEditor activity:</p>
455 *
456 * <ul>
457 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
458 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
459 * displays and allows the user to edit the title associated
460 * with note <var>{ID}</var>.</p>
461 * </ul>
462 *
463 * <h3>Standard Activity Actions</h3>
464 *
465 * <p>These are the current standard actions that Intent defines for launching
466 * activities (usually through {@link Context#startActivity}. The most
467 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
468 * {@link #ACTION_EDIT}.
469 *
470 * <ul>
471 * <li> {@link #ACTION_MAIN}
472 * <li> {@link #ACTION_VIEW}
473 * <li> {@link #ACTION_ATTACH_DATA}
474 * <li> {@link #ACTION_EDIT}
475 * <li> {@link #ACTION_PICK}
476 * <li> {@link #ACTION_CHOOSER}
477 * <li> {@link #ACTION_GET_CONTENT}
478 * <li> {@link #ACTION_DIAL}
479 * <li> {@link #ACTION_CALL}
480 * <li> {@link #ACTION_SEND}
481 * <li> {@link #ACTION_SENDTO}
482 * <li> {@link #ACTION_ANSWER}
483 * <li> {@link #ACTION_INSERT}
484 * <li> {@link #ACTION_DELETE}
485 * <li> {@link #ACTION_RUN}
486 * <li> {@link #ACTION_SYNC}
487 * <li> {@link #ACTION_PICK_ACTIVITY}
488 * <li> {@link #ACTION_SEARCH}
489 * <li> {@link #ACTION_WEB_SEARCH}
490 * <li> {@link #ACTION_FACTORY_TEST}
491 * </ul>
492 *
493 * <h3>Standard Broadcast Actions</h3>
494 *
495 * <p>These are the current standard actions that Intent defines for receiving
496 * broadcasts (usually through {@link Context#registerReceiver} or a
497 * &lt;receiver&gt; tag in a manifest).
498 *
499 * <ul>
500 * <li> {@link #ACTION_TIME_TICK}
501 * <li> {@link #ACTION_TIME_CHANGED}
502 * <li> {@link #ACTION_TIMEZONE_CHANGED}
503 * <li> {@link #ACTION_BOOT_COMPLETED}
504 * <li> {@link #ACTION_PACKAGE_ADDED}
505 * <li> {@link #ACTION_PACKAGE_CHANGED}
506 * <li> {@link #ACTION_PACKAGE_REMOVED}
507 * <li> {@link #ACTION_PACKAGE_RESTARTED}
508 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
509 * <li> {@link #ACTION_UID_REMOVED}
510 * <li> {@link #ACTION_BATTERY_CHANGED}
511 * </ul>
512 *
513 * <h3>Standard Categories</h3>
514 *
515 * <p>These are the current standard categories that can be used to further
516 * clarify an Intent via {@link #addCategory}.
517 *
518 * <ul>
519 * <li> {@link #CATEGORY_DEFAULT}
520 * <li> {@link #CATEGORY_BROWSABLE}
521 * <li> {@link #CATEGORY_TAB}
522 * <li> {@link #CATEGORY_ALTERNATIVE}
523 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
524 * <li> {@link #CATEGORY_LAUNCHER}
525 * <li> {@link #CATEGORY_INFO}
526 * <li> {@link #CATEGORY_HOME}
527 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800528 * <li> {@link #CATEGORY_TEST}
529 * </ul>
530 *
531 * <h3>Standard Extra Data</h3>
532 *
533 * <p>These are the current standard fields that can be used as extra data via
534 * {@link #putExtra}.
535 *
536 * <ul>
537 * <li> {@link #EXTRA_TEMPLATE}
538 * <li> {@link #EXTRA_INTENT}
539 * <li> {@link #EXTRA_STREAM}
540 * <li> {@link #EXTRA_TEXT}
541 * </ul>
542 *
543 * <h3>Flags</h3>
544 *
545 * <p>These are the possible flags that can be used in the Intent via
546 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
547 * of all possible flags.
548 */
549public class Intent implements Parcelable {
550 // ---------------------------------------------------------------------
551 // ---------------------------------------------------------------------
552 // Standard intent activity actions (see action variable).
553
554 /**
555 * Activity Action: Start as a main entry point, does not expect to
556 * receive data.
557 * <p>Input: nothing
558 * <p>Output: nothing
559 */
560 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
561 public static final String ACTION_MAIN = "android.intent.action.MAIN";
562
563 /**
564 * Activity Action: Display the data to the user. This is the most common
565 * action performed on data -- it is the generic action you can use on
566 * a piece of data to get the most reasonable thing to occur. For example,
567 * when used on a contacts entry it will view the entry; when used on a
568 * mailto: URI it will bring up a compose window filled with the information
569 * supplied by the URI; when used with a tel: URI it will invoke the
570 * dialer.
571 * <p>Input: {@link #getData} is URI from which to retrieve data.
572 * <p>Output: nothing.
573 */
574 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
575 public static final String ACTION_VIEW = "android.intent.action.VIEW";
576
577 /**
578 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
579 * performed on a piece of data.
580 */
581 public static final String ACTION_DEFAULT = ACTION_VIEW;
582
583 /**
584 * Used to indicate that some piece of data should be attached to some other
585 * place. For example, image data could be attached to a contact. It is up
586 * to the recipient to decide where the data should be attached; the intent
587 * does not specify the ultimate destination.
588 * <p>Input: {@link #getData} is URI of data to be attached.
589 * <p>Output: nothing.
590 */
591 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
592 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
593
594 /**
595 * Activity Action: Provide explicit editable access to the given data.
596 * <p>Input: {@link #getData} is URI of data to be edited.
597 * <p>Output: nothing.
598 */
599 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
600 public static final String ACTION_EDIT = "android.intent.action.EDIT";
601
602 /**
603 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
604 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
605 * The extras can contain type specific data to pass through to the editing/creating
606 * activity.
607 * <p>Output: The URI of the item that was picked. This must be a content:
608 * URI so that any receiver can access it.
609 */
610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
611 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
612
613 /**
614 * Activity Action: Pick an item from the data, returning what was selected.
615 * <p>Input: {@link #getData} is URI containing a directory of data
616 * (vnd.android.cursor.dir/*) from which to pick an item.
617 * <p>Output: The URI of the item that was picked.
618 */
619 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
620 public static final String ACTION_PICK = "android.intent.action.PICK";
621
622 /**
623 * Activity Action: Creates a shortcut.
624 * <p>Input: Nothing.</p>
625 * <p>Output: An Intent representing the shortcut. The intent must contain three
626 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
627 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
628 * (value: ShortcutIconResource).</p>
629 *
630 * @see #EXTRA_SHORTCUT_INTENT
631 * @see #EXTRA_SHORTCUT_NAME
632 * @see #EXTRA_SHORTCUT_ICON
633 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
634 * @see android.content.Intent.ShortcutIconResource
635 */
636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
637 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
638
639 /**
640 * The name of the extra used to define the Intent of a shortcut.
641 *
642 * @see #ACTION_CREATE_SHORTCUT
643 */
644 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
645 /**
646 * The name of the extra used to define the name of a shortcut.
647 *
648 * @see #ACTION_CREATE_SHORTCUT
649 */
650 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
651 /**
652 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
653 *
654 * @see #ACTION_CREATE_SHORTCUT
655 */
656 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
657 /**
658 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
659 *
660 * @see #ACTION_CREATE_SHORTCUT
661 * @see android.content.Intent.ShortcutIconResource
662 */
663 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
664 "android.intent.extra.shortcut.ICON_RESOURCE";
665
666 /**
667 * Represents a shortcut/live folder icon resource.
668 *
669 * @see Intent#ACTION_CREATE_SHORTCUT
670 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
671 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
672 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
673 */
674 public static class ShortcutIconResource implements Parcelable {
675 /**
676 * The package name of the application containing the icon.
677 */
678 public String packageName;
679
680 /**
681 * The resource name of the icon, including package, name and type.
682 */
683 public String resourceName;
684
685 /**
686 * Creates a new ShortcutIconResource for the specified context and resource
687 * identifier.
688 *
689 * @param context The context of the application.
690 * @param resourceId The resource idenfitier for the icon.
691 * @return A new ShortcutIconResource with the specified's context package name
692 * and icon resource idenfitier.
693 */
694 public static ShortcutIconResource fromContext(Context context, int resourceId) {
695 ShortcutIconResource icon = new ShortcutIconResource();
696 icon.packageName = context.getPackageName();
697 icon.resourceName = context.getResources().getResourceName(resourceId);
698 return icon;
699 }
700
701 /**
702 * Used to read a ShortcutIconResource from a Parcel.
703 */
704 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
705 new Parcelable.Creator<ShortcutIconResource>() {
706
707 public ShortcutIconResource createFromParcel(Parcel source) {
708 ShortcutIconResource icon = new ShortcutIconResource();
709 icon.packageName = source.readString();
710 icon.resourceName = source.readString();
711 return icon;
712 }
713
714 public ShortcutIconResource[] newArray(int size) {
715 return new ShortcutIconResource[size];
716 }
717 };
718
719 /**
720 * No special parcel contents.
721 */
722 public int describeContents() {
723 return 0;
724 }
725
726 public void writeToParcel(Parcel dest, int flags) {
727 dest.writeString(packageName);
728 dest.writeString(resourceName);
729 }
730
731 @Override
732 public String toString() {
733 return resourceName;
734 }
735 }
736
737 /**
738 * Activity Action: Display an activity chooser, allowing the user to pick
739 * what they want to before proceeding. This can be used as an alternative
740 * to the standard activity picker that is displayed by the system when
741 * you try to start an activity with multiple possible matches, with these
742 * differences in behavior:
743 * <ul>
744 * <li>You can specify the title that will appear in the activity chooser.
745 * <li>The user does not have the option to make one of the matching
746 * activities a preferred activity, and all possible activities will
747 * always be shown even if one of them is currently marked as the
748 * preferred activity.
749 * </ul>
750 * <p>
751 * This action should be used when the user will naturally expect to
752 * select an activity in order to proceed. An example if when not to use
753 * it is when the user clicks on a "mailto:" link. They would naturally
754 * expect to go directly to their mail app, so startActivity() should be
755 * called directly: it will
756 * either launch the current preferred app, or put up a dialog allowing the
757 * user to pick an app to use and optionally marking that as preferred.
758 * <p>
759 * In contrast, if the user is selecting a menu item to send a picture
760 * they are viewing to someone else, there are many different things they
761 * may want to do at this point: send it through e-mail, upload it to a
762 * web service, etc. In this case the CHOOSER action should be used, to
763 * always present to the user a list of the things they can do, with a
764 * nice title given by the caller such as "Send this photo with:".
765 * <p>
766 * As a convenience, an Intent of this form can be created with the
767 * {@link #createChooser} function.
768 * <p>Input: No data should be specified. get*Extra must have
769 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
770 * and can optionally have a {@link #EXTRA_TITLE} field containing the
771 * title text to display in the chooser.
772 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
773 */
774 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
775 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
776
777 /**
778 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
779 *
780 * @param target The Intent that the user will be selecting an activity
781 * to perform.
782 * @param title Optional title that will be displayed in the chooser.
783 * @return Return a new Intent object that you can hand to
784 * {@link Context#startActivity(Intent) Context.startActivity()} and
785 * related methods.
786 */
787 public static Intent createChooser(Intent target, CharSequence title) {
788 Intent intent = new Intent(ACTION_CHOOSER);
789 intent.putExtra(EXTRA_INTENT, target);
790 if (title != null) {
791 intent.putExtra(EXTRA_TITLE, title);
792 }
793 return intent;
794 }
795 /**
796 * Activity Action: Allow the user to select a particular kind of data and
797 * return it. This is different than {@link #ACTION_PICK} in that here we
798 * just say what kind of data is desired, not a URI of existing data from
799 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
800 * create the data as it runs (for example taking a picture or recording a
801 * sound), let them browser over the web and download the desired data,
802 * etc.
803 * <p>
804 * There are two main ways to use this action: if you want an specific kind
805 * of data, such as a person contact, you set the MIME type to the kind of
806 * data you want and launch it with {@link Context#startActivity(Intent)}.
807 * The system will then launch the best application to select that kind
808 * of data for you.
809 * <p>
810 * You may also be interested in any of a set of types of content the user
811 * can pick. For example, an e-mail application that wants to allow the
812 * user to add an attachment to an e-mail message can use this action to
813 * bring up a list of all of the types of content the user can attach.
814 * <p>
815 * In this case, you should wrap the GET_CONTENT intent with a chooser
816 * (through {@link #createChooser}), which will give the proper interface
817 * for the user to pick how to send your data and allow you to specify
818 * a prompt indicating what they are doing. You will usually specify a
819 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
820 * broad range of content types the user can select from.
821 * <p>
822 * When using such a broad GET_CONTENT action, it is often desireable to
823 * only pick from data that can be represented as a stream. This is
824 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
825 * <p>
826 * Input: {@link #getType} is the desired MIME type to retrieve. Note
827 * that no URI is supplied in the intent, as there are no constraints on
828 * where the returned data originally comes from. You may also include the
829 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
830 * opened as a stream.
831 * <p>
832 * Output: The URI of the item that was picked. This must be a content:
833 * URI so that any receiver can access it.
834 */
835 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
836 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
837 /**
838 * Activity Action: Dial a number as specified by the data. This shows a
839 * UI with the number being dialed, allowing the user to explicitly
840 * initiate the call.
841 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
842 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
843 * number.
844 * <p>Output: nothing.
845 */
846 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
847 public static final String ACTION_DIAL = "android.intent.action.DIAL";
848 /**
849 * Activity Action: Perform a call to someone specified by the data.
850 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
851 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
852 * number.
853 * <p>Output: nothing.
854 *
855 * <p>Note: there will be restrictions on which applications can initiate a
856 * call; most applications should use the {@link #ACTION_DIAL}.
857 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
858 * numbers. Applications can <strong>dial</strong> emergency numbers using
859 * {@link #ACTION_DIAL}, however.
860 */
861 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
862 public static final String ACTION_CALL = "android.intent.action.CALL";
863 /**
864 * Activity Action: Perform a call to an emergency number specified by the
865 * data.
866 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
867 * tel: URI of an explicit phone number.
868 * <p>Output: nothing.
869 * @hide
870 */
871 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
872 /**
873 * Activity action: Perform a call to any number (emergency or not)
874 * specified by the data.
875 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
876 * tel: URI of an explicit phone number.
877 * <p>Output: nothing.
878 * @hide
879 */
880 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
881 /**
882 * Activity Action: Send a message to someone specified by the data.
883 * <p>Input: {@link #getData} is URI describing the target.
884 * <p>Output: nothing.
885 */
886 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
887 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
888 /**
889 * Activity Action: Deliver some data to someone else. Who the data is
890 * being delivered to is not specified; it is up to the receiver of this
891 * action to ask the user where the data should be sent.
892 * <p>
893 * When launching a SEND intent, you should usually wrap it in a chooser
894 * (through {@link #createChooser}), which will give the proper interface
895 * for the user to pick how to send your data and allow you to specify
896 * a prompt indicating what they are doing.
897 * <p>
898 * Input: {@link #getType} is the MIME type of the data being sent.
899 * get*Extra can have either a {@link #EXTRA_TEXT}
900 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
901 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
902 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
903 * if the MIME type is unknown (this will only allow senders that can
904 * handle generic data streams).
905 * <p>
906 * Optional standard extras, which may be interpreted by some recipients as
907 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
908 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
909 * <p>
910 * Output: nothing.
911 */
912 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
913 public static final String ACTION_SEND = "android.intent.action.SEND";
914 /**
915 * Activity Action: Handle an incoming phone call.
916 * <p>Input: nothing.
917 * <p>Output: nothing.
918 */
919 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
920 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
921 /**
922 * Activity Action: Insert an empty item into the given container.
923 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
924 * in which to place the data.
925 * <p>Output: URI of the new data that was created.
926 */
927 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
928 public static final String ACTION_INSERT = "android.intent.action.INSERT";
929 /**
930 * Activity Action: Delete the given data from its container.
931 * <p>Input: {@link #getData} is URI of data to be deleted.
932 * <p>Output: nothing.
933 */
934 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
935 public static final String ACTION_DELETE = "android.intent.action.DELETE";
936 /**
937 * Activity Action: Run the data, whatever that means.
938 * <p>Input: ? (Note: this is currently specific to the test harness.)
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_RUN = "android.intent.action.RUN";
943 /**
944 * Activity Action: Perform a data synchronization.
945 * <p>Input: ?
946 * <p>Output: ?
947 */
948 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
949 public static final String ACTION_SYNC = "android.intent.action.SYNC";
950 /**
951 * Activity Action: Pick an activity given an intent, returning the class
952 * selected.
953 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
954 * used with {@link PackageManager#queryIntentActivities} to determine the
955 * set of activities from which to pick.
956 * <p>Output: Class name of the activity that was selected.
957 */
958 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
959 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
960 /**
961 * Activity Action: Perform a search.
962 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
963 * is the text to search for. If empty, simply
964 * enter your search results Activity with the search UI activated.
965 * <p>Output: nothing.
966 */
967 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
968 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
969 /**
970 * Activity Action: Perform a web search.
971 * <p>
972 * Input: {@link android.app.SearchManager#QUERY
973 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
974 * a url starts with http or https, the site will be opened. If it is plain
975 * text, Google search will be applied.
976 * <p>
977 * Output: nothing.
978 */
979 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
980 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
981 /**
982 * Activity Action: List all available applications
983 * <p>Input: Nothing.
984 * <p>Output: nothing.
985 */
986 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
987 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
988 /**
989 * Activity Action: Show settings for choosing wallpaper
990 * <p>Input: Nothing.
991 * <p>Output: Nothing.
992 */
993 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
994 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
995
996 /**
997 * Activity Action: Show activity for reporting a bug.
998 * <p>Input: Nothing.
999 * <p>Output: Nothing.
1000 */
1001 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1002 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1003
1004 /**
1005 * Activity Action: Main entry point for factory tests. Only used when
1006 * the device is booting in factory test node. The implementing package
1007 * must be installed in the system image.
1008 * <p>Input: nothing
1009 * <p>Output: nothing
1010 */
1011 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1012
1013 /**
1014 * Activity Action: The user pressed the "call" button to go to the dialer
1015 * or other appropriate UI for placing a call.
1016 * <p>Input: Nothing.
1017 * <p>Output: Nothing.
1018 */
1019 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1020 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1021
1022 /**
1023 * Activity Action: Start Voice Command.
1024 * <p>Input: Nothing.
1025 * <p>Output: Nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001029
1030 /**
1031 * Activity Action: Start action associated with long pressing on the
1032 * search key.
1033 * <p>Input: Nothing.
1034 * <p>Output: Nothing.
1035 */
1036 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1037 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001038
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001039 // ---------------------------------------------------------------------
1040 // ---------------------------------------------------------------------
1041 // Standard intent broadcast actions (see action variable).
1042
1043 /**
1044 * Broadcast Action: Sent after the screen turns off.
1045 */
1046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1047 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1048 /**
1049 * Broadcast Action: Sent after the screen turns on.
1050 */
1051 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1052 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001053
1054 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001055 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001056 * keyguard is gone).
1057 */
1058 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1059 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1060
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001061 /**
1062 * Broadcast Action: The current time has changed. Sent every
1063 * minute. You can <em>not</em> receive this through components declared
1064 * in manifests, only by exlicitly registering for it with
1065 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1066 * Context.registerReceiver()}.
1067 */
1068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1069 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1070 /**
1071 * Broadcast Action: The time was set.
1072 */
1073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1074 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1075 /**
1076 * Broadcast Action: The date has changed.
1077 */
1078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1079 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1080 /**
1081 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1082 * <ul>
1083 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1084 * </ul>
1085 */
1086 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1087 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1088 /**
1089 * Alarm Changed Action: This is broadcast when the AlarmClock
1090 * application's alarm is set or unset. It is used by the
1091 * AlarmClock application and the StatusBar service.
1092 * @hide
1093 */
1094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1095 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1096 /**
1097 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1098 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1099 * @hide
1100 */
1101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1102 public static final String ACTION_SYNC_STATE_CHANGED
1103 = "android.intent.action.SYNC_STATE_CHANGED";
1104 /**
1105 * Broadcast Action: This is broadcast once, after the system has finished
1106 * booting. It can be used to perform application-specific initialization,
1107 * such as installing alarms. You must hold the
1108 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1109 * in order to receive this broadcast.
1110 */
1111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1112 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1113 /**
1114 * Broadcast Action: This is broadcast when a user action should request a
1115 * temporary system dialog to dismiss. Some examples of temporary system
1116 * dialogs are the notification window-shade and the recent tasks dialog.
1117 */
1118 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1119 /**
1120 * Broadcast Action: Trigger the download and eventual installation
1121 * of a package.
1122 * <p>Input: {@link #getData} is the URI of the package file to download.
1123 */
1124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1125 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1126 /**
1127 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001128 * device. The data contains the name of the package. Note that the
1129 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001130 * <p>My include the following extras:
1131 * <ul>
1132 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1133 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1134 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1135 * </ul>
1136 */
1137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1138 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1139 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001140 * Broadcast Action: A new version of an application package has been
1141 * installed, replacing an existing version that was previously installed.
1142 * The data contains the name of the package.
1143 * <p>My include the following extras:
1144 * <ul>
1145 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1146 * </ul>
1147 */
1148 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1149 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001151 * Broadcast Action: An existing application package has been removed from
1152 * the device. The data contains the name of the package. The package
1153 * that is being installed does <em>not</em> receive this Intent.
1154 * <ul>
1155 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1156 * to the package.
1157 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1158 * application -- data and code -- is being removed.
1159 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1160 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1161 * </ul>
1162 */
1163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1164 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1165 /**
1166 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1167 * enabled or disabled. The data contains the name of the package.
1168 * <ul>
1169 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1170 * </ul>
1171 */
1172 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1173 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1174 /**
1175 * Broadcast Action: The user has restarted a package, and all of its
1176 * processes have been killed. All runtime state
1177 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001178 * be removed. Note that the restarted package does <em>not</em>
1179 * receive this broadcast.
1180 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001181 * <ul>
1182 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1183 * </ul>
1184 */
1185 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1186 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1187 /**
1188 * Broadcast Action: The user has cleared the data of a package. This should
1189 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001190 * its persistent data is erased and this broadcast sent.
1191 * Note that the cleared package does <em>not</em>
1192 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001193 * <ul>
1194 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1195 * </ul>
1196 */
1197 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1198 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1199 /**
1200 * Broadcast Action: A user ID has been removed from the system. The user
1201 * ID number is stored in the extra data under {@link #EXTRA_UID}.
1202 */
1203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1204 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1205 /**
1206 * Broadcast Action: The current system wallpaper has changed. See
1207 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1208 */
1209 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1210 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1211 /**
1212 * Broadcast Action: The current device {@link android.content.res.Configuration}
1213 * (orientation, locale, etc) has changed. When such a change happens, the
1214 * UIs (view hierarchy) will need to be rebuilt based on this new
1215 * information; for the most part, applications don't need to worry about
1216 * this, because the system will take care of stopping and restarting the
1217 * application to make sure it sees the new changes. Some system code that
1218 * can not be restarted will need to watch for this action and handle it
1219 * appropriately.
1220 *
1221 * @see android.content.res.Configuration
1222 */
1223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1224 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1225 /**
1226 * Broadcast Action: The charging state, or charge level of the battery has
1227 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001228 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001229 * <p class="note">
1230 * You can <em>not</em> receive this through components declared
1231 * in manifests, only by exlicitly registering for it with
1232 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1233 * Context.registerReceiver()}.
1234 */
1235 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1236 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1237 /**
1238 * Broadcast Action: Indicates low battery condition on the device.
1239 * This broadcast corresponds to the "Low battery warning" system dialog.
1240 */
1241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1242 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1243 /**
1244 * Broadcast Action: Indicates low memory condition on the device
1245 */
1246 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1247 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1248 /**
1249 * Broadcast Action: Indicates low memory condition on the device no longer exists
1250 */
1251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1252 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1253 /**
1254 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1255 * and package management should be started.
1256 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1257 * notification.
1258 */
1259 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1260 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1261 /**
1262 * Broadcast Action: The device has entered USB Mass Storage mode.
1263 * This is used mainly for the USB Settings panel.
1264 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1265 * when the SD card file system is mounted or unmounted
1266 */
1267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1268 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1269
1270 /**
1271 * Broadcast Action: The device has exited USB Mass Storage mode.
1272 * This is used mainly for the USB Settings panel.
1273 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1274 * when the SD card file system is mounted or unmounted
1275 */
1276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1277 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1278
1279 /**
1280 * Broadcast Action: External media has been removed.
1281 * The path to the mount point for the removed media is contained in the Intent.mData field.
1282 */
1283 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1284 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1285
1286 /**
1287 * Broadcast Action: External media is present, but not mounted at its mount point.
1288 * The path to the mount point for the removed media is contained in the Intent.mData field.
1289 */
1290 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1291 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1292
1293 /**
1294 * Broadcast Action: External media is present, and being disk-checked
1295 * The path to the mount point for the checking media is contained in the Intent.mData field.
1296 */
1297 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1298 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1299
1300 /**
1301 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1302 * The path to the mount point for the checking media is contained in the Intent.mData field.
1303 */
1304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1305 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1306
1307 /**
1308 * Broadcast Action: External media is present and mounted at its mount point.
1309 * The path to the mount point for the removed media is contained in the Intent.mData field.
1310 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1311 * media was mounted read only.
1312 */
1313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1314 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1315
1316 /**
1317 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1318 * The path to the mount point for the removed media is contained in the Intent.mData field.
1319 */
1320 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1321 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1322
1323 /**
1324 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1325 * The path to the mount point for the removed media is contained in the Intent.mData field.
1326 */
1327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1328 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1329
1330 /**
1331 * Broadcast Action: External media is present but cannot be mounted.
1332 * The path to the mount point for the removed media is contained in the Intent.mData field.
1333 */
1334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1335 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1336
1337 /**
1338 * Broadcast Action: User has expressed the desire to remove the external storage media.
1339 * Applications should close all files they have open within the mount point when they receive this intent.
1340 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1341 */
1342 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1343 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1344
1345 /**
1346 * Broadcast Action: The media scanner has started scanning a directory.
1347 * The path to the directory being scanned is contained in the Intent.mData field.
1348 */
1349 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1350 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1351
1352 /**
1353 * Broadcast Action: The media scanner has finished scanning a directory.
1354 * The path to the scanned directory is contained in the Intent.mData field.
1355 */
1356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1357 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1358
1359 /**
1360 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1361 * The path to the file is contained in the Intent.mData field.
1362 */
1363 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1364 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1365
1366 /**
1367 * Broadcast Action: The "Media Button" was pressed. Includes a single
1368 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1369 * caused the broadcast.
1370 */
1371 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1372 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1373
1374 /**
1375 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1376 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1377 * caused the broadcast.
1378 */
1379 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1380 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1381
1382 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1383 // location; they are not general-purpose actions.
1384
1385 /**
1386 * Broadcast Action: An GTalk connection has been established.
1387 */
1388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1389 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1390 "android.intent.action.GTALK_CONNECTED";
1391
1392 /**
1393 * Broadcast Action: An GTalk connection has been disconnected.
1394 */
1395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1396 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1397 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001398
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001399 /**
1400 * Broadcast Action: An input method has been changed.
1401 * {@hide pending API Council approval}
1402 */
1403 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1404 public static final String ACTION_INPUT_METHOD_CHANGED =
1405 "android.intent.action.INPUT_METHOD_CHANGED";
1406
1407 /**
1408 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1409 * more radios have been turned off or on. The intent will have the following extra value:</p>
1410 * <ul>
1411 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1412 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1413 * turned off</li>
1414 * </ul>
1415 */
1416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1417 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1418
1419 /**
1420 * Broadcast Action: Some content providers have parts of their namespace
1421 * where they publish new events or items that the user may be especially
1422 * interested in. For these things, they may broadcast this action when the
1423 * set of interesting items change.
1424 *
1425 * For example, GmailProvider sends this notification when the set of unread
1426 * mail in the inbox changes.
1427 *
1428 * <p>The data of the intent identifies which part of which provider
1429 * changed. When queried through the content resolver, the data URI will
1430 * return the data set in question.
1431 *
1432 * <p>The intent will have the following extra values:
1433 * <ul>
1434 * <li><em>count</em> - The number of items in the data set. This is the
1435 * same as the number of items in the cursor returned by querying the
1436 * data URI. </li>
1437 * </ul>
1438 *
1439 * This intent will be sent at boot (if the count is non-zero) and when the
1440 * data set changes. It is possible for the data set to change without the
1441 * count changing (for example, if a new unread message arrives in the same
1442 * sync operation in which a message is archived). The phone should still
1443 * ring/vibrate/etc as normal in this case.
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_PROVIDER_CHANGED =
1447 "android.intent.action.PROVIDER_CHANGED";
1448
1449 /**
1450 * Broadcast Action: Wired Headset plugged in or unplugged.
1451 *
1452 * <p>The intent will have the following extra values:
1453 * <ul>
1454 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1455 * <li><em>name</em> - Headset type, human readable string </li>
1456 * </ul>
1457 * </ul>
1458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_HEADSET_PLUG =
1461 "android.intent.action.HEADSET_PLUG";
1462
1463 /**
1464 * Broadcast Action: An outgoing call is about to be placed.
1465 *
1466 * <p>The Intent will have the following extra value:
1467 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001468 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001469 * the phone number originally intended to be dialed.</li>
1470 * </ul>
1471 * <p>Once the broadcast is finished, the resultData is used as the actual
1472 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001473 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001474 * outgoing call in turn: for example, a parental control application
1475 * might verify that the user is authorized to place the call at that
1476 * time, then a number-rewriting application might add an area code if
1477 * one was not specified.</p>
1478 * <p>For consistency, any receiver whose purpose is to prohibit phone
1479 * calls should have a priority of 0, to ensure it will see the final
1480 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001481 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001482 * should have a positive priority.
1483 * Negative priorities are reserved for the system for this broadcast;
1484 * using them may cause problems.</p>
1485 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1486 * abort the broadcast.</p>
1487 * <p>Emergency calls cannot be intercepted using this mechanism, and
1488 * other calls cannot be modified to call emergency numbers using this
1489 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001490 * <p>You must hold the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001491 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1492 * permission to receive this Intent.</p>
1493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_NEW_OUTGOING_CALL =
1496 "android.intent.action.NEW_OUTGOING_CALL";
1497
1498 /**
1499 * Broadcast Action: Have the device reboot. This is only for use by
1500 * system code.
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_REBOOT =
1504 "android.intent.action.REBOOT";
1505
1506 // ---------------------------------------------------------------------
1507 // ---------------------------------------------------------------------
1508 // Standard intent categories (see addCategory()).
1509
1510 /**
1511 * Set if the activity should be an option for the default action
1512 * (center press) to perform on a piece of data. Setting this will
1513 * hide from the user any activities without it set when performing an
1514 * action on some data. Note that this is normal -not- set in the
1515 * Intent when initiating an action -- it is for use in intent filters
1516 * specified in packages.
1517 */
1518 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1519 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1520 /**
1521 * Activities that can be safely invoked from a browser must support this
1522 * category. For example, if the user is viewing a web page or an e-mail
1523 * and clicks on a link in the text, the Intent generated execute that
1524 * link will require the BROWSABLE category, so that only activities
1525 * supporting this category will be considered as possible actions. By
1526 * supporting this category, you are promising that there is nothing
1527 * damaging (without user intervention) that can happen by invoking any
1528 * matching Intent.
1529 */
1530 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1531 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1532 /**
1533 * Set if the activity should be considered as an alternative action to
1534 * the data the user is currently viewing. See also
1535 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1536 * applies to the selection in a list of items.
1537 *
1538 * <p>Supporting this category means that you would like your activity to be
1539 * displayed in the set of alternative things the user can do, usually as
1540 * part of the current activity's options menu. You will usually want to
1541 * include a specific label in the &lt;intent-filter&gt; of this action
1542 * describing to the user what it does.
1543 *
1544 * <p>The action of IntentFilter with this category is important in that it
1545 * describes the specific action the target will perform. This generally
1546 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1547 * a specific name such as "com.android.camera.action.CROP. Only one
1548 * alternative of any particular action will be shown to the user, so using
1549 * a specific action like this makes sure that your alternative will be
1550 * displayed while also allowing other applications to provide their own
1551 * overrides of that particular action.
1552 */
1553 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1554 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1555 /**
1556 * Set if the activity should be considered as an alternative selection
1557 * action to the data the user has currently selected. This is like
1558 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1559 * of items from which the user can select, giving them alternatives to the
1560 * default action that will be performed on it.
1561 */
1562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1563 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1564 /**
1565 * Intended to be used as a tab inside of an containing TabActivity.
1566 */
1567 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1568 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1569 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001570 * Should be displayed in the top-level launcher.
1571 */
1572 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1573 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1574 /**
1575 * Provides information about the package it is in; typically used if
1576 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1577 * a front-door to the user without having to be shown in the all apps list.
1578 */
1579 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1580 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1581 /**
1582 * This is the home activity, that is the first activity that is displayed
1583 * when the device boots.
1584 */
1585 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1586 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1587 /**
1588 * This activity is a preference panel.
1589 */
1590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1591 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1592 /**
1593 * This activity is a development preference panel.
1594 */
1595 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1596 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1597 /**
1598 * Capable of running inside a parent activity container.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001599 */
1600 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1601 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1602 /**
1603 * This activity may be exercised by the monkey or other automated test tools.
1604 */
1605 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1606 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1607 /**
1608 * To be used as a test (not part of the normal user experience).
1609 */
1610 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1611 /**
1612 * To be used as a unit test (run through the Test Harness).
1613 */
1614 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1615 /**
1616 * To be used as an sample code example (not part of the normal user
1617 * experience).
1618 */
1619 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1620 /**
1621 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1622 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1623 * when queried, though it is allowable for those columns to be blank.
1624 */
1625 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1626 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1627
1628 /**
1629 * To be used as code under test for framework instrumentation tests.
1630 */
1631 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1632 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
1633 // ---------------------------------------------------------------------
1634 // ---------------------------------------------------------------------
1635 // Standard extra data keys.
1636
1637 /**
1638 * The initial data to place in a newly created record. Use with
1639 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1640 * fields as would be given to the underlying ContentProvider.insert()
1641 * call.
1642 */
1643 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1644
1645 /**
1646 * A constant CharSequence that is associated with the Intent, used with
1647 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1648 * this may be a styled CharSequence, so you must use
1649 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1650 * retrieve it.
1651 */
1652 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1653
1654 /**
1655 * A content: URI holding a stream of data associated with the Intent,
1656 * used with {@link #ACTION_SEND} to supply the data being sent.
1657 */
1658 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1659
1660 /**
1661 * A String[] holding e-mail addresses that should be delivered to.
1662 */
1663 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1664
1665 /**
1666 * A String[] holding e-mail addresses that should be carbon copied.
1667 */
1668 public static final String EXTRA_CC = "android.intent.extra.CC";
1669
1670 /**
1671 * A String[] holding e-mail addresses that should be blind carbon copied.
1672 */
1673 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1674
1675 /**
1676 * A constant string holding the desired subject line of a message.
1677 */
1678 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1679
1680 /**
1681 * An Intent describing the choices you would like shown with
1682 * {@link #ACTION_PICK_ACTIVITY}.
1683 */
1684 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1685
1686 /**
1687 * A CharSequence dialog title to provide to the user when used with a
1688 * {@link #ACTION_CHOOSER}.
1689 */
1690 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1691
1692 /**
1693 * A {@link android.view.KeyEvent} object containing the event that
1694 * triggered the creation of the Intent it is in.
1695 */
1696 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1697
1698 /**
1699 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1700 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1701 * of restarting the application.
1702 */
1703 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1704
1705 /**
1706 * A String holding the phone number originally entered in
1707 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1708 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1709 */
1710 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1711 /**
1712 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1713 * intents to supply the uid the package had been assigned. Also an optional
1714 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1715 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1716 * purpose.
1717 */
1718 public static final String EXTRA_UID = "android.intent.extra.UID";
1719
1720 /**
1721 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1722 * intents to indicate whether this represents a full uninstall (removing
1723 * both the code and its data) or a partial uninstall (leaving its data,
1724 * implying that this is an update).
1725 */
1726 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001727
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001728 /**
1729 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1730 * intents to indicate that this is a replacement of the package, so this
1731 * broadcast will immediately be followed by an add broadcast for a
1732 * different version of the same package.
1733 */
1734 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001735
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001736 /**
1737 * Used as an int extra field in {@link android.app.AlarmManager} intents
1738 * to tell the application being invoked how many pending alarms are being
1739 * delievered with the intent. For one-shot alarms this will always be 1.
1740 * For recurring alarms, this might be greater than 1 if the device was
1741 * asleep or powered off at the time an earlier alarm would have been
1742 * delivered.
1743 */
1744 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
1745
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001746 // ---------------------------------------------------------------------
1747 // ---------------------------------------------------------------------
1748 // Intent flags (see mFlags variable).
1749
1750 /**
1751 * If set, the recipient of this Intent will be granted permission to
1752 * perform read operations on the Uri in the Intent's data.
1753 */
1754 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
1755 /**
1756 * If set, the recipient of this Intent will be granted permission to
1757 * perform write operations on the Uri in the Intent's data.
1758 */
1759 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
1760 /**
1761 * Can be set by the caller to indicate that this Intent is coming from
1762 * a background operation, not from direct user interaction.
1763 */
1764 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
1765 /**
1766 * A flag you can enable for debugging: when set, log messages will be
1767 * printed during the resolution of this intent to show you what has
1768 * been found to create the final resolved list.
1769 */
1770 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
1771
1772 /**
1773 * If set, the new activity is not kept in the history stack. As soon as
1774 * the user navigates away from it, the activity is finished. This may also
1775 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
1776 * noHistory} attribute.
1777 */
1778 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
1779 /**
1780 * If set, the activity will not be launched if it is already running
1781 * at the top of the history stack.
1782 */
1783 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
1784 /**
1785 * If set, this activity will become the start of a new task on this
1786 * history stack. A task (from the activity that started it to the
1787 * next task activity) defines an atomic group of activities that the
1788 * user can move to. Tasks can be moved to the foreground and background;
1789 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07001790 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001791 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1792 * Activities and Tasks</a> for more details on tasks.
1793 *
1794 * <p>This flag is generally used by activities that want
1795 * to present a "launcher" style behavior: they give the user a list of
1796 * separate things that can be done, which otherwise run completely
1797 * independently of the activity launching them.
1798 *
1799 * <p>When using this flag, if a task is already running for the activity
1800 * you are now starting, then a new activity will not be started; instead,
1801 * the current task will simply be brought to the front of the screen with
1802 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
1803 * to disable this behavior.
1804 *
1805 * <p>This flag can not be used when the caller is requesting a result from
1806 * the activity being launched.
1807 */
1808 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
1809 /**
1810 * <strong>Do not use this flag unless you are implementing your own
1811 * top-level application launcher.</strong> Used in conjunction with
1812 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
1813 * behavior of bringing an existing task to the foreground. When set,
1814 * a new task is <em>always</em> started to host the Activity for the
1815 * Intent, regardless of whether there is already an existing task running
1816 * the same thing.
1817 *
1818 * <p><strong>Because the default system does not include graphical task management,
1819 * you should not use this flag unless you provide some way for a user to
1820 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07001821 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001822 * <p>This flag is ignored if
1823 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
1824 *
1825 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1826 * Activities and Tasks</a> for more details on tasks.
1827 */
1828 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
1829 /**
1830 * If set, and the activity being launched is already running in the
1831 * current task, then instead of launching a new instance of that activity,
1832 * all of the other activities on top of it will be closed and this Intent
1833 * will be delivered to the (now on top) old activity as a new Intent.
1834 *
1835 * <p>For example, consider a task consisting of the activities: A, B, C, D.
1836 * If D calls startActivity() with an Intent that resolves to the component
1837 * of activity B, then C and D will be finished and B receive the given
1838 * Intent, resulting in the stack now being: A, B.
1839 *
1840 * <p>The currently running instance of task B in the above example will
1841 * either receive the new intent you are starting here in its
1842 * onNewIntent() method, or be itself finished and restarted with the
1843 * new intent. If it has declared its launch mode to be "multiple" (the
1844 * default) it will be finished and re-created; for all other launch modes
1845 * it will receive the Intent in the current instance.
1846 *
1847 * <p>This launch mode can also be used to good effect in conjunction with
1848 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
1849 * of a task, it will bring any currently running instance of that task
1850 * to the foreground, and then clear it to its root state. This is
1851 * especially useful, for example, when launching an activity from the
1852 * notification manager.
1853 *
1854 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1855 * Activities and Tasks</a> for more details on tasks.
1856 */
1857 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
1858 /**
1859 * If set and this intent is being used to launch a new activity from an
1860 * existing one, then the reply target of the existing activity will be
1861 * transfered to the new activity. This way the new activity can call
1862 * {@link android.app.Activity#setResult} and have that result sent back to
1863 * the reply target of the original activity.
1864 */
1865 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
1866 /**
1867 * If set and this intent is being used to launch a new activity from an
1868 * existing one, the current activity will not be counted as the top
1869 * activity for deciding whether the new intent should be delivered to
1870 * the top instead of starting a new one. The previous activity will
1871 * be used as the top, with the assumption being that the current activity
1872 * will finish itself immediately.
1873 */
1874 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
1875 /**
1876 * If set, the new activity is not kept in the list of recently launched
1877 * activities.
1878 */
1879 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
1880 /**
1881 * This flag is not normally set by application code, but set for you by
1882 * the system as described in the
1883 * {@link android.R.styleable#AndroidManifestActivity_launchMode
1884 * launchMode} documentation for the singleTask mode.
1885 */
1886 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
1887 /**
1888 * If set, and this activity is either being started in a new task or
1889 * bringing to the top an existing task, then it will be launched as
1890 * the front door of the task. This will result in the application of
1891 * any affinities needed to have that task in the proper state (either
1892 * moving activities to or from it), or simply resetting that task to
1893 * its initial state if needed.
1894 */
1895 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
1896 /**
1897 * This flag is not normally set by application code, but set for you by
1898 * the system if this activity is being launched from history
1899 * (longpress home key).
1900 */
1901 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
1902 /**
1903 * If set, this marks a point in the task's activity stack that should
1904 * be cleared when the task is reset. That is, the next time the task
1905 * is broad to the foreground with
1906 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
1907 * the user re-launching it from home), this activity and all on top of
1908 * it will be finished so that the user does not return to them, but
1909 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07001910 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001911 * <p>This is useful for cases where you have a logical break in your
1912 * application. For example, an e-mail application may have a command
1913 * to view an attachment, which launches an image view activity to
1914 * display it. This activity should be part of the e-mail application's
1915 * task, since it is a part of the task the user is involved in. However,
1916 * if the user leaves that task, and later selects the e-mail app from
1917 * home, we may like them to return to the conversation they were
1918 * viewing, not the picture attachment, since that is confusing. By
1919 * setting this flag when launching the image viewer, that viewer and
1920 * any activities it starts will be removed the next time the user returns
1921 * to mail.
1922 */
1923 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
1924 /**
1925 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
1926 * callback from occurring on the current frontmost activity before it is
1927 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07001928 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001929 * <p>Typically, an activity can rely on that callback to indicate that an
1930 * explicit user action has caused their activity to be moved out of the
1931 * foreground. The callback marks an appropriate point in the activity's
1932 * lifecycle for it to dismiss any notifications that it intends to display
1933 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07001934 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001935 * <p>If an activity is ever started via any non-user-driven events such as
1936 * phone-call receipt or an alarm handler, this flag should be passed to {@link
1937 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07001938 * activity does not think the user has acknowledged its notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001939 */
1940 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
1941 /**
1942 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
1943 * this flag will cause the launched activity to be brought to the front of its
1944 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07001945 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001946 * <p>For example, consider a task consisting of four activities: A, B, C, D.
1947 * If D calls startActivity() with an Intent that resolves to the component
1948 * of activity B, then B will be brought to the front of the history stack,
1949 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07001950 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001951 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07001952 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001953 */
1954 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
1955 /**
1956 * If set, when sending a broadcast only registered receivers will be
1957 * called -- no BroadcastReceiver components will be launched.
1958 */
1959 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
1960 /**
1961 * If set, when sending a broadcast <i>before boot has completed</i> only
1962 * registered receivers will be called -- no BroadcastReceiver components
1963 * will be launched. Sticky intent state will be recorded properly even
1964 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
1965 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07001966 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001967 * <p>This flag is only for use by system sevices as a convenience to
1968 * avoid having to implement a more complex mechanism around detection
1969 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07001970 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001971 * @hide
1972 */
1973 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
1974
1975 // ---------------------------------------------------------------------
1976
1977 private String mAction;
1978 private Uri mData;
1979 private String mType;
1980 private ComponentName mComponent;
1981 private int mFlags;
1982 private HashSet<String> mCategories;
1983 private Bundle mExtras;
1984
1985 // ---------------------------------------------------------------------
1986
1987 /**
1988 * Create an empty intent.
1989 */
1990 public Intent() {
1991 }
1992
1993 /**
1994 * Copy constructor.
1995 */
1996 public Intent(Intent o) {
1997 this.mAction = o.mAction;
1998 this.mData = o.mData;
1999 this.mType = o.mType;
2000 this.mComponent = o.mComponent;
2001 this.mFlags = o.mFlags;
2002 if (o.mCategories != null) {
2003 this.mCategories = new HashSet<String>(o.mCategories);
2004 }
2005 if (o.mExtras != null) {
2006 this.mExtras = new Bundle(o.mExtras);
2007 }
2008 }
2009
2010 @Override
2011 public Object clone() {
2012 return new Intent(this);
2013 }
2014
2015 private Intent(Intent o, boolean all) {
2016 this.mAction = o.mAction;
2017 this.mData = o.mData;
2018 this.mType = o.mType;
2019 this.mComponent = o.mComponent;
2020 if (o.mCategories != null) {
2021 this.mCategories = new HashSet<String>(o.mCategories);
2022 }
2023 }
2024
2025 /**
2026 * Make a clone of only the parts of the Intent that are relevant for
2027 * filter matching: the action, data, type, component, and categories.
2028 */
2029 public Intent cloneFilter() {
2030 return new Intent(this, false);
2031 }
2032
2033 /**
2034 * Create an intent with a given action. All other fields (data, type,
2035 * class) are null. Note that the action <em>must</em> be in a
2036 * namespace because Intents are used globally in the system -- for
2037 * example the system VIEW action is android.intent.action.VIEW; an
2038 * application's custom action would be something like
2039 * com.google.app.myapp.CUSTOM_ACTION.
2040 *
2041 * @param action The Intent action, such as ACTION_VIEW.
2042 */
2043 public Intent(String action) {
2044 mAction = action;
2045 }
2046
2047 /**
2048 * Create an intent with a given action and for a given data url. Note
2049 * that the action <em>must</em> be in a namespace because Intents are
2050 * used globally in the system -- for example the system VIEW action is
2051 * android.intent.action.VIEW; an application's custom action would be
2052 * something like com.google.app.myapp.CUSTOM_ACTION.
2053 *
2054 * @param action The Intent action, such as ACTION_VIEW.
2055 * @param uri The Intent data URI.
2056 */
2057 public Intent(String action, Uri uri) {
2058 mAction = action;
2059 mData = uri;
2060 }
2061
2062 /**
2063 * Create an intent for a specific component. All other fields (action, data,
2064 * type, class) are null, though they can be modified later with explicit
2065 * calls. This provides a convenient way to create an intent that is
2066 * intended to execute a hard-coded class name, rather than relying on the
2067 * system to find an appropriate class for you; see {@link #setComponent}
2068 * for more information on the repercussions of this.
2069 *
2070 * @param packageContext A Context of the application package implementing
2071 * this class.
2072 * @param cls The component class that is to be used for the intent.
2073 *
2074 * @see #setClass
2075 * @see #setComponent
2076 * @see #Intent(String, android.net.Uri , Context, Class)
2077 */
2078 public Intent(Context packageContext, Class<?> cls) {
2079 mComponent = new ComponentName(packageContext, cls);
2080 }
2081
2082 /**
2083 * Create an intent for a specific component with a specified action and data.
2084 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2085 * construct the Intent and then calling {@link #setClass} to set its
2086 * class.
2087 *
2088 * @param action The Intent action, such as ACTION_VIEW.
2089 * @param uri The Intent data URI.
2090 * @param packageContext A Context of the application package implementing
2091 * this class.
2092 * @param cls The component class that is to be used for the intent.
2093 *
2094 * @see #Intent(String, android.net.Uri)
2095 * @see #Intent(Context, Class)
2096 * @see #setClass
2097 * @see #setComponent
2098 */
2099 public Intent(String action, Uri uri,
2100 Context packageContext, Class<?> cls) {
2101 mAction = action;
2102 mData = uri;
2103 mComponent = new ComponentName(packageContext, cls);
2104 }
2105
2106 /**
2107 * Create an intent from a URI. This URI may encode the action,
2108 * category, and other intent fields, if it was returned by toURI(). If
2109 * the Intent was not generate by toURI(), its data will be the entire URI
2110 * and its action will be ACTION_VIEW.
2111 *
2112 * <p>The URI given here must not be relative -- that is, it must include
2113 * the scheme and full path.
2114 *
2115 * @param uri The URI to turn into an Intent.
2116 *
2117 * @return Intent The newly created Intent object.
2118 *
2119 * @see #toURI
2120 */
2121 public static Intent getIntent(String uri) throws URISyntaxException {
2122 int i = 0;
2123 try {
2124 // simple case
2125 i = uri.lastIndexOf("#");
2126 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2127
2128 // old format Intent URI
2129 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002130
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002131 // new format
2132 Intent intent = new Intent(ACTION_VIEW);
2133
2134 // fetch data part, if present
2135 if (i > 0) {
2136 intent.mData = Uri.parse(uri.substring(0, i));
2137 }
2138 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002139
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002140 // loop over contents of Intent, all name=value;
2141 while (!uri.startsWith("end", i)) {
2142 int eq = uri.indexOf('=', i);
2143 int semi = uri.indexOf(';', eq);
2144 String value = uri.substring(eq + 1, semi);
2145
2146 // action
2147 if (uri.startsWith("action=", i)) {
2148 intent.mAction = value;
2149 }
2150
2151 // categories
2152 else if (uri.startsWith("category=", i)) {
2153 intent.addCategory(value);
2154 }
2155
2156 // type
2157 else if (uri.startsWith("type=", i)) {
2158 intent.mType = value;
2159 }
2160
2161 // launch flags
2162 else if (uri.startsWith("launchFlags=", i)) {
2163 intent.mFlags = Integer.decode(value).intValue();
2164 }
2165
2166 // component
2167 else if (uri.startsWith("component=", i)) {
2168 intent.mComponent = ComponentName.unflattenFromString(value);
2169 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002170
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002171 // extra
2172 else {
2173 String key = Uri.decode(uri.substring(i + 2, eq));
2174 value = Uri.decode(value);
2175 // create Bundle if it doesn't already exist
2176 if (intent.mExtras == null) intent.mExtras = new Bundle();
2177 Bundle b = intent.mExtras;
2178 // add EXTRA
2179 if (uri.startsWith("S.", i)) b.putString(key, value);
2180 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2181 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2182 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2183 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2184 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2185 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2186 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2187 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2188 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2189 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002190
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002191 // move to the next item
2192 i = semi + 1;
2193 }
2194
2195 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002196
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002197 } catch (IndexOutOfBoundsException e) {
2198 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2199 }
2200 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002201
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002202 public static Intent getIntentOld(String uri) throws URISyntaxException {
2203 Intent intent;
2204
2205 int i = uri.lastIndexOf('#');
2206 if (i >= 0) {
2207 Uri data = null;
2208 String action = null;
2209 if (i > 0) {
2210 data = Uri.parse(uri.substring(0, i));
2211 }
2212
2213 i++;
2214
2215 if (uri.regionMatches(i, "action(", 0, 7)) {
2216 i += 7;
2217 int j = uri.indexOf(')', i);
2218 action = uri.substring(i, j);
2219 i = j + 1;
2220 }
2221
2222 intent = new Intent(action, data);
2223
2224 if (uri.regionMatches(i, "categories(", 0, 11)) {
2225 i += 11;
2226 int j = uri.indexOf(')', i);
2227 while (i < j) {
2228 int sep = uri.indexOf('!', i);
2229 if (sep < 0) sep = j;
2230 if (i < sep) {
2231 intent.addCategory(uri.substring(i, sep));
2232 }
2233 i = sep + 1;
2234 }
2235 i = j + 1;
2236 }
2237
2238 if (uri.regionMatches(i, "type(", 0, 5)) {
2239 i += 5;
2240 int j = uri.indexOf(')', i);
2241 intent.mType = uri.substring(i, j);
2242 i = j + 1;
2243 }
2244
2245 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2246 i += 12;
2247 int j = uri.indexOf(')', i);
2248 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2249 i = j + 1;
2250 }
2251
2252 if (uri.regionMatches(i, "component(", 0, 10)) {
2253 i += 10;
2254 int j = uri.indexOf(')', i);
2255 int sep = uri.indexOf('!', i);
2256 if (sep >= 0 && sep < j) {
2257 String pkg = uri.substring(i, sep);
2258 String cls = uri.substring(sep + 1, j);
2259 intent.mComponent = new ComponentName(pkg, cls);
2260 }
2261 i = j + 1;
2262 }
2263
2264 if (uri.regionMatches(i, "extras(", 0, 7)) {
2265 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002266
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002267 final int closeParen = uri.indexOf(')', i);
2268 if (closeParen == -1) throw new URISyntaxException(uri,
2269 "EXTRA missing trailing ')'", i);
2270
2271 while (i < closeParen) {
2272 // fetch the key value
2273 int j = uri.indexOf('=', i);
2274 if (j <= i + 1 || i >= closeParen) {
2275 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2276 }
2277 char type = uri.charAt(i);
2278 i++;
2279 String key = uri.substring(i, j);
2280 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002281
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002282 // get type-value
2283 j = uri.indexOf('!', i);
2284 if (j == -1 || j >= closeParen) j = closeParen;
2285 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2286 String value = uri.substring(i, j);
2287 i = j;
2288
2289 // create Bundle if it doesn't already exist
2290 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002291
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002292 // add item to bundle
2293 try {
2294 switch (type) {
2295 case 'S':
2296 intent.mExtras.putString(key, Uri.decode(value));
2297 break;
2298 case 'B':
2299 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2300 break;
2301 case 'b':
2302 intent.mExtras.putByte(key, Byte.parseByte(value));
2303 break;
2304 case 'c':
2305 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2306 break;
2307 case 'd':
2308 intent.mExtras.putDouble(key, Double.parseDouble(value));
2309 break;
2310 case 'f':
2311 intent.mExtras.putFloat(key, Float.parseFloat(value));
2312 break;
2313 case 'i':
2314 intent.mExtras.putInt(key, Integer.parseInt(value));
2315 break;
2316 case 'l':
2317 intent.mExtras.putLong(key, Long.parseLong(value));
2318 break;
2319 case 's':
2320 intent.mExtras.putShort(key, Short.parseShort(value));
2321 break;
2322 default:
2323 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2324 }
2325 } catch (NumberFormatException e) {
2326 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2327 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002328
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002329 char ch = uri.charAt(i);
2330 if (ch == ')') break;
2331 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2332 i++;
2333 }
2334 }
2335
2336 if (intent.mAction == null) {
2337 // By default, if no action is specified, then use VIEW.
2338 intent.mAction = ACTION_VIEW;
2339 }
2340
2341 } else {
2342 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2343 }
2344
2345 return intent;
2346 }
2347
2348 /**
2349 * Retrieve the general action to be performed, such as
2350 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2351 * the information in the intent should be interpreted -- most importantly,
2352 * what to do with the data returned by {@link #getData}.
2353 *
2354 * @return The action of this intent or null if none is specified.
2355 *
2356 * @see #setAction
2357 */
2358 public String getAction() {
2359 return mAction;
2360 }
2361
2362 /**
2363 * Retrieve data this intent is operating on. This URI specifies the name
2364 * of the data; often it uses the content: scheme, specifying data in a
2365 * content provider. Other schemes may be handled by specific activities,
2366 * such as http: by the web browser.
2367 *
2368 * @return The URI of the data this intent is targeting or null.
2369 *
2370 * @see #getScheme
2371 * @see #setData
2372 */
2373 public Uri getData() {
2374 return mData;
2375 }
2376
2377 /**
2378 * The same as {@link #getData()}, but returns the URI as an encoded
2379 * String.
2380 */
2381 public String getDataString() {
2382 return mData != null ? mData.toString() : null;
2383 }
2384
2385 /**
2386 * Return the scheme portion of the intent's data. If the data is null or
2387 * does not include a scheme, null is returned. Otherwise, the scheme
2388 * prefix without the final ':' is returned, i.e. "http".
2389 *
2390 * <p>This is the same as calling getData().getScheme() (and checking for
2391 * null data).
2392 *
2393 * @return The scheme of this intent.
2394 *
2395 * @see #getData
2396 */
2397 public String getScheme() {
2398 return mData != null ? mData.getScheme() : null;
2399 }
2400
2401 /**
2402 * Retrieve any explicit MIME type included in the intent. This is usually
2403 * null, as the type is determined by the intent data.
2404 *
2405 * @return If a type was manually set, it is returned; else null is
2406 * returned.
2407 *
2408 * @see #resolveType(ContentResolver)
2409 * @see #setType
2410 */
2411 public String getType() {
2412 return mType;
2413 }
2414
2415 /**
2416 * Return the MIME data type of this intent. If the type field is
2417 * explicitly set, that is simply returned. Otherwise, if the data is set,
2418 * the type of that data is returned. If neither fields are set, a null is
2419 * returned.
2420 *
2421 * @return The MIME type of this intent.
2422 *
2423 * @see #getType
2424 * @see #resolveType(ContentResolver)
2425 */
2426 public String resolveType(Context context) {
2427 return resolveType(context.getContentResolver());
2428 }
2429
2430 /**
2431 * Return the MIME data type of this intent. If the type field is
2432 * explicitly set, that is simply returned. Otherwise, if the data is set,
2433 * the type of that data is returned. If neither fields are set, a null is
2434 * returned.
2435 *
2436 * @param resolver A ContentResolver that can be used to determine the MIME
2437 * type of the intent's data.
2438 *
2439 * @return The MIME type of this intent.
2440 *
2441 * @see #getType
2442 * @see #resolveType(Context)
2443 */
2444 public String resolveType(ContentResolver resolver) {
2445 if (mType != null) {
2446 return mType;
2447 }
2448 if (mData != null) {
2449 if ("content".equals(mData.getScheme())) {
2450 return resolver.getType(mData);
2451 }
2452 }
2453 return null;
2454 }
2455
2456 /**
2457 * Return the MIME data type of this intent, only if it will be needed for
2458 * intent resolution. This is not generally useful for application code;
2459 * it is used by the frameworks for communicating with back-end system
2460 * services.
2461 *
2462 * @param resolver A ContentResolver that can be used to determine the MIME
2463 * type of the intent's data.
2464 *
2465 * @return The MIME type of this intent, or null if it is unknown or not
2466 * needed.
2467 */
2468 public String resolveTypeIfNeeded(ContentResolver resolver) {
2469 if (mComponent != null) {
2470 return mType;
2471 }
2472 return resolveType(resolver);
2473 }
2474
2475 /**
2476 * Check if an category exists in the intent.
2477 *
2478 * @param category The category to check.
2479 *
2480 * @return boolean True if the intent contains the category, else false.
2481 *
2482 * @see #getCategories
2483 * @see #addCategory
2484 */
2485 public boolean hasCategory(String category) {
2486 return mCategories != null && mCategories.contains(category);
2487 }
2488
2489 /**
2490 * Return the set of all categories in the intent. If there are no categories,
2491 * returns NULL.
2492 *
2493 * @return Set The set of categories you can examine. Do not modify!
2494 *
2495 * @see #hasCategory
2496 * @see #addCategory
2497 */
2498 public Set<String> getCategories() {
2499 return mCategories;
2500 }
2501
2502 /**
2503 * Sets the ClassLoader that will be used when unmarshalling
2504 * any Parcelable values from the extras of this Intent.
2505 *
2506 * @param loader a ClassLoader, or null to use the default loader
2507 * at the time of unmarshalling.
2508 */
2509 public void setExtrasClassLoader(ClassLoader loader) {
2510 if (mExtras != null) {
2511 mExtras.setClassLoader(loader);
2512 }
2513 }
2514
2515 /**
2516 * Returns true if an extra value is associated with the given name.
2517 * @param name the extra's name
2518 * @return true if the given extra is present.
2519 */
2520 public boolean hasExtra(String name) {
2521 return mExtras != null && mExtras.containsKey(name);
2522 }
2523
2524 /**
2525 * Returns true if the Intent's extras contain a parcelled file descriptor.
2526 * @return true if the Intent contains a parcelled file descriptor.
2527 */
2528 public boolean hasFileDescriptors() {
2529 return mExtras != null && mExtras.hasFileDescriptors();
2530 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002531
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002532 /**
2533 * Retrieve extended data from the intent.
2534 *
2535 * @param name The name of the desired item.
2536 *
2537 * @return the value of an item that previously added with putExtra()
2538 * or null if none was found.
2539 *
2540 * @deprecated
2541 * @hide
2542 */
2543 @Deprecated
2544 public Object getExtra(String name) {
2545 return getExtra(name, null);
2546 }
2547
2548 /**
2549 * Retrieve extended data from the intent.
2550 *
2551 * @param name The name of the desired item.
2552 * @param defaultValue the value to be returned if no value of the desired
2553 * type is stored with the given name.
2554 *
2555 * @return the value of an item that previously added with putExtra()
2556 * or the default value if none was found.
2557 *
2558 * @see #putExtra(String, boolean)
2559 */
2560 public boolean getBooleanExtra(String name, boolean defaultValue) {
2561 return mExtras == null ? defaultValue :
2562 mExtras.getBoolean(name, defaultValue);
2563 }
2564
2565 /**
2566 * Retrieve extended data from the intent.
2567 *
2568 * @param name The name of the desired item.
2569 * @param defaultValue the value to be returned if no value of the desired
2570 * type is stored with the given name.
2571 *
2572 * @return the value of an item that previously added with putExtra()
2573 * or the default value if none was found.
2574 *
2575 * @see #putExtra(String, byte)
2576 */
2577 public byte getByteExtra(String name, byte defaultValue) {
2578 return mExtras == null ? defaultValue :
2579 mExtras.getByte(name, defaultValue);
2580 }
2581
2582 /**
2583 * Retrieve extended data from the intent.
2584 *
2585 * @param name The name of the desired item.
2586 * @param defaultValue the value to be returned if no value of the desired
2587 * type is stored with the given name.
2588 *
2589 * @return the value of an item that previously added with putExtra()
2590 * or the default value if none was found.
2591 *
2592 * @see #putExtra(String, short)
2593 */
2594 public short getShortExtra(String name, short defaultValue) {
2595 return mExtras == null ? defaultValue :
2596 mExtras.getShort(name, defaultValue);
2597 }
2598
2599 /**
2600 * Retrieve extended data from the intent.
2601 *
2602 * @param name The name of the desired item.
2603 * @param defaultValue the value to be returned if no value of the desired
2604 * type is stored with the given name.
2605 *
2606 * @return the value of an item that previously added with putExtra()
2607 * or the default value if none was found.
2608 *
2609 * @see #putExtra(String, char)
2610 */
2611 public char getCharExtra(String name, char defaultValue) {
2612 return mExtras == null ? defaultValue :
2613 mExtras.getChar(name, defaultValue);
2614 }
2615
2616 /**
2617 * Retrieve extended data from the intent.
2618 *
2619 * @param name The name of the desired item.
2620 * @param defaultValue the value to be returned if no value of the desired
2621 * type is stored with the given name.
2622 *
2623 * @return the value of an item that previously added with putExtra()
2624 * or the default value if none was found.
2625 *
2626 * @see #putExtra(String, int)
2627 */
2628 public int getIntExtra(String name, int defaultValue) {
2629 return mExtras == null ? defaultValue :
2630 mExtras.getInt(name, defaultValue);
2631 }
2632
2633 /**
2634 * Retrieve extended data from the intent.
2635 *
2636 * @param name The name of the desired item.
2637 * @param defaultValue the value to be returned if no value of the desired
2638 * type is stored with the given name.
2639 *
2640 * @return the value of an item that previously added with putExtra()
2641 * or the default value if none was found.
2642 *
2643 * @see #putExtra(String, long)
2644 */
2645 public long getLongExtra(String name, long defaultValue) {
2646 return mExtras == null ? defaultValue :
2647 mExtras.getLong(name, defaultValue);
2648 }
2649
2650 /**
2651 * Retrieve extended data from the intent.
2652 *
2653 * @param name The name of the desired item.
2654 * @param defaultValue the value to be returned if no value of the desired
2655 * type is stored with the given name.
2656 *
2657 * @return the value of an item that previously added with putExtra(),
2658 * or the default value if no such item is present
2659 *
2660 * @see #putExtra(String, float)
2661 */
2662 public float getFloatExtra(String name, float defaultValue) {
2663 return mExtras == null ? defaultValue :
2664 mExtras.getFloat(name, defaultValue);
2665 }
2666
2667 /**
2668 * Retrieve extended data from the intent.
2669 *
2670 * @param name The name of the desired item.
2671 * @param defaultValue the value to be returned if no value of the desired
2672 * type is stored with the given name.
2673 *
2674 * @return the value of an item that previously added with putExtra()
2675 * or the default value if none was found.
2676 *
2677 * @see #putExtra(String, double)
2678 */
2679 public double getDoubleExtra(String name, double defaultValue) {
2680 return mExtras == null ? defaultValue :
2681 mExtras.getDouble(name, defaultValue);
2682 }
2683
2684 /**
2685 * Retrieve extended data from the intent.
2686 *
2687 * @param name The name of the desired item.
2688 *
2689 * @return the value of an item that previously added with putExtra()
2690 * or null if no String value was found.
2691 *
2692 * @see #putExtra(String, String)
2693 */
2694 public String getStringExtra(String name) {
2695 return mExtras == null ? null : mExtras.getString(name);
2696 }
2697
2698 /**
2699 * Retrieve extended data from the intent.
2700 *
2701 * @param name The name of the desired item.
2702 *
2703 * @return the value of an item that previously added with putExtra()
2704 * or null if no CharSequence value was found.
2705 *
2706 * @see #putExtra(String, CharSequence)
2707 */
2708 public CharSequence getCharSequenceExtra(String name) {
2709 return mExtras == null ? null : mExtras.getCharSequence(name);
2710 }
2711
2712 /**
2713 * Retrieve extended data from the intent.
2714 *
2715 * @param name The name of the desired item.
2716 *
2717 * @return the value of an item that previously added with putExtra()
2718 * or null if no Parcelable value was found.
2719 *
2720 * @see #putExtra(String, Parcelable)
2721 */
2722 public <T extends Parcelable> T getParcelableExtra(String name) {
2723 return mExtras == null ? null : mExtras.<T>getParcelable(name);
2724 }
2725
2726 /**
2727 * Retrieve extended data from the intent.
2728 *
2729 * @param name The name of the desired item.
2730 *
2731 * @return the value of an item that previously added with putExtra()
2732 * or null if no Parcelable[] value was found.
2733 *
2734 * @see #putExtra(String, Parcelable[])
2735 */
2736 public Parcelable[] getParcelableArrayExtra(String name) {
2737 return mExtras == null ? null : mExtras.getParcelableArray(name);
2738 }
2739
2740 /**
2741 * Retrieve extended data from the intent.
2742 *
2743 * @param name The name of the desired item.
2744 *
2745 * @return the value of an item that previously added with putExtra()
2746 * or null if no ArrayList<Parcelable> value was found.
2747 *
2748 * @see #putParcelableArrayListExtra(String, ArrayList)
2749 */
2750 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
2751 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
2752 }
2753
2754 /**
2755 * Retrieve extended data from the intent.
2756 *
2757 * @param name The name of the desired item.
2758 *
2759 * @return the value of an item that previously added with putExtra()
2760 * or null if no Serializable value was found.
2761 *
2762 * @see #putExtra(String, Serializable)
2763 */
2764 public Serializable getSerializableExtra(String name) {
2765 return mExtras == null ? null : mExtras.getSerializable(name);
2766 }
2767
2768 /**
2769 * Retrieve extended data from the intent.
2770 *
2771 * @param name The name of the desired item.
2772 *
2773 * @return the value of an item that previously added with putExtra()
2774 * or null if no ArrayList<Integer> value was found.
2775 *
2776 * @see #putIntegerArrayListExtra(String, ArrayList)
2777 */
2778 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
2779 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
2780 }
2781
2782 /**
2783 * Retrieve extended data from the intent.
2784 *
2785 * @param name The name of the desired item.
2786 *
2787 * @return the value of an item that previously added with putExtra()
2788 * or null if no ArrayList<String> value was found.
2789 *
2790 * @see #putStringArrayListExtra(String, ArrayList)
2791 */
2792 public ArrayList<String> getStringArrayListExtra(String name) {
2793 return mExtras == null ? null : mExtras.getStringArrayList(name);
2794 }
2795
2796 /**
2797 * Retrieve extended data from the intent.
2798 *
2799 * @param name The name of the desired item.
2800 *
2801 * @return the value of an item that previously added with putExtra()
2802 * or null if no boolean array value was found.
2803 *
2804 * @see #putExtra(String, boolean[])
2805 */
2806 public boolean[] getBooleanArrayExtra(String name) {
2807 return mExtras == null ? null : mExtras.getBooleanArray(name);
2808 }
2809
2810 /**
2811 * Retrieve extended data from the intent.
2812 *
2813 * @param name The name of the desired item.
2814 *
2815 * @return the value of an item that previously added with putExtra()
2816 * or null if no byte array value was found.
2817 *
2818 * @see #putExtra(String, byte[])
2819 */
2820 public byte[] getByteArrayExtra(String name) {
2821 return mExtras == null ? null : mExtras.getByteArray(name);
2822 }
2823
2824 /**
2825 * Retrieve extended data from the intent.
2826 *
2827 * @param name The name of the desired item.
2828 *
2829 * @return the value of an item that previously added with putExtra()
2830 * or null if no short array value was found.
2831 *
2832 * @see #putExtra(String, short[])
2833 */
2834 public short[] getShortArrayExtra(String name) {
2835 return mExtras == null ? null : mExtras.getShortArray(name);
2836 }
2837
2838 /**
2839 * Retrieve extended data from the intent.
2840 *
2841 * @param name The name of the desired item.
2842 *
2843 * @return the value of an item that previously added with putExtra()
2844 * or null if no char array value was found.
2845 *
2846 * @see #putExtra(String, char[])
2847 */
2848 public char[] getCharArrayExtra(String name) {
2849 return mExtras == null ? null : mExtras.getCharArray(name);
2850 }
2851
2852 /**
2853 * Retrieve extended data from the intent.
2854 *
2855 * @param name The name of the desired item.
2856 *
2857 * @return the value of an item that previously added with putExtra()
2858 * or null if no int array value was found.
2859 *
2860 * @see #putExtra(String, int[])
2861 */
2862 public int[] getIntArrayExtra(String name) {
2863 return mExtras == null ? null : mExtras.getIntArray(name);
2864 }
2865
2866 /**
2867 * Retrieve extended data from the intent.
2868 *
2869 * @param name The name of the desired item.
2870 *
2871 * @return the value of an item that previously added with putExtra()
2872 * or null if no long array value was found.
2873 *
2874 * @see #putExtra(String, long[])
2875 */
2876 public long[] getLongArrayExtra(String name) {
2877 return mExtras == null ? null : mExtras.getLongArray(name);
2878 }
2879
2880 /**
2881 * Retrieve extended data from the intent.
2882 *
2883 * @param name The name of the desired item.
2884 *
2885 * @return the value of an item that previously added with putExtra()
2886 * or null if no float array value was found.
2887 *
2888 * @see #putExtra(String, float[])
2889 */
2890 public float[] getFloatArrayExtra(String name) {
2891 return mExtras == null ? null : mExtras.getFloatArray(name);
2892 }
2893
2894 /**
2895 * Retrieve extended data from the intent.
2896 *
2897 * @param name The name of the desired item.
2898 *
2899 * @return the value of an item that previously added with putExtra()
2900 * or null if no double array value was found.
2901 *
2902 * @see #putExtra(String, double[])
2903 */
2904 public double[] getDoubleArrayExtra(String name) {
2905 return mExtras == null ? null : mExtras.getDoubleArray(name);
2906 }
2907
2908 /**
2909 * Retrieve extended data from the intent.
2910 *
2911 * @param name The name of the desired item.
2912 *
2913 * @return the value of an item that previously added with putExtra()
2914 * or null if no String array value was found.
2915 *
2916 * @see #putExtra(String, String[])
2917 */
2918 public String[] getStringArrayExtra(String name) {
2919 return mExtras == null ? null : mExtras.getStringArray(name);
2920 }
2921
2922 /**
2923 * Retrieve extended data from the intent.
2924 *
2925 * @param name The name of the desired item.
2926 *
2927 * @return the value of an item that previously added with putExtra()
2928 * or null if no Bundle value was found.
2929 *
2930 * @see #putExtra(String, Bundle)
2931 */
2932 public Bundle getBundleExtra(String name) {
2933 return mExtras == null ? null : mExtras.getBundle(name);
2934 }
2935
2936 /**
2937 * Retrieve extended data from the intent.
2938 *
2939 * @param name The name of the desired item.
2940 *
2941 * @return the value of an item that previously added with putExtra()
2942 * or null if no IBinder value was found.
2943 *
2944 * @see #putExtra(String, IBinder)
2945 *
2946 * @deprecated
2947 * @hide
2948 */
2949 @Deprecated
2950 public IBinder getIBinderExtra(String name) {
2951 return mExtras == null ? null : mExtras.getIBinder(name);
2952 }
2953
2954 /**
2955 * Retrieve extended data from the intent.
2956 *
2957 * @param name The name of the desired item.
2958 * @param defaultValue The default value to return in case no item is
2959 * associated with the key 'name'
2960 *
2961 * @return the value of an item that previously added with putExtra()
2962 * or defaultValue if none was found.
2963 *
2964 * @see #putExtra
2965 *
2966 * @deprecated
2967 * @hide
2968 */
2969 @Deprecated
2970 public Object getExtra(String name, Object defaultValue) {
2971 Object result = defaultValue;
2972 if (mExtras != null) {
2973 Object result2 = mExtras.get(name);
2974 if (result2 != null) {
2975 result = result2;
2976 }
2977 }
2978
2979 return result;
2980 }
2981
2982 /**
2983 * Retrieves a map of extended data from the intent.
2984 *
2985 * @return the map of all extras previously added with putExtra(),
2986 * or null if none have been added.
2987 */
2988 public Bundle getExtras() {
2989 return (mExtras != null)
2990 ? new Bundle(mExtras)
2991 : null;
2992 }
2993
2994 /**
2995 * Retrieve any special flags associated with this intent. You will
2996 * normally just set them with {@link #setFlags} and let the system
2997 * take the appropriate action with them.
2998 *
2999 * @return int The currently set flags.
3000 *
3001 * @see #setFlags
3002 */
3003 public int getFlags() {
3004 return mFlags;
3005 }
3006
3007 /**
3008 * Retrieve the concrete component associated with the intent. When receiving
3009 * an intent, this is the component that was found to best handle it (that is,
3010 * yourself) and will always be non-null; in all other cases it will be
3011 * null unless explicitly set.
3012 *
3013 * @return The name of the application component to handle the intent.
3014 *
3015 * @see #resolveActivity
3016 * @see #setComponent
3017 */
3018 public ComponentName getComponent() {
3019 return mComponent;
3020 }
3021
3022 /**
3023 * Return the Activity component that should be used to handle this intent.
3024 * The appropriate component is determined based on the information in the
3025 * intent, evaluated as follows:
3026 *
3027 * <p>If {@link #getComponent} returns an explicit class, that is returned
3028 * without any further consideration.
3029 *
3030 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3031 * category to be considered.
3032 *
3033 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3034 * action.
3035 *
3036 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3037 * this type.
3038 *
3039 * <p>If {@link #addCategory} has added any categories, the activity must
3040 * handle ALL of the categories specified.
3041 *
3042 * <p>If there are no activities that satisfy all of these conditions, a
3043 * null string is returned.
3044 *
3045 * <p>If multiple activities are found to satisfy the intent, the one with
3046 * the highest priority will be used. If there are multiple activities
3047 * with the same priority, the system will either pick the best activity
3048 * based on user preference, or resolve to a system class that will allow
3049 * the user to pick an activity and forward from there.
3050 *
3051 * <p>This method is implemented simply by calling
3052 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3053 * true.</p>
3054 * <p> This API is called for you as part of starting an activity from an
3055 * intent. You do not normally need to call it yourself.</p>
3056 *
3057 * @param pm The package manager with which to resolve the Intent.
3058 *
3059 * @return Name of the component implementing an activity that can
3060 * display the intent.
3061 *
3062 * @see #setComponent
3063 * @see #getComponent
3064 * @see #resolveActivityInfo
3065 */
3066 public ComponentName resolveActivity(PackageManager pm) {
3067 if (mComponent != null) {
3068 return mComponent;
3069 }
3070
3071 ResolveInfo info = pm.resolveActivity(
3072 this, PackageManager.MATCH_DEFAULT_ONLY);
3073 if (info != null) {
3074 return new ComponentName(
3075 info.activityInfo.applicationInfo.packageName,
3076 info.activityInfo.name);
3077 }
3078
3079 return null;
3080 }
3081
3082 /**
3083 * Resolve the Intent into an {@link ActivityInfo}
3084 * describing the activity that should execute the intent. Resolution
3085 * follows the same rules as described for {@link #resolveActivity}, but
3086 * you get back the completely information about the resolved activity
3087 * instead of just its class name.
3088 *
3089 * @param pm The package manager with which to resolve the Intent.
3090 * @param flags Addition information to retrieve as per
3091 * {@link PackageManager#getActivityInfo(ComponentName, int)
3092 * PackageManager.getActivityInfo()}.
3093 *
3094 * @return PackageManager.ActivityInfo
3095 *
3096 * @see #resolveActivity
3097 */
3098 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3099 ActivityInfo ai = null;
3100 if (mComponent != null) {
3101 try {
3102 ai = pm.getActivityInfo(mComponent, flags);
3103 } catch (PackageManager.NameNotFoundException e) {
3104 // ignore
3105 }
3106 } else {
3107 ResolveInfo info = pm.resolveActivity(
3108 this, PackageManager.MATCH_DEFAULT_ONLY);
3109 if (info != null) {
3110 ai = info.activityInfo;
3111 }
3112 }
3113
3114 return ai;
3115 }
3116
3117 /**
3118 * Set the general action to be performed.
3119 *
3120 * @param action An action name, such as ACTION_VIEW. Application-specific
3121 * actions should be prefixed with the vendor's package name.
3122 *
3123 * @return Returns the same Intent object, for chaining multiple calls
3124 * into a single statement.
3125 *
3126 * @see #getAction
3127 */
3128 public Intent setAction(String action) {
3129 mAction = action;
3130 return this;
3131 }
3132
3133 /**
3134 * Set the data this intent is operating on. This method automatically
3135 * clears any type that was previously set by {@link #setType}.
3136 *
3137 * @param data The URI of the data this intent is now targeting.
3138 *
3139 * @return Returns the same Intent object, for chaining multiple calls
3140 * into a single statement.
3141 *
3142 * @see #getData
3143 * @see #setType
3144 * @see #setDataAndType
3145 */
3146 public Intent setData(Uri data) {
3147 mData = data;
3148 mType = null;
3149 return this;
3150 }
3151
3152 /**
3153 * Set an explicit MIME data type. This is used to create intents that
3154 * only specify a type and not data, for example to indicate the type of
3155 * data to return. This method automatically clears any data that was
3156 * previously set by {@link #setData}.
3157 *
3158 * @param type The MIME type of the data being handled by this intent.
3159 *
3160 * @return Returns the same Intent object, for chaining multiple calls
3161 * into a single statement.
3162 *
3163 * @see #getType
3164 * @see #setData
3165 * @see #setDataAndType
3166 */
3167 public Intent setType(String type) {
3168 mData = null;
3169 mType = type;
3170 return this;
3171 }
3172
3173 /**
3174 * (Usually optional) Set the data for the intent along with an explicit
3175 * MIME data type. This method should very rarely be used -- it allows you
3176 * to override the MIME type that would ordinarily be inferred from the
3177 * data with your own type given here.
3178 *
3179 * @param data The URI of the data this intent is now targeting.
3180 * @param type The MIME type of the data being handled by this intent.
3181 *
3182 * @return Returns the same Intent object, for chaining multiple calls
3183 * into a single statement.
3184 *
3185 * @see #setData
3186 * @see #setType
3187 */
3188 public Intent setDataAndType(Uri data, String type) {
3189 mData = data;
3190 mType = type;
3191 return this;
3192 }
3193
3194 /**
3195 * Add a new category to the intent. Categories provide additional detail
3196 * about the action the intent is perform. When resolving an intent, only
3197 * activities that provide <em>all</em> of the requested categories will be
3198 * used.
3199 *
3200 * @param category The desired category. This can be either one of the
3201 * predefined Intent categories, or a custom category in your own
3202 * namespace.
3203 *
3204 * @return Returns the same Intent object, for chaining multiple calls
3205 * into a single statement.
3206 *
3207 * @see #hasCategory
3208 * @see #removeCategory
3209 */
3210 public Intent addCategory(String category) {
3211 if (mCategories == null) {
3212 mCategories = new HashSet<String>();
3213 }
3214 mCategories.add(category);
3215 return this;
3216 }
3217
3218 /**
3219 * Remove an category from an intent.
3220 *
3221 * @param category The category to remove.
3222 *
3223 * @see #addCategory
3224 */
3225 public void removeCategory(String category) {
3226 if (mCategories != null) {
3227 mCategories.remove(category);
3228 if (mCategories.size() == 0) {
3229 mCategories = null;
3230 }
3231 }
3232 }
3233
3234 /**
3235 * Add extended data to the intent. The name must include a package
3236 * prefix, for example the app com.android.contacts would use names
3237 * like "com.android.contacts.ShowAll".
3238 *
3239 * @param name The name of the extra data, with package prefix.
3240 * @param value The boolean data value.
3241 *
3242 * @return Returns the same Intent object, for chaining multiple calls
3243 * into a single statement.
3244 *
3245 * @see #putExtras
3246 * @see #removeExtra
3247 * @see #getBooleanExtra(String, boolean)
3248 */
3249 public Intent putExtra(String name, boolean value) {
3250 if (mExtras == null) {
3251 mExtras = new Bundle();
3252 }
3253 mExtras.putBoolean(name, value);
3254 return this;
3255 }
3256
3257 /**
3258 * Add extended data to the intent. The name must include a package
3259 * prefix, for example the app com.android.contacts would use names
3260 * like "com.android.contacts.ShowAll".
3261 *
3262 * @param name The name of the extra data, with package prefix.
3263 * @param value The byte data value.
3264 *
3265 * @return Returns the same Intent object, for chaining multiple calls
3266 * into a single statement.
3267 *
3268 * @see #putExtras
3269 * @see #removeExtra
3270 * @see #getByteExtra(String, byte)
3271 */
3272 public Intent putExtra(String name, byte value) {
3273 if (mExtras == null) {
3274 mExtras = new Bundle();
3275 }
3276 mExtras.putByte(name, value);
3277 return this;
3278 }
3279
3280 /**
3281 * Add extended data to the intent. The name must include a package
3282 * prefix, for example the app com.android.contacts would use names
3283 * like "com.android.contacts.ShowAll".
3284 *
3285 * @param name The name of the extra data, with package prefix.
3286 * @param value The char data value.
3287 *
3288 * @return Returns the same Intent object, for chaining multiple calls
3289 * into a single statement.
3290 *
3291 * @see #putExtras
3292 * @see #removeExtra
3293 * @see #getCharExtra(String, char)
3294 */
3295 public Intent putExtra(String name, char value) {
3296 if (mExtras == null) {
3297 mExtras = new Bundle();
3298 }
3299 mExtras.putChar(name, value);
3300 return this;
3301 }
3302
3303 /**
3304 * Add extended data to the intent. The name must include a package
3305 * prefix, for example the app com.android.contacts would use names
3306 * like "com.android.contacts.ShowAll".
3307 *
3308 * @param name The name of the extra data, with package prefix.
3309 * @param value The short data value.
3310 *
3311 * @return Returns the same Intent object, for chaining multiple calls
3312 * into a single statement.
3313 *
3314 * @see #putExtras
3315 * @see #removeExtra
3316 * @see #getShortExtra(String, short)
3317 */
3318 public Intent putExtra(String name, short value) {
3319 if (mExtras == null) {
3320 mExtras = new Bundle();
3321 }
3322 mExtras.putShort(name, value);
3323 return this;
3324 }
3325
3326 /**
3327 * Add extended data to the intent. The name must include a package
3328 * prefix, for example the app com.android.contacts would use names
3329 * like "com.android.contacts.ShowAll".
3330 *
3331 * @param name The name of the extra data, with package prefix.
3332 * @param value The integer data value.
3333 *
3334 * @return Returns the same Intent object, for chaining multiple calls
3335 * into a single statement.
3336 *
3337 * @see #putExtras
3338 * @see #removeExtra
3339 * @see #getIntExtra(String, int)
3340 */
3341 public Intent putExtra(String name, int value) {
3342 if (mExtras == null) {
3343 mExtras = new Bundle();
3344 }
3345 mExtras.putInt(name, value);
3346 return this;
3347 }
3348
3349 /**
3350 * Add extended data to the intent. The name must include a package
3351 * prefix, for example the app com.android.contacts would use names
3352 * like "com.android.contacts.ShowAll".
3353 *
3354 * @param name The name of the extra data, with package prefix.
3355 * @param value The long data value.
3356 *
3357 * @return Returns the same Intent object, for chaining multiple calls
3358 * into a single statement.
3359 *
3360 * @see #putExtras
3361 * @see #removeExtra
3362 * @see #getLongExtra(String, long)
3363 */
3364 public Intent putExtra(String name, long value) {
3365 if (mExtras == null) {
3366 mExtras = new Bundle();
3367 }
3368 mExtras.putLong(name, value);
3369 return this;
3370 }
3371
3372 /**
3373 * Add extended data to the intent. The name must include a package
3374 * prefix, for example the app com.android.contacts would use names
3375 * like "com.android.contacts.ShowAll".
3376 *
3377 * @param name The name of the extra data, with package prefix.
3378 * @param value The float data value.
3379 *
3380 * @return Returns the same Intent object, for chaining multiple calls
3381 * into a single statement.
3382 *
3383 * @see #putExtras
3384 * @see #removeExtra
3385 * @see #getFloatExtra(String, float)
3386 */
3387 public Intent putExtra(String name, float value) {
3388 if (mExtras == null) {
3389 mExtras = new Bundle();
3390 }
3391 mExtras.putFloat(name, value);
3392 return this;
3393 }
3394
3395 /**
3396 * Add extended data to the intent. The name must include a package
3397 * prefix, for example the app com.android.contacts would use names
3398 * like "com.android.contacts.ShowAll".
3399 *
3400 * @param name The name of the extra data, with package prefix.
3401 * @param value The double data value.
3402 *
3403 * @return Returns the same Intent object, for chaining multiple calls
3404 * into a single statement.
3405 *
3406 * @see #putExtras
3407 * @see #removeExtra
3408 * @see #getDoubleExtra(String, double)
3409 */
3410 public Intent putExtra(String name, double value) {
3411 if (mExtras == null) {
3412 mExtras = new Bundle();
3413 }
3414 mExtras.putDouble(name, value);
3415 return this;
3416 }
3417
3418 /**
3419 * Add extended data to the intent. The name must include a package
3420 * prefix, for example the app com.android.contacts would use names
3421 * like "com.android.contacts.ShowAll".
3422 *
3423 * @param name The name of the extra data, with package prefix.
3424 * @param value The String data value.
3425 *
3426 * @return Returns the same Intent object, for chaining multiple calls
3427 * into a single statement.
3428 *
3429 * @see #putExtras
3430 * @see #removeExtra
3431 * @see #getStringExtra(String)
3432 */
3433 public Intent putExtra(String name, String value) {
3434 if (mExtras == null) {
3435 mExtras = new Bundle();
3436 }
3437 mExtras.putString(name, value);
3438 return this;
3439 }
3440
3441 /**
3442 * Add extended data to the intent. The name must include a package
3443 * prefix, for example the app com.android.contacts would use names
3444 * like "com.android.contacts.ShowAll".
3445 *
3446 * @param name The name of the extra data, with package prefix.
3447 * @param value The CharSequence data value.
3448 *
3449 * @return Returns the same Intent object, for chaining multiple calls
3450 * into a single statement.
3451 *
3452 * @see #putExtras
3453 * @see #removeExtra
3454 * @see #getCharSequenceExtra(String)
3455 */
3456 public Intent putExtra(String name, CharSequence value) {
3457 if (mExtras == null) {
3458 mExtras = new Bundle();
3459 }
3460 mExtras.putCharSequence(name, value);
3461 return this;
3462 }
3463
3464 /**
3465 * Add extended data to the intent. The name must include a package
3466 * prefix, for example the app com.android.contacts would use names
3467 * like "com.android.contacts.ShowAll".
3468 *
3469 * @param name The name of the extra data, with package prefix.
3470 * @param value The Parcelable data value.
3471 *
3472 * @return Returns the same Intent object, for chaining multiple calls
3473 * into a single statement.
3474 *
3475 * @see #putExtras
3476 * @see #removeExtra
3477 * @see #getParcelableExtra(String)
3478 */
3479 public Intent putExtra(String name, Parcelable value) {
3480 if (mExtras == null) {
3481 mExtras = new Bundle();
3482 }
3483 mExtras.putParcelable(name, value);
3484 return this;
3485 }
3486
3487 /**
3488 * Add extended data to the intent. The name must include a package
3489 * prefix, for example the app com.android.contacts would use names
3490 * like "com.android.contacts.ShowAll".
3491 *
3492 * @param name The name of the extra data, with package prefix.
3493 * @param value The Parcelable[] data value.
3494 *
3495 * @return Returns the same Intent object, for chaining multiple calls
3496 * into a single statement.
3497 *
3498 * @see #putExtras
3499 * @see #removeExtra
3500 * @see #getParcelableArrayExtra(String)
3501 */
3502 public Intent putExtra(String name, Parcelable[] value) {
3503 if (mExtras == null) {
3504 mExtras = new Bundle();
3505 }
3506 mExtras.putParcelableArray(name, value);
3507 return this;
3508 }
3509
3510 /**
3511 * Add extended data to the intent. The name must include a package
3512 * prefix, for example the app com.android.contacts would use names
3513 * like "com.android.contacts.ShowAll".
3514 *
3515 * @param name The name of the extra data, with package prefix.
3516 * @param value The ArrayList<Parcelable> data value.
3517 *
3518 * @return Returns the same Intent object, for chaining multiple calls
3519 * into a single statement.
3520 *
3521 * @see #putExtras
3522 * @see #removeExtra
3523 * @see #getParcelableArrayListExtra(String)
3524 */
3525 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3526 if (mExtras == null) {
3527 mExtras = new Bundle();
3528 }
3529 mExtras.putParcelableArrayList(name, value);
3530 return this;
3531 }
3532
3533 /**
3534 * Add extended data to the intent. The name must include a package
3535 * prefix, for example the app com.android.contacts would use names
3536 * like "com.android.contacts.ShowAll".
3537 *
3538 * @param name The name of the extra data, with package prefix.
3539 * @param value The ArrayList<Integer> data value.
3540 *
3541 * @return Returns the same Intent object, for chaining multiple calls
3542 * into a single statement.
3543 *
3544 * @see #putExtras
3545 * @see #removeExtra
3546 * @see #getIntegerArrayListExtra(String)
3547 */
3548 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
3549 if (mExtras == null) {
3550 mExtras = new Bundle();
3551 }
3552 mExtras.putIntegerArrayList(name, value);
3553 return this;
3554 }
3555
3556 /**
3557 * Add extended data to the intent. The name must include a package
3558 * prefix, for example the app com.android.contacts would use names
3559 * like "com.android.contacts.ShowAll".
3560 *
3561 * @param name The name of the extra data, with package prefix.
3562 * @param value The ArrayList<String> data value.
3563 *
3564 * @return Returns the same Intent object, for chaining multiple calls
3565 * into a single statement.
3566 *
3567 * @see #putExtras
3568 * @see #removeExtra
3569 * @see #getStringArrayListExtra(String)
3570 */
3571 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
3572 if (mExtras == null) {
3573 mExtras = new Bundle();
3574 }
3575 mExtras.putStringArrayList(name, value);
3576 return this;
3577 }
3578
3579 /**
3580 * Add extended data to the intent. The name must include a package
3581 * prefix, for example the app com.android.contacts would use names
3582 * like "com.android.contacts.ShowAll".
3583 *
3584 * @param name The name of the extra data, with package prefix.
3585 * @param value The Serializable data value.
3586 *
3587 * @return Returns the same Intent object, for chaining multiple calls
3588 * into a single statement.
3589 *
3590 * @see #putExtras
3591 * @see #removeExtra
3592 * @see #getSerializableExtra(String)
3593 */
3594 public Intent putExtra(String name, Serializable value) {
3595 if (mExtras == null) {
3596 mExtras = new Bundle();
3597 }
3598 mExtras.putSerializable(name, value);
3599 return this;
3600 }
3601
3602 /**
3603 * Add extended data to the intent. The name must include a package
3604 * prefix, for example the app com.android.contacts would use names
3605 * like "com.android.contacts.ShowAll".
3606 *
3607 * @param name The name of the extra data, with package prefix.
3608 * @param value The boolean array data value.
3609 *
3610 * @return Returns the same Intent object, for chaining multiple calls
3611 * into a single statement.
3612 *
3613 * @see #putExtras
3614 * @see #removeExtra
3615 * @see #getBooleanArrayExtra(String)
3616 */
3617 public Intent putExtra(String name, boolean[] value) {
3618 if (mExtras == null) {
3619 mExtras = new Bundle();
3620 }
3621 mExtras.putBooleanArray(name, value);
3622 return this;
3623 }
3624
3625 /**
3626 * Add extended data to the intent. The name must include a package
3627 * prefix, for example the app com.android.contacts would use names
3628 * like "com.android.contacts.ShowAll".
3629 *
3630 * @param name The name of the extra data, with package prefix.
3631 * @param value The byte array data value.
3632 *
3633 * @return Returns the same Intent object, for chaining multiple calls
3634 * into a single statement.
3635 *
3636 * @see #putExtras
3637 * @see #removeExtra
3638 * @see #getByteArrayExtra(String)
3639 */
3640 public Intent putExtra(String name, byte[] value) {
3641 if (mExtras == null) {
3642 mExtras = new Bundle();
3643 }
3644 mExtras.putByteArray(name, value);
3645 return this;
3646 }
3647
3648 /**
3649 * Add extended data to the intent. The name must include a package
3650 * prefix, for example the app com.android.contacts would use names
3651 * like "com.android.contacts.ShowAll".
3652 *
3653 * @param name The name of the extra data, with package prefix.
3654 * @param value The short array data value.
3655 *
3656 * @return Returns the same Intent object, for chaining multiple calls
3657 * into a single statement.
3658 *
3659 * @see #putExtras
3660 * @see #removeExtra
3661 * @see #getShortArrayExtra(String)
3662 */
3663 public Intent putExtra(String name, short[] value) {
3664 if (mExtras == null) {
3665 mExtras = new Bundle();
3666 }
3667 mExtras.putShortArray(name, value);
3668 return this;
3669 }
3670
3671 /**
3672 * Add extended data to the intent. The name must include a package
3673 * prefix, for example the app com.android.contacts would use names
3674 * like "com.android.contacts.ShowAll".
3675 *
3676 * @param name The name of the extra data, with package prefix.
3677 * @param value The char array data value.
3678 *
3679 * @return Returns the same Intent object, for chaining multiple calls
3680 * into a single statement.
3681 *
3682 * @see #putExtras
3683 * @see #removeExtra
3684 * @see #getCharArrayExtra(String)
3685 */
3686 public Intent putExtra(String name, char[] value) {
3687 if (mExtras == null) {
3688 mExtras = new Bundle();
3689 }
3690 mExtras.putCharArray(name, value);
3691 return this;
3692 }
3693
3694 /**
3695 * Add extended data to the intent. The name must include a package
3696 * prefix, for example the app com.android.contacts would use names
3697 * like "com.android.contacts.ShowAll".
3698 *
3699 * @param name The name of the extra data, with package prefix.
3700 * @param value The int array data value.
3701 *
3702 * @return Returns the same Intent object, for chaining multiple calls
3703 * into a single statement.
3704 *
3705 * @see #putExtras
3706 * @see #removeExtra
3707 * @see #getIntArrayExtra(String)
3708 */
3709 public Intent putExtra(String name, int[] value) {
3710 if (mExtras == null) {
3711 mExtras = new Bundle();
3712 }
3713 mExtras.putIntArray(name, value);
3714 return this;
3715 }
3716
3717 /**
3718 * Add extended data to the intent. The name must include a package
3719 * prefix, for example the app com.android.contacts would use names
3720 * like "com.android.contacts.ShowAll".
3721 *
3722 * @param name The name of the extra data, with package prefix.
3723 * @param value The byte array data value.
3724 *
3725 * @return Returns the same Intent object, for chaining multiple calls
3726 * into a single statement.
3727 *
3728 * @see #putExtras
3729 * @see #removeExtra
3730 * @see #getLongArrayExtra(String)
3731 */
3732 public Intent putExtra(String name, long[] value) {
3733 if (mExtras == null) {
3734 mExtras = new Bundle();
3735 }
3736 mExtras.putLongArray(name, value);
3737 return this;
3738 }
3739
3740 /**
3741 * Add extended data to the intent. The name must include a package
3742 * prefix, for example the app com.android.contacts would use names
3743 * like "com.android.contacts.ShowAll".
3744 *
3745 * @param name The name of the extra data, with package prefix.
3746 * @param value The float array data value.
3747 *
3748 * @return Returns the same Intent object, for chaining multiple calls
3749 * into a single statement.
3750 *
3751 * @see #putExtras
3752 * @see #removeExtra
3753 * @see #getFloatArrayExtra(String)
3754 */
3755 public Intent putExtra(String name, float[] value) {
3756 if (mExtras == null) {
3757 mExtras = new Bundle();
3758 }
3759 mExtras.putFloatArray(name, value);
3760 return this;
3761 }
3762
3763 /**
3764 * Add extended data to the intent. The name must include a package
3765 * prefix, for example the app com.android.contacts would use names
3766 * like "com.android.contacts.ShowAll".
3767 *
3768 * @param name The name of the extra data, with package prefix.
3769 * @param value The double array data value.
3770 *
3771 * @return Returns the same Intent object, for chaining multiple calls
3772 * into a single statement.
3773 *
3774 * @see #putExtras
3775 * @see #removeExtra
3776 * @see #getDoubleArrayExtra(String)
3777 */
3778 public Intent putExtra(String name, double[] value) {
3779 if (mExtras == null) {
3780 mExtras = new Bundle();
3781 }
3782 mExtras.putDoubleArray(name, value);
3783 return this;
3784 }
3785
3786 /**
3787 * Add extended data to the intent. The name must include a package
3788 * prefix, for example the app com.android.contacts would use names
3789 * like "com.android.contacts.ShowAll".
3790 *
3791 * @param name The name of the extra data, with package prefix.
3792 * @param value The String array data value.
3793 *
3794 * @return Returns the same Intent object, for chaining multiple calls
3795 * into a single statement.
3796 *
3797 * @see #putExtras
3798 * @see #removeExtra
3799 * @see #getStringArrayExtra(String)
3800 */
3801 public Intent putExtra(String name, String[] value) {
3802 if (mExtras == null) {
3803 mExtras = new Bundle();
3804 }
3805 mExtras.putStringArray(name, value);
3806 return this;
3807 }
3808
3809 /**
3810 * Add extended data to the intent. The name must include a package
3811 * prefix, for example the app com.android.contacts would use names
3812 * like "com.android.contacts.ShowAll".
3813 *
3814 * @param name The name of the extra data, with package prefix.
3815 * @param value The Bundle data value.
3816 *
3817 * @return Returns the same Intent object, for chaining multiple calls
3818 * into a single statement.
3819 *
3820 * @see #putExtras
3821 * @see #removeExtra
3822 * @see #getBundleExtra(String)
3823 */
3824 public Intent putExtra(String name, Bundle value) {
3825 if (mExtras == null) {
3826 mExtras = new Bundle();
3827 }
3828 mExtras.putBundle(name, value);
3829 return this;
3830 }
3831
3832 /**
3833 * Add extended data to the intent. The name must include a package
3834 * prefix, for example the app com.android.contacts would use names
3835 * like "com.android.contacts.ShowAll".
3836 *
3837 * @param name The name of the extra data, with package prefix.
3838 * @param value The IBinder data value.
3839 *
3840 * @return Returns the same Intent object, for chaining multiple calls
3841 * into a single statement.
3842 *
3843 * @see #putExtras
3844 * @see #removeExtra
3845 * @see #getIBinderExtra(String)
3846 *
3847 * @deprecated
3848 * @hide
3849 */
3850 @Deprecated
3851 public Intent putExtra(String name, IBinder value) {
3852 if (mExtras == null) {
3853 mExtras = new Bundle();
3854 }
3855 mExtras.putIBinder(name, value);
3856 return this;
3857 }
3858
3859 /**
3860 * Copy all extras in 'src' in to this intent.
3861 *
3862 * @param src Contains the extras to copy.
3863 *
3864 * @see #putExtra
3865 */
3866 public Intent putExtras(Intent src) {
3867 if (src.mExtras != null) {
3868 if (mExtras == null) {
3869 mExtras = new Bundle(src.mExtras);
3870 } else {
3871 mExtras.putAll(src.mExtras);
3872 }
3873 }
3874 return this;
3875 }
3876
3877 /**
3878 * Add a set of extended data to the intent. The keys must include a package
3879 * prefix, for example the app com.android.contacts would use names
3880 * like "com.android.contacts.ShowAll".
3881 *
3882 * @param extras The Bundle of extras to add to this intent.
3883 *
3884 * @see #putExtra
3885 * @see #removeExtra
3886 */
3887 public Intent putExtras(Bundle extras) {
3888 if (mExtras == null) {
3889 mExtras = new Bundle();
3890 }
3891 mExtras.putAll(extras);
3892 return this;
3893 }
3894
3895 /**
3896 * Completely replace the extras in the Intent with the extras in the
3897 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07003898 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003899 * @param src The exact extras contained in this Intent are copied
3900 * into the target intent, replacing any that were previously there.
3901 */
3902 public Intent replaceExtras(Intent src) {
3903 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
3904 return this;
3905 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003906
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003907 /**
3908 * Completely replace the extras in the Intent with the given Bundle of
3909 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07003910 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003911 * @param extras The new set of extras in the Intent, or null to erase
3912 * all extras.
3913 */
3914 public Intent replaceExtras(Bundle extras) {
3915 mExtras = extras != null ? new Bundle(extras) : null;
3916 return this;
3917 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003918
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003919 /**
3920 * Remove extended data from the intent.
3921 *
3922 * @see #putExtra
3923 */
3924 public void removeExtra(String name) {
3925 if (mExtras != null) {
3926 mExtras.remove(name);
3927 if (mExtras.size() == 0) {
3928 mExtras = null;
3929 }
3930 }
3931 }
3932
3933 /**
3934 * Set special flags controlling how this intent is handled. Most values
3935 * here depend on the type of component being executed by the Intent,
3936 * specifically the FLAG_ACTIVITY_* flags are all for use with
3937 * {@link Context#startActivity Context.startActivity()} and the
3938 * FLAG_RECEIVER_* flags are all for use with
3939 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
3940 *
3941 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
3942 * Activities and Tasks</a> documentation for important information on how some of these options impact
3943 * the behavior of your application.
3944 *
3945 * @param flags The desired flags.
3946 *
3947 * @return Returns the same Intent object, for chaining multiple calls
3948 * into a single statement.
3949 *
3950 * @see #getFlags
3951 * @see #addFlags
3952 *
3953 * @see #FLAG_GRANT_READ_URI_PERMISSION
3954 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
3955 * @see #FLAG_DEBUG_LOG_RESOLUTION
3956 * @see #FLAG_FROM_BACKGROUND
3957 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
3958 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
3959 * @see #FLAG_ACTIVITY_CLEAR_TOP
3960 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
3961 * @see #FLAG_ACTIVITY_FORWARD_RESULT
3962 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
3963 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3964 * @see #FLAG_ACTIVITY_NEW_TASK
3965 * @see #FLAG_ACTIVITY_NO_HISTORY
3966 * @see #FLAG_ACTIVITY_NO_USER_ACTION
3967 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
3968 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
3969 * @see #FLAG_ACTIVITY_SINGLE_TOP
3970 * @see #FLAG_RECEIVER_REGISTERED_ONLY
3971 */
3972 public Intent setFlags(int flags) {
3973 mFlags = flags;
3974 return this;
3975 }
3976
3977 /**
3978 * Add additional flags to the intent (or with existing flags
3979 * value).
3980 *
3981 * @param flags The new flags to set.
3982 *
3983 * @return Returns the same Intent object, for chaining multiple calls
3984 * into a single statement.
3985 *
3986 * @see #setFlags
3987 */
3988 public Intent addFlags(int flags) {
3989 mFlags |= flags;
3990 return this;
3991 }
3992
3993 /**
3994 * (Usually optional) Explicitly set the component to handle the intent.
3995 * If left with the default value of null, the system will determine the
3996 * appropriate class to use based on the other fields (action, data,
3997 * type, categories) in the Intent. If this class is defined, the
3998 * specified class will always be used regardless of the other fields. You
3999 * should only set this value when you know you absolutely want a specific
4000 * class to be used; otherwise it is better to let the system find the
4001 * appropriate class so that you will respect the installed applications
4002 * and user preferences.
4003 *
4004 * @param component The name of the application component to handle the
4005 * intent, or null to let the system find one for you.
4006 *
4007 * @return Returns the same Intent object, for chaining multiple calls
4008 * into a single statement.
4009 *
4010 * @see #setClass
4011 * @see #setClassName(Context, String)
4012 * @see #setClassName(String, String)
4013 * @see #getComponent
4014 * @see #resolveActivity
4015 */
4016 public Intent setComponent(ComponentName component) {
4017 mComponent = component;
4018 return this;
4019 }
4020
4021 /**
4022 * Convenience for calling {@link #setComponent} with an
4023 * explicit class name.
4024 *
4025 * @param packageContext A Context of the application package implementing
4026 * this class.
4027 * @param className The name of a class inside of the application package
4028 * that will be used as the component for this Intent.
4029 *
4030 * @return Returns the same Intent object, for chaining multiple calls
4031 * into a single statement.
4032 *
4033 * @see #setComponent
4034 * @see #setClass
4035 */
4036 public Intent setClassName(Context packageContext, String className) {
4037 mComponent = new ComponentName(packageContext, className);
4038 return this;
4039 }
4040
4041 /**
4042 * Convenience for calling {@link #setComponent} with an
4043 * explicit application package name and class name.
4044 *
4045 * @param packageName The name of the package implementing the desired
4046 * component.
4047 * @param className The name of a class inside of the application package
4048 * that will be used as the component for this Intent.
4049 *
4050 * @return Returns the same Intent object, for chaining multiple calls
4051 * into a single statement.
4052 *
4053 * @see #setComponent
4054 * @see #setClass
4055 */
4056 public Intent setClassName(String packageName, String className) {
4057 mComponent = new ComponentName(packageName, className);
4058 return this;
4059 }
4060
4061 /**
4062 * Convenience for calling {@link #setComponent(ComponentName)} with the
4063 * name returned by a {@link Class} object.
4064 *
4065 * @param packageContext A Context of the application package implementing
4066 * this class.
4067 * @param cls The class name to set, equivalent to
4068 * <code>setClassName(context, cls.getName())</code>.
4069 *
4070 * @return Returns the same Intent object, for chaining multiple calls
4071 * into a single statement.
4072 *
4073 * @see #setComponent
4074 */
4075 public Intent setClass(Context packageContext, Class<?> cls) {
4076 mComponent = new ComponentName(packageContext, cls);
4077 return this;
4078 }
4079
4080 /**
4081 * Use with {@link #fillIn} to allow the current action value to be
4082 * overwritten, even if it is already set.
4083 */
4084 public static final int FILL_IN_ACTION = 1<<0;
4085
4086 /**
4087 * Use with {@link #fillIn} to allow the current data or type value
4088 * overwritten, even if it is already set.
4089 */
4090 public static final int FILL_IN_DATA = 1<<1;
4091
4092 /**
4093 * Use with {@link #fillIn} to allow the current categories to be
4094 * overwritten, even if they are already set.
4095 */
4096 public static final int FILL_IN_CATEGORIES = 1<<2;
4097
4098 /**
4099 * Use with {@link #fillIn} to allow the current component value to be
4100 * overwritten, even if it is already set.
4101 */
4102 public static final int FILL_IN_COMPONENT = 1<<3;
4103
4104 /**
4105 * Copy the contents of <var>other</var> in to this object, but only
4106 * where fields are not defined by this object. For purposes of a field
4107 * being defined, the following pieces of data in the Intent are
4108 * considered to be separate fields:
4109 *
4110 * <ul>
4111 * <li> action, as set by {@link #setAction}.
4112 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4113 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4114 * <li> categories, as set by {@link #addCategory}.
4115 * <li> component, as set by {@link #setComponent(ComponentName)} or
4116 * related methods.
4117 * <li> each top-level name in the associated extras.
4118 * </ul>
4119 *
4120 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
4121 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, and
4122 * {@link #FILL_IN_COMPONENT} to override the restriction where the
4123 * corresponding field will not be replaced if it is already set.
4124 *
4125 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4126 * and Intent B with {action="gotit", data-type="some/thing",
4127 * categories="one","two"}.
4128 *
4129 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4130 * containing: {action="gotit", data-type="some/thing",
4131 * categories="bar"}.
4132 *
4133 * @param other Another Intent whose values are to be used to fill in
4134 * the current one.
4135 * @param flags Options to control which fields can be filled in.
4136 *
4137 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
4138 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, and
4139 * {@link #FILL_IN_COMPONENT} indicating which fields were changed.
4140 */
4141 public int fillIn(Intent other, int flags) {
4142 int changes = 0;
4143 if ((mAction == null && other.mAction == null)
4144 || (flags&FILL_IN_ACTION) != 0) {
4145 mAction = other.mAction;
4146 changes |= FILL_IN_ACTION;
4147 }
4148 if ((mData == null && mType == null &&
4149 (other.mData != null || other.mType != null))
4150 || (flags&FILL_IN_DATA) != 0) {
4151 mData = other.mData;
4152 mType = other.mType;
4153 changes |= FILL_IN_DATA;
4154 }
4155 if ((mCategories == null && other.mCategories == null)
4156 || (flags&FILL_IN_CATEGORIES) != 0) {
4157 if (other.mCategories != null) {
4158 mCategories = new HashSet<String>(other.mCategories);
4159 }
4160 changes |= FILL_IN_CATEGORIES;
4161 }
4162 if ((mComponent == null && other.mComponent == null)
4163 || (flags&FILL_IN_COMPONENT) != 0) {
4164 mComponent = other.mComponent;
4165 changes |= FILL_IN_COMPONENT;
4166 }
4167 mFlags |= other.mFlags;
4168 if (mExtras == null) {
4169 if (other.mExtras != null) {
4170 mExtras = new Bundle(other.mExtras);
4171 }
4172 } else if (other.mExtras != null) {
4173 try {
4174 Bundle newb = new Bundle(other.mExtras);
4175 newb.putAll(mExtras);
4176 mExtras = newb;
4177 } catch (RuntimeException e) {
4178 // Modifying the extras can cause us to unparcel the contents
4179 // of the bundle, and if we do this in the system process that
4180 // may fail. We really should handle this (i.e., the Bundle
4181 // impl shouldn't be on top of a plain map), but for now just
4182 // ignore it and keep the original contents. :(
4183 Log.w("Intent", "Failure filling in extras", e);
4184 }
4185 }
4186 return changes;
4187 }
4188
4189 /**
4190 * Wrapper class holding an Intent and implementing comparisons on it for
4191 * the purpose of filtering. The class implements its
4192 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4193 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4194 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4195 * on the wrapped Intent.
4196 */
4197 public static final class FilterComparison {
4198 private final Intent mIntent;
4199 private final int mHashCode;
4200
4201 public FilterComparison(Intent intent) {
4202 mIntent = intent;
4203 mHashCode = intent.filterHashCode();
4204 }
4205
4206 /**
4207 * Return the Intent that this FilterComparison represents.
4208 * @return Returns the Intent held by the FilterComparison. Do
4209 * not modify!
4210 */
4211 public Intent getIntent() {
4212 return mIntent;
4213 }
4214
4215 @Override
4216 public boolean equals(Object obj) {
4217 if (obj instanceof FilterComparison) {
4218 Intent other = ((FilterComparison)obj).mIntent;
4219 return mIntent.filterEquals(other);
4220 }
4221 return false;
4222 }
4223
4224 @Override
4225 public int hashCode() {
4226 return mHashCode;
4227 }
4228 }
4229
4230 /**
4231 * Determine if two intents are the same for the purposes of intent
4232 * resolution (filtering). That is, if their action, data, type,
4233 * class, and categories are the same. This does <em>not</em> compare
4234 * any extra data included in the intents.
4235 *
4236 * @param other The other Intent to compare against.
4237 *
4238 * @return Returns true if action, data, type, class, and categories
4239 * are the same.
4240 */
4241 public boolean filterEquals(Intent other) {
4242 if (other == null) {
4243 return false;
4244 }
4245 if (mAction != other.mAction) {
4246 if (mAction != null) {
4247 if (!mAction.equals(other.mAction)) {
4248 return false;
4249 }
4250 } else {
4251 if (!other.mAction.equals(mAction)) {
4252 return false;
4253 }
4254 }
4255 }
4256 if (mData != other.mData) {
4257 if (mData != null) {
4258 if (!mData.equals(other.mData)) {
4259 return false;
4260 }
4261 } else {
4262 if (!other.mData.equals(mData)) {
4263 return false;
4264 }
4265 }
4266 }
4267 if (mType != other.mType) {
4268 if (mType != null) {
4269 if (!mType.equals(other.mType)) {
4270 return false;
4271 }
4272 } else {
4273 if (!other.mType.equals(mType)) {
4274 return false;
4275 }
4276 }
4277 }
4278 if (mComponent != other.mComponent) {
4279 if (mComponent != null) {
4280 if (!mComponent.equals(other.mComponent)) {
4281 return false;
4282 }
4283 } else {
4284 if (!other.mComponent.equals(mComponent)) {
4285 return false;
4286 }
4287 }
4288 }
4289 if (mCategories != other.mCategories) {
4290 if (mCategories != null) {
4291 if (!mCategories.equals(other.mCategories)) {
4292 return false;
4293 }
4294 } else {
4295 if (!other.mCategories.equals(mCategories)) {
4296 return false;
4297 }
4298 }
4299 }
4300
4301 return true;
4302 }
4303
4304 /**
4305 * Generate hash code that matches semantics of filterEquals().
4306 *
4307 * @return Returns the hash value of the action, data, type, class, and
4308 * categories.
4309 *
4310 * @see #filterEquals
4311 */
4312 public int filterHashCode() {
4313 int code = 0;
4314 if (mAction != null) {
4315 code += mAction.hashCode();
4316 }
4317 if (mData != null) {
4318 code += mData.hashCode();
4319 }
4320 if (mType != null) {
4321 code += mType.hashCode();
4322 }
4323 if (mComponent != null) {
4324 code += mComponent.hashCode();
4325 }
4326 if (mCategories != null) {
4327 code += mCategories.hashCode();
4328 }
4329 return code;
4330 }
4331
4332 @Override
4333 public String toString() {
4334 StringBuilder b = new StringBuilder();
4335
4336 b.append("Intent {");
4337 if (mAction != null) b.append(" action=").append(mAction);
4338 if (mCategories != null) {
4339 b.append(" categories={");
4340 Iterator<String> i = mCategories.iterator();
4341 boolean didone = false;
4342 while (i.hasNext()) {
4343 if (didone) b.append(",");
4344 didone = true;
4345 b.append(i.next());
4346 }
4347 b.append("}");
4348 }
4349 if (mData != null) b.append(" data=").append(mData);
4350 if (mType != null) b.append(" type=").append(mType);
4351 if (mFlags != 0) b.append(" flags=0x").append(Integer.toHexString(mFlags));
4352 if (mComponent != null) b.append(" comp=").append(mComponent.toShortString());
4353 if (mExtras != null) b.append(" (has extras)");
4354 b.append(" }");
4355
4356 return b.toString();
4357 }
4358
4359 public String toURI() {
4360 StringBuilder uri = new StringBuilder(mData != null ? mData.toString() : "");
4361
4362 uri.append("#Intent;");
4363
4364 if (mAction != null) {
4365 uri.append("action=").append(mAction).append(';');
4366 }
4367 if (mCategories != null) {
4368 for (String category : mCategories) {
4369 uri.append("category=").append(category).append(';');
4370 }
4371 }
4372 if (mType != null) {
4373 uri.append("type=").append(mType).append(';');
4374 }
4375 if (mFlags != 0) {
4376 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
4377 }
4378 if (mComponent != null) {
4379 uri.append("component=").append(mComponent.flattenToShortString()).append(';');
4380 }
4381 if (mExtras != null) {
4382 for (String key : mExtras.keySet()) {
4383 final Object value = mExtras.get(key);
4384 char entryType =
4385 value instanceof String ? 'S' :
4386 value instanceof Boolean ? 'B' :
4387 value instanceof Byte ? 'b' :
4388 value instanceof Character ? 'c' :
4389 value instanceof Double ? 'd' :
4390 value instanceof Float ? 'f' :
4391 value instanceof Integer ? 'i' :
4392 value instanceof Long ? 'l' :
4393 value instanceof Short ? 's' :
4394 '\0';
4395
4396 if (entryType != '\0') {
4397 uri.append(entryType);
4398 uri.append('.');
4399 uri.append(Uri.encode(key));
4400 uri.append('=');
4401 uri.append(Uri.encode(value.toString()));
4402 uri.append(';');
4403 }
4404 }
4405 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004406
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004407 uri.append("end");
4408
4409 return uri.toString();
4410 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004411
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004412 public int describeContents() {
4413 return (mExtras != null) ? mExtras.describeContents() : 0;
4414 }
4415
4416 public void writeToParcel(Parcel out, int flags) {
4417 out.writeString(mAction);
4418 Uri.writeToParcel(out, mData);
4419 out.writeString(mType);
4420 out.writeInt(mFlags);
4421 ComponentName.writeToParcel(mComponent, out);
4422
4423 if (mCategories != null) {
4424 out.writeInt(mCategories.size());
4425 for (String category : mCategories) {
4426 out.writeString(category);
4427 }
4428 } else {
4429 out.writeInt(0);
4430 }
4431
4432 out.writeBundle(mExtras);
4433 }
4434
4435 public static final Parcelable.Creator<Intent> CREATOR
4436 = new Parcelable.Creator<Intent>() {
4437 public Intent createFromParcel(Parcel in) {
4438 return new Intent(in);
4439 }
4440 public Intent[] newArray(int size) {
4441 return new Intent[size];
4442 }
4443 };
4444
4445 private Intent(Parcel in) {
4446 readFromParcel(in);
4447 }
4448
4449 public void readFromParcel(Parcel in) {
4450 mAction = in.readString();
4451 mData = Uri.CREATOR.createFromParcel(in);
4452 mType = in.readString();
4453 mFlags = in.readInt();
4454 mComponent = ComponentName.readFromParcel(in);
4455
4456 int N = in.readInt();
4457 if (N > 0) {
4458 mCategories = new HashSet<String>();
4459 int i;
4460 for (i=0; i<N; i++) {
4461 mCategories.add(in.readString());
4462 }
4463 } else {
4464 mCategories = null;
4465 }
4466
4467 mExtras = in.readBundle();
4468 }
4469
4470 /**
4471 * Parses the "intent" element (and its children) from XML and instantiates
4472 * an Intent object. The given XML parser should be located at the tag
4473 * where parsing should start (often named "intent"), from which the
4474 * basic action, data, type, and package and class name will be
4475 * retrieved. The function will then parse in to any child elements,
4476 * looking for <category android:name="xxx"> tags to add categories and
4477 * <extra android:name="xxx" android:value="yyy"> to attach extra data
4478 * to the intent.
4479 *
4480 * @param resources The Resources to use when inflating resources.
4481 * @param parser The XML parser pointing at an "intent" tag.
4482 * @param attrs The AttributeSet interface for retrieving extended
4483 * attribute data at the current <var>parser</var> location.
4484 * @return An Intent object matching the XML data.
4485 * @throws XmlPullParserException If there was an XML parsing error.
4486 * @throws IOException If there was an I/O error.
4487 */
4488 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
4489 throws XmlPullParserException, IOException {
4490 Intent intent = new Intent();
4491
4492 TypedArray sa = resources.obtainAttributes(attrs,
4493 com.android.internal.R.styleable.Intent);
4494
4495 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
4496
4497 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
4498 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
4499 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
4500
4501 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
4502 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
4503 if (packageName != null && className != null) {
4504 intent.setComponent(new ComponentName(packageName, className));
4505 }
4506
4507 sa.recycle();
4508
4509 int outerDepth = parser.getDepth();
4510 int type;
4511 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
4512 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
4513 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
4514 continue;
4515 }
4516
4517 String nodeName = parser.getName();
4518 if (nodeName.equals("category")) {
4519 sa = resources.obtainAttributes(attrs,
4520 com.android.internal.R.styleable.IntentCategory);
4521 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
4522 sa.recycle();
4523
4524 if (cat != null) {
4525 intent.addCategory(cat);
4526 }
4527 XmlUtils.skipCurrentTag(parser);
4528
4529 } else if (nodeName.equals("extra")) {
4530 if (intent.mExtras == null) {
4531 intent.mExtras = new Bundle();
4532 }
4533 resources.parseBundleExtra("extra", attrs, intent.mExtras);
4534 XmlUtils.skipCurrentTag(parser);
4535
4536 } else {
4537 XmlUtils.skipCurrentTag(parser);
4538 }
4539 }
4540
4541 return intent;
4542 }
4543}