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