blob: 76156147b0d5ac203ee208ae8d65471fb875e0ef [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;
Romain Guy4969af72009-06-17 10:53:19 -0700243 * &lt;action android:name="android.intent.action.MAIN" /&gt;
244 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800245 * &lt;/intent-filter&gt;
246 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700247 * &lt;action android:name="android.intent.action.VIEW" /&gt;
248 * &lt;action android:name="android.intent.action.EDIT" /&gt;
249 * &lt;action android:name="android.intent.action.PICK" /&gt;
250 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
251 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800252 * &lt;/intent-filter&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
255 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
256 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800257 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.VIEW" /&gt;
263 * &lt;action android:name="android.intent.action.EDIT" /&gt;
264 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
265 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800266 * &lt;/intent-filter&gt;
267 *
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.INSERT" /&gt;
270 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
271 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800272 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
280 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
281 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
282 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800284 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
298 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800299 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700306 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
307 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
308 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
310 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800311 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700325 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
326 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
327 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800328 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700374 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
375 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
376 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
377 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800378 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700387 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800390 * &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;
Romain Guy4969af72009-06-17 10:53:19 -0700425 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
426 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
429 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800430 * &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}
Romain Guy4969af72009-06-17 10:53:19 -0700512 * <li> {@link #ACTION_POWER_DISCONNECTED}
513 * <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 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800918 * Activity Action: Deliver multiple data to someone else.
919 * <p>
920 * Like ACTION_SEND, except the data is multiple.
921 * <p>
922 * Input: {@link #getType} is the MIME type of the data being sent.
923 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
924 * #EXTRA_STREAM} field, containing the data to be sent.
925 * <p>
926 * Optional standard extras, which may be interpreted by some recipients as
927 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
928 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
929 * <p>
930 * Output: nothing.
931 */
932 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
933 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
934 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800935 * Activity Action: Handle an incoming phone call.
936 * <p>Input: nothing.
937 * <p>Output: nothing.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
941 /**
942 * Activity Action: Insert an empty item into the given container.
943 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
944 * in which to place the data.
945 * <p>Output: URI of the new data that was created.
946 */
947 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
948 public static final String ACTION_INSERT = "android.intent.action.INSERT";
949 /**
950 * Activity Action: Delete the given data from its container.
951 * <p>Input: {@link #getData} is URI of data to be deleted.
952 * <p>Output: nothing.
953 */
954 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
955 public static final String ACTION_DELETE = "android.intent.action.DELETE";
956 /**
957 * Activity Action: Run the data, whatever that means.
958 * <p>Input: ? (Note: this is currently specific to the test harness.)
959 * <p>Output: nothing.
960 */
961 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
962 public static final String ACTION_RUN = "android.intent.action.RUN";
963 /**
964 * Activity Action: Perform a data synchronization.
965 * <p>Input: ?
966 * <p>Output: ?
967 */
968 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
969 public static final String ACTION_SYNC = "android.intent.action.SYNC";
970 /**
971 * Activity Action: Pick an activity given an intent, returning the class
972 * selected.
973 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
974 * used with {@link PackageManager#queryIntentActivities} to determine the
975 * set of activities from which to pick.
976 * <p>Output: Class name of the activity that was selected.
977 */
978 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
979 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
980 /**
981 * Activity Action: Perform a search.
982 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
983 * is the text to search for. If empty, simply
984 * enter your search results Activity with the search UI activated.
985 * <p>Output: nothing.
986 */
987 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
988 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
989 /**
Jim Miller303736d2009-03-25 18:18:34 -0700990 * Activity Action: Start the platform-defined tutorial
991 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
992 * is the text to search for. If empty, simply
993 * enter your search results Activity with the search UI activated.
994 * <p>Output: nothing.
995 */
996 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
997 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
998 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800999 * Activity Action: Perform a web search.
1000 * <p>
1001 * Input: {@link android.app.SearchManager#QUERY
1002 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1003 * a url starts with http or https, the site will be opened. If it is plain
1004 * text, Google search will be applied.
1005 * <p>
1006 * Output: nothing.
1007 */
1008 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1010 /**
1011 * Activity Action: List all available applications
1012 * <p>Input: Nothing.
1013 * <p>Output: nothing.
1014 */
1015 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1016 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1017 /**
1018 * Activity Action: Show settings for choosing wallpaper
1019 * <p>Input: Nothing.
1020 * <p>Output: Nothing.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1024
1025 /**
1026 * Activity Action: Show activity for reporting a bug.
1027 * <p>Input: Nothing.
1028 * <p>Output: Nothing.
1029 */
1030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1031 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1032
1033 /**
1034 * Activity Action: Main entry point for factory tests. Only used when
1035 * the device is booting in factory test node. The implementing package
1036 * must be installed in the system image.
1037 * <p>Input: nothing
1038 * <p>Output: nothing
1039 */
1040 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1041
1042 /**
1043 * Activity Action: The user pressed the "call" button to go to the dialer
1044 * or other appropriate UI for placing a call.
1045 * <p>Input: Nothing.
1046 * <p>Output: Nothing.
1047 */
1048 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1049 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1050
1051 /**
1052 * Activity Action: Start Voice Command.
1053 * <p>Input: Nothing.
1054 * <p>Output: Nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001058
1059 /**
1060 * Activity Action: Start action associated with long pressing on the
1061 * search key.
1062 * <p>Input: Nothing.
1063 * <p>Output: Nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001067
Jacek Surazski86b6c532009-05-13 14:38:28 +02001068 /**
1069 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1070 * This intent is delivered to the package which installed the application, usually
1071 * the Market.
1072 * <p>Input: No data is specified. The bug report is passed in using
1073 * an {@link #EXTRA_BUG_REPORT} field.
1074 * <p>Output: Nothing.
1075 * @hide
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001079
1080 /**
1081 * Activity Action: Show power usage information to the user.
1082 * <p>Input: Nothing.
1083 * <p>Output: Nothing.
1084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1087
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001088 /**
1089 * Activity Action: Setup wizard to launch after a platform update. This
1090 * activity should have a string meta-data field associated with it,
1091 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1092 * the platform for setup. The activity will be launched only if
1093 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1094 * same value.
1095 * <p>Input: Nothing.
1096 * <p>Output: Nothing.
1097 * @hide
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1101
1102 /**
1103 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1104 * describing the last run version of the platform that was setup.
1105 * @hide
1106 */
1107 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001109 // ---------------------------------------------------------------------
1110 // ---------------------------------------------------------------------
1111 // Standard intent broadcast actions (see action variable).
1112
1113 /**
1114 * Broadcast Action: Sent after the screen turns off.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001115 *
1116 * <p class="note">This is a protected intent that can only be sent
1117 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001118 */
1119 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1120 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1121 /**
1122 * Broadcast Action: Sent after the screen turns on.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001123 *
1124 * <p class="note">This is a protected intent that can only be sent
1125 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001126 */
1127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1128 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001129
1130 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001131 * 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 -07001132 * keyguard is gone).
Dianne Hackborn854060af2009-07-09 18:14:31 -07001133 *
1134 * <p class="note">This is a protected intent that can only be sent
1135 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001136 */
1137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1138 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1139
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001140 /**
1141 * Broadcast Action: The current time has changed. Sent every
1142 * minute. You can <em>not</em> receive this through components declared
1143 * in manifests, only by exlicitly registering for it with
1144 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1145 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001146 *
1147 * <p class="note">This is a protected intent that can only be sent
1148 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001149 */
1150 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1151 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1152 /**
1153 * Broadcast Action: The time was set.
1154 */
1155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1156 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1157 /**
1158 * Broadcast Action: The date has changed.
1159 */
1160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1161 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1162 /**
1163 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1164 * <ul>
1165 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1166 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001167 *
1168 * <p class="note">This is a protected intent that can only be sent
1169 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001170 */
1171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1172 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1173 /**
1174 * Alarm Changed Action: This is broadcast when the AlarmClock
1175 * application's alarm is set or unset. It is used by the
1176 * AlarmClock application and the StatusBar service.
1177 * @hide
1178 */
1179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1180 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1181 /**
1182 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1183 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1184 * @hide
1185 */
1186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1187 public static final String ACTION_SYNC_STATE_CHANGED
1188 = "android.intent.action.SYNC_STATE_CHANGED";
1189 /**
1190 * Broadcast Action: This is broadcast once, after the system has finished
1191 * booting. It can be used to perform application-specific initialization,
1192 * such as installing alarms. You must hold the
1193 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1194 * in order to receive this broadcast.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001195 *
1196 * <p class="note">This is a protected intent that can only be sent
1197 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001198 */
1199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1200 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1201 /**
1202 * Broadcast Action: This is broadcast when a user action should request a
1203 * temporary system dialog to dismiss. Some examples of temporary system
1204 * dialogs are the notification window-shade and the recent tasks dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001205 *
1206 * <p class="note">This is a protected intent that can only be sent
1207 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001208 */
1209 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1210 /**
1211 * Broadcast Action: Trigger the download and eventual installation
1212 * of a package.
1213 * <p>Input: {@link #getData} is the URI of the package file to download.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001214 *
1215 * <p class="note">This is a protected intent that can only be sent
1216 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001217 */
1218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1219 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1220 /**
1221 * Broadcast Action: A new application package has been installed on the
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001222 * device. The data contains the name of the package. Note that the
1223 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001224 * <p>My include the following extras:
1225 * <ul>
1226 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1227 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1228 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1229 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001230 *
1231 * <p class="note">This is a protected intent that can only be sent
1232 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001233 */
1234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1235 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1236 /**
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001237 * Broadcast Action: A new version of an application package has been
1238 * installed, replacing an existing version that was previously installed.
1239 * The data contains the name of the package.
1240 * <p>My include the following extras:
1241 * <ul>
1242 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1243 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001244 *
1245 * <p class="note">This is a protected intent that can only be sent
1246 * by the system.
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001247 */
1248 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1249 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1250 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001251 * Broadcast Action: An existing application package has been removed from
1252 * the device. The data contains the name of the package. The package
1253 * that is being installed does <em>not</em> receive this Intent.
1254 * <ul>
1255 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1256 * to the package.
1257 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1258 * application -- data and code -- is being removed.
1259 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1260 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1261 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001262 *
1263 * <p class="note">This is a protected intent that can only be sent
1264 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001265 */
1266 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1267 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1268 /**
1269 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1270 * enabled or disabled. The data contains the name of the package.
1271 * <ul>
1272 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1273 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001274 *
1275 * <p class="note">This is a protected intent that can only be sent
1276 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001277 */
1278 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1279 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1280 /**
1281 * Broadcast Action: The user has restarted a package, and all of its
1282 * processes have been killed. All runtime state
1283 * associated with it (processes, alarms, notifications, etc) should
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001284 * be removed. Note that the restarted package does <em>not</em>
1285 * receive this broadcast.
1286 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001287 * <ul>
1288 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1289 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001290 *
1291 * <p class="note">This is a protected intent that can only be sent
1292 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001293 */
1294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1295 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1296 /**
1297 * Broadcast Action: The user has cleared the data of a package. This should
1298 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
Dianne Hackbornf63220f2009-03-24 18:38:43 -07001299 * its persistent data is erased and this broadcast sent.
1300 * Note that the cleared package does <em>not</em>
1301 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001302 * <ul>
1303 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1304 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001305 *
1306 * <p class="note">This is a protected intent that can only be sent
1307 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001308 */
1309 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1310 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1311 /**
1312 * Broadcast Action: A user ID has been removed from the system. The user
1313 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001314 *
1315 * <p class="note">This is a protected intent that can only be sent
1316 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001317 */
1318 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1319 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1320 /**
1321 * Broadcast Action: The current system wallpaper has changed. See
1322 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1323 */
1324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1325 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1326 /**
1327 * Broadcast Action: The current device {@link android.content.res.Configuration}
1328 * (orientation, locale, etc) has changed. When such a change happens, the
1329 * UIs (view hierarchy) will need to be rebuilt based on this new
1330 * information; for the most part, applications don't need to worry about
1331 * this, because the system will take care of stopping and restarting the
1332 * application to make sure it sees the new changes. Some system code that
1333 * can not be restarted will need to watch for this action and handle it
1334 * appropriately.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001335 *
1336 * <p class="note">This is a protected intent that can only be sent
1337 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001338 *
1339 * @see android.content.res.Configuration
1340 */
1341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1342 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1343 /**
1344 * Broadcast Action: The charging state, or charge level of the battery has
1345 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001346 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001347 * <p class="note">
1348 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001349 * in manifests, only by explicitly registering for it with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001350 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1351 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001352 *
1353 * <p class="note">This is a protected intent that can only be sent
1354 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001355 */
1356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1357 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1358 /**
1359 * Broadcast Action: Indicates low battery condition on the device.
1360 * This broadcast corresponds to the "Low battery warning" system dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001361 *
1362 * <p class="note">This is a protected intent that can only be sent
1363 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001364 */
1365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1366 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1367 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001368 * Broadcast Action: Indicates the battery is now okay after being low.
1369 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1370 * gone back up to an okay state.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001371 *
1372 * <p class="note">This is a protected intent that can only be sent
1373 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001374 */
1375 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1376 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1377 /**
Christopher Tate06ba5542009-04-09 16:03:56 -07001378 * Broadcast Action: External power has been connected to the device.
1379 * This is intended for applications that wish to register specifically to this notification.
1380 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1381 * stay active to receive this notification. This action can be used to implement actions
1382 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001383 *
1384 * <p class="note">This is a protected intent that can only be sent
1385 * by the system.
Christopher Tate06ba5542009-04-09 16:03:56 -07001386 */
1387 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1388 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
1389 /**
1390 * Broadcast Action: External power has been removed from the device.
1391 * This is intended for applications that wish to register specifically to this notification.
1392 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1393 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001394 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001395 *
1396 * <p class="note">This is a protected intent that can only be sent
1397 * by the system.
Christopher Tate06ba5542009-04-09 16:03:56 -07001398 */
1399 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001400 public static final String ACTION_POWER_DISCONNECTED = "android.intent.action.ACTION_POWER_DISCONNECTED";
Christopher Tate06ba5542009-04-09 16:03:56 -07001401 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001402 * Broadcast Action: Device is shutting down.
1403 * This is broadcast when the device is being shut down (completely turned
1404 * off, not sleeping). Once the broadcast is complete, the final shutdown
1405 * will proceed and all unsaved data lost. Apps will not normally need
1406 * to handle this, since the forground activity will be paused as well.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001407 *
1408 * <p class="note">This is a protected intent that can only be sent
1409 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001410 */
1411 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001412 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001413 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001414 * Broadcast Action: Indicates low memory condition on the device
Dianne Hackborn854060af2009-07-09 18:14:31 -07001415 *
1416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1421 /**
1422 * Broadcast Action: Indicates low memory condition on the device no longer exists
Dianne Hackborn854060af2009-07-09 18:14:31 -07001423 *
1424 * <p class="note">This is a protected intent that can only be sent
1425 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001426 */
1427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1428 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1429 /**
1430 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1431 * and package management should be started.
1432 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1433 * notification.
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1437 /**
1438 * Broadcast Action: The device has entered USB Mass Storage mode.
1439 * This is used mainly for the USB Settings panel.
1440 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1441 * when the SD card file system is mounted or unmounted
1442 */
1443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1444 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1445
1446 /**
1447 * Broadcast Action: The device has exited USB Mass Storage mode.
1448 * This is used mainly for the USB Settings panel.
1449 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1450 * when the SD card file system is mounted or unmounted
1451 */
1452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1453 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1454
1455 /**
1456 * Broadcast Action: External media has been removed.
1457 * The path to the mount point for the removed media is contained in the Intent.mData field.
1458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1461
1462 /**
1463 * Broadcast Action: External media is present, but not mounted at its mount point.
1464 * The path to the mount point for the removed media is contained in the Intent.mData field.
1465 */
1466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1467 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1468
1469 /**
1470 * Broadcast Action: External media is present, and being disk-checked
1471 * The path to the mount point for the checking media is contained in the Intent.mData field.
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1475
1476 /**
1477 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1478 * The path to the mount point for the checking media is contained in the Intent.mData field.
1479 */
1480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1481 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1482
1483 /**
1484 * Broadcast Action: External media is present and mounted at its mount point.
1485 * The path to the mount point for the removed media is contained in the Intent.mData field.
1486 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1487 * media was mounted read only.
1488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1491
1492 /**
1493 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1494 * The path to the mount point for the removed media is contained in the Intent.mData field.
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1498
1499 /**
1500 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1501 * The path to the mount point for the removed media is contained in the Intent.mData field.
1502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1505
1506 /**
1507 * Broadcast Action: External media is present but cannot be mounted.
1508 * The path to the mount point for the removed media is contained in the Intent.mData field.
1509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1512
1513 /**
1514 * Broadcast Action: User has expressed the desire to remove the external storage media.
1515 * Applications should close all files they have open within the mount point when they receive this intent.
1516 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1520
1521 /**
1522 * Broadcast Action: The media scanner has started scanning a directory.
1523 * The path to the directory being scanned is contained in the Intent.mData field.
1524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1527
1528 /**
1529 * Broadcast Action: The media scanner has finished scanning a directory.
1530 * The path to the scanned directory is contained in the Intent.mData field.
1531 */
1532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1533 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1534
1535 /**
1536 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1537 * The path to the file is contained in the Intent.mData field.
1538 */
1539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1540 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1541
1542 /**
1543 * Broadcast Action: The "Media Button" was pressed. Includes a single
1544 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1545 * caused the broadcast.
1546 */
1547 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1548 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1549
1550 /**
1551 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1552 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1553 * caused the broadcast.
1554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1556 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1557
1558 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1559 // location; they are not general-purpose actions.
1560
1561 /**
1562 * Broadcast Action: An GTalk connection has been established.
1563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1566 "android.intent.action.GTALK_CONNECTED";
1567
1568 /**
1569 * Broadcast Action: An GTalk connection has been disconnected.
1570 */
1571 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1572 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1573 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001574
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001575 /**
1576 * Broadcast Action: An input method has been changed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001577 */
1578 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1579 public static final String ACTION_INPUT_METHOD_CHANGED =
1580 "android.intent.action.INPUT_METHOD_CHANGED";
1581
1582 /**
1583 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1584 * more radios have been turned off or on. The intent will have the following extra value:</p>
1585 * <ul>
1586 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1587 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1588 * turned off</li>
1589 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001590 *
1591 * <p class="note">This is a protected intent that can only be sent
1592 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001593 */
1594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1595 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1596
1597 /**
1598 * Broadcast Action: Some content providers have parts of their namespace
1599 * where they publish new events or items that the user may be especially
1600 * interested in. For these things, they may broadcast this action when the
1601 * set of interesting items change.
1602 *
1603 * For example, GmailProvider sends this notification when the set of unread
1604 * mail in the inbox changes.
1605 *
1606 * <p>The data of the intent identifies which part of which provider
1607 * changed. When queried through the content resolver, the data URI will
1608 * return the data set in question.
1609 *
1610 * <p>The intent will have the following extra values:
1611 * <ul>
1612 * <li><em>count</em> - The number of items in the data set. This is the
1613 * same as the number of items in the cursor returned by querying the
1614 * data URI. </li>
1615 * </ul>
1616 *
1617 * This intent will be sent at boot (if the count is non-zero) and when the
1618 * data set changes. It is possible for the data set to change without the
1619 * count changing (for example, if a new unread message arrives in the same
1620 * sync operation in which a message is archived). The phone should still
1621 * ring/vibrate/etc as normal in this case.
1622 */
1623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1624 public static final String ACTION_PROVIDER_CHANGED =
1625 "android.intent.action.PROVIDER_CHANGED";
1626
1627 /**
1628 * Broadcast Action: Wired Headset plugged in or unplugged.
1629 *
1630 * <p>The intent will have the following extra values:
1631 * <ul>
1632 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1633 * <li><em>name</em> - Headset type, human readable string </li>
1634 * </ul>
1635 * </ul>
1636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_HEADSET_PLUG =
1639 "android.intent.action.HEADSET_PLUG";
1640
1641 /**
1642 * Broadcast Action: An outgoing call is about to be placed.
1643 *
1644 * <p>The Intent will have the following extra value:
1645 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001646 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001647 * the phone number originally intended to be dialed.</li>
1648 * </ul>
1649 * <p>Once the broadcast is finished, the resultData is used as the actual
1650 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001651 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001652 * outgoing call in turn: for example, a parental control application
1653 * might verify that the user is authorized to place the call at that
1654 * time, then a number-rewriting application might add an area code if
1655 * one was not specified.</p>
1656 * <p>For consistency, any receiver whose purpose is to prohibit phone
1657 * calls should have a priority of 0, to ensure it will see the final
1658 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001659 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001660 * should have a positive priority.
1661 * Negative priorities are reserved for the system for this broadcast;
1662 * using them may cause problems.</p>
1663 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1664 * abort the broadcast.</p>
1665 * <p>Emergency calls cannot be intercepted using this mechanism, and
1666 * other calls cannot be modified to call emergency numbers using this
1667 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001668 * <p>You must hold the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001669 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1670 * permission to receive this Intent.</p>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001671 *
1672 * <p class="note">This is a protected intent that can only be sent
1673 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_NEW_OUTGOING_CALL =
1677 "android.intent.action.NEW_OUTGOING_CALL";
1678
1679 /**
1680 * Broadcast Action: Have the device reboot. This is only for use by
1681 * system code.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001682 *
1683 * <p class="note">This is a protected intent that can only be sent
1684 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001685 */
1686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1687 public static final String ACTION_REBOOT =
1688 "android.intent.action.REBOOT";
1689
Charles Chen04779542009-06-24 14:55:53 -07001690 /**
1691 * @hide
1692 * TODO: This will be unhidden in a later CL.
1693 * Broadcast Action: The TextToSpeech synthesizer has completed processing
1694 * all of the text in the speech queue.
1695 */
1696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1697 public static final String ACTION_TTS_QUEUE_PROCESSING_COMPLETED =
1698 "android.intent.action.TTS_QUEUE_PROCESSING_COMPLETED";
1699
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001700 // ---------------------------------------------------------------------
1701 // ---------------------------------------------------------------------
1702 // Standard intent categories (see addCategory()).
1703
1704 /**
1705 * Set if the activity should be an option for the default action
1706 * (center press) to perform on a piece of data. Setting this will
1707 * hide from the user any activities without it set when performing an
1708 * action on some data. Note that this is normal -not- set in the
1709 * Intent when initiating an action -- it is for use in intent filters
1710 * specified in packages.
1711 */
1712 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1713 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1714 /**
1715 * Activities that can be safely invoked from a browser must support this
1716 * category. For example, if the user is viewing a web page or an e-mail
1717 * and clicks on a link in the text, the Intent generated execute that
1718 * link will require the BROWSABLE category, so that only activities
1719 * supporting this category will be considered as possible actions. By
1720 * supporting this category, you are promising that there is nothing
1721 * damaging (without user intervention) that can happen by invoking any
1722 * matching Intent.
1723 */
1724 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1725 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1726 /**
1727 * Set if the activity should be considered as an alternative action to
1728 * the data the user is currently viewing. See also
1729 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1730 * applies to the selection in a list of items.
1731 *
1732 * <p>Supporting this category means that you would like your activity to be
1733 * displayed in the set of alternative things the user can do, usually as
1734 * part of the current activity's options menu. You will usually want to
1735 * include a specific label in the &lt;intent-filter&gt; of this action
1736 * describing to the user what it does.
1737 *
1738 * <p>The action of IntentFilter with this category is important in that it
1739 * describes the specific action the target will perform. This generally
1740 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1741 * a specific name such as "com.android.camera.action.CROP. Only one
1742 * alternative of any particular action will be shown to the user, so using
1743 * a specific action like this makes sure that your alternative will be
1744 * displayed while also allowing other applications to provide their own
1745 * overrides of that particular action.
1746 */
1747 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1748 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1749 /**
1750 * Set if the activity should be considered as an alternative selection
1751 * action to the data the user has currently selected. This is like
1752 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1753 * of items from which the user can select, giving them alternatives to the
1754 * default action that will be performed on it.
1755 */
1756 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1757 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1758 /**
1759 * Intended to be used as a tab inside of an containing TabActivity.
1760 */
1761 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1762 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1763 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001764 * Should be displayed in the top-level launcher.
1765 */
1766 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1767 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1768 /**
1769 * Provides information about the package it is in; typically used if
1770 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1771 * a front-door to the user without having to be shown in the all apps list.
1772 */
1773 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1774 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1775 /**
1776 * This is the home activity, that is the first activity that is displayed
1777 * when the device boots.
1778 */
1779 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1780 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1781 /**
1782 * This activity is a preference panel.
1783 */
1784 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1785 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1786 /**
1787 * This activity is a development preference panel.
1788 */
1789 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1790 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1791 /**
1792 * Capable of running inside a parent activity container.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001793 */
1794 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1795 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1796 /**
1797 * This activity may be exercised by the monkey or other automated test tools.
1798 */
1799 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1800 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1801 /**
1802 * To be used as a test (not part of the normal user experience).
1803 */
1804 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1805 /**
1806 * To be used as a unit test (run through the Test Harness).
1807 */
1808 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1809 /**
1810 * To be used as an sample code example (not part of the normal user
1811 * experience).
1812 */
1813 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1814 /**
1815 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1816 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1817 * when queried, though it is allowable for those columns to be blank.
1818 */
1819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1820 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1821
1822 /**
1823 * To be used as code under test for framework instrumentation tests.
1824 */
1825 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1826 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
1827 // ---------------------------------------------------------------------
1828 // ---------------------------------------------------------------------
1829 // Standard extra data keys.
1830
1831 /**
1832 * The initial data to place in a newly created record. Use with
1833 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1834 * fields as would be given to the underlying ContentProvider.insert()
1835 * call.
1836 */
1837 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1838
1839 /**
1840 * A constant CharSequence that is associated with the Intent, used with
1841 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1842 * this may be a styled CharSequence, so you must use
1843 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1844 * retrieve it.
1845 */
1846 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1847
1848 /**
1849 * A content: URI holding a stream of data associated with the Intent,
1850 * used with {@link #ACTION_SEND} to supply the data being sent.
1851 */
1852 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1853
1854 /**
1855 * A String[] holding e-mail addresses that should be delivered to.
1856 */
1857 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1858
1859 /**
1860 * A String[] holding e-mail addresses that should be carbon copied.
1861 */
1862 public static final String EXTRA_CC = "android.intent.extra.CC";
1863
1864 /**
1865 * A String[] holding e-mail addresses that should be blind carbon copied.
1866 */
1867 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1868
1869 /**
1870 * A constant string holding the desired subject line of a message.
1871 */
1872 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1873
1874 /**
1875 * An Intent describing the choices you would like shown with
1876 * {@link #ACTION_PICK_ACTIVITY}.
1877 */
1878 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1879
1880 /**
1881 * A CharSequence dialog title to provide to the user when used with a
1882 * {@link #ACTION_CHOOSER}.
1883 */
1884 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1885
1886 /**
1887 * A {@link android.view.KeyEvent} object containing the event that
1888 * triggered the creation of the Intent it is in.
1889 */
1890 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1891
1892 /**
1893 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1894 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1895 * of restarting the application.
1896 */
1897 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1898
1899 /**
1900 * A String holding the phone number originally entered in
1901 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1902 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1903 */
1904 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1905 /**
1906 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1907 * intents to supply the uid the package had been assigned. Also an optional
1908 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1909 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1910 * purpose.
1911 */
1912 public static final String EXTRA_UID = "android.intent.extra.UID";
1913
1914 /**
1915 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1916 * intents to indicate whether this represents a full uninstall (removing
1917 * both the code and its data) or a partial uninstall (leaving its data,
1918 * implying that this is an update).
1919 */
1920 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001921
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001922 /**
1923 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1924 * intents to indicate that this is a replacement of the package, so this
1925 * broadcast will immediately be followed by an add broadcast for a
1926 * different version of the same package.
1927 */
1928 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001929
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001930 /**
1931 * Used as an int extra field in {@link android.app.AlarmManager} intents
1932 * to tell the application being invoked how many pending alarms are being
1933 * delievered with the intent. For one-shot alarms this will always be 1.
1934 * For recurring alarms, this might be greater than 1 if the device was
1935 * asleep or powered off at the time an earlier alarm would have been
1936 * delivered.
1937 */
1938 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07001939
Jacek Surazski86b6c532009-05-13 14:38:28 +02001940 /**
1941 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
1942 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07001943 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02001944 * @hide
1945 */
1946 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
1947
1948 /**
Romain Guy4969af72009-06-17 10:53:19 -07001949 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02001950 * package. Specifies the installer package name; this package will receive the
1951 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07001952 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02001953 * @hide
1954 */
Romain Guy4969af72009-06-17 10:53:19 -07001955 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02001956 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001957
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001958 // ---------------------------------------------------------------------
1959 // ---------------------------------------------------------------------
1960 // Intent flags (see mFlags variable).
1961
1962 /**
1963 * If set, the recipient of this Intent will be granted permission to
1964 * perform read operations on the Uri in the Intent's data.
1965 */
1966 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
1967 /**
1968 * If set, the recipient of this Intent will be granted permission to
1969 * perform write operations on the Uri in the Intent's data.
1970 */
1971 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
1972 /**
1973 * Can be set by the caller to indicate that this Intent is coming from
1974 * a background operation, not from direct user interaction.
1975 */
1976 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
1977 /**
1978 * A flag you can enable for debugging: when set, log messages will be
1979 * printed during the resolution of this intent to show you what has
1980 * been found to create the final resolved list.
1981 */
1982 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
1983
1984 /**
1985 * If set, the new activity is not kept in the history stack. As soon as
1986 * the user navigates away from it, the activity is finished. This may also
1987 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
1988 * noHistory} attribute.
1989 */
1990 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
1991 /**
1992 * If set, the activity will not be launched if it is already running
1993 * at the top of the history stack.
1994 */
1995 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
1996 /**
1997 * If set, this activity will become the start of a new task on this
1998 * history stack. A task (from the activity that started it to the
1999 * next task activity) defines an atomic group of activities that the
2000 * user can move to. Tasks can be moved to the foreground and background;
2001 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002002 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002003 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2004 * Activities and Tasks</a> for more details on tasks.
2005 *
2006 * <p>This flag is generally used by activities that want
2007 * to present a "launcher" style behavior: they give the user a list of
2008 * separate things that can be done, which otherwise run completely
2009 * independently of the activity launching them.
2010 *
2011 * <p>When using this flag, if a task is already running for the activity
2012 * you are now starting, then a new activity will not be started; instead,
2013 * the current task will simply be brought to the front of the screen with
2014 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2015 * to disable this behavior.
2016 *
2017 * <p>This flag can not be used when the caller is requesting a result from
2018 * the activity being launched.
2019 */
2020 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2021 /**
2022 * <strong>Do not use this flag unless you are implementing your own
2023 * top-level application launcher.</strong> Used in conjunction with
2024 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2025 * behavior of bringing an existing task to the foreground. When set,
2026 * a new task is <em>always</em> started to host the Activity for the
2027 * Intent, regardless of whether there is already an existing task running
2028 * the same thing.
2029 *
2030 * <p><strong>Because the default system does not include graphical task management,
2031 * you should not use this flag unless you provide some way for a user to
2032 * return back to the tasks you have launched.</strong>
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 ignored if
2035 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2036 *
2037 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2038 * Activities and Tasks</a> for more details on tasks.
2039 */
2040 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2041 /**
2042 * If set, and the activity being launched is already running in the
2043 * current task, then instead of launching a new instance of that activity,
2044 * all of the other activities on top of it will be closed and this Intent
2045 * will be delivered to the (now on top) old activity as a new Intent.
2046 *
2047 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2048 * If D calls startActivity() with an Intent that resolves to the component
2049 * of activity B, then C and D will be finished and B receive the given
2050 * Intent, resulting in the stack now being: A, B.
2051 *
2052 * <p>The currently running instance of task B in the above example will
2053 * either receive the new intent you are starting here in its
2054 * onNewIntent() method, or be itself finished and restarted with the
2055 * new intent. If it has declared its launch mode to be "multiple" (the
2056 * default) it will be finished and re-created; for all other launch modes
2057 * it will receive the Intent in the current instance.
2058 *
2059 * <p>This launch mode can also be used to good effect in conjunction with
2060 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2061 * of a task, it will bring any currently running instance of that task
2062 * to the foreground, and then clear it to its root state. This is
2063 * especially useful, for example, when launching an activity from the
2064 * notification manager.
2065 *
2066 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2067 * Activities and Tasks</a> for more details on tasks.
2068 */
2069 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2070 /**
2071 * If set and this intent is being used to launch a new activity from an
2072 * existing one, then the reply target of the existing activity will be
2073 * transfered to the new activity. This way the new activity can call
2074 * {@link android.app.Activity#setResult} and have that result sent back to
2075 * the reply target of the original activity.
2076 */
2077 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2078 /**
2079 * If set and this intent is being used to launch a new activity from an
2080 * existing one, the current activity will not be counted as the top
2081 * activity for deciding whether the new intent should be delivered to
2082 * the top instead of starting a new one. The previous activity will
2083 * be used as the top, with the assumption being that the current activity
2084 * will finish itself immediately.
2085 */
2086 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2087 /**
2088 * If set, the new activity is not kept in the list of recently launched
2089 * activities.
2090 */
2091 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2092 /**
2093 * This flag is not normally set by application code, but set for you by
2094 * the system as described in the
2095 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2096 * launchMode} documentation for the singleTask mode.
2097 */
2098 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2099 /**
2100 * If set, and this activity is either being started in a new task or
2101 * bringing to the top an existing task, then it will be launched as
2102 * the front door of the task. This will result in the application of
2103 * any affinities needed to have that task in the proper state (either
2104 * moving activities to or from it), or simply resetting that task to
2105 * its initial state if needed.
2106 */
2107 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2108 /**
2109 * This flag is not normally set by application code, but set for you by
2110 * the system if this activity is being launched from history
2111 * (longpress home key).
2112 */
2113 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
2114 /**
2115 * If set, this marks a point in the task's activity stack that should
2116 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002117 * is brought to the foreground with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002118 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2119 * the user re-launching it from home), this activity and all on top of
2120 * it will be finished so that the user does not return to them, but
2121 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002122 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 * <p>This is useful for cases where you have a logical break in your
2124 * application. For example, an e-mail application may have a command
2125 * to view an attachment, which launches an image view activity to
2126 * display it. This activity should be part of the e-mail application's
2127 * task, since it is a part of the task the user is involved in. However,
2128 * if the user leaves that task, and later selects the e-mail app from
2129 * home, we may like them to return to the conversation they were
2130 * viewing, not the picture attachment, since that is confusing. By
2131 * setting this flag when launching the image viewer, that viewer and
2132 * any activities it starts will be removed the next time the user returns
2133 * to mail.
2134 */
2135 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
2136 /**
2137 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
2138 * callback from occurring on the current frontmost activity before it is
2139 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002140 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002141 * <p>Typically, an activity can rely on that callback to indicate that an
2142 * explicit user action has caused their activity to be moved out of the
2143 * foreground. The callback marks an appropriate point in the activity's
2144 * lifecycle for it to dismiss any notifications that it intends to display
2145 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002146 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002147 * <p>If an activity is ever started via any non-user-driven events such as
2148 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2149 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002150 * activity does not think the user has acknowledged its notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002151 */
2152 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
2153 /**
2154 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2155 * this flag will cause the launched activity to be brought to the front of its
2156 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002157 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002158 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2159 * If D calls startActivity() with an Intent that resolves to the component
2160 * of activity B, then B will be brought to the front of the history stack,
2161 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002162 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002163 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002164 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002165 */
2166 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
2167 /**
2168 * If set, when sending a broadcast only registered receivers will be
2169 * called -- no BroadcastReceiver components will be launched.
2170 */
2171 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
2172 /**
2173 * If set, when sending a broadcast <i>before boot has completed</i> only
2174 * registered receivers will be called -- no BroadcastReceiver components
2175 * will be launched. Sticky intent state will be recorded properly even
2176 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2177 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002178 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 * <p>This flag is only for use by system sevices as a convenience to
2180 * avoid having to implement a more complex mechanism around detection
2181 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002182 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002183 * @hide
2184 */
2185 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
2186
2187 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002188 // ---------------------------------------------------------------------
2189 // toUri() and parseUri() options.
2190
2191 /**
2192 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2193 * always has the "intent:" scheme. This syntax can be used when you want
2194 * to later disambiguate between URIs that are intended to describe an
2195 * Intent vs. all others that should be treated as raw URIs. When used
2196 * with {@link #parseUri}, any other scheme will result in a generic
2197 * VIEW action for that raw URI.
2198 */
2199 public static final int URI_INTENT_SCHEME = 1<<0;
2200
2201 // ---------------------------------------------------------------------
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002202
2203 private String mAction;
2204 private Uri mData;
2205 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002206 private String mPackage;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002207 private ComponentName mComponent;
2208 private int mFlags;
2209 private HashSet<String> mCategories;
2210 private Bundle mExtras;
2211
2212 // ---------------------------------------------------------------------
2213
2214 /**
2215 * Create an empty intent.
2216 */
2217 public Intent() {
2218 }
2219
2220 /**
2221 * Copy constructor.
2222 */
2223 public Intent(Intent o) {
2224 this.mAction = o.mAction;
2225 this.mData = o.mData;
2226 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002227 this.mPackage = o.mPackage;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002228 this.mComponent = o.mComponent;
2229 this.mFlags = o.mFlags;
2230 if (o.mCategories != null) {
2231 this.mCategories = new HashSet<String>(o.mCategories);
2232 }
2233 if (o.mExtras != null) {
2234 this.mExtras = new Bundle(o.mExtras);
2235 }
2236 }
2237
2238 @Override
2239 public Object clone() {
2240 return new Intent(this);
2241 }
2242
2243 private Intent(Intent o, boolean all) {
2244 this.mAction = o.mAction;
2245 this.mData = o.mData;
2246 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002247 this.mPackage = o.mPackage;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002248 this.mComponent = o.mComponent;
2249 if (o.mCategories != null) {
2250 this.mCategories = new HashSet<String>(o.mCategories);
2251 }
2252 }
2253
2254 /**
2255 * Make a clone of only the parts of the Intent that are relevant for
2256 * filter matching: the action, data, type, component, and categories.
2257 */
2258 public Intent cloneFilter() {
2259 return new Intent(this, false);
2260 }
2261
2262 /**
2263 * Create an intent with a given action. All other fields (data, type,
2264 * class) are null. Note that the action <em>must</em> be in a
2265 * namespace because Intents are used globally in the system -- for
2266 * example the system VIEW action is android.intent.action.VIEW; an
2267 * application's custom action would be something like
2268 * com.google.app.myapp.CUSTOM_ACTION.
2269 *
2270 * @param action The Intent action, such as ACTION_VIEW.
2271 */
2272 public Intent(String action) {
2273 mAction = action;
2274 }
2275
2276 /**
2277 * Create an intent with a given action and for a given data url. Note
2278 * that the action <em>must</em> be in a namespace because Intents are
2279 * used globally in the system -- for example the system VIEW action is
2280 * android.intent.action.VIEW; an application's custom action would be
2281 * something like com.google.app.myapp.CUSTOM_ACTION.
2282 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07002283 * <p><em>Note: scheme and host name matching in the Android framework is
2284 * case-sensitive, unlike the formal RFC. As a result,
2285 * you should always ensure that you write your Uri with these elements
2286 * using lower case letters, and normalize any Uris you receive from
2287 * outside of Android to ensure the scheme and host is lower case.</em></p>
2288 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002289 * @param action The Intent action, such as ACTION_VIEW.
2290 * @param uri The Intent data URI.
2291 */
2292 public Intent(String action, Uri uri) {
2293 mAction = action;
2294 mData = uri;
2295 }
2296
2297 /**
2298 * Create an intent for a specific component. All other fields (action, data,
2299 * type, class) are null, though they can be modified later with explicit
2300 * calls. This provides a convenient way to create an intent that is
2301 * intended to execute a hard-coded class name, rather than relying on the
2302 * system to find an appropriate class for you; see {@link #setComponent}
2303 * for more information on the repercussions of this.
2304 *
2305 * @param packageContext A Context of the application package implementing
2306 * this class.
2307 * @param cls The component class that is to be used for the intent.
2308 *
2309 * @see #setClass
2310 * @see #setComponent
2311 * @see #Intent(String, android.net.Uri , Context, Class)
2312 */
2313 public Intent(Context packageContext, Class<?> cls) {
2314 mComponent = new ComponentName(packageContext, cls);
2315 }
2316
2317 /**
2318 * Create an intent for a specific component with a specified action and data.
2319 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2320 * construct the Intent and then calling {@link #setClass} to set its
2321 * class.
2322 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07002323 * <p><em>Note: scheme and host name matching in the Android framework is
2324 * case-sensitive, unlike the formal RFC. As a result,
2325 * you should always ensure that you write your Uri with these elements
2326 * using lower case letters, and normalize any Uris you receive from
2327 * outside of Android to ensure the scheme and host is lower case.</em></p>
2328 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002329 * @param action The Intent action, such as ACTION_VIEW.
2330 * @param uri The Intent data URI.
2331 * @param packageContext A Context of the application package implementing
2332 * this class.
2333 * @param cls The component class that is to be used for the intent.
2334 *
2335 * @see #Intent(String, android.net.Uri)
2336 * @see #Intent(Context, Class)
2337 * @see #setClass
2338 * @see #setComponent
2339 */
2340 public Intent(String action, Uri uri,
2341 Context packageContext, Class<?> cls) {
2342 mAction = action;
2343 mData = uri;
2344 mComponent = new ComponentName(packageContext, cls);
2345 }
2346
2347 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002348 * Call {@link #parseUri} with 0 flags.
2349 * @deprecated Use {@link #parseUri} instead.
2350 */
2351 @Deprecated
2352 public static Intent getIntent(String uri) throws URISyntaxException {
2353 return parseUri(uri, 0);
2354 }
2355
2356 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002357 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002358 * category, and other intent fields, if it was returned by
2359 * {@link #toUri}.. If the Intent was not generate by toUri(), its data
2360 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002361 *
2362 * <p>The URI given here must not be relative -- that is, it must include
2363 * the scheme and full path.
2364 *
2365 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002366 * @param flags Additional processing flags. Either 0 or
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002367 *
2368 * @return Intent The newly created Intent object.
2369 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002370 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2371 * it bad (as parsed by the Uri class) or the Intent data within the
2372 * URI is invalid.
2373 *
2374 * @see #toUri
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002375 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002376 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002377 int i = 0;
2378 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002379 // Validate intent scheme for if requested.
2380 if ((flags&URI_INTENT_SCHEME) != 0) {
2381 if (!uri.startsWith("intent:")) {
2382 Intent intent = new Intent(ACTION_VIEW);
2383 try {
2384 intent.setData(Uri.parse(uri));
2385 } catch (IllegalArgumentException e) {
2386 throw new URISyntaxException(uri, e.getMessage());
2387 }
2388 return intent;
2389 }
2390 }
2391
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002392 // simple case
2393 i = uri.lastIndexOf("#");
2394 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2395
2396 // old format Intent URI
2397 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002398
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002399 // new format
2400 Intent intent = new Intent(ACTION_VIEW);
2401
2402 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002403 String data = i >= 0 ? uri.substring(0, i) : null;
2404 String scheme = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002405 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002406
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002407 // loop over contents of Intent, all name=value;
2408 while (!uri.startsWith("end", i)) {
2409 int eq = uri.indexOf('=', i);
2410 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002411 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002412
2413 // action
2414 if (uri.startsWith("action=", i)) {
2415 intent.mAction = value;
2416 }
2417
2418 // categories
2419 else if (uri.startsWith("category=", i)) {
2420 intent.addCategory(value);
2421 }
2422
2423 // type
2424 else if (uri.startsWith("type=", i)) {
2425 intent.mType = value;
2426 }
2427
2428 // launch flags
2429 else if (uri.startsWith("launchFlags=", i)) {
2430 intent.mFlags = Integer.decode(value).intValue();
2431 }
2432
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002433 // package
2434 else if (uri.startsWith("package=", i)) {
2435 intent.mPackage = value;
2436 }
2437
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002438 // component
2439 else if (uri.startsWith("component=", i)) {
2440 intent.mComponent = ComponentName.unflattenFromString(value);
2441 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002442
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002443 // scheme
2444 else if (uri.startsWith("scheme=", i)) {
2445 scheme = value;
2446 }
2447
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002448 // extra
2449 else {
2450 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002451 // create Bundle if it doesn't already exist
2452 if (intent.mExtras == null) intent.mExtras = new Bundle();
2453 Bundle b = intent.mExtras;
2454 // add EXTRA
2455 if (uri.startsWith("S.", i)) b.putString(key, value);
2456 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2457 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2458 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2459 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2460 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2461 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2462 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2463 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2464 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2465 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002466
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002467 // move to the next item
2468 i = semi + 1;
2469 }
2470
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002471 if (data != null) {
2472 if (data.startsWith("intent:")) {
2473 data = data.substring(7);
2474 if (scheme != null) {
2475 data = scheme + ':' + data;
2476 }
2477 }
2478
2479 if (data.length() > 0) {
2480 try {
2481 intent.mData = Uri.parse(data);
2482 } catch (IllegalArgumentException e) {
2483 throw new URISyntaxException(uri, e.getMessage());
2484 }
2485 }
2486 }
2487
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002488 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002489
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002490 } catch (IndexOutOfBoundsException e) {
2491 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2492 }
2493 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002494
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002495 public static Intent getIntentOld(String uri) throws URISyntaxException {
2496 Intent intent;
2497
2498 int i = uri.lastIndexOf('#');
2499 if (i >= 0) {
2500 Uri data = null;
2501 String action = null;
2502 if (i > 0) {
2503 data = Uri.parse(uri.substring(0, i));
2504 }
2505
2506 i++;
2507
2508 if (uri.regionMatches(i, "action(", 0, 7)) {
2509 i += 7;
2510 int j = uri.indexOf(')', i);
2511 action = uri.substring(i, j);
2512 i = j + 1;
2513 }
2514
2515 intent = new Intent(action, data);
2516
2517 if (uri.regionMatches(i, "categories(", 0, 11)) {
2518 i += 11;
2519 int j = uri.indexOf(')', i);
2520 while (i < j) {
2521 int sep = uri.indexOf('!', i);
2522 if (sep < 0) sep = j;
2523 if (i < sep) {
2524 intent.addCategory(uri.substring(i, sep));
2525 }
2526 i = sep + 1;
2527 }
2528 i = j + 1;
2529 }
2530
2531 if (uri.regionMatches(i, "type(", 0, 5)) {
2532 i += 5;
2533 int j = uri.indexOf(')', i);
2534 intent.mType = uri.substring(i, j);
2535 i = j + 1;
2536 }
2537
2538 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2539 i += 12;
2540 int j = uri.indexOf(')', i);
2541 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2542 i = j + 1;
2543 }
2544
2545 if (uri.regionMatches(i, "component(", 0, 10)) {
2546 i += 10;
2547 int j = uri.indexOf(')', i);
2548 int sep = uri.indexOf('!', i);
2549 if (sep >= 0 && sep < j) {
2550 String pkg = uri.substring(i, sep);
2551 String cls = uri.substring(sep + 1, j);
2552 intent.mComponent = new ComponentName(pkg, cls);
2553 }
2554 i = j + 1;
2555 }
2556
2557 if (uri.regionMatches(i, "extras(", 0, 7)) {
2558 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002559
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002560 final int closeParen = uri.indexOf(')', i);
2561 if (closeParen == -1) throw new URISyntaxException(uri,
2562 "EXTRA missing trailing ')'", i);
2563
2564 while (i < closeParen) {
2565 // fetch the key value
2566 int j = uri.indexOf('=', i);
2567 if (j <= i + 1 || i >= closeParen) {
2568 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2569 }
2570 char type = uri.charAt(i);
2571 i++;
2572 String key = uri.substring(i, j);
2573 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002574
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002575 // get type-value
2576 j = uri.indexOf('!', i);
2577 if (j == -1 || j >= closeParen) j = closeParen;
2578 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2579 String value = uri.substring(i, j);
2580 i = j;
2581
2582 // create Bundle if it doesn't already exist
2583 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002584
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002585 // add item to bundle
2586 try {
2587 switch (type) {
2588 case 'S':
2589 intent.mExtras.putString(key, Uri.decode(value));
2590 break;
2591 case 'B':
2592 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2593 break;
2594 case 'b':
2595 intent.mExtras.putByte(key, Byte.parseByte(value));
2596 break;
2597 case 'c':
2598 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2599 break;
2600 case 'd':
2601 intent.mExtras.putDouble(key, Double.parseDouble(value));
2602 break;
2603 case 'f':
2604 intent.mExtras.putFloat(key, Float.parseFloat(value));
2605 break;
2606 case 'i':
2607 intent.mExtras.putInt(key, Integer.parseInt(value));
2608 break;
2609 case 'l':
2610 intent.mExtras.putLong(key, Long.parseLong(value));
2611 break;
2612 case 's':
2613 intent.mExtras.putShort(key, Short.parseShort(value));
2614 break;
2615 default:
2616 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2617 }
2618 } catch (NumberFormatException e) {
2619 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2620 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002621
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002622 char ch = uri.charAt(i);
2623 if (ch == ')') break;
2624 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2625 i++;
2626 }
2627 }
2628
2629 if (intent.mAction == null) {
2630 // By default, if no action is specified, then use VIEW.
2631 intent.mAction = ACTION_VIEW;
2632 }
2633
2634 } else {
2635 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2636 }
2637
2638 return intent;
2639 }
2640
2641 /**
2642 * Retrieve the general action to be performed, such as
2643 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2644 * the information in the intent should be interpreted -- most importantly,
2645 * what to do with the data returned by {@link #getData}.
2646 *
2647 * @return The action of this intent or null if none is specified.
2648 *
2649 * @see #setAction
2650 */
2651 public String getAction() {
2652 return mAction;
2653 }
2654
2655 /**
2656 * Retrieve data this intent is operating on. This URI specifies the name
2657 * of the data; often it uses the content: scheme, specifying data in a
2658 * content provider. Other schemes may be handled by specific activities,
2659 * such as http: by the web browser.
2660 *
2661 * @return The URI of the data this intent is targeting or null.
2662 *
2663 * @see #getScheme
2664 * @see #setData
2665 */
2666 public Uri getData() {
2667 return mData;
2668 }
2669
2670 /**
2671 * The same as {@link #getData()}, but returns the URI as an encoded
2672 * String.
2673 */
2674 public String getDataString() {
2675 return mData != null ? mData.toString() : null;
2676 }
2677
2678 /**
2679 * Return the scheme portion of the intent's data. If the data is null or
2680 * does not include a scheme, null is returned. Otherwise, the scheme
2681 * prefix without the final ':' is returned, i.e. "http".
2682 *
2683 * <p>This is the same as calling getData().getScheme() (and checking for
2684 * null data).
2685 *
2686 * @return The scheme of this intent.
2687 *
2688 * @see #getData
2689 */
2690 public String getScheme() {
2691 return mData != null ? mData.getScheme() : null;
2692 }
2693
2694 /**
2695 * Retrieve any explicit MIME type included in the intent. This is usually
2696 * null, as the type is determined by the intent data.
2697 *
2698 * @return If a type was manually set, it is returned; else null is
2699 * returned.
2700 *
2701 * @see #resolveType(ContentResolver)
2702 * @see #setType
2703 */
2704 public String getType() {
2705 return mType;
2706 }
2707
2708 /**
2709 * Return the MIME data type of this intent. If the type field is
2710 * explicitly set, that is simply returned. Otherwise, if the data is set,
2711 * the type of that data is returned. If neither fields are set, a null is
2712 * returned.
2713 *
2714 * @return The MIME type of this intent.
2715 *
2716 * @see #getType
2717 * @see #resolveType(ContentResolver)
2718 */
2719 public String resolveType(Context context) {
2720 return resolveType(context.getContentResolver());
2721 }
2722
2723 /**
2724 * Return the MIME data type of this intent. If the type field is
2725 * explicitly set, that is simply returned. Otherwise, if the data is set,
2726 * the type of that data is returned. If neither fields are set, a null is
2727 * returned.
2728 *
2729 * @param resolver A ContentResolver that can be used to determine the MIME
2730 * type of the intent's data.
2731 *
2732 * @return The MIME type of this intent.
2733 *
2734 * @see #getType
2735 * @see #resolveType(Context)
2736 */
2737 public String resolveType(ContentResolver resolver) {
2738 if (mType != null) {
2739 return mType;
2740 }
2741 if (mData != null) {
2742 if ("content".equals(mData.getScheme())) {
2743 return resolver.getType(mData);
2744 }
2745 }
2746 return null;
2747 }
2748
2749 /**
2750 * Return the MIME data type of this intent, only if it will be needed for
2751 * intent resolution. This is not generally useful for application code;
2752 * it is used by the frameworks for communicating with back-end system
2753 * services.
2754 *
2755 * @param resolver A ContentResolver that can be used to determine the MIME
2756 * type of the intent's data.
2757 *
2758 * @return The MIME type of this intent, or null if it is unknown or not
2759 * needed.
2760 */
2761 public String resolveTypeIfNeeded(ContentResolver resolver) {
2762 if (mComponent != null) {
2763 return mType;
2764 }
2765 return resolveType(resolver);
2766 }
2767
2768 /**
2769 * Check if an category exists in the intent.
2770 *
2771 * @param category The category to check.
2772 *
2773 * @return boolean True if the intent contains the category, else false.
2774 *
2775 * @see #getCategories
2776 * @see #addCategory
2777 */
2778 public boolean hasCategory(String category) {
2779 return mCategories != null && mCategories.contains(category);
2780 }
2781
2782 /**
2783 * Return the set of all categories in the intent. If there are no categories,
2784 * returns NULL.
2785 *
2786 * @return Set The set of categories you can examine. Do not modify!
2787 *
2788 * @see #hasCategory
2789 * @see #addCategory
2790 */
2791 public Set<String> getCategories() {
2792 return mCategories;
2793 }
2794
2795 /**
2796 * Sets the ClassLoader that will be used when unmarshalling
2797 * any Parcelable values from the extras of this Intent.
2798 *
2799 * @param loader a ClassLoader, or null to use the default loader
2800 * at the time of unmarshalling.
2801 */
2802 public void setExtrasClassLoader(ClassLoader loader) {
2803 if (mExtras != null) {
2804 mExtras.setClassLoader(loader);
2805 }
2806 }
2807
2808 /**
2809 * Returns true if an extra value is associated with the given name.
2810 * @param name the extra's name
2811 * @return true if the given extra is present.
2812 */
2813 public boolean hasExtra(String name) {
2814 return mExtras != null && mExtras.containsKey(name);
2815 }
2816
2817 /**
2818 * Returns true if the Intent's extras contain a parcelled file descriptor.
2819 * @return true if the Intent contains a parcelled file descriptor.
2820 */
2821 public boolean hasFileDescriptors() {
2822 return mExtras != null && mExtras.hasFileDescriptors();
2823 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002824
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002825 /**
2826 * Retrieve extended data from the intent.
2827 *
2828 * @param name The name of the desired item.
2829 *
2830 * @return the value of an item that previously added with putExtra()
2831 * or null if none was found.
2832 *
2833 * @deprecated
2834 * @hide
2835 */
2836 @Deprecated
2837 public Object getExtra(String name) {
2838 return getExtra(name, null);
2839 }
2840
2841 /**
2842 * Retrieve extended data from the intent.
2843 *
2844 * @param name The name of the desired item.
2845 * @param defaultValue the value to be returned if no value of the desired
2846 * type is stored with the given name.
2847 *
2848 * @return the value of an item that previously added with putExtra()
2849 * or the default value if none was found.
2850 *
2851 * @see #putExtra(String, boolean)
2852 */
2853 public boolean getBooleanExtra(String name, boolean defaultValue) {
2854 return mExtras == null ? defaultValue :
2855 mExtras.getBoolean(name, defaultValue);
2856 }
2857
2858 /**
2859 * Retrieve extended data from the intent.
2860 *
2861 * @param name The name of the desired item.
2862 * @param defaultValue the value to be returned if no value of the desired
2863 * type is stored with the given name.
2864 *
2865 * @return the value of an item that previously added with putExtra()
2866 * or the default value if none was found.
2867 *
2868 * @see #putExtra(String, byte)
2869 */
2870 public byte getByteExtra(String name, byte defaultValue) {
2871 return mExtras == null ? defaultValue :
2872 mExtras.getByte(name, defaultValue);
2873 }
2874
2875 /**
2876 * Retrieve extended data from the intent.
2877 *
2878 * @param name The name of the desired item.
2879 * @param defaultValue the value to be returned if no value of the desired
2880 * type is stored with the given name.
2881 *
2882 * @return the value of an item that previously added with putExtra()
2883 * or the default value if none was found.
2884 *
2885 * @see #putExtra(String, short)
2886 */
2887 public short getShortExtra(String name, short defaultValue) {
2888 return mExtras == null ? defaultValue :
2889 mExtras.getShort(name, defaultValue);
2890 }
2891
2892 /**
2893 * Retrieve extended data from the intent.
2894 *
2895 * @param name The name of the desired item.
2896 * @param defaultValue the value to be returned if no value of the desired
2897 * type is stored with the given name.
2898 *
2899 * @return the value of an item that previously added with putExtra()
2900 * or the default value if none was found.
2901 *
2902 * @see #putExtra(String, char)
2903 */
2904 public char getCharExtra(String name, char defaultValue) {
2905 return mExtras == null ? defaultValue :
2906 mExtras.getChar(name, defaultValue);
2907 }
2908
2909 /**
2910 * Retrieve extended data from the intent.
2911 *
2912 * @param name The name of the desired item.
2913 * @param defaultValue the value to be returned if no value of the desired
2914 * type is stored with the given name.
2915 *
2916 * @return the value of an item that previously added with putExtra()
2917 * or the default value if none was found.
2918 *
2919 * @see #putExtra(String, int)
2920 */
2921 public int getIntExtra(String name, int defaultValue) {
2922 return mExtras == null ? defaultValue :
2923 mExtras.getInt(name, defaultValue);
2924 }
2925
2926 /**
2927 * Retrieve extended data from the intent.
2928 *
2929 * @param name The name of the desired item.
2930 * @param defaultValue the value to be returned if no value of the desired
2931 * type is stored with the given name.
2932 *
2933 * @return the value of an item that previously added with putExtra()
2934 * or the default value if none was found.
2935 *
2936 * @see #putExtra(String, long)
2937 */
2938 public long getLongExtra(String name, long defaultValue) {
2939 return mExtras == null ? defaultValue :
2940 mExtras.getLong(name, defaultValue);
2941 }
2942
2943 /**
2944 * Retrieve extended data from the intent.
2945 *
2946 * @param name The name of the desired item.
2947 * @param defaultValue the value to be returned if no value of the desired
2948 * type is stored with the given name.
2949 *
2950 * @return the value of an item that previously added with putExtra(),
2951 * or the default value if no such item is present
2952 *
2953 * @see #putExtra(String, float)
2954 */
2955 public float getFloatExtra(String name, float defaultValue) {
2956 return mExtras == null ? defaultValue :
2957 mExtras.getFloat(name, defaultValue);
2958 }
2959
2960 /**
2961 * Retrieve extended data from the intent.
2962 *
2963 * @param name The name of the desired item.
2964 * @param defaultValue the value to be returned if no value of the desired
2965 * type is stored with the given name.
2966 *
2967 * @return the value of an item that previously added with putExtra()
2968 * or the default value if none was found.
2969 *
2970 * @see #putExtra(String, double)
2971 */
2972 public double getDoubleExtra(String name, double defaultValue) {
2973 return mExtras == null ? defaultValue :
2974 mExtras.getDouble(name, defaultValue);
2975 }
2976
2977 /**
2978 * Retrieve extended data from the intent.
2979 *
2980 * @param name The name of the desired item.
2981 *
2982 * @return the value of an item that previously added with putExtra()
2983 * or null if no String value was found.
2984 *
2985 * @see #putExtra(String, String)
2986 */
2987 public String getStringExtra(String name) {
2988 return mExtras == null ? null : mExtras.getString(name);
2989 }
2990
2991 /**
2992 * Retrieve extended data from the intent.
2993 *
2994 * @param name The name of the desired item.
2995 *
2996 * @return the value of an item that previously added with putExtra()
2997 * or null if no CharSequence value was found.
2998 *
2999 * @see #putExtra(String, CharSequence)
3000 */
3001 public CharSequence getCharSequenceExtra(String name) {
3002 return mExtras == null ? null : mExtras.getCharSequence(name);
3003 }
3004
3005 /**
3006 * Retrieve extended data from the intent.
3007 *
3008 * @param name The name of the desired item.
3009 *
3010 * @return the value of an item that previously added with putExtra()
3011 * or null if no Parcelable value was found.
3012 *
3013 * @see #putExtra(String, Parcelable)
3014 */
3015 public <T extends Parcelable> T getParcelableExtra(String name) {
3016 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3017 }
3018
3019 /**
3020 * Retrieve extended data from the intent.
3021 *
3022 * @param name The name of the desired item.
3023 *
3024 * @return the value of an item that previously added with putExtra()
3025 * or null if no Parcelable[] value was found.
3026 *
3027 * @see #putExtra(String, Parcelable[])
3028 */
3029 public Parcelable[] getParcelableArrayExtra(String name) {
3030 return mExtras == null ? null : mExtras.getParcelableArray(name);
3031 }
3032
3033 /**
3034 * Retrieve extended data from the intent.
3035 *
3036 * @param name The name of the desired item.
3037 *
3038 * @return the value of an item that previously added with putExtra()
3039 * or null if no ArrayList<Parcelable> value was found.
3040 *
3041 * @see #putParcelableArrayListExtra(String, ArrayList)
3042 */
3043 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3044 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3045 }
3046
3047 /**
3048 * Retrieve extended data from the intent.
3049 *
3050 * @param name The name of the desired item.
3051 *
3052 * @return the value of an item that previously added with putExtra()
3053 * or null if no Serializable value was found.
3054 *
3055 * @see #putExtra(String, Serializable)
3056 */
3057 public Serializable getSerializableExtra(String name) {
3058 return mExtras == null ? null : mExtras.getSerializable(name);
3059 }
3060
3061 /**
3062 * Retrieve extended data from the intent.
3063 *
3064 * @param name The name of the desired item.
3065 *
3066 * @return the value of an item that previously added with putExtra()
3067 * or null if no ArrayList<Integer> value was found.
3068 *
3069 * @see #putIntegerArrayListExtra(String, ArrayList)
3070 */
3071 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3072 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3073 }
3074
3075 /**
3076 * Retrieve extended data from the intent.
3077 *
3078 * @param name The name of the desired item.
3079 *
3080 * @return the value of an item that previously added with putExtra()
3081 * or null if no ArrayList<String> value was found.
3082 *
3083 * @see #putStringArrayListExtra(String, ArrayList)
3084 */
3085 public ArrayList<String> getStringArrayListExtra(String name) {
3086 return mExtras == null ? null : mExtras.getStringArrayList(name);
3087 }
3088
3089 /**
3090 * Retrieve extended data from the intent.
3091 *
3092 * @param name The name of the desired item.
3093 *
3094 * @return the value of an item that previously added with putExtra()
3095 * or null if no boolean array value was found.
3096 *
3097 * @see #putExtra(String, boolean[])
3098 */
3099 public boolean[] getBooleanArrayExtra(String name) {
3100 return mExtras == null ? null : mExtras.getBooleanArray(name);
3101 }
3102
3103 /**
3104 * Retrieve extended data from the intent.
3105 *
3106 * @param name The name of the desired item.
3107 *
3108 * @return the value of an item that previously added with putExtra()
3109 * or null if no byte array value was found.
3110 *
3111 * @see #putExtra(String, byte[])
3112 */
3113 public byte[] getByteArrayExtra(String name) {
3114 return mExtras == null ? null : mExtras.getByteArray(name);
3115 }
3116
3117 /**
3118 * Retrieve extended data from the intent.
3119 *
3120 * @param name The name of the desired item.
3121 *
3122 * @return the value of an item that previously added with putExtra()
3123 * or null if no short array value was found.
3124 *
3125 * @see #putExtra(String, short[])
3126 */
3127 public short[] getShortArrayExtra(String name) {
3128 return mExtras == null ? null : mExtras.getShortArray(name);
3129 }
3130
3131 /**
3132 * Retrieve extended data from the intent.
3133 *
3134 * @param name The name of the desired item.
3135 *
3136 * @return the value of an item that previously added with putExtra()
3137 * or null if no char array value was found.
3138 *
3139 * @see #putExtra(String, char[])
3140 */
3141 public char[] getCharArrayExtra(String name) {
3142 return mExtras == null ? null : mExtras.getCharArray(name);
3143 }
3144
3145 /**
3146 * Retrieve extended data from the intent.
3147 *
3148 * @param name The name of the desired item.
3149 *
3150 * @return the value of an item that previously added with putExtra()
3151 * or null if no int array value was found.
3152 *
3153 * @see #putExtra(String, int[])
3154 */
3155 public int[] getIntArrayExtra(String name) {
3156 return mExtras == null ? null : mExtras.getIntArray(name);
3157 }
3158
3159 /**
3160 * Retrieve extended data from the intent.
3161 *
3162 * @param name The name of the desired item.
3163 *
3164 * @return the value of an item that previously added with putExtra()
3165 * or null if no long array value was found.
3166 *
3167 * @see #putExtra(String, long[])
3168 */
3169 public long[] getLongArrayExtra(String name) {
3170 return mExtras == null ? null : mExtras.getLongArray(name);
3171 }
3172
3173 /**
3174 * Retrieve extended data from the intent.
3175 *
3176 * @param name The name of the desired item.
3177 *
3178 * @return the value of an item that previously added with putExtra()
3179 * or null if no float array value was found.
3180 *
3181 * @see #putExtra(String, float[])
3182 */
3183 public float[] getFloatArrayExtra(String name) {
3184 return mExtras == null ? null : mExtras.getFloatArray(name);
3185 }
3186
3187 /**
3188 * Retrieve extended data from the intent.
3189 *
3190 * @param name The name of the desired item.
3191 *
3192 * @return the value of an item that previously added with putExtra()
3193 * or null if no double array value was found.
3194 *
3195 * @see #putExtra(String, double[])
3196 */
3197 public double[] getDoubleArrayExtra(String name) {
3198 return mExtras == null ? null : mExtras.getDoubleArray(name);
3199 }
3200
3201 /**
3202 * Retrieve extended data from the intent.
3203 *
3204 * @param name The name of the desired item.
3205 *
3206 * @return the value of an item that previously added with putExtra()
3207 * or null if no String array value was found.
3208 *
3209 * @see #putExtra(String, String[])
3210 */
3211 public String[] getStringArrayExtra(String name) {
3212 return mExtras == null ? null : mExtras.getStringArray(name);
3213 }
3214
3215 /**
3216 * Retrieve extended data from the intent.
3217 *
3218 * @param name The name of the desired item.
3219 *
3220 * @return the value of an item that previously added with putExtra()
3221 * or null if no Bundle value was found.
3222 *
3223 * @see #putExtra(String, Bundle)
3224 */
3225 public Bundle getBundleExtra(String name) {
3226 return mExtras == null ? null : mExtras.getBundle(name);
3227 }
3228
3229 /**
3230 * Retrieve extended data from the intent.
3231 *
3232 * @param name The name of the desired item.
3233 *
3234 * @return the value of an item that previously added with putExtra()
3235 * or null if no IBinder value was found.
3236 *
3237 * @see #putExtra(String, IBinder)
3238 *
3239 * @deprecated
3240 * @hide
3241 */
3242 @Deprecated
3243 public IBinder getIBinderExtra(String name) {
3244 return mExtras == null ? null : mExtras.getIBinder(name);
3245 }
3246
3247 /**
3248 * Retrieve extended data from the intent.
3249 *
3250 * @param name The name of the desired item.
3251 * @param defaultValue The default value to return in case no item is
3252 * associated with the key 'name'
3253 *
3254 * @return the value of an item that previously added with putExtra()
3255 * or defaultValue if none was found.
3256 *
3257 * @see #putExtra
3258 *
3259 * @deprecated
3260 * @hide
3261 */
3262 @Deprecated
3263 public Object getExtra(String name, Object defaultValue) {
3264 Object result = defaultValue;
3265 if (mExtras != null) {
3266 Object result2 = mExtras.get(name);
3267 if (result2 != null) {
3268 result = result2;
3269 }
3270 }
3271
3272 return result;
3273 }
3274
3275 /**
3276 * Retrieves a map of extended data from the intent.
3277 *
3278 * @return the map of all extras previously added with putExtra(),
3279 * or null if none have been added.
3280 */
3281 public Bundle getExtras() {
3282 return (mExtras != null)
3283 ? new Bundle(mExtras)
3284 : null;
3285 }
3286
3287 /**
3288 * Retrieve any special flags associated with this intent. You will
3289 * normally just set them with {@link #setFlags} and let the system
3290 * take the appropriate action with them.
3291 *
3292 * @return int The currently set flags.
3293 *
3294 * @see #setFlags
3295 */
3296 public int getFlags() {
3297 return mFlags;
3298 }
3299
3300 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003301 * Retrieve the application package name this Intent is limited to. When
3302 * resolving an Intent, if non-null this limits the resolution to only
3303 * components in the given application package.
3304 *
3305 * @return The name of the application package for the Intent.
3306 *
3307 * @see #resolveActivity
3308 * @see #setPackage
3309 */
3310 public String getPackage() {
3311 return mPackage;
3312 }
3313
3314 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003315 * Retrieve the concrete component associated with the intent. When receiving
3316 * an intent, this is the component that was found to best handle it (that is,
3317 * yourself) and will always be non-null; in all other cases it will be
3318 * null unless explicitly set.
3319 *
3320 * @return The name of the application component to handle the intent.
3321 *
3322 * @see #resolveActivity
3323 * @see #setComponent
3324 */
3325 public ComponentName getComponent() {
3326 return mComponent;
3327 }
3328
3329 /**
3330 * Return the Activity component that should be used to handle this intent.
3331 * The appropriate component is determined based on the information in the
3332 * intent, evaluated as follows:
3333 *
3334 * <p>If {@link #getComponent} returns an explicit class, that is returned
3335 * without any further consideration.
3336 *
3337 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3338 * category to be considered.
3339 *
3340 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3341 * action.
3342 *
3343 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3344 * this type.
3345 *
3346 * <p>If {@link #addCategory} has added any categories, the activity must
3347 * handle ALL of the categories specified.
3348 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003349 * <p>If {@link #getPackage} is non-NULL, only activity components in
3350 * that application package will be considered.
3351 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003352 * <p>If there are no activities that satisfy all of these conditions, a
3353 * null string is returned.
3354 *
3355 * <p>If multiple activities are found to satisfy the intent, the one with
3356 * the highest priority will be used. If there are multiple activities
3357 * with the same priority, the system will either pick the best activity
3358 * based on user preference, or resolve to a system class that will allow
3359 * the user to pick an activity and forward from there.
3360 *
3361 * <p>This method is implemented simply by calling
3362 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3363 * true.</p>
3364 * <p> This API is called for you as part of starting an activity from an
3365 * intent. You do not normally need to call it yourself.</p>
3366 *
3367 * @param pm The package manager with which to resolve the Intent.
3368 *
3369 * @return Name of the component implementing an activity that can
3370 * display the intent.
3371 *
3372 * @see #setComponent
3373 * @see #getComponent
3374 * @see #resolveActivityInfo
3375 */
3376 public ComponentName resolveActivity(PackageManager pm) {
3377 if (mComponent != null) {
3378 return mComponent;
3379 }
3380
3381 ResolveInfo info = pm.resolveActivity(
3382 this, PackageManager.MATCH_DEFAULT_ONLY);
3383 if (info != null) {
3384 return new ComponentName(
3385 info.activityInfo.applicationInfo.packageName,
3386 info.activityInfo.name);
3387 }
3388
3389 return null;
3390 }
3391
3392 /**
3393 * Resolve the Intent into an {@link ActivityInfo}
3394 * describing the activity that should execute the intent. Resolution
3395 * follows the same rules as described for {@link #resolveActivity}, but
3396 * you get back the completely information about the resolved activity
3397 * instead of just its class name.
3398 *
3399 * @param pm The package manager with which to resolve the Intent.
3400 * @param flags Addition information to retrieve as per
3401 * {@link PackageManager#getActivityInfo(ComponentName, int)
3402 * PackageManager.getActivityInfo()}.
3403 *
3404 * @return PackageManager.ActivityInfo
3405 *
3406 * @see #resolveActivity
3407 */
3408 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3409 ActivityInfo ai = null;
3410 if (mComponent != null) {
3411 try {
3412 ai = pm.getActivityInfo(mComponent, flags);
3413 } catch (PackageManager.NameNotFoundException e) {
3414 // ignore
3415 }
3416 } else {
3417 ResolveInfo info = pm.resolveActivity(
3418 this, PackageManager.MATCH_DEFAULT_ONLY);
3419 if (info != null) {
3420 ai = info.activityInfo;
3421 }
3422 }
3423
3424 return ai;
3425 }
3426
3427 /**
3428 * Set the general action to be performed.
3429 *
3430 * @param action An action name, such as ACTION_VIEW. Application-specific
3431 * actions should be prefixed with the vendor's package name.
3432 *
3433 * @return Returns the same Intent object, for chaining multiple calls
3434 * into a single statement.
3435 *
3436 * @see #getAction
3437 */
3438 public Intent setAction(String action) {
3439 mAction = action;
3440 return this;
3441 }
3442
3443 /**
3444 * Set the data this intent is operating on. This method automatically
3445 * clears any type that was previously set by {@link #setType}.
3446 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07003447 * <p><em>Note: scheme and host name matching in the Android framework is
3448 * case-sensitive, unlike the formal RFC. As a result,
3449 * you should always ensure that you write your Uri with these elements
3450 * using lower case letters, and normalize any Uris you receive from
3451 * outside of Android to ensure the scheme and host is lower case.</em></p>
3452 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003453 * @param data The URI of the data this intent is now targeting.
3454 *
3455 * @return Returns the same Intent object, for chaining multiple calls
3456 * into a single statement.
3457 *
3458 * @see #getData
3459 * @see #setType
3460 * @see #setDataAndType
3461 */
3462 public Intent setData(Uri data) {
3463 mData = data;
3464 mType = null;
3465 return this;
3466 }
3467
3468 /**
3469 * Set an explicit MIME data type. This is used to create intents that
3470 * only specify a type and not data, for example to indicate the type of
3471 * data to return. This method automatically clears any data that was
3472 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003473 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07003474 * <p><em>Note: MIME type matching in the Android framework is
3475 * case-sensitive, unlike formal RFC MIME types. As a result,
3476 * you should always write your MIME types with lower case letters,
3477 * and any MIME types you receive from outside of Android should be
3478 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003479 *
3480 * @param type The MIME type of the data being handled by this intent.
3481 *
3482 * @return Returns the same Intent object, for chaining multiple calls
3483 * into a single statement.
3484 *
3485 * @see #getType
3486 * @see #setData
3487 * @see #setDataAndType
3488 */
3489 public Intent setType(String type) {
3490 mData = null;
3491 mType = type;
3492 return this;
3493 }
3494
3495 /**
3496 * (Usually optional) Set the data for the intent along with an explicit
3497 * MIME data type. This method should very rarely be used -- it allows you
3498 * to override the MIME type that would ordinarily be inferred from the
3499 * data with your own type given here.
3500 *
Dianne Hackborn06f36b42009-04-13 08:52:45 -07003501 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3502 * Android framework is case-sensitive, unlike the formal RFC definitions.
3503 * As a result, you should always write these elements with lower case letters,
3504 * and normalize any MIME types or Uris you receive from
3505 * outside of Android to ensure these elements are lower case before
3506 * supplying them here.</em></p>
3507 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003508 * @param data The URI of the data this intent is now targeting.
3509 * @param type The MIME type of the data being handled by this intent.
3510 *
3511 * @return Returns the same Intent object, for chaining multiple calls
3512 * into a single statement.
3513 *
3514 * @see #setData
3515 * @see #setType
3516 */
3517 public Intent setDataAndType(Uri data, String type) {
3518 mData = data;
3519 mType = type;
3520 return this;
3521 }
3522
3523 /**
3524 * Add a new category to the intent. Categories provide additional detail
3525 * about the action the intent is perform. When resolving an intent, only
3526 * activities that provide <em>all</em> of the requested categories will be
3527 * used.
3528 *
3529 * @param category The desired category. This can be either one of the
3530 * predefined Intent categories, or a custom category in your own
3531 * namespace.
3532 *
3533 * @return Returns the same Intent object, for chaining multiple calls
3534 * into a single statement.
3535 *
3536 * @see #hasCategory
3537 * @see #removeCategory
3538 */
3539 public Intent addCategory(String category) {
3540 if (mCategories == null) {
3541 mCategories = new HashSet<String>();
3542 }
3543 mCategories.add(category);
3544 return this;
3545 }
3546
3547 /**
3548 * Remove an category from an intent.
3549 *
3550 * @param category The category to remove.
3551 *
3552 * @see #addCategory
3553 */
3554 public void removeCategory(String category) {
3555 if (mCategories != null) {
3556 mCategories.remove(category);
3557 if (mCategories.size() == 0) {
3558 mCategories = null;
3559 }
3560 }
3561 }
3562
3563 /**
3564 * Add extended data to the intent. The name must include a package
3565 * prefix, for example the app com.android.contacts would use names
3566 * like "com.android.contacts.ShowAll".
3567 *
3568 * @param name The name of the extra data, with package prefix.
3569 * @param value The boolean data value.
3570 *
3571 * @return Returns the same Intent object, for chaining multiple calls
3572 * into a single statement.
3573 *
3574 * @see #putExtras
3575 * @see #removeExtra
3576 * @see #getBooleanExtra(String, boolean)
3577 */
3578 public Intent putExtra(String name, boolean value) {
3579 if (mExtras == null) {
3580 mExtras = new Bundle();
3581 }
3582 mExtras.putBoolean(name, value);
3583 return this;
3584 }
3585
3586 /**
3587 * Add extended data to the intent. The name must include a package
3588 * prefix, for example the app com.android.contacts would use names
3589 * like "com.android.contacts.ShowAll".
3590 *
3591 * @param name The name of the extra data, with package prefix.
3592 * @param value The byte data value.
3593 *
3594 * @return Returns the same Intent object, for chaining multiple calls
3595 * into a single statement.
3596 *
3597 * @see #putExtras
3598 * @see #removeExtra
3599 * @see #getByteExtra(String, byte)
3600 */
3601 public Intent putExtra(String name, byte value) {
3602 if (mExtras == null) {
3603 mExtras = new Bundle();
3604 }
3605 mExtras.putByte(name, value);
3606 return this;
3607 }
3608
3609 /**
3610 * Add extended data to the intent. The name must include a package
3611 * prefix, for example the app com.android.contacts would use names
3612 * like "com.android.contacts.ShowAll".
3613 *
3614 * @param name The name of the extra data, with package prefix.
3615 * @param value The char data value.
3616 *
3617 * @return Returns the same Intent object, for chaining multiple calls
3618 * into a single statement.
3619 *
3620 * @see #putExtras
3621 * @see #removeExtra
3622 * @see #getCharExtra(String, char)
3623 */
3624 public Intent putExtra(String name, char value) {
3625 if (mExtras == null) {
3626 mExtras = new Bundle();
3627 }
3628 mExtras.putChar(name, value);
3629 return this;
3630 }
3631
3632 /**
3633 * Add extended data to the intent. The name must include a package
3634 * prefix, for example the app com.android.contacts would use names
3635 * like "com.android.contacts.ShowAll".
3636 *
3637 * @param name The name of the extra data, with package prefix.
3638 * @param value The short data value.
3639 *
3640 * @return Returns the same Intent object, for chaining multiple calls
3641 * into a single statement.
3642 *
3643 * @see #putExtras
3644 * @see #removeExtra
3645 * @see #getShortExtra(String, short)
3646 */
3647 public Intent putExtra(String name, short value) {
3648 if (mExtras == null) {
3649 mExtras = new Bundle();
3650 }
3651 mExtras.putShort(name, value);
3652 return this;
3653 }
3654
3655 /**
3656 * Add extended data to the intent. The name must include a package
3657 * prefix, for example the app com.android.contacts would use names
3658 * like "com.android.contacts.ShowAll".
3659 *
3660 * @param name The name of the extra data, with package prefix.
3661 * @param value The integer data value.
3662 *
3663 * @return Returns the same Intent object, for chaining multiple calls
3664 * into a single statement.
3665 *
3666 * @see #putExtras
3667 * @see #removeExtra
3668 * @see #getIntExtra(String, int)
3669 */
3670 public Intent putExtra(String name, int value) {
3671 if (mExtras == null) {
3672 mExtras = new Bundle();
3673 }
3674 mExtras.putInt(name, value);
3675 return this;
3676 }
3677
3678 /**
3679 * Add extended data to the intent. The name must include a package
3680 * prefix, for example the app com.android.contacts would use names
3681 * like "com.android.contacts.ShowAll".
3682 *
3683 * @param name The name of the extra data, with package prefix.
3684 * @param value The long data value.
3685 *
3686 * @return Returns the same Intent object, for chaining multiple calls
3687 * into a single statement.
3688 *
3689 * @see #putExtras
3690 * @see #removeExtra
3691 * @see #getLongExtra(String, long)
3692 */
3693 public Intent putExtra(String name, long value) {
3694 if (mExtras == null) {
3695 mExtras = new Bundle();
3696 }
3697 mExtras.putLong(name, value);
3698 return this;
3699 }
3700
3701 /**
3702 * Add extended data to the intent. The name must include a package
3703 * prefix, for example the app com.android.contacts would use names
3704 * like "com.android.contacts.ShowAll".
3705 *
3706 * @param name The name of the extra data, with package prefix.
3707 * @param value The float data value.
3708 *
3709 * @return Returns the same Intent object, for chaining multiple calls
3710 * into a single statement.
3711 *
3712 * @see #putExtras
3713 * @see #removeExtra
3714 * @see #getFloatExtra(String, float)
3715 */
3716 public Intent putExtra(String name, float value) {
3717 if (mExtras == null) {
3718 mExtras = new Bundle();
3719 }
3720 mExtras.putFloat(name, value);
3721 return this;
3722 }
3723
3724 /**
3725 * Add extended data to the intent. The name must include a package
3726 * prefix, for example the app com.android.contacts would use names
3727 * like "com.android.contacts.ShowAll".
3728 *
3729 * @param name The name of the extra data, with package prefix.
3730 * @param value The double data value.
3731 *
3732 * @return Returns the same Intent object, for chaining multiple calls
3733 * into a single statement.
3734 *
3735 * @see #putExtras
3736 * @see #removeExtra
3737 * @see #getDoubleExtra(String, double)
3738 */
3739 public Intent putExtra(String name, double value) {
3740 if (mExtras == null) {
3741 mExtras = new Bundle();
3742 }
3743 mExtras.putDouble(name, value);
3744 return this;
3745 }
3746
3747 /**
3748 * Add extended data to the intent. The name must include a package
3749 * prefix, for example the app com.android.contacts would use names
3750 * like "com.android.contacts.ShowAll".
3751 *
3752 * @param name The name of the extra data, with package prefix.
3753 * @param value The String data value.
3754 *
3755 * @return Returns the same Intent object, for chaining multiple calls
3756 * into a single statement.
3757 *
3758 * @see #putExtras
3759 * @see #removeExtra
3760 * @see #getStringExtra(String)
3761 */
3762 public Intent putExtra(String name, String value) {
3763 if (mExtras == null) {
3764 mExtras = new Bundle();
3765 }
3766 mExtras.putString(name, value);
3767 return this;
3768 }
3769
3770 /**
3771 * Add extended data to the intent. The name must include a package
3772 * prefix, for example the app com.android.contacts would use names
3773 * like "com.android.contacts.ShowAll".
3774 *
3775 * @param name The name of the extra data, with package prefix.
3776 * @param value The CharSequence data value.
3777 *
3778 * @return Returns the same Intent object, for chaining multiple calls
3779 * into a single statement.
3780 *
3781 * @see #putExtras
3782 * @see #removeExtra
3783 * @see #getCharSequenceExtra(String)
3784 */
3785 public Intent putExtra(String name, CharSequence value) {
3786 if (mExtras == null) {
3787 mExtras = new Bundle();
3788 }
3789 mExtras.putCharSequence(name, value);
3790 return this;
3791 }
3792
3793 /**
3794 * Add extended data to the intent. The name must include a package
3795 * prefix, for example the app com.android.contacts would use names
3796 * like "com.android.contacts.ShowAll".
3797 *
3798 * @param name The name of the extra data, with package prefix.
3799 * @param value The Parcelable data value.
3800 *
3801 * @return Returns the same Intent object, for chaining multiple calls
3802 * into a single statement.
3803 *
3804 * @see #putExtras
3805 * @see #removeExtra
3806 * @see #getParcelableExtra(String)
3807 */
3808 public Intent putExtra(String name, Parcelable value) {
3809 if (mExtras == null) {
3810 mExtras = new Bundle();
3811 }
3812 mExtras.putParcelable(name, value);
3813 return this;
3814 }
3815
3816 /**
3817 * Add extended data to the intent. The name must include a package
3818 * prefix, for example the app com.android.contacts would use names
3819 * like "com.android.contacts.ShowAll".
3820 *
3821 * @param name The name of the extra data, with package prefix.
3822 * @param value The Parcelable[] data value.
3823 *
3824 * @return Returns the same Intent object, for chaining multiple calls
3825 * into a single statement.
3826 *
3827 * @see #putExtras
3828 * @see #removeExtra
3829 * @see #getParcelableArrayExtra(String)
3830 */
3831 public Intent putExtra(String name, Parcelable[] value) {
3832 if (mExtras == null) {
3833 mExtras = new Bundle();
3834 }
3835 mExtras.putParcelableArray(name, value);
3836 return this;
3837 }
3838
3839 /**
3840 * Add extended data to the intent. The name must include a package
3841 * prefix, for example the app com.android.contacts would use names
3842 * like "com.android.contacts.ShowAll".
3843 *
3844 * @param name The name of the extra data, with package prefix.
3845 * @param value The ArrayList<Parcelable> data value.
3846 *
3847 * @return Returns the same Intent object, for chaining multiple calls
3848 * into a single statement.
3849 *
3850 * @see #putExtras
3851 * @see #removeExtra
3852 * @see #getParcelableArrayListExtra(String)
3853 */
3854 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3855 if (mExtras == null) {
3856 mExtras = new Bundle();
3857 }
3858 mExtras.putParcelableArrayList(name, value);
3859 return this;
3860 }
3861
3862 /**
3863 * Add extended data to the intent. The name must include a package
3864 * prefix, for example the app com.android.contacts would use names
3865 * like "com.android.contacts.ShowAll".
3866 *
3867 * @param name The name of the extra data, with package prefix.
3868 * @param value The ArrayList<Integer> data value.
3869 *
3870 * @return Returns the same Intent object, for chaining multiple calls
3871 * into a single statement.
3872 *
3873 * @see #putExtras
3874 * @see #removeExtra
3875 * @see #getIntegerArrayListExtra(String)
3876 */
3877 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
3878 if (mExtras == null) {
3879 mExtras = new Bundle();
3880 }
3881 mExtras.putIntegerArrayList(name, value);
3882 return this;
3883 }
3884
3885 /**
3886 * Add extended data to the intent. The name must include a package
3887 * prefix, for example the app com.android.contacts would use names
3888 * like "com.android.contacts.ShowAll".
3889 *
3890 * @param name The name of the extra data, with package prefix.
3891 * @param value The ArrayList<String> data value.
3892 *
3893 * @return Returns the same Intent object, for chaining multiple calls
3894 * into a single statement.
3895 *
3896 * @see #putExtras
3897 * @see #removeExtra
3898 * @see #getStringArrayListExtra(String)
3899 */
3900 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
3901 if (mExtras == null) {
3902 mExtras = new Bundle();
3903 }
3904 mExtras.putStringArrayList(name, value);
3905 return this;
3906 }
3907
3908 /**
3909 * Add extended data to the intent. The name must include a package
3910 * prefix, for example the app com.android.contacts would use names
3911 * like "com.android.contacts.ShowAll".
3912 *
3913 * @param name The name of the extra data, with package prefix.
3914 * @param value The Serializable data value.
3915 *
3916 * @return Returns the same Intent object, for chaining multiple calls
3917 * into a single statement.
3918 *
3919 * @see #putExtras
3920 * @see #removeExtra
3921 * @see #getSerializableExtra(String)
3922 */
3923 public Intent putExtra(String name, Serializable value) {
3924 if (mExtras == null) {
3925 mExtras = new Bundle();
3926 }
3927 mExtras.putSerializable(name, value);
3928 return this;
3929 }
3930
3931 /**
3932 * Add extended data to the intent. The name must include a package
3933 * prefix, for example the app com.android.contacts would use names
3934 * like "com.android.contacts.ShowAll".
3935 *
3936 * @param name The name of the extra data, with package prefix.
3937 * @param value The boolean array data value.
3938 *
3939 * @return Returns the same Intent object, for chaining multiple calls
3940 * into a single statement.
3941 *
3942 * @see #putExtras
3943 * @see #removeExtra
3944 * @see #getBooleanArrayExtra(String)
3945 */
3946 public Intent putExtra(String name, boolean[] value) {
3947 if (mExtras == null) {
3948 mExtras = new Bundle();
3949 }
3950 mExtras.putBooleanArray(name, value);
3951 return this;
3952 }
3953
3954 /**
3955 * Add extended data to the intent. The name must include a package
3956 * prefix, for example the app com.android.contacts would use names
3957 * like "com.android.contacts.ShowAll".
3958 *
3959 * @param name The name of the extra data, with package prefix.
3960 * @param value The byte array data value.
3961 *
3962 * @return Returns the same Intent object, for chaining multiple calls
3963 * into a single statement.
3964 *
3965 * @see #putExtras
3966 * @see #removeExtra
3967 * @see #getByteArrayExtra(String)
3968 */
3969 public Intent putExtra(String name, byte[] value) {
3970 if (mExtras == null) {
3971 mExtras = new Bundle();
3972 }
3973 mExtras.putByteArray(name, value);
3974 return this;
3975 }
3976
3977 /**
3978 * Add extended data to the intent. The name must include a package
3979 * prefix, for example the app com.android.contacts would use names
3980 * like "com.android.contacts.ShowAll".
3981 *
3982 * @param name The name of the extra data, with package prefix.
3983 * @param value The short array data value.
3984 *
3985 * @return Returns the same Intent object, for chaining multiple calls
3986 * into a single statement.
3987 *
3988 * @see #putExtras
3989 * @see #removeExtra
3990 * @see #getShortArrayExtra(String)
3991 */
3992 public Intent putExtra(String name, short[] value) {
3993 if (mExtras == null) {
3994 mExtras = new Bundle();
3995 }
3996 mExtras.putShortArray(name, value);
3997 return this;
3998 }
3999
4000 /**
4001 * Add extended data to the intent. The name must include a package
4002 * prefix, for example the app com.android.contacts would use names
4003 * like "com.android.contacts.ShowAll".
4004 *
4005 * @param name The name of the extra data, with package prefix.
4006 * @param value The char array data value.
4007 *
4008 * @return Returns the same Intent object, for chaining multiple calls
4009 * into a single statement.
4010 *
4011 * @see #putExtras
4012 * @see #removeExtra
4013 * @see #getCharArrayExtra(String)
4014 */
4015 public Intent putExtra(String name, char[] value) {
4016 if (mExtras == null) {
4017 mExtras = new Bundle();
4018 }
4019 mExtras.putCharArray(name, value);
4020 return this;
4021 }
4022
4023 /**
4024 * Add extended data to the intent. The name must include a package
4025 * prefix, for example the app com.android.contacts would use names
4026 * like "com.android.contacts.ShowAll".
4027 *
4028 * @param name The name of the extra data, with package prefix.
4029 * @param value The int array data value.
4030 *
4031 * @return Returns the same Intent object, for chaining multiple calls
4032 * into a single statement.
4033 *
4034 * @see #putExtras
4035 * @see #removeExtra
4036 * @see #getIntArrayExtra(String)
4037 */
4038 public Intent putExtra(String name, int[] value) {
4039 if (mExtras == null) {
4040 mExtras = new Bundle();
4041 }
4042 mExtras.putIntArray(name, value);
4043 return this;
4044 }
4045
4046 /**
4047 * Add extended data to the intent. The name must include a package
4048 * prefix, for example the app com.android.contacts would use names
4049 * like "com.android.contacts.ShowAll".
4050 *
4051 * @param name The name of the extra data, with package prefix.
4052 * @param value The byte array data value.
4053 *
4054 * @return Returns the same Intent object, for chaining multiple calls
4055 * into a single statement.
4056 *
4057 * @see #putExtras
4058 * @see #removeExtra
4059 * @see #getLongArrayExtra(String)
4060 */
4061 public Intent putExtra(String name, long[] value) {
4062 if (mExtras == null) {
4063 mExtras = new Bundle();
4064 }
4065 mExtras.putLongArray(name, value);
4066 return this;
4067 }
4068
4069 /**
4070 * Add extended data to the intent. The name must include a package
4071 * prefix, for example the app com.android.contacts would use names
4072 * like "com.android.contacts.ShowAll".
4073 *
4074 * @param name The name of the extra data, with package prefix.
4075 * @param value The float array data value.
4076 *
4077 * @return Returns the same Intent object, for chaining multiple calls
4078 * into a single statement.
4079 *
4080 * @see #putExtras
4081 * @see #removeExtra
4082 * @see #getFloatArrayExtra(String)
4083 */
4084 public Intent putExtra(String name, float[] value) {
4085 if (mExtras == null) {
4086 mExtras = new Bundle();
4087 }
4088 mExtras.putFloatArray(name, value);
4089 return this;
4090 }
4091
4092 /**
4093 * Add extended data to the intent. The name must include a package
4094 * prefix, for example the app com.android.contacts would use names
4095 * like "com.android.contacts.ShowAll".
4096 *
4097 * @param name The name of the extra data, with package prefix.
4098 * @param value The double array data value.
4099 *
4100 * @return Returns the same Intent object, for chaining multiple calls
4101 * into a single statement.
4102 *
4103 * @see #putExtras
4104 * @see #removeExtra
4105 * @see #getDoubleArrayExtra(String)
4106 */
4107 public Intent putExtra(String name, double[] value) {
4108 if (mExtras == null) {
4109 mExtras = new Bundle();
4110 }
4111 mExtras.putDoubleArray(name, value);
4112 return this;
4113 }
4114
4115 /**
4116 * Add extended data to the intent. The name must include a package
4117 * prefix, for example the app com.android.contacts would use names
4118 * like "com.android.contacts.ShowAll".
4119 *
4120 * @param name The name of the extra data, with package prefix.
4121 * @param value The String array data value.
4122 *
4123 * @return Returns the same Intent object, for chaining multiple calls
4124 * into a single statement.
4125 *
4126 * @see #putExtras
4127 * @see #removeExtra
4128 * @see #getStringArrayExtra(String)
4129 */
4130 public Intent putExtra(String name, String[] value) {
4131 if (mExtras == null) {
4132 mExtras = new Bundle();
4133 }
4134 mExtras.putStringArray(name, value);
4135 return this;
4136 }
4137
4138 /**
4139 * Add extended data to the intent. The name must include a package
4140 * prefix, for example the app com.android.contacts would use names
4141 * like "com.android.contacts.ShowAll".
4142 *
4143 * @param name The name of the extra data, with package prefix.
4144 * @param value The Bundle data value.
4145 *
4146 * @return Returns the same Intent object, for chaining multiple calls
4147 * into a single statement.
4148 *
4149 * @see #putExtras
4150 * @see #removeExtra
4151 * @see #getBundleExtra(String)
4152 */
4153 public Intent putExtra(String name, Bundle value) {
4154 if (mExtras == null) {
4155 mExtras = new Bundle();
4156 }
4157 mExtras.putBundle(name, value);
4158 return this;
4159 }
4160
4161 /**
4162 * Add extended data to the intent. The name must include a package
4163 * prefix, for example the app com.android.contacts would use names
4164 * like "com.android.contacts.ShowAll".
4165 *
4166 * @param name The name of the extra data, with package prefix.
4167 * @param value The IBinder data value.
4168 *
4169 * @return Returns the same Intent object, for chaining multiple calls
4170 * into a single statement.
4171 *
4172 * @see #putExtras
4173 * @see #removeExtra
4174 * @see #getIBinderExtra(String)
4175 *
4176 * @deprecated
4177 * @hide
4178 */
4179 @Deprecated
4180 public Intent putExtra(String name, IBinder value) {
4181 if (mExtras == null) {
4182 mExtras = new Bundle();
4183 }
4184 mExtras.putIBinder(name, value);
4185 return this;
4186 }
4187
4188 /**
4189 * Copy all extras in 'src' in to this intent.
4190 *
4191 * @param src Contains the extras to copy.
4192 *
4193 * @see #putExtra
4194 */
4195 public Intent putExtras(Intent src) {
4196 if (src.mExtras != null) {
4197 if (mExtras == null) {
4198 mExtras = new Bundle(src.mExtras);
4199 } else {
4200 mExtras.putAll(src.mExtras);
4201 }
4202 }
4203 return this;
4204 }
4205
4206 /**
4207 * Add a set of extended data to the intent. The keys must include a package
4208 * prefix, for example the app com.android.contacts would use names
4209 * like "com.android.contacts.ShowAll".
4210 *
4211 * @param extras The Bundle of extras to add to this intent.
4212 *
4213 * @see #putExtra
4214 * @see #removeExtra
4215 */
4216 public Intent putExtras(Bundle extras) {
4217 if (mExtras == null) {
4218 mExtras = new Bundle();
4219 }
4220 mExtras.putAll(extras);
4221 return this;
4222 }
4223
4224 /**
4225 * Completely replace the extras in the Intent with the extras in the
4226 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004227 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004228 * @param src The exact extras contained in this Intent are copied
4229 * into the target intent, replacing any that were previously there.
4230 */
4231 public Intent replaceExtras(Intent src) {
4232 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4233 return this;
4234 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004235
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004236 /**
4237 * Completely replace the extras in the Intent with the given Bundle of
4238 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004239 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004240 * @param extras The new set of extras in the Intent, or null to erase
4241 * all extras.
4242 */
4243 public Intent replaceExtras(Bundle extras) {
4244 mExtras = extras != null ? new Bundle(extras) : null;
4245 return this;
4246 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004247
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004248 /**
4249 * Remove extended data from the intent.
4250 *
4251 * @see #putExtra
4252 */
4253 public void removeExtra(String name) {
4254 if (mExtras != null) {
4255 mExtras.remove(name);
4256 if (mExtras.size() == 0) {
4257 mExtras = null;
4258 }
4259 }
4260 }
4261
4262 /**
4263 * Set special flags controlling how this intent is handled. Most values
4264 * here depend on the type of component being executed by the Intent,
4265 * specifically the FLAG_ACTIVITY_* flags are all for use with
4266 * {@link Context#startActivity Context.startActivity()} and the
4267 * FLAG_RECEIVER_* flags are all for use with
4268 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4269 *
4270 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4271 * Activities and Tasks</a> documentation for important information on how some of these options impact
4272 * the behavior of your application.
4273 *
4274 * @param flags The desired flags.
4275 *
4276 * @return Returns the same Intent object, for chaining multiple calls
4277 * into a single statement.
4278 *
4279 * @see #getFlags
4280 * @see #addFlags
4281 *
4282 * @see #FLAG_GRANT_READ_URI_PERMISSION
4283 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4284 * @see #FLAG_DEBUG_LOG_RESOLUTION
4285 * @see #FLAG_FROM_BACKGROUND
4286 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
4287 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
4288 * @see #FLAG_ACTIVITY_CLEAR_TOP
4289 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4290 * @see #FLAG_ACTIVITY_FORWARD_RESULT
4291 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
4292 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4293 * @see #FLAG_ACTIVITY_NEW_TASK
4294 * @see #FLAG_ACTIVITY_NO_HISTORY
4295 * @see #FLAG_ACTIVITY_NO_USER_ACTION
4296 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4297 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
4298 * @see #FLAG_ACTIVITY_SINGLE_TOP
4299 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4300 */
4301 public Intent setFlags(int flags) {
4302 mFlags = flags;
4303 return this;
4304 }
4305
4306 /**
4307 * Add additional flags to the intent (or with existing flags
4308 * value).
4309 *
4310 * @param flags The new flags to set.
4311 *
4312 * @return Returns the same Intent object, for chaining multiple calls
4313 * into a single statement.
4314 *
4315 * @see #setFlags
4316 */
4317 public Intent addFlags(int flags) {
4318 mFlags |= flags;
4319 return this;
4320 }
4321
4322 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004323 * (Usually optional) Set an explicit application package name that limits
4324 * the components this Intent will resolve to. If left to the default
4325 * value of null, all components in all applications will considered.
4326 * If non-null, the Intent can only match the components in the given
4327 * application package.
4328 *
4329 * @param packageName The name of the application package to handle the
4330 * intent, or null to allow any application package.
4331 *
4332 * @return Returns the same Intent object, for chaining multiple calls
4333 * into a single statement.
4334 *
4335 * @see #getPackage
4336 * @see #resolveActivity
4337 */
4338 public Intent setPackage(String packageName) {
4339 mPackage = packageName;
4340 return this;
4341 }
4342
4343 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004344 * (Usually optional) Explicitly set the component to handle the intent.
4345 * If left with the default value of null, the system will determine the
4346 * appropriate class to use based on the other fields (action, data,
4347 * type, categories) in the Intent. If this class is defined, the
4348 * specified class will always be used regardless of the other fields. You
4349 * should only set this value when you know you absolutely want a specific
4350 * class to be used; otherwise it is better to let the system find the
4351 * appropriate class so that you will respect the installed applications
4352 * and user preferences.
4353 *
4354 * @param component The name of the application component to handle the
4355 * intent, or null to let the system find one for you.
4356 *
4357 * @return Returns the same Intent object, for chaining multiple calls
4358 * into a single statement.
4359 *
4360 * @see #setClass
4361 * @see #setClassName(Context, String)
4362 * @see #setClassName(String, String)
4363 * @see #getComponent
4364 * @see #resolveActivity
4365 */
4366 public Intent setComponent(ComponentName component) {
4367 mComponent = component;
4368 return this;
4369 }
4370
4371 /**
4372 * Convenience for calling {@link #setComponent} with an
4373 * explicit class name.
4374 *
4375 * @param packageContext A Context of the application package implementing
4376 * this class.
4377 * @param className The name of a class inside of the application package
4378 * that will be used as the component for this Intent.
4379 *
4380 * @return Returns the same Intent object, for chaining multiple calls
4381 * into a single statement.
4382 *
4383 * @see #setComponent
4384 * @see #setClass
4385 */
4386 public Intent setClassName(Context packageContext, String className) {
4387 mComponent = new ComponentName(packageContext, className);
4388 return this;
4389 }
4390
4391 /**
4392 * Convenience for calling {@link #setComponent} with an
4393 * explicit application package name and class name.
4394 *
4395 * @param packageName The name of the package implementing the desired
4396 * component.
4397 * @param className The name of a class inside of the application package
4398 * that will be used as the component for this Intent.
4399 *
4400 * @return Returns the same Intent object, for chaining multiple calls
4401 * into a single statement.
4402 *
4403 * @see #setComponent
4404 * @see #setClass
4405 */
4406 public Intent setClassName(String packageName, String className) {
4407 mComponent = new ComponentName(packageName, className);
4408 return this;
4409 }
4410
4411 /**
4412 * Convenience for calling {@link #setComponent(ComponentName)} with the
4413 * name returned by a {@link Class} object.
4414 *
4415 * @param packageContext A Context of the application package implementing
4416 * this class.
4417 * @param cls The class name to set, equivalent to
4418 * <code>setClassName(context, cls.getName())</code>.
4419 *
4420 * @return Returns the same Intent object, for chaining multiple calls
4421 * into a single statement.
4422 *
4423 * @see #setComponent
4424 */
4425 public Intent setClass(Context packageContext, Class<?> cls) {
4426 mComponent = new ComponentName(packageContext, cls);
4427 return this;
4428 }
4429
4430 /**
4431 * Use with {@link #fillIn} to allow the current action value to be
4432 * overwritten, even if it is already set.
4433 */
4434 public static final int FILL_IN_ACTION = 1<<0;
4435
4436 /**
4437 * Use with {@link #fillIn} to allow the current data or type value
4438 * overwritten, even if it is already set.
4439 */
4440 public static final int FILL_IN_DATA = 1<<1;
4441
4442 /**
4443 * Use with {@link #fillIn} to allow the current categories to be
4444 * overwritten, even if they are already set.
4445 */
4446 public static final int FILL_IN_CATEGORIES = 1<<2;
4447
4448 /**
4449 * Use with {@link #fillIn} to allow the current component value to be
4450 * overwritten, even if it is already set.
4451 */
4452 public static final int FILL_IN_COMPONENT = 1<<3;
4453
4454 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004455 * Use with {@link #fillIn} to allow the current package value to be
4456 * overwritten, even if it is already set.
4457 */
4458 public static final int FILL_IN_PACKAGE = 1<<4;
4459
4460 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004461 * Copy the contents of <var>other</var> in to this object, but only
4462 * where fields are not defined by this object. For purposes of a field
4463 * being defined, the following pieces of data in the Intent are
4464 * considered to be separate fields:
4465 *
4466 * <ul>
4467 * <li> action, as set by {@link #setAction}.
4468 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4469 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4470 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004471 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004472 * <li> component, as set by {@link #setComponent(ComponentName)} or
4473 * related methods.
4474 * <li> each top-level name in the associated extras.
4475 * </ul>
4476 *
4477 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004478 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4479 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004480 * corresponding field will not be replaced if it is already set.
4481 *
4482 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4483 * and Intent B with {action="gotit", data-type="some/thing",
4484 * categories="one","two"}.
4485 *
4486 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4487 * containing: {action="gotit", data-type="some/thing",
4488 * categories="bar"}.
4489 *
4490 * @param other Another Intent whose values are to be used to fill in
4491 * the current one.
4492 * @param flags Options to control which fields can be filled in.
4493 *
4494 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004495 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4496 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004497 */
4498 public int fillIn(Intent other, int flags) {
4499 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004500 if (other.mAction != null
4501 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004502 mAction = other.mAction;
4503 changes |= FILL_IN_ACTION;
4504 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004505 if ((other.mData != null || other.mType != null)
4506 && ((mData == null && mType == null)
4507 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004508 mData = other.mData;
4509 mType = other.mType;
4510 changes |= FILL_IN_DATA;
4511 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004512 if (other.mCategories != null
4513 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004514 if (other.mCategories != null) {
4515 mCategories = new HashSet<String>(other.mCategories);
4516 }
4517 changes |= FILL_IN_CATEGORIES;
4518 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004519 if (other.mPackage != null
4520 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4521 mPackage = other.mPackage;
4522 changes |= FILL_IN_PACKAGE;
4523 }
4524 // Component is special: it can -only- be set if explicitly allowed,
4525 // since otherwise the sender could force the intent somewhere the
4526 // originator didn't intend.
4527 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004528 mComponent = other.mComponent;
4529 changes |= FILL_IN_COMPONENT;
4530 }
4531 mFlags |= other.mFlags;
4532 if (mExtras == null) {
4533 if (other.mExtras != null) {
4534 mExtras = new Bundle(other.mExtras);
4535 }
4536 } else if (other.mExtras != null) {
4537 try {
4538 Bundle newb = new Bundle(other.mExtras);
4539 newb.putAll(mExtras);
4540 mExtras = newb;
4541 } catch (RuntimeException e) {
4542 // Modifying the extras can cause us to unparcel the contents
4543 // of the bundle, and if we do this in the system process that
4544 // may fail. We really should handle this (i.e., the Bundle
4545 // impl shouldn't be on top of a plain map), but for now just
4546 // ignore it and keep the original contents. :(
4547 Log.w("Intent", "Failure filling in extras", e);
4548 }
4549 }
4550 return changes;
4551 }
4552
4553 /**
4554 * Wrapper class holding an Intent and implementing comparisons on it for
4555 * the purpose of filtering. The class implements its
4556 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4557 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4558 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4559 * on the wrapped Intent.
4560 */
4561 public static final class FilterComparison {
4562 private final Intent mIntent;
4563 private final int mHashCode;
4564
4565 public FilterComparison(Intent intent) {
4566 mIntent = intent;
4567 mHashCode = intent.filterHashCode();
4568 }
4569
4570 /**
4571 * Return the Intent that this FilterComparison represents.
4572 * @return Returns the Intent held by the FilterComparison. Do
4573 * not modify!
4574 */
4575 public Intent getIntent() {
4576 return mIntent;
4577 }
4578
4579 @Override
4580 public boolean equals(Object obj) {
4581 if (obj instanceof FilterComparison) {
4582 Intent other = ((FilterComparison)obj).mIntent;
4583 return mIntent.filterEquals(other);
4584 }
4585 return false;
4586 }
4587
4588 @Override
4589 public int hashCode() {
4590 return mHashCode;
4591 }
4592 }
4593
4594 /**
4595 * Determine if two intents are the same for the purposes of intent
4596 * resolution (filtering). That is, if their action, data, type,
4597 * class, and categories are the same. This does <em>not</em> compare
4598 * any extra data included in the intents.
4599 *
4600 * @param other The other Intent to compare against.
4601 *
4602 * @return Returns true if action, data, type, class, and categories
4603 * are the same.
4604 */
4605 public boolean filterEquals(Intent other) {
4606 if (other == null) {
4607 return false;
4608 }
4609 if (mAction != other.mAction) {
4610 if (mAction != null) {
4611 if (!mAction.equals(other.mAction)) {
4612 return false;
4613 }
4614 } else {
4615 if (!other.mAction.equals(mAction)) {
4616 return false;
4617 }
4618 }
4619 }
4620 if (mData != other.mData) {
4621 if (mData != null) {
4622 if (!mData.equals(other.mData)) {
4623 return false;
4624 }
4625 } else {
4626 if (!other.mData.equals(mData)) {
4627 return false;
4628 }
4629 }
4630 }
4631 if (mType != other.mType) {
4632 if (mType != null) {
4633 if (!mType.equals(other.mType)) {
4634 return false;
4635 }
4636 } else {
4637 if (!other.mType.equals(mType)) {
4638 return false;
4639 }
4640 }
4641 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004642 if (mPackage != other.mPackage) {
4643 if (mPackage != null) {
4644 if (!mPackage.equals(other.mPackage)) {
4645 return false;
4646 }
4647 } else {
4648 if (!other.mPackage.equals(mPackage)) {
4649 return false;
4650 }
4651 }
4652 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004653 if (mComponent != other.mComponent) {
4654 if (mComponent != null) {
4655 if (!mComponent.equals(other.mComponent)) {
4656 return false;
4657 }
4658 } else {
4659 if (!other.mComponent.equals(mComponent)) {
4660 return false;
4661 }
4662 }
4663 }
4664 if (mCategories != other.mCategories) {
4665 if (mCategories != null) {
4666 if (!mCategories.equals(other.mCategories)) {
4667 return false;
4668 }
4669 } else {
4670 if (!other.mCategories.equals(mCategories)) {
4671 return false;
4672 }
4673 }
4674 }
4675
4676 return true;
4677 }
4678
4679 /**
4680 * Generate hash code that matches semantics of filterEquals().
4681 *
4682 * @return Returns the hash value of the action, data, type, class, and
4683 * categories.
4684 *
4685 * @see #filterEquals
4686 */
4687 public int filterHashCode() {
4688 int code = 0;
4689 if (mAction != null) {
4690 code += mAction.hashCode();
4691 }
4692 if (mData != null) {
4693 code += mData.hashCode();
4694 }
4695 if (mType != null) {
4696 code += mType.hashCode();
4697 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004698 if (mPackage != null) {
4699 code += mPackage.hashCode();
4700 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004701 if (mComponent != null) {
4702 code += mComponent.hashCode();
4703 }
4704 if (mCategories != null) {
4705 code += mCategories.hashCode();
4706 }
4707 return code;
4708 }
4709
4710 @Override
4711 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004712 StringBuilder b = new StringBuilder(128);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004713
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004714 b.append("Intent { ");
4715 toShortString(b, true, true);
4716 b.append(" }");
4717
4718 return b.toString();
4719 }
4720
4721 /** @hide */
4722 public String toShortString(boolean comp, boolean extras) {
4723 StringBuilder b = new StringBuilder(128);
4724 toShortString(b, comp, extras);
4725 return b.toString();
4726 }
Romain Guy4969af72009-06-17 10:53:19 -07004727
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004728 /** @hide */
4729 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4730 boolean first = true;
4731 if (mAction != null) {
4732 b.append("act=").append(mAction);
4733 first = false;
4734 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004735 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004736 if (!first) {
4737 b.append(' ');
4738 }
4739 first = false;
4740 b.append("cat=[");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004741 Iterator<String> i = mCategories.iterator();
4742 boolean didone = false;
4743 while (i.hasNext()) {
4744 if (didone) b.append(",");
4745 didone = true;
4746 b.append(i.next());
4747 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004748 b.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004749 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004750 if (mData != null) {
4751 if (!first) {
4752 b.append(' ');
4753 }
4754 first = false;
4755 b.append("dat=").append(mData);
4756 }
4757 if (mType != null) {
4758 if (!first) {
4759 b.append(' ');
4760 }
4761 first = false;
4762 b.append("typ=").append(mType);
4763 }
4764 if (mFlags != 0) {
4765 if (!first) {
4766 b.append(' ');
4767 }
4768 first = false;
4769 b.append("flg=0x").append(Integer.toHexString(mFlags));
4770 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004771 if (mPackage != null) {
4772 if (!first) {
4773 b.append(' ');
4774 }
4775 first = false;
4776 b.append("pkg=").append(mPackage);
4777 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004778 if (comp && mComponent != null) {
4779 if (!first) {
4780 b.append(' ');
4781 }
4782 first = false;
4783 b.append("cmp=").append(mComponent.flattenToShortString());
4784 }
4785 if (extras && mExtras != null) {
4786 if (!first) {
4787 b.append(' ');
4788 }
4789 first = false;
4790 b.append("(has extras)");
4791 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004792 }
4793
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004794 /**
4795 * Call {@link #toUri} with 0 flags.
4796 * @deprecated Use {@link #toUri} instead.
4797 */
4798 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004799 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004800 return toUri(0);
4801 }
4802
4803 /**
4804 * Convert this Intent into a String holding a URI representation of it.
4805 * The returned URI string has been properly URI encoded, so it can be
4806 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
4807 * Intent's data as the base URI, with an additional fragment describing
4808 * the action, categories, type, flags, package, component, and extras.
4809 *
4810 * <p>You can convert the returned string back to an Intent with
4811 * {@link #getIntent}.
4812 *
4813 * @param flags Additional operating flags. Either 0 or
4814 * {@link #URI_INTENT_SCHEME}.
4815 *
4816 * @return Returns a URI encoding URI string describing the entire contents
4817 * of the Intent.
4818 */
4819 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004820 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004821 String scheme = null;
4822 if (mData != null) {
4823 String data = mData.toString();
4824 if ((flags&URI_INTENT_SCHEME) != 0) {
4825 final int N = data.length();
4826 for (int i=0; i<N; i++) {
4827 char c = data.charAt(i);
4828 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
4829 || c == '.' || c == '-') {
4830 continue;
4831 }
4832 if (c == ':' && i > 0) {
4833 // Valid scheme.
4834 scheme = data.substring(0, i);
4835 uri.append("intent:");
4836 data = data.substring(i+1);
4837 break;
4838 }
4839
4840 // No scheme.
4841 break;
4842 }
4843 }
4844 uri.append(data);
4845
4846 } else if ((flags&URI_INTENT_SCHEME) != 0) {
4847 uri.append("intent:");
4848 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004849
4850 uri.append("#Intent;");
4851
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004852 if (scheme != null) {
4853 uri.append("scheme=").append(scheme).append(';');
4854 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004855 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004856 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004857 }
4858 if (mCategories != null) {
4859 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004860 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004861 }
4862 }
4863 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004864 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004865 }
4866 if (mFlags != 0) {
4867 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
4868 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004869 if (mPackage != null) {
4870 uri.append("package=").append(Uri.encode(mPackage)).append(';');
4871 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004872 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004873 uri.append("component=").append(Uri.encode(
4874 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004875 }
4876 if (mExtras != null) {
4877 for (String key : mExtras.keySet()) {
4878 final Object value = mExtras.get(key);
4879 char entryType =
4880 value instanceof String ? 'S' :
4881 value instanceof Boolean ? 'B' :
4882 value instanceof Byte ? 'b' :
4883 value instanceof Character ? 'c' :
4884 value instanceof Double ? 'd' :
4885 value instanceof Float ? 'f' :
4886 value instanceof Integer ? 'i' :
4887 value instanceof Long ? 'l' :
4888 value instanceof Short ? 's' :
4889 '\0';
4890
4891 if (entryType != '\0') {
4892 uri.append(entryType);
4893 uri.append('.');
4894 uri.append(Uri.encode(key));
4895 uri.append('=');
4896 uri.append(Uri.encode(value.toString()));
4897 uri.append(';');
4898 }
4899 }
4900 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004901
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004902 uri.append("end");
4903
4904 return uri.toString();
4905 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004906
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004907 public int describeContents() {
4908 return (mExtras != null) ? mExtras.describeContents() : 0;
4909 }
4910
4911 public void writeToParcel(Parcel out, int flags) {
4912 out.writeString(mAction);
4913 Uri.writeToParcel(out, mData);
4914 out.writeString(mType);
4915 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004916 out.writeString(mPackage);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004917 ComponentName.writeToParcel(mComponent, out);
4918
4919 if (mCategories != null) {
4920 out.writeInt(mCategories.size());
4921 for (String category : mCategories) {
4922 out.writeString(category);
4923 }
4924 } else {
4925 out.writeInt(0);
4926 }
4927
4928 out.writeBundle(mExtras);
4929 }
4930
4931 public static final Parcelable.Creator<Intent> CREATOR
4932 = new Parcelable.Creator<Intent>() {
4933 public Intent createFromParcel(Parcel in) {
4934 return new Intent(in);
4935 }
4936 public Intent[] newArray(int size) {
4937 return new Intent[size];
4938 }
4939 };
4940
4941 private Intent(Parcel in) {
4942 readFromParcel(in);
4943 }
4944
4945 public void readFromParcel(Parcel in) {
4946 mAction = in.readString();
4947 mData = Uri.CREATOR.createFromParcel(in);
4948 mType = in.readString();
4949 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004950 mPackage = in.readString();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004951 mComponent = ComponentName.readFromParcel(in);
4952
4953 int N = in.readInt();
4954 if (N > 0) {
4955 mCategories = new HashSet<String>();
4956 int i;
4957 for (i=0; i<N; i++) {
4958 mCategories.add(in.readString());
4959 }
4960 } else {
4961 mCategories = null;
4962 }
4963
4964 mExtras = in.readBundle();
4965 }
4966
4967 /**
4968 * Parses the "intent" element (and its children) from XML and instantiates
4969 * an Intent object. The given XML parser should be located at the tag
4970 * where parsing should start (often named "intent"), from which the
4971 * basic action, data, type, and package and class name will be
4972 * retrieved. The function will then parse in to any child elements,
4973 * looking for <category android:name="xxx"> tags to add categories and
4974 * <extra android:name="xxx" android:value="yyy"> to attach extra data
4975 * to the intent.
4976 *
4977 * @param resources The Resources to use when inflating resources.
4978 * @param parser The XML parser pointing at an "intent" tag.
4979 * @param attrs The AttributeSet interface for retrieving extended
4980 * attribute data at the current <var>parser</var> location.
4981 * @return An Intent object matching the XML data.
4982 * @throws XmlPullParserException If there was an XML parsing error.
4983 * @throws IOException If there was an I/O error.
4984 */
4985 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
4986 throws XmlPullParserException, IOException {
4987 Intent intent = new Intent();
4988
4989 TypedArray sa = resources.obtainAttributes(attrs,
4990 com.android.internal.R.styleable.Intent);
4991
4992 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
4993
4994 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
4995 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
4996 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
4997
4998 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
4999 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5000 if (packageName != null && className != null) {
5001 intent.setComponent(new ComponentName(packageName, className));
5002 }
5003
5004 sa.recycle();
5005
5006 int outerDepth = parser.getDepth();
5007 int type;
5008 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5009 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5010 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5011 continue;
5012 }
5013
5014 String nodeName = parser.getName();
5015 if (nodeName.equals("category")) {
5016 sa = resources.obtainAttributes(attrs,
5017 com.android.internal.R.styleable.IntentCategory);
5018 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5019 sa.recycle();
5020
5021 if (cat != null) {
5022 intent.addCategory(cat);
5023 }
5024 XmlUtils.skipCurrentTag(parser);
5025
5026 } else if (nodeName.equals("extra")) {
5027 if (intent.mExtras == null) {
5028 intent.mExtras = new Bundle();
5029 }
5030 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5031 XmlUtils.skipCurrentTag(parser);
5032
5033 } else {
5034 XmlUtils.skipCurrentTag(parser);
5035 }
5036 }
5037
5038 return intent;
5039 }
5040}