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