blob: 24262f51197d5f44b1b6c2797d64fcc5176a24c8 [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}
Christopher Tate06ba5542009-04-09 16:03:56 -0700511 * <li> {@link #ACTION_POWER_CONNECTED}
512 * <li> {@link #ACTION_POWER_DISCONNECTED}
Dianne Hackborn55280a92009-05-07 15:53:46 -0700513 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800514 * </ul>
515 *
516 * <h3>Standard Categories</h3>
517 *
518 * <p>These are the current standard categories that can be used to further
519 * clarify an Intent via {@link #addCategory}.
520 *
521 * <ul>
522 * <li> {@link #CATEGORY_DEFAULT}
523 * <li> {@link #CATEGORY_BROWSABLE}
524 * <li> {@link #CATEGORY_TAB}
525 * <li> {@link #CATEGORY_ALTERNATIVE}
526 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
527 * <li> {@link #CATEGORY_LAUNCHER}
528 * <li> {@link #CATEGORY_INFO}
529 * <li> {@link #CATEGORY_HOME}
530 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800531 * <li> {@link #CATEGORY_TEST}
532 * </ul>
533 *
534 * <h3>Standard Extra Data</h3>
535 *
536 * <p>These are the current standard fields that can be used as extra data via
537 * {@link #putExtra}.
538 *
539 * <ul>
540 * <li> {@link #EXTRA_TEMPLATE}
541 * <li> {@link #EXTRA_INTENT}
542 * <li> {@link #EXTRA_STREAM}
543 * <li> {@link #EXTRA_TEXT}
544 * </ul>
545 *
546 * <h3>Flags</h3>
547 *
548 * <p>These are the possible flags that can be used in the Intent via
549 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
550 * of all possible flags.
551 */
552public class Intent implements Parcelable {
553 // ---------------------------------------------------------------------
554 // ---------------------------------------------------------------------
555 // Standard intent activity actions (see action variable).
556
557 /**
558 * Activity Action: Start as a main entry point, does not expect to
559 * receive data.
560 * <p>Input: nothing
561 * <p>Output: nothing
562 */
563 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
564 public static final String ACTION_MAIN = "android.intent.action.MAIN";
565
566 /**
567 * Activity Action: Display the data to the user. This is the most common
568 * action performed on data -- it is the generic action you can use on
569 * a piece of data to get the most reasonable thing to occur. For example,
570 * when used on a contacts entry it will view the entry; when used on a
571 * mailto: URI it will bring up a compose window filled with the information
572 * supplied by the URI; when used with a tel: URI it will invoke the
573 * dialer.
574 * <p>Input: {@link #getData} is URI from which to retrieve data.
575 * <p>Output: nothing.
576 */
577 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
578 public static final String ACTION_VIEW = "android.intent.action.VIEW";
579
580 /**
581 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
582 * performed on a piece of data.
583 */
584 public static final String ACTION_DEFAULT = ACTION_VIEW;
585
586 /**
587 * Used to indicate that some piece of data should be attached to some other
588 * place. For example, image data could be attached to a contact. It is up
589 * to the recipient to decide where the data should be attached; the intent
590 * does not specify the ultimate destination.
591 * <p>Input: {@link #getData} is URI of data to be attached.
592 * <p>Output: nothing.
593 */
594 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
595 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
596
597 /**
598 * Activity Action: Provide explicit editable access to the given data.
599 * <p>Input: {@link #getData} is URI of data to be edited.
600 * <p>Output: nothing.
601 */
602 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
603 public static final String ACTION_EDIT = "android.intent.action.EDIT";
604
605 /**
606 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
607 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
608 * The extras can contain type specific data to pass through to the editing/creating
609 * activity.
610 * <p>Output: The URI of the item that was picked. This must be a content:
611 * URI so that any receiver can access it.
612 */
613 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
614 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
615
616 /**
617 * Activity Action: Pick an item from the data, returning what was selected.
618 * <p>Input: {@link #getData} is URI containing a directory of data
619 * (vnd.android.cursor.dir/*) from which to pick an item.
620 * <p>Output: The URI of the item that was picked.
621 */
622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
623 public static final String ACTION_PICK = "android.intent.action.PICK";
624
625 /**
626 * Activity Action: Creates a shortcut.
627 * <p>Input: Nothing.</p>
628 * <p>Output: An Intent representing the shortcut. The intent must contain three
629 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
630 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
631 * (value: ShortcutIconResource).</p>
632 *
633 * @see #EXTRA_SHORTCUT_INTENT
634 * @see #EXTRA_SHORTCUT_NAME
635 * @see #EXTRA_SHORTCUT_ICON
636 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
637 * @see android.content.Intent.ShortcutIconResource
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
641
642 /**
643 * The name of the extra used to define the Intent of a shortcut.
644 *
645 * @see #ACTION_CREATE_SHORTCUT
646 */
647 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
648 /**
649 * The name of the extra used to define the name of a shortcut.
650 *
651 * @see #ACTION_CREATE_SHORTCUT
652 */
653 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
654 /**
655 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
656 *
657 * @see #ACTION_CREATE_SHORTCUT
658 */
659 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
660 /**
661 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
662 *
663 * @see #ACTION_CREATE_SHORTCUT
664 * @see android.content.Intent.ShortcutIconResource
665 */
666 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
667 "android.intent.extra.shortcut.ICON_RESOURCE";
668
669 /**
670 * Represents a shortcut/live folder icon resource.
671 *
672 * @see Intent#ACTION_CREATE_SHORTCUT
673 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
674 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
675 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
676 */
677 public static class ShortcutIconResource implements Parcelable {
678 /**
679 * The package name of the application containing the icon.
680 */
681 public String packageName;
682
683 /**
684 * The resource name of the icon, including package, name and type.
685 */
686 public String resourceName;
687
688 /**
689 * Creates a new ShortcutIconResource for the specified context and resource
690 * identifier.
691 *
692 * @param context The context of the application.
693 * @param resourceId The resource idenfitier for the icon.
694 * @return A new ShortcutIconResource with the specified's context package name
695 * and icon resource idenfitier.
696 */
697 public static ShortcutIconResource fromContext(Context context, int resourceId) {
698 ShortcutIconResource icon = new ShortcutIconResource();
699 icon.packageName = context.getPackageName();
700 icon.resourceName = context.getResources().getResourceName(resourceId);
701 return icon;
702 }
703
704 /**
705 * Used to read a ShortcutIconResource from a Parcel.
706 */
707 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
708 new Parcelable.Creator<ShortcutIconResource>() {
709
710 public ShortcutIconResource createFromParcel(Parcel source) {
711 ShortcutIconResource icon = new ShortcutIconResource();
712 icon.packageName = source.readString();
713 icon.resourceName = source.readString();
714 return icon;
715 }
716
717 public ShortcutIconResource[] newArray(int size) {
718 return new ShortcutIconResource[size];
719 }
720 };
721
722 /**
723 * No special parcel contents.
724 */
725 public int describeContents() {
726 return 0;
727 }
728
729 public void writeToParcel(Parcel dest, int flags) {
730 dest.writeString(packageName);
731 dest.writeString(resourceName);
732 }
733
734 @Override
735 public String toString() {
736 return resourceName;
737 }
738 }
739
740 /**
741 * Activity Action: Display an activity chooser, allowing the user to pick
742 * what they want to before proceeding. This can be used as an alternative
743 * to the standard activity picker that is displayed by the system when
744 * you try to start an activity with multiple possible matches, with these
745 * differences in behavior:
746 * <ul>
747 * <li>You can specify the title that will appear in the activity chooser.
748 * <li>The user does not have the option to make one of the matching
749 * activities a preferred activity, and all possible activities will
750 * always be shown even if one of them is currently marked as the
751 * preferred activity.
752 * </ul>
753 * <p>
754 * This action should be used when the user will naturally expect to
755 * select an activity in order to proceed. An example if when not to use
756 * it is when the user clicks on a "mailto:" link. They would naturally
757 * expect to go directly to their mail app, so startActivity() should be
758 * called directly: it will
759 * either launch the current preferred app, or put up a dialog allowing the
760 * user to pick an app to use and optionally marking that as preferred.
761 * <p>
762 * In contrast, if the user is selecting a menu item to send a picture
763 * they are viewing to someone else, there are many different things they
764 * may want to do at this point: send it through e-mail, upload it to a
765 * web service, etc. In this case the CHOOSER action should be used, to
766 * always present to the user a list of the things they can do, with a
767 * nice title given by the caller such as "Send this photo with:".
768 * <p>
769 * As a convenience, an Intent of this form can be created with the
770 * {@link #createChooser} function.
771 * <p>Input: No data should be specified. get*Extra must have
772 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
773 * and can optionally have a {@link #EXTRA_TITLE} field containing the
774 * title text to display in the chooser.
775 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
776 */
777 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
778 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
779
780 /**
781 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
782 *
783 * @param target The Intent that the user will be selecting an activity
784 * to perform.
785 * @param title Optional title that will be displayed in the chooser.
786 * @return Return a new Intent object that you can hand to
787 * {@link Context#startActivity(Intent) Context.startActivity()} and
788 * related methods.
789 */
790 public static Intent createChooser(Intent target, CharSequence title) {
791 Intent intent = new Intent(ACTION_CHOOSER);
792 intent.putExtra(EXTRA_INTENT, target);
793 if (title != null) {
794 intent.putExtra(EXTRA_TITLE, title);
795 }
796 return intent;
797 }
798 /**
799 * Activity Action: Allow the user to select a particular kind of data and
800 * return it. This is different than {@link #ACTION_PICK} in that here we
801 * just say what kind of data is desired, not a URI of existing data from
802 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
803 * create the data as it runs (for example taking a picture or recording a
804 * sound), let them browser over the web and download the desired data,
805 * etc.
806 * <p>
807 * There are two main ways to use this action: if you want an specific kind
808 * of data, such as a person contact, you set the MIME type to the kind of
809 * data you want and launch it with {@link Context#startActivity(Intent)}.
810 * The system will then launch the best application to select that kind
811 * of data for you.
812 * <p>
813 * You may also be interested in any of a set of types of content the user
814 * can pick. For example, an e-mail application that wants to allow the
815 * user to add an attachment to an e-mail message can use this action to
816 * bring up a list of all of the types of content the user can attach.
817 * <p>
818 * In this case, you should wrap the GET_CONTENT intent with a chooser
819 * (through {@link #createChooser}), which will give the proper interface
820 * for the user to pick how to send your data and allow you to specify
821 * a prompt indicating what they are doing. You will usually specify a
822 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
823 * broad range of content types the user can select from.
824 * <p>
825 * When using such a broad GET_CONTENT action, it is often desireable to
826 * only pick from data that can be represented as a stream. This is
827 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
828 * <p>
829 * Input: {@link #getType} is the desired MIME type to retrieve. Note
830 * that no URI is supplied in the intent, as there are no constraints on
831 * where the returned data originally comes from. You may also include the
832 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
833 * opened as a stream.
834 * <p>
835 * Output: The URI of the item that was picked. This must be a content:
836 * URI so that any receiver can access it.
837 */
838 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
839 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
840 /**
841 * Activity Action: Dial a number as specified by the data. This shows a
842 * UI with the number being dialed, allowing the user to explicitly
843 * initiate the call.
844 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
845 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
846 * number.
847 * <p>Output: nothing.
848 */
849 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
850 public static final String ACTION_DIAL = "android.intent.action.DIAL";
851 /**
852 * Activity Action: Perform a call to someone specified by the data.
853 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
854 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
855 * number.
856 * <p>Output: nothing.
857 *
858 * <p>Note: there will be restrictions on which applications can initiate a
859 * call; most applications should use the {@link #ACTION_DIAL}.
860 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
861 * numbers. Applications can <strong>dial</strong> emergency numbers using
862 * {@link #ACTION_DIAL}, however.
863 */
864 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
865 public static final String ACTION_CALL = "android.intent.action.CALL";
866 /**
867 * Activity Action: Perform a call to an emergency number specified by the
868 * data.
869 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
870 * tel: URI of an explicit phone number.
871 * <p>Output: nothing.
872 * @hide
873 */
874 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
875 /**
876 * Activity action: Perform a call to any number (emergency or not)
877 * specified by the data.
878 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
879 * tel: URI of an explicit phone number.
880 * <p>Output: nothing.
881 * @hide
882 */
883 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
884 /**
885 * Activity Action: Send a message to someone specified by the data.
886 * <p>Input: {@link #getData} is URI describing the target.
887 * <p>Output: nothing.
888 */
889 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
890 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
891 /**
892 * Activity Action: Deliver some data to someone else. Who the data is
893 * being delivered to is not specified; it is up to the receiver of this
894 * action to ask the user where the data should be sent.
895 * <p>
896 * When launching a SEND intent, you should usually wrap it in a chooser
897 * (through {@link #createChooser}), which will give the proper interface
898 * for the user to pick how to send your data and allow you to specify
899 * a prompt indicating what they are doing.
900 * <p>
901 * Input: {@link #getType} is the MIME type of the data being sent.
902 * get*Extra can have either a {@link #EXTRA_TEXT}
903 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
904 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
905 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
906 * if the MIME type is unknown (this will only allow senders that can
907 * handle generic data streams).
908 * <p>
909 * Optional standard extras, which may be interpreted by some recipients as
910 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
911 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
912 * <p>
913 * Output: nothing.
914 */
915 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
916 public static final String ACTION_SEND = "android.intent.action.SEND";
917 /**
918 * Activity Action: Handle an incoming phone call.
919 * <p>Input: nothing.
920 * <p>Output: nothing.
921 */
922 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
923 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
924 /**
925 * Activity Action: Insert an empty item into the given container.
926 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
927 * in which to place the data.
928 * <p>Output: URI of the new data that was created.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_INSERT = "android.intent.action.INSERT";
932 /**
933 * Activity Action: Delete the given data from its container.
934 * <p>Input: {@link #getData} is URI of data to be deleted.
935 * <p>Output: nothing.
936 */
937 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
938 public static final String ACTION_DELETE = "android.intent.action.DELETE";
939 /**
940 * Activity Action: Run the data, whatever that means.
941 * <p>Input: ? (Note: this is currently specific to the test harness.)
942 * <p>Output: nothing.
943 */
944 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
945 public static final String ACTION_RUN = "android.intent.action.RUN";
946 /**
947 * Activity Action: Perform a data synchronization.
948 * <p>Input: ?
949 * <p>Output: ?
950 */
951 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
952 public static final String ACTION_SYNC = "android.intent.action.SYNC";
953 /**
954 * Activity Action: Pick an activity given an intent, returning the class
955 * selected.
956 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
957 * used with {@link PackageManager#queryIntentActivities} to determine the
958 * set of activities from which to pick.
959 * <p>Output: Class name of the activity that was selected.
960 */
961 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
962 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
963 /**
964 * Activity Action: Perform a search.
965 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
966 * is the text to search for. If empty, simply
967 * enter your search results Activity with the search UI activated.
968 * <p>Output: nothing.
969 */
970 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
971 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
972 /**
Jim Miller303736d2009-03-25 18:18:34 -0700973 * Activity Action: Start the platform-defined tutorial
974 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
975 * is the text to search for. If empty, simply
976 * enter your search results Activity with the search UI activated.
977 * <p>Output: nothing.
978 */
979 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
980 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
981 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800982 * Activity Action: Perform a web search.
983 * <p>
984 * Input: {@link android.app.SearchManager#QUERY
985 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
986 * a url starts with http or https, the site will be opened. If it is plain
987 * text, Google search will be applied.
988 * <p>
989 * Output: nothing.
990 */
991 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
992 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
993 /**
994 * Activity Action: List all available applications
995 * <p>Input: Nothing.
996 * <p>Output: nothing.
997 */
998 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
999 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1000 /**
1001 * Activity Action: Show settings for choosing wallpaper
1002 * <p>Input: Nothing.
1003 * <p>Output: Nothing.
1004 */
1005 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1006 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1007
1008 /**
1009 * Activity Action: Show activity for reporting a bug.
1010 * <p>Input: Nothing.
1011 * <p>Output: Nothing.
1012 */
1013 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1014 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1015
1016 /**
1017 * Activity Action: Main entry point for factory tests. Only used when
1018 * the device is booting in factory test node. The implementing package
1019 * must be installed in the system image.
1020 * <p>Input: nothing
1021 * <p>Output: nothing
1022 */
1023 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1024
1025 /**
1026 * Activity Action: The user pressed the "call" button to go to the dialer
1027 * or other appropriate UI for placing a call.
1028 * <p>Input: Nothing.
1029 * <p>Output: Nothing.
1030 */
1031 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1032 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1033
1034 /**
1035 * Activity Action: Start Voice Command.
1036 * <p>Input: Nothing.
1037 * <p>Output: Nothing.
1038 */
1039 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1040 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001041
1042 /**
1043 * Activity Action: Start action associated with long pressing on the
1044 * search key.
1045 * <p>Input: Nothing.
1046 * <p>Output: Nothing.
1047 */
1048 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1049 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001050
Jacek Surazski86b6c532009-05-13 14:38:28 +02001051 /**
1052 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1053 * This intent is delivered to the package which installed the application, usually
1054 * the Market.
1055 * <p>Input: No data is specified. The bug report is passed in using
1056 * an {@link #EXTRA_BUG_REPORT} field.
1057 * <p>Output: Nothing.
1058 * @hide
1059 */
1060 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1061 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001062 // ---------------------------------------------------------------------
1063 // ---------------------------------------------------------------------
1064 // Standard intent broadcast actions (see action variable).
1065
1066 /**
1067 * Broadcast Action: Sent after the screen turns off.
1068 */
1069 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1070 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1071 /**
1072 * Broadcast Action: Sent after the screen turns on.
1073 */
1074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1075 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001076
1077 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001078 * 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 -07001079 * keyguard is gone).
1080 */
1081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1082 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1083
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001084 /**
1085 * Broadcast Action: The current time has changed. Sent every
1086 * minute. You can <em>not</em> receive this through components declared
1087 * in manifests, only by exlicitly registering for it with
1088 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1089 * Context.registerReceiver()}.
1090 */
1091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1092 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1093 /**
1094 * Broadcast Action: The time was set.
1095 */
1096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1097 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1098 /**
1099 * Broadcast Action: The date has changed.
1100 */
1101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1102 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1103 /**
1104 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1105 * <ul>
1106 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1107 * </ul>
1108 */
1109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1110 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1111 /**
1112 * Alarm Changed Action: This is broadcast when the AlarmClock
1113 * application's alarm is set or unset. It is used by the
1114 * AlarmClock application and the StatusBar service.
1115 * @hide
1116 */
1117 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1118 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1119 /**
1120 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1121 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1122 * @hide
1123 */
1124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1125 public static final String ACTION_SYNC_STATE_CHANGED
1126 = "android.intent.action.SYNC_STATE_CHANGED";
1127 /**
1128 * Broadcast Action: This is broadcast once, after the system has finished
1129 * booting. It can be used to perform application-specific initialization,
1130 * such as installing alarms. You must hold the
1131 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1132 * in order to receive this broadcast.
1133 */
1134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1135 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1136 /**
1137 * Broadcast Action: This is broadcast when a user action should request a
1138 * temporary system dialog to dismiss. Some examples of temporary system
1139 * dialogs are the notification window-shade and the recent tasks dialog.
1140 */
1141 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1142 /**
1143 * Broadcast Action: Trigger the download and eventual installation
1144 * of a package.
1145 * <p>Input: {@link #getData} is the URI of the package file to download.
1146 */
1147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1148 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1149 /**
1150 * Broadcast Action: A new application package has been installed on the
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001151 * device. The data contains the name of the package. Note that the
1152 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001153 * <p>My include the following extras:
1154 * <ul>
1155 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1156 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1157 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1158 * </ul>
1159 */
1160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1161 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1162 /**
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001163 * Broadcast Action: A new version of an application package has been
1164 * installed, replacing an existing version that was previously installed.
1165 * The data contains the name of the package.
1166 * <p>My include the following extras:
1167 * <ul>
1168 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1169 * </ul>
1170 */
1171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1172 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1173 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001174 * Broadcast Action: An existing application package has been removed from
1175 * the device. The data contains the name of the package. The package
1176 * that is being installed does <em>not</em> receive this Intent.
1177 * <ul>
1178 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1179 * to the package.
1180 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1181 * application -- data and code -- is being removed.
1182 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1183 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1184 * </ul>
1185 */
1186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1187 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1188 /**
1189 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1190 * enabled or disabled. The data contains the name of the package.
1191 * <ul>
1192 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1193 * </ul>
1194 */
1195 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1196 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1197 /**
1198 * Broadcast Action: The user has restarted a package, and all of its
1199 * processes have been killed. All runtime state
1200 * associated with it (processes, alarms, notifications, etc) should
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001201 * be removed. Note that the restarted package does <em>not</em>
1202 * receive this broadcast.
1203 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001204 * <ul>
1205 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1206 * </ul>
1207 */
1208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1209 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1210 /**
1211 * Broadcast Action: The user has cleared the data of a package. This should
1212 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001213 * its persistent data is erased and this broadcast sent.
1214 * Note that the cleared package does <em>not</em>
1215 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001216 * <ul>
1217 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1218 * </ul>
1219 */
1220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1221 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1222 /**
1223 * Broadcast Action: A user ID has been removed from the system. The user
1224 * ID number is stored in the extra data under {@link #EXTRA_UID}.
1225 */
1226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1227 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1228 /**
1229 * Broadcast Action: The current system wallpaper has changed. See
1230 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1231 */
1232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1233 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1234 /**
1235 * Broadcast Action: The current device {@link android.content.res.Configuration}
1236 * (orientation, locale, etc) has changed. When such a change happens, the
1237 * UIs (view hierarchy) will need to be rebuilt based on this new
1238 * information; for the most part, applications don't need to worry about
1239 * this, because the system will take care of stopping and restarting the
1240 * application to make sure it sees the new changes. Some system code that
1241 * can not be restarted will need to watch for this action and handle it
1242 * appropriately.
1243 *
1244 * @see android.content.res.Configuration
1245 */
1246 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1247 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1248 /**
1249 * Broadcast Action: The charging state, or charge level of the battery has
1250 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001251 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001252 * <p class="note">
1253 * You can <em>not</em> receive this through components declared
1254 * in manifests, only by exlicitly registering for it with
1255 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1256 * Context.registerReceiver()}.
1257 */
1258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1259 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1260 /**
1261 * Broadcast Action: Indicates low battery condition on the device.
1262 * This broadcast corresponds to the "Low battery warning" system dialog.
1263 */
1264 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1265 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1266 /**
Christopher Tate06ba5542009-04-09 16:03:56 -07001267 * Broadcast Action: External power has been connected to the device.
1268 * This is intended for applications that wish to register specifically to this notification.
1269 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1270 * stay active to receive this notification. This action can be used to implement actions
1271 * that wait until power is available to trigger.
1272 */
1273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1274 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
1275 /**
1276 * Broadcast Action: External power has been removed from the device.
1277 * This is intended for applications that wish to register specifically to this notification.
1278 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1279 * stay active to receive this notification. This action can be used to implement actions
1280 * that wait until power is available to trigger.
1281 */
1282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1283 public static final String ACTION_POWER_DISCONNECTED = "android.intent.action.ACTION_POWER_DISCONNECTED";
1284 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001285 * Broadcast Action: Device is shutting down.
1286 * This is broadcast when the device is being shut down (completely turned
1287 * off, not sleeping). Once the broadcast is complete, the final shutdown
1288 * will proceed and all unsaved data lost. Apps will not normally need
1289 * to handle this, since the forground activity will be paused as well.
1290 */
1291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1292 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
1293 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001294 * Broadcast Action: Indicates low memory condition on the device
1295 */
1296 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1297 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1298 /**
1299 * Broadcast Action: Indicates low memory condition on the device no longer exists
1300 */
1301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1302 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1303 /**
1304 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1305 * and package management should be started.
1306 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1307 * notification.
1308 */
1309 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1310 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1311 /**
1312 * Broadcast Action: The device has entered USB Mass Storage mode.
1313 * This is used mainly for the USB Settings panel.
1314 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1315 * when the SD card file system is mounted or unmounted
1316 */
1317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1318 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1319
1320 /**
1321 * Broadcast Action: The device has exited USB Mass Storage mode.
1322 * This is used mainly for the USB Settings panel.
1323 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1324 * when the SD card file system is mounted or unmounted
1325 */
1326 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1327 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1328
1329 /**
1330 * Broadcast Action: External media has been removed.
1331 * The path to the mount point for the removed media is contained in the Intent.mData field.
1332 */
1333 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1334 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1335
1336 /**
1337 * Broadcast Action: External media is present, but not mounted at its mount point.
1338 * The path to the mount point for the removed media is contained in the Intent.mData field.
1339 */
1340 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1341 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1342
1343 /**
1344 * Broadcast Action: External media is present, and being disk-checked
1345 * The path to the mount point for the checking media is contained in the Intent.mData field.
1346 */
1347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1348 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1349
1350 /**
1351 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1352 * The path to the mount point for the checking media is contained in the Intent.mData field.
1353 */
1354 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1355 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1356
1357 /**
1358 * Broadcast Action: External media is present and mounted at its mount point.
1359 * The path to the mount point for the removed media is contained in the Intent.mData field.
1360 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1361 * media was mounted read only.
1362 */
1363 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1364 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1365
1366 /**
1367 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1368 * The path to the mount point for the removed media is contained in the Intent.mData field.
1369 */
1370 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1371 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1372
1373 /**
1374 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1375 * The path to the mount point for the removed media is contained in the Intent.mData field.
1376 */
1377 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1378 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1379
1380 /**
1381 * Broadcast Action: External media is present but cannot be mounted.
1382 * The path to the mount point for the removed media is contained in the Intent.mData field.
1383 */
1384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1385 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1386
1387 /**
1388 * Broadcast Action: User has expressed the desire to remove the external storage media.
1389 * Applications should close all files they have open within the mount point when they receive this intent.
1390 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1391 */
1392 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1393 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1394
1395 /**
1396 * Broadcast Action: The media scanner has started scanning a directory.
1397 * The path to the directory being scanned is contained in the Intent.mData field.
1398 */
1399 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1400 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1401
1402 /**
1403 * Broadcast Action: The media scanner has finished scanning a directory.
1404 * The path to the scanned directory is contained in the Intent.mData field.
1405 */
1406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1407 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1408
1409 /**
1410 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1411 * The path to the file is contained in the Intent.mData field.
1412 */
1413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1414 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1415
1416 /**
1417 * Broadcast Action: The "Media Button" was pressed. Includes a single
1418 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1419 * caused the broadcast.
1420 */
1421 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1422 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1423
1424 /**
1425 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1426 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1427 * caused the broadcast.
1428 */
1429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1430 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1431
1432 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1433 // location; they are not general-purpose actions.
1434
1435 /**
1436 * Broadcast Action: An GTalk connection has been established.
1437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1440 "android.intent.action.GTALK_CONNECTED";
1441
1442 /**
1443 * Broadcast Action: An GTalk connection has been disconnected.
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1447 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001448
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001449 /**
1450 * Broadcast Action: An input method has been changed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001451 */
1452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1453 public static final String ACTION_INPUT_METHOD_CHANGED =
1454 "android.intent.action.INPUT_METHOD_CHANGED";
1455
1456 /**
1457 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1458 * more radios have been turned off or on. The intent will have the following extra value:</p>
1459 * <ul>
1460 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1461 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1462 * turned off</li>
1463 * </ul>
1464 */
1465 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1466 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1467
1468 /**
1469 * Broadcast Action: Some content providers have parts of their namespace
1470 * where they publish new events or items that the user may be especially
1471 * interested in. For these things, they may broadcast this action when the
1472 * set of interesting items change.
1473 *
1474 * For example, GmailProvider sends this notification when the set of unread
1475 * mail in the inbox changes.
1476 *
1477 * <p>The data of the intent identifies which part of which provider
1478 * changed. When queried through the content resolver, the data URI will
1479 * return the data set in question.
1480 *
1481 * <p>The intent will have the following extra values:
1482 * <ul>
1483 * <li><em>count</em> - The number of items in the data set. This is the
1484 * same as the number of items in the cursor returned by querying the
1485 * data URI. </li>
1486 * </ul>
1487 *
1488 * This intent will be sent at boot (if the count is non-zero) and when the
1489 * data set changes. It is possible for the data set to change without the
1490 * count changing (for example, if a new unread message arrives in the same
1491 * sync operation in which a message is archived). The phone should still
1492 * ring/vibrate/etc as normal in this case.
1493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_PROVIDER_CHANGED =
1496 "android.intent.action.PROVIDER_CHANGED";
1497
1498 /**
1499 * Broadcast Action: Wired Headset plugged in or unplugged.
1500 *
1501 * <p>The intent will have the following extra values:
1502 * <ul>
1503 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1504 * <li><em>name</em> - Headset type, human readable string </li>
1505 * </ul>
1506 * </ul>
1507 */
1508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1509 public static final String ACTION_HEADSET_PLUG =
1510 "android.intent.action.HEADSET_PLUG";
1511
1512 /**
1513 * Broadcast Action: An outgoing call is about to be placed.
1514 *
1515 * <p>The Intent will have the following extra value:
1516 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001517 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001518 * the phone number originally intended to be dialed.</li>
1519 * </ul>
1520 * <p>Once the broadcast is finished, the resultData is used as the actual
1521 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001522 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001523 * outgoing call in turn: for example, a parental control application
1524 * might verify that the user is authorized to place the call at that
1525 * time, then a number-rewriting application might add an area code if
1526 * one was not specified.</p>
1527 * <p>For consistency, any receiver whose purpose is to prohibit phone
1528 * calls should have a priority of 0, to ensure it will see the final
1529 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001530 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001531 * should have a positive priority.
1532 * Negative priorities are reserved for the system for this broadcast;
1533 * using them may cause problems.</p>
1534 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1535 * abort the broadcast.</p>
1536 * <p>Emergency calls cannot be intercepted using this mechanism, and
1537 * other calls cannot be modified to call emergency numbers using this
1538 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001539 * <p>You must hold the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001540 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1541 * permission to receive this Intent.</p>
1542 */
1543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1544 public static final String ACTION_NEW_OUTGOING_CALL =
1545 "android.intent.action.NEW_OUTGOING_CALL";
1546
1547 /**
1548 * Broadcast Action: Have the device reboot. This is only for use by
1549 * system code.
1550 */
1551 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1552 public static final String ACTION_REBOOT =
1553 "android.intent.action.REBOOT";
1554
1555 // ---------------------------------------------------------------------
1556 // ---------------------------------------------------------------------
1557 // Standard intent categories (see addCategory()).
1558
1559 /**
1560 * Set if the activity should be an option for the default action
1561 * (center press) to perform on a piece of data. Setting this will
1562 * hide from the user any activities without it set when performing an
1563 * action on some data. Note that this is normal -not- set in the
1564 * Intent when initiating an action -- it is for use in intent filters
1565 * specified in packages.
1566 */
1567 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1568 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1569 /**
1570 * Activities that can be safely invoked from a browser must support this
1571 * category. For example, if the user is viewing a web page or an e-mail
1572 * and clicks on a link in the text, the Intent generated execute that
1573 * link will require the BROWSABLE category, so that only activities
1574 * supporting this category will be considered as possible actions. By
1575 * supporting this category, you are promising that there is nothing
1576 * damaging (without user intervention) that can happen by invoking any
1577 * matching Intent.
1578 */
1579 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1580 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1581 /**
1582 * Set if the activity should be considered as an alternative action to
1583 * the data the user is currently viewing. See also
1584 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1585 * applies to the selection in a list of items.
1586 *
1587 * <p>Supporting this category means that you would like your activity to be
1588 * displayed in the set of alternative things the user can do, usually as
1589 * part of the current activity's options menu. You will usually want to
1590 * include a specific label in the &lt;intent-filter&gt; of this action
1591 * describing to the user what it does.
1592 *
1593 * <p>The action of IntentFilter with this category is important in that it
1594 * describes the specific action the target will perform. This generally
1595 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1596 * a specific name such as "com.android.camera.action.CROP. Only one
1597 * alternative of any particular action will be shown to the user, so using
1598 * a specific action like this makes sure that your alternative will be
1599 * displayed while also allowing other applications to provide their own
1600 * overrides of that particular action.
1601 */
1602 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1603 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1604 /**
1605 * Set if the activity should be considered as an alternative selection
1606 * action to the data the user has currently selected. This is like
1607 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1608 * of items from which the user can select, giving them alternatives to the
1609 * default action that will be performed on it.
1610 */
1611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1612 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1613 /**
1614 * Intended to be used as a tab inside of an containing TabActivity.
1615 */
1616 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1617 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1618 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001619 * Should be displayed in the top-level launcher.
1620 */
1621 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1622 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1623 /**
1624 * Provides information about the package it is in; typically used if
1625 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1626 * a front-door to the user without having to be shown in the all apps list.
1627 */
1628 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1629 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1630 /**
1631 * This is the home activity, that is the first activity that is displayed
1632 * when the device boots.
1633 */
1634 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1635 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1636 /**
1637 * This activity is a preference panel.
1638 */
1639 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1640 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1641 /**
1642 * This activity is a development preference panel.
1643 */
1644 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1645 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1646 /**
1647 * Capable of running inside a parent activity container.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001648 */
1649 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1650 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1651 /**
1652 * This activity may be exercised by the monkey or other automated test tools.
1653 */
1654 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1655 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1656 /**
1657 * To be used as a test (not part of the normal user experience).
1658 */
1659 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1660 /**
1661 * To be used as a unit test (run through the Test Harness).
1662 */
1663 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1664 /**
1665 * To be used as an sample code example (not part of the normal user
1666 * experience).
1667 */
1668 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1669 /**
1670 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1671 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1672 * when queried, though it is allowable for those columns to be blank.
1673 */
1674 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1675 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1676
1677 /**
1678 * To be used as code under test for framework instrumentation tests.
1679 */
1680 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1681 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
1682 // ---------------------------------------------------------------------
1683 // ---------------------------------------------------------------------
1684 // Standard extra data keys.
1685
1686 /**
1687 * The initial data to place in a newly created record. Use with
1688 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1689 * fields as would be given to the underlying ContentProvider.insert()
1690 * call.
1691 */
1692 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1693
1694 /**
1695 * A constant CharSequence that is associated with the Intent, used with
1696 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1697 * this may be a styled CharSequence, so you must use
1698 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1699 * retrieve it.
1700 */
1701 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1702
1703 /**
1704 * A content: URI holding a stream of data associated with the Intent,
1705 * used with {@link #ACTION_SEND} to supply the data being sent.
1706 */
1707 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1708
1709 /**
1710 * A String[] holding e-mail addresses that should be delivered to.
1711 */
1712 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1713
1714 /**
1715 * A String[] holding e-mail addresses that should be carbon copied.
1716 */
1717 public static final String EXTRA_CC = "android.intent.extra.CC";
1718
1719 /**
1720 * A String[] holding e-mail addresses that should be blind carbon copied.
1721 */
1722 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1723
1724 /**
1725 * A constant string holding the desired subject line of a message.
1726 */
1727 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1728
1729 /**
1730 * An Intent describing the choices you would like shown with
1731 * {@link #ACTION_PICK_ACTIVITY}.
1732 */
1733 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1734
1735 /**
1736 * A CharSequence dialog title to provide to the user when used with a
1737 * {@link #ACTION_CHOOSER}.
1738 */
1739 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1740
1741 /**
1742 * A {@link android.view.KeyEvent} object containing the event that
1743 * triggered the creation of the Intent it is in.
1744 */
1745 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1746
1747 /**
1748 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1749 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1750 * of restarting the application.
1751 */
1752 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1753
1754 /**
1755 * A String holding the phone number originally entered in
1756 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1757 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1758 */
1759 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1760 /**
1761 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1762 * intents to supply the uid the package had been assigned. Also an optional
1763 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1764 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1765 * purpose.
1766 */
1767 public static final String EXTRA_UID = "android.intent.extra.UID";
1768
1769 /**
1770 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1771 * intents to indicate whether this represents a full uninstall (removing
1772 * both the code and its data) or a partial uninstall (leaving its data,
1773 * implying that this is an update).
1774 */
1775 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001776
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001777 /**
1778 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1779 * intents to indicate that this is a replacement of the package, so this
1780 * broadcast will immediately be followed by an add broadcast for a
1781 * different version of the same package.
1782 */
1783 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001784
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001785 /**
1786 * Used as an int extra field in {@link android.app.AlarmManager} intents
1787 * to tell the application being invoked how many pending alarms are being
1788 * delievered with the intent. For one-shot alarms this will always be 1.
1789 * For recurring alarms, this might be greater than 1 if the device was
1790 * asleep or powered off at the time an earlier alarm would have been
1791 * delivered.
1792 */
1793 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Jacek Surazski86b6c532009-05-13 14:38:28 +02001794
1795 /**
1796 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
1797 * the bug report.
1798 *
1799 * @hide
1800 */
1801 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
1802
1803 /**
1804 * Used as a string extra field when sending an intent to PackageInstaller to install a
1805 * package. Specifies the installer package name; this package will receive the
1806 * {@link #ACTION_APP_ERROR} intent.
1807 *
1808 * @hide
1809 */
1810 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1811 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001812
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001813 // ---------------------------------------------------------------------
1814 // ---------------------------------------------------------------------
1815 // Intent flags (see mFlags variable).
1816
1817 /**
1818 * If set, the recipient of this Intent will be granted permission to
1819 * perform read operations on the Uri in the Intent's data.
1820 */
1821 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
1822 /**
1823 * If set, the recipient of this Intent will be granted permission to
1824 * perform write operations on the Uri in the Intent's data.
1825 */
1826 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
1827 /**
1828 * Can be set by the caller to indicate that this Intent is coming from
1829 * a background operation, not from direct user interaction.
1830 */
1831 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
1832 /**
1833 * A flag you can enable for debugging: when set, log messages will be
1834 * printed during the resolution of this intent to show you what has
1835 * been found to create the final resolved list.
1836 */
1837 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
1838
1839 /**
1840 * If set, the new activity is not kept in the history stack. As soon as
1841 * the user navigates away from it, the activity is finished. This may also
1842 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
1843 * noHistory} attribute.
1844 */
1845 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
1846 /**
1847 * If set, the activity will not be launched if it is already running
1848 * at the top of the history stack.
1849 */
1850 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
1851 /**
1852 * If set, this activity will become the start of a new task on this
1853 * history stack. A task (from the activity that started it to the
1854 * next task activity) defines an atomic group of activities that the
1855 * user can move to. Tasks can be moved to the foreground and background;
1856 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07001857 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001858 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1859 * Activities and Tasks</a> for more details on tasks.
1860 *
1861 * <p>This flag is generally used by activities that want
1862 * to present a "launcher" style behavior: they give the user a list of
1863 * separate things that can be done, which otherwise run completely
1864 * independently of the activity launching them.
1865 *
1866 * <p>When using this flag, if a task is already running for the activity
1867 * you are now starting, then a new activity will not be started; instead,
1868 * the current task will simply be brought to the front of the screen with
1869 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
1870 * to disable this behavior.
1871 *
1872 * <p>This flag can not be used when the caller is requesting a result from
1873 * the activity being launched.
1874 */
1875 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
1876 /**
1877 * <strong>Do not use this flag unless you are implementing your own
1878 * top-level application launcher.</strong> Used in conjunction with
1879 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
1880 * behavior of bringing an existing task to the foreground. When set,
1881 * a new task is <em>always</em> started to host the Activity for the
1882 * Intent, regardless of whether there is already an existing task running
1883 * the same thing.
1884 *
1885 * <p><strong>Because the default system does not include graphical task management,
1886 * you should not use this flag unless you provide some way for a user to
1887 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07001888 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001889 * <p>This flag is ignored if
1890 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
1891 *
1892 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1893 * Activities and Tasks</a> for more details on tasks.
1894 */
1895 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
1896 /**
1897 * If set, and the activity being launched is already running in the
1898 * current task, then instead of launching a new instance of that activity,
1899 * all of the other activities on top of it will be closed and this Intent
1900 * will be delivered to the (now on top) old activity as a new Intent.
1901 *
1902 * <p>For example, consider a task consisting of the activities: A, B, C, D.
1903 * If D calls startActivity() with an Intent that resolves to the component
1904 * of activity B, then C and D will be finished and B receive the given
1905 * Intent, resulting in the stack now being: A, B.
1906 *
1907 * <p>The currently running instance of task B in the above example will
1908 * either receive the new intent you are starting here in its
1909 * onNewIntent() method, or be itself finished and restarted with the
1910 * new intent. If it has declared its launch mode to be "multiple" (the
1911 * default) it will be finished and re-created; for all other launch modes
1912 * it will receive the Intent in the current instance.
1913 *
1914 * <p>This launch mode can also be used to good effect in conjunction with
1915 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
1916 * of a task, it will bring any currently running instance of that task
1917 * to the foreground, and then clear it to its root state. This is
1918 * especially useful, for example, when launching an activity from the
1919 * notification manager.
1920 *
1921 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
1922 * Activities and Tasks</a> for more details on tasks.
1923 */
1924 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
1925 /**
1926 * If set and this intent is being used to launch a new activity from an
1927 * existing one, then the reply target of the existing activity will be
1928 * transfered to the new activity. This way the new activity can call
1929 * {@link android.app.Activity#setResult} and have that result sent back to
1930 * the reply target of the original activity.
1931 */
1932 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
1933 /**
1934 * If set and this intent is being used to launch a new activity from an
1935 * existing one, the current activity will not be counted as the top
1936 * activity for deciding whether the new intent should be delivered to
1937 * the top instead of starting a new one. The previous activity will
1938 * be used as the top, with the assumption being that the current activity
1939 * will finish itself immediately.
1940 */
1941 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
1942 /**
1943 * If set, the new activity is not kept in the list of recently launched
1944 * activities.
1945 */
1946 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
1947 /**
1948 * This flag is not normally set by application code, but set for you by
1949 * the system as described in the
1950 * {@link android.R.styleable#AndroidManifestActivity_launchMode
1951 * launchMode} documentation for the singleTask mode.
1952 */
1953 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
1954 /**
1955 * If set, and this activity is either being started in a new task or
1956 * bringing to the top an existing task, then it will be launched as
1957 * the front door of the task. This will result in the application of
1958 * any affinities needed to have that task in the proper state (either
1959 * moving activities to or from it), or simply resetting that task to
1960 * its initial state if needed.
1961 */
1962 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
1963 /**
1964 * This flag is not normally set by application code, but set for you by
1965 * the system if this activity is being launched from history
1966 * (longpress home key).
1967 */
1968 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
1969 /**
1970 * If set, this marks a point in the task's activity stack that should
1971 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07001972 * is brought to the foreground with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001973 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
1974 * the user re-launching it from home), this activity and all on top of
1975 * it will be finished so that the user does not return to them, but
1976 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07001977 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001978 * <p>This is useful for cases where you have a logical break in your
1979 * application. For example, an e-mail application may have a command
1980 * to view an attachment, which launches an image view activity to
1981 * display it. This activity should be part of the e-mail application's
1982 * task, since it is a part of the task the user is involved in. However,
1983 * if the user leaves that task, and later selects the e-mail app from
1984 * home, we may like them to return to the conversation they were
1985 * viewing, not the picture attachment, since that is confusing. By
1986 * setting this flag when launching the image viewer, that viewer and
1987 * any activities it starts will be removed the next time the user returns
1988 * to mail.
1989 */
1990 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
1991 /**
1992 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
1993 * callback from occurring on the current frontmost activity before it is
1994 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07001995 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001996 * <p>Typically, an activity can rely on that callback to indicate that an
1997 * explicit user action has caused their activity to be moved out of the
1998 * foreground. The callback marks an appropriate point in the activity's
1999 * lifecycle for it to dismiss any notifications that it intends to display
2000 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002001 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002002 * <p>If an activity is ever started via any non-user-driven events such as
2003 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2004 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002005 * activity does not think the user has acknowledged its notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002006 */
2007 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
2008 /**
2009 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2010 * this flag will cause the launched activity to be brought to the front of its
2011 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002012 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002013 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2014 * If D calls startActivity() with an Intent that resolves to the component
2015 * of activity B, then B will be brought to the front of the history stack,
2016 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002017 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002018 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002019 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002020 */
2021 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
2022 /**
2023 * If set, when sending a broadcast only registered receivers will be
2024 * called -- no BroadcastReceiver components will be launched.
2025 */
2026 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
2027 /**
2028 * If set, when sending a broadcast <i>before boot has completed</i> only
2029 * registered receivers will be called -- no BroadcastReceiver components
2030 * will be launched. Sticky intent state will be recorded properly even
2031 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2032 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002033 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002034 * <p>This flag is only for use by system sevices as a convenience to
2035 * avoid having to implement a more complex mechanism around detection
2036 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002037 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 * @hide
2039 */
2040 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
2041
2042 // ---------------------------------------------------------------------
2043
2044 private String mAction;
2045 private Uri mData;
2046 private String mType;
2047 private ComponentName mComponent;
2048 private int mFlags;
2049 private HashSet<String> mCategories;
2050 private Bundle mExtras;
2051
2052 // ---------------------------------------------------------------------
2053
2054 /**
2055 * Create an empty intent.
2056 */
2057 public Intent() {
2058 }
2059
2060 /**
2061 * Copy constructor.
2062 */
2063 public Intent(Intent o) {
2064 this.mAction = o.mAction;
2065 this.mData = o.mData;
2066 this.mType = o.mType;
2067 this.mComponent = o.mComponent;
2068 this.mFlags = o.mFlags;
2069 if (o.mCategories != null) {
2070 this.mCategories = new HashSet<String>(o.mCategories);
2071 }
2072 if (o.mExtras != null) {
2073 this.mExtras = new Bundle(o.mExtras);
2074 }
2075 }
2076
2077 @Override
2078 public Object clone() {
2079 return new Intent(this);
2080 }
2081
2082 private Intent(Intent o, boolean all) {
2083 this.mAction = o.mAction;
2084 this.mData = o.mData;
2085 this.mType = o.mType;
2086 this.mComponent = o.mComponent;
2087 if (o.mCategories != null) {
2088 this.mCategories = new HashSet<String>(o.mCategories);
2089 }
2090 }
2091
2092 /**
2093 * Make a clone of only the parts of the Intent that are relevant for
2094 * filter matching: the action, data, type, component, and categories.
2095 */
2096 public Intent cloneFilter() {
2097 return new Intent(this, false);
2098 }
2099
2100 /**
2101 * Create an intent with a given action. All other fields (data, type,
2102 * class) are null. Note that the action <em>must</em> be in a
2103 * namespace because Intents are used globally in the system -- for
2104 * example the system VIEW action is android.intent.action.VIEW; an
2105 * application's custom action would be something like
2106 * com.google.app.myapp.CUSTOM_ACTION.
2107 *
2108 * @param action The Intent action, such as ACTION_VIEW.
2109 */
2110 public Intent(String action) {
2111 mAction = action;
2112 }
2113
2114 /**
2115 * Create an intent with a given action and for a given data url. Note
2116 * that the action <em>must</em> be in a namespace because Intents are
2117 * used globally in the system -- for example the system VIEW action is
2118 * android.intent.action.VIEW; an application's custom action would be
2119 * something like com.google.app.myapp.CUSTOM_ACTION.
2120 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07002121 * <p><em>Note: scheme and host name matching in the Android framework is
2122 * case-sensitive, unlike the formal RFC. As a result,
2123 * you should always ensure that you write your Uri with these elements
2124 * using lower case letters, and normalize any Uris you receive from
2125 * outside of Android to ensure the scheme and host is lower case.</em></p>
2126 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002127 * @param action The Intent action, such as ACTION_VIEW.
2128 * @param uri The Intent data URI.
2129 */
2130 public Intent(String action, Uri uri) {
2131 mAction = action;
2132 mData = uri;
2133 }
2134
2135 /**
2136 * Create an intent for a specific component. All other fields (action, data,
2137 * type, class) are null, though they can be modified later with explicit
2138 * calls. This provides a convenient way to create an intent that is
2139 * intended to execute a hard-coded class name, rather than relying on the
2140 * system to find an appropriate class for you; see {@link #setComponent}
2141 * for more information on the repercussions of this.
2142 *
2143 * @param packageContext A Context of the application package implementing
2144 * this class.
2145 * @param cls The component class that is to be used for the intent.
2146 *
2147 * @see #setClass
2148 * @see #setComponent
2149 * @see #Intent(String, android.net.Uri , Context, Class)
2150 */
2151 public Intent(Context packageContext, Class<?> cls) {
2152 mComponent = new ComponentName(packageContext, cls);
2153 }
2154
2155 /**
2156 * Create an intent for a specific component with a specified action and data.
2157 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2158 * construct the Intent and then calling {@link #setClass} to set its
2159 * class.
2160 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07002161 * <p><em>Note: scheme and host name matching in the Android framework is
2162 * case-sensitive, unlike the formal RFC. As a result,
2163 * you should always ensure that you write your Uri with these elements
2164 * using lower case letters, and normalize any Uris you receive from
2165 * outside of Android to ensure the scheme and host is lower case.</em></p>
2166 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002167 * @param action The Intent action, such as ACTION_VIEW.
2168 * @param uri The Intent data URI.
2169 * @param packageContext A Context of the application package implementing
2170 * this class.
2171 * @param cls The component class that is to be used for the intent.
2172 *
2173 * @see #Intent(String, android.net.Uri)
2174 * @see #Intent(Context, Class)
2175 * @see #setClass
2176 * @see #setComponent
2177 */
2178 public Intent(String action, Uri uri,
2179 Context packageContext, Class<?> cls) {
2180 mAction = action;
2181 mData = uri;
2182 mComponent = new ComponentName(packageContext, cls);
2183 }
2184
2185 /**
2186 * Create an intent from a URI. This URI may encode the action,
2187 * category, and other intent fields, if it was returned by toURI(). If
2188 * the Intent was not generate by toURI(), its data will be the entire URI
2189 * and its action will be ACTION_VIEW.
2190 *
2191 * <p>The URI given here must not be relative -- that is, it must include
2192 * the scheme and full path.
2193 *
2194 * @param uri The URI to turn into an Intent.
2195 *
2196 * @return Intent The newly created Intent object.
2197 *
2198 * @see #toURI
2199 */
2200 public static Intent getIntent(String uri) throws URISyntaxException {
2201 int i = 0;
2202 try {
2203 // simple case
2204 i = uri.lastIndexOf("#");
2205 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2206
2207 // old format Intent URI
2208 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002209
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002210 // new format
2211 Intent intent = new Intent(ACTION_VIEW);
2212
2213 // fetch data part, if present
2214 if (i > 0) {
2215 intent.mData = Uri.parse(uri.substring(0, i));
2216 }
2217 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002218
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002219 // loop over contents of Intent, all name=value;
2220 while (!uri.startsWith("end", i)) {
2221 int eq = uri.indexOf('=', i);
2222 int semi = uri.indexOf(';', eq);
2223 String value = uri.substring(eq + 1, semi);
2224
2225 // action
2226 if (uri.startsWith("action=", i)) {
2227 intent.mAction = value;
2228 }
2229
2230 // categories
2231 else if (uri.startsWith("category=", i)) {
2232 intent.addCategory(value);
2233 }
2234
2235 // type
2236 else if (uri.startsWith("type=", i)) {
2237 intent.mType = value;
2238 }
2239
2240 // launch flags
2241 else if (uri.startsWith("launchFlags=", i)) {
2242 intent.mFlags = Integer.decode(value).intValue();
2243 }
2244
2245 // component
2246 else if (uri.startsWith("component=", i)) {
2247 intent.mComponent = ComponentName.unflattenFromString(value);
2248 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002249
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002250 // extra
2251 else {
2252 String key = Uri.decode(uri.substring(i + 2, eq));
2253 value = Uri.decode(value);
2254 // create Bundle if it doesn't already exist
2255 if (intent.mExtras == null) intent.mExtras = new Bundle();
2256 Bundle b = intent.mExtras;
2257 // add EXTRA
2258 if (uri.startsWith("S.", i)) b.putString(key, value);
2259 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2260 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2261 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2262 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2263 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2264 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2265 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2266 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2267 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2268 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002269
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002270 // move to the next item
2271 i = semi + 1;
2272 }
2273
2274 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002275
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002276 } catch (IndexOutOfBoundsException e) {
2277 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2278 }
2279 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002280
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002281 public static Intent getIntentOld(String uri) throws URISyntaxException {
2282 Intent intent;
2283
2284 int i = uri.lastIndexOf('#');
2285 if (i >= 0) {
2286 Uri data = null;
2287 String action = null;
2288 if (i > 0) {
2289 data = Uri.parse(uri.substring(0, i));
2290 }
2291
2292 i++;
2293
2294 if (uri.regionMatches(i, "action(", 0, 7)) {
2295 i += 7;
2296 int j = uri.indexOf(')', i);
2297 action = uri.substring(i, j);
2298 i = j + 1;
2299 }
2300
2301 intent = new Intent(action, data);
2302
2303 if (uri.regionMatches(i, "categories(", 0, 11)) {
2304 i += 11;
2305 int j = uri.indexOf(')', i);
2306 while (i < j) {
2307 int sep = uri.indexOf('!', i);
2308 if (sep < 0) sep = j;
2309 if (i < sep) {
2310 intent.addCategory(uri.substring(i, sep));
2311 }
2312 i = sep + 1;
2313 }
2314 i = j + 1;
2315 }
2316
2317 if (uri.regionMatches(i, "type(", 0, 5)) {
2318 i += 5;
2319 int j = uri.indexOf(')', i);
2320 intent.mType = uri.substring(i, j);
2321 i = j + 1;
2322 }
2323
2324 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2325 i += 12;
2326 int j = uri.indexOf(')', i);
2327 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2328 i = j + 1;
2329 }
2330
2331 if (uri.regionMatches(i, "component(", 0, 10)) {
2332 i += 10;
2333 int j = uri.indexOf(')', i);
2334 int sep = uri.indexOf('!', i);
2335 if (sep >= 0 && sep < j) {
2336 String pkg = uri.substring(i, sep);
2337 String cls = uri.substring(sep + 1, j);
2338 intent.mComponent = new ComponentName(pkg, cls);
2339 }
2340 i = j + 1;
2341 }
2342
2343 if (uri.regionMatches(i, "extras(", 0, 7)) {
2344 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002345
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002346 final int closeParen = uri.indexOf(')', i);
2347 if (closeParen == -1) throw new URISyntaxException(uri,
2348 "EXTRA missing trailing ')'", i);
2349
2350 while (i < closeParen) {
2351 // fetch the key value
2352 int j = uri.indexOf('=', i);
2353 if (j <= i + 1 || i >= closeParen) {
2354 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2355 }
2356 char type = uri.charAt(i);
2357 i++;
2358 String key = uri.substring(i, j);
2359 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002360
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002361 // get type-value
2362 j = uri.indexOf('!', i);
2363 if (j == -1 || j >= closeParen) j = closeParen;
2364 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2365 String value = uri.substring(i, j);
2366 i = j;
2367
2368 // create Bundle if it doesn't already exist
2369 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002370
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002371 // add item to bundle
2372 try {
2373 switch (type) {
2374 case 'S':
2375 intent.mExtras.putString(key, Uri.decode(value));
2376 break;
2377 case 'B':
2378 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2379 break;
2380 case 'b':
2381 intent.mExtras.putByte(key, Byte.parseByte(value));
2382 break;
2383 case 'c':
2384 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2385 break;
2386 case 'd':
2387 intent.mExtras.putDouble(key, Double.parseDouble(value));
2388 break;
2389 case 'f':
2390 intent.mExtras.putFloat(key, Float.parseFloat(value));
2391 break;
2392 case 'i':
2393 intent.mExtras.putInt(key, Integer.parseInt(value));
2394 break;
2395 case 'l':
2396 intent.mExtras.putLong(key, Long.parseLong(value));
2397 break;
2398 case 's':
2399 intent.mExtras.putShort(key, Short.parseShort(value));
2400 break;
2401 default:
2402 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2403 }
2404 } catch (NumberFormatException e) {
2405 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2406 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002407
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002408 char ch = uri.charAt(i);
2409 if (ch == ')') break;
2410 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2411 i++;
2412 }
2413 }
2414
2415 if (intent.mAction == null) {
2416 // By default, if no action is specified, then use VIEW.
2417 intent.mAction = ACTION_VIEW;
2418 }
2419
2420 } else {
2421 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2422 }
2423
2424 return intent;
2425 }
2426
2427 /**
2428 * Retrieve the general action to be performed, such as
2429 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2430 * the information in the intent should be interpreted -- most importantly,
2431 * what to do with the data returned by {@link #getData}.
2432 *
2433 * @return The action of this intent or null if none is specified.
2434 *
2435 * @see #setAction
2436 */
2437 public String getAction() {
2438 return mAction;
2439 }
2440
2441 /**
2442 * Retrieve data this intent is operating on. This URI specifies the name
2443 * of the data; often it uses the content: scheme, specifying data in a
2444 * content provider. Other schemes may be handled by specific activities,
2445 * such as http: by the web browser.
2446 *
2447 * @return The URI of the data this intent is targeting or null.
2448 *
2449 * @see #getScheme
2450 * @see #setData
2451 */
2452 public Uri getData() {
2453 return mData;
2454 }
2455
2456 /**
2457 * The same as {@link #getData()}, but returns the URI as an encoded
2458 * String.
2459 */
2460 public String getDataString() {
2461 return mData != null ? mData.toString() : null;
2462 }
2463
2464 /**
2465 * Return the scheme portion of the intent's data. If the data is null or
2466 * does not include a scheme, null is returned. Otherwise, the scheme
2467 * prefix without the final ':' is returned, i.e. "http".
2468 *
2469 * <p>This is the same as calling getData().getScheme() (and checking for
2470 * null data).
2471 *
2472 * @return The scheme of this intent.
2473 *
2474 * @see #getData
2475 */
2476 public String getScheme() {
2477 return mData != null ? mData.getScheme() : null;
2478 }
2479
2480 /**
2481 * Retrieve any explicit MIME type included in the intent. This is usually
2482 * null, as the type is determined by the intent data.
2483 *
2484 * @return If a type was manually set, it is returned; else null is
2485 * returned.
2486 *
2487 * @see #resolveType(ContentResolver)
2488 * @see #setType
2489 */
2490 public String getType() {
2491 return mType;
2492 }
2493
2494 /**
2495 * Return the MIME data type of this intent. If the type field is
2496 * explicitly set, that is simply returned. Otherwise, if the data is set,
2497 * the type of that data is returned. If neither fields are set, a null is
2498 * returned.
2499 *
2500 * @return The MIME type of this intent.
2501 *
2502 * @see #getType
2503 * @see #resolveType(ContentResolver)
2504 */
2505 public String resolveType(Context context) {
2506 return resolveType(context.getContentResolver());
2507 }
2508
2509 /**
2510 * Return the MIME data type of this intent. If the type field is
2511 * explicitly set, that is simply returned. Otherwise, if the data is set,
2512 * the type of that data is returned. If neither fields are set, a null is
2513 * returned.
2514 *
2515 * @param resolver A ContentResolver that can be used to determine the MIME
2516 * type of the intent's data.
2517 *
2518 * @return The MIME type of this intent.
2519 *
2520 * @see #getType
2521 * @see #resolveType(Context)
2522 */
2523 public String resolveType(ContentResolver resolver) {
2524 if (mType != null) {
2525 return mType;
2526 }
2527 if (mData != null) {
2528 if ("content".equals(mData.getScheme())) {
2529 return resolver.getType(mData);
2530 }
2531 }
2532 return null;
2533 }
2534
2535 /**
2536 * Return the MIME data type of this intent, only if it will be needed for
2537 * intent resolution. This is not generally useful for application code;
2538 * it is used by the frameworks for communicating with back-end system
2539 * services.
2540 *
2541 * @param resolver A ContentResolver that can be used to determine the MIME
2542 * type of the intent's data.
2543 *
2544 * @return The MIME type of this intent, or null if it is unknown or not
2545 * needed.
2546 */
2547 public String resolveTypeIfNeeded(ContentResolver resolver) {
2548 if (mComponent != null) {
2549 return mType;
2550 }
2551 return resolveType(resolver);
2552 }
2553
2554 /**
2555 * Check if an category exists in the intent.
2556 *
2557 * @param category The category to check.
2558 *
2559 * @return boolean True if the intent contains the category, else false.
2560 *
2561 * @see #getCategories
2562 * @see #addCategory
2563 */
2564 public boolean hasCategory(String category) {
2565 return mCategories != null && mCategories.contains(category);
2566 }
2567
2568 /**
2569 * Return the set of all categories in the intent. If there are no categories,
2570 * returns NULL.
2571 *
2572 * @return Set The set of categories you can examine. Do not modify!
2573 *
2574 * @see #hasCategory
2575 * @see #addCategory
2576 */
2577 public Set<String> getCategories() {
2578 return mCategories;
2579 }
2580
2581 /**
2582 * Sets the ClassLoader that will be used when unmarshalling
2583 * any Parcelable values from the extras of this Intent.
2584 *
2585 * @param loader a ClassLoader, or null to use the default loader
2586 * at the time of unmarshalling.
2587 */
2588 public void setExtrasClassLoader(ClassLoader loader) {
2589 if (mExtras != null) {
2590 mExtras.setClassLoader(loader);
2591 }
2592 }
2593
2594 /**
2595 * Returns true if an extra value is associated with the given name.
2596 * @param name the extra's name
2597 * @return true if the given extra is present.
2598 */
2599 public boolean hasExtra(String name) {
2600 return mExtras != null && mExtras.containsKey(name);
2601 }
2602
2603 /**
2604 * Returns true if the Intent's extras contain a parcelled file descriptor.
2605 * @return true if the Intent contains a parcelled file descriptor.
2606 */
2607 public boolean hasFileDescriptors() {
2608 return mExtras != null && mExtras.hasFileDescriptors();
2609 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002610
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002611 /**
2612 * Retrieve extended data from the intent.
2613 *
2614 * @param name The name of the desired item.
2615 *
2616 * @return the value of an item that previously added with putExtra()
2617 * or null if none was found.
2618 *
2619 * @deprecated
2620 * @hide
2621 */
2622 @Deprecated
2623 public Object getExtra(String name) {
2624 return getExtra(name, null);
2625 }
2626
2627 /**
2628 * Retrieve extended data from the intent.
2629 *
2630 * @param name The name of the desired item.
2631 * @param defaultValue the value to be returned if no value of the desired
2632 * type is stored with the given name.
2633 *
2634 * @return the value of an item that previously added with putExtra()
2635 * or the default value if none was found.
2636 *
2637 * @see #putExtra(String, boolean)
2638 */
2639 public boolean getBooleanExtra(String name, boolean defaultValue) {
2640 return mExtras == null ? defaultValue :
2641 mExtras.getBoolean(name, defaultValue);
2642 }
2643
2644 /**
2645 * Retrieve extended data from the intent.
2646 *
2647 * @param name The name of the desired item.
2648 * @param defaultValue the value to be returned if no value of the desired
2649 * type is stored with the given name.
2650 *
2651 * @return the value of an item that previously added with putExtra()
2652 * or the default value if none was found.
2653 *
2654 * @see #putExtra(String, byte)
2655 */
2656 public byte getByteExtra(String name, byte defaultValue) {
2657 return mExtras == null ? defaultValue :
2658 mExtras.getByte(name, defaultValue);
2659 }
2660
2661 /**
2662 * Retrieve extended data from the intent.
2663 *
2664 * @param name The name of the desired item.
2665 * @param defaultValue the value to be returned if no value of the desired
2666 * type is stored with the given name.
2667 *
2668 * @return the value of an item that previously added with putExtra()
2669 * or the default value if none was found.
2670 *
2671 * @see #putExtra(String, short)
2672 */
2673 public short getShortExtra(String name, short defaultValue) {
2674 return mExtras == null ? defaultValue :
2675 mExtras.getShort(name, defaultValue);
2676 }
2677
2678 /**
2679 * Retrieve extended data from the intent.
2680 *
2681 * @param name The name of the desired item.
2682 * @param defaultValue the value to be returned if no value of the desired
2683 * type is stored with the given name.
2684 *
2685 * @return the value of an item that previously added with putExtra()
2686 * or the default value if none was found.
2687 *
2688 * @see #putExtra(String, char)
2689 */
2690 public char getCharExtra(String name, char defaultValue) {
2691 return mExtras == null ? defaultValue :
2692 mExtras.getChar(name, defaultValue);
2693 }
2694
2695 /**
2696 * Retrieve extended data from the intent.
2697 *
2698 * @param name The name of the desired item.
2699 * @param defaultValue the value to be returned if no value of the desired
2700 * type is stored with the given name.
2701 *
2702 * @return the value of an item that previously added with putExtra()
2703 * or the default value if none was found.
2704 *
2705 * @see #putExtra(String, int)
2706 */
2707 public int getIntExtra(String name, int defaultValue) {
2708 return mExtras == null ? defaultValue :
2709 mExtras.getInt(name, defaultValue);
2710 }
2711
2712 /**
2713 * Retrieve extended data from the intent.
2714 *
2715 * @param name The name of the desired item.
2716 * @param defaultValue the value to be returned if no value of the desired
2717 * type is stored with the given name.
2718 *
2719 * @return the value of an item that previously added with putExtra()
2720 * or the default value if none was found.
2721 *
2722 * @see #putExtra(String, long)
2723 */
2724 public long getLongExtra(String name, long defaultValue) {
2725 return mExtras == null ? defaultValue :
2726 mExtras.getLong(name, defaultValue);
2727 }
2728
2729 /**
2730 * Retrieve extended data from the intent.
2731 *
2732 * @param name The name of the desired item.
2733 * @param defaultValue the value to be returned if no value of the desired
2734 * type is stored with the given name.
2735 *
2736 * @return the value of an item that previously added with putExtra(),
2737 * or the default value if no such item is present
2738 *
2739 * @see #putExtra(String, float)
2740 */
2741 public float getFloatExtra(String name, float defaultValue) {
2742 return mExtras == null ? defaultValue :
2743 mExtras.getFloat(name, defaultValue);
2744 }
2745
2746 /**
2747 * Retrieve extended data from the intent.
2748 *
2749 * @param name The name of the desired item.
2750 * @param defaultValue the value to be returned if no value of the desired
2751 * type is stored with the given name.
2752 *
2753 * @return the value of an item that previously added with putExtra()
2754 * or the default value if none was found.
2755 *
2756 * @see #putExtra(String, double)
2757 */
2758 public double getDoubleExtra(String name, double defaultValue) {
2759 return mExtras == null ? defaultValue :
2760 mExtras.getDouble(name, defaultValue);
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 String value was found.
2770 *
2771 * @see #putExtra(String, String)
2772 */
2773 public String getStringExtra(String name) {
2774 return mExtras == null ? null : mExtras.getString(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 CharSequence value was found.
2784 *
2785 * @see #putExtra(String, CharSequence)
2786 */
2787 public CharSequence getCharSequenceExtra(String name) {
2788 return mExtras == null ? null : mExtras.getCharSequence(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 Parcelable value was found.
2798 *
2799 * @see #putExtra(String, Parcelable)
2800 */
2801 public <T extends Parcelable> T getParcelableExtra(String name) {
2802 return mExtras == null ? null : mExtras.<T>getParcelable(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 Parcelable[] value was found.
2812 *
2813 * @see #putExtra(String, Parcelable[])
2814 */
2815 public Parcelable[] getParcelableArrayExtra(String name) {
2816 return mExtras == null ? null : mExtras.getParcelableArray(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 ArrayList<Parcelable> value was found.
2826 *
2827 * @see #putParcelableArrayListExtra(String, ArrayList)
2828 */
2829 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
2830 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(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 Serializable value was found.
2840 *
2841 * @see #putExtra(String, Serializable)
2842 */
2843 public Serializable getSerializableExtra(String name) {
2844 return mExtras == null ? null : mExtras.getSerializable(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 ArrayList<Integer> value was found.
2854 *
2855 * @see #putIntegerArrayListExtra(String, ArrayList)
2856 */
2857 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
2858 return mExtras == null ? null : mExtras.getIntegerArrayList(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 ArrayList<String> value was found.
2868 *
2869 * @see #putStringArrayListExtra(String, ArrayList)
2870 */
2871 public ArrayList<String> getStringArrayListExtra(String name) {
2872 return mExtras == null ? null : mExtras.getStringArrayList(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 boolean array value was found.
2882 *
2883 * @see #putExtra(String, boolean[])
2884 */
2885 public boolean[] getBooleanArrayExtra(String name) {
2886 return mExtras == null ? null : mExtras.getBooleanArray(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 byte array value was found.
2896 *
2897 * @see #putExtra(String, byte[])
2898 */
2899 public byte[] getByteArrayExtra(String name) {
2900 return mExtras == null ? null : mExtras.getByteArray(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 short array value was found.
2910 *
2911 * @see #putExtra(String, short[])
2912 */
2913 public short[] getShortArrayExtra(String name) {
2914 return mExtras == null ? null : mExtras.getShortArray(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 char array value was found.
2924 *
2925 * @see #putExtra(String, char[])
2926 */
2927 public char[] getCharArrayExtra(String name) {
2928 return mExtras == null ? null : mExtras.getCharArray(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 int array value was found.
2938 *
2939 * @see #putExtra(String, int[])
2940 */
2941 public int[] getIntArrayExtra(String name) {
2942 return mExtras == null ? null : mExtras.getIntArray(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 long array value was found.
2952 *
2953 * @see #putExtra(String, long[])
2954 */
2955 public long[] getLongArrayExtra(String name) {
2956 return mExtras == null ? null : mExtras.getLongArray(name);
2957 }
2958
2959 /**
2960 * Retrieve extended data from the intent.
2961 *
2962 * @param name The name of the desired item.
2963 *
2964 * @return the value of an item that previously added with putExtra()
2965 * or null if no float array value was found.
2966 *
2967 * @see #putExtra(String, float[])
2968 */
2969 public float[] getFloatArrayExtra(String name) {
2970 return mExtras == null ? null : mExtras.getFloatArray(name);
2971 }
2972
2973 /**
2974 * Retrieve extended data from the intent.
2975 *
2976 * @param name The name of the desired item.
2977 *
2978 * @return the value of an item that previously added with putExtra()
2979 * or null if no double array value was found.
2980 *
2981 * @see #putExtra(String, double[])
2982 */
2983 public double[] getDoubleArrayExtra(String name) {
2984 return mExtras == null ? null : mExtras.getDoubleArray(name);
2985 }
2986
2987 /**
2988 * Retrieve extended data from the intent.
2989 *
2990 * @param name The name of the desired item.
2991 *
2992 * @return the value of an item that previously added with putExtra()
2993 * or null if no String array value was found.
2994 *
2995 * @see #putExtra(String, String[])
2996 */
2997 public String[] getStringArrayExtra(String name) {
2998 return mExtras == null ? null : mExtras.getStringArray(name);
2999 }
3000
3001 /**
3002 * Retrieve extended data from the intent.
3003 *
3004 * @param name The name of the desired item.
3005 *
3006 * @return the value of an item that previously added with putExtra()
3007 * or null if no Bundle value was found.
3008 *
3009 * @see #putExtra(String, Bundle)
3010 */
3011 public Bundle getBundleExtra(String name) {
3012 return mExtras == null ? null : mExtras.getBundle(name);
3013 }
3014
3015 /**
3016 * Retrieve extended data from the intent.
3017 *
3018 * @param name The name of the desired item.
3019 *
3020 * @return the value of an item that previously added with putExtra()
3021 * or null if no IBinder value was found.
3022 *
3023 * @see #putExtra(String, IBinder)
3024 *
3025 * @deprecated
3026 * @hide
3027 */
3028 @Deprecated
3029 public IBinder getIBinderExtra(String name) {
3030 return mExtras == null ? null : mExtras.getIBinder(name);
3031 }
3032
3033 /**
3034 * Retrieve extended data from the intent.
3035 *
3036 * @param name The name of the desired item.
3037 * @param defaultValue The default value to return in case no item is
3038 * associated with the key 'name'
3039 *
3040 * @return the value of an item that previously added with putExtra()
3041 * or defaultValue if none was found.
3042 *
3043 * @see #putExtra
3044 *
3045 * @deprecated
3046 * @hide
3047 */
3048 @Deprecated
3049 public Object getExtra(String name, Object defaultValue) {
3050 Object result = defaultValue;
3051 if (mExtras != null) {
3052 Object result2 = mExtras.get(name);
3053 if (result2 != null) {
3054 result = result2;
3055 }
3056 }
3057
3058 return result;
3059 }
3060
3061 /**
3062 * Retrieves a map of extended data from the intent.
3063 *
3064 * @return the map of all extras previously added with putExtra(),
3065 * or null if none have been added.
3066 */
3067 public Bundle getExtras() {
3068 return (mExtras != null)
3069 ? new Bundle(mExtras)
3070 : null;
3071 }
3072
3073 /**
3074 * Retrieve any special flags associated with this intent. You will
3075 * normally just set them with {@link #setFlags} and let the system
3076 * take the appropriate action with them.
3077 *
3078 * @return int The currently set flags.
3079 *
3080 * @see #setFlags
3081 */
3082 public int getFlags() {
3083 return mFlags;
3084 }
3085
3086 /**
3087 * Retrieve the concrete component associated with the intent. When receiving
3088 * an intent, this is the component that was found to best handle it (that is,
3089 * yourself) and will always be non-null; in all other cases it will be
3090 * null unless explicitly set.
3091 *
3092 * @return The name of the application component to handle the intent.
3093 *
3094 * @see #resolveActivity
3095 * @see #setComponent
3096 */
3097 public ComponentName getComponent() {
3098 return mComponent;
3099 }
3100
3101 /**
3102 * Return the Activity component that should be used to handle this intent.
3103 * The appropriate component is determined based on the information in the
3104 * intent, evaluated as follows:
3105 *
3106 * <p>If {@link #getComponent} returns an explicit class, that is returned
3107 * without any further consideration.
3108 *
3109 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3110 * category to be considered.
3111 *
3112 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3113 * action.
3114 *
3115 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3116 * this type.
3117 *
3118 * <p>If {@link #addCategory} has added any categories, the activity must
3119 * handle ALL of the categories specified.
3120 *
3121 * <p>If there are no activities that satisfy all of these conditions, a
3122 * null string is returned.
3123 *
3124 * <p>If multiple activities are found to satisfy the intent, the one with
3125 * the highest priority will be used. If there are multiple activities
3126 * with the same priority, the system will either pick the best activity
3127 * based on user preference, or resolve to a system class that will allow
3128 * the user to pick an activity and forward from there.
3129 *
3130 * <p>This method is implemented simply by calling
3131 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3132 * true.</p>
3133 * <p> This API is called for you as part of starting an activity from an
3134 * intent. You do not normally need to call it yourself.</p>
3135 *
3136 * @param pm The package manager with which to resolve the Intent.
3137 *
3138 * @return Name of the component implementing an activity that can
3139 * display the intent.
3140 *
3141 * @see #setComponent
3142 * @see #getComponent
3143 * @see #resolveActivityInfo
3144 */
3145 public ComponentName resolveActivity(PackageManager pm) {
3146 if (mComponent != null) {
3147 return mComponent;
3148 }
3149
3150 ResolveInfo info = pm.resolveActivity(
3151 this, PackageManager.MATCH_DEFAULT_ONLY);
3152 if (info != null) {
3153 return new ComponentName(
3154 info.activityInfo.applicationInfo.packageName,
3155 info.activityInfo.name);
3156 }
3157
3158 return null;
3159 }
3160
3161 /**
3162 * Resolve the Intent into an {@link ActivityInfo}
3163 * describing the activity that should execute the intent. Resolution
3164 * follows the same rules as described for {@link #resolveActivity}, but
3165 * you get back the completely information about the resolved activity
3166 * instead of just its class name.
3167 *
3168 * @param pm The package manager with which to resolve the Intent.
3169 * @param flags Addition information to retrieve as per
3170 * {@link PackageManager#getActivityInfo(ComponentName, int)
3171 * PackageManager.getActivityInfo()}.
3172 *
3173 * @return PackageManager.ActivityInfo
3174 *
3175 * @see #resolveActivity
3176 */
3177 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3178 ActivityInfo ai = null;
3179 if (mComponent != null) {
3180 try {
3181 ai = pm.getActivityInfo(mComponent, flags);
3182 } catch (PackageManager.NameNotFoundException e) {
3183 // ignore
3184 }
3185 } else {
3186 ResolveInfo info = pm.resolveActivity(
3187 this, PackageManager.MATCH_DEFAULT_ONLY);
3188 if (info != null) {
3189 ai = info.activityInfo;
3190 }
3191 }
3192
3193 return ai;
3194 }
3195
3196 /**
3197 * Set the general action to be performed.
3198 *
3199 * @param action An action name, such as ACTION_VIEW. Application-specific
3200 * actions should be prefixed with the vendor's package name.
3201 *
3202 * @return Returns the same Intent object, for chaining multiple calls
3203 * into a single statement.
3204 *
3205 * @see #getAction
3206 */
3207 public Intent setAction(String action) {
3208 mAction = action;
3209 return this;
3210 }
3211
3212 /**
3213 * Set the data this intent is operating on. This method automatically
3214 * clears any type that was previously set by {@link #setType}.
3215 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07003216 * <p><em>Note: scheme and host name matching in the Android framework is
3217 * case-sensitive, unlike the formal RFC. As a result,
3218 * you should always ensure that you write your Uri with these elements
3219 * using lower case letters, and normalize any Uris you receive from
3220 * outside of Android to ensure the scheme and host is lower case.</em></p>
3221 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003222 * @param data The URI of the data this intent is now targeting.
3223 *
3224 * @return Returns the same Intent object, for chaining multiple calls
3225 * into a single statement.
3226 *
3227 * @see #getData
3228 * @see #setType
3229 * @see #setDataAndType
3230 */
3231 public Intent setData(Uri data) {
3232 mData = data;
3233 mType = null;
3234 return this;
3235 }
3236
3237 /**
3238 * Set an explicit MIME data type. This is used to create intents that
3239 * only specify a type and not data, for example to indicate the type of
3240 * data to return. This method automatically clears any data that was
3241 * previously set by {@link #setData}.
Dianne Hackborn06f36b42009-04-13 08:52:45 -07003242 *
3243 * <p><em>Note: MIME type matching in the Android framework is
3244 * case-sensitive, unlike formal RFC MIME types. As a result,
3245 * you should always write your MIME types with lower case letters,
3246 * and any MIME types you receive from outside of Android should be
3247 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003248 *
3249 * @param type The MIME type of the data being handled by this intent.
3250 *
3251 * @return Returns the same Intent object, for chaining multiple calls
3252 * into a single statement.
3253 *
3254 * @see #getType
3255 * @see #setData
3256 * @see #setDataAndType
3257 */
3258 public Intent setType(String type) {
3259 mData = null;
3260 mType = type;
3261 return this;
3262 }
3263
3264 /**
3265 * (Usually optional) Set the data for the intent along with an explicit
3266 * MIME data type. This method should very rarely be used -- it allows you
3267 * to override the MIME type that would ordinarily be inferred from the
3268 * data with your own type given here.
3269 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07003270 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3271 * Android framework is case-sensitive, unlike the formal RFC definitions.
3272 * As a result, you should always write these elements with lower case letters,
3273 * and normalize any MIME types or Uris you receive from
3274 * outside of Android to ensure these elements are lower case before
3275 * supplying them here.</em></p>
3276 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003277 * @param data The URI of the data this intent is now targeting.
3278 * @param type The MIME type of the data being handled by this intent.
3279 *
3280 * @return Returns the same Intent object, for chaining multiple calls
3281 * into a single statement.
3282 *
3283 * @see #setData
3284 * @see #setType
3285 */
3286 public Intent setDataAndType(Uri data, String type) {
3287 mData = data;
3288 mType = type;
3289 return this;
3290 }
3291
3292 /**
3293 * Add a new category to the intent. Categories provide additional detail
3294 * about the action the intent is perform. When resolving an intent, only
3295 * activities that provide <em>all</em> of the requested categories will be
3296 * used.
3297 *
3298 * @param category The desired category. This can be either one of the
3299 * predefined Intent categories, or a custom category in your own
3300 * namespace.
3301 *
3302 * @return Returns the same Intent object, for chaining multiple calls
3303 * into a single statement.
3304 *
3305 * @see #hasCategory
3306 * @see #removeCategory
3307 */
3308 public Intent addCategory(String category) {
3309 if (mCategories == null) {
3310 mCategories = new HashSet<String>();
3311 }
3312 mCategories.add(category);
3313 return this;
3314 }
3315
3316 /**
3317 * Remove an category from an intent.
3318 *
3319 * @param category The category to remove.
3320 *
3321 * @see #addCategory
3322 */
3323 public void removeCategory(String category) {
3324 if (mCategories != null) {
3325 mCategories.remove(category);
3326 if (mCategories.size() == 0) {
3327 mCategories = null;
3328 }
3329 }
3330 }
3331
3332 /**
3333 * Add extended data to the intent. The name must include a package
3334 * prefix, for example the app com.android.contacts would use names
3335 * like "com.android.contacts.ShowAll".
3336 *
3337 * @param name The name of the extra data, with package prefix.
3338 * @param value The boolean data value.
3339 *
3340 * @return Returns the same Intent object, for chaining multiple calls
3341 * into a single statement.
3342 *
3343 * @see #putExtras
3344 * @see #removeExtra
3345 * @see #getBooleanExtra(String, boolean)
3346 */
3347 public Intent putExtra(String name, boolean value) {
3348 if (mExtras == null) {
3349 mExtras = new Bundle();
3350 }
3351 mExtras.putBoolean(name, value);
3352 return this;
3353 }
3354
3355 /**
3356 * Add extended data to the intent. The name must include a package
3357 * prefix, for example the app com.android.contacts would use names
3358 * like "com.android.contacts.ShowAll".
3359 *
3360 * @param name The name of the extra data, with package prefix.
3361 * @param value The byte data value.
3362 *
3363 * @return Returns the same Intent object, for chaining multiple calls
3364 * into a single statement.
3365 *
3366 * @see #putExtras
3367 * @see #removeExtra
3368 * @see #getByteExtra(String, byte)
3369 */
3370 public Intent putExtra(String name, byte value) {
3371 if (mExtras == null) {
3372 mExtras = new Bundle();
3373 }
3374 mExtras.putByte(name, value);
3375 return this;
3376 }
3377
3378 /**
3379 * Add extended data to the intent. The name must include a package
3380 * prefix, for example the app com.android.contacts would use names
3381 * like "com.android.contacts.ShowAll".
3382 *
3383 * @param name The name of the extra data, with package prefix.
3384 * @param value The char data value.
3385 *
3386 * @return Returns the same Intent object, for chaining multiple calls
3387 * into a single statement.
3388 *
3389 * @see #putExtras
3390 * @see #removeExtra
3391 * @see #getCharExtra(String, char)
3392 */
3393 public Intent putExtra(String name, char value) {
3394 if (mExtras == null) {
3395 mExtras = new Bundle();
3396 }
3397 mExtras.putChar(name, value);
3398 return this;
3399 }
3400
3401 /**
3402 * Add extended data to the intent. The name must include a package
3403 * prefix, for example the app com.android.contacts would use names
3404 * like "com.android.contacts.ShowAll".
3405 *
3406 * @param name The name of the extra data, with package prefix.
3407 * @param value The short data value.
3408 *
3409 * @return Returns the same Intent object, for chaining multiple calls
3410 * into a single statement.
3411 *
3412 * @see #putExtras
3413 * @see #removeExtra
3414 * @see #getShortExtra(String, short)
3415 */
3416 public Intent putExtra(String name, short value) {
3417 if (mExtras == null) {
3418 mExtras = new Bundle();
3419 }
3420 mExtras.putShort(name, value);
3421 return this;
3422 }
3423
3424 /**
3425 * Add extended data to the intent. The name must include a package
3426 * prefix, for example the app com.android.contacts would use names
3427 * like "com.android.contacts.ShowAll".
3428 *
3429 * @param name The name of the extra data, with package prefix.
3430 * @param value The integer data value.
3431 *
3432 * @return Returns the same Intent object, for chaining multiple calls
3433 * into a single statement.
3434 *
3435 * @see #putExtras
3436 * @see #removeExtra
3437 * @see #getIntExtra(String, int)
3438 */
3439 public Intent putExtra(String name, int value) {
3440 if (mExtras == null) {
3441 mExtras = new Bundle();
3442 }
3443 mExtras.putInt(name, value);
3444 return this;
3445 }
3446
3447 /**
3448 * Add extended data to the intent. The name must include a package
3449 * prefix, for example the app com.android.contacts would use names
3450 * like "com.android.contacts.ShowAll".
3451 *
3452 * @param name The name of the extra data, with package prefix.
3453 * @param value The long data value.
3454 *
3455 * @return Returns the same Intent object, for chaining multiple calls
3456 * into a single statement.
3457 *
3458 * @see #putExtras
3459 * @see #removeExtra
3460 * @see #getLongExtra(String, long)
3461 */
3462 public Intent putExtra(String name, long value) {
3463 if (mExtras == null) {
3464 mExtras = new Bundle();
3465 }
3466 mExtras.putLong(name, value);
3467 return this;
3468 }
3469
3470 /**
3471 * Add extended data to the intent. The name must include a package
3472 * prefix, for example the app com.android.contacts would use names
3473 * like "com.android.contacts.ShowAll".
3474 *
3475 * @param name The name of the extra data, with package prefix.
3476 * @param value The float data value.
3477 *
3478 * @return Returns the same Intent object, for chaining multiple calls
3479 * into a single statement.
3480 *
3481 * @see #putExtras
3482 * @see #removeExtra
3483 * @see #getFloatExtra(String, float)
3484 */
3485 public Intent putExtra(String name, float value) {
3486 if (mExtras == null) {
3487 mExtras = new Bundle();
3488 }
3489 mExtras.putFloat(name, value);
3490 return this;
3491 }
3492
3493 /**
3494 * Add extended data to the intent. The name must include a package
3495 * prefix, for example the app com.android.contacts would use names
3496 * like "com.android.contacts.ShowAll".
3497 *
3498 * @param name The name of the extra data, with package prefix.
3499 * @param value The double data value.
3500 *
3501 * @return Returns the same Intent object, for chaining multiple calls
3502 * into a single statement.
3503 *
3504 * @see #putExtras
3505 * @see #removeExtra
3506 * @see #getDoubleExtra(String, double)
3507 */
3508 public Intent putExtra(String name, double value) {
3509 if (mExtras == null) {
3510 mExtras = new Bundle();
3511 }
3512 mExtras.putDouble(name, value);
3513 return this;
3514 }
3515
3516 /**
3517 * Add extended data to the intent. The name must include a package
3518 * prefix, for example the app com.android.contacts would use names
3519 * like "com.android.contacts.ShowAll".
3520 *
3521 * @param name The name of the extra data, with package prefix.
3522 * @param value The String data value.
3523 *
3524 * @return Returns the same Intent object, for chaining multiple calls
3525 * into a single statement.
3526 *
3527 * @see #putExtras
3528 * @see #removeExtra
3529 * @see #getStringExtra(String)
3530 */
3531 public Intent putExtra(String name, String value) {
3532 if (mExtras == null) {
3533 mExtras = new Bundle();
3534 }
3535 mExtras.putString(name, value);
3536 return this;
3537 }
3538
3539 /**
3540 * Add extended data to the intent. The name must include a package
3541 * prefix, for example the app com.android.contacts would use names
3542 * like "com.android.contacts.ShowAll".
3543 *
3544 * @param name The name of the extra data, with package prefix.
3545 * @param value The CharSequence data value.
3546 *
3547 * @return Returns the same Intent object, for chaining multiple calls
3548 * into a single statement.
3549 *
3550 * @see #putExtras
3551 * @see #removeExtra
3552 * @see #getCharSequenceExtra(String)
3553 */
3554 public Intent putExtra(String name, CharSequence value) {
3555 if (mExtras == null) {
3556 mExtras = new Bundle();
3557 }
3558 mExtras.putCharSequence(name, value);
3559 return this;
3560 }
3561
3562 /**
3563 * Add extended data to the intent. The name must include a package
3564 * prefix, for example the app com.android.contacts would use names
3565 * like "com.android.contacts.ShowAll".
3566 *
3567 * @param name The name of the extra data, with package prefix.
3568 * @param value The Parcelable data value.
3569 *
3570 * @return Returns the same Intent object, for chaining multiple calls
3571 * into a single statement.
3572 *
3573 * @see #putExtras
3574 * @see #removeExtra
3575 * @see #getParcelableExtra(String)
3576 */
3577 public Intent putExtra(String name, Parcelable value) {
3578 if (mExtras == null) {
3579 mExtras = new Bundle();
3580 }
3581 mExtras.putParcelable(name, value);
3582 return this;
3583 }
3584
3585 /**
3586 * Add extended data to the intent. The name must include a package
3587 * prefix, for example the app com.android.contacts would use names
3588 * like "com.android.contacts.ShowAll".
3589 *
3590 * @param name The name of the extra data, with package prefix.
3591 * @param value The Parcelable[] data value.
3592 *
3593 * @return Returns the same Intent object, for chaining multiple calls
3594 * into a single statement.
3595 *
3596 * @see #putExtras
3597 * @see #removeExtra
3598 * @see #getParcelableArrayExtra(String)
3599 */
3600 public Intent putExtra(String name, Parcelable[] value) {
3601 if (mExtras == null) {
3602 mExtras = new Bundle();
3603 }
3604 mExtras.putParcelableArray(name, value);
3605 return this;
3606 }
3607
3608 /**
3609 * Add extended data to the intent. The name must include a package
3610 * prefix, for example the app com.android.contacts would use names
3611 * like "com.android.contacts.ShowAll".
3612 *
3613 * @param name The name of the extra data, with package prefix.
3614 * @param value The ArrayList<Parcelable> data value.
3615 *
3616 * @return Returns the same Intent object, for chaining multiple calls
3617 * into a single statement.
3618 *
3619 * @see #putExtras
3620 * @see #removeExtra
3621 * @see #getParcelableArrayListExtra(String)
3622 */
3623 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3624 if (mExtras == null) {
3625 mExtras = new Bundle();
3626 }
3627 mExtras.putParcelableArrayList(name, value);
3628 return this;
3629 }
3630
3631 /**
3632 * Add extended data to the intent. The name must include a package
3633 * prefix, for example the app com.android.contacts would use names
3634 * like "com.android.contacts.ShowAll".
3635 *
3636 * @param name The name of the extra data, with package prefix.
3637 * @param value The ArrayList<Integer> data value.
3638 *
3639 * @return Returns the same Intent object, for chaining multiple calls
3640 * into a single statement.
3641 *
3642 * @see #putExtras
3643 * @see #removeExtra
3644 * @see #getIntegerArrayListExtra(String)
3645 */
3646 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
3647 if (mExtras == null) {
3648 mExtras = new Bundle();
3649 }
3650 mExtras.putIntegerArrayList(name, value);
3651 return this;
3652 }
3653
3654 /**
3655 * Add extended data to the intent. The name must include a package
3656 * prefix, for example the app com.android.contacts would use names
3657 * like "com.android.contacts.ShowAll".
3658 *
3659 * @param name The name of the extra data, with package prefix.
3660 * @param value The ArrayList<String> data value.
3661 *
3662 * @return Returns the same Intent object, for chaining multiple calls
3663 * into a single statement.
3664 *
3665 * @see #putExtras
3666 * @see #removeExtra
3667 * @see #getStringArrayListExtra(String)
3668 */
3669 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
3670 if (mExtras == null) {
3671 mExtras = new Bundle();
3672 }
3673 mExtras.putStringArrayList(name, value);
3674 return this;
3675 }
3676
3677 /**
3678 * Add extended data to the intent. The name must include a package
3679 * prefix, for example the app com.android.contacts would use names
3680 * like "com.android.contacts.ShowAll".
3681 *
3682 * @param name The name of the extra data, with package prefix.
3683 * @param value The Serializable data value.
3684 *
3685 * @return Returns the same Intent object, for chaining multiple calls
3686 * into a single statement.
3687 *
3688 * @see #putExtras
3689 * @see #removeExtra
3690 * @see #getSerializableExtra(String)
3691 */
3692 public Intent putExtra(String name, Serializable value) {
3693 if (mExtras == null) {
3694 mExtras = new Bundle();
3695 }
3696 mExtras.putSerializable(name, value);
3697 return this;
3698 }
3699
3700 /**
3701 * Add extended data to the intent. The name must include a package
3702 * prefix, for example the app com.android.contacts would use names
3703 * like "com.android.contacts.ShowAll".
3704 *
3705 * @param name The name of the extra data, with package prefix.
3706 * @param value The boolean array data value.
3707 *
3708 * @return Returns the same Intent object, for chaining multiple calls
3709 * into a single statement.
3710 *
3711 * @see #putExtras
3712 * @see #removeExtra
3713 * @see #getBooleanArrayExtra(String)
3714 */
3715 public Intent putExtra(String name, boolean[] value) {
3716 if (mExtras == null) {
3717 mExtras = new Bundle();
3718 }
3719 mExtras.putBooleanArray(name, value);
3720 return this;
3721 }
3722
3723 /**
3724 * Add extended data to the intent. The name must include a package
3725 * prefix, for example the app com.android.contacts would use names
3726 * like "com.android.contacts.ShowAll".
3727 *
3728 * @param name The name of the extra data, with package prefix.
3729 * @param value The byte array data value.
3730 *
3731 * @return Returns the same Intent object, for chaining multiple calls
3732 * into a single statement.
3733 *
3734 * @see #putExtras
3735 * @see #removeExtra
3736 * @see #getByteArrayExtra(String)
3737 */
3738 public Intent putExtra(String name, byte[] value) {
3739 if (mExtras == null) {
3740 mExtras = new Bundle();
3741 }
3742 mExtras.putByteArray(name, value);
3743 return this;
3744 }
3745
3746 /**
3747 * Add extended data to the intent. The name must include a package
3748 * prefix, for example the app com.android.contacts would use names
3749 * like "com.android.contacts.ShowAll".
3750 *
3751 * @param name The name of the extra data, with package prefix.
3752 * @param value The short array data value.
3753 *
3754 * @return Returns the same Intent object, for chaining multiple calls
3755 * into a single statement.
3756 *
3757 * @see #putExtras
3758 * @see #removeExtra
3759 * @see #getShortArrayExtra(String)
3760 */
3761 public Intent putExtra(String name, short[] value) {
3762 if (mExtras == null) {
3763 mExtras = new Bundle();
3764 }
3765 mExtras.putShortArray(name, value);
3766 return this;
3767 }
3768
3769 /**
3770 * Add extended data to the intent. The name must include a package
3771 * prefix, for example the app com.android.contacts would use names
3772 * like "com.android.contacts.ShowAll".
3773 *
3774 * @param name The name of the extra data, with package prefix.
3775 * @param value The char array data value.
3776 *
3777 * @return Returns the same Intent object, for chaining multiple calls
3778 * into a single statement.
3779 *
3780 * @see #putExtras
3781 * @see #removeExtra
3782 * @see #getCharArrayExtra(String)
3783 */
3784 public Intent putExtra(String name, char[] value) {
3785 if (mExtras == null) {
3786 mExtras = new Bundle();
3787 }
3788 mExtras.putCharArray(name, value);
3789 return this;
3790 }
3791
3792 /**
3793 * Add extended data to the intent. The name must include a package
3794 * prefix, for example the app com.android.contacts would use names
3795 * like "com.android.contacts.ShowAll".
3796 *
3797 * @param name The name of the extra data, with package prefix.
3798 * @param value The int array data value.
3799 *
3800 * @return Returns the same Intent object, for chaining multiple calls
3801 * into a single statement.
3802 *
3803 * @see #putExtras
3804 * @see #removeExtra
3805 * @see #getIntArrayExtra(String)
3806 */
3807 public Intent putExtra(String name, int[] value) {
3808 if (mExtras == null) {
3809 mExtras = new Bundle();
3810 }
3811 mExtras.putIntArray(name, value);
3812 return this;
3813 }
3814
3815 /**
3816 * Add extended data to the intent. The name must include a package
3817 * prefix, for example the app com.android.contacts would use names
3818 * like "com.android.contacts.ShowAll".
3819 *
3820 * @param name The name of the extra data, with package prefix.
3821 * @param value The byte array data value.
3822 *
3823 * @return Returns the same Intent object, for chaining multiple calls
3824 * into a single statement.
3825 *
3826 * @see #putExtras
3827 * @see #removeExtra
3828 * @see #getLongArrayExtra(String)
3829 */
3830 public Intent putExtra(String name, long[] value) {
3831 if (mExtras == null) {
3832 mExtras = new Bundle();
3833 }
3834 mExtras.putLongArray(name, value);
3835 return this;
3836 }
3837
3838 /**
3839 * Add extended data to the intent. The name must include a package
3840 * prefix, for example the app com.android.contacts would use names
3841 * like "com.android.contacts.ShowAll".
3842 *
3843 * @param name The name of the extra data, with package prefix.
3844 * @param value The float array data value.
3845 *
3846 * @return Returns the same Intent object, for chaining multiple calls
3847 * into a single statement.
3848 *
3849 * @see #putExtras
3850 * @see #removeExtra
3851 * @see #getFloatArrayExtra(String)
3852 */
3853 public Intent putExtra(String name, float[] value) {
3854 if (mExtras == null) {
3855 mExtras = new Bundle();
3856 }
3857 mExtras.putFloatArray(name, value);
3858 return this;
3859 }
3860
3861 /**
3862 * Add extended data to the intent. The name must include a package
3863 * prefix, for example the app com.android.contacts would use names
3864 * like "com.android.contacts.ShowAll".
3865 *
3866 * @param name The name of the extra data, with package prefix.
3867 * @param value The double array data value.
3868 *
3869 * @return Returns the same Intent object, for chaining multiple calls
3870 * into a single statement.
3871 *
3872 * @see #putExtras
3873 * @see #removeExtra
3874 * @see #getDoubleArrayExtra(String)
3875 */
3876 public Intent putExtra(String name, double[] value) {
3877 if (mExtras == null) {
3878 mExtras = new Bundle();
3879 }
3880 mExtras.putDoubleArray(name, value);
3881 return this;
3882 }
3883
3884 /**
3885 * Add extended data to the intent. The name must include a package
3886 * prefix, for example the app com.android.contacts would use names
3887 * like "com.android.contacts.ShowAll".
3888 *
3889 * @param name The name of the extra data, with package prefix.
3890 * @param value The String array data value.
3891 *
3892 * @return Returns the same Intent object, for chaining multiple calls
3893 * into a single statement.
3894 *
3895 * @see #putExtras
3896 * @see #removeExtra
3897 * @see #getStringArrayExtra(String)
3898 */
3899 public Intent putExtra(String name, String[] value) {
3900 if (mExtras == null) {
3901 mExtras = new Bundle();
3902 }
3903 mExtras.putStringArray(name, value);
3904 return this;
3905 }
3906
3907 /**
3908 * Add extended data to the intent. The name must include a package
3909 * prefix, for example the app com.android.contacts would use names
3910 * like "com.android.contacts.ShowAll".
3911 *
3912 * @param name The name of the extra data, with package prefix.
3913 * @param value The Bundle data value.
3914 *
3915 * @return Returns the same Intent object, for chaining multiple calls
3916 * into a single statement.
3917 *
3918 * @see #putExtras
3919 * @see #removeExtra
3920 * @see #getBundleExtra(String)
3921 */
3922 public Intent putExtra(String name, Bundle value) {
3923 if (mExtras == null) {
3924 mExtras = new Bundle();
3925 }
3926 mExtras.putBundle(name, value);
3927 return this;
3928 }
3929
3930 /**
3931 * Add extended data to the intent. The name must include a package
3932 * prefix, for example the app com.android.contacts would use names
3933 * like "com.android.contacts.ShowAll".
3934 *
3935 * @param name The name of the extra data, with package prefix.
3936 * @param value The IBinder data value.
3937 *
3938 * @return Returns the same Intent object, for chaining multiple calls
3939 * into a single statement.
3940 *
3941 * @see #putExtras
3942 * @see #removeExtra
3943 * @see #getIBinderExtra(String)
3944 *
3945 * @deprecated
3946 * @hide
3947 */
3948 @Deprecated
3949 public Intent putExtra(String name, IBinder value) {
3950 if (mExtras == null) {
3951 mExtras = new Bundle();
3952 }
3953 mExtras.putIBinder(name, value);
3954 return this;
3955 }
3956
3957 /**
3958 * Copy all extras in 'src' in to this intent.
3959 *
3960 * @param src Contains the extras to copy.
3961 *
3962 * @see #putExtra
3963 */
3964 public Intent putExtras(Intent src) {
3965 if (src.mExtras != null) {
3966 if (mExtras == null) {
3967 mExtras = new Bundle(src.mExtras);
3968 } else {
3969 mExtras.putAll(src.mExtras);
3970 }
3971 }
3972 return this;
3973 }
3974
3975 /**
3976 * Add a set of extended data to the intent. The keys must include a package
3977 * prefix, for example the app com.android.contacts would use names
3978 * like "com.android.contacts.ShowAll".
3979 *
3980 * @param extras The Bundle of extras to add to this intent.
3981 *
3982 * @see #putExtra
3983 * @see #removeExtra
3984 */
3985 public Intent putExtras(Bundle extras) {
3986 if (mExtras == null) {
3987 mExtras = new Bundle();
3988 }
3989 mExtras.putAll(extras);
3990 return this;
3991 }
3992
3993 /**
3994 * Completely replace the extras in the Intent with the extras in the
3995 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07003996 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003997 * @param src The exact extras contained in this Intent are copied
3998 * into the target intent, replacing any that were previously there.
3999 */
4000 public Intent replaceExtras(Intent src) {
4001 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4002 return this;
4003 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004004
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004005 /**
4006 * Completely replace the extras in the Intent with the given Bundle of
4007 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004008 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004009 * @param extras The new set of extras in the Intent, or null to erase
4010 * all extras.
4011 */
4012 public Intent replaceExtras(Bundle extras) {
4013 mExtras = extras != null ? new Bundle(extras) : null;
4014 return this;
4015 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004016
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004017 /**
4018 * Remove extended data from the intent.
4019 *
4020 * @see #putExtra
4021 */
4022 public void removeExtra(String name) {
4023 if (mExtras != null) {
4024 mExtras.remove(name);
4025 if (mExtras.size() == 0) {
4026 mExtras = null;
4027 }
4028 }
4029 }
4030
4031 /**
4032 * Set special flags controlling how this intent is handled. Most values
4033 * here depend on the type of component being executed by the Intent,
4034 * specifically the FLAG_ACTIVITY_* flags are all for use with
4035 * {@link Context#startActivity Context.startActivity()} and the
4036 * FLAG_RECEIVER_* flags are all for use with
4037 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4038 *
4039 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4040 * Activities and Tasks</a> documentation for important information on how some of these options impact
4041 * the behavior of your application.
4042 *
4043 * @param flags The desired flags.
4044 *
4045 * @return Returns the same Intent object, for chaining multiple calls
4046 * into a single statement.
4047 *
4048 * @see #getFlags
4049 * @see #addFlags
4050 *
4051 * @see #FLAG_GRANT_READ_URI_PERMISSION
4052 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4053 * @see #FLAG_DEBUG_LOG_RESOLUTION
4054 * @see #FLAG_FROM_BACKGROUND
4055 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
4056 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
4057 * @see #FLAG_ACTIVITY_CLEAR_TOP
4058 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4059 * @see #FLAG_ACTIVITY_FORWARD_RESULT
4060 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
4061 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4062 * @see #FLAG_ACTIVITY_NEW_TASK
4063 * @see #FLAG_ACTIVITY_NO_HISTORY
4064 * @see #FLAG_ACTIVITY_NO_USER_ACTION
4065 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4066 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
4067 * @see #FLAG_ACTIVITY_SINGLE_TOP
4068 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4069 */
4070 public Intent setFlags(int flags) {
4071 mFlags = flags;
4072 return this;
4073 }
4074
4075 /**
4076 * Add additional flags to the intent (or with existing flags
4077 * value).
4078 *
4079 * @param flags The new flags to set.
4080 *
4081 * @return Returns the same Intent object, for chaining multiple calls
4082 * into a single statement.
4083 *
4084 * @see #setFlags
4085 */
4086 public Intent addFlags(int flags) {
4087 mFlags |= flags;
4088 return this;
4089 }
4090
4091 /**
4092 * (Usually optional) Explicitly set the component to handle the intent.
4093 * If left with the default value of null, the system will determine the
4094 * appropriate class to use based on the other fields (action, data,
4095 * type, categories) in the Intent. If this class is defined, the
4096 * specified class will always be used regardless of the other fields. You
4097 * should only set this value when you know you absolutely want a specific
4098 * class to be used; otherwise it is better to let the system find the
4099 * appropriate class so that you will respect the installed applications
4100 * and user preferences.
4101 *
4102 * @param component The name of the application component to handle the
4103 * intent, or null to let the system find one for you.
4104 *
4105 * @return Returns the same Intent object, for chaining multiple calls
4106 * into a single statement.
4107 *
4108 * @see #setClass
4109 * @see #setClassName(Context, String)
4110 * @see #setClassName(String, String)
4111 * @see #getComponent
4112 * @see #resolveActivity
4113 */
4114 public Intent setComponent(ComponentName component) {
4115 mComponent = component;
4116 return this;
4117 }
4118
4119 /**
4120 * Convenience for calling {@link #setComponent} with an
4121 * explicit class name.
4122 *
4123 * @param packageContext A Context of the application package implementing
4124 * this class.
4125 * @param className The name of a class inside of the application package
4126 * that will be used as the component for this Intent.
4127 *
4128 * @return Returns the same Intent object, for chaining multiple calls
4129 * into a single statement.
4130 *
4131 * @see #setComponent
4132 * @see #setClass
4133 */
4134 public Intent setClassName(Context packageContext, String className) {
4135 mComponent = new ComponentName(packageContext, className);
4136 return this;
4137 }
4138
4139 /**
4140 * Convenience for calling {@link #setComponent} with an
4141 * explicit application package name and class name.
4142 *
4143 * @param packageName The name of the package implementing the desired
4144 * component.
4145 * @param className The name of a class inside of the application package
4146 * that will be used as the component for this Intent.
4147 *
4148 * @return Returns the same Intent object, for chaining multiple calls
4149 * into a single statement.
4150 *
4151 * @see #setComponent
4152 * @see #setClass
4153 */
4154 public Intent setClassName(String packageName, String className) {
4155 mComponent = new ComponentName(packageName, className);
4156 return this;
4157 }
4158
4159 /**
4160 * Convenience for calling {@link #setComponent(ComponentName)} with the
4161 * name returned by a {@link Class} object.
4162 *
4163 * @param packageContext A Context of the application package implementing
4164 * this class.
4165 * @param cls The class name to set, equivalent to
4166 * <code>setClassName(context, cls.getName())</code>.
4167 *
4168 * @return Returns the same Intent object, for chaining multiple calls
4169 * into a single statement.
4170 *
4171 * @see #setComponent
4172 */
4173 public Intent setClass(Context packageContext, Class<?> cls) {
4174 mComponent = new ComponentName(packageContext, cls);
4175 return this;
4176 }
4177
4178 /**
4179 * Use with {@link #fillIn} to allow the current action value to be
4180 * overwritten, even if it is already set.
4181 */
4182 public static final int FILL_IN_ACTION = 1<<0;
4183
4184 /**
4185 * Use with {@link #fillIn} to allow the current data or type value
4186 * overwritten, even if it is already set.
4187 */
4188 public static final int FILL_IN_DATA = 1<<1;
4189
4190 /**
4191 * Use with {@link #fillIn} to allow the current categories to be
4192 * overwritten, even if they are already set.
4193 */
4194 public static final int FILL_IN_CATEGORIES = 1<<2;
4195
4196 /**
4197 * Use with {@link #fillIn} to allow the current component value to be
4198 * overwritten, even if it is already set.
4199 */
4200 public static final int FILL_IN_COMPONENT = 1<<3;
4201
4202 /**
4203 * Copy the contents of <var>other</var> in to this object, but only
4204 * where fields are not defined by this object. For purposes of a field
4205 * being defined, the following pieces of data in the Intent are
4206 * considered to be separate fields:
4207 *
4208 * <ul>
4209 * <li> action, as set by {@link #setAction}.
4210 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4211 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4212 * <li> categories, as set by {@link #addCategory}.
4213 * <li> component, as set by {@link #setComponent(ComponentName)} or
4214 * related methods.
4215 * <li> each top-level name in the associated extras.
4216 * </ul>
4217 *
4218 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
4219 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, and
4220 * {@link #FILL_IN_COMPONENT} to override the restriction where the
4221 * corresponding field will not be replaced if it is already set.
4222 *
4223 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4224 * and Intent B with {action="gotit", data-type="some/thing",
4225 * categories="one","two"}.
4226 *
4227 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4228 * containing: {action="gotit", data-type="some/thing",
4229 * categories="bar"}.
4230 *
4231 * @param other Another Intent whose values are to be used to fill in
4232 * the current one.
4233 * @param flags Options to control which fields can be filled in.
4234 *
4235 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
4236 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, and
4237 * {@link #FILL_IN_COMPONENT} indicating which fields were changed.
4238 */
4239 public int fillIn(Intent other, int flags) {
4240 int changes = 0;
4241 if ((mAction == null && other.mAction == null)
4242 || (flags&FILL_IN_ACTION) != 0) {
4243 mAction = other.mAction;
4244 changes |= FILL_IN_ACTION;
4245 }
4246 if ((mData == null && mType == null &&
4247 (other.mData != null || other.mType != null))
4248 || (flags&FILL_IN_DATA) != 0) {
4249 mData = other.mData;
4250 mType = other.mType;
4251 changes |= FILL_IN_DATA;
4252 }
4253 if ((mCategories == null && other.mCategories == null)
4254 || (flags&FILL_IN_CATEGORIES) != 0) {
4255 if (other.mCategories != null) {
4256 mCategories = new HashSet<String>(other.mCategories);
4257 }
4258 changes |= FILL_IN_CATEGORIES;
4259 }
4260 if ((mComponent == null && other.mComponent == null)
4261 || (flags&FILL_IN_COMPONENT) != 0) {
4262 mComponent = other.mComponent;
4263 changes |= FILL_IN_COMPONENT;
4264 }
4265 mFlags |= other.mFlags;
4266 if (mExtras == null) {
4267 if (other.mExtras != null) {
4268 mExtras = new Bundle(other.mExtras);
4269 }
4270 } else if (other.mExtras != null) {
4271 try {
4272 Bundle newb = new Bundle(other.mExtras);
4273 newb.putAll(mExtras);
4274 mExtras = newb;
4275 } catch (RuntimeException e) {
4276 // Modifying the extras can cause us to unparcel the contents
4277 // of the bundle, and if we do this in the system process that
4278 // may fail. We really should handle this (i.e., the Bundle
4279 // impl shouldn't be on top of a plain map), but for now just
4280 // ignore it and keep the original contents. :(
4281 Log.w("Intent", "Failure filling in extras", e);
4282 }
4283 }
4284 return changes;
4285 }
4286
4287 /**
4288 * Wrapper class holding an Intent and implementing comparisons on it for
4289 * the purpose of filtering. The class implements its
4290 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4291 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4292 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4293 * on the wrapped Intent.
4294 */
4295 public static final class FilterComparison {
4296 private final Intent mIntent;
4297 private final int mHashCode;
4298
4299 public FilterComparison(Intent intent) {
4300 mIntent = intent;
4301 mHashCode = intent.filterHashCode();
4302 }
4303
4304 /**
4305 * Return the Intent that this FilterComparison represents.
4306 * @return Returns the Intent held by the FilterComparison. Do
4307 * not modify!
4308 */
4309 public Intent getIntent() {
4310 return mIntent;
4311 }
4312
4313 @Override
4314 public boolean equals(Object obj) {
4315 if (obj instanceof FilterComparison) {
4316 Intent other = ((FilterComparison)obj).mIntent;
4317 return mIntent.filterEquals(other);
4318 }
4319 return false;
4320 }
4321
4322 @Override
4323 public int hashCode() {
4324 return mHashCode;
4325 }
4326 }
4327
4328 /**
4329 * Determine if two intents are the same for the purposes of intent
4330 * resolution (filtering). That is, if their action, data, type,
4331 * class, and categories are the same. This does <em>not</em> compare
4332 * any extra data included in the intents.
4333 *
4334 * @param other The other Intent to compare against.
4335 *
4336 * @return Returns true if action, data, type, class, and categories
4337 * are the same.
4338 */
4339 public boolean filterEquals(Intent other) {
4340 if (other == null) {
4341 return false;
4342 }
4343 if (mAction != other.mAction) {
4344 if (mAction != null) {
4345 if (!mAction.equals(other.mAction)) {
4346 return false;
4347 }
4348 } else {
4349 if (!other.mAction.equals(mAction)) {
4350 return false;
4351 }
4352 }
4353 }
4354 if (mData != other.mData) {
4355 if (mData != null) {
4356 if (!mData.equals(other.mData)) {
4357 return false;
4358 }
4359 } else {
4360 if (!other.mData.equals(mData)) {
4361 return false;
4362 }
4363 }
4364 }
4365 if (mType != other.mType) {
4366 if (mType != null) {
4367 if (!mType.equals(other.mType)) {
4368 return false;
4369 }
4370 } else {
4371 if (!other.mType.equals(mType)) {
4372 return false;
4373 }
4374 }
4375 }
4376 if (mComponent != other.mComponent) {
4377 if (mComponent != null) {
4378 if (!mComponent.equals(other.mComponent)) {
4379 return false;
4380 }
4381 } else {
4382 if (!other.mComponent.equals(mComponent)) {
4383 return false;
4384 }
4385 }
4386 }
4387 if (mCategories != other.mCategories) {
4388 if (mCategories != null) {
4389 if (!mCategories.equals(other.mCategories)) {
4390 return false;
4391 }
4392 } else {
4393 if (!other.mCategories.equals(mCategories)) {
4394 return false;
4395 }
4396 }
4397 }
4398
4399 return true;
4400 }
4401
4402 /**
4403 * Generate hash code that matches semantics of filterEquals().
4404 *
4405 * @return Returns the hash value of the action, data, type, class, and
4406 * categories.
4407 *
4408 * @see #filterEquals
4409 */
4410 public int filterHashCode() {
4411 int code = 0;
4412 if (mAction != null) {
4413 code += mAction.hashCode();
4414 }
4415 if (mData != null) {
4416 code += mData.hashCode();
4417 }
4418 if (mType != null) {
4419 code += mType.hashCode();
4420 }
4421 if (mComponent != null) {
4422 code += mComponent.hashCode();
4423 }
4424 if (mCategories != null) {
4425 code += mCategories.hashCode();
4426 }
4427 return code;
4428 }
4429
4430 @Override
4431 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004432 StringBuilder b = new StringBuilder(128);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004433
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004434 b.append("Intent { ");
4435 toShortString(b, true, true);
4436 b.append(" }");
4437
4438 return b.toString();
4439 }
4440
4441 /** @hide */
4442 public String toShortString(boolean comp, boolean extras) {
4443 StringBuilder b = new StringBuilder(128);
4444 toShortString(b, comp, extras);
4445 return b.toString();
4446 }
4447
4448 /** @hide */
4449 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4450 boolean first = true;
4451 if (mAction != null) {
4452 b.append("act=").append(mAction);
4453 first = false;
4454 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004455 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004456 if (!first) {
4457 b.append(' ');
4458 }
4459 first = false;
4460 b.append("cat=[");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004461 Iterator<String> i = mCategories.iterator();
4462 boolean didone = false;
4463 while (i.hasNext()) {
4464 if (didone) b.append(",");
4465 didone = true;
4466 b.append(i.next());
4467 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004468 b.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004469 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004470 if (mData != null) {
4471 if (!first) {
4472 b.append(' ');
4473 }
4474 first = false;
4475 b.append("dat=").append(mData);
4476 }
4477 if (mType != null) {
4478 if (!first) {
4479 b.append(' ');
4480 }
4481 first = false;
4482 b.append("typ=").append(mType);
4483 }
4484 if (mFlags != 0) {
4485 if (!first) {
4486 b.append(' ');
4487 }
4488 first = false;
4489 b.append("flg=0x").append(Integer.toHexString(mFlags));
4490 }
4491 if (comp && mComponent != null) {
4492 if (!first) {
4493 b.append(' ');
4494 }
4495 first = false;
4496 b.append("cmp=").append(mComponent.flattenToShortString());
4497 }
4498 if (extras && mExtras != null) {
4499 if (!first) {
4500 b.append(' ');
4501 }
4502 first = false;
4503 b.append("(has extras)");
4504 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004505 }
4506
4507 public String toURI() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004508 StringBuilder uri = new StringBuilder(128);
4509 if (mData != null) uri.append(mData.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004510
4511 uri.append("#Intent;");
4512
4513 if (mAction != null) {
4514 uri.append("action=").append(mAction).append(';');
4515 }
4516 if (mCategories != null) {
4517 for (String category : mCategories) {
4518 uri.append("category=").append(category).append(';');
4519 }
4520 }
4521 if (mType != null) {
4522 uri.append("type=").append(mType).append(';');
4523 }
4524 if (mFlags != 0) {
4525 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
4526 }
4527 if (mComponent != null) {
4528 uri.append("component=").append(mComponent.flattenToShortString()).append(';');
4529 }
4530 if (mExtras != null) {
4531 for (String key : mExtras.keySet()) {
4532 final Object value = mExtras.get(key);
4533 char entryType =
4534 value instanceof String ? 'S' :
4535 value instanceof Boolean ? 'B' :
4536 value instanceof Byte ? 'b' :
4537 value instanceof Character ? 'c' :
4538 value instanceof Double ? 'd' :
4539 value instanceof Float ? 'f' :
4540 value instanceof Integer ? 'i' :
4541 value instanceof Long ? 'l' :
4542 value instanceof Short ? 's' :
4543 '\0';
4544
4545 if (entryType != '\0') {
4546 uri.append(entryType);
4547 uri.append('.');
4548 uri.append(Uri.encode(key));
4549 uri.append('=');
4550 uri.append(Uri.encode(value.toString()));
4551 uri.append(';');
4552 }
4553 }
4554 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004555
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004556 uri.append("end");
4557
4558 return uri.toString();
4559 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004560
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004561 public int describeContents() {
4562 return (mExtras != null) ? mExtras.describeContents() : 0;
4563 }
4564
4565 public void writeToParcel(Parcel out, int flags) {
4566 out.writeString(mAction);
4567 Uri.writeToParcel(out, mData);
4568 out.writeString(mType);
4569 out.writeInt(mFlags);
4570 ComponentName.writeToParcel(mComponent, out);
4571
4572 if (mCategories != null) {
4573 out.writeInt(mCategories.size());
4574 for (String category : mCategories) {
4575 out.writeString(category);
4576 }
4577 } else {
4578 out.writeInt(0);
4579 }
4580
4581 out.writeBundle(mExtras);
4582 }
4583
4584 public static final Parcelable.Creator<Intent> CREATOR
4585 = new Parcelable.Creator<Intent>() {
4586 public Intent createFromParcel(Parcel in) {
4587 return new Intent(in);
4588 }
4589 public Intent[] newArray(int size) {
4590 return new Intent[size];
4591 }
4592 };
4593
4594 private Intent(Parcel in) {
4595 readFromParcel(in);
4596 }
4597
4598 public void readFromParcel(Parcel in) {
4599 mAction = in.readString();
4600 mData = Uri.CREATOR.createFromParcel(in);
4601 mType = in.readString();
4602 mFlags = in.readInt();
4603 mComponent = ComponentName.readFromParcel(in);
4604
4605 int N = in.readInt();
4606 if (N > 0) {
4607 mCategories = new HashSet<String>();
4608 int i;
4609 for (i=0; i<N; i++) {
4610 mCategories.add(in.readString());
4611 }
4612 } else {
4613 mCategories = null;
4614 }
4615
4616 mExtras = in.readBundle();
4617 }
4618
4619 /**
4620 * Parses the "intent" element (and its children) from XML and instantiates
4621 * an Intent object. The given XML parser should be located at the tag
4622 * where parsing should start (often named "intent"), from which the
4623 * basic action, data, type, and package and class name will be
4624 * retrieved. The function will then parse in to any child elements,
4625 * looking for <category android:name="xxx"> tags to add categories and
4626 * <extra android:name="xxx" android:value="yyy"> to attach extra data
4627 * to the intent.
4628 *
4629 * @param resources The Resources to use when inflating resources.
4630 * @param parser The XML parser pointing at an "intent" tag.
4631 * @param attrs The AttributeSet interface for retrieving extended
4632 * attribute data at the current <var>parser</var> location.
4633 * @return An Intent object matching the XML data.
4634 * @throws XmlPullParserException If there was an XML parsing error.
4635 * @throws IOException If there was an I/O error.
4636 */
4637 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
4638 throws XmlPullParserException, IOException {
4639 Intent intent = new Intent();
4640
4641 TypedArray sa = resources.obtainAttributes(attrs,
4642 com.android.internal.R.styleable.Intent);
4643
4644 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
4645
4646 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
4647 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
4648 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
4649
4650 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
4651 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
4652 if (packageName != null && className != null) {
4653 intent.setComponent(new ComponentName(packageName, className));
4654 }
4655
4656 sa.recycle();
4657
4658 int outerDepth = parser.getDepth();
4659 int type;
4660 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
4661 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
4662 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
4663 continue;
4664 }
4665
4666 String nodeName = parser.getName();
4667 if (nodeName.equals("category")) {
4668 sa = resources.obtainAttributes(attrs,
4669 com.android.internal.R.styleable.IntentCategory);
4670 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
4671 sa.recycle();
4672
4673 if (cat != null) {
4674 intent.addCategory(cat);
4675 }
4676 XmlUtils.skipCurrentTag(parser);
4677
4678 } else if (nodeName.equals("extra")) {
4679 if (intent.mExtras == null) {
4680 intent.mExtras = new Bundle();
4681 }
4682 resources.parseBundleExtra("extra", attrs, intent.mExtras);
4683 XmlUtils.skipCurrentTag(parser);
4684
4685 } else {
4686 XmlUtils.skipCurrentTag(parser);
4687 }
4688 }
4689
4690 return intent;
4691 }
4692}