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