blob: 306c02eca3d82217897b6df392325b9ffc89c1d7 [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
1128 * device. The data contains the name of the package.
1129 * <p>My include the following extras:
1130 * <ul>
1131 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1132 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1133 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1134 * </ul>
1135 */
1136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1137 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1138 /**
1139 * Broadcast Action: An existing application package has been removed from
1140 * the device. The data contains the name of the package. The package
1141 * that is being installed does <em>not</em> receive this Intent.
1142 * <ul>
1143 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1144 * to the package.
1145 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1146 * application -- data and code -- is being removed.
1147 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1148 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1149 * </ul>
1150 */
1151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1152 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1153 /**
1154 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1155 * enabled or disabled. The data contains the name of the package.
1156 * <ul>
1157 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1158 * </ul>
1159 */
1160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1161 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1162 /**
1163 * Broadcast Action: The user has restarted a package, and all of its
1164 * processes have been killed. All runtime state
1165 * associated with it (processes, alarms, notifications, etc) should
1166 * be removed. The data contains the name of the package.
1167 * <ul>
1168 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1169 * </ul>
1170 */
1171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1172 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1173 /**
1174 * Broadcast Action: The user has cleared the data of a package. This should
1175 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
1176 * its persistent data is erased and this broadcast sent. The data contains
1177 * the name of the package.
1178 * <ul>
1179 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1180 * </ul>
1181 */
1182 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1183 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1184 /**
1185 * Broadcast Action: A user ID has been removed from the system. The user
1186 * ID number is stored in the extra data under {@link #EXTRA_UID}.
1187 */
1188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1189 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1190 /**
1191 * Broadcast Action: The current system wallpaper has changed. See
1192 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1193 */
1194 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1195 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1196 /**
1197 * Broadcast Action: The current device {@link android.content.res.Configuration}
1198 * (orientation, locale, etc) has changed. When such a change happens, the
1199 * UIs (view hierarchy) will need to be rebuilt based on this new
1200 * information; for the most part, applications don't need to worry about
1201 * this, because the system will take care of stopping and restarting the
1202 * application to make sure it sees the new changes. Some system code that
1203 * can not be restarted will need to watch for this action and handle it
1204 * appropriately.
1205 *
1206 * @see android.content.res.Configuration
1207 */
1208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1209 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1210 /**
1211 * Broadcast Action: The charging state, or charge level of the battery has
1212 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001213 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001214 * <p class="note">
1215 * You can <em>not</em> receive this through components declared
1216 * in manifests, only by exlicitly registering for it with
1217 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1218 * Context.registerReceiver()}.
1219 */
1220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1221 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1222 /**
1223 * Broadcast Action: Indicates low battery condition on the device.
1224 * This broadcast corresponds to the "Low battery warning" system dialog.
1225 */
1226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1227 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1228 /**
1229 * Broadcast Action: Indicates low memory condition on the device
1230 */
1231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1232 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1233 /**
1234 * Broadcast Action: Indicates low memory condition on the device no longer exists
1235 */
1236 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1237 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1238 /**
1239 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1240 * and package management should be started.
1241 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1242 * notification.
1243 */
1244 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1245 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1246 /**
1247 * Broadcast Action: The device has entered USB Mass Storage mode.
1248 * This is used mainly for the USB Settings panel.
1249 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1250 * when the SD card file system is mounted or unmounted
1251 */
1252 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1253 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1254
1255 /**
1256 * Broadcast Action: The device has exited USB Mass Storage mode.
1257 * This is used mainly for the USB Settings panel.
1258 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1259 * when the SD card file system is mounted or unmounted
1260 */
1261 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1262 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1263
1264 /**
1265 * Broadcast Action: External media has been removed.
1266 * The path to the mount point for the removed media is contained in the Intent.mData field.
1267 */
1268 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1269 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1270
1271 /**
1272 * Broadcast Action: External media is present, but not mounted at its mount point.
1273 * The path to the mount point for the removed media is contained in the Intent.mData field.
1274 */
1275 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1276 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1277
1278 /**
1279 * Broadcast Action: External media is present, and being disk-checked
1280 * The path to the mount point for the checking media is contained in the Intent.mData field.
1281 */
1282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1283 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1284
1285 /**
1286 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1287 * The path to the mount point for the checking media is contained in the Intent.mData field.
1288 */
1289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1290 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1291
1292 /**
1293 * Broadcast Action: External media is present and mounted at its mount point.
1294 * The path to the mount point for the removed media is contained in the Intent.mData field.
1295 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1296 * media was mounted read only.
1297 */
1298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1299 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1300
1301 /**
1302 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1303 * The path to the mount point for the removed media is contained in the Intent.mData field.
1304 */
1305 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1306 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1307
1308 /**
1309 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1310 * The path to the mount point for the removed media is contained in the Intent.mData field.
1311 */
1312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1313 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1314
1315 /**
1316 * Broadcast Action: External media is present but cannot be mounted.
1317 * The path to the mount point for the removed media is contained in the Intent.mData field.
1318 */
1319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1320 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1321
1322 /**
1323 * Broadcast Action: User has expressed the desire to remove the external storage media.
1324 * Applications should close all files they have open within the mount point when they receive this intent.
1325 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1326 */
1327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1328 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1329
1330 /**
1331 * Broadcast Action: The media scanner has started scanning a directory.
1332 * The path to the directory being scanned is contained in the Intent.mData field.
1333 */
1334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1335 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1336
1337 /**
1338 * Broadcast Action: The media scanner has finished scanning a directory.
1339 * The path to the scanned directory is contained in the Intent.mData field.
1340 */
1341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1342 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1343
1344 /**
1345 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1346 * The path to the file is contained in the Intent.mData field.
1347 */
1348 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1349 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1350
1351 /**
1352 * Broadcast Action: The "Media Button" was pressed. Includes a single
1353 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1354 * caused the broadcast.
1355 */
1356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1357 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1358
1359 /**
1360 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1361 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1362 * caused the broadcast.
1363 */
1364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1365 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1366
1367 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1368 // location; they are not general-purpose actions.
1369
1370 /**
1371 * Broadcast Action: An GTalk connection has been established.
1372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1375 "android.intent.action.GTALK_CONNECTED";
1376
1377 /**
1378 * Broadcast Action: An GTalk connection has been disconnected.
1379 */
1380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1381 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1382 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001383
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001384 /**
1385 * Broadcast Action: An input method has been changed.
1386 * {@hide pending API Council approval}
1387 */
1388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1389 public static final String ACTION_INPUT_METHOD_CHANGED =
1390 "android.intent.action.INPUT_METHOD_CHANGED";
1391
1392 /**
1393 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1394 * more radios have been turned off or on. The intent will have the following extra value:</p>
1395 * <ul>
1396 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1397 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1398 * turned off</li>
1399 * </ul>
1400 */
1401 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1402 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1403
1404 /**
1405 * Broadcast Action: Some content providers have parts of their namespace
1406 * where they publish new events or items that the user may be especially
1407 * interested in. For these things, they may broadcast this action when the
1408 * set of interesting items change.
1409 *
1410 * For example, GmailProvider sends this notification when the set of unread
1411 * mail in the inbox changes.
1412 *
1413 * <p>The data of the intent identifies which part of which provider
1414 * changed. When queried through the content resolver, the data URI will
1415 * return the data set in question.
1416 *
1417 * <p>The intent will have the following extra values:
1418 * <ul>
1419 * <li><em>count</em> - The number of items in the data set. This is the
1420 * same as the number of items in the cursor returned by querying the
1421 * data URI. </li>
1422 * </ul>
1423 *
1424 * This intent will be sent at boot (if the count is non-zero) and when the
1425 * data set changes. It is possible for the data set to change without the
1426 * count changing (for example, if a new unread message arrives in the same
1427 * sync operation in which a message is archived). The phone should still
1428 * ring/vibrate/etc as normal in this case.
1429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_PROVIDER_CHANGED =
1432 "android.intent.action.PROVIDER_CHANGED";
1433
1434 /**
1435 * Broadcast Action: Wired Headset plugged in or unplugged.
1436 *
1437 * <p>The intent will have the following extra values:
1438 * <ul>
1439 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1440 * <li><em>name</em> - Headset type, human readable string </li>
1441 * </ul>
1442 * </ul>
1443 */
1444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1445 public static final String ACTION_HEADSET_PLUG =
1446 "android.intent.action.HEADSET_PLUG";
1447
1448 /**
1449 * Broadcast Action: An outgoing call is about to be placed.
1450 *
1451 * <p>The Intent will have the following extra value:
1452 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001453 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001454 * the phone number originally intended to be dialed.</li>
1455 * </ul>
1456 * <p>Once the broadcast is finished, the resultData is used as the actual
1457 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001458 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001459 * outgoing call in turn: for example, a parental control application
1460 * might verify that the user is authorized to place the call at that
1461 * time, then a number-rewriting application might add an area code if
1462 * one was not specified.</p>
1463 * <p>For consistency, any receiver whose purpose is to prohibit phone
1464 * calls should have a priority of 0, to ensure it will see the final
1465 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001466 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001467 * should have a positive priority.
1468 * Negative priorities are reserved for the system for this broadcast;
1469 * using them may cause problems.</p>
1470 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1471 * abort the broadcast.</p>
1472 * <p>Emergency calls cannot be intercepted using this mechanism, and
1473 * other calls cannot be modified to call emergency numbers using this
1474 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001475 * <p>You must hold the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001476 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1477 * permission to receive this Intent.</p>
1478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_NEW_OUTGOING_CALL =
1481 "android.intent.action.NEW_OUTGOING_CALL";
1482
1483 /**
1484 * Broadcast Action: Have the device reboot. This is only for use by
1485 * system code.
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_REBOOT =
1489 "android.intent.action.REBOOT";
1490
1491 // ---------------------------------------------------------------------
1492 // ---------------------------------------------------------------------
1493 // Standard intent categories (see addCategory()).
1494
1495 /**
1496 * Set if the activity should be an option for the default action
1497 * (center press) to perform on a piece of data. Setting this will
1498 * hide from the user any activities without it set when performing an
1499 * action on some data. Note that this is normal -not- set in the
1500 * Intent when initiating an action -- it is for use in intent filters
1501 * specified in packages.
1502 */
1503 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1504 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1505 /**
1506 * Activities that can be safely invoked from a browser must support this
1507 * category. For example, if the user is viewing a web page or an e-mail
1508 * and clicks on a link in the text, the Intent generated execute that
1509 * link will require the BROWSABLE category, so that only activities
1510 * supporting this category will be considered as possible actions. By
1511 * supporting this category, you are promising that there is nothing
1512 * damaging (without user intervention) that can happen by invoking any
1513 * matching Intent.
1514 */
1515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1516 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1517 /**
1518 * Set if the activity should be considered as an alternative action to
1519 * the data the user is currently viewing. See also
1520 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1521 * applies to the selection in a list of items.
1522 *
1523 * <p>Supporting this category means that you would like your activity to be
1524 * displayed in the set of alternative things the user can do, usually as
1525 * part of the current activity's options menu. You will usually want to
1526 * include a specific label in the &lt;intent-filter&gt; of this action
1527 * describing to the user what it does.
1528 *
1529 * <p>The action of IntentFilter with this category is important in that it
1530 * describes the specific action the target will perform. This generally
1531 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1532 * a specific name such as "com.android.camera.action.CROP. Only one
1533 * alternative of any particular action will be shown to the user, so using
1534 * a specific action like this makes sure that your alternative will be
1535 * displayed while also allowing other applications to provide their own
1536 * overrides of that particular action.
1537 */
1538 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1539 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1540 /**
1541 * Set if the activity should be considered as an alternative selection
1542 * action to the data the user has currently selected. This is like
1543 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1544 * of items from which the user can select, giving them alternatives to the
1545 * default action that will be performed on it.
1546 */
1547 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1548 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1549 /**
1550 * Intended to be used as a tab inside of an containing TabActivity.
1551 */
1552 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1553 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1554 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001555 * Should be displayed in the top-level launcher.
1556 */
1557 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1558 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1559 /**
1560 * Provides information about the package it is in; typically used if
1561 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1562 * a front-door to the user without having to be shown in the all apps list.
1563 */
1564 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1565 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1566 /**
1567 * This is the home activity, that is the first activity that is displayed
1568 * when the device boots.
1569 */
1570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1571 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1572 /**
1573 * This activity is a preference panel.
1574 */
1575 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1576 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1577 /**
1578 * This activity is a development preference panel.
1579 */
1580 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1581 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1582 /**
1583 * Capable of running inside a parent activity container.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001584 */
1585 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1586 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1587 /**
1588 * This activity may be exercised by the monkey or other automated test tools.
1589 */
1590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1591 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1592 /**
1593 * To be used as a test (not part of the normal user experience).
1594 */
1595 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1596 /**
1597 * To be used as a unit test (run through the Test Harness).
1598 */
1599 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1600 /**
1601 * To be used as an sample code example (not part of the normal user
1602 * experience).
1603 */
1604 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1605 /**
1606 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1607 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1608 * when queried, though it is allowable for those columns to be blank.
1609 */
1610 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1611 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1612
1613 /**
1614 * To be used as code under test for framework instrumentation tests.
1615 */
1616 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1617 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
1618 // ---------------------------------------------------------------------
1619 // ---------------------------------------------------------------------
1620 // Standard extra data keys.
1621
1622 /**
1623 * The initial data to place in a newly created record. Use with
1624 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1625 * fields as would be given to the underlying ContentProvider.insert()
1626 * call.
1627 */
1628 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1629
1630 /**
1631 * A constant CharSequence that is associated with the Intent, used with
1632 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1633 * this may be a styled CharSequence, so you must use
1634 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1635 * retrieve it.
1636 */
1637 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1638
1639 /**
1640 * A content: URI holding a stream of data associated with the Intent,
1641 * used with {@link #ACTION_SEND} to supply the data being sent.
1642 */
1643 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1644
1645 /**
1646 * A String[] holding e-mail addresses that should be delivered to.
1647 */
1648 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1649
1650 /**
1651 * A String[] holding e-mail addresses that should be carbon copied.
1652 */
1653 public static final String EXTRA_CC = "android.intent.extra.CC";
1654
1655 /**
1656 * A String[] holding e-mail addresses that should be blind carbon copied.
1657 */
1658 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1659
1660 /**
1661 * A constant string holding the desired subject line of a message.
1662 */
1663 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1664
1665 /**
1666 * An Intent describing the choices you would like shown with
1667 * {@link #ACTION_PICK_ACTIVITY}.
1668 */
1669 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1670
1671 /**
1672 * A CharSequence dialog title to provide to the user when used with a
1673 * {@link #ACTION_CHOOSER}.
1674 */
1675 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1676
1677 /**
1678 * A {@link android.view.KeyEvent} object containing the event that
1679 * triggered the creation of the Intent it is in.
1680 */
1681 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1682
1683 /**
1684 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1685 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1686 * of restarting the application.
1687 */
1688 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1689
1690 /**
1691 * A String holding the phone number originally entered in
1692 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1693 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1694 */
1695 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1696 /**
1697 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1698 * intents to supply the uid the package had been assigned. Also an optional
1699 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1700 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1701 * purpose.
1702 */
1703 public static final String EXTRA_UID = "android.intent.extra.UID";
1704
1705 /**
1706 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1707 * intents to indicate whether this represents a full uninstall (removing
1708 * both the code and its data) or a partial uninstall (leaving its data,
1709 * implying that this is an update).
1710 */
1711 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001712
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001713 /**
1714 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1715 * intents to indicate that this is a replacement of the package, so this
1716 * broadcast will immediately be followed by an add broadcast for a
1717 * different version of the same package.
1718 */
1719 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001720
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001721 /**
1722 * Used as an int extra field in {@link android.app.AlarmManager} intents
1723 * to tell the application being invoked how many pending alarms are being
1724 * delievered with the intent. For one-shot alarms this will always be 1.
1725 * For recurring alarms, this might be greater than 1 if the device was
1726 * asleep or powered off at the time an earlier alarm would have been
1727 * delivered.
1728 */
1729 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
1730
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001731 // ---------------------------------------------------------------------
1732 // ---------------------------------------------------------------------
1733 // Intent flags (see mFlags variable).
1734
1735 /**
1736 * If set, the recipient of this Intent will be granted permission to
1737 * perform read operations on the Uri in the Intent's data.
1738 */
1739 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
1740 /**
1741 * If set, the recipient of this Intent will be granted permission to
1742 * perform write operations on the Uri in the Intent's data.
1743 */
1744 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
1745 /**
1746 * Can be set by the caller to indicate that this Intent is coming from
1747 * a background operation, not from direct user interaction.
1748 */
1749 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
1750 /**
1751 * A flag you can enable for debugging: when set, log messages will be
1752 * printed during the resolution of this intent to show you what has
1753 * been found to create the final resolved list.
1754 */
1755 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
1756
1757 /**
1758 * If set, the new activity is not kept in the history stack. As soon as
1759 * the user navigates away from it, the activity is finished. This may also
1760 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
1761 * noHistory} attribute.
1762 */
1763 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
1764 /**
1765 * If set, the activity will not be launched if it is already running
1766 * at the top of the history stack.
1767 */
1768 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
1769 /**
1770 * If set, this activity will become the start of a new task on this
1771 * history stack. A task (from the activity that started it to the
1772 * next task activity) defines an atomic group of activities that the
1773 * user can move to. Tasks can be moved to the foreground and background;
1774 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07001775 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001776 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1777 * Activities and Tasks</a> for more details on tasks.
1778 *
1779 * <p>This flag is generally used by activities that want
1780 * to present a "launcher" style behavior: they give the user a list of
1781 * separate things that can be done, which otherwise run completely
1782 * independently of the activity launching them.
1783 *
1784 * <p>When using this flag, if a task is already running for the activity
1785 * you are now starting, then a new activity will not be started; instead,
1786 * the current task will simply be brought to the front of the screen with
1787 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
1788 * to disable this behavior.
1789 *
1790 * <p>This flag can not be used when the caller is requesting a result from
1791 * the activity being launched.
1792 */
1793 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
1794 /**
1795 * <strong>Do not use this flag unless you are implementing your own
1796 * top-level application launcher.</strong> Used in conjunction with
1797 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
1798 * behavior of bringing an existing task to the foreground. When set,
1799 * a new task is <em>always</em> started to host the Activity for the
1800 * Intent, regardless of whether there is already an existing task running
1801 * the same thing.
1802 *
1803 * <p><strong>Because the default system does not include graphical task management,
1804 * you should not use this flag unless you provide some way for a user to
1805 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07001806 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001807 * <p>This flag is ignored if
1808 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
1809 *
1810 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1811 * Activities and Tasks</a> for more details on tasks.
1812 */
1813 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
1814 /**
1815 * If set, and the activity being launched is already running in the
1816 * current task, then instead of launching a new instance of that activity,
1817 * all of the other activities on top of it will be closed and this Intent
1818 * will be delivered to the (now on top) old activity as a new Intent.
1819 *
1820 * <p>For example, consider a task consisting of the activities: A, B, C, D.
1821 * If D calls startActivity() with an Intent that resolves to the component
1822 * of activity B, then C and D will be finished and B receive the given
1823 * Intent, resulting in the stack now being: A, B.
1824 *
1825 * <p>The currently running instance of task B in the above example will
1826 * either receive the new intent you are starting here in its
1827 * onNewIntent() method, or be itself finished and restarted with the
1828 * new intent. If it has declared its launch mode to be "multiple" (the
1829 * default) it will be finished and re-created; for all other launch modes
1830 * it will receive the Intent in the current instance.
1831 *
1832 * <p>This launch mode can also be used to good effect in conjunction with
1833 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
1834 * of a task, it will bring any currently running instance of that task
1835 * to the foreground, and then clear it to its root state. This is
1836 * especially useful, for example, when launching an activity from the
1837 * notification manager.
1838 *
1839 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1840 * Activities and Tasks</a> for more details on tasks.
1841 */
1842 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
1843 /**
1844 * If set and this intent is being used to launch a new activity from an
1845 * existing one, then the reply target of the existing activity will be
1846 * transfered to the new activity. This way the new activity can call
1847 * {@link android.app.Activity#setResult} and have that result sent back to
1848 * the reply target of the original activity.
1849 */
1850 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
1851 /**
1852 * If set and this intent is being used to launch a new activity from an
1853 * existing one, the current activity will not be counted as the top
1854 * activity for deciding whether the new intent should be delivered to
1855 * the top instead of starting a new one. The previous activity will
1856 * be used as the top, with the assumption being that the current activity
1857 * will finish itself immediately.
1858 */
1859 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
1860 /**
1861 * If set, the new activity is not kept in the list of recently launched
1862 * activities.
1863 */
1864 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
1865 /**
1866 * This flag is not normally set by application code, but set for you by
1867 * the system as described in the
1868 * {@link android.R.styleable#AndroidManifestActivity_launchMode
1869 * launchMode} documentation for the singleTask mode.
1870 */
1871 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
1872 /**
1873 * If set, and this activity is either being started in a new task or
1874 * bringing to the top an existing task, then it will be launched as
1875 * the front door of the task. This will result in the application of
1876 * any affinities needed to have that task in the proper state (either
1877 * moving activities to or from it), or simply resetting that task to
1878 * its initial state if needed.
1879 */
1880 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
1881 /**
1882 * This flag is not normally set by application code, but set for you by
1883 * the system if this activity is being launched from history
1884 * (longpress home key).
1885 */
1886 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
1887 /**
1888 * If set, this marks a point in the task's activity stack that should
1889 * be cleared when the task is reset. That is, the next time the task
1890 * is broad to the foreground with
1891 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
1892 * the user re-launching it from home), this activity and all on top of
1893 * it will be finished so that the user does not return to them, but
1894 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07001895 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001896 * <p>This is useful for cases where you have a logical break in your
1897 * application. For example, an e-mail application may have a command
1898 * to view an attachment, which launches an image view activity to
1899 * display it. This activity should be part of the e-mail application's
1900 * task, since it is a part of the task the user is involved in. However,
1901 * if the user leaves that task, and later selects the e-mail app from
1902 * home, we may like them to return to the conversation they were
1903 * viewing, not the picture attachment, since that is confusing. By
1904 * setting this flag when launching the image viewer, that viewer and
1905 * any activities it starts will be removed the next time the user returns
1906 * to mail.
1907 */
1908 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
1909 /**
1910 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
1911 * callback from occurring on the current frontmost activity before it is
1912 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07001913 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001914 * <p>Typically, an activity can rely on that callback to indicate that an
1915 * explicit user action has caused their activity to be moved out of the
1916 * foreground. The callback marks an appropriate point in the activity's
1917 * lifecycle for it to dismiss any notifications that it intends to display
1918 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07001919 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001920 * <p>If an activity is ever started via any non-user-driven events such as
1921 * phone-call receipt or an alarm handler, this flag should be passed to {@link
1922 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07001923 * activity does not think the user has acknowledged its notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001924 */
1925 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
1926 /**
1927 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
1928 * this flag will cause the launched activity to be brought to the front of its
1929 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07001930 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001931 * <p>For example, consider a task consisting of four activities: A, B, C, D.
1932 * If D calls startActivity() with an Intent that resolves to the component
1933 * of activity B, then B will be brought to the front of the history stack,
1934 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07001935 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001936 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07001937 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001938 */
1939 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
1940 /**
1941 * If set, when sending a broadcast only registered receivers will be
1942 * called -- no BroadcastReceiver components will be launched.
1943 */
1944 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
1945 /**
1946 * If set, when sending a broadcast <i>before boot has completed</i> only
1947 * registered receivers will be called -- no BroadcastReceiver components
1948 * will be launched. Sticky intent state will be recorded properly even
1949 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
1950 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07001951 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001952 * <p>This flag is only for use by system sevices as a convenience to
1953 * avoid having to implement a more complex mechanism around detection
1954 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07001955 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001956 * @hide
1957 */
1958 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
1959
1960 // ---------------------------------------------------------------------
1961
1962 private String mAction;
1963 private Uri mData;
1964 private String mType;
1965 private ComponentName mComponent;
1966 private int mFlags;
1967 private HashSet<String> mCategories;
1968 private Bundle mExtras;
1969
1970 // ---------------------------------------------------------------------
1971
1972 /**
1973 * Create an empty intent.
1974 */
1975 public Intent() {
1976 }
1977
1978 /**
1979 * Copy constructor.
1980 */
1981 public Intent(Intent o) {
1982 this.mAction = o.mAction;
1983 this.mData = o.mData;
1984 this.mType = o.mType;
1985 this.mComponent = o.mComponent;
1986 this.mFlags = o.mFlags;
1987 if (o.mCategories != null) {
1988 this.mCategories = new HashSet<String>(o.mCategories);
1989 }
1990 if (o.mExtras != null) {
1991 this.mExtras = new Bundle(o.mExtras);
1992 }
1993 }
1994
1995 @Override
1996 public Object clone() {
1997 return new Intent(this);
1998 }
1999
2000 private Intent(Intent o, boolean all) {
2001 this.mAction = o.mAction;
2002 this.mData = o.mData;
2003 this.mType = o.mType;
2004 this.mComponent = o.mComponent;
2005 if (o.mCategories != null) {
2006 this.mCategories = new HashSet<String>(o.mCategories);
2007 }
2008 }
2009
2010 /**
2011 * Make a clone of only the parts of the Intent that are relevant for
2012 * filter matching: the action, data, type, component, and categories.
2013 */
2014 public Intent cloneFilter() {
2015 return new Intent(this, false);
2016 }
2017
2018 /**
2019 * Create an intent with a given action. All other fields (data, type,
2020 * class) are null. Note that the action <em>must</em> be in a
2021 * namespace because Intents are used globally in the system -- for
2022 * example the system VIEW action is android.intent.action.VIEW; an
2023 * application's custom action would be something like
2024 * com.google.app.myapp.CUSTOM_ACTION.
2025 *
2026 * @param action The Intent action, such as ACTION_VIEW.
2027 */
2028 public Intent(String action) {
2029 mAction = action;
2030 }
2031
2032 /**
2033 * Create an intent with a given action and for a given data url. Note
2034 * that the action <em>must</em> be in a namespace because Intents are
2035 * used globally in the system -- for example the system VIEW action is
2036 * android.intent.action.VIEW; an application's custom action would be
2037 * something like com.google.app.myapp.CUSTOM_ACTION.
2038 *
2039 * @param action The Intent action, such as ACTION_VIEW.
2040 * @param uri The Intent data URI.
2041 */
2042 public Intent(String action, Uri uri) {
2043 mAction = action;
2044 mData = uri;
2045 }
2046
2047 /**
2048 * Create an intent for a specific component. All other fields (action, data,
2049 * type, class) are null, though they can be modified later with explicit
2050 * calls. This provides a convenient way to create an intent that is
2051 * intended to execute a hard-coded class name, rather than relying on the
2052 * system to find an appropriate class for you; see {@link #setComponent}
2053 * for more information on the repercussions of this.
2054 *
2055 * @param packageContext A Context of the application package implementing
2056 * this class.
2057 * @param cls The component class that is to be used for the intent.
2058 *
2059 * @see #setClass
2060 * @see #setComponent
2061 * @see #Intent(String, android.net.Uri , Context, Class)
2062 */
2063 public Intent(Context packageContext, Class<?> cls) {
2064 mComponent = new ComponentName(packageContext, cls);
2065 }
2066
2067 /**
2068 * Create an intent for a specific component with a specified action and data.
2069 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2070 * construct the Intent and then calling {@link #setClass} to set its
2071 * class.
2072 *
2073 * @param action The Intent action, such as ACTION_VIEW.
2074 * @param uri The Intent data URI.
2075 * @param packageContext A Context of the application package implementing
2076 * this class.
2077 * @param cls The component class that is to be used for the intent.
2078 *
2079 * @see #Intent(String, android.net.Uri)
2080 * @see #Intent(Context, Class)
2081 * @see #setClass
2082 * @see #setComponent
2083 */
2084 public Intent(String action, Uri uri,
2085 Context packageContext, Class<?> cls) {
2086 mAction = action;
2087 mData = uri;
2088 mComponent = new ComponentName(packageContext, cls);
2089 }
2090
2091 /**
2092 * Create an intent from a URI. This URI may encode the action,
2093 * category, and other intent fields, if it was returned by toURI(). If
2094 * the Intent was not generate by toURI(), its data will be the entire URI
2095 * and its action will be ACTION_VIEW.
2096 *
2097 * <p>The URI given here must not be relative -- that is, it must include
2098 * the scheme and full path.
2099 *
2100 * @param uri The URI to turn into an Intent.
2101 *
2102 * @return Intent The newly created Intent object.
2103 *
2104 * @see #toURI
2105 */
2106 public static Intent getIntent(String uri) throws URISyntaxException {
2107 int i = 0;
2108 try {
2109 // simple case
2110 i = uri.lastIndexOf("#");
2111 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2112
2113 // old format Intent URI
2114 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002115
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002116 // new format
2117 Intent intent = new Intent(ACTION_VIEW);
2118
2119 // fetch data part, if present
2120 if (i > 0) {
2121 intent.mData = Uri.parse(uri.substring(0, i));
2122 }
2123 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002124
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002125 // loop over contents of Intent, all name=value;
2126 while (!uri.startsWith("end", i)) {
2127 int eq = uri.indexOf('=', i);
2128 int semi = uri.indexOf(';', eq);
2129 String value = uri.substring(eq + 1, semi);
2130
2131 // action
2132 if (uri.startsWith("action=", i)) {
2133 intent.mAction = value;
2134 }
2135
2136 // categories
2137 else if (uri.startsWith("category=", i)) {
2138 intent.addCategory(value);
2139 }
2140
2141 // type
2142 else if (uri.startsWith("type=", i)) {
2143 intent.mType = value;
2144 }
2145
2146 // launch flags
2147 else if (uri.startsWith("launchFlags=", i)) {
2148 intent.mFlags = Integer.decode(value).intValue();
2149 }
2150
2151 // component
2152 else if (uri.startsWith("component=", i)) {
2153 intent.mComponent = ComponentName.unflattenFromString(value);
2154 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002155
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002156 // extra
2157 else {
2158 String key = Uri.decode(uri.substring(i + 2, eq));
2159 value = Uri.decode(value);
2160 // create Bundle if it doesn't already exist
2161 if (intent.mExtras == null) intent.mExtras = new Bundle();
2162 Bundle b = intent.mExtras;
2163 // add EXTRA
2164 if (uri.startsWith("S.", i)) b.putString(key, value);
2165 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2166 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2167 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2168 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2169 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2170 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2171 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2172 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2173 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2174 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002175
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002176 // move to the next item
2177 i = semi + 1;
2178 }
2179
2180 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002181
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002182 } catch (IndexOutOfBoundsException e) {
2183 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2184 }
2185 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002186
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002187 public static Intent getIntentOld(String uri) throws URISyntaxException {
2188 Intent intent;
2189
2190 int i = uri.lastIndexOf('#');
2191 if (i >= 0) {
2192 Uri data = null;
2193 String action = null;
2194 if (i > 0) {
2195 data = Uri.parse(uri.substring(0, i));
2196 }
2197
2198 i++;
2199
2200 if (uri.regionMatches(i, "action(", 0, 7)) {
2201 i += 7;
2202 int j = uri.indexOf(')', i);
2203 action = uri.substring(i, j);
2204 i = j + 1;
2205 }
2206
2207 intent = new Intent(action, data);
2208
2209 if (uri.regionMatches(i, "categories(", 0, 11)) {
2210 i += 11;
2211 int j = uri.indexOf(')', i);
2212 while (i < j) {
2213 int sep = uri.indexOf('!', i);
2214 if (sep < 0) sep = j;
2215 if (i < sep) {
2216 intent.addCategory(uri.substring(i, sep));
2217 }
2218 i = sep + 1;
2219 }
2220 i = j + 1;
2221 }
2222
2223 if (uri.regionMatches(i, "type(", 0, 5)) {
2224 i += 5;
2225 int j = uri.indexOf(')', i);
2226 intent.mType = uri.substring(i, j);
2227 i = j + 1;
2228 }
2229
2230 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2231 i += 12;
2232 int j = uri.indexOf(')', i);
2233 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2234 i = j + 1;
2235 }
2236
2237 if (uri.regionMatches(i, "component(", 0, 10)) {
2238 i += 10;
2239 int j = uri.indexOf(')', i);
2240 int sep = uri.indexOf('!', i);
2241 if (sep >= 0 && sep < j) {
2242 String pkg = uri.substring(i, sep);
2243 String cls = uri.substring(sep + 1, j);
2244 intent.mComponent = new ComponentName(pkg, cls);
2245 }
2246 i = j + 1;
2247 }
2248
2249 if (uri.regionMatches(i, "extras(", 0, 7)) {
2250 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002251
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002252 final int closeParen = uri.indexOf(')', i);
2253 if (closeParen == -1) throw new URISyntaxException(uri,
2254 "EXTRA missing trailing ')'", i);
2255
2256 while (i < closeParen) {
2257 // fetch the key value
2258 int j = uri.indexOf('=', i);
2259 if (j <= i + 1 || i >= closeParen) {
2260 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2261 }
2262 char type = uri.charAt(i);
2263 i++;
2264 String key = uri.substring(i, j);
2265 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002266
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002267 // get type-value
2268 j = uri.indexOf('!', i);
2269 if (j == -1 || j >= closeParen) j = closeParen;
2270 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2271 String value = uri.substring(i, j);
2272 i = j;
2273
2274 // create Bundle if it doesn't already exist
2275 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002276
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002277 // add item to bundle
2278 try {
2279 switch (type) {
2280 case 'S':
2281 intent.mExtras.putString(key, Uri.decode(value));
2282 break;
2283 case 'B':
2284 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2285 break;
2286 case 'b':
2287 intent.mExtras.putByte(key, Byte.parseByte(value));
2288 break;
2289 case 'c':
2290 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2291 break;
2292 case 'd':
2293 intent.mExtras.putDouble(key, Double.parseDouble(value));
2294 break;
2295 case 'f':
2296 intent.mExtras.putFloat(key, Float.parseFloat(value));
2297 break;
2298 case 'i':
2299 intent.mExtras.putInt(key, Integer.parseInt(value));
2300 break;
2301 case 'l':
2302 intent.mExtras.putLong(key, Long.parseLong(value));
2303 break;
2304 case 's':
2305 intent.mExtras.putShort(key, Short.parseShort(value));
2306 break;
2307 default:
2308 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2309 }
2310 } catch (NumberFormatException e) {
2311 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2312 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002313
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002314 char ch = uri.charAt(i);
2315 if (ch == ')') break;
2316 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2317 i++;
2318 }
2319 }
2320
2321 if (intent.mAction == null) {
2322 // By default, if no action is specified, then use VIEW.
2323 intent.mAction = ACTION_VIEW;
2324 }
2325
2326 } else {
2327 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2328 }
2329
2330 return intent;
2331 }
2332
2333 /**
2334 * Retrieve the general action to be performed, such as
2335 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2336 * the information in the intent should be interpreted -- most importantly,
2337 * what to do with the data returned by {@link #getData}.
2338 *
2339 * @return The action of this intent or null if none is specified.
2340 *
2341 * @see #setAction
2342 */
2343 public String getAction() {
2344 return mAction;
2345 }
2346
2347 /**
2348 * Retrieve data this intent is operating on. This URI specifies the name
2349 * of the data; often it uses the content: scheme, specifying data in a
2350 * content provider. Other schemes may be handled by specific activities,
2351 * such as http: by the web browser.
2352 *
2353 * @return The URI of the data this intent is targeting or null.
2354 *
2355 * @see #getScheme
2356 * @see #setData
2357 */
2358 public Uri getData() {
2359 return mData;
2360 }
2361
2362 /**
2363 * The same as {@link #getData()}, but returns the URI as an encoded
2364 * String.
2365 */
2366 public String getDataString() {
2367 return mData != null ? mData.toString() : null;
2368 }
2369
2370 /**
2371 * Return the scheme portion of the intent's data. If the data is null or
2372 * does not include a scheme, null is returned. Otherwise, the scheme
2373 * prefix without the final ':' is returned, i.e. "http".
2374 *
2375 * <p>This is the same as calling getData().getScheme() (and checking for
2376 * null data).
2377 *
2378 * @return The scheme of this intent.
2379 *
2380 * @see #getData
2381 */
2382 public String getScheme() {
2383 return mData != null ? mData.getScheme() : null;
2384 }
2385
2386 /**
2387 * Retrieve any explicit MIME type included in the intent. This is usually
2388 * null, as the type is determined by the intent data.
2389 *
2390 * @return If a type was manually set, it is returned; else null is
2391 * returned.
2392 *
2393 * @see #resolveType(ContentResolver)
2394 * @see #setType
2395 */
2396 public String getType() {
2397 return mType;
2398 }
2399
2400 /**
2401 * Return the MIME data type of this intent. If the type field is
2402 * explicitly set, that is simply returned. Otherwise, if the data is set,
2403 * the type of that data is returned. If neither fields are set, a null is
2404 * returned.
2405 *
2406 * @return The MIME type of this intent.
2407 *
2408 * @see #getType
2409 * @see #resolveType(ContentResolver)
2410 */
2411 public String resolveType(Context context) {
2412 return resolveType(context.getContentResolver());
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 * @param resolver A ContentResolver that can be used to determine the MIME
2422 * type of the intent's data.
2423 *
2424 * @return The MIME type of this intent.
2425 *
2426 * @see #getType
2427 * @see #resolveType(Context)
2428 */
2429 public String resolveType(ContentResolver resolver) {
2430 if (mType != null) {
2431 return mType;
2432 }
2433 if (mData != null) {
2434 if ("content".equals(mData.getScheme())) {
2435 return resolver.getType(mData);
2436 }
2437 }
2438 return null;
2439 }
2440
2441 /**
2442 * Return the MIME data type of this intent, only if it will be needed for
2443 * intent resolution. This is not generally useful for application code;
2444 * it is used by the frameworks for communicating with back-end system
2445 * services.
2446 *
2447 * @param resolver A ContentResolver that can be used to determine the MIME
2448 * type of the intent's data.
2449 *
2450 * @return The MIME type of this intent, or null if it is unknown or not
2451 * needed.
2452 */
2453 public String resolveTypeIfNeeded(ContentResolver resolver) {
2454 if (mComponent != null) {
2455 return mType;
2456 }
2457 return resolveType(resolver);
2458 }
2459
2460 /**
2461 * Check if an category exists in the intent.
2462 *
2463 * @param category The category to check.
2464 *
2465 * @return boolean True if the intent contains the category, else false.
2466 *
2467 * @see #getCategories
2468 * @see #addCategory
2469 */
2470 public boolean hasCategory(String category) {
2471 return mCategories != null && mCategories.contains(category);
2472 }
2473
2474 /**
2475 * Return the set of all categories in the intent. If there are no categories,
2476 * returns NULL.
2477 *
2478 * @return Set The set of categories you can examine. Do not modify!
2479 *
2480 * @see #hasCategory
2481 * @see #addCategory
2482 */
2483 public Set<String> getCategories() {
2484 return mCategories;
2485 }
2486
2487 /**
2488 * Sets the ClassLoader that will be used when unmarshalling
2489 * any Parcelable values from the extras of this Intent.
2490 *
2491 * @param loader a ClassLoader, or null to use the default loader
2492 * at the time of unmarshalling.
2493 */
2494 public void setExtrasClassLoader(ClassLoader loader) {
2495 if (mExtras != null) {
2496 mExtras.setClassLoader(loader);
2497 }
2498 }
2499
2500 /**
2501 * Returns true if an extra value is associated with the given name.
2502 * @param name the extra's name
2503 * @return true if the given extra is present.
2504 */
2505 public boolean hasExtra(String name) {
2506 return mExtras != null && mExtras.containsKey(name);
2507 }
2508
2509 /**
2510 * Returns true if the Intent's extras contain a parcelled file descriptor.
2511 * @return true if the Intent contains a parcelled file descriptor.
2512 */
2513 public boolean hasFileDescriptors() {
2514 return mExtras != null && mExtras.hasFileDescriptors();
2515 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002516
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002517 /**
2518 * Retrieve extended data from the intent.
2519 *
2520 * @param name The name of the desired item.
2521 *
2522 * @return the value of an item that previously added with putExtra()
2523 * or null if none was found.
2524 *
2525 * @deprecated
2526 * @hide
2527 */
2528 @Deprecated
2529 public Object getExtra(String name) {
2530 return getExtra(name, null);
2531 }
2532
2533 /**
2534 * Retrieve extended data from the intent.
2535 *
2536 * @param name The name of the desired item.
2537 * @param defaultValue the value to be returned if no value of the desired
2538 * type is stored with the given name.
2539 *
2540 * @return the value of an item that previously added with putExtra()
2541 * or the default value if none was found.
2542 *
2543 * @see #putExtra(String, boolean)
2544 */
2545 public boolean getBooleanExtra(String name, boolean defaultValue) {
2546 return mExtras == null ? defaultValue :
2547 mExtras.getBoolean(name, defaultValue);
2548 }
2549
2550 /**
2551 * Retrieve extended data from the intent.
2552 *
2553 * @param name The name of the desired item.
2554 * @param defaultValue the value to be returned if no value of the desired
2555 * type is stored with the given name.
2556 *
2557 * @return the value of an item that previously added with putExtra()
2558 * or the default value if none was found.
2559 *
2560 * @see #putExtra(String, byte)
2561 */
2562 public byte getByteExtra(String name, byte defaultValue) {
2563 return mExtras == null ? defaultValue :
2564 mExtras.getByte(name, defaultValue);
2565 }
2566
2567 /**
2568 * Retrieve extended data from the intent.
2569 *
2570 * @param name The name of the desired item.
2571 * @param defaultValue the value to be returned if no value of the desired
2572 * type is stored with the given name.
2573 *
2574 * @return the value of an item that previously added with putExtra()
2575 * or the default value if none was found.
2576 *
2577 * @see #putExtra(String, short)
2578 */
2579 public short getShortExtra(String name, short defaultValue) {
2580 return mExtras == null ? defaultValue :
2581 mExtras.getShort(name, defaultValue);
2582 }
2583
2584 /**
2585 * Retrieve extended data from the intent.
2586 *
2587 * @param name The name of the desired item.
2588 * @param defaultValue the value to be returned if no value of the desired
2589 * type is stored with the given name.
2590 *
2591 * @return the value of an item that previously added with putExtra()
2592 * or the default value if none was found.
2593 *
2594 * @see #putExtra(String, char)
2595 */
2596 public char getCharExtra(String name, char defaultValue) {
2597 return mExtras == null ? defaultValue :
2598 mExtras.getChar(name, defaultValue);
2599 }
2600
2601 /**
2602 * Retrieve extended data from the intent.
2603 *
2604 * @param name The name of the desired item.
2605 * @param defaultValue the value to be returned if no value of the desired
2606 * type is stored with the given name.
2607 *
2608 * @return the value of an item that previously added with putExtra()
2609 * or the default value if none was found.
2610 *
2611 * @see #putExtra(String, int)
2612 */
2613 public int getIntExtra(String name, int defaultValue) {
2614 return mExtras == null ? defaultValue :
2615 mExtras.getInt(name, defaultValue);
2616 }
2617
2618 /**
2619 * Retrieve extended data from the intent.
2620 *
2621 * @param name The name of the desired item.
2622 * @param defaultValue the value to be returned if no value of the desired
2623 * type is stored with the given name.
2624 *
2625 * @return the value of an item that previously added with putExtra()
2626 * or the default value if none was found.
2627 *
2628 * @see #putExtra(String, long)
2629 */
2630 public long getLongExtra(String name, long defaultValue) {
2631 return mExtras == null ? defaultValue :
2632 mExtras.getLong(name, defaultValue);
2633 }
2634
2635 /**
2636 * Retrieve extended data from the intent.
2637 *
2638 * @param name The name of the desired item.
2639 * @param defaultValue the value to be returned if no value of the desired
2640 * type is stored with the given name.
2641 *
2642 * @return the value of an item that previously added with putExtra(),
2643 * or the default value if no such item is present
2644 *
2645 * @see #putExtra(String, float)
2646 */
2647 public float getFloatExtra(String name, float defaultValue) {
2648 return mExtras == null ? defaultValue :
2649 mExtras.getFloat(name, defaultValue);
2650 }
2651
2652 /**
2653 * Retrieve extended data from the intent.
2654 *
2655 * @param name The name of the desired item.
2656 * @param defaultValue the value to be returned if no value of the desired
2657 * type is stored with the given name.
2658 *
2659 * @return the value of an item that previously added with putExtra()
2660 * or the default value if none was found.
2661 *
2662 * @see #putExtra(String, double)
2663 */
2664 public double getDoubleExtra(String name, double defaultValue) {
2665 return mExtras == null ? defaultValue :
2666 mExtras.getDouble(name, defaultValue);
2667 }
2668
2669 /**
2670 * Retrieve extended data from the intent.
2671 *
2672 * @param name The name of the desired item.
2673 *
2674 * @return the value of an item that previously added with putExtra()
2675 * or null if no String value was found.
2676 *
2677 * @see #putExtra(String, String)
2678 */
2679 public String getStringExtra(String name) {
2680 return mExtras == null ? null : mExtras.getString(name);
2681 }
2682
2683 /**
2684 * Retrieve extended data from the intent.
2685 *
2686 * @param name The name of the desired item.
2687 *
2688 * @return the value of an item that previously added with putExtra()
2689 * or null if no CharSequence value was found.
2690 *
2691 * @see #putExtra(String, CharSequence)
2692 */
2693 public CharSequence getCharSequenceExtra(String name) {
2694 return mExtras == null ? null : mExtras.getCharSequence(name);
2695 }
2696
2697 /**
2698 * Retrieve extended data from the intent.
2699 *
2700 * @param name The name of the desired item.
2701 *
2702 * @return the value of an item that previously added with putExtra()
2703 * or null if no Parcelable value was found.
2704 *
2705 * @see #putExtra(String, Parcelable)
2706 */
2707 public <T extends Parcelable> T getParcelableExtra(String name) {
2708 return mExtras == null ? null : mExtras.<T>getParcelable(name);
2709 }
2710
2711 /**
2712 * Retrieve extended data from the intent.
2713 *
2714 * @param name The name of the desired item.
2715 *
2716 * @return the value of an item that previously added with putExtra()
2717 * or null if no Parcelable[] value was found.
2718 *
2719 * @see #putExtra(String, Parcelable[])
2720 */
2721 public Parcelable[] getParcelableArrayExtra(String name) {
2722 return mExtras == null ? null : mExtras.getParcelableArray(name);
2723 }
2724
2725 /**
2726 * Retrieve extended data from the intent.
2727 *
2728 * @param name The name of the desired item.
2729 *
2730 * @return the value of an item that previously added with putExtra()
2731 * or null if no ArrayList<Parcelable> value was found.
2732 *
2733 * @see #putParcelableArrayListExtra(String, ArrayList)
2734 */
2735 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
2736 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
2737 }
2738
2739 /**
2740 * Retrieve extended data from the intent.
2741 *
2742 * @param name The name of the desired item.
2743 *
2744 * @return the value of an item that previously added with putExtra()
2745 * or null if no Serializable value was found.
2746 *
2747 * @see #putExtra(String, Serializable)
2748 */
2749 public Serializable getSerializableExtra(String name) {
2750 return mExtras == null ? null : mExtras.getSerializable(name);
2751 }
2752
2753 /**
2754 * Retrieve extended data from the intent.
2755 *
2756 * @param name The name of the desired item.
2757 *
2758 * @return the value of an item that previously added with putExtra()
2759 * or null if no ArrayList<Integer> value was found.
2760 *
2761 * @see #putIntegerArrayListExtra(String, ArrayList)
2762 */
2763 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
2764 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
2765 }
2766
2767 /**
2768 * Retrieve extended data from the intent.
2769 *
2770 * @param name The name of the desired item.
2771 *
2772 * @return the value of an item that previously added with putExtra()
2773 * or null if no ArrayList<String> value was found.
2774 *
2775 * @see #putStringArrayListExtra(String, ArrayList)
2776 */
2777 public ArrayList<String> getStringArrayListExtra(String name) {
2778 return mExtras == null ? null : mExtras.getStringArrayList(name);
2779 }
2780
2781 /**
2782 * Retrieve extended data from the intent.
2783 *
2784 * @param name The name of the desired item.
2785 *
2786 * @return the value of an item that previously added with putExtra()
2787 * or null if no boolean array value was found.
2788 *
2789 * @see #putExtra(String, boolean[])
2790 */
2791 public boolean[] getBooleanArrayExtra(String name) {
2792 return mExtras == null ? null : mExtras.getBooleanArray(name);
2793 }
2794
2795 /**
2796 * Retrieve extended data from the intent.
2797 *
2798 * @param name The name of the desired item.
2799 *
2800 * @return the value of an item that previously added with putExtra()
2801 * or null if no byte array value was found.
2802 *
2803 * @see #putExtra(String, byte[])
2804 */
2805 public byte[] getByteArrayExtra(String name) {
2806 return mExtras == null ? null : mExtras.getByteArray(name);
2807 }
2808
2809 /**
2810 * Retrieve extended data from the intent.
2811 *
2812 * @param name The name of the desired item.
2813 *
2814 * @return the value of an item that previously added with putExtra()
2815 * or null if no short array value was found.
2816 *
2817 * @see #putExtra(String, short[])
2818 */
2819 public short[] getShortArrayExtra(String name) {
2820 return mExtras == null ? null : mExtras.getShortArray(name);
2821 }
2822
2823 /**
2824 * Retrieve extended data from the intent.
2825 *
2826 * @param name The name of the desired item.
2827 *
2828 * @return the value of an item that previously added with putExtra()
2829 * or null if no char array value was found.
2830 *
2831 * @see #putExtra(String, char[])
2832 */
2833 public char[] getCharArrayExtra(String name) {
2834 return mExtras == null ? null : mExtras.getCharArray(name);
2835 }
2836
2837 /**
2838 * Retrieve extended data from the intent.
2839 *
2840 * @param name The name of the desired item.
2841 *
2842 * @return the value of an item that previously added with putExtra()
2843 * or null if no int array value was found.
2844 *
2845 * @see #putExtra(String, int[])
2846 */
2847 public int[] getIntArrayExtra(String name) {
2848 return mExtras == null ? null : mExtras.getIntArray(name);
2849 }
2850
2851 /**
2852 * Retrieve extended data from the intent.
2853 *
2854 * @param name The name of the desired item.
2855 *
2856 * @return the value of an item that previously added with putExtra()
2857 * or null if no long array value was found.
2858 *
2859 * @see #putExtra(String, long[])
2860 */
2861 public long[] getLongArrayExtra(String name) {
2862 return mExtras == null ? null : mExtras.getLongArray(name);
2863 }
2864
2865 /**
2866 * Retrieve extended data from the intent.
2867 *
2868 * @param name The name of the desired item.
2869 *
2870 * @return the value of an item that previously added with putExtra()
2871 * or null if no float array value was found.
2872 *
2873 * @see #putExtra(String, float[])
2874 */
2875 public float[] getFloatArrayExtra(String name) {
2876 return mExtras == null ? null : mExtras.getFloatArray(name);
2877 }
2878
2879 /**
2880 * Retrieve extended data from the intent.
2881 *
2882 * @param name The name of the desired item.
2883 *
2884 * @return the value of an item that previously added with putExtra()
2885 * or null if no double array value was found.
2886 *
2887 * @see #putExtra(String, double[])
2888 */
2889 public double[] getDoubleArrayExtra(String name) {
2890 return mExtras == null ? null : mExtras.getDoubleArray(name);
2891 }
2892
2893 /**
2894 * Retrieve extended data from the intent.
2895 *
2896 * @param name The name of the desired item.
2897 *
2898 * @return the value of an item that previously added with putExtra()
2899 * or null if no String array value was found.
2900 *
2901 * @see #putExtra(String, String[])
2902 */
2903 public String[] getStringArrayExtra(String name) {
2904 return mExtras == null ? null : mExtras.getStringArray(name);
2905 }
2906
2907 /**
2908 * Retrieve extended data from the intent.
2909 *
2910 * @param name The name of the desired item.
2911 *
2912 * @return the value of an item that previously added with putExtra()
2913 * or null if no Bundle value was found.
2914 *
2915 * @see #putExtra(String, Bundle)
2916 */
2917 public Bundle getBundleExtra(String name) {
2918 return mExtras == null ? null : mExtras.getBundle(name);
2919 }
2920
2921 /**
2922 * Retrieve extended data from the intent.
2923 *
2924 * @param name The name of the desired item.
2925 *
2926 * @return the value of an item that previously added with putExtra()
2927 * or null if no IBinder value was found.
2928 *
2929 * @see #putExtra(String, IBinder)
2930 *
2931 * @deprecated
2932 * @hide
2933 */
2934 @Deprecated
2935 public IBinder getIBinderExtra(String name) {
2936 return mExtras == null ? null : mExtras.getIBinder(name);
2937 }
2938
2939 /**
2940 * Retrieve extended data from the intent.
2941 *
2942 * @param name The name of the desired item.
2943 * @param defaultValue The default value to return in case no item is
2944 * associated with the key 'name'
2945 *
2946 * @return the value of an item that previously added with putExtra()
2947 * or defaultValue if none was found.
2948 *
2949 * @see #putExtra
2950 *
2951 * @deprecated
2952 * @hide
2953 */
2954 @Deprecated
2955 public Object getExtra(String name, Object defaultValue) {
2956 Object result = defaultValue;
2957 if (mExtras != null) {
2958 Object result2 = mExtras.get(name);
2959 if (result2 != null) {
2960 result = result2;
2961 }
2962 }
2963
2964 return result;
2965 }
2966
2967 /**
2968 * Retrieves a map of extended data from the intent.
2969 *
2970 * @return the map of all extras previously added with putExtra(),
2971 * or null if none have been added.
2972 */
2973 public Bundle getExtras() {
2974 return (mExtras != null)
2975 ? new Bundle(mExtras)
2976 : null;
2977 }
2978
2979 /**
2980 * Retrieve any special flags associated with this intent. You will
2981 * normally just set them with {@link #setFlags} and let the system
2982 * take the appropriate action with them.
2983 *
2984 * @return int The currently set flags.
2985 *
2986 * @see #setFlags
2987 */
2988 public int getFlags() {
2989 return mFlags;
2990 }
2991
2992 /**
2993 * Retrieve the concrete component associated with the intent. When receiving
2994 * an intent, this is the component that was found to best handle it (that is,
2995 * yourself) and will always be non-null; in all other cases it will be
2996 * null unless explicitly set.
2997 *
2998 * @return The name of the application component to handle the intent.
2999 *
3000 * @see #resolveActivity
3001 * @see #setComponent
3002 */
3003 public ComponentName getComponent() {
3004 return mComponent;
3005 }
3006
3007 /**
3008 * Return the Activity component that should be used to handle this intent.
3009 * The appropriate component is determined based on the information in the
3010 * intent, evaluated as follows:
3011 *
3012 * <p>If {@link #getComponent} returns an explicit class, that is returned
3013 * without any further consideration.
3014 *
3015 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3016 * category to be considered.
3017 *
3018 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3019 * action.
3020 *
3021 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3022 * this type.
3023 *
3024 * <p>If {@link #addCategory} has added any categories, the activity must
3025 * handle ALL of the categories specified.
3026 *
3027 * <p>If there are no activities that satisfy all of these conditions, a
3028 * null string is returned.
3029 *
3030 * <p>If multiple activities are found to satisfy the intent, the one with
3031 * the highest priority will be used. If there are multiple activities
3032 * with the same priority, the system will either pick the best activity
3033 * based on user preference, or resolve to a system class that will allow
3034 * the user to pick an activity and forward from there.
3035 *
3036 * <p>This method is implemented simply by calling
3037 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3038 * true.</p>
3039 * <p> This API is called for you as part of starting an activity from an
3040 * intent. You do not normally need to call it yourself.</p>
3041 *
3042 * @param pm The package manager with which to resolve the Intent.
3043 *
3044 * @return Name of the component implementing an activity that can
3045 * display the intent.
3046 *
3047 * @see #setComponent
3048 * @see #getComponent
3049 * @see #resolveActivityInfo
3050 */
3051 public ComponentName resolveActivity(PackageManager pm) {
3052 if (mComponent != null) {
3053 return mComponent;
3054 }
3055
3056 ResolveInfo info = pm.resolveActivity(
3057 this, PackageManager.MATCH_DEFAULT_ONLY);
3058 if (info != null) {
3059 return new ComponentName(
3060 info.activityInfo.applicationInfo.packageName,
3061 info.activityInfo.name);
3062 }
3063
3064 return null;
3065 }
3066
3067 /**
3068 * Resolve the Intent into an {@link ActivityInfo}
3069 * describing the activity that should execute the intent. Resolution
3070 * follows the same rules as described for {@link #resolveActivity}, but
3071 * you get back the completely information about the resolved activity
3072 * instead of just its class name.
3073 *
3074 * @param pm The package manager with which to resolve the Intent.
3075 * @param flags Addition information to retrieve as per
3076 * {@link PackageManager#getActivityInfo(ComponentName, int)
3077 * PackageManager.getActivityInfo()}.
3078 *
3079 * @return PackageManager.ActivityInfo
3080 *
3081 * @see #resolveActivity
3082 */
3083 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3084 ActivityInfo ai = null;
3085 if (mComponent != null) {
3086 try {
3087 ai = pm.getActivityInfo(mComponent, flags);
3088 } catch (PackageManager.NameNotFoundException e) {
3089 // ignore
3090 }
3091 } else {
3092 ResolveInfo info = pm.resolveActivity(
3093 this, PackageManager.MATCH_DEFAULT_ONLY);
3094 if (info != null) {
3095 ai = info.activityInfo;
3096 }
3097 }
3098
3099 return ai;
3100 }
3101
3102 /**
3103 * Set the general action to be performed.
3104 *
3105 * @param action An action name, such as ACTION_VIEW. Application-specific
3106 * actions should be prefixed with the vendor's package name.
3107 *
3108 * @return Returns the same Intent object, for chaining multiple calls
3109 * into a single statement.
3110 *
3111 * @see #getAction
3112 */
3113 public Intent setAction(String action) {
3114 mAction = action;
3115 return this;
3116 }
3117
3118 /**
3119 * Set the data this intent is operating on. This method automatically
3120 * clears any type that was previously set by {@link #setType}.
3121 *
3122 * @param data The URI of the data this intent is now targeting.
3123 *
3124 * @return Returns the same Intent object, for chaining multiple calls
3125 * into a single statement.
3126 *
3127 * @see #getData
3128 * @see #setType
3129 * @see #setDataAndType
3130 */
3131 public Intent setData(Uri data) {
3132 mData = data;
3133 mType = null;
3134 return this;
3135 }
3136
3137 /**
3138 * Set an explicit MIME data type. This is used to create intents that
3139 * only specify a type and not data, for example to indicate the type of
3140 * data to return. This method automatically clears any data that was
3141 * previously set by {@link #setData}.
3142 *
3143 * @param type The MIME type of the data being handled by this intent.
3144 *
3145 * @return Returns the same Intent object, for chaining multiple calls
3146 * into a single statement.
3147 *
3148 * @see #getType
3149 * @see #setData
3150 * @see #setDataAndType
3151 */
3152 public Intent setType(String type) {
3153 mData = null;
3154 mType = type;
3155 return this;
3156 }
3157
3158 /**
3159 * (Usually optional) Set the data for the intent along with an explicit
3160 * MIME data type. This method should very rarely be used -- it allows you
3161 * to override the MIME type that would ordinarily be inferred from the
3162 * data with your own type given here.
3163 *
3164 * @param data The URI of the data this intent is now targeting.
3165 * @param type The MIME type of the data being handled by this intent.
3166 *
3167 * @return Returns the same Intent object, for chaining multiple calls
3168 * into a single statement.
3169 *
3170 * @see #setData
3171 * @see #setType
3172 */
3173 public Intent setDataAndType(Uri data, String type) {
3174 mData = data;
3175 mType = type;
3176 return this;
3177 }
3178
3179 /**
3180 * Add a new category to the intent. Categories provide additional detail
3181 * about the action the intent is perform. When resolving an intent, only
3182 * activities that provide <em>all</em> of the requested categories will be
3183 * used.
3184 *
3185 * @param category The desired category. This can be either one of the
3186 * predefined Intent categories, or a custom category in your own
3187 * namespace.
3188 *
3189 * @return Returns the same Intent object, for chaining multiple calls
3190 * into a single statement.
3191 *
3192 * @see #hasCategory
3193 * @see #removeCategory
3194 */
3195 public Intent addCategory(String category) {
3196 if (mCategories == null) {
3197 mCategories = new HashSet<String>();
3198 }
3199 mCategories.add(category);
3200 return this;
3201 }
3202
3203 /**
3204 * Remove an category from an intent.
3205 *
3206 * @param category The category to remove.
3207 *
3208 * @see #addCategory
3209 */
3210 public void removeCategory(String category) {
3211 if (mCategories != null) {
3212 mCategories.remove(category);
3213 if (mCategories.size() == 0) {
3214 mCategories = null;
3215 }
3216 }
3217 }
3218
3219 /**
3220 * Add extended data to the intent. The name must include a package
3221 * prefix, for example the app com.android.contacts would use names
3222 * like "com.android.contacts.ShowAll".
3223 *
3224 * @param name The name of the extra data, with package prefix.
3225 * @param value The boolean data value.
3226 *
3227 * @return Returns the same Intent object, for chaining multiple calls
3228 * into a single statement.
3229 *
3230 * @see #putExtras
3231 * @see #removeExtra
3232 * @see #getBooleanExtra(String, boolean)
3233 */
3234 public Intent putExtra(String name, boolean value) {
3235 if (mExtras == null) {
3236 mExtras = new Bundle();
3237 }
3238 mExtras.putBoolean(name, value);
3239 return this;
3240 }
3241
3242 /**
3243 * Add extended data to the intent. The name must include a package
3244 * prefix, for example the app com.android.contacts would use names
3245 * like "com.android.contacts.ShowAll".
3246 *
3247 * @param name The name of the extra data, with package prefix.
3248 * @param value The byte data value.
3249 *
3250 * @return Returns the same Intent object, for chaining multiple calls
3251 * into a single statement.
3252 *
3253 * @see #putExtras
3254 * @see #removeExtra
3255 * @see #getByteExtra(String, byte)
3256 */
3257 public Intent putExtra(String name, byte value) {
3258 if (mExtras == null) {
3259 mExtras = new Bundle();
3260 }
3261 mExtras.putByte(name, value);
3262 return this;
3263 }
3264
3265 /**
3266 * Add extended data to the intent. The name must include a package
3267 * prefix, for example the app com.android.contacts would use names
3268 * like "com.android.contacts.ShowAll".
3269 *
3270 * @param name The name of the extra data, with package prefix.
3271 * @param value The char data value.
3272 *
3273 * @return Returns the same Intent object, for chaining multiple calls
3274 * into a single statement.
3275 *
3276 * @see #putExtras
3277 * @see #removeExtra
3278 * @see #getCharExtra(String, char)
3279 */
3280 public Intent putExtra(String name, char value) {
3281 if (mExtras == null) {
3282 mExtras = new Bundle();
3283 }
3284 mExtras.putChar(name, value);
3285 return this;
3286 }
3287
3288 /**
3289 * Add extended data to the intent. The name must include a package
3290 * prefix, for example the app com.android.contacts would use names
3291 * like "com.android.contacts.ShowAll".
3292 *
3293 * @param name The name of the extra data, with package prefix.
3294 * @param value The short data value.
3295 *
3296 * @return Returns the same Intent object, for chaining multiple calls
3297 * into a single statement.
3298 *
3299 * @see #putExtras
3300 * @see #removeExtra
3301 * @see #getShortExtra(String, short)
3302 */
3303 public Intent putExtra(String name, short value) {
3304 if (mExtras == null) {
3305 mExtras = new Bundle();
3306 }
3307 mExtras.putShort(name, value);
3308 return this;
3309 }
3310
3311 /**
3312 * Add extended data to the intent. The name must include a package
3313 * prefix, for example the app com.android.contacts would use names
3314 * like "com.android.contacts.ShowAll".
3315 *
3316 * @param name The name of the extra data, with package prefix.
3317 * @param value The integer data value.
3318 *
3319 * @return Returns the same Intent object, for chaining multiple calls
3320 * into a single statement.
3321 *
3322 * @see #putExtras
3323 * @see #removeExtra
3324 * @see #getIntExtra(String, int)
3325 */
3326 public Intent putExtra(String name, int value) {
3327 if (mExtras == null) {
3328 mExtras = new Bundle();
3329 }
3330 mExtras.putInt(name, value);
3331 return this;
3332 }
3333
3334 /**
3335 * Add extended data to the intent. The name must include a package
3336 * prefix, for example the app com.android.contacts would use names
3337 * like "com.android.contacts.ShowAll".
3338 *
3339 * @param name The name of the extra data, with package prefix.
3340 * @param value The long data value.
3341 *
3342 * @return Returns the same Intent object, for chaining multiple calls
3343 * into a single statement.
3344 *
3345 * @see #putExtras
3346 * @see #removeExtra
3347 * @see #getLongExtra(String, long)
3348 */
3349 public Intent putExtra(String name, long value) {
3350 if (mExtras == null) {
3351 mExtras = new Bundle();
3352 }
3353 mExtras.putLong(name, value);
3354 return this;
3355 }
3356
3357 /**
3358 * Add extended data to the intent. The name must include a package
3359 * prefix, for example the app com.android.contacts would use names
3360 * like "com.android.contacts.ShowAll".
3361 *
3362 * @param name The name of the extra data, with package prefix.
3363 * @param value The float data value.
3364 *
3365 * @return Returns the same Intent object, for chaining multiple calls
3366 * into a single statement.
3367 *
3368 * @see #putExtras
3369 * @see #removeExtra
3370 * @see #getFloatExtra(String, float)
3371 */
3372 public Intent putExtra(String name, float value) {
3373 if (mExtras == null) {
3374 mExtras = new Bundle();
3375 }
3376 mExtras.putFloat(name, value);
3377 return this;
3378 }
3379
3380 /**
3381 * Add extended data to the intent. The name must include a package
3382 * prefix, for example the app com.android.contacts would use names
3383 * like "com.android.contacts.ShowAll".
3384 *
3385 * @param name The name of the extra data, with package prefix.
3386 * @param value The double data value.
3387 *
3388 * @return Returns the same Intent object, for chaining multiple calls
3389 * into a single statement.
3390 *
3391 * @see #putExtras
3392 * @see #removeExtra
3393 * @see #getDoubleExtra(String, double)
3394 */
3395 public Intent putExtra(String name, double value) {
3396 if (mExtras == null) {
3397 mExtras = new Bundle();
3398 }
3399 mExtras.putDouble(name, value);
3400 return this;
3401 }
3402
3403 /**
3404 * Add extended data to the intent. The name must include a package
3405 * prefix, for example the app com.android.contacts would use names
3406 * like "com.android.contacts.ShowAll".
3407 *
3408 * @param name The name of the extra data, with package prefix.
3409 * @param value The String data value.
3410 *
3411 * @return Returns the same Intent object, for chaining multiple calls
3412 * into a single statement.
3413 *
3414 * @see #putExtras
3415 * @see #removeExtra
3416 * @see #getStringExtra(String)
3417 */
3418 public Intent putExtra(String name, String value) {
3419 if (mExtras == null) {
3420 mExtras = new Bundle();
3421 }
3422 mExtras.putString(name, value);
3423 return this;
3424 }
3425
3426 /**
3427 * Add extended data to the intent. The name must include a package
3428 * prefix, for example the app com.android.contacts would use names
3429 * like "com.android.contacts.ShowAll".
3430 *
3431 * @param name The name of the extra data, with package prefix.
3432 * @param value The CharSequence data value.
3433 *
3434 * @return Returns the same Intent object, for chaining multiple calls
3435 * into a single statement.
3436 *
3437 * @see #putExtras
3438 * @see #removeExtra
3439 * @see #getCharSequenceExtra(String)
3440 */
3441 public Intent putExtra(String name, CharSequence value) {
3442 if (mExtras == null) {
3443 mExtras = new Bundle();
3444 }
3445 mExtras.putCharSequence(name, value);
3446 return this;
3447 }
3448
3449 /**
3450 * Add extended data to the intent. The name must include a package
3451 * prefix, for example the app com.android.contacts would use names
3452 * like "com.android.contacts.ShowAll".
3453 *
3454 * @param name The name of the extra data, with package prefix.
3455 * @param value The Parcelable data value.
3456 *
3457 * @return Returns the same Intent object, for chaining multiple calls
3458 * into a single statement.
3459 *
3460 * @see #putExtras
3461 * @see #removeExtra
3462 * @see #getParcelableExtra(String)
3463 */
3464 public Intent putExtra(String name, Parcelable value) {
3465 if (mExtras == null) {
3466 mExtras = new Bundle();
3467 }
3468 mExtras.putParcelable(name, value);
3469 return this;
3470 }
3471
3472 /**
3473 * Add extended data to the intent. The name must include a package
3474 * prefix, for example the app com.android.contacts would use names
3475 * like "com.android.contacts.ShowAll".
3476 *
3477 * @param name The name of the extra data, with package prefix.
3478 * @param value The Parcelable[] data value.
3479 *
3480 * @return Returns the same Intent object, for chaining multiple calls
3481 * into a single statement.
3482 *
3483 * @see #putExtras
3484 * @see #removeExtra
3485 * @see #getParcelableArrayExtra(String)
3486 */
3487 public Intent putExtra(String name, Parcelable[] value) {
3488 if (mExtras == null) {
3489 mExtras = new Bundle();
3490 }
3491 mExtras.putParcelableArray(name, value);
3492 return this;
3493 }
3494
3495 /**
3496 * Add extended data to the intent. The name must include a package
3497 * prefix, for example the app com.android.contacts would use names
3498 * like "com.android.contacts.ShowAll".
3499 *
3500 * @param name The name of the extra data, with package prefix.
3501 * @param value The ArrayList<Parcelable> data value.
3502 *
3503 * @return Returns the same Intent object, for chaining multiple calls
3504 * into a single statement.
3505 *
3506 * @see #putExtras
3507 * @see #removeExtra
3508 * @see #getParcelableArrayListExtra(String)
3509 */
3510 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3511 if (mExtras == null) {
3512 mExtras = new Bundle();
3513 }
3514 mExtras.putParcelableArrayList(name, value);
3515 return this;
3516 }
3517
3518 /**
3519 * Add extended data to the intent. The name must include a package
3520 * prefix, for example the app com.android.contacts would use names
3521 * like "com.android.contacts.ShowAll".
3522 *
3523 * @param name The name of the extra data, with package prefix.
3524 * @param value The ArrayList<Integer> data value.
3525 *
3526 * @return Returns the same Intent object, for chaining multiple calls
3527 * into a single statement.
3528 *
3529 * @see #putExtras
3530 * @see #removeExtra
3531 * @see #getIntegerArrayListExtra(String)
3532 */
3533 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
3534 if (mExtras == null) {
3535 mExtras = new Bundle();
3536 }
3537 mExtras.putIntegerArrayList(name, value);
3538 return this;
3539 }
3540
3541 /**
3542 * Add extended data to the intent. The name must include a package
3543 * prefix, for example the app com.android.contacts would use names
3544 * like "com.android.contacts.ShowAll".
3545 *
3546 * @param name The name of the extra data, with package prefix.
3547 * @param value The ArrayList<String> data value.
3548 *
3549 * @return Returns the same Intent object, for chaining multiple calls
3550 * into a single statement.
3551 *
3552 * @see #putExtras
3553 * @see #removeExtra
3554 * @see #getStringArrayListExtra(String)
3555 */
3556 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
3557 if (mExtras == null) {
3558 mExtras = new Bundle();
3559 }
3560 mExtras.putStringArrayList(name, value);
3561 return this;
3562 }
3563
3564 /**
3565 * Add extended data to the intent. The name must include a package
3566 * prefix, for example the app com.android.contacts would use names
3567 * like "com.android.contacts.ShowAll".
3568 *
3569 * @param name The name of the extra data, with package prefix.
3570 * @param value The Serializable data value.
3571 *
3572 * @return Returns the same Intent object, for chaining multiple calls
3573 * into a single statement.
3574 *
3575 * @see #putExtras
3576 * @see #removeExtra
3577 * @see #getSerializableExtra(String)
3578 */
3579 public Intent putExtra(String name, Serializable value) {
3580 if (mExtras == null) {
3581 mExtras = new Bundle();
3582 }
3583 mExtras.putSerializable(name, value);
3584 return this;
3585 }
3586
3587 /**
3588 * Add extended data to the intent. The name must include a package
3589 * prefix, for example the app com.android.contacts would use names
3590 * like "com.android.contacts.ShowAll".
3591 *
3592 * @param name The name of the extra data, with package prefix.
3593 * @param value The boolean array data value.
3594 *
3595 * @return Returns the same Intent object, for chaining multiple calls
3596 * into a single statement.
3597 *
3598 * @see #putExtras
3599 * @see #removeExtra
3600 * @see #getBooleanArrayExtra(String)
3601 */
3602 public Intent putExtra(String name, boolean[] value) {
3603 if (mExtras == null) {
3604 mExtras = new Bundle();
3605 }
3606 mExtras.putBooleanArray(name, value);
3607 return this;
3608 }
3609
3610 /**
3611 * Add extended data to the intent. The name must include a package
3612 * prefix, for example the app com.android.contacts would use names
3613 * like "com.android.contacts.ShowAll".
3614 *
3615 * @param name The name of the extra data, with package prefix.
3616 * @param value The byte array data value.
3617 *
3618 * @return Returns the same Intent object, for chaining multiple calls
3619 * into a single statement.
3620 *
3621 * @see #putExtras
3622 * @see #removeExtra
3623 * @see #getByteArrayExtra(String)
3624 */
3625 public Intent putExtra(String name, byte[] value) {
3626 if (mExtras == null) {
3627 mExtras = new Bundle();
3628 }
3629 mExtras.putByteArray(name, value);
3630 return this;
3631 }
3632
3633 /**
3634 * Add extended data to the intent. The name must include a package
3635 * prefix, for example the app com.android.contacts would use names
3636 * like "com.android.contacts.ShowAll".
3637 *
3638 * @param name The name of the extra data, with package prefix.
3639 * @param value The short array data value.
3640 *
3641 * @return Returns the same Intent object, for chaining multiple calls
3642 * into a single statement.
3643 *
3644 * @see #putExtras
3645 * @see #removeExtra
3646 * @see #getShortArrayExtra(String)
3647 */
3648 public Intent putExtra(String name, short[] value) {
3649 if (mExtras == null) {
3650 mExtras = new Bundle();
3651 }
3652 mExtras.putShortArray(name, value);
3653 return this;
3654 }
3655
3656 /**
3657 * Add extended data to the intent. The name must include a package
3658 * prefix, for example the app com.android.contacts would use names
3659 * like "com.android.contacts.ShowAll".
3660 *
3661 * @param name The name of the extra data, with package prefix.
3662 * @param value The char array data value.
3663 *
3664 * @return Returns the same Intent object, for chaining multiple calls
3665 * into a single statement.
3666 *
3667 * @see #putExtras
3668 * @see #removeExtra
3669 * @see #getCharArrayExtra(String)
3670 */
3671 public Intent putExtra(String name, char[] value) {
3672 if (mExtras == null) {
3673 mExtras = new Bundle();
3674 }
3675 mExtras.putCharArray(name, value);
3676 return this;
3677 }
3678
3679 /**
3680 * Add extended data to the intent. The name must include a package
3681 * prefix, for example the app com.android.contacts would use names
3682 * like "com.android.contacts.ShowAll".
3683 *
3684 * @param name The name of the extra data, with package prefix.
3685 * @param value The int array data value.
3686 *
3687 * @return Returns the same Intent object, for chaining multiple calls
3688 * into a single statement.
3689 *
3690 * @see #putExtras
3691 * @see #removeExtra
3692 * @see #getIntArrayExtra(String)
3693 */
3694 public Intent putExtra(String name, int[] value) {
3695 if (mExtras == null) {
3696 mExtras = new Bundle();
3697 }
3698 mExtras.putIntArray(name, value);
3699 return this;
3700 }
3701
3702 /**
3703 * Add extended data to the intent. The name must include a package
3704 * prefix, for example the app com.android.contacts would use names
3705 * like "com.android.contacts.ShowAll".
3706 *
3707 * @param name The name of the extra data, with package prefix.
3708 * @param value The byte array data value.
3709 *
3710 * @return Returns the same Intent object, for chaining multiple calls
3711 * into a single statement.
3712 *
3713 * @see #putExtras
3714 * @see #removeExtra
3715 * @see #getLongArrayExtra(String)
3716 */
3717 public Intent putExtra(String name, long[] value) {
3718 if (mExtras == null) {
3719 mExtras = new Bundle();
3720 }
3721 mExtras.putLongArray(name, value);
3722 return this;
3723 }
3724
3725 /**
3726 * Add extended data to the intent. The name must include a package
3727 * prefix, for example the app com.android.contacts would use names
3728 * like "com.android.contacts.ShowAll".
3729 *
3730 * @param name The name of the extra data, with package prefix.
3731 * @param value The float array data value.
3732 *
3733 * @return Returns the same Intent object, for chaining multiple calls
3734 * into a single statement.
3735 *
3736 * @see #putExtras
3737 * @see #removeExtra
3738 * @see #getFloatArrayExtra(String)
3739 */
3740 public Intent putExtra(String name, float[] value) {
3741 if (mExtras == null) {
3742 mExtras = new Bundle();
3743 }
3744 mExtras.putFloatArray(name, value);
3745 return this;
3746 }
3747
3748 /**
3749 * Add extended data to the intent. The name must include a package
3750 * prefix, for example the app com.android.contacts would use names
3751 * like "com.android.contacts.ShowAll".
3752 *
3753 * @param name The name of the extra data, with package prefix.
3754 * @param value The double array data value.
3755 *
3756 * @return Returns the same Intent object, for chaining multiple calls
3757 * into a single statement.
3758 *
3759 * @see #putExtras
3760 * @see #removeExtra
3761 * @see #getDoubleArrayExtra(String)
3762 */
3763 public Intent putExtra(String name, double[] value) {
3764 if (mExtras == null) {
3765 mExtras = new Bundle();
3766 }
3767 mExtras.putDoubleArray(name, value);
3768 return this;
3769 }
3770
3771 /**
3772 * Add extended data to the intent. The name must include a package
3773 * prefix, for example the app com.android.contacts would use names
3774 * like "com.android.contacts.ShowAll".
3775 *
3776 * @param name The name of the extra data, with package prefix.
3777 * @param value The String array data value.
3778 *
3779 * @return Returns the same Intent object, for chaining multiple calls
3780 * into a single statement.
3781 *
3782 * @see #putExtras
3783 * @see #removeExtra
3784 * @see #getStringArrayExtra(String)
3785 */
3786 public Intent putExtra(String name, String[] value) {
3787 if (mExtras == null) {
3788 mExtras = new Bundle();
3789 }
3790 mExtras.putStringArray(name, value);
3791 return this;
3792 }
3793
3794 /**
3795 * Add extended data to the intent. The name must include a package
3796 * prefix, for example the app com.android.contacts would use names
3797 * like "com.android.contacts.ShowAll".
3798 *
3799 * @param name The name of the extra data, with package prefix.
3800 * @param value The Bundle data value.
3801 *
3802 * @return Returns the same Intent object, for chaining multiple calls
3803 * into a single statement.
3804 *
3805 * @see #putExtras
3806 * @see #removeExtra
3807 * @see #getBundleExtra(String)
3808 */
3809 public Intent putExtra(String name, Bundle value) {
3810 if (mExtras == null) {
3811 mExtras = new Bundle();
3812 }
3813 mExtras.putBundle(name, value);
3814 return this;
3815 }
3816
3817 /**
3818 * Add extended data to the intent. The name must include a package
3819 * prefix, for example the app com.android.contacts would use names
3820 * like "com.android.contacts.ShowAll".
3821 *
3822 * @param name The name of the extra data, with package prefix.
3823 * @param value The IBinder data value.
3824 *
3825 * @return Returns the same Intent object, for chaining multiple calls
3826 * into a single statement.
3827 *
3828 * @see #putExtras
3829 * @see #removeExtra
3830 * @see #getIBinderExtra(String)
3831 *
3832 * @deprecated
3833 * @hide
3834 */
3835 @Deprecated
3836 public Intent putExtra(String name, IBinder value) {
3837 if (mExtras == null) {
3838 mExtras = new Bundle();
3839 }
3840 mExtras.putIBinder(name, value);
3841 return this;
3842 }
3843
3844 /**
3845 * Copy all extras in 'src' in to this intent.
3846 *
3847 * @param src Contains the extras to copy.
3848 *
3849 * @see #putExtra
3850 */
3851 public Intent putExtras(Intent src) {
3852 if (src.mExtras != null) {
3853 if (mExtras == null) {
3854 mExtras = new Bundle(src.mExtras);
3855 } else {
3856 mExtras.putAll(src.mExtras);
3857 }
3858 }
3859 return this;
3860 }
3861
3862 /**
3863 * Add a set of extended data to the intent. The keys must include a package
3864 * prefix, for example the app com.android.contacts would use names
3865 * like "com.android.contacts.ShowAll".
3866 *
3867 * @param extras The Bundle of extras to add to this intent.
3868 *
3869 * @see #putExtra
3870 * @see #removeExtra
3871 */
3872 public Intent putExtras(Bundle extras) {
3873 if (mExtras == null) {
3874 mExtras = new Bundle();
3875 }
3876 mExtras.putAll(extras);
3877 return this;
3878 }
3879
3880 /**
3881 * Completely replace the extras in the Intent with the extras in the
3882 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07003883 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003884 * @param src The exact extras contained in this Intent are copied
3885 * into the target intent, replacing any that were previously there.
3886 */
3887 public Intent replaceExtras(Intent src) {
3888 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
3889 return this;
3890 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003891
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003892 /**
3893 * Completely replace the extras in the Intent with the given Bundle of
3894 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07003895 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003896 * @param extras The new set of extras in the Intent, or null to erase
3897 * all extras.
3898 */
3899 public Intent replaceExtras(Bundle extras) {
3900 mExtras = extras != null ? new Bundle(extras) : null;
3901 return this;
3902 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003903
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003904 /**
3905 * Remove extended data from the intent.
3906 *
3907 * @see #putExtra
3908 */
3909 public void removeExtra(String name) {
3910 if (mExtras != null) {
3911 mExtras.remove(name);
3912 if (mExtras.size() == 0) {
3913 mExtras = null;
3914 }
3915 }
3916 }
3917
3918 /**
3919 * Set special flags controlling how this intent is handled. Most values
3920 * here depend on the type of component being executed by the Intent,
3921 * specifically the FLAG_ACTIVITY_* flags are all for use with
3922 * {@link Context#startActivity Context.startActivity()} and the
3923 * FLAG_RECEIVER_* flags are all for use with
3924 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
3925 *
3926 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
3927 * Activities and Tasks</a> documentation for important information on how some of these options impact
3928 * the behavior of your application.
3929 *
3930 * @param flags The desired flags.
3931 *
3932 * @return Returns the same Intent object, for chaining multiple calls
3933 * into a single statement.
3934 *
3935 * @see #getFlags
3936 * @see #addFlags
3937 *
3938 * @see #FLAG_GRANT_READ_URI_PERMISSION
3939 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
3940 * @see #FLAG_DEBUG_LOG_RESOLUTION
3941 * @see #FLAG_FROM_BACKGROUND
3942 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
3943 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
3944 * @see #FLAG_ACTIVITY_CLEAR_TOP
3945 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
3946 * @see #FLAG_ACTIVITY_FORWARD_RESULT
3947 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
3948 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3949 * @see #FLAG_ACTIVITY_NEW_TASK
3950 * @see #FLAG_ACTIVITY_NO_HISTORY
3951 * @see #FLAG_ACTIVITY_NO_USER_ACTION
3952 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
3953 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
3954 * @see #FLAG_ACTIVITY_SINGLE_TOP
3955 * @see #FLAG_RECEIVER_REGISTERED_ONLY
3956 */
3957 public Intent setFlags(int flags) {
3958 mFlags = flags;
3959 return this;
3960 }
3961
3962 /**
3963 * Add additional flags to the intent (or with existing flags
3964 * value).
3965 *
3966 * @param flags The new flags to set.
3967 *
3968 * @return Returns the same Intent object, for chaining multiple calls
3969 * into a single statement.
3970 *
3971 * @see #setFlags
3972 */
3973 public Intent addFlags(int flags) {
3974 mFlags |= flags;
3975 return this;
3976 }
3977
3978 /**
3979 * (Usually optional) Explicitly set the component to handle the intent.
3980 * If left with the default value of null, the system will determine the
3981 * appropriate class to use based on the other fields (action, data,
3982 * type, categories) in the Intent. If this class is defined, the
3983 * specified class will always be used regardless of the other fields. You
3984 * should only set this value when you know you absolutely want a specific
3985 * class to be used; otherwise it is better to let the system find the
3986 * appropriate class so that you will respect the installed applications
3987 * and user preferences.
3988 *
3989 * @param component The name of the application component to handle the
3990 * intent, or null to let the system find one for you.
3991 *
3992 * @return Returns the same Intent object, for chaining multiple calls
3993 * into a single statement.
3994 *
3995 * @see #setClass
3996 * @see #setClassName(Context, String)
3997 * @see #setClassName(String, String)
3998 * @see #getComponent
3999 * @see #resolveActivity
4000 */
4001 public Intent setComponent(ComponentName component) {
4002 mComponent = component;
4003 return this;
4004 }
4005
4006 /**
4007 * Convenience for calling {@link #setComponent} with an
4008 * explicit class name.
4009 *
4010 * @param packageContext A Context of the application package implementing
4011 * this class.
4012 * @param className The name of a class inside of the application package
4013 * that will be used as the component for this Intent.
4014 *
4015 * @return Returns the same Intent object, for chaining multiple calls
4016 * into a single statement.
4017 *
4018 * @see #setComponent
4019 * @see #setClass
4020 */
4021 public Intent setClassName(Context packageContext, String className) {
4022 mComponent = new ComponentName(packageContext, className);
4023 return this;
4024 }
4025
4026 /**
4027 * Convenience for calling {@link #setComponent} with an
4028 * explicit application package name and class name.
4029 *
4030 * @param packageName The name of the package implementing the desired
4031 * component.
4032 * @param className The name of a class inside of the application package
4033 * that will be used as the component for this Intent.
4034 *
4035 * @return Returns the same Intent object, for chaining multiple calls
4036 * into a single statement.
4037 *
4038 * @see #setComponent
4039 * @see #setClass
4040 */
4041 public Intent setClassName(String packageName, String className) {
4042 mComponent = new ComponentName(packageName, className);
4043 return this;
4044 }
4045
4046 /**
4047 * Convenience for calling {@link #setComponent(ComponentName)} with the
4048 * name returned by a {@link Class} object.
4049 *
4050 * @param packageContext A Context of the application package implementing
4051 * this class.
4052 * @param cls The class name to set, equivalent to
4053 * <code>setClassName(context, cls.getName())</code>.
4054 *
4055 * @return Returns the same Intent object, for chaining multiple calls
4056 * into a single statement.
4057 *
4058 * @see #setComponent
4059 */
4060 public Intent setClass(Context packageContext, Class<?> cls) {
4061 mComponent = new ComponentName(packageContext, cls);
4062 return this;
4063 }
4064
4065 /**
4066 * Use with {@link #fillIn} to allow the current action value to be
4067 * overwritten, even if it is already set.
4068 */
4069 public static final int FILL_IN_ACTION = 1<<0;
4070
4071 /**
4072 * Use with {@link #fillIn} to allow the current data or type value
4073 * overwritten, even if it is already set.
4074 */
4075 public static final int FILL_IN_DATA = 1<<1;
4076
4077 /**
4078 * Use with {@link #fillIn} to allow the current categories to be
4079 * overwritten, even if they are already set.
4080 */
4081 public static final int FILL_IN_CATEGORIES = 1<<2;
4082
4083 /**
4084 * Use with {@link #fillIn} to allow the current component value to be
4085 * overwritten, even if it is already set.
4086 */
4087 public static final int FILL_IN_COMPONENT = 1<<3;
4088
4089 /**
4090 * Copy the contents of <var>other</var> in to this object, but only
4091 * where fields are not defined by this object. For purposes of a field
4092 * being defined, the following pieces of data in the Intent are
4093 * considered to be separate fields:
4094 *
4095 * <ul>
4096 * <li> action, as set by {@link #setAction}.
4097 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4098 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4099 * <li> categories, as set by {@link #addCategory}.
4100 * <li> component, as set by {@link #setComponent(ComponentName)} or
4101 * related methods.
4102 * <li> each top-level name in the associated extras.
4103 * </ul>
4104 *
4105 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
4106 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, and
4107 * {@link #FILL_IN_COMPONENT} to override the restriction where the
4108 * corresponding field will not be replaced if it is already set.
4109 *
4110 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4111 * and Intent B with {action="gotit", data-type="some/thing",
4112 * categories="one","two"}.
4113 *
4114 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4115 * containing: {action="gotit", data-type="some/thing",
4116 * categories="bar"}.
4117 *
4118 * @param other Another Intent whose values are to be used to fill in
4119 * the current one.
4120 * @param flags Options to control which fields can be filled in.
4121 *
4122 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
4123 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, and
4124 * {@link #FILL_IN_COMPONENT} indicating which fields were changed.
4125 */
4126 public int fillIn(Intent other, int flags) {
4127 int changes = 0;
4128 if ((mAction == null && other.mAction == null)
4129 || (flags&FILL_IN_ACTION) != 0) {
4130 mAction = other.mAction;
4131 changes |= FILL_IN_ACTION;
4132 }
4133 if ((mData == null && mType == null &&
4134 (other.mData != null || other.mType != null))
4135 || (flags&FILL_IN_DATA) != 0) {
4136 mData = other.mData;
4137 mType = other.mType;
4138 changes |= FILL_IN_DATA;
4139 }
4140 if ((mCategories == null && other.mCategories == null)
4141 || (flags&FILL_IN_CATEGORIES) != 0) {
4142 if (other.mCategories != null) {
4143 mCategories = new HashSet<String>(other.mCategories);
4144 }
4145 changes |= FILL_IN_CATEGORIES;
4146 }
4147 if ((mComponent == null && other.mComponent == null)
4148 || (flags&FILL_IN_COMPONENT) != 0) {
4149 mComponent = other.mComponent;
4150 changes |= FILL_IN_COMPONENT;
4151 }
4152 mFlags |= other.mFlags;
4153 if (mExtras == null) {
4154 if (other.mExtras != null) {
4155 mExtras = new Bundle(other.mExtras);
4156 }
4157 } else if (other.mExtras != null) {
4158 try {
4159 Bundle newb = new Bundle(other.mExtras);
4160 newb.putAll(mExtras);
4161 mExtras = newb;
4162 } catch (RuntimeException e) {
4163 // Modifying the extras can cause us to unparcel the contents
4164 // of the bundle, and if we do this in the system process that
4165 // may fail. We really should handle this (i.e., the Bundle
4166 // impl shouldn't be on top of a plain map), but for now just
4167 // ignore it and keep the original contents. :(
4168 Log.w("Intent", "Failure filling in extras", e);
4169 }
4170 }
4171 return changes;
4172 }
4173
4174 /**
4175 * Wrapper class holding an Intent and implementing comparisons on it for
4176 * the purpose of filtering. The class implements its
4177 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4178 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4179 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4180 * on the wrapped Intent.
4181 */
4182 public static final class FilterComparison {
4183 private final Intent mIntent;
4184 private final int mHashCode;
4185
4186 public FilterComparison(Intent intent) {
4187 mIntent = intent;
4188 mHashCode = intent.filterHashCode();
4189 }
4190
4191 /**
4192 * Return the Intent that this FilterComparison represents.
4193 * @return Returns the Intent held by the FilterComparison. Do
4194 * not modify!
4195 */
4196 public Intent getIntent() {
4197 return mIntent;
4198 }
4199
4200 @Override
4201 public boolean equals(Object obj) {
4202 if (obj instanceof FilterComparison) {
4203 Intent other = ((FilterComparison)obj).mIntent;
4204 return mIntent.filterEquals(other);
4205 }
4206 return false;
4207 }
4208
4209 @Override
4210 public int hashCode() {
4211 return mHashCode;
4212 }
4213 }
4214
4215 /**
4216 * Determine if two intents are the same for the purposes of intent
4217 * resolution (filtering). That is, if their action, data, type,
4218 * class, and categories are the same. This does <em>not</em> compare
4219 * any extra data included in the intents.
4220 *
4221 * @param other The other Intent to compare against.
4222 *
4223 * @return Returns true if action, data, type, class, and categories
4224 * are the same.
4225 */
4226 public boolean filterEquals(Intent other) {
4227 if (other == null) {
4228 return false;
4229 }
4230 if (mAction != other.mAction) {
4231 if (mAction != null) {
4232 if (!mAction.equals(other.mAction)) {
4233 return false;
4234 }
4235 } else {
4236 if (!other.mAction.equals(mAction)) {
4237 return false;
4238 }
4239 }
4240 }
4241 if (mData != other.mData) {
4242 if (mData != null) {
4243 if (!mData.equals(other.mData)) {
4244 return false;
4245 }
4246 } else {
4247 if (!other.mData.equals(mData)) {
4248 return false;
4249 }
4250 }
4251 }
4252 if (mType != other.mType) {
4253 if (mType != null) {
4254 if (!mType.equals(other.mType)) {
4255 return false;
4256 }
4257 } else {
4258 if (!other.mType.equals(mType)) {
4259 return false;
4260 }
4261 }
4262 }
4263 if (mComponent != other.mComponent) {
4264 if (mComponent != null) {
4265 if (!mComponent.equals(other.mComponent)) {
4266 return false;
4267 }
4268 } else {
4269 if (!other.mComponent.equals(mComponent)) {
4270 return false;
4271 }
4272 }
4273 }
4274 if (mCategories != other.mCategories) {
4275 if (mCategories != null) {
4276 if (!mCategories.equals(other.mCategories)) {
4277 return false;
4278 }
4279 } else {
4280 if (!other.mCategories.equals(mCategories)) {
4281 return false;
4282 }
4283 }
4284 }
4285
4286 return true;
4287 }
4288
4289 /**
4290 * Generate hash code that matches semantics of filterEquals().
4291 *
4292 * @return Returns the hash value of the action, data, type, class, and
4293 * categories.
4294 *
4295 * @see #filterEquals
4296 */
4297 public int filterHashCode() {
4298 int code = 0;
4299 if (mAction != null) {
4300 code += mAction.hashCode();
4301 }
4302 if (mData != null) {
4303 code += mData.hashCode();
4304 }
4305 if (mType != null) {
4306 code += mType.hashCode();
4307 }
4308 if (mComponent != null) {
4309 code += mComponent.hashCode();
4310 }
4311 if (mCategories != null) {
4312 code += mCategories.hashCode();
4313 }
4314 return code;
4315 }
4316
4317 @Override
4318 public String toString() {
4319 StringBuilder b = new StringBuilder();
4320
4321 b.append("Intent {");
4322 if (mAction != null) b.append(" action=").append(mAction);
4323 if (mCategories != null) {
4324 b.append(" categories={");
4325 Iterator<String> i = mCategories.iterator();
4326 boolean didone = false;
4327 while (i.hasNext()) {
4328 if (didone) b.append(",");
4329 didone = true;
4330 b.append(i.next());
4331 }
4332 b.append("}");
4333 }
4334 if (mData != null) b.append(" data=").append(mData);
4335 if (mType != null) b.append(" type=").append(mType);
4336 if (mFlags != 0) b.append(" flags=0x").append(Integer.toHexString(mFlags));
4337 if (mComponent != null) b.append(" comp=").append(mComponent.toShortString());
4338 if (mExtras != null) b.append(" (has extras)");
4339 b.append(" }");
4340
4341 return b.toString();
4342 }
4343
4344 public String toURI() {
4345 StringBuilder uri = new StringBuilder(mData != null ? mData.toString() : "");
4346
4347 uri.append("#Intent;");
4348
4349 if (mAction != null) {
4350 uri.append("action=").append(mAction).append(';');
4351 }
4352 if (mCategories != null) {
4353 for (String category : mCategories) {
4354 uri.append("category=").append(category).append(';');
4355 }
4356 }
4357 if (mType != null) {
4358 uri.append("type=").append(mType).append(';');
4359 }
4360 if (mFlags != 0) {
4361 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
4362 }
4363 if (mComponent != null) {
4364 uri.append("component=").append(mComponent.flattenToShortString()).append(';');
4365 }
4366 if (mExtras != null) {
4367 for (String key : mExtras.keySet()) {
4368 final Object value = mExtras.get(key);
4369 char entryType =
4370 value instanceof String ? 'S' :
4371 value instanceof Boolean ? 'B' :
4372 value instanceof Byte ? 'b' :
4373 value instanceof Character ? 'c' :
4374 value instanceof Double ? 'd' :
4375 value instanceof Float ? 'f' :
4376 value instanceof Integer ? 'i' :
4377 value instanceof Long ? 'l' :
4378 value instanceof Short ? 's' :
4379 '\0';
4380
4381 if (entryType != '\0') {
4382 uri.append(entryType);
4383 uri.append('.');
4384 uri.append(Uri.encode(key));
4385 uri.append('=');
4386 uri.append(Uri.encode(value.toString()));
4387 uri.append(';');
4388 }
4389 }
4390 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004391
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004392 uri.append("end");
4393
4394 return uri.toString();
4395 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004396
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004397 public int describeContents() {
4398 return (mExtras != null) ? mExtras.describeContents() : 0;
4399 }
4400
4401 public void writeToParcel(Parcel out, int flags) {
4402 out.writeString(mAction);
4403 Uri.writeToParcel(out, mData);
4404 out.writeString(mType);
4405 out.writeInt(mFlags);
4406 ComponentName.writeToParcel(mComponent, out);
4407
4408 if (mCategories != null) {
4409 out.writeInt(mCategories.size());
4410 for (String category : mCategories) {
4411 out.writeString(category);
4412 }
4413 } else {
4414 out.writeInt(0);
4415 }
4416
4417 out.writeBundle(mExtras);
4418 }
4419
4420 public static final Parcelable.Creator<Intent> CREATOR
4421 = new Parcelable.Creator<Intent>() {
4422 public Intent createFromParcel(Parcel in) {
4423 return new Intent(in);
4424 }
4425 public Intent[] newArray(int size) {
4426 return new Intent[size];
4427 }
4428 };
4429
4430 private Intent(Parcel in) {
4431 readFromParcel(in);
4432 }
4433
4434 public void readFromParcel(Parcel in) {
4435 mAction = in.readString();
4436 mData = Uri.CREATOR.createFromParcel(in);
4437 mType = in.readString();
4438 mFlags = in.readInt();
4439 mComponent = ComponentName.readFromParcel(in);
4440
4441 int N = in.readInt();
4442 if (N > 0) {
4443 mCategories = new HashSet<String>();
4444 int i;
4445 for (i=0; i<N; i++) {
4446 mCategories.add(in.readString());
4447 }
4448 } else {
4449 mCategories = null;
4450 }
4451
4452 mExtras = in.readBundle();
4453 }
4454
4455 /**
4456 * Parses the "intent" element (and its children) from XML and instantiates
4457 * an Intent object. The given XML parser should be located at the tag
4458 * where parsing should start (often named "intent"), from which the
4459 * basic action, data, type, and package and class name will be
4460 * retrieved. The function will then parse in to any child elements,
4461 * looking for <category android:name="xxx"> tags to add categories and
4462 * <extra android:name="xxx" android:value="yyy"> to attach extra data
4463 * to the intent.
4464 *
4465 * @param resources The Resources to use when inflating resources.
4466 * @param parser The XML parser pointing at an "intent" tag.
4467 * @param attrs The AttributeSet interface for retrieving extended
4468 * attribute data at the current <var>parser</var> location.
4469 * @return An Intent object matching the XML data.
4470 * @throws XmlPullParserException If there was an XML parsing error.
4471 * @throws IOException If there was an I/O error.
4472 */
4473 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
4474 throws XmlPullParserException, IOException {
4475 Intent intent = new Intent();
4476
4477 TypedArray sa = resources.obtainAttributes(attrs,
4478 com.android.internal.R.styleable.Intent);
4479
4480 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
4481
4482 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
4483 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
4484 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
4485
4486 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
4487 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
4488 if (packageName != null && className != null) {
4489 intent.setComponent(new ComponentName(packageName, className));
4490 }
4491
4492 sa.recycle();
4493
4494 int outerDepth = parser.getDepth();
4495 int type;
4496 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
4497 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
4498 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
4499 continue;
4500 }
4501
4502 String nodeName = parser.getName();
4503 if (nodeName.equals("category")) {
4504 sa = resources.obtainAttributes(attrs,
4505 com.android.internal.R.styleable.IntentCategory);
4506 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
4507 sa.recycle();
4508
4509 if (cat != null) {
4510 intent.addCategory(cat);
4511 }
4512 XmlUtils.skipCurrentTag(parser);
4513
4514 } else if (nodeName.equals("extra")) {
4515 if (intent.mExtras == null) {
4516 intent.mExtras = new Bundle();
4517 }
4518 resources.parseBundleExtra("extra", attrs, intent.mExtras);
4519 XmlUtils.skipCurrentTag(parser);
4520
4521 } else {
4522 XmlUtils.skipCurrentTag(parser);
4523 }
4524 }
4525
4526 return intent;
4527 }
4528}