blob: 1359761f3b602509ffdfd62a89c94528255f1805 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
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;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import 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>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070078 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070079 * information about the person whose identifier is "1".</p>
80 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070081 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070082 * 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>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * information about the person whose identifier is "1".</p>
94 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070095 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070096 * 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
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700159 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700160 *
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 Project54b6cfa2008-10-21 07:00:00 -0700245 * &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 Project54b6cfa2008-10-21 07:00:00 -0700252 * &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 Project54b6cfa2008-10-21 07:00:00 -0700257 * &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 Project54b6cfa2008-10-21 07:00:00 -0700266 * &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 Project54b6cfa2008-10-21 07:00:00 -0700272 * &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 Project54b6cfa2008-10-21 07:00:00 -0700284 * &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 Project54b6cfa2008-10-21 07:00:00 -0700299 * &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 Project54b6cfa2008-10-21 07:00:00 -0700311 * &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 Project54b6cfa2008-10-21 07:00:00 -0700328 * &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>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700350 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * 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 Project54b6cfa2008-10-21 07:00:00 -0700378 * &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 Project54b6cfa2008-10-21 07:00:00 -0700390 * &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>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700402 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700403 * 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 Project54b6cfa2008-10-21 07:00:00 -0700430 * &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}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 * <li> {@link #ACTION_PACKAGE_RESTARTED}
508 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700509 * <li> {@link #ACTION_UID_REMOVED}
510 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -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 Project54b6cfa2008-10-21 07:00:00 -0700514 * </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}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800528 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700529 * <li> {@link #CATEGORY_HOME}
530 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400532 * <li> {@link #CATEGORY_CAR_DOCK}
533 * <li> {@link #CATEGORY_DESK_DOCK}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700534 * </ul>
535 *
536 * <h3>Standard Extra Data</h3>
537 *
538 * <p>These are the current standard fields that can be used as extra data via
539 * {@link #putExtra}.
540 *
541 * <ul>
542 * <li> {@link #EXTRA_TEMPLATE}
543 * <li> {@link #EXTRA_INTENT}
544 * <li> {@link #EXTRA_STREAM}
545 * <li> {@link #EXTRA_TEXT}
546 * </ul>
547 *
548 * <h3>Flags</h3>
549 *
550 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800551 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
552 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700553 */
554public class Intent implements Parcelable {
555 // ---------------------------------------------------------------------
556 // ---------------------------------------------------------------------
557 // Standard intent activity actions (see action variable).
558
559 /**
560 * Activity Action: Start as a main entry point, does not expect to
561 * receive data.
562 * <p>Input: nothing
563 * <p>Output: nothing
564 */
565 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
566 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800567
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700568 /**
569 * Activity Action: Display the data to the user. This is the most common
570 * action performed on data -- it is the generic action you can use on
571 * a piece of data to get the most reasonable thing to occur. For example,
572 * when used on a contacts entry it will view the entry; when used on a
573 * mailto: URI it will bring up a compose window filled with the information
574 * supplied by the URI; when used with a tel: URI it will invoke the
575 * dialer.
576 * <p>Input: {@link #getData} is URI from which to retrieve data.
577 * <p>Output: nothing.
578 */
579 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
580 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800581
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 /**
583 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
584 * performed on a piece of data.
585 */
586 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800587
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 /**
589 * Used to indicate that some piece of data should be attached to some other
590 * place. For example, image data could be attached to a contact. It is up
591 * to the recipient to decide where the data should be attached; the intent
592 * does not specify the ultimate destination.
593 * <p>Input: {@link #getData} is URI of data to be attached.
594 * <p>Output: nothing.
595 */
596 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
597 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 /**
600 * Activity Action: Provide explicit editable access to the given data.
601 * <p>Input: {@link #getData} is URI of data to be edited.
602 * <p>Output: nothing.
603 */
604 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
605 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800606
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 /**
608 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
609 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
610 * The extras can contain type specific data to pass through to the editing/creating
611 * activity.
612 * <p>Output: The URI of the item that was picked. This must be a content:
613 * URI so that any receiver can access it.
614 */
615 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
616 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 /**
619 * Activity Action: Pick an item from the data, returning what was selected.
620 * <p>Input: {@link #getData} is URI containing a directory of data
621 * (vnd.android.cursor.dir/*) from which to pick an item.
622 * <p>Output: The URI of the item that was picked.
623 */
624 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
625 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 /**
628 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 * <p>Output: An Intent representing the shortcut. The intent must contain three
631 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
632 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800633 * (value: ShortcutIconResource).</p>
634 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700635 * @see #EXTRA_SHORTCUT_INTENT
636 * @see #EXTRA_SHORTCUT_NAME
637 * @see #EXTRA_SHORTCUT_ICON
638 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
639 * @see android.content.Intent.ShortcutIconResource
640 */
641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
642 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
643
644 /**
645 * The name of the extra used to define the Intent of a shortcut.
646 *
647 * @see #ACTION_CREATE_SHORTCUT
648 */
649 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
650 /**
651 * The name of the extra used to define the name of a shortcut.
652 *
653 * @see #ACTION_CREATE_SHORTCUT
654 */
655 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
656 /**
657 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
658 *
659 * @see #ACTION_CREATE_SHORTCUT
660 */
661 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
662 /**
663 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
664 *
665 * @see #ACTION_CREATE_SHORTCUT
666 * @see android.content.Intent.ShortcutIconResource
667 */
668 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
669 "android.intent.extra.shortcut.ICON_RESOURCE";
670
671 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800672 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 *
674 * @see Intent#ACTION_CREATE_SHORTCUT
675 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
677 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 */
679 public static class ShortcutIconResource implements Parcelable {
680 /**
681 * The package name of the application containing the icon.
682 */
683 public String packageName;
684
685 /**
686 * The resource name of the icon, including package, name and type.
687 */
688 public String resourceName;
689
690 /**
691 * Creates a new ShortcutIconResource for the specified context and resource
692 * identifier.
693 *
694 * @param context The context of the application.
695 * @param resourceId The resource idenfitier for the icon.
696 * @return A new ShortcutIconResource with the specified's context package name
697 * and icon resource idenfitier.
698 */
699 public static ShortcutIconResource fromContext(Context context, int resourceId) {
700 ShortcutIconResource icon = new ShortcutIconResource();
701 icon.packageName = context.getPackageName();
702 icon.resourceName = context.getResources().getResourceName(resourceId);
703 return icon;
704 }
705
706 /**
707 * Used to read a ShortcutIconResource from a Parcel.
708 */
709 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
710 new Parcelable.Creator<ShortcutIconResource>() {
711
712 public ShortcutIconResource createFromParcel(Parcel source) {
713 ShortcutIconResource icon = new ShortcutIconResource();
714 icon.packageName = source.readString();
715 icon.resourceName = source.readString();
716 return icon;
717 }
718
719 public ShortcutIconResource[] newArray(int size) {
720 return new ShortcutIconResource[size];
721 }
722 };
723
724 /**
725 * No special parcel contents.
726 */
727 public int describeContents() {
728 return 0;
729 }
730
731 public void writeToParcel(Parcel dest, int flags) {
732 dest.writeString(packageName);
733 dest.writeString(resourceName);
734 }
735
736 @Override
737 public String toString() {
738 return resourceName;
739 }
740 }
741
742 /**
743 * Activity Action: Display an activity chooser, allowing the user to pick
744 * what they want to before proceeding. This can be used as an alternative
745 * to the standard activity picker that is displayed by the system when
746 * you try to start an activity with multiple possible matches, with these
747 * differences in behavior:
748 * <ul>
749 * <li>You can specify the title that will appear in the activity chooser.
750 * <li>The user does not have the option to make one of the matching
751 * activities a preferred activity, and all possible activities will
752 * always be shown even if one of them is currently marked as the
753 * preferred activity.
754 * </ul>
755 * <p>
756 * This action should be used when the user will naturally expect to
757 * select an activity in order to proceed. An example if when not to use
758 * it is when the user clicks on a "mailto:" link. They would naturally
759 * expect to go directly to their mail app, so startActivity() should be
760 * called directly: it will
761 * either launch the current preferred app, or put up a dialog allowing the
762 * user to pick an app to use and optionally marking that as preferred.
763 * <p>
764 * In contrast, if the user is selecting a menu item to send a picture
765 * they are viewing to someone else, there are many different things they
766 * may want to do at this point: send it through e-mail, upload it to a
767 * web service, etc. In this case the CHOOSER action should be used, to
768 * always present to the user a list of the things they can do, with a
769 * nice title given by the caller such as "Send this photo with:".
770 * <p>
771 * As a convenience, an Intent of this form can be created with the
772 * {@link #createChooser} function.
773 * <p>Input: No data should be specified. get*Extra must have
774 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
775 * and can optionally have a {@link #EXTRA_TITLE} field containing the
776 * title text to display in the chooser.
777 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
778 */
779 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
780 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
781
782 /**
783 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
784 *
785 * @param target The Intent that the user will be selecting an activity
786 * to perform.
787 * @param title Optional title that will be displayed in the chooser.
788 * @return Return a new Intent object that you can hand to
789 * {@link Context#startActivity(Intent) Context.startActivity()} and
790 * related methods.
791 */
792 public static Intent createChooser(Intent target, CharSequence title) {
793 Intent intent = new Intent(ACTION_CHOOSER);
794 intent.putExtra(EXTRA_INTENT, target);
795 if (title != null) {
796 intent.putExtra(EXTRA_TITLE, title);
797 }
798 return intent;
799 }
800 /**
801 * Activity Action: Allow the user to select a particular kind of data and
802 * return it. This is different than {@link #ACTION_PICK} in that here we
803 * just say what kind of data is desired, not a URI of existing data from
804 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
805 * create the data as it runs (for example taking a picture or recording a
806 * sound), let them browser over the web and download the desired data,
807 * etc.
808 * <p>
809 * There are two main ways to use this action: if you want an specific kind
810 * of data, such as a person contact, you set the MIME type to the kind of
811 * data you want and launch it with {@link Context#startActivity(Intent)}.
812 * The system will then launch the best application to select that kind
813 * of data for you.
814 * <p>
815 * You may also be interested in any of a set of types of content the user
816 * can pick. For example, an e-mail application that wants to allow the
817 * user to add an attachment to an e-mail message can use this action to
818 * bring up a list of all of the types of content the user can attach.
819 * <p>
820 * In this case, you should wrap the GET_CONTENT intent with a chooser
821 * (through {@link #createChooser}), which will give the proper interface
822 * for the user to pick how to send your data and allow you to specify
823 * a prompt indicating what they are doing. You will usually specify a
824 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
825 * broad range of content types the user can select from.
826 * <p>
827 * When using such a broad GET_CONTENT action, it is often desireable to
828 * only pick from data that can be represented as a stream. This is
829 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
830 * <p>
831 * Input: {@link #getType} is the desired MIME type to retrieve. Note
832 * that no URI is supplied in the intent, as there are no constraints on
833 * where the returned data originally comes from. You may also include the
834 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
835 * opened as a stream.
836 * <p>
837 * Output: The URI of the item that was picked. This must be a content:
838 * URI so that any receiver can access it.
839 */
840 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
841 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
842 /**
843 * Activity Action: Dial a number as specified by the data. This shows a
844 * UI with the number being dialed, allowing the user to explicitly
845 * initiate the call.
846 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
847 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
848 * number.
849 * <p>Output: nothing.
850 */
851 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
852 public static final String ACTION_DIAL = "android.intent.action.DIAL";
853 /**
854 * Activity Action: Perform a call to someone specified by the data.
855 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
856 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
857 * number.
858 * <p>Output: nothing.
859 *
860 * <p>Note: there will be restrictions on which applications can initiate a
861 * call; most applications should use the {@link #ACTION_DIAL}.
862 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
863 * numbers. Applications can <strong>dial</strong> emergency numbers using
864 * {@link #ACTION_DIAL}, however.
865 */
866 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
867 public static final String ACTION_CALL = "android.intent.action.CALL";
868 /**
869 * Activity Action: Perform a call to an emergency number specified by the
870 * data.
871 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
872 * tel: URI of an explicit phone number.
873 * <p>Output: nothing.
874 * @hide
875 */
876 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
877 /**
878 * Activity action: Perform a call to any number (emergency or not)
879 * specified by the data.
880 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
881 * tel: URI of an explicit phone number.
882 * <p>Output: nothing.
883 * @hide
884 */
885 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
886 /**
887 * Activity Action: Send a message to someone specified by the data.
888 * <p>Input: {@link #getData} is URI describing the target.
889 * <p>Output: nothing.
890 */
891 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
892 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
893 /**
894 * Activity Action: Deliver some data to someone else. Who the data is
895 * being delivered to is not specified; it is up to the receiver of this
896 * action to ask the user where the data should be sent.
897 * <p>
898 * When launching a SEND intent, you should usually wrap it in a chooser
899 * (through {@link #createChooser}), which will give the proper interface
900 * for the user to pick how to send your data and allow you to specify
901 * a prompt indicating what they are doing.
902 * <p>
903 * Input: {@link #getType} is the MIME type of the data being sent.
904 * get*Extra can have either a {@link #EXTRA_TEXT}
905 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
906 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
907 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
908 * if the MIME type is unknown (this will only allow senders that can
909 * handle generic data streams).
910 * <p>
911 * Optional standard extras, which may be interpreted by some recipients as
912 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
913 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
914 * <p>
915 * Output: nothing.
916 */
917 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
918 public static final String ACTION_SEND = "android.intent.action.SEND";
919 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800920 * Activity Action: Deliver multiple data to someone else.
921 * <p>
922 * Like ACTION_SEND, except the data is multiple.
923 * <p>
924 * Input: {@link #getType} is the MIME type of the data being sent.
925 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
926 * #EXTRA_STREAM} field, containing the data to be sent.
927 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800928 * Multiple types are supported, and receivers should handle mixed types
929 * whenever possible. The right way for the receiver to check them is to
930 * use the content resolver on each URI. The intent sender should try to
931 * put the most concrete mime type in the intent type, but it can fall
932 * back to {@literal <type>/*} or {@literal *}/* as needed.
933 * <p>
934 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
935 * be image/jpg, but if you are sending image/jpg and image/png, then the
936 * intent's type should be image/*.
937 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800938 * Optional standard extras, which may be interpreted by some recipients as
939 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
940 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
941 * <p>
942 * Output: nothing.
943 */
944 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
945 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 * Activity Action: Handle an incoming phone call.
948 * <p>Input: nothing.
949 * <p>Output: nothing.
950 */
951 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
952 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
953 /**
954 * Activity Action: Insert an empty item into the given container.
955 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
956 * in which to place the data.
957 * <p>Output: URI of the new data that was created.
958 */
959 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
960 public static final String ACTION_INSERT = "android.intent.action.INSERT";
961 /**
962 * Activity Action: Delete the given data from its container.
963 * <p>Input: {@link #getData} is URI of data to be deleted.
964 * <p>Output: nothing.
965 */
966 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
967 public static final String ACTION_DELETE = "android.intent.action.DELETE";
968 /**
969 * Activity Action: Run the data, whatever that means.
970 * <p>Input: ? (Note: this is currently specific to the test harness.)
971 * <p>Output: nothing.
972 */
973 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
974 public static final String ACTION_RUN = "android.intent.action.RUN";
975 /**
976 * Activity Action: Perform a data synchronization.
977 * <p>Input: ?
978 * <p>Output: ?
979 */
980 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
981 public static final String ACTION_SYNC = "android.intent.action.SYNC";
982 /**
983 * Activity Action: Pick an activity given an intent, returning the class
984 * selected.
985 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
986 * used with {@link PackageManager#queryIntentActivities} to determine the
987 * set of activities from which to pick.
988 * <p>Output: Class name of the activity that was selected.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
992 /**
993 * Activity Action: Perform a search.
994 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
995 * is the text to search for. If empty, simply
996 * enter your search results Activity with the search UI activated.
997 * <p>Output: nothing.
998 */
999 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1000 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1001 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001002 * Activity Action: Start the platform-defined tutorial
1003 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1004 * is the text to search for. If empty, simply
1005 * enter your search results Activity with the search UI activated.
1006 * <p>Output: nothing.
1007 */
1008 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001012 * <p>
1013 * Input: {@link android.app.SearchManager#QUERY
1014 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1015 * a url starts with http or https, the site will be opened. If it is plain
1016 * text, Google search will be applied.
1017 * <p>
1018 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 */
1020 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1021 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1022 /**
1023 * Activity Action: List all available applications
1024 * <p>Input: Nothing.
1025 * <p>Output: nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1029 /**
1030 * Activity Action: Show settings for choosing wallpaper
1031 * <p>Input: Nothing.
1032 * <p>Output: Nothing.
1033 */
1034 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1035 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1036
1037 /**
1038 * Activity Action: Show activity for reporting a bug.
1039 * <p>Input: Nothing.
1040 * <p>Output: Nothing.
1041 */
1042 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1043 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1044
1045 /**
1046 * Activity Action: Main entry point for factory tests. Only used when
1047 * the device is booting in factory test node. The implementing package
1048 * must be installed in the system image.
1049 * <p>Input: nothing
1050 * <p>Output: nothing
1051 */
1052 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1053
1054 /**
1055 * Activity Action: The user pressed the "call" button to go to the dialer
1056 * or other appropriate UI for placing a call.
1057 * <p>Input: Nothing.
1058 * <p>Output: Nothing.
1059 */
1060 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1061 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1062
1063 /**
1064 * Activity Action: Start Voice Command.
1065 * <p>Input: Nothing.
1066 * <p>Output: Nothing.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001070
1071 /**
1072 * Activity Action: Start action associated with long pressing on the
1073 * search key.
1074 * <p>Input: Nothing.
1075 * <p>Output: Nothing.
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001079
Jacek Surazski86b6c532009-05-13 14:38:28 +02001080 /**
1081 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1082 * This intent is delivered to the package which installed the application, usually
1083 * the Market.
1084 * <p>Input: No data is specified. The bug report is passed in using
1085 * an {@link #EXTRA_BUG_REPORT} field.
1086 * <p>Output: Nothing.
1087 * @hide
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001091
1092 /**
1093 * Activity Action: Show power usage information to the user.
1094 * <p>Input: Nothing.
1095 * <p>Output: Nothing.
1096 */
1097 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1098 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1099
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001100 /**
1101 * Activity Action: Setup wizard to launch after a platform update. This
1102 * activity should have a string meta-data field associated with it,
1103 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1104 * the platform for setup. The activity will be launched only if
1105 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1106 * same value.
1107 * <p>Input: Nothing.
1108 * <p>Output: Nothing.
1109 * @hide
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1113
1114 /**
1115 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1116 * describing the last run version of the platform that was setup.
1117 * @hide
1118 */
1119 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1120
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001121 // ---------------------------------------------------------------------
1122 // ---------------------------------------------------------------------
1123 // Standard intent broadcast actions (see action variable).
1124
1125 /**
1126 * Broadcast Action: Sent after the screen turns off.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001127 *
1128 * <p class="note">This is a protected intent that can only be sent
1129 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001130 */
1131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1132 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1133 /**
1134 * Broadcast Action: Sent after the screen turns on.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001135 *
1136 * <p class="note">This is a protected intent that can only be sent
1137 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001138 */
1139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1140 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001141
1142 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001143 * 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 -07001144 * keyguard is gone).
Dianne Hackborn854060af2009-07-09 18:14:31 -07001145 *
1146 * <p class="note">This is a protected intent that can only be sent
1147 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001148 */
1149 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1150 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1151
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 /**
1153 * Broadcast Action: The current time has changed. Sent every
1154 * minute. You can <em>not</em> receive this through components declared
1155 * in manifests, only by exlicitly registering for it with
1156 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1157 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001158 *
1159 * <p class="note">This is a protected intent that can only be sent
1160 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001161 */
1162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1163 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1164 /**
1165 * Broadcast Action: The time was set.
1166 */
1167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1168 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1169 /**
1170 * Broadcast Action: The date has changed.
1171 */
1172 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1173 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1174 /**
1175 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1176 * <ul>
1177 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1178 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001179 *
1180 * <p class="note">This is a protected intent that can only be sent
1181 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001182 */
1183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1184 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1185 /**
1186 * Alarm Changed Action: This is broadcast when the AlarmClock
1187 * application's alarm is set or unset. It is used by the
1188 * AlarmClock application and the StatusBar service.
1189 * @hide
1190 */
1191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1192 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1193 /**
1194 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1195 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1196 * @hide
1197 */
1198 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1199 public static final String ACTION_SYNC_STATE_CHANGED
1200 = "android.intent.action.SYNC_STATE_CHANGED";
1201 /**
1202 * Broadcast Action: This is broadcast once, after the system has finished
1203 * booting. It can be used to perform application-specific initialization,
1204 * such as installing alarms. You must hold the
1205 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1206 * in order to receive this broadcast.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001207 *
1208 * <p class="note">This is a protected intent that can only be sent
1209 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001210 */
1211 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1212 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1213 /**
1214 * Broadcast Action: This is broadcast when a user action should request a
1215 * temporary system dialog to dismiss. Some examples of temporary system
1216 * dialogs are the notification window-shade and the recent tasks dialog.
1217 */
1218 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1219 /**
1220 * Broadcast Action: Trigger the download and eventual installation
1221 * of a package.
1222 * <p>Input: {@link #getData} is the URI of the package file to download.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001223 *
1224 * <p class="note">This is a protected intent that can only be sent
1225 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001226 */
1227 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1228 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1229 /**
1230 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001231 * device. The data contains the name of the package. Note that the
1232 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001233 * <p>My include the following extras:
1234 * <ul>
1235 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1236 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1237 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1238 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001239 *
1240 * <p class="note">This is a protected intent that can only be sent
1241 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001242 */
1243 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1244 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1245 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001246 * Broadcast Action: A new version of an application package has been
1247 * installed, replacing an existing version that was previously installed.
1248 * The data contains the name of the package.
1249 * <p>My include the following extras:
1250 * <ul>
1251 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1252 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001253 *
1254 * <p class="note">This is a protected intent that can only be sent
1255 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001256 */
1257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1258 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1259 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001260 * Broadcast Action: An existing application package has been removed from
1261 * the device. The data contains the name of the package. The package
1262 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001263 * <ul>
1264 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1265 * to the package.
1266 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1267 * application -- data and code -- is being removed.
1268 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1269 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1270 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001271 *
1272 * <p class="note">This is a protected intent that can only be sent
1273 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001274 */
1275 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1276 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1277 /**
1278 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1279 * enabled or disabled. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001280 * <ul>
1281 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07001282 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME} containing the class name of the changed component.
1283 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001284 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001285 *
1286 * <p class="note">This is a protected intent that can only be sent
1287 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001288 */
1289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1290 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1291 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001292 * Broadcast Action: The user has restarted a package, and all of its
1293 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001294 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001295 * be removed. Note that the restarted package does <em>not</em>
1296 * receive this broadcast.
1297 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001298 * <ul>
1299 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1300 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001301 *
1302 * <p class="note">This is a protected intent that can only be sent
1303 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001304 */
1305 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1306 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1307 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001308 * Broadcast Action: The user has cleared the data of a package. This should
1309 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001310 * its persistent data is erased and this broadcast sent.
1311 * Note that the cleared package does <em>not</em>
1312 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001313 * <ul>
1314 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1315 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001316 *
1317 * <p class="note">This is a protected intent that can only be sent
1318 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001319 */
1320 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1321 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1322 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001323 * Broadcast Action: A user ID has been removed from the system. The user
1324 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001325 *
1326 * <p class="note">This is a protected intent that can only be sent
1327 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 */
1329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1330 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1331 /**
1332 * Broadcast Action: The current system wallpaper has changed. See
1333 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1334 */
1335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1336 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1337 /**
1338 * Broadcast Action: The current device {@link android.content.res.Configuration}
1339 * (orientation, locale, etc) has changed. When such a change happens, the
1340 * UIs (view hierarchy) will need to be rebuilt based on this new
1341 * information; for the most part, applications don't need to worry about
1342 * this, because the system will take care of stopping and restarting the
1343 * application to make sure it sees the new changes. Some system code that
1344 * can not be restarted will need to watch for this action and handle it
1345 * appropriately.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001346 *
1347 * <p class="note">This is a protected intent that can only be sent
1348 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001349 *
1350 * @see android.content.res.Configuration
1351 */
1352 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1353 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1354 /**
1355 * Broadcast Action: The charging state, or charge level of the battery has
1356 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001357 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001358 * <p class="note">
1359 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001360 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001361 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1362 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001363 *
1364 * <p class="note">This is a protected intent that can only be sent
1365 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001366 */
1367 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1368 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1369 /**
1370 * Broadcast Action: Indicates low battery condition on the device.
1371 * This broadcast corresponds to the "Low battery warning" system dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001372 *
1373 * <p class="note">This is a protected intent that can only be sent
1374 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001375 */
1376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1377 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1378 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001379 * Broadcast Action: Indicates the battery is now okay after being low.
1380 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1381 * gone back up to an okay state.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001382 *
1383 * <p class="note">This is a protected intent that can only be sent
1384 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001385 */
1386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1387 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1388 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001389 * Broadcast Action: External power has been connected to the device.
1390 * This is intended for applications that wish to register specifically to this notification.
1391 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1392 * stay active to receive this notification. This action can be used to implement actions
1393 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001394 *
1395 * <p class="note">This is a protected intent that can only be sent
1396 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001397 */
1398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001399 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001400 /**
1401 * Broadcast Action: External power has been removed from the device.
1402 * This is intended for applications that wish to register specifically to this notification.
1403 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1404 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001405 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001406 *
1407 * <p class="note">This is a protected intent that can only be sent
1408 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001409 */
1410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001411 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001412 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001413 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001414 * Broadcast Action: Device is shutting down.
1415 * This is broadcast when the device is being shut down (completely turned
1416 * off, not sleeping). Once the broadcast is complete, the final shutdown
1417 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001418 * to handle this, since the foreground activity will be paused as well.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001419 *
1420 * <p class="note">This is a protected intent that can only be sent
1421 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001422 */
1423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001424 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001425 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001426 * Activity Action: Start this activity to request system shutdown.
1427 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1428 * to request confirmation from the user before shutting down.
1429 *
1430 * <p class="note">This is a protected intent that can only be sent
1431 * by the system.
1432 *
1433 * {@hide}
1434 */
1435 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1436 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001437 * Broadcast Action: Indicates low memory condition on the device
Dianne Hackborn854060af2009-07-09 18:14:31 -07001438 *
1439 * <p class="note">This is a protected intent that can only be sent
1440 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001441 */
1442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1443 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1444 /**
1445 * Broadcast Action: Indicates low memory condition on the device no longer exists
Dianne Hackborn854060af2009-07-09 18:14:31 -07001446 *
1447 * <p class="note">This is a protected intent that can only be sent
1448 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001449 */
1450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1451 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1452 /**
1453 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1454 * and package management should be started.
1455 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1456 * notification.
1457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1460 /**
1461 * Broadcast Action: The device has entered USB Mass Storage mode.
1462 * This is used mainly for the USB Settings panel.
1463 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1464 * when the SD card file system is mounted or unmounted
1465 */
1466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1467 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1468
1469 /**
1470 * Broadcast Action: The device has exited USB Mass Storage mode.
1471 * This is used mainly for the USB Settings panel.
1472 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1473 * when the SD card file system is mounted or unmounted
1474 */
1475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1476 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1477
1478 /**
1479 * Broadcast Action: External media has been removed.
1480 * The path to the mount point for the removed media is contained in the Intent.mData field.
1481 */
1482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1483 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1484
1485 /**
1486 * Broadcast Action: External media is present, but not mounted at its mount point.
1487 * The path to the mount point for the removed media is contained in the Intent.mData field.
1488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1491
1492 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001493 * Broadcast Action: External media is present, and being disk-checked
1494 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1498
1499 /**
1500 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1501 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1505
1506 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001507 * Broadcast Action: External media is present and mounted at its mount point.
1508 * The path to the mount point for the removed media is contained in the Intent.mData field.
1509 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1510 * media was mounted read only.
1511 */
1512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1513 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1514
1515 /**
1516 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1517 * The path to the mount point for the removed media is contained in the Intent.mData field.
1518 */
1519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1520 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1521
1522 /**
1523 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1524 * The path to the mount point for the removed media is contained in the Intent.mData field.
1525 */
1526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1527 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1528
1529 /**
1530 * Broadcast Action: External media is present but cannot be mounted.
1531 * The path to the mount point for the removed media is contained in the Intent.mData field.
1532 */
1533 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1534 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1535
1536 /**
1537 * Broadcast Action: User has expressed the desire to remove the external storage media.
1538 * Applications should close all files they have open within the mount point when they receive this intent.
1539 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1540 */
1541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1542 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1543
1544 /**
1545 * Broadcast Action: The media scanner has started scanning a directory.
1546 * The path to the directory being scanned is contained in the Intent.mData field.
1547 */
1548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1549 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1550
1551 /**
1552 * Broadcast Action: The media scanner has finished scanning a directory.
1553 * The path to the scanned directory is contained in the Intent.mData field.
1554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1556 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1557
1558 /**
1559 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1560 * The path to the file is contained in the Intent.mData field.
1561 */
1562 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1563 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1564
1565 /**
1566 * Broadcast Action: The "Media Button" was pressed. Includes a single
1567 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1568 * caused the broadcast.
1569 */
1570 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1571 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1572
1573 /**
1574 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1575 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1576 * caused the broadcast.
1577 */
1578 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1579 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1580
1581 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1582 // location; they are not general-purpose actions.
1583
1584 /**
1585 * Broadcast Action: An GTalk connection has been established.
1586 */
1587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1588 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1589 "android.intent.action.GTALK_CONNECTED";
1590
1591 /**
1592 * Broadcast Action: An GTalk connection has been disconnected.
1593 */
1594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1595 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1596 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001597
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001598 /**
1599 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001600 */
1601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602 public static final String ACTION_INPUT_METHOD_CHANGED =
1603 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001604
1605 /**
1606 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1607 * more radios have been turned off or on. The intent will have the following extra value:</p>
1608 * <ul>
1609 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1610 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1611 * turned off</li>
1612 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001613 *
1614 * <p class="note">This is a protected intent that can only be sent
1615 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001616 */
1617 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1618 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1619
1620 /**
1621 * Broadcast Action: Some content providers have parts of their namespace
1622 * where they publish new events or items that the user may be especially
1623 * interested in. For these things, they may broadcast this action when the
1624 * set of interesting items change.
1625 *
1626 * For example, GmailProvider sends this notification when the set of unread
1627 * mail in the inbox changes.
1628 *
1629 * <p>The data of the intent identifies which part of which provider
1630 * changed. When queried through the content resolver, the data URI will
1631 * return the data set in question.
1632 *
1633 * <p>The intent will have the following extra values:
1634 * <ul>
1635 * <li><em>count</em> - The number of items in the data set. This is the
1636 * same as the number of items in the cursor returned by querying the
1637 * data URI. </li>
1638 * </ul>
1639 *
1640 * This intent will be sent at boot (if the count is non-zero) and when the
1641 * data set changes. It is possible for the data set to change without the
1642 * count changing (for example, if a new unread message arrives in the same
1643 * sync operation in which a message is archived). The phone should still
1644 * ring/vibrate/etc as normal in this case.
1645 */
1646 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1647 public static final String ACTION_PROVIDER_CHANGED =
1648 "android.intent.action.PROVIDER_CHANGED";
1649
1650 /**
1651 * Broadcast Action: Wired Headset plugged in or unplugged.
1652 *
1653 * <p>The intent will have the following extra values:
1654 * <ul>
1655 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1656 * <li><em>name</em> - Headset type, human readable string </li>
1657 * </ul>
1658 * </ul>
1659 */
1660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1661 public static final String ACTION_HEADSET_PLUG =
1662 "android.intent.action.HEADSET_PLUG";
1663
1664 /**
1665 * Broadcast Action: An outgoing call is about to be placed.
1666 *
1667 * <p>The Intent will have the following extra value:
1668 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001669 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001670 * the phone number originally intended to be dialed.</li>
1671 * </ul>
1672 * <p>Once the broadcast is finished, the resultData is used as the actual
1673 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001674 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001675 * outgoing call in turn: for example, a parental control application
1676 * might verify that the user is authorized to place the call at that
1677 * time, then a number-rewriting application might add an area code if
1678 * one was not specified.</p>
1679 * <p>For consistency, any receiver whose purpose is to prohibit phone
1680 * calls should have a priority of 0, to ensure it will see the final
1681 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001682 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001683 * should have a positive priority.
1684 * Negative priorities are reserved for the system for this broadcast;
1685 * using them may cause problems.</p>
1686 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1687 * abort the broadcast.</p>
1688 * <p>Emergency calls cannot be intercepted using this mechanism, and
1689 * other calls cannot be modified to call emergency numbers using this
1690 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001691 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001692 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1693 * permission to receive this Intent.</p>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001694 *
1695 * <p class="note">This is a protected intent that can only be sent
1696 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001697 */
1698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1699 public static final String ACTION_NEW_OUTGOING_CALL =
1700 "android.intent.action.NEW_OUTGOING_CALL";
1701
1702 /**
1703 * Broadcast Action: Have the device reboot. This is only for use by
1704 * system code.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001705 *
1706 * <p class="note">This is a protected intent that can only be sent
1707 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001708 */
1709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1710 public static final String ACTION_REBOOT =
1711 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001712
Wei Huang97ecc9c2009-05-11 17:44:20 -07001713 /**
1714 * Broadcast Action: a remote intent is to be broadcasted.
1715 *
1716 * A remote intent is used for remote RPC between devices. The remote intent
1717 * is serialized and sent from one device to another device. The receiving
1718 * device parses the remote intent and broadcasts it. Note that anyone can
1719 * broadcast a remote intent. However, if the intent receiver of the remote intent
1720 * does not trust intent broadcasts from arbitrary intent senders, it should require
1721 * the sender to hold certain permissions so only trusted sender's broadcast will be
1722 * let through.
1723 */
1724 public static final String ACTION_REMOTE_INTENT =
1725 "android.intent.action.REMOTE_INTENT";
1726
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001727 /**
1728 * Broadcast Action: hook for permforming cleanup after a system update.
1729 *
1730 * The broadcast is sent when the system is booting, before the
1731 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1732 * image. A receiver for this should do its work and then disable itself
1733 * so that it does not get run again at the next boot.
1734 * @hide
1735 */
1736 public static final String ACTION_PRE_BOOT_COMPLETED =
1737 "android.intent.action.PRE_BOOT_COMPLETED";
1738
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001739 // ---------------------------------------------------------------------
1740 // ---------------------------------------------------------------------
1741 // Standard intent categories (see addCategory()).
1742
1743 /**
1744 * Set if the activity should be an option for the default action
1745 * (center press) to perform on a piece of data. Setting this will
1746 * hide from the user any activities without it set when performing an
1747 * action on some data. Note that this is normal -not- set in the
1748 * Intent when initiating an action -- it is for use in intent filters
1749 * specified in packages.
1750 */
1751 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1752 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1753 /**
1754 * Activities that can be safely invoked from a browser must support this
1755 * category. For example, if the user is viewing a web page or an e-mail
1756 * and clicks on a link in the text, the Intent generated execute that
1757 * link will require the BROWSABLE category, so that only activities
1758 * supporting this category will be considered as possible actions. By
1759 * supporting this category, you are promising that there is nothing
1760 * damaging (without user intervention) that can happen by invoking any
1761 * matching Intent.
1762 */
1763 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1764 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1765 /**
1766 * Set if the activity should be considered as an alternative action to
1767 * the data the user is currently viewing. See also
1768 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1769 * applies to the selection in a list of items.
1770 *
1771 * <p>Supporting this category means that you would like your activity to be
1772 * displayed in the set of alternative things the user can do, usually as
1773 * part of the current activity's options menu. You will usually want to
1774 * include a specific label in the &lt;intent-filter&gt; of this action
1775 * describing to the user what it does.
1776 *
1777 * <p>The action of IntentFilter with this category is important in that it
1778 * describes the specific action the target will perform. This generally
1779 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1780 * a specific name such as "com.android.camera.action.CROP. Only one
1781 * alternative of any particular action will be shown to the user, so using
1782 * a specific action like this makes sure that your alternative will be
1783 * displayed while also allowing other applications to provide their own
1784 * overrides of that particular action.
1785 */
1786 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1787 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1788 /**
1789 * Set if the activity should be considered as an alternative selection
1790 * action to the data the user has currently selected. This is like
1791 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1792 * of items from which the user can select, giving them alternatives to the
1793 * default action that will be performed on it.
1794 */
1795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1796 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1797 /**
1798 * Intended to be used as a tab inside of an containing TabActivity.
1799 */
1800 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1801 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1802 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001803 * Should be displayed in the top-level launcher.
1804 */
1805 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1806 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1807 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001808 * Provides information about the package it is in; typically used if
1809 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1810 * a front-door to the user without having to be shown in the all apps list.
1811 */
1812 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1813 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1814 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001815 * This is the home activity, that is the first activity that is displayed
1816 * when the device boots.
1817 */
1818 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1819 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1820 /**
1821 * This activity is a preference panel.
1822 */
1823 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1824 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1825 /**
1826 * This activity is a development preference panel.
1827 */
1828 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1829 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1830 /**
1831 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 */
1833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1834 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1835 /**
1836 * This activity may be exercised by the monkey or other automated test tools.
1837 */
1838 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1839 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1840 /**
1841 * To be used as a test (not part of the normal user experience).
1842 */
1843 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1844 /**
1845 * To be used as a unit test (run through the Test Harness).
1846 */
1847 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1848 /**
1849 * To be used as an sample code example (not part of the normal user
1850 * experience).
1851 */
1852 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1853 /**
1854 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1855 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1856 * when queried, though it is allowable for those columns to be blank.
1857 */
1858 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1859 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1860
1861 /**
1862 * To be used as code under test for framework instrumentation tests.
1863 */
1864 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1865 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04001866 /**
1867 * An activity to run when device is inserted into a car dock.
1868 * Used with {@link #ACTION_MAIN} to launch an activity.
1869 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
1870 */
1871 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1872 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
1873 /**
1874 * An activity to run when device is inserted into a car dock.
1875 * Used with {@link #ACTION_MAIN} to launch an activity.
1876 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
1877 */
1878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1879 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001880
1881 /**
1882 * Broadcast Action: The phone was docked or undocked. Includes the extra
1883 * field {@link #EXTRA_DOCK_STATE}, containing the current dock state.
Mike Lockwood9092ab42009-09-16 13:01:32 -04001884 * This is intended for monitoring the current dock state.
1885 * To launch an activity from a dock state change, use {@link #CATEGORY_CAR_DOCK}
1886 * or {@link #CATEGORY_DESK_DOCK} instead.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001887 */
Mike Lockwood9092ab42009-09-16 13:01:32 -04001888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001889 public static final String ACTION_DOCK_EVENT = "android.intent.action.DOCK_EVENT";
1890
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 // ---------------------------------------------------------------------
1892 // ---------------------------------------------------------------------
1893 // Standard extra data keys.
1894
1895 /**
1896 * The initial data to place in a newly created record. Use with
1897 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1898 * fields as would be given to the underlying ContentProvider.insert()
1899 * call.
1900 */
1901 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1902
1903 /**
1904 * A constant CharSequence that is associated with the Intent, used with
1905 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1906 * this may be a styled CharSequence, so you must use
1907 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1908 * retrieve it.
1909 */
1910 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1911
1912 /**
1913 * A content: URI holding a stream of data associated with the Intent,
1914 * used with {@link #ACTION_SEND} to supply the data being sent.
1915 */
1916 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1917
1918 /**
1919 * A String[] holding e-mail addresses that should be delivered to.
1920 */
1921 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1922
1923 /**
1924 * A String[] holding e-mail addresses that should be carbon copied.
1925 */
1926 public static final String EXTRA_CC = "android.intent.extra.CC";
1927
1928 /**
1929 * A String[] holding e-mail addresses that should be blind carbon copied.
1930 */
1931 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1932
1933 /**
1934 * A constant string holding the desired subject line of a message.
1935 */
1936 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1937
1938 /**
1939 * An Intent describing the choices you would like shown with
1940 * {@link #ACTION_PICK_ACTIVITY}.
1941 */
1942 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1943
1944 /**
1945 * A CharSequence dialog title to provide to the user when used with a
1946 * {@link #ACTION_CHOOSER}.
1947 */
1948 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1949
1950 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07001951 * A Parcelable[] of {@link Intent} or
1952 * {@link android.content.pm.LabeledIntent} objects as set with
1953 * {@link #putExtra(String, Parcelable[])} of additional activities to place
1954 * a the front of the list of choices, when shown to the user with a
1955 * {@link #ACTION_CHOOSER}.
1956 */
1957 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
1958
1959 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 * A {@link android.view.KeyEvent} object containing the event that
1961 * triggered the creation of the Intent it is in.
1962 */
1963 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1964
1965 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001966 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
1967 * before shutting down.
1968 *
1969 * {@hide}
1970 */
1971 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
1972
1973 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1975 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1976 * of restarting the application.
1977 */
1978 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1979
1980 /**
1981 * A String holding the phone number originally entered in
1982 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1983 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1984 */
1985 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1986 /**
1987 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1988 * intents to supply the uid the package had been assigned. Also an optional
1989 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1990 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1991 * purpose.
1992 */
1993 public static final String EXTRA_UID = "android.intent.extra.UID";
1994
1995 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001996 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1997 * intents to indicate whether this represents a full uninstall (removing
1998 * both the code and its data) or a partial uninstall (leaving its data,
1999 * implying that this is an update).
2000 */
2001 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002002
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002003 /**
2004 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2005 * intents to indicate that this is a replacement of the package, so this
2006 * broadcast will immediately be followed by an add broadcast for a
2007 * different version of the same package.
2008 */
2009 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002010
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 * Used as an int extra field in {@link android.app.AlarmManager} intents
2013 * to tell the application being invoked how many pending alarms are being
2014 * delievered with the intent. For one-shot alarms this will always be 1.
2015 * For recurring alarms, this might be greater than 1 if the device was
2016 * asleep or powered off at the time an earlier alarm would have been
2017 * delivered.
2018 */
2019 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002020
Jacek Surazski86b6c532009-05-13 14:38:28 +02002021 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002022 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2023 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002024 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2025 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2026 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002027 */
2028 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2029
2030 /**
2031 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2032 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002033 */
2034 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2035
2036 /**
2037 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2038 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002039 */
2040 public static final int EXTRA_DOCK_STATE_DESK = 1;
2041
2042 /**
2043 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2044 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002045 */
2046 public static final int EXTRA_DOCK_STATE_CAR = 2;
2047
2048 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002049 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2050 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002051 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002052 * @hide
2053 */
2054 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2055
2056 /**
Romain Guy4969af72009-06-17 10:53:19 -07002057 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002058 * package. Specifies the installer package name; this package will receive the
2059 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002060 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002061 * @hide
2062 */
Romain Guy4969af72009-06-17 10:53:19 -07002063 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002064 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002065
Wei Huang97ecc9c2009-05-11 17:44:20 -07002066 /**
2067 * Used in the extra field in the remote intent. It's astring token passed with the
2068 * remote intent.
2069 */
2070 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2071 "android.intent.extra.remote_intent_token";
2072
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002073 /**
2074 * Used as an int extra field in {@link android.content.Intent#ACTION_PACKAGE_CHANGED}
2075 * intent to supply the name of the component that changed.
Suchi Amalapurapu32f58902009-09-02 15:36:20 -07002076 *
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002077 */
2078 public static final String EXTRA_CHANGED_COMPONENT_NAME =
2079 "android.intent.extra.changed_component_name";
2080
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002081 /**
2082 * @hide
2083 * Magic extra system code can use when binding, to give a label for
2084 * who it is that has bound to a service. This is an integer giving
2085 * a framework string resource that can be displayed to the user.
2086 */
2087 public static final String EXTRA_CLIENT_LABEL =
2088 "android.intent.extra.client_label";
2089
2090 /**
2091 * @hide
2092 * Magic extra system code can use when binding, to give a PendingIntent object
2093 * that can be launched for the user to disable the system's use of this
2094 * service.
2095 */
2096 public static final String EXTRA_CLIENT_INTENT =
2097 "android.intent.extra.client_intent";
2098
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002099 // ---------------------------------------------------------------------
2100 // ---------------------------------------------------------------------
2101 // Intent flags (see mFlags variable).
2102
2103 /**
2104 * If set, the recipient of this Intent will be granted permission to
2105 * perform read operations on the Uri in the Intent's data.
2106 */
2107 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2108 /**
2109 * If set, the recipient of this Intent will be granted permission to
2110 * perform write operations on the Uri in the Intent's data.
2111 */
2112 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2113 /**
2114 * Can be set by the caller to indicate that this Intent is coming from
2115 * a background operation, not from direct user interaction.
2116 */
2117 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2118 /**
2119 * A flag you can enable for debugging: when set, log messages will be
2120 * printed during the resolution of this intent to show you what has
2121 * been found to create the final resolved list.
2122 */
2123 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2124
2125 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002126 * If set, the new activity is not kept in the history stack. As soon as
2127 * the user navigates away from it, the activity is finished. This may also
2128 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2129 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002130 */
2131 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2132 /**
2133 * If set, the activity will not be launched if it is already running
2134 * at the top of the history stack.
2135 */
2136 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2137 /**
2138 * If set, this activity will become the start of a new task on this
2139 * history stack. A task (from the activity that started it to the
2140 * next task activity) defines an atomic group of activities that the
2141 * user can move to. Tasks can be moved to the foreground and background;
2142 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002143 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002144 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2145 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002146 *
2147 * <p>This flag is generally used by activities that want
2148 * to present a "launcher" style behavior: they give the user a list of
2149 * separate things that can be done, which otherwise run completely
2150 * independently of the activity launching them.
2151 *
2152 * <p>When using this flag, if a task is already running for the activity
2153 * you are now starting, then a new activity will not be started; instead,
2154 * the current task will simply be brought to the front of the screen with
2155 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2156 * to disable this behavior.
2157 *
2158 * <p>This flag can not be used when the caller is requesting a result from
2159 * the activity being launched.
2160 */
2161 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2162 /**
2163 * <strong>Do not use this flag unless you are implementing your own
2164 * top-level application launcher.</strong> Used in conjunction with
2165 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2166 * behavior of bringing an existing task to the foreground. When set,
2167 * a new task is <em>always</em> started to host the Activity for the
2168 * Intent, regardless of whether there is already an existing task running
2169 * the same thing.
2170 *
2171 * <p><strong>Because the default system does not include graphical task management,
2172 * you should not use this flag unless you provide some way for a user to
2173 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002174 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002175 * <p>This flag is ignored if
2176 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2177 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002178 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2179 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002180 */
2181 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2182 /**
2183 * If set, and the activity being launched is already running in the
2184 * current task, then instead of launching a new instance of that activity,
2185 * all of the other activities on top of it will be closed and this Intent
2186 * will be delivered to the (now on top) old activity as a new Intent.
2187 *
2188 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2189 * If D calls startActivity() with an Intent that resolves to the component
2190 * of activity B, then C and D will be finished and B receive the given
2191 * Intent, resulting in the stack now being: A, B.
2192 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002193 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002194 * either receive the new intent you are starting here in its
2195 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002196 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002197 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2198 * the same intent, then it will be finished and re-created; for all other
2199 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2200 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002201 *
2202 * <p>This launch mode can also be used to good effect in conjunction with
2203 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2204 * of a task, it will bring any currently running instance of that task
2205 * to the foreground, and then clear it to its root state. This is
2206 * especially useful, for example, when launching an activity from the
2207 * notification manager.
2208 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002209 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2210 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002211 */
2212 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2213 /**
2214 * If set and this intent is being used to launch a new activity from an
2215 * existing one, then the reply target of the existing activity will be
2216 * transfered to the new activity. This way the new activity can call
2217 * {@link android.app.Activity#setResult} and have that result sent back to
2218 * the reply target of the original activity.
2219 */
2220 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2221 /**
2222 * If set and this intent is being used to launch a new activity from an
2223 * existing one, the current activity will not be counted as the top
2224 * activity for deciding whether the new intent should be delivered to
2225 * the top instead of starting a new one. The previous activity will
2226 * be used as the top, with the assumption being that the current activity
2227 * will finish itself immediately.
2228 */
2229 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2230 /**
2231 * If set, the new activity is not kept in the list of recently launched
2232 * activities.
2233 */
2234 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2235 /**
2236 * This flag is not normally set by application code, but set for you by
2237 * the system as described in the
2238 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2239 * launchMode} documentation for the singleTask mode.
2240 */
2241 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2242 /**
2243 * If set, and this activity is either being started in a new task or
2244 * bringing to the top an existing task, then it will be launched as
2245 * the front door of the task. This will result in the application of
2246 * any affinities needed to have that task in the proper state (either
2247 * moving activities to or from it), or simply resetting that task to
2248 * its initial state if needed.
2249 */
2250 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2251 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002252 * This flag is not normally set by application code, but set for you by
2253 * the system if this activity is being launched from history
2254 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002255 */
2256 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002257 /**
2258 * If set, this marks a point in the task's activity stack that should
2259 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002260 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002261 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2262 * the user re-launching it from home), this activity and all on top of
2263 * it will be finished so that the user does not return to them, but
2264 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002265 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002266 * <p>This is useful for cases where you have a logical break in your
2267 * application. For example, an e-mail application may have a command
2268 * to view an attachment, which launches an image view activity to
2269 * display it. This activity should be part of the e-mail application's
2270 * task, since it is a part of the task the user is involved in. However,
2271 * if the user leaves that task, and later selects the e-mail app from
2272 * home, we may like them to return to the conversation they were
2273 * viewing, not the picture attachment, since that is confusing. By
2274 * setting this flag when launching the image viewer, that viewer and
2275 * any activities it starts will be removed the next time the user returns
2276 * to mail.
2277 */
2278 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002279 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002280 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002281 * callback from occurring on the current frontmost activity before it is
2282 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002283 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002284 * <p>Typically, an activity can rely on that callback to indicate that an
2285 * explicit user action has caused their activity to be moved out of the
2286 * foreground. The callback marks an appropriate point in the activity's
2287 * lifecycle for it to dismiss any notifications that it intends to display
2288 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002289 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002290 * <p>If an activity is ever started via any non-user-driven events such as
2291 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2292 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002293 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002294 */
2295 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002296 /**
2297 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2298 * this flag will cause the launched activity to be brought to the front of its
2299 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002300 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002301 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2302 * If D calls startActivity() with an Intent that resolves to the component
2303 * of activity B, then B will be brought to the front of the history stack,
2304 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002305 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002306 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002307 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002308 */
2309 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002310 /**
2311 * If set, when sending a broadcast only registered receivers will be
2312 * called -- no BroadcastReceiver components will be launched.
2313 */
2314 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002315 /**
2316 * If set, when sending a broadcast <i>before boot has completed</i> only
2317 * registered receivers will be called -- no BroadcastReceiver components
2318 * will be launched. Sticky intent state will be recorded properly even
2319 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2320 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002321 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322 * <p>This flag is only for use by system sevices as a convenience to
2323 * avoid having to implement a more complex mechanism around detection
2324 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002325 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002326 * @hide
2327 */
2328 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002329 /**
2330 * Set when this broadcast is for a boot upgrade, a special mode that
2331 * allows the broadcast to be sent before the system is ready and launches
2332 * the app process with no providers running in it.
2333 * @hide
2334 */
2335 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x10000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002336
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002337 /**
2338 * @hide Flags that can't be changed with PendingIntent.
2339 */
2340 public static final int IMMUTABLE_FLAGS =
2341 FLAG_GRANT_READ_URI_PERMISSION
2342 | FLAG_GRANT_WRITE_URI_PERMISSION;
2343
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002345 // ---------------------------------------------------------------------
2346 // toUri() and parseUri() options.
2347
2348 /**
2349 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2350 * always has the "intent:" scheme. This syntax can be used when you want
2351 * to later disambiguate between URIs that are intended to describe an
2352 * Intent vs. all others that should be treated as raw URIs. When used
2353 * with {@link #parseUri}, any other scheme will result in a generic
2354 * VIEW action for that raw URI.
2355 */
2356 public static final int URI_INTENT_SCHEME = 1<<0;
2357
2358 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002359
2360 private String mAction;
2361 private Uri mData;
2362 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002363 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364 private ComponentName mComponent;
2365 private int mFlags;
2366 private HashSet<String> mCategories;
2367 private Bundle mExtras;
2368
2369 // ---------------------------------------------------------------------
2370
2371 /**
2372 * Create an empty intent.
2373 */
2374 public Intent() {
2375 }
2376
2377 /**
2378 * Copy constructor.
2379 */
2380 public Intent(Intent o) {
2381 this.mAction = o.mAction;
2382 this.mData = o.mData;
2383 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002384 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002385 this.mComponent = o.mComponent;
2386 this.mFlags = o.mFlags;
2387 if (o.mCategories != null) {
2388 this.mCategories = new HashSet<String>(o.mCategories);
2389 }
2390 if (o.mExtras != null) {
2391 this.mExtras = new Bundle(o.mExtras);
2392 }
2393 }
2394
2395 @Override
2396 public Object clone() {
2397 return new Intent(this);
2398 }
2399
2400 private Intent(Intent o, boolean all) {
2401 this.mAction = o.mAction;
2402 this.mData = o.mData;
2403 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002404 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002405 this.mComponent = o.mComponent;
2406 if (o.mCategories != null) {
2407 this.mCategories = new HashSet<String>(o.mCategories);
2408 }
2409 }
2410
2411 /**
2412 * Make a clone of only the parts of the Intent that are relevant for
2413 * filter matching: the action, data, type, component, and categories.
2414 */
2415 public Intent cloneFilter() {
2416 return new Intent(this, false);
2417 }
2418
2419 /**
2420 * Create an intent with a given action. All other fields (data, type,
2421 * class) are null. Note that the action <em>must</em> be in a
2422 * namespace because Intents are used globally in the system -- for
2423 * example the system VIEW action is android.intent.action.VIEW; an
2424 * application's custom action would be something like
2425 * com.google.app.myapp.CUSTOM_ACTION.
2426 *
2427 * @param action The Intent action, such as ACTION_VIEW.
2428 */
2429 public Intent(String action) {
2430 mAction = action;
2431 }
2432
2433 /**
2434 * Create an intent with a given action and for a given data url. Note
2435 * that the action <em>must</em> be in a namespace because Intents are
2436 * used globally in the system -- for example the system VIEW action is
2437 * android.intent.action.VIEW; an application's custom action would be
2438 * something like com.google.app.myapp.CUSTOM_ACTION.
2439 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002440 * <p><em>Note: scheme and host name matching in the Android framework is
2441 * case-sensitive, unlike the formal RFC. As a result,
2442 * you should always ensure that you write your Uri with these elements
2443 * using lower case letters, and normalize any Uris you receive from
2444 * outside of Android to ensure the scheme and host is lower case.</em></p>
2445 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 * @param action The Intent action, such as ACTION_VIEW.
2447 * @param uri The Intent data URI.
2448 */
2449 public Intent(String action, Uri uri) {
2450 mAction = action;
2451 mData = uri;
2452 }
2453
2454 /**
2455 * Create an intent for a specific component. All other fields (action, data,
2456 * type, class) are null, though they can be modified later with explicit
2457 * calls. This provides a convenient way to create an intent that is
2458 * intended to execute a hard-coded class name, rather than relying on the
2459 * system to find an appropriate class for you; see {@link #setComponent}
2460 * for more information on the repercussions of this.
2461 *
2462 * @param packageContext A Context of the application package implementing
2463 * this class.
2464 * @param cls The component class that is to be used for the intent.
2465 *
2466 * @see #setClass
2467 * @see #setComponent
2468 * @see #Intent(String, android.net.Uri , Context, Class)
2469 */
2470 public Intent(Context packageContext, Class<?> cls) {
2471 mComponent = new ComponentName(packageContext, cls);
2472 }
2473
2474 /**
2475 * Create an intent for a specific component with a specified action and data.
2476 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2477 * construct the Intent and then calling {@link #setClass} to set its
2478 * class.
2479 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002480 * <p><em>Note: scheme and host name matching in the Android framework is
2481 * case-sensitive, unlike the formal RFC. As a result,
2482 * you should always ensure that you write your Uri with these elements
2483 * using lower case letters, and normalize any Uris you receive from
2484 * outside of Android to ensure the scheme and host is lower case.</em></p>
2485 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002486 * @param action The Intent action, such as ACTION_VIEW.
2487 * @param uri The Intent data URI.
2488 * @param packageContext A Context of the application package implementing
2489 * this class.
2490 * @param cls The component class that is to be used for the intent.
2491 *
2492 * @see #Intent(String, android.net.Uri)
2493 * @see #Intent(Context, Class)
2494 * @see #setClass
2495 * @see #setComponent
2496 */
2497 public Intent(String action, Uri uri,
2498 Context packageContext, Class<?> cls) {
2499 mAction = action;
2500 mData = uri;
2501 mComponent = new ComponentName(packageContext, cls);
2502 }
2503
2504 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002505 * Call {@link #parseUri} with 0 flags.
2506 * @deprecated Use {@link #parseUri} instead.
2507 */
2508 @Deprecated
2509 public static Intent getIntent(String uri) throws URISyntaxException {
2510 return parseUri(uri, 0);
2511 }
2512
2513 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002514 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002515 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002516 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002517 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002518 *
2519 * <p>The URI given here must not be relative -- that is, it must include
2520 * the scheme and full path.
2521 *
2522 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002523 * @param flags Additional processing flags. Either 0 or
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002524 *
2525 * @return Intent The newly created Intent object.
2526 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002527 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2528 * it bad (as parsed by the Uri class) or the Intent data within the
2529 * URI is invalid.
2530 *
2531 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002532 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002533 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 int i = 0;
2535 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002536 // Validate intent scheme for if requested.
2537 if ((flags&URI_INTENT_SCHEME) != 0) {
2538 if (!uri.startsWith("intent:")) {
2539 Intent intent = new Intent(ACTION_VIEW);
2540 try {
2541 intent.setData(Uri.parse(uri));
2542 } catch (IllegalArgumentException e) {
2543 throw new URISyntaxException(uri, e.getMessage());
2544 }
2545 return intent;
2546 }
2547 }
2548
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 // simple case
2550 i = uri.lastIndexOf("#");
2551 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2552
2553 // old format Intent URI
2554 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002555
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002556 // new format
2557 Intent intent = new Intent(ACTION_VIEW);
2558
2559 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002560 String data = i >= 0 ? uri.substring(0, i) : null;
2561 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002562 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002563
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 // loop over contents of Intent, all name=value;
2565 while (!uri.startsWith("end", i)) {
2566 int eq = uri.indexOf('=', i);
2567 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002568 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002569
2570 // action
2571 if (uri.startsWith("action=", i)) {
2572 intent.mAction = value;
2573 }
2574
2575 // categories
2576 else if (uri.startsWith("category=", i)) {
2577 intent.addCategory(value);
2578 }
2579
2580 // type
2581 else if (uri.startsWith("type=", i)) {
2582 intent.mType = value;
2583 }
2584
2585 // launch flags
2586 else if (uri.startsWith("launchFlags=", i)) {
2587 intent.mFlags = Integer.decode(value).intValue();
2588 }
2589
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002590 // package
2591 else if (uri.startsWith("package=", i)) {
2592 intent.mPackage = value;
2593 }
2594
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002595 // component
2596 else if (uri.startsWith("component=", i)) {
2597 intent.mComponent = ComponentName.unflattenFromString(value);
2598 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002599
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002600 // scheme
2601 else if (uri.startsWith("scheme=", i)) {
2602 scheme = value;
2603 }
2604
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 // extra
2606 else {
2607 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608 // create Bundle if it doesn't already exist
2609 if (intent.mExtras == null) intent.mExtras = new Bundle();
2610 Bundle b = intent.mExtras;
2611 // add EXTRA
2612 if (uri.startsWith("S.", i)) b.putString(key, value);
2613 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2614 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2615 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2616 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2617 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2618 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2619 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2620 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2621 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2622 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 // move to the next item
2625 i = semi + 1;
2626 }
2627
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002628 if (data != null) {
2629 if (data.startsWith("intent:")) {
2630 data = data.substring(7);
2631 if (scheme != null) {
2632 data = scheme + ':' + data;
2633 }
2634 }
2635
2636 if (data.length() > 0) {
2637 try {
2638 intent.mData = Uri.parse(data);
2639 } catch (IllegalArgumentException e) {
2640 throw new URISyntaxException(uri, e.getMessage());
2641 }
2642 }
2643 }
2644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002645 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002647 } catch (IndexOutOfBoundsException e) {
2648 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2649 }
2650 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002652 public static Intent getIntentOld(String uri) throws URISyntaxException {
2653 Intent intent;
2654
2655 int i = uri.lastIndexOf('#');
2656 if (i >= 0) {
2657 Uri data = null;
2658 String action = null;
2659 if (i > 0) {
2660 data = Uri.parse(uri.substring(0, i));
2661 }
2662
2663 i++;
2664
2665 if (uri.regionMatches(i, "action(", 0, 7)) {
2666 i += 7;
2667 int j = uri.indexOf(')', i);
2668 action = uri.substring(i, j);
2669 i = j + 1;
2670 }
2671
2672 intent = new Intent(action, data);
2673
2674 if (uri.regionMatches(i, "categories(", 0, 11)) {
2675 i += 11;
2676 int j = uri.indexOf(')', i);
2677 while (i < j) {
2678 int sep = uri.indexOf('!', i);
2679 if (sep < 0) sep = j;
2680 if (i < sep) {
2681 intent.addCategory(uri.substring(i, sep));
2682 }
2683 i = sep + 1;
2684 }
2685 i = j + 1;
2686 }
2687
2688 if (uri.regionMatches(i, "type(", 0, 5)) {
2689 i += 5;
2690 int j = uri.indexOf(')', i);
2691 intent.mType = uri.substring(i, j);
2692 i = j + 1;
2693 }
2694
2695 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2696 i += 12;
2697 int j = uri.indexOf(')', i);
2698 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2699 i = j + 1;
2700 }
2701
2702 if (uri.regionMatches(i, "component(", 0, 10)) {
2703 i += 10;
2704 int j = uri.indexOf(')', i);
2705 int sep = uri.indexOf('!', i);
2706 if (sep >= 0 && sep < j) {
2707 String pkg = uri.substring(i, sep);
2708 String cls = uri.substring(sep + 1, j);
2709 intent.mComponent = new ComponentName(pkg, cls);
2710 }
2711 i = j + 1;
2712 }
2713
2714 if (uri.regionMatches(i, "extras(", 0, 7)) {
2715 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002716
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002717 final int closeParen = uri.indexOf(')', i);
2718 if (closeParen == -1) throw new URISyntaxException(uri,
2719 "EXTRA missing trailing ')'", i);
2720
2721 while (i < closeParen) {
2722 // fetch the key value
2723 int j = uri.indexOf('=', i);
2724 if (j <= i + 1 || i >= closeParen) {
2725 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2726 }
2727 char type = uri.charAt(i);
2728 i++;
2729 String key = uri.substring(i, j);
2730 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002731
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002732 // get type-value
2733 j = uri.indexOf('!', i);
2734 if (j == -1 || j >= closeParen) j = closeParen;
2735 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2736 String value = uri.substring(i, j);
2737 i = j;
2738
2739 // create Bundle if it doesn't already exist
2740 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002741
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002742 // add item to bundle
2743 try {
2744 switch (type) {
2745 case 'S':
2746 intent.mExtras.putString(key, Uri.decode(value));
2747 break;
2748 case 'B':
2749 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2750 break;
2751 case 'b':
2752 intent.mExtras.putByte(key, Byte.parseByte(value));
2753 break;
2754 case 'c':
2755 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2756 break;
2757 case 'd':
2758 intent.mExtras.putDouble(key, Double.parseDouble(value));
2759 break;
2760 case 'f':
2761 intent.mExtras.putFloat(key, Float.parseFloat(value));
2762 break;
2763 case 'i':
2764 intent.mExtras.putInt(key, Integer.parseInt(value));
2765 break;
2766 case 'l':
2767 intent.mExtras.putLong(key, Long.parseLong(value));
2768 break;
2769 case 's':
2770 intent.mExtras.putShort(key, Short.parseShort(value));
2771 break;
2772 default:
2773 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2774 }
2775 } catch (NumberFormatException e) {
2776 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2777 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002778
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002779 char ch = uri.charAt(i);
2780 if (ch == ')') break;
2781 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2782 i++;
2783 }
2784 }
2785
2786 if (intent.mAction == null) {
2787 // By default, if no action is specified, then use VIEW.
2788 intent.mAction = ACTION_VIEW;
2789 }
2790
2791 } else {
2792 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2793 }
2794
2795 return intent;
2796 }
2797
2798 /**
2799 * Retrieve the general action to be performed, such as
2800 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2801 * the information in the intent should be interpreted -- most importantly,
2802 * what to do with the data returned by {@link #getData}.
2803 *
2804 * @return The action of this intent or null if none is specified.
2805 *
2806 * @see #setAction
2807 */
2808 public String getAction() {
2809 return mAction;
2810 }
2811
2812 /**
2813 * Retrieve data this intent is operating on. This URI specifies the name
2814 * of the data; often it uses the content: scheme, specifying data in a
2815 * content provider. Other schemes may be handled by specific activities,
2816 * such as http: by the web browser.
2817 *
2818 * @return The URI of the data this intent is targeting or null.
2819 *
2820 * @see #getScheme
2821 * @see #setData
2822 */
2823 public Uri getData() {
2824 return mData;
2825 }
2826
2827 /**
2828 * The same as {@link #getData()}, but returns the URI as an encoded
2829 * String.
2830 */
2831 public String getDataString() {
2832 return mData != null ? mData.toString() : null;
2833 }
2834
2835 /**
2836 * Return the scheme portion of the intent's data. If the data is null or
2837 * does not include a scheme, null is returned. Otherwise, the scheme
2838 * prefix without the final ':' is returned, i.e. "http".
2839 *
2840 * <p>This is the same as calling getData().getScheme() (and checking for
2841 * null data).
2842 *
2843 * @return The scheme of this intent.
2844 *
2845 * @see #getData
2846 */
2847 public String getScheme() {
2848 return mData != null ? mData.getScheme() : null;
2849 }
2850
2851 /**
2852 * Retrieve any explicit MIME type included in the intent. This is usually
2853 * null, as the type is determined by the intent data.
2854 *
2855 * @return If a type was manually set, it is returned; else null is
2856 * returned.
2857 *
2858 * @see #resolveType(ContentResolver)
2859 * @see #setType
2860 */
2861 public String getType() {
2862 return mType;
2863 }
2864
2865 /**
2866 * Return the MIME data type of this intent. If the type field is
2867 * explicitly set, that is simply returned. Otherwise, if the data is set,
2868 * the type of that data is returned. If neither fields are set, a null is
2869 * returned.
2870 *
2871 * @return The MIME type of this intent.
2872 *
2873 * @see #getType
2874 * @see #resolveType(ContentResolver)
2875 */
2876 public String resolveType(Context context) {
2877 return resolveType(context.getContentResolver());
2878 }
2879
2880 /**
2881 * Return the MIME data type of this intent. If the type field is
2882 * explicitly set, that is simply returned. Otherwise, if the data is set,
2883 * the type of that data is returned. If neither fields are set, a null is
2884 * returned.
2885 *
2886 * @param resolver A ContentResolver that can be used to determine the MIME
2887 * type of the intent's data.
2888 *
2889 * @return The MIME type of this intent.
2890 *
2891 * @see #getType
2892 * @see #resolveType(Context)
2893 */
2894 public String resolveType(ContentResolver resolver) {
2895 if (mType != null) {
2896 return mType;
2897 }
2898 if (mData != null) {
2899 if ("content".equals(mData.getScheme())) {
2900 return resolver.getType(mData);
2901 }
2902 }
2903 return null;
2904 }
2905
2906 /**
2907 * Return the MIME data type of this intent, only if it will be needed for
2908 * intent resolution. This is not generally useful for application code;
2909 * it is used by the frameworks for communicating with back-end system
2910 * services.
2911 *
2912 * @param resolver A ContentResolver that can be used to determine the MIME
2913 * type of the intent's data.
2914 *
2915 * @return The MIME type of this intent, or null if it is unknown or not
2916 * needed.
2917 */
2918 public String resolveTypeIfNeeded(ContentResolver resolver) {
2919 if (mComponent != null) {
2920 return mType;
2921 }
2922 return resolveType(resolver);
2923 }
2924
2925 /**
2926 * Check if an category exists in the intent.
2927 *
2928 * @param category The category to check.
2929 *
2930 * @return boolean True if the intent contains the category, else false.
2931 *
2932 * @see #getCategories
2933 * @see #addCategory
2934 */
2935 public boolean hasCategory(String category) {
2936 return mCategories != null && mCategories.contains(category);
2937 }
2938
2939 /**
2940 * Return the set of all categories in the intent. If there are no categories,
2941 * returns NULL.
2942 *
2943 * @return Set The set of categories you can examine. Do not modify!
2944 *
2945 * @see #hasCategory
2946 * @see #addCategory
2947 */
2948 public Set<String> getCategories() {
2949 return mCategories;
2950 }
2951
2952 /**
2953 * Sets the ClassLoader that will be used when unmarshalling
2954 * any Parcelable values from the extras of this Intent.
2955 *
2956 * @param loader a ClassLoader, or null to use the default loader
2957 * at the time of unmarshalling.
2958 */
2959 public void setExtrasClassLoader(ClassLoader loader) {
2960 if (mExtras != null) {
2961 mExtras.setClassLoader(loader);
2962 }
2963 }
2964
2965 /**
2966 * Returns true if an extra value is associated with the given name.
2967 * @param name the extra's name
2968 * @return true if the given extra is present.
2969 */
2970 public boolean hasExtra(String name) {
2971 return mExtras != null && mExtras.containsKey(name);
2972 }
2973
2974 /**
2975 * Returns true if the Intent's extras contain a parcelled file descriptor.
2976 * @return true if the Intent contains a parcelled file descriptor.
2977 */
2978 public boolean hasFileDescriptors() {
2979 return mExtras != null && mExtras.hasFileDescriptors();
2980 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 /**
2983 * Retrieve extended data from the intent.
2984 *
2985 * @param name The name of the desired item.
2986 *
2987 * @return the value of an item that previously added with putExtra()
2988 * or null if none was found.
2989 *
2990 * @deprecated
2991 * @hide
2992 */
2993 @Deprecated
2994 public Object getExtra(String name) {
2995 return getExtra(name, null);
2996 }
2997
2998 /**
2999 * Retrieve extended data from the intent.
3000 *
3001 * @param name The name of the desired item.
3002 * @param defaultValue the value to be returned if no value of the desired
3003 * type is stored with the given name.
3004 *
3005 * @return the value of an item that previously added with putExtra()
3006 * or the default value if none was found.
3007 *
3008 * @see #putExtra(String, boolean)
3009 */
3010 public boolean getBooleanExtra(String name, boolean defaultValue) {
3011 return mExtras == null ? defaultValue :
3012 mExtras.getBoolean(name, defaultValue);
3013 }
3014
3015 /**
3016 * Retrieve extended data from the intent.
3017 *
3018 * @param name The name of the desired item.
3019 * @param defaultValue the value to be returned if no value of the desired
3020 * type is stored with the given name.
3021 *
3022 * @return the value of an item that previously added with putExtra()
3023 * or the default value if none was found.
3024 *
3025 * @see #putExtra(String, byte)
3026 */
3027 public byte getByteExtra(String name, byte defaultValue) {
3028 return mExtras == null ? defaultValue :
3029 mExtras.getByte(name, defaultValue);
3030 }
3031
3032 /**
3033 * Retrieve extended data from the intent.
3034 *
3035 * @param name The name of the desired item.
3036 * @param defaultValue the value to be returned if no value of the desired
3037 * type is stored with the given name.
3038 *
3039 * @return the value of an item that previously added with putExtra()
3040 * or the default value if none was found.
3041 *
3042 * @see #putExtra(String, short)
3043 */
3044 public short getShortExtra(String name, short defaultValue) {
3045 return mExtras == null ? defaultValue :
3046 mExtras.getShort(name, defaultValue);
3047 }
3048
3049 /**
3050 * Retrieve extended data from the intent.
3051 *
3052 * @param name The name of the desired item.
3053 * @param defaultValue the value to be returned if no value of the desired
3054 * type is stored with the given name.
3055 *
3056 * @return the value of an item that previously added with putExtra()
3057 * or the default value if none was found.
3058 *
3059 * @see #putExtra(String, char)
3060 */
3061 public char getCharExtra(String name, char defaultValue) {
3062 return mExtras == null ? defaultValue :
3063 mExtras.getChar(name, defaultValue);
3064 }
3065
3066 /**
3067 * Retrieve extended data from the intent.
3068 *
3069 * @param name The name of the desired item.
3070 * @param defaultValue the value to be returned if no value of the desired
3071 * type is stored with the given name.
3072 *
3073 * @return the value of an item that previously added with putExtra()
3074 * or the default value if none was found.
3075 *
3076 * @see #putExtra(String, int)
3077 */
3078 public int getIntExtra(String name, int defaultValue) {
3079 return mExtras == null ? defaultValue :
3080 mExtras.getInt(name, defaultValue);
3081 }
3082
3083 /**
3084 * Retrieve extended data from the intent.
3085 *
3086 * @param name The name of the desired item.
3087 * @param defaultValue the value to be returned if no value of the desired
3088 * type is stored with the given name.
3089 *
3090 * @return the value of an item that previously added with putExtra()
3091 * or the default value if none was found.
3092 *
3093 * @see #putExtra(String, long)
3094 */
3095 public long getLongExtra(String name, long defaultValue) {
3096 return mExtras == null ? defaultValue :
3097 mExtras.getLong(name, defaultValue);
3098 }
3099
3100 /**
3101 * Retrieve extended data from the intent.
3102 *
3103 * @param name The name of the desired item.
3104 * @param defaultValue the value to be returned if no value of the desired
3105 * type is stored with the given name.
3106 *
3107 * @return the value of an item that previously added with putExtra(),
3108 * or the default value if no such item is present
3109 *
3110 * @see #putExtra(String, float)
3111 */
3112 public float getFloatExtra(String name, float defaultValue) {
3113 return mExtras == null ? defaultValue :
3114 mExtras.getFloat(name, defaultValue);
3115 }
3116
3117 /**
3118 * Retrieve extended data from the intent.
3119 *
3120 * @param name The name of the desired item.
3121 * @param defaultValue the value to be returned if no value of the desired
3122 * type is stored with the given name.
3123 *
3124 * @return the value of an item that previously added with putExtra()
3125 * or the default value if none was found.
3126 *
3127 * @see #putExtra(String, double)
3128 */
3129 public double getDoubleExtra(String name, double defaultValue) {
3130 return mExtras == null ? defaultValue :
3131 mExtras.getDouble(name, defaultValue);
3132 }
3133
3134 /**
3135 * Retrieve extended data from the intent.
3136 *
3137 * @param name The name of the desired item.
3138 *
3139 * @return the value of an item that previously added with putExtra()
3140 * or null if no String value was found.
3141 *
3142 * @see #putExtra(String, String)
3143 */
3144 public String getStringExtra(String name) {
3145 return mExtras == null ? null : mExtras.getString(name);
3146 }
3147
3148 /**
3149 * Retrieve extended data from the intent.
3150 *
3151 * @param name The name of the desired item.
3152 *
3153 * @return the value of an item that previously added with putExtra()
3154 * or null if no CharSequence value was found.
3155 *
3156 * @see #putExtra(String, CharSequence)
3157 */
3158 public CharSequence getCharSequenceExtra(String name) {
3159 return mExtras == null ? null : mExtras.getCharSequence(name);
3160 }
3161
3162 /**
3163 * Retrieve extended data from the intent.
3164 *
3165 * @param name The name of the desired item.
3166 *
3167 * @return the value of an item that previously added with putExtra()
3168 * or null if no Parcelable value was found.
3169 *
3170 * @see #putExtra(String, Parcelable)
3171 */
3172 public <T extends Parcelable> T getParcelableExtra(String name) {
3173 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3174 }
3175
3176 /**
3177 * Retrieve extended data from the intent.
3178 *
3179 * @param name The name of the desired item.
3180 *
3181 * @return the value of an item that previously added with putExtra()
3182 * or null if no Parcelable[] value was found.
3183 *
3184 * @see #putExtra(String, Parcelable[])
3185 */
3186 public Parcelable[] getParcelableArrayExtra(String name) {
3187 return mExtras == null ? null : mExtras.getParcelableArray(name);
3188 }
3189
3190 /**
3191 * Retrieve extended data from the intent.
3192 *
3193 * @param name The name of the desired item.
3194 *
3195 * @return the value of an item that previously added with putExtra()
3196 * or null if no ArrayList<Parcelable> value was found.
3197 *
3198 * @see #putParcelableArrayListExtra(String, ArrayList)
3199 */
3200 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3201 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3202 }
3203
3204 /**
3205 * Retrieve extended data from the intent.
3206 *
3207 * @param name The name of the desired item.
3208 *
3209 * @return the value of an item that previously added with putExtra()
3210 * or null if no Serializable value was found.
3211 *
3212 * @see #putExtra(String, Serializable)
3213 */
3214 public Serializable getSerializableExtra(String name) {
3215 return mExtras == null ? null : mExtras.getSerializable(name);
3216 }
3217
3218 /**
3219 * Retrieve extended data from the intent.
3220 *
3221 * @param name The name of the desired item.
3222 *
3223 * @return the value of an item that previously added with putExtra()
3224 * or null if no ArrayList<Integer> value was found.
3225 *
3226 * @see #putIntegerArrayListExtra(String, ArrayList)
3227 */
3228 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3229 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3230 }
3231
3232 /**
3233 * Retrieve extended data from the intent.
3234 *
3235 * @param name The name of the desired item.
3236 *
3237 * @return the value of an item that previously added with putExtra()
3238 * or null if no ArrayList<String> value was found.
3239 *
3240 * @see #putStringArrayListExtra(String, ArrayList)
3241 */
3242 public ArrayList<String> getStringArrayListExtra(String name) {
3243 return mExtras == null ? null : mExtras.getStringArrayList(name);
3244 }
3245
3246 /**
3247 * Retrieve extended data from the intent.
3248 *
3249 * @param name The name of the desired item.
3250 *
3251 * @return the value of an item that previously added with putExtra()
3252 * or null if no boolean array value was found.
3253 *
3254 * @see #putExtra(String, boolean[])
3255 */
3256 public boolean[] getBooleanArrayExtra(String name) {
3257 return mExtras == null ? null : mExtras.getBooleanArray(name);
3258 }
3259
3260 /**
3261 * Retrieve extended data from the intent.
3262 *
3263 * @param name The name of the desired item.
3264 *
3265 * @return the value of an item that previously added with putExtra()
3266 * or null if no byte array value was found.
3267 *
3268 * @see #putExtra(String, byte[])
3269 */
3270 public byte[] getByteArrayExtra(String name) {
3271 return mExtras == null ? null : mExtras.getByteArray(name);
3272 }
3273
3274 /**
3275 * Retrieve extended data from the intent.
3276 *
3277 * @param name The name of the desired item.
3278 *
3279 * @return the value of an item that previously added with putExtra()
3280 * or null if no short array value was found.
3281 *
3282 * @see #putExtra(String, short[])
3283 */
3284 public short[] getShortArrayExtra(String name) {
3285 return mExtras == null ? null : mExtras.getShortArray(name);
3286 }
3287
3288 /**
3289 * Retrieve extended data from the intent.
3290 *
3291 * @param name The name of the desired item.
3292 *
3293 * @return the value of an item that previously added with putExtra()
3294 * or null if no char array value was found.
3295 *
3296 * @see #putExtra(String, char[])
3297 */
3298 public char[] getCharArrayExtra(String name) {
3299 return mExtras == null ? null : mExtras.getCharArray(name);
3300 }
3301
3302 /**
3303 * Retrieve extended data from the intent.
3304 *
3305 * @param name The name of the desired item.
3306 *
3307 * @return the value of an item that previously added with putExtra()
3308 * or null if no int array value was found.
3309 *
3310 * @see #putExtra(String, int[])
3311 */
3312 public int[] getIntArrayExtra(String name) {
3313 return mExtras == null ? null : mExtras.getIntArray(name);
3314 }
3315
3316 /**
3317 * Retrieve extended data from the intent.
3318 *
3319 * @param name The name of the desired item.
3320 *
3321 * @return the value of an item that previously added with putExtra()
3322 * or null if no long array value was found.
3323 *
3324 * @see #putExtra(String, long[])
3325 */
3326 public long[] getLongArrayExtra(String name) {
3327 return mExtras == null ? null : mExtras.getLongArray(name);
3328 }
3329
3330 /**
3331 * Retrieve extended data from the intent.
3332 *
3333 * @param name The name of the desired item.
3334 *
3335 * @return the value of an item that previously added with putExtra()
3336 * or null if no float array value was found.
3337 *
3338 * @see #putExtra(String, float[])
3339 */
3340 public float[] getFloatArrayExtra(String name) {
3341 return mExtras == null ? null : mExtras.getFloatArray(name);
3342 }
3343
3344 /**
3345 * Retrieve extended data from the intent.
3346 *
3347 * @param name The name of the desired item.
3348 *
3349 * @return the value of an item that previously added with putExtra()
3350 * or null if no double array value was found.
3351 *
3352 * @see #putExtra(String, double[])
3353 */
3354 public double[] getDoubleArrayExtra(String name) {
3355 return mExtras == null ? null : mExtras.getDoubleArray(name);
3356 }
3357
3358 /**
3359 * Retrieve extended data from the intent.
3360 *
3361 * @param name The name of the desired item.
3362 *
3363 * @return the value of an item that previously added with putExtra()
3364 * or null if no String array value was found.
3365 *
3366 * @see #putExtra(String, String[])
3367 */
3368 public String[] getStringArrayExtra(String name) {
3369 return mExtras == null ? null : mExtras.getStringArray(name);
3370 }
3371
3372 /**
3373 * Retrieve extended data from the intent.
3374 *
3375 * @param name The name of the desired item.
3376 *
3377 * @return the value of an item that previously added with putExtra()
3378 * or null if no Bundle value was found.
3379 *
3380 * @see #putExtra(String, Bundle)
3381 */
3382 public Bundle getBundleExtra(String name) {
3383 return mExtras == null ? null : mExtras.getBundle(name);
3384 }
3385
3386 /**
3387 * Retrieve extended data from the intent.
3388 *
3389 * @param name The name of the desired item.
3390 *
3391 * @return the value of an item that previously added with putExtra()
3392 * or null if no IBinder value was found.
3393 *
3394 * @see #putExtra(String, IBinder)
3395 *
3396 * @deprecated
3397 * @hide
3398 */
3399 @Deprecated
3400 public IBinder getIBinderExtra(String name) {
3401 return mExtras == null ? null : mExtras.getIBinder(name);
3402 }
3403
3404 /**
3405 * Retrieve extended data from the intent.
3406 *
3407 * @param name The name of the desired item.
3408 * @param defaultValue The default value to return in case no item is
3409 * associated with the key 'name'
3410 *
3411 * @return the value of an item that previously added with putExtra()
3412 * or defaultValue if none was found.
3413 *
3414 * @see #putExtra
3415 *
3416 * @deprecated
3417 * @hide
3418 */
3419 @Deprecated
3420 public Object getExtra(String name, Object defaultValue) {
3421 Object result = defaultValue;
3422 if (mExtras != null) {
3423 Object result2 = mExtras.get(name);
3424 if (result2 != null) {
3425 result = result2;
3426 }
3427 }
3428
3429 return result;
3430 }
3431
3432 /**
3433 * Retrieves a map of extended data from the intent.
3434 *
3435 * @return the map of all extras previously added with putExtra(),
3436 * or null if none have been added.
3437 */
3438 public Bundle getExtras() {
3439 return (mExtras != null)
3440 ? new Bundle(mExtras)
3441 : null;
3442 }
3443
3444 /**
3445 * Retrieve any special flags associated with this intent. You will
3446 * normally just set them with {@link #setFlags} and let the system
3447 * take the appropriate action with them.
3448 *
3449 * @return int The currently set flags.
3450 *
3451 * @see #setFlags
3452 */
3453 public int getFlags() {
3454 return mFlags;
3455 }
3456
3457 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003458 * Retrieve the application package name this Intent is limited to. When
3459 * resolving an Intent, if non-null this limits the resolution to only
3460 * components in the given application package.
3461 *
3462 * @return The name of the application package for the Intent.
3463 *
3464 * @see #resolveActivity
3465 * @see #setPackage
3466 */
3467 public String getPackage() {
3468 return mPackage;
3469 }
3470
3471 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003472 * Retrieve the concrete component associated with the intent. When receiving
3473 * an intent, this is the component that was found to best handle it (that is,
3474 * yourself) and will always be non-null; in all other cases it will be
3475 * null unless explicitly set.
3476 *
3477 * @return The name of the application component to handle the intent.
3478 *
3479 * @see #resolveActivity
3480 * @see #setComponent
3481 */
3482 public ComponentName getComponent() {
3483 return mComponent;
3484 }
3485
3486 /**
3487 * Return the Activity component that should be used to handle this intent.
3488 * The appropriate component is determined based on the information in the
3489 * intent, evaluated as follows:
3490 *
3491 * <p>If {@link #getComponent} returns an explicit class, that is returned
3492 * without any further consideration.
3493 *
3494 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3495 * category to be considered.
3496 *
3497 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3498 * action.
3499 *
3500 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3501 * this type.
3502 *
3503 * <p>If {@link #addCategory} has added any categories, the activity must
3504 * handle ALL of the categories specified.
3505 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003506 * <p>If {@link #getPackage} is non-NULL, only activity components in
3507 * that application package will be considered.
3508 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 * <p>If there are no activities that satisfy all of these conditions, a
3510 * null string is returned.
3511 *
3512 * <p>If multiple activities are found to satisfy the intent, the one with
3513 * the highest priority will be used. If there are multiple activities
3514 * with the same priority, the system will either pick the best activity
3515 * based on user preference, or resolve to a system class that will allow
3516 * the user to pick an activity and forward from there.
3517 *
3518 * <p>This method is implemented simply by calling
3519 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3520 * true.</p>
3521 * <p> This API is called for you as part of starting an activity from an
3522 * intent. You do not normally need to call it yourself.</p>
3523 *
3524 * @param pm The package manager with which to resolve the Intent.
3525 *
3526 * @return Name of the component implementing an activity that can
3527 * display the intent.
3528 *
3529 * @see #setComponent
3530 * @see #getComponent
3531 * @see #resolveActivityInfo
3532 */
3533 public ComponentName resolveActivity(PackageManager pm) {
3534 if (mComponent != null) {
3535 return mComponent;
3536 }
3537
3538 ResolveInfo info = pm.resolveActivity(
3539 this, PackageManager.MATCH_DEFAULT_ONLY);
3540 if (info != null) {
3541 return new ComponentName(
3542 info.activityInfo.applicationInfo.packageName,
3543 info.activityInfo.name);
3544 }
3545
3546 return null;
3547 }
3548
3549 /**
3550 * Resolve the Intent into an {@link ActivityInfo}
3551 * describing the activity that should execute the intent. Resolution
3552 * follows the same rules as described for {@link #resolveActivity}, but
3553 * you get back the completely information about the resolved activity
3554 * instead of just its class name.
3555 *
3556 * @param pm The package manager with which to resolve the Intent.
3557 * @param flags Addition information to retrieve as per
3558 * {@link PackageManager#getActivityInfo(ComponentName, int)
3559 * PackageManager.getActivityInfo()}.
3560 *
3561 * @return PackageManager.ActivityInfo
3562 *
3563 * @see #resolveActivity
3564 */
3565 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3566 ActivityInfo ai = null;
3567 if (mComponent != null) {
3568 try {
3569 ai = pm.getActivityInfo(mComponent, flags);
3570 } catch (PackageManager.NameNotFoundException e) {
3571 // ignore
3572 }
3573 } else {
3574 ResolveInfo info = pm.resolveActivity(
3575 this, PackageManager.MATCH_DEFAULT_ONLY);
3576 if (info != null) {
3577 ai = info.activityInfo;
3578 }
3579 }
3580
3581 return ai;
3582 }
3583
3584 /**
3585 * Set the general action to be performed.
3586 *
3587 * @param action An action name, such as ACTION_VIEW. Application-specific
3588 * actions should be prefixed with the vendor's package name.
3589 *
3590 * @return Returns the same Intent object, for chaining multiple calls
3591 * into a single statement.
3592 *
3593 * @see #getAction
3594 */
3595 public Intent setAction(String action) {
3596 mAction = action;
3597 return this;
3598 }
3599
3600 /**
3601 * Set the data this intent is operating on. This method automatically
3602 * clears any type that was previously set by {@link #setType}.
3603 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003604 * <p><em>Note: scheme and host name matching in the Android framework is
3605 * case-sensitive, unlike the formal RFC. As a result,
3606 * you should always ensure that you write your Uri with these elements
3607 * using lower case letters, and normalize any Uris you receive from
3608 * outside of Android to ensure the scheme and host is lower case.</em></p>
3609 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003610 * @param data The URI of the data this intent is now targeting.
3611 *
3612 * @return Returns the same Intent object, for chaining multiple calls
3613 * into a single statement.
3614 *
3615 * @see #getData
3616 * @see #setType
3617 * @see #setDataAndType
3618 */
3619 public Intent setData(Uri data) {
3620 mData = data;
3621 mType = null;
3622 return this;
3623 }
3624
3625 /**
3626 * Set an explicit MIME data type. This is used to create intents that
3627 * only specify a type and not data, for example to indicate the type of
3628 * data to return. This method automatically clears any data that was
3629 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003630 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003631 * <p><em>Note: MIME type matching in the Android framework is
3632 * case-sensitive, unlike formal RFC MIME types. As a result,
3633 * you should always write your MIME types with lower case letters,
3634 * and any MIME types you receive from outside of Android should be
3635 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003636 *
3637 * @param type The MIME type of the data being handled by this intent.
3638 *
3639 * @return Returns the same Intent object, for chaining multiple calls
3640 * into a single statement.
3641 *
3642 * @see #getType
3643 * @see #setData
3644 * @see #setDataAndType
3645 */
3646 public Intent setType(String type) {
3647 mData = null;
3648 mType = type;
3649 return this;
3650 }
3651
3652 /**
3653 * (Usually optional) Set the data for the intent along with an explicit
3654 * MIME data type. This method should very rarely be used -- it allows you
3655 * to override the MIME type that would ordinarily be inferred from the
3656 * data with your own type given here.
3657 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003658 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3659 * Android framework is case-sensitive, unlike the formal RFC definitions.
3660 * As a result, you should always write these elements with lower case letters,
3661 * and normalize any MIME types or Uris you receive from
3662 * outside of Android to ensure these elements are lower case before
3663 * supplying them here.</em></p>
3664 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003665 * @param data The URI of the data this intent is now targeting.
3666 * @param type The MIME type of the data being handled by this intent.
3667 *
3668 * @return Returns the same Intent object, for chaining multiple calls
3669 * into a single statement.
3670 *
3671 * @see #setData
3672 * @see #setType
3673 */
3674 public Intent setDataAndType(Uri data, String type) {
3675 mData = data;
3676 mType = type;
3677 return this;
3678 }
3679
3680 /**
3681 * Add a new category to the intent. Categories provide additional detail
3682 * about the action the intent is perform. When resolving an intent, only
3683 * activities that provide <em>all</em> of the requested categories will be
3684 * used.
3685 *
3686 * @param category The desired category. This can be either one of the
3687 * predefined Intent categories, or a custom category in your own
3688 * namespace.
3689 *
3690 * @return Returns the same Intent object, for chaining multiple calls
3691 * into a single statement.
3692 *
3693 * @see #hasCategory
3694 * @see #removeCategory
3695 */
3696 public Intent addCategory(String category) {
3697 if (mCategories == null) {
3698 mCategories = new HashSet<String>();
3699 }
3700 mCategories.add(category);
3701 return this;
3702 }
3703
3704 /**
3705 * Remove an category from an intent.
3706 *
3707 * @param category The category to remove.
3708 *
3709 * @see #addCategory
3710 */
3711 public void removeCategory(String category) {
3712 if (mCategories != null) {
3713 mCategories.remove(category);
3714 if (mCategories.size() == 0) {
3715 mCategories = null;
3716 }
3717 }
3718 }
3719
3720 /**
3721 * Add extended data to the intent. The name must include a package
3722 * prefix, for example the app com.android.contacts would use names
3723 * like "com.android.contacts.ShowAll".
3724 *
3725 * @param name The name of the extra data, with package prefix.
3726 * @param value The boolean data value.
3727 *
3728 * @return Returns the same Intent object, for chaining multiple calls
3729 * into a single statement.
3730 *
3731 * @see #putExtras
3732 * @see #removeExtra
3733 * @see #getBooleanExtra(String, boolean)
3734 */
3735 public Intent putExtra(String name, boolean value) {
3736 if (mExtras == null) {
3737 mExtras = new Bundle();
3738 }
3739 mExtras.putBoolean(name, value);
3740 return this;
3741 }
3742
3743 /**
3744 * Add extended data to the intent. The name must include a package
3745 * prefix, for example the app com.android.contacts would use names
3746 * like "com.android.contacts.ShowAll".
3747 *
3748 * @param name The name of the extra data, with package prefix.
3749 * @param value The byte data value.
3750 *
3751 * @return Returns the same Intent object, for chaining multiple calls
3752 * into a single statement.
3753 *
3754 * @see #putExtras
3755 * @see #removeExtra
3756 * @see #getByteExtra(String, byte)
3757 */
3758 public Intent putExtra(String name, byte value) {
3759 if (mExtras == null) {
3760 mExtras = new Bundle();
3761 }
3762 mExtras.putByte(name, value);
3763 return this;
3764 }
3765
3766 /**
3767 * Add extended data to the intent. The name must include a package
3768 * prefix, for example the app com.android.contacts would use names
3769 * like "com.android.contacts.ShowAll".
3770 *
3771 * @param name The name of the extra data, with package prefix.
3772 * @param value The char data value.
3773 *
3774 * @return Returns the same Intent object, for chaining multiple calls
3775 * into a single statement.
3776 *
3777 * @see #putExtras
3778 * @see #removeExtra
3779 * @see #getCharExtra(String, char)
3780 */
3781 public Intent putExtra(String name, char value) {
3782 if (mExtras == null) {
3783 mExtras = new Bundle();
3784 }
3785 mExtras.putChar(name, value);
3786 return this;
3787 }
3788
3789 /**
3790 * Add extended data to the intent. The name must include a package
3791 * prefix, for example the app com.android.contacts would use names
3792 * like "com.android.contacts.ShowAll".
3793 *
3794 * @param name The name of the extra data, with package prefix.
3795 * @param value The short data value.
3796 *
3797 * @return Returns the same Intent object, for chaining multiple calls
3798 * into a single statement.
3799 *
3800 * @see #putExtras
3801 * @see #removeExtra
3802 * @see #getShortExtra(String, short)
3803 */
3804 public Intent putExtra(String name, short value) {
3805 if (mExtras == null) {
3806 mExtras = new Bundle();
3807 }
3808 mExtras.putShort(name, value);
3809 return this;
3810 }
3811
3812 /**
3813 * Add extended data to the intent. The name must include a package
3814 * prefix, for example the app com.android.contacts would use names
3815 * like "com.android.contacts.ShowAll".
3816 *
3817 * @param name The name of the extra data, with package prefix.
3818 * @param value The integer data value.
3819 *
3820 * @return Returns the same Intent object, for chaining multiple calls
3821 * into a single statement.
3822 *
3823 * @see #putExtras
3824 * @see #removeExtra
3825 * @see #getIntExtra(String, int)
3826 */
3827 public Intent putExtra(String name, int value) {
3828 if (mExtras == null) {
3829 mExtras = new Bundle();
3830 }
3831 mExtras.putInt(name, value);
3832 return this;
3833 }
3834
3835 /**
3836 * Add extended data to the intent. The name must include a package
3837 * prefix, for example the app com.android.contacts would use names
3838 * like "com.android.contacts.ShowAll".
3839 *
3840 * @param name The name of the extra data, with package prefix.
3841 * @param value The long data value.
3842 *
3843 * @return Returns the same Intent object, for chaining multiple calls
3844 * into a single statement.
3845 *
3846 * @see #putExtras
3847 * @see #removeExtra
3848 * @see #getLongExtra(String, long)
3849 */
3850 public Intent putExtra(String name, long value) {
3851 if (mExtras == null) {
3852 mExtras = new Bundle();
3853 }
3854 mExtras.putLong(name, value);
3855 return this;
3856 }
3857
3858 /**
3859 * Add extended data to the intent. The name must include a package
3860 * prefix, for example the app com.android.contacts would use names
3861 * like "com.android.contacts.ShowAll".
3862 *
3863 * @param name The name of the extra data, with package prefix.
3864 * @param value The float data value.
3865 *
3866 * @return Returns the same Intent object, for chaining multiple calls
3867 * into a single statement.
3868 *
3869 * @see #putExtras
3870 * @see #removeExtra
3871 * @see #getFloatExtra(String, float)
3872 */
3873 public Intent putExtra(String name, float value) {
3874 if (mExtras == null) {
3875 mExtras = new Bundle();
3876 }
3877 mExtras.putFloat(name, value);
3878 return this;
3879 }
3880
3881 /**
3882 * Add extended data to the intent. The name must include a package
3883 * prefix, for example the app com.android.contacts would use names
3884 * like "com.android.contacts.ShowAll".
3885 *
3886 * @param name The name of the extra data, with package prefix.
3887 * @param value The double data value.
3888 *
3889 * @return Returns the same Intent object, for chaining multiple calls
3890 * into a single statement.
3891 *
3892 * @see #putExtras
3893 * @see #removeExtra
3894 * @see #getDoubleExtra(String, double)
3895 */
3896 public Intent putExtra(String name, double value) {
3897 if (mExtras == null) {
3898 mExtras = new Bundle();
3899 }
3900 mExtras.putDouble(name, value);
3901 return this;
3902 }
3903
3904 /**
3905 * Add extended data to the intent. The name must include a package
3906 * prefix, for example the app com.android.contacts would use names
3907 * like "com.android.contacts.ShowAll".
3908 *
3909 * @param name The name of the extra data, with package prefix.
3910 * @param value The String data value.
3911 *
3912 * @return Returns the same Intent object, for chaining multiple calls
3913 * into a single statement.
3914 *
3915 * @see #putExtras
3916 * @see #removeExtra
3917 * @see #getStringExtra(String)
3918 */
3919 public Intent putExtra(String name, String value) {
3920 if (mExtras == null) {
3921 mExtras = new Bundle();
3922 }
3923 mExtras.putString(name, value);
3924 return this;
3925 }
3926
3927 /**
3928 * Add extended data to the intent. The name must include a package
3929 * prefix, for example the app com.android.contacts would use names
3930 * like "com.android.contacts.ShowAll".
3931 *
3932 * @param name The name of the extra data, with package prefix.
3933 * @param value The CharSequence data value.
3934 *
3935 * @return Returns the same Intent object, for chaining multiple calls
3936 * into a single statement.
3937 *
3938 * @see #putExtras
3939 * @see #removeExtra
3940 * @see #getCharSequenceExtra(String)
3941 */
3942 public Intent putExtra(String name, CharSequence value) {
3943 if (mExtras == null) {
3944 mExtras = new Bundle();
3945 }
3946 mExtras.putCharSequence(name, value);
3947 return this;
3948 }
3949
3950 /**
3951 * Add extended data to the intent. The name must include a package
3952 * prefix, for example the app com.android.contacts would use names
3953 * like "com.android.contacts.ShowAll".
3954 *
3955 * @param name The name of the extra data, with package prefix.
3956 * @param value The Parcelable data value.
3957 *
3958 * @return Returns the same Intent object, for chaining multiple calls
3959 * into a single statement.
3960 *
3961 * @see #putExtras
3962 * @see #removeExtra
3963 * @see #getParcelableExtra(String)
3964 */
3965 public Intent putExtra(String name, Parcelable value) {
3966 if (mExtras == null) {
3967 mExtras = new Bundle();
3968 }
3969 mExtras.putParcelable(name, value);
3970 return this;
3971 }
3972
3973 /**
3974 * Add extended data to the intent. The name must include a package
3975 * prefix, for example the app com.android.contacts would use names
3976 * like "com.android.contacts.ShowAll".
3977 *
3978 * @param name The name of the extra data, with package prefix.
3979 * @param value The Parcelable[] data value.
3980 *
3981 * @return Returns the same Intent object, for chaining multiple calls
3982 * into a single statement.
3983 *
3984 * @see #putExtras
3985 * @see #removeExtra
3986 * @see #getParcelableArrayExtra(String)
3987 */
3988 public Intent putExtra(String name, Parcelable[] value) {
3989 if (mExtras == null) {
3990 mExtras = new Bundle();
3991 }
3992 mExtras.putParcelableArray(name, value);
3993 return this;
3994 }
3995
3996 /**
3997 * Add extended data to the intent. The name must include a package
3998 * prefix, for example the app com.android.contacts would use names
3999 * like "com.android.contacts.ShowAll".
4000 *
4001 * @param name The name of the extra data, with package prefix.
4002 * @param value The ArrayList<Parcelable> data value.
4003 *
4004 * @return Returns the same Intent object, for chaining multiple calls
4005 * into a single statement.
4006 *
4007 * @see #putExtras
4008 * @see #removeExtra
4009 * @see #getParcelableArrayListExtra(String)
4010 */
4011 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4012 if (mExtras == null) {
4013 mExtras = new Bundle();
4014 }
4015 mExtras.putParcelableArrayList(name, value);
4016 return this;
4017 }
4018
4019 /**
4020 * Add extended data to the intent. The name must include a package
4021 * prefix, for example the app com.android.contacts would use names
4022 * like "com.android.contacts.ShowAll".
4023 *
4024 * @param name The name of the extra data, with package prefix.
4025 * @param value The ArrayList<Integer> data value.
4026 *
4027 * @return Returns the same Intent object, for chaining multiple calls
4028 * into a single statement.
4029 *
4030 * @see #putExtras
4031 * @see #removeExtra
4032 * @see #getIntegerArrayListExtra(String)
4033 */
4034 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4035 if (mExtras == null) {
4036 mExtras = new Bundle();
4037 }
4038 mExtras.putIntegerArrayList(name, value);
4039 return this;
4040 }
4041
4042 /**
4043 * Add extended data to the intent. The name must include a package
4044 * prefix, for example the app com.android.contacts would use names
4045 * like "com.android.contacts.ShowAll".
4046 *
4047 * @param name The name of the extra data, with package prefix.
4048 * @param value The ArrayList<String> data value.
4049 *
4050 * @return Returns the same Intent object, for chaining multiple calls
4051 * into a single statement.
4052 *
4053 * @see #putExtras
4054 * @see #removeExtra
4055 * @see #getStringArrayListExtra(String)
4056 */
4057 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4058 if (mExtras == null) {
4059 mExtras = new Bundle();
4060 }
4061 mExtras.putStringArrayList(name, value);
4062 return this;
4063 }
4064
4065 /**
4066 * Add extended data to the intent. The name must include a package
4067 * prefix, for example the app com.android.contacts would use names
4068 * like "com.android.contacts.ShowAll".
4069 *
4070 * @param name The name of the extra data, with package prefix.
4071 * @param value The Serializable data value.
4072 *
4073 * @return Returns the same Intent object, for chaining multiple calls
4074 * into a single statement.
4075 *
4076 * @see #putExtras
4077 * @see #removeExtra
4078 * @see #getSerializableExtra(String)
4079 */
4080 public Intent putExtra(String name, Serializable value) {
4081 if (mExtras == null) {
4082 mExtras = new Bundle();
4083 }
4084 mExtras.putSerializable(name, value);
4085 return this;
4086 }
4087
4088 /**
4089 * Add extended data to the intent. The name must include a package
4090 * prefix, for example the app com.android.contacts would use names
4091 * like "com.android.contacts.ShowAll".
4092 *
4093 * @param name The name of the extra data, with package prefix.
4094 * @param value The boolean array data value.
4095 *
4096 * @return Returns the same Intent object, for chaining multiple calls
4097 * into a single statement.
4098 *
4099 * @see #putExtras
4100 * @see #removeExtra
4101 * @see #getBooleanArrayExtra(String)
4102 */
4103 public Intent putExtra(String name, boolean[] value) {
4104 if (mExtras == null) {
4105 mExtras = new Bundle();
4106 }
4107 mExtras.putBooleanArray(name, value);
4108 return this;
4109 }
4110
4111 /**
4112 * Add extended data to the intent. The name must include a package
4113 * prefix, for example the app com.android.contacts would use names
4114 * like "com.android.contacts.ShowAll".
4115 *
4116 * @param name The name of the extra data, with package prefix.
4117 * @param value The byte array data value.
4118 *
4119 * @return Returns the same Intent object, for chaining multiple calls
4120 * into a single statement.
4121 *
4122 * @see #putExtras
4123 * @see #removeExtra
4124 * @see #getByteArrayExtra(String)
4125 */
4126 public Intent putExtra(String name, byte[] value) {
4127 if (mExtras == null) {
4128 mExtras = new Bundle();
4129 }
4130 mExtras.putByteArray(name, value);
4131 return this;
4132 }
4133
4134 /**
4135 * Add extended data to the intent. The name must include a package
4136 * prefix, for example the app com.android.contacts would use names
4137 * like "com.android.contacts.ShowAll".
4138 *
4139 * @param name The name of the extra data, with package prefix.
4140 * @param value The short array data value.
4141 *
4142 * @return Returns the same Intent object, for chaining multiple calls
4143 * into a single statement.
4144 *
4145 * @see #putExtras
4146 * @see #removeExtra
4147 * @see #getShortArrayExtra(String)
4148 */
4149 public Intent putExtra(String name, short[] value) {
4150 if (mExtras == null) {
4151 mExtras = new Bundle();
4152 }
4153 mExtras.putShortArray(name, value);
4154 return this;
4155 }
4156
4157 /**
4158 * Add extended data to the intent. The name must include a package
4159 * prefix, for example the app com.android.contacts would use names
4160 * like "com.android.contacts.ShowAll".
4161 *
4162 * @param name The name of the extra data, with package prefix.
4163 * @param value The char array data value.
4164 *
4165 * @return Returns the same Intent object, for chaining multiple calls
4166 * into a single statement.
4167 *
4168 * @see #putExtras
4169 * @see #removeExtra
4170 * @see #getCharArrayExtra(String)
4171 */
4172 public Intent putExtra(String name, char[] value) {
4173 if (mExtras == null) {
4174 mExtras = new Bundle();
4175 }
4176 mExtras.putCharArray(name, value);
4177 return this;
4178 }
4179
4180 /**
4181 * Add extended data to the intent. The name must include a package
4182 * prefix, for example the app com.android.contacts would use names
4183 * like "com.android.contacts.ShowAll".
4184 *
4185 * @param name The name of the extra data, with package prefix.
4186 * @param value The int array data value.
4187 *
4188 * @return Returns the same Intent object, for chaining multiple calls
4189 * into a single statement.
4190 *
4191 * @see #putExtras
4192 * @see #removeExtra
4193 * @see #getIntArrayExtra(String)
4194 */
4195 public Intent putExtra(String name, int[] value) {
4196 if (mExtras == null) {
4197 mExtras = new Bundle();
4198 }
4199 mExtras.putIntArray(name, value);
4200 return this;
4201 }
4202
4203 /**
4204 * Add extended data to the intent. The name must include a package
4205 * prefix, for example the app com.android.contacts would use names
4206 * like "com.android.contacts.ShowAll".
4207 *
4208 * @param name The name of the extra data, with package prefix.
4209 * @param value The byte array data value.
4210 *
4211 * @return Returns the same Intent object, for chaining multiple calls
4212 * into a single statement.
4213 *
4214 * @see #putExtras
4215 * @see #removeExtra
4216 * @see #getLongArrayExtra(String)
4217 */
4218 public Intent putExtra(String name, long[] value) {
4219 if (mExtras == null) {
4220 mExtras = new Bundle();
4221 }
4222 mExtras.putLongArray(name, value);
4223 return this;
4224 }
4225
4226 /**
4227 * Add extended data to the intent. The name must include a package
4228 * prefix, for example the app com.android.contacts would use names
4229 * like "com.android.contacts.ShowAll".
4230 *
4231 * @param name The name of the extra data, with package prefix.
4232 * @param value The float array data value.
4233 *
4234 * @return Returns the same Intent object, for chaining multiple calls
4235 * into a single statement.
4236 *
4237 * @see #putExtras
4238 * @see #removeExtra
4239 * @see #getFloatArrayExtra(String)
4240 */
4241 public Intent putExtra(String name, float[] value) {
4242 if (mExtras == null) {
4243 mExtras = new Bundle();
4244 }
4245 mExtras.putFloatArray(name, value);
4246 return this;
4247 }
4248
4249 /**
4250 * Add extended data to the intent. The name must include a package
4251 * prefix, for example the app com.android.contacts would use names
4252 * like "com.android.contacts.ShowAll".
4253 *
4254 * @param name The name of the extra data, with package prefix.
4255 * @param value The double array data value.
4256 *
4257 * @return Returns the same Intent object, for chaining multiple calls
4258 * into a single statement.
4259 *
4260 * @see #putExtras
4261 * @see #removeExtra
4262 * @see #getDoubleArrayExtra(String)
4263 */
4264 public Intent putExtra(String name, double[] value) {
4265 if (mExtras == null) {
4266 mExtras = new Bundle();
4267 }
4268 mExtras.putDoubleArray(name, value);
4269 return this;
4270 }
4271
4272 /**
4273 * Add extended data to the intent. The name must include a package
4274 * prefix, for example the app com.android.contacts would use names
4275 * like "com.android.contacts.ShowAll".
4276 *
4277 * @param name The name of the extra data, with package prefix.
4278 * @param value The String array data value.
4279 *
4280 * @return Returns the same Intent object, for chaining multiple calls
4281 * into a single statement.
4282 *
4283 * @see #putExtras
4284 * @see #removeExtra
4285 * @see #getStringArrayExtra(String)
4286 */
4287 public Intent putExtra(String name, String[] value) {
4288 if (mExtras == null) {
4289 mExtras = new Bundle();
4290 }
4291 mExtras.putStringArray(name, value);
4292 return this;
4293 }
4294
4295 /**
4296 * Add extended data to the intent. The name must include a package
4297 * prefix, for example the app com.android.contacts would use names
4298 * like "com.android.contacts.ShowAll".
4299 *
4300 * @param name The name of the extra data, with package prefix.
4301 * @param value The Bundle data value.
4302 *
4303 * @return Returns the same Intent object, for chaining multiple calls
4304 * into a single statement.
4305 *
4306 * @see #putExtras
4307 * @see #removeExtra
4308 * @see #getBundleExtra(String)
4309 */
4310 public Intent putExtra(String name, Bundle value) {
4311 if (mExtras == null) {
4312 mExtras = new Bundle();
4313 }
4314 mExtras.putBundle(name, value);
4315 return this;
4316 }
4317
4318 /**
4319 * Add extended data to the intent. The name must include a package
4320 * prefix, for example the app com.android.contacts would use names
4321 * like "com.android.contacts.ShowAll".
4322 *
4323 * @param name The name of the extra data, with package prefix.
4324 * @param value The IBinder data value.
4325 *
4326 * @return Returns the same Intent object, for chaining multiple calls
4327 * into a single statement.
4328 *
4329 * @see #putExtras
4330 * @see #removeExtra
4331 * @see #getIBinderExtra(String)
4332 *
4333 * @deprecated
4334 * @hide
4335 */
4336 @Deprecated
4337 public Intent putExtra(String name, IBinder value) {
4338 if (mExtras == null) {
4339 mExtras = new Bundle();
4340 }
4341 mExtras.putIBinder(name, value);
4342 return this;
4343 }
4344
4345 /**
4346 * Copy all extras in 'src' in to this intent.
4347 *
4348 * @param src Contains the extras to copy.
4349 *
4350 * @see #putExtra
4351 */
4352 public Intent putExtras(Intent src) {
4353 if (src.mExtras != null) {
4354 if (mExtras == null) {
4355 mExtras = new Bundle(src.mExtras);
4356 } else {
4357 mExtras.putAll(src.mExtras);
4358 }
4359 }
4360 return this;
4361 }
4362
4363 /**
4364 * Add a set of extended data to the intent. The keys must include a package
4365 * prefix, for example the app com.android.contacts would use names
4366 * like "com.android.contacts.ShowAll".
4367 *
4368 * @param extras The Bundle of extras to add to this intent.
4369 *
4370 * @see #putExtra
4371 * @see #removeExtra
4372 */
4373 public Intent putExtras(Bundle extras) {
4374 if (mExtras == null) {
4375 mExtras = new Bundle();
4376 }
4377 mExtras.putAll(extras);
4378 return this;
4379 }
4380
4381 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004382 * Completely replace the extras in the Intent with the extras in the
4383 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004384 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004385 * @param src The exact extras contained in this Intent are copied
4386 * into the target intent, replacing any that were previously there.
4387 */
4388 public Intent replaceExtras(Intent src) {
4389 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4390 return this;
4391 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004392
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004393 /**
4394 * Completely replace the extras in the Intent with the given Bundle of
4395 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004396 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004397 * @param extras The new set of extras in the Intent, or null to erase
4398 * all extras.
4399 */
4400 public Intent replaceExtras(Bundle extras) {
4401 mExtras = extras != null ? new Bundle(extras) : null;
4402 return this;
4403 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004404
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004405 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004406 * Remove extended data from the intent.
4407 *
4408 * @see #putExtra
4409 */
4410 public void removeExtra(String name) {
4411 if (mExtras != null) {
4412 mExtras.remove(name);
4413 if (mExtras.size() == 0) {
4414 mExtras = null;
4415 }
4416 }
4417 }
4418
4419 /**
4420 * Set special flags controlling how this intent is handled. Most values
4421 * here depend on the type of component being executed by the Intent,
4422 * specifically the FLAG_ACTIVITY_* flags are all for use with
4423 * {@link Context#startActivity Context.startActivity()} and the
4424 * FLAG_RECEIVER_* flags are all for use with
4425 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4426 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004427 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4428 * Activities and Tasks</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004429 * the behavior of your application.
4430 *
4431 * @param flags The desired flags.
4432 *
4433 * @return Returns the same Intent object, for chaining multiple calls
4434 * into a single statement.
4435 *
4436 * @see #getFlags
4437 * @see #addFlags
4438 *
4439 * @see #FLAG_GRANT_READ_URI_PERMISSION
4440 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4441 * @see #FLAG_DEBUG_LOG_RESOLUTION
4442 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004443 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004444 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004445 * @see #FLAG_ACTIVITY_CLEAR_TOP
4446 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4447 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004448 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004449 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4450 * @see #FLAG_ACTIVITY_NEW_TASK
4451 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004452 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004453 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4454 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004455 * @see #FLAG_ACTIVITY_SINGLE_TOP
4456 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4457 */
4458 public Intent setFlags(int flags) {
4459 mFlags = flags;
4460 return this;
4461 }
4462
4463 /**
4464 * Add additional flags to the intent (or with existing flags
4465 * value).
4466 *
4467 * @param flags The new flags to set.
4468 *
4469 * @return Returns the same Intent object, for chaining multiple calls
4470 * into a single statement.
4471 *
4472 * @see #setFlags
4473 */
4474 public Intent addFlags(int flags) {
4475 mFlags |= flags;
4476 return this;
4477 }
4478
4479 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004480 * (Usually optional) Set an explicit application package name that limits
4481 * the components this Intent will resolve to. If left to the default
4482 * value of null, all components in all applications will considered.
4483 * If non-null, the Intent can only match the components in the given
4484 * application package.
4485 *
4486 * @param packageName The name of the application package to handle the
4487 * intent, or null to allow any application package.
4488 *
4489 * @return Returns the same Intent object, for chaining multiple calls
4490 * into a single statement.
4491 *
4492 * @see #getPackage
4493 * @see #resolveActivity
4494 */
4495 public Intent setPackage(String packageName) {
4496 mPackage = packageName;
4497 return this;
4498 }
4499
4500 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004501 * (Usually optional) Explicitly set the component to handle the intent.
4502 * If left with the default value of null, the system will determine the
4503 * appropriate class to use based on the other fields (action, data,
4504 * type, categories) in the Intent. If this class is defined, the
4505 * specified class will always be used regardless of the other fields. You
4506 * should only set this value when you know you absolutely want a specific
4507 * class to be used; otherwise it is better to let the system find the
4508 * appropriate class so that you will respect the installed applications
4509 * and user preferences.
4510 *
4511 * @param component The name of the application component to handle the
4512 * intent, or null to let the system find one for you.
4513 *
4514 * @return Returns the same Intent object, for chaining multiple calls
4515 * into a single statement.
4516 *
4517 * @see #setClass
4518 * @see #setClassName(Context, String)
4519 * @see #setClassName(String, String)
4520 * @see #getComponent
4521 * @see #resolveActivity
4522 */
4523 public Intent setComponent(ComponentName component) {
4524 mComponent = component;
4525 return this;
4526 }
4527
4528 /**
4529 * Convenience for calling {@link #setComponent} with an
4530 * explicit class name.
4531 *
4532 * @param packageContext A Context of the application package implementing
4533 * this class.
4534 * @param className The name of a class inside of the application package
4535 * that will be used as the component for this Intent.
4536 *
4537 * @return Returns the same Intent object, for chaining multiple calls
4538 * into a single statement.
4539 *
4540 * @see #setComponent
4541 * @see #setClass
4542 */
4543 public Intent setClassName(Context packageContext, String className) {
4544 mComponent = new ComponentName(packageContext, className);
4545 return this;
4546 }
4547
4548 /**
4549 * Convenience for calling {@link #setComponent} with an
4550 * explicit application package name and class name.
4551 *
4552 * @param packageName The name of the package implementing the desired
4553 * component.
4554 * @param className The name of a class inside of the application package
4555 * that will be used as the component for this Intent.
4556 *
4557 * @return Returns the same Intent object, for chaining multiple calls
4558 * into a single statement.
4559 *
4560 * @see #setComponent
4561 * @see #setClass
4562 */
4563 public Intent setClassName(String packageName, String className) {
4564 mComponent = new ComponentName(packageName, className);
4565 return this;
4566 }
4567
4568 /**
4569 * Convenience for calling {@link #setComponent(ComponentName)} with the
4570 * name returned by a {@link Class} object.
4571 *
4572 * @param packageContext A Context of the application package implementing
4573 * this class.
4574 * @param cls The class name to set, equivalent to
4575 * <code>setClassName(context, cls.getName())</code>.
4576 *
4577 * @return Returns the same Intent object, for chaining multiple calls
4578 * into a single statement.
4579 *
4580 * @see #setComponent
4581 */
4582 public Intent setClass(Context packageContext, Class<?> cls) {
4583 mComponent = new ComponentName(packageContext, cls);
4584 return this;
4585 }
4586
4587 /**
4588 * Use with {@link #fillIn} to allow the current action value to be
4589 * overwritten, even if it is already set.
4590 */
4591 public static final int FILL_IN_ACTION = 1<<0;
4592
4593 /**
4594 * Use with {@link #fillIn} to allow the current data or type value
4595 * overwritten, even if it is already set.
4596 */
4597 public static final int FILL_IN_DATA = 1<<1;
4598
4599 /**
4600 * Use with {@link #fillIn} to allow the current categories to be
4601 * overwritten, even if they are already set.
4602 */
4603 public static final int FILL_IN_CATEGORIES = 1<<2;
4604
4605 /**
4606 * Use with {@link #fillIn} to allow the current component value to be
4607 * overwritten, even if it is already set.
4608 */
4609 public static final int FILL_IN_COMPONENT = 1<<3;
4610
4611 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004612 * Use with {@link #fillIn} to allow the current package value to be
4613 * overwritten, even if it is already set.
4614 */
4615 public static final int FILL_IN_PACKAGE = 1<<4;
4616
4617 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004618 * Copy the contents of <var>other</var> in to this object, but only
4619 * where fields are not defined by this object. For purposes of a field
4620 * being defined, the following pieces of data in the Intent are
4621 * considered to be separate fields:
4622 *
4623 * <ul>
4624 * <li> action, as set by {@link #setAction}.
4625 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4626 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4627 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004628 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004629 * <li> component, as set by {@link #setComponent(ComponentName)} or
4630 * related methods.
4631 * <li> each top-level name in the associated extras.
4632 * </ul>
4633 *
4634 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004635 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4636 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004637 * corresponding field will not be replaced if it is already set.
4638 *
Brett Chabot3e391752009-07-21 16:07:23 -07004639 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4640 * specified.
4641 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4643 * and Intent B with {action="gotit", data-type="some/thing",
4644 * categories="one","two"}.
4645 *
4646 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4647 * containing: {action="gotit", data-type="some/thing",
4648 * categories="bar"}.
4649 *
4650 * @param other Another Intent whose values are to be used to fill in
4651 * the current one.
4652 * @param flags Options to control which fields can be filled in.
4653 *
4654 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004655 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4656 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 */
4658 public int fillIn(Intent other, int flags) {
4659 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004660 if (other.mAction != null
4661 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662 mAction = other.mAction;
4663 changes |= FILL_IN_ACTION;
4664 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004665 if ((other.mData != null || other.mType != null)
4666 && ((mData == null && mType == null)
4667 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004668 mData = other.mData;
4669 mType = other.mType;
4670 changes |= FILL_IN_DATA;
4671 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004672 if (other.mCategories != null
4673 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004674 if (other.mCategories != null) {
4675 mCategories = new HashSet<String>(other.mCategories);
4676 }
4677 changes |= FILL_IN_CATEGORIES;
4678 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004679 if (other.mPackage != null
4680 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4681 mPackage = other.mPackage;
4682 changes |= FILL_IN_PACKAGE;
4683 }
4684 // Component is special: it can -only- be set if explicitly allowed,
4685 // since otherwise the sender could force the intent somewhere the
4686 // originator didn't intend.
4687 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004688 mComponent = other.mComponent;
4689 changes |= FILL_IN_COMPONENT;
4690 }
4691 mFlags |= other.mFlags;
4692 if (mExtras == null) {
4693 if (other.mExtras != null) {
4694 mExtras = new Bundle(other.mExtras);
4695 }
4696 } else if (other.mExtras != null) {
4697 try {
4698 Bundle newb = new Bundle(other.mExtras);
4699 newb.putAll(mExtras);
4700 mExtras = newb;
4701 } catch (RuntimeException e) {
4702 // Modifying the extras can cause us to unparcel the contents
4703 // of the bundle, and if we do this in the system process that
4704 // may fail. We really should handle this (i.e., the Bundle
4705 // impl shouldn't be on top of a plain map), but for now just
4706 // ignore it and keep the original contents. :(
4707 Log.w("Intent", "Failure filling in extras", e);
4708 }
4709 }
4710 return changes;
4711 }
4712
4713 /**
4714 * Wrapper class holding an Intent and implementing comparisons on it for
4715 * the purpose of filtering. The class implements its
4716 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4717 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4718 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4719 * on the wrapped Intent.
4720 */
4721 public static final class FilterComparison {
4722 private final Intent mIntent;
4723 private final int mHashCode;
4724
4725 public FilterComparison(Intent intent) {
4726 mIntent = intent;
4727 mHashCode = intent.filterHashCode();
4728 }
4729
4730 /**
4731 * Return the Intent that this FilterComparison represents.
4732 * @return Returns the Intent held by the FilterComparison. Do
4733 * not modify!
4734 */
4735 public Intent getIntent() {
4736 return mIntent;
4737 }
4738
4739 @Override
4740 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004741 if (obj instanceof FilterComparison) {
4742 Intent other = ((FilterComparison)obj).mIntent;
4743 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004744 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004745 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004746 }
4747
4748 @Override
4749 public int hashCode() {
4750 return mHashCode;
4751 }
4752 }
4753
4754 /**
4755 * Determine if two intents are the same for the purposes of intent
4756 * resolution (filtering). That is, if their action, data, type,
4757 * class, and categories are the same. This does <em>not</em> compare
4758 * any extra data included in the intents.
4759 *
4760 * @param other The other Intent to compare against.
4761 *
4762 * @return Returns true if action, data, type, class, and categories
4763 * are the same.
4764 */
4765 public boolean filterEquals(Intent other) {
4766 if (other == null) {
4767 return false;
4768 }
4769 if (mAction != other.mAction) {
4770 if (mAction != null) {
4771 if (!mAction.equals(other.mAction)) {
4772 return false;
4773 }
4774 } else {
4775 if (!other.mAction.equals(mAction)) {
4776 return false;
4777 }
4778 }
4779 }
4780 if (mData != other.mData) {
4781 if (mData != null) {
4782 if (!mData.equals(other.mData)) {
4783 return false;
4784 }
4785 } else {
4786 if (!other.mData.equals(mData)) {
4787 return false;
4788 }
4789 }
4790 }
4791 if (mType != other.mType) {
4792 if (mType != null) {
4793 if (!mType.equals(other.mType)) {
4794 return false;
4795 }
4796 } else {
4797 if (!other.mType.equals(mType)) {
4798 return false;
4799 }
4800 }
4801 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004802 if (mPackage != other.mPackage) {
4803 if (mPackage != null) {
4804 if (!mPackage.equals(other.mPackage)) {
4805 return false;
4806 }
4807 } else {
4808 if (!other.mPackage.equals(mPackage)) {
4809 return false;
4810 }
4811 }
4812 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004813 if (mComponent != other.mComponent) {
4814 if (mComponent != null) {
4815 if (!mComponent.equals(other.mComponent)) {
4816 return false;
4817 }
4818 } else {
4819 if (!other.mComponent.equals(mComponent)) {
4820 return false;
4821 }
4822 }
4823 }
4824 if (mCategories != other.mCategories) {
4825 if (mCategories != null) {
4826 if (!mCategories.equals(other.mCategories)) {
4827 return false;
4828 }
4829 } else {
4830 if (!other.mCategories.equals(mCategories)) {
4831 return false;
4832 }
4833 }
4834 }
4835
4836 return true;
4837 }
4838
4839 /**
4840 * Generate hash code that matches semantics of filterEquals().
4841 *
4842 * @return Returns the hash value of the action, data, type, class, and
4843 * categories.
4844 *
4845 * @see #filterEquals
4846 */
4847 public int filterHashCode() {
4848 int code = 0;
4849 if (mAction != null) {
4850 code += mAction.hashCode();
4851 }
4852 if (mData != null) {
4853 code += mData.hashCode();
4854 }
4855 if (mType != null) {
4856 code += mType.hashCode();
4857 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004858 if (mPackage != null) {
4859 code += mPackage.hashCode();
4860 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004861 if (mComponent != null) {
4862 code += mComponent.hashCode();
4863 }
4864 if (mCategories != null) {
4865 code += mCategories.hashCode();
4866 }
4867 return code;
4868 }
4869
4870 @Override
4871 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004872 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004874 b.append("Intent { ");
4875 toShortString(b, true, true);
4876 b.append(" }");
4877
4878 return b.toString();
4879 }
4880
4881 /** @hide */
4882 public String toShortString(boolean comp, boolean extras) {
4883 StringBuilder b = new StringBuilder(128);
4884 toShortString(b, comp, extras);
4885 return b.toString();
4886 }
Romain Guy4969af72009-06-17 10:53:19 -07004887
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004888 /** @hide */
4889 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4890 boolean first = true;
4891 if (mAction != null) {
4892 b.append("act=").append(mAction);
4893 first = false;
4894 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004895 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004896 if (!first) {
4897 b.append(' ');
4898 }
4899 first = false;
4900 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004901 Iterator<String> i = mCategories.iterator();
4902 boolean didone = false;
4903 while (i.hasNext()) {
4904 if (didone) b.append(",");
4905 didone = true;
4906 b.append(i.next());
4907 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004908 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004909 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004910 if (mData != null) {
4911 if (!first) {
4912 b.append(' ');
4913 }
4914 first = false;
4915 b.append("dat=").append(mData);
4916 }
4917 if (mType != null) {
4918 if (!first) {
4919 b.append(' ');
4920 }
4921 first = false;
4922 b.append("typ=").append(mType);
4923 }
4924 if (mFlags != 0) {
4925 if (!first) {
4926 b.append(' ');
4927 }
4928 first = false;
4929 b.append("flg=0x").append(Integer.toHexString(mFlags));
4930 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004931 if (mPackage != null) {
4932 if (!first) {
4933 b.append(' ');
4934 }
4935 first = false;
4936 b.append("pkg=").append(mPackage);
4937 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004938 if (comp && mComponent != null) {
4939 if (!first) {
4940 b.append(' ');
4941 }
4942 first = false;
4943 b.append("cmp=").append(mComponent.flattenToShortString());
4944 }
4945 if (extras && mExtras != null) {
4946 if (!first) {
4947 b.append(' ');
4948 }
4949 first = false;
4950 b.append("(has extras)");
4951 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004952 }
4953
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004954 /**
4955 * Call {@link #toUri} with 0 flags.
4956 * @deprecated Use {@link #toUri} instead.
4957 */
4958 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004959 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004960 return toUri(0);
4961 }
4962
4963 /**
4964 * Convert this Intent into a String holding a URI representation of it.
4965 * The returned URI string has been properly URI encoded, so it can be
4966 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
4967 * Intent's data as the base URI, with an additional fragment describing
4968 * the action, categories, type, flags, package, component, and extras.
4969 *
4970 * <p>You can convert the returned string back to an Intent with
4971 * {@link #getIntent}.
4972 *
4973 * @param flags Additional operating flags. Either 0 or
4974 * {@link #URI_INTENT_SCHEME}.
4975 *
4976 * @return Returns a URI encoding URI string describing the entire contents
4977 * of the Intent.
4978 */
4979 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004980 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004981 String scheme = null;
4982 if (mData != null) {
4983 String data = mData.toString();
4984 if ((flags&URI_INTENT_SCHEME) != 0) {
4985 final int N = data.length();
4986 for (int i=0; i<N; i++) {
4987 char c = data.charAt(i);
4988 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
4989 || c == '.' || c == '-') {
4990 continue;
4991 }
4992 if (c == ':' && i > 0) {
4993 // Valid scheme.
4994 scheme = data.substring(0, i);
4995 uri.append("intent:");
4996 data = data.substring(i+1);
4997 break;
4998 }
4999
5000 // No scheme.
5001 break;
5002 }
5003 }
5004 uri.append(data);
5005
5006 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5007 uri.append("intent:");
5008 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005009
5010 uri.append("#Intent;");
5011
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005012 if (scheme != null) {
5013 uri.append("scheme=").append(scheme).append(';');
5014 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005015 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005016 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 }
5018 if (mCategories != null) {
5019 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005020 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 }
5022 }
5023 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005024 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005025 }
5026 if (mFlags != 0) {
5027 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5028 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005029 if (mPackage != null) {
5030 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5031 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005032 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005033 uri.append("component=").append(Uri.encode(
5034 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005035 }
5036 if (mExtras != null) {
5037 for (String key : mExtras.keySet()) {
5038 final Object value = mExtras.get(key);
5039 char entryType =
5040 value instanceof String ? 'S' :
5041 value instanceof Boolean ? 'B' :
5042 value instanceof Byte ? 'b' :
5043 value instanceof Character ? 'c' :
5044 value instanceof Double ? 'd' :
5045 value instanceof Float ? 'f' :
5046 value instanceof Integer ? 'i' :
5047 value instanceof Long ? 'l' :
5048 value instanceof Short ? 's' :
5049 '\0';
5050
5051 if (entryType != '\0') {
5052 uri.append(entryType);
5053 uri.append('.');
5054 uri.append(Uri.encode(key));
5055 uri.append('=');
5056 uri.append(Uri.encode(value.toString()));
5057 uri.append(';');
5058 }
5059 }
5060 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005061
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005062 uri.append("end");
5063
5064 return uri.toString();
5065 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005066
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005067 public int describeContents() {
5068 return (mExtras != null) ? mExtras.describeContents() : 0;
5069 }
5070
5071 public void writeToParcel(Parcel out, int flags) {
5072 out.writeString(mAction);
5073 Uri.writeToParcel(out, mData);
5074 out.writeString(mType);
5075 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005076 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005077 ComponentName.writeToParcel(mComponent, out);
5078
5079 if (mCategories != null) {
5080 out.writeInt(mCategories.size());
5081 for (String category : mCategories) {
5082 out.writeString(category);
5083 }
5084 } else {
5085 out.writeInt(0);
5086 }
5087
5088 out.writeBundle(mExtras);
5089 }
5090
5091 public static final Parcelable.Creator<Intent> CREATOR
5092 = new Parcelable.Creator<Intent>() {
5093 public Intent createFromParcel(Parcel in) {
5094 return new Intent(in);
5095 }
5096 public Intent[] newArray(int size) {
5097 return new Intent[size];
5098 }
5099 };
5100
Dianne Hackborneb034652009-09-07 00:49:58 -07005101 /** @hide */
5102 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103 readFromParcel(in);
5104 }
5105
5106 public void readFromParcel(Parcel in) {
5107 mAction = in.readString();
5108 mData = Uri.CREATOR.createFromParcel(in);
5109 mType = in.readString();
5110 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005111 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 mComponent = ComponentName.readFromParcel(in);
5113
5114 int N = in.readInt();
5115 if (N > 0) {
5116 mCategories = new HashSet<String>();
5117 int i;
5118 for (i=0; i<N; i++) {
5119 mCategories.add(in.readString());
5120 }
5121 } else {
5122 mCategories = null;
5123 }
5124
5125 mExtras = in.readBundle();
5126 }
5127
5128 /**
5129 * Parses the "intent" element (and its children) from XML and instantiates
5130 * an Intent object. The given XML parser should be located at the tag
5131 * where parsing should start (often named "intent"), from which the
5132 * basic action, data, type, and package and class name will be
5133 * retrieved. The function will then parse in to any child elements,
5134 * looking for <category android:name="xxx"> tags to add categories and
5135 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5136 * to the intent.
5137 *
5138 * @param resources The Resources to use when inflating resources.
5139 * @param parser The XML parser pointing at an "intent" tag.
5140 * @param attrs The AttributeSet interface for retrieving extended
5141 * attribute data at the current <var>parser</var> location.
5142 * @return An Intent object matching the XML data.
5143 * @throws XmlPullParserException If there was an XML parsing error.
5144 * @throws IOException If there was an I/O error.
5145 */
5146 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5147 throws XmlPullParserException, IOException {
5148 Intent intent = new Intent();
5149
5150 TypedArray sa = resources.obtainAttributes(attrs,
5151 com.android.internal.R.styleable.Intent);
5152
5153 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5154
5155 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5156 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5157 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5158
5159 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5160 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5161 if (packageName != null && className != null) {
5162 intent.setComponent(new ComponentName(packageName, className));
5163 }
5164
5165 sa.recycle();
5166
5167 int outerDepth = parser.getDepth();
5168 int type;
5169 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5170 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5171 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5172 continue;
5173 }
5174
5175 String nodeName = parser.getName();
5176 if (nodeName.equals("category")) {
5177 sa = resources.obtainAttributes(attrs,
5178 com.android.internal.R.styleable.IntentCategory);
5179 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5180 sa.recycle();
5181
5182 if (cat != null) {
5183 intent.addCategory(cat);
5184 }
5185 XmlUtils.skipCurrentTag(parser);
5186
5187 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005188 if (intent.mExtras == null) {
5189 intent.mExtras = new Bundle();
5190 }
5191 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5192 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005193
5194 } else {
5195 XmlUtils.skipCurrentTag(parser);
5196 }
5197 }
5198
5199 return intent;
5200 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005201}