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