blob: c053ace7e1baaaad181a981fb2d5c6cabd0fb6c2 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
29import android.net.Uri;
30import android.os.Bundle;
31import android.os.IBinder;
32import android.os.Parcel;
33import android.os.Parcelable;
34import android.util.AttributeSet;
35import android.util.Log;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import com.android.internal.util.XmlUtils;
37
38import java.io.IOException;
39import java.io.Serializable;
40import java.net.URISyntaxException;
41import java.util.ArrayList;
42import java.util.HashSet;
43import java.util.Iterator;
44import java.util.Set;
45
46/**
47 * An intent is an abstract description of an operation to be performed. It
48 * can be used with {@link Context#startActivity(Intent) startActivity} to
49 * launch an {@link android.app.Activity},
50 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
51 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
52 * and {@link android.content.Context#startService} or
53 * {@link android.content.Context#bindService} to communicate with a
54 * background {@link android.app.Service}.
55 *
56 * <p>An Intent provides a facility for performing late runtime binding between
57 * the code in different applications. Its most significant use is in the
58 * launching of activities, where it can be thought of as the glue between
59 * activities. It is
60 * basically a passive data structure holding an abstract description of an
61 * action to be performed. The primary pieces of information in an intent
62 * are:</p>
63 *
64 * <ul>
65 * <li> <p><b>action</b> -- The general action to be performed, such as
66 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
67 * etc.</p>
68 * </li>
69 * <li> <p><b>data</b> -- The data to operate on, such as a person record
70 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
71 * </li>
72 * </ul>
73 *
74 *
75 * <p>Some examples of action/data pairs are:</p>
76 *
77 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070078 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070079 * information about the person whose identifier is "1".</p>
80 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070081 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070082 * the phone dialer with the person filled in.</p>
83 * </li>
84 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
85 * the phone dialer with the given number filled in. Note how the
86 * VIEW action does what what is considered the most reasonable thing for
87 * a particular URI.</p>
88 * </li>
89 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
90 * the phone dialer with the given number filled in.</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * information about the person whose identifier is "1".</p>
94 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070095 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070096 * a list of people, which the user can browse through. This example is a
97 * typical top-level entry into the Contacts application, showing you the
98 * list of people. Selecting a particular person to view would result in a
99 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
100 * being used to start an activity to display that person.</p>
101 * </li>
102 * </ul>
103 *
104 * <p>In addition to these primary attributes, there are a number of secondary
105 * attributes that you can also include with an intent:</p>
106 *
107 * <ul>
108 * <li> <p><b>category</b> -- Gives additional information about the action
109 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
110 * appear in the Launcher as a top-level application, while
111 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
112 * of alternative actions the user can perform on a piece of data.</p>
113 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
114 * intent data. Normally the type is inferred from the data itself.
115 * By setting this attribute, you disable that evaluation and force
116 * an explicit type.</p>
117 * <li> <p><b>component</b> -- Specifies an explicit name of a component
118 * class to use for the intent. Normally this is determined by looking
119 * at the other information in the intent (the action, data/type, and
120 * categories) and matching that with a component that can handle it.
121 * If this attribute is set then none of the evaluation is performed,
122 * and this component is used exactly as is. By specifying this attribute,
123 * all of the other Intent attributes become optional.</p>
124 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
125 * This can be used to provide extended information to the component.
126 * For example, if we have a action to send an e-mail message, we could
127 * also include extra pieces of data here to supply a subject, body,
128 * etc.</p>
129 * </ul>
130 *
131 * <p>Here are some examples of other operations you can specify as intents
132 * using these additional parameters:</p>
133 *
134 * <ul>
135 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
136 * Launch the home screen.</p>
137 * </li>
138 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
139 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
140 * vnd.android.cursor.item/phone}</i></b>
141 * -- Display the list of people's phone numbers, allowing the user to
142 * browse through them and pick one and return it to the parent activity.</p>
143 * </li>
144 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
145 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
146 * -- Display all pickers for data that can be opened with
147 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
148 * allowing the user to pick one of them and then some data inside of it
149 * and returning the resulting URI to the caller. This can be used,
150 * for example, in an e-mail application to allow the user to pick some
151 * data to include as an attachment.</p>
152 * </li>
153 * </ul>
154 *
155 * <p>There are a variety of standard Intent action and category constants
156 * defined in the Intent class, but applications can also define their own.
157 * These strings use java style scoping, to ensure they are unique -- for
158 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700159 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700160 *
161 * <p>Put together, the set of actions, data types, categories, and extra data
162 * defines a language for the system allowing for the expression of phrases
163 * such as "call john smith's cell". As applications are added to the system,
164 * they can extend this language by adding new actions, types, and categories, or
165 * they can modify the behavior of existing phrases by supplying their own
166 * activities that handle them.</p>
167 *
168 * <a name="IntentResolution"></a>
169 * <h3>Intent Resolution</h3>
170 *
171 * <p>There are two primary forms of intents you will use.
172 *
173 * <ul>
174 * <li> <p><b>Explicit Intents</b> have specified a component (via
175 * {@link #setComponent} or {@link #setClass}), which provides the exact
176 * class to be run. Often these will not include any other information,
177 * simply being a way for an application to launch various internal
178 * activities it has as the user interacts with the application.
179 *
180 * <li> <p><b>Implicit Intents</b> have not specified a component;
181 * instead, they must include enough information for the system to
182 * determine which of the available components is best to run for that
183 * intent.
184 * </ul>
185 *
186 * <p>When using implicit intents, given such an arbitrary intent we need to
187 * know what to do with it. This is handled by the process of <em>Intent
188 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
189 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
190 * more activities/receivers) that can handle it.</p>
191 *
192 * <p>The intent resolution mechanism basically revolves around matching an
193 * Intent against all of the &lt;intent-filter&gt; descriptions in the
194 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
195 * objects explicitly registered with {@link Context#registerReceiver}.) More
196 * details on this can be found in the documentation on the {@link
197 * IntentFilter} class.</p>
198 *
199 * <p>There are three pieces of information in the Intent that are used for
200 * resolution: the action, type, and category. Using this information, a query
201 * is done on the {@link PackageManager} for a component that can handle the
202 * intent. The appropriate component is determined based on the intent
203 * information supplied in the <code>AndroidManifest.xml</code> file as
204 * follows:</p>
205 *
206 * <ul>
207 * <li> <p>The <b>action</b>, if given, must be listed by the component as
208 * one it handles.</p>
209 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
210 * already supplied in the Intent. Like the action, if a type is
211 * included in the intent (either explicitly or implicitly in its
212 * data), then this must be listed by the component as one it handles.</p>
213 * <li> For data that is not a <code>content:</code> URI and where no explicit
214 * type is included in the Intent, instead the <b>scheme</b> of the
215 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
216 * considered. Again like the action, if we are matching a scheme it
217 * must be listed by the component as one it can handle.
218 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
219 * by the activity as categories it handles. That is, if you include
220 * the categories {@link #CATEGORY_LAUNCHER} and
221 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
222 * with an intent that lists <em>both</em> of those categories.
223 * Activities will very often need to support the
224 * {@link #CATEGORY_DEFAULT} so that they can be found by
225 * {@link Context#startActivity Context.startActivity()}.</p>
226 * </ul>
227 *
228 * <p>For example, consider the Note Pad sample application that
229 * allows user to browse through a list of notes data and view details about
230 * individual items. Text in italics indicate places were you would replace a
231 * name with one specific to your own package.</p>
232 *
233 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
234 * package="<i>com.android.notepad</i>"&gt;
235 * &lt;application android:icon="@drawable/app_notes"
236 * android:label="@string/app_name"&gt;
237 *
238 * &lt;provider class=".NotePadProvider"
239 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
240 *
241 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
242 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700243 * &lt;action android:name="android.intent.action.MAIN" /&gt;
244 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700245 * &lt;/intent-filter&gt;
246 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700247 * &lt;action android:name="android.intent.action.VIEW" /&gt;
248 * &lt;action android:name="android.intent.action.EDIT" /&gt;
249 * &lt;action android:name="android.intent.action.PICK" /&gt;
250 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
251 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700252 * &lt;/intent-filter&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
255 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
256 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700257 * &lt;/intent-filter&gt;
258 * &lt;/activity&gt;
259 *
260 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
261 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.VIEW" /&gt;
263 * &lt;action android:name="android.intent.action.EDIT" /&gt;
264 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
265 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700266 * &lt;/intent-filter&gt;
267 *
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.INSERT" /&gt;
270 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
271 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700272 * &lt;/intent-filter&gt;
273 *
274 * &lt;/activity&gt;
275 *
276 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
277 * android:theme="@android:style/Theme.Dialog"&gt;
278 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
280 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
281 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
282 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;/activity&gt;
286 *
287 * &lt;/application&gt;
288 * &lt;/manifest&gt;</pre>
289 *
290 * <p>The first activity,
291 * <code>com.android.notepad.NotesList</code>, serves as our main
292 * entry into the app. It can do three things as described by its three intent
293 * templates:
294 * <ol>
295 * <li><pre>
296 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
298 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700299 * &lt;/intent-filter&gt;</pre>
300 * <p>This provides a top-level entry into the NotePad application: the standard
301 * MAIN action is a main entry point (not requiring any other information in
302 * the Intent), and the LAUNCHER category says that this entry point should be
303 * listed in the application launcher.</p>
304 * <li><pre>
305 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700306 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
307 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
308 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
310 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;</pre>
312 * <p>This declares the things that the activity can do on a directory of
313 * notes. The type being supported is given with the &lt;type&gt; tag, where
314 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
315 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
316 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
317 * The activity allows the user to view or edit the directory of data (via
318 * the VIEW and EDIT actions), or to pick a particular note and return it
319 * to the caller (via the PICK action). Note also the DEFAULT category
320 * supplied here: this is <em>required</em> for the
321 * {@link Context#startActivity Context.startActivity} method to resolve your
322 * activity when its component name is not explicitly specified.</p>
323 * <li><pre>
324 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700325 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
326 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
327 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700328 * &lt;/intent-filter&gt;</pre>
329 * <p>This filter describes the ability return to the caller a note selected by
330 * the user without needing to know where it came from. The data type
331 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
332 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
333 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
334 * The GET_CONTENT action is similar to the PICK action, where the activity
335 * will return to its caller a piece of data selected by the user. Here,
336 * however, the caller specifies the type of data they desire instead of
337 * the type of data the user will be picking from.</p>
338 * </ol>
339 *
340 * <p>Given these capabilities, the following intents will resolve to the
341 * NotesList activity:</p>
342 *
343 * <ul>
344 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
345 * activities that can be used as top-level entry points into an
346 * application.</p>
347 * <li> <p><b>{ action=android.app.action.MAIN,
348 * category=android.app.category.LAUNCHER }</b> is the actual intent
349 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700350 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * data=content://com.google.provider.NotePad/notes }</b>
352 * displays a list of all the notes under
353 * "content://com.google.provider.NotePad/notes", which
354 * the user can browse through and see the details on.</p>
355 * <li> <p><b>{ action=android.app.action.PICK
356 * data=content://com.google.provider.NotePad/notes }</b>
357 * provides a list of the notes under
358 * "content://com.google.provider.NotePad/notes", from which
359 * the user can pick a note whose data URL is returned back to the caller.</p>
360 * <li> <p><b>{ action=android.app.action.GET_CONTENT
361 * type=vnd.android.cursor.item/vnd.google.note }</b>
362 * is similar to the pick action, but allows the caller to specify the
363 * kind of data they want back so that the system can find the appropriate
364 * activity to pick something of that data type.</p>
365 * </ul>
366 *
367 * <p>The second activity,
368 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
369 * note entry and allows them to edit it. It can do two things as described
370 * by its two intent templates:
371 * <ol>
372 * <li><pre>
373 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700374 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
375 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
376 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
377 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700378 * &lt;/intent-filter&gt;</pre>
379 * <p>The first, primary, purpose of this activity is to let the user interact
380 * with a single note, as decribed by the MIME type
381 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
382 * either VIEW a note or allow the user to EDIT it. Again we support the
383 * DEFAULT category to allow the activity to be launched without explicitly
384 * specifying its component.</p>
385 * <li><pre>
386 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700387 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * &lt;/intent-filter&gt;</pre>
391 * <p>The secondary use of this activity is to insert a new note entry into
392 * an existing directory of notes. This is used when the user creates a new
393 * note: the INSERT action is executed on the directory of notes, causing
394 * this activity to run and have the user create the new note data which
395 * it then adds to the content provider.</p>
396 * </ol>
397 *
398 * <p>Given these capabilities, the following intents will resolve to the
399 * NoteEditor activity:</p>
400 *
401 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700402 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700403 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
404 * shows the user the content of note <var>{ID}</var>.</p>
405 * <li> <p><b>{ action=android.app.action.EDIT
406 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
407 * allows the user to edit the content of note <var>{ID}</var>.</p>
408 * <li> <p><b>{ action=android.app.action.INSERT
409 * data=content://com.google.provider.NotePad/notes }</b>
410 * creates a new, empty note in the notes list at
411 * "content://com.google.provider.NotePad/notes"
412 * and allows the user to edit it. If they keep their changes, the URI
413 * of the newly created note is returned to the caller.</p>
414 * </ul>
415 *
416 * <p>The last activity,
417 * <code>com.android.notepad.TitleEditor</code>, allows the user to
418 * edit the title of a note. This could be implemented as a class that the
419 * application directly invokes (by explicitly setting its component in
420 * the Intent), but here we show a way you can publish alternative
421 * operations on existing data:</p>
422 *
423 * <pre>
424 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700425 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
426 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
429 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700430 * &lt;/intent-filter&gt;</pre>
431 *
432 * <p>In the single intent template here, we
433 * have created our own private action called
434 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
435 * edit the title of a note. It must be invoked on a specific note
436 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
437 * view and edit actions, but here displays and edits the title contained
438 * in the note data.
439 *
440 * <p>In addition to supporting the default category as usual, our title editor
441 * also supports two other standard categories: ALTERNATIVE and
442 * SELECTED_ALTERNATIVE. Implementing
443 * these categories allows others to find the special action it provides
444 * without directly knowing about it, through the
445 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
446 * more often to build dynamic menu items with
447 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
448 * template here was also supply an explicit name for the template
449 * (via <code>android:label="@string/resolve_title"</code>) to better control
450 * what the user sees when presented with this activity as an alternative
451 * action to the data they are viewing.
452 *
453 * <p>Given these capabilities, the following intent will resolve to the
454 * TitleEditor activity:</p>
455 *
456 * <ul>
457 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
458 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
459 * displays and allows the user to edit the title associated
460 * with note <var>{ID}</var>.</p>
461 * </ul>
462 *
463 * <h3>Standard Activity Actions</h3>
464 *
465 * <p>These are the current standard actions that Intent defines for launching
466 * activities (usually through {@link Context#startActivity}. The most
467 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
468 * {@link #ACTION_EDIT}.
469 *
470 * <ul>
471 * <li> {@link #ACTION_MAIN}
472 * <li> {@link #ACTION_VIEW}
473 * <li> {@link #ACTION_ATTACH_DATA}
474 * <li> {@link #ACTION_EDIT}
475 * <li> {@link #ACTION_PICK}
476 * <li> {@link #ACTION_CHOOSER}
477 * <li> {@link #ACTION_GET_CONTENT}
478 * <li> {@link #ACTION_DIAL}
479 * <li> {@link #ACTION_CALL}
480 * <li> {@link #ACTION_SEND}
481 * <li> {@link #ACTION_SENDTO}
482 * <li> {@link #ACTION_ANSWER}
483 * <li> {@link #ACTION_INSERT}
484 * <li> {@link #ACTION_DELETE}
485 * <li> {@link #ACTION_RUN}
486 * <li> {@link #ACTION_SYNC}
487 * <li> {@link #ACTION_PICK_ACTIVITY}
488 * <li> {@link #ACTION_SEARCH}
489 * <li> {@link #ACTION_WEB_SEARCH}
490 * <li> {@link #ACTION_FACTORY_TEST}
491 * </ul>
492 *
493 * <h3>Standard Broadcast Actions</h3>
494 *
495 * <p>These are the current standard actions that Intent defines for receiving
496 * broadcasts (usually through {@link Context#registerReceiver} or a
497 * &lt;receiver&gt; tag in a manifest).
498 *
499 * <ul>
500 * <li> {@link #ACTION_TIME_TICK}
501 * <li> {@link #ACTION_TIME_CHANGED}
502 * <li> {@link #ACTION_TIMEZONE_CHANGED}
503 * <li> {@link #ACTION_BOOT_COMPLETED}
504 * <li> {@link #ACTION_PACKAGE_ADDED}
505 * <li> {@link #ACTION_PACKAGE_CHANGED}
506 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 * <li> {@link #ACTION_PACKAGE_RESTARTED}
508 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700509 * <li> {@link #ACTION_UID_REMOVED}
510 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700511 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700512 * <li> {@link #ACTION_POWER_DISCONNECTED}
513 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700514 * </ul>
515 *
516 * <h3>Standard Categories</h3>
517 *
518 * <p>These are the current standard categories that can be used to further
519 * clarify an Intent via {@link #addCategory}.
520 *
521 * <ul>
522 * <li> {@link #CATEGORY_DEFAULT}
523 * <li> {@link #CATEGORY_BROWSABLE}
524 * <li> {@link #CATEGORY_TAB}
525 * <li> {@link #CATEGORY_ALTERNATIVE}
526 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
527 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800528 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700529 * <li> {@link #CATEGORY_HOME}
530 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_TEST}
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
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800549 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
550 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 */
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";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800565
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700566 /**
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";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800579
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700580 /**
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;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800585
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 /**
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";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800596
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 /**
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";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800604
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 /**
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";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800615
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 /**
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";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 /**
626 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 * <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
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800631 * (value: ShortcutIconResource).</p>
632 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 * @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 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800670 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700671 *
672 * @see Intent#ACTION_CREATE_SHORTCUT
673 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800674 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
675 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 */
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>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800926 * Multiple types are supported, and receivers should handle mixed types
927 * whenever possible. The right way for the receiver to check them is to
928 * use the content resolver on each URI. The intent sender should try to
929 * put the most concrete mime type in the intent type, but it can fall
930 * back to {@literal <type>/*} or {@literal *}/* as needed.
931 * <p>
932 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
933 * be image/jpg, but if you are sending image/jpg and image/png, then the
934 * intent's type should be image/*.
935 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800936 * Optional standard extras, which may be interpreted by some recipients as
937 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
938 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
939 * <p>
940 * Output: nothing.
941 */
942 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
943 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
944 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700945 * Activity Action: Handle an incoming phone call.
946 * <p>Input: nothing.
947 * <p>Output: nothing.
948 */
949 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
950 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
951 /**
952 * Activity Action: Insert an empty item into the given container.
953 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
954 * in which to place the data.
955 * <p>Output: URI of the new data that was created.
956 */
957 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
958 public static final String ACTION_INSERT = "android.intent.action.INSERT";
959 /**
960 * Activity Action: Delete the given data from its container.
961 * <p>Input: {@link #getData} is URI of data to be deleted.
962 * <p>Output: nothing.
963 */
964 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
965 public static final String ACTION_DELETE = "android.intent.action.DELETE";
966 /**
967 * Activity Action: Run the data, whatever that means.
968 * <p>Input: ? (Note: this is currently specific to the test harness.)
969 * <p>Output: nothing.
970 */
971 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
972 public static final String ACTION_RUN = "android.intent.action.RUN";
973 /**
974 * Activity Action: Perform a data synchronization.
975 * <p>Input: ?
976 * <p>Output: ?
977 */
978 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
979 public static final String ACTION_SYNC = "android.intent.action.SYNC";
980 /**
981 * Activity Action: Pick an activity given an intent, returning the class
982 * selected.
983 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
984 * used with {@link PackageManager#queryIntentActivities} to determine the
985 * set of activities from which to pick.
986 * <p>Output: Class name of the activity that was selected.
987 */
988 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
989 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
990 /**
991 * Activity Action: Perform a search.
992 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
993 * is the text to search for. If empty, simply
994 * enter your search results Activity with the search UI activated.
995 * <p>Output: nothing.
996 */
997 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
998 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
999 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001000 * Activity Action: Start the platform-defined tutorial
1001 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1002 * is the text to search for. If empty, simply
1003 * enter your search results Activity with the search UI activated.
1004 * <p>Output: nothing.
1005 */
1006 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1007 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001009 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001010 * <p>
1011 * Input: {@link android.app.SearchManager#QUERY
1012 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1013 * a url starts with http or https, the site will be opened. If it is plain
1014 * text, Google search will be applied.
1015 * <p>
1016 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1020 /**
1021 * Activity Action: List all available applications
1022 * <p>Input: Nothing.
1023 * <p>Output: nothing.
1024 */
1025 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1026 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1027 /**
1028 * Activity Action: Show settings for choosing wallpaper
1029 * <p>Input: Nothing.
1030 * <p>Output: Nothing.
1031 */
1032 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1033 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1034
1035 /**
1036 * Activity Action: Show activity for reporting a bug.
1037 * <p>Input: Nothing.
1038 * <p>Output: Nothing.
1039 */
1040 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1041 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1042
1043 /**
1044 * Activity Action: Main entry point for factory tests. Only used when
1045 * the device is booting in factory test node. The implementing package
1046 * must be installed in the system image.
1047 * <p>Input: nothing
1048 * <p>Output: nothing
1049 */
1050 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1051
1052 /**
1053 * Activity Action: The user pressed the "call" button to go to the dialer
1054 * or other appropriate UI for placing a call.
1055 * <p>Input: Nothing.
1056 * <p>Output: Nothing.
1057 */
1058 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1059 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1060
1061 /**
1062 * Activity Action: Start Voice Command.
1063 * <p>Input: Nothing.
1064 * <p>Output: Nothing.
1065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001068
1069 /**
1070 * Activity Action: Start action associated with long pressing on the
1071 * search key.
1072 * <p>Input: Nothing.
1073 * <p>Output: Nothing.
1074 */
1075 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1076 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001077
Jacek Surazski86b6c532009-05-13 14:38:28 +02001078 /**
1079 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1080 * This intent is delivered to the package which installed the application, usually
1081 * the Market.
1082 * <p>Input: No data is specified. The bug report is passed in using
1083 * an {@link #EXTRA_BUG_REPORT} field.
1084 * <p>Output: Nothing.
1085 * @hide
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001089
1090 /**
1091 * Activity Action: Show power usage information to the user.
1092 * <p>Input: Nothing.
1093 * <p>Output: Nothing.
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1097
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001098 /**
1099 * Activity Action: Setup wizard to launch after a platform update. This
1100 * activity should have a string meta-data field associated with it,
1101 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1102 * the platform for setup. The activity will be launched only if
1103 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1104 * same value.
1105 * <p>Input: Nothing.
1106 * <p>Output: Nothing.
1107 * @hide
1108 */
1109 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1110 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1111
1112 /**
1113 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1114 * describing the last run version of the platform that was setup.
1115 * @hide
1116 */
1117 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1118
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001119 // ---------------------------------------------------------------------
1120 // ---------------------------------------------------------------------
1121 // Standard intent broadcast actions (see action variable).
1122
1123 /**
1124 * Broadcast Action: Sent after the screen turns off.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001125 *
1126 * <p class="note">This is a protected intent that can only be sent
1127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001128 */
1129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1130 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1131 /**
1132 * Broadcast Action: Sent after the screen turns on.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001133 *
1134 * <p class="note">This is a protected intent that can only be sent
1135 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001136 */
1137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1138 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001139
1140 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001141 * 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 -07001142 * keyguard is gone).
Dianne Hackborn854060af2009-07-09 18:14:31 -07001143 *
1144 * <p class="note">This is a protected intent that can only be sent
1145 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001146 */
1147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1148 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 /**
1151 * Broadcast Action: The current time has changed. Sent every
1152 * minute. You can <em>not</em> receive this through components declared
1153 * in manifests, only by exlicitly registering for it with
1154 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1155 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001156 *
1157 * <p class="note">This is a protected intent that can only be sent
1158 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001159 */
1160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1161 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1162 /**
1163 * Broadcast Action: The time was set.
1164 */
1165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1166 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1167 /**
1168 * Broadcast Action: The date has changed.
1169 */
1170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1171 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1172 /**
1173 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1174 * <ul>
1175 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1176 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001177 *
1178 * <p class="note">This is a protected intent that can only be sent
1179 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001180 */
1181 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1182 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1183 /**
1184 * Alarm Changed Action: This is broadcast when the AlarmClock
1185 * application's alarm is set or unset. It is used by the
1186 * AlarmClock application and the StatusBar service.
1187 * @hide
1188 */
1189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1190 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1191 /**
1192 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1193 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1194 * @hide
1195 */
1196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1197 public static final String ACTION_SYNC_STATE_CHANGED
1198 = "android.intent.action.SYNC_STATE_CHANGED";
1199 /**
1200 * Broadcast Action: This is broadcast once, after the system has finished
1201 * booting. It can be used to perform application-specific initialization,
1202 * such as installing alarms. You must hold the
1203 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1204 * in order to receive this broadcast.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001205 *
1206 * <p class="note">This is a protected intent that can only be sent
1207 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001208 */
1209 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1210 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1211 /**
1212 * Broadcast Action: This is broadcast when a user action should request a
1213 * temporary system dialog to dismiss. Some examples of temporary system
1214 * dialogs are the notification window-shade and the recent tasks dialog.
1215 */
1216 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1217 /**
1218 * Broadcast Action: Trigger the download and eventual installation
1219 * of a package.
1220 * <p>Input: {@link #getData} is the URI of the package file to download.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001221 *
1222 * <p class="note">This is a protected intent that can only be sent
1223 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001224 */
1225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1226 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1227 /**
1228 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001229 * device. The data contains the name of the package. Note that the
1230 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001231 * <p>My include the following extras:
1232 * <ul>
1233 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1234 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1235 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1236 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001237 *
1238 * <p class="note">This is a protected intent that can only be sent
1239 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001240 */
1241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1242 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1243 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001244 * Broadcast Action: A new version of an application package has been
1245 * installed, replacing an existing version that was previously installed.
1246 * The data contains the name of the package.
1247 * <p>My include the following extras:
1248 * <ul>
1249 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1250 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001251 *
1252 * <p class="note">This is a protected intent that can only be sent
1253 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001254 */
1255 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1256 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1257 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001258 * Broadcast Action: An existing application package has been removed from
1259 * the device. The data contains the name of the package. The package
1260 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001261 * <ul>
1262 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1263 * to the package.
1264 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1265 * application -- data and code -- is being removed.
1266 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1267 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1268 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001269 *
1270 * <p class="note">This is a protected intent that can only be sent
1271 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001272 */
1273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1274 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1275 /**
1276 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1277 * enabled or disabled. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001278 * <ul>
1279 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07001280 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME} containing the class name of the changed component.
1281 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001282 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001283 *
1284 * <p class="note">This is a protected intent that can only be sent
1285 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001286 */
1287 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1288 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1289 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001290 * Broadcast Action: The user has restarted a package, and all of its
1291 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001292 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001293 * be removed. Note that the restarted package does <em>not</em>
1294 * receive this broadcast.
1295 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001296 * <ul>
1297 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1298 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001299 *
1300 * <p class="note">This is a protected intent that can only be sent
1301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 */
1303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1304 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1305 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001306 * Broadcast Action: The user has cleared the data of a package. This should
1307 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001308 * its persistent data is erased and this broadcast sent.
1309 * Note that the cleared package does <em>not</em>
1310 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 * <ul>
1312 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1313 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001314 *
1315 * <p class="note">This is a protected intent that can only be sent
1316 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001317 */
1318 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1319 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1320 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001321 * Broadcast Action: A user ID has been removed from the system. The user
1322 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001323 *
1324 * <p class="note">This is a protected intent that can only be sent
1325 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001326 */
1327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1328 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1329 /**
1330 * Broadcast Action: The current system wallpaper has changed. See
1331 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1332 */
1333 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1334 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1335 /**
1336 * Broadcast Action: The current device {@link android.content.res.Configuration}
1337 * (orientation, locale, etc) has changed. When such a change happens, the
1338 * UIs (view hierarchy) will need to be rebuilt based on this new
1339 * information; for the most part, applications don't need to worry about
1340 * this, because the system will take care of stopping and restarting the
1341 * application to make sure it sees the new changes. Some system code that
1342 * can not be restarted will need to watch for this action and handle it
1343 * appropriately.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001344 *
1345 * <p class="note">This is a protected intent that can only be sent
1346 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001347 *
1348 * @see android.content.res.Configuration
1349 */
1350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1351 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1352 /**
1353 * Broadcast Action: The charging state, or charge level of the battery has
1354 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001355 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001356 * <p class="note">
1357 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001358 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001359 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1360 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001361 *
1362 * <p class="note">This is a protected intent that can only be sent
1363 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001364 */
1365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1366 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1367 /**
1368 * Broadcast Action: Indicates low battery condition on the device.
1369 * This broadcast corresponds to the "Low battery warning" system dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001370 *
1371 * <p class="note">This is a protected intent that can only be sent
1372 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001373 */
1374 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1375 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1376 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001377 * Broadcast Action: Indicates the battery is now okay after being low.
1378 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1379 * gone back up to an okay state.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001380 *
1381 * <p class="note">This is a protected intent that can only be sent
1382 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001383 */
1384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1385 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1386 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001387 * Broadcast Action: External power has been connected to the device.
1388 * This is intended for applications that wish to register specifically to this notification.
1389 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1390 * stay active to receive this notification. This action can be used to implement actions
1391 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001392 *
1393 * <p class="note">This is a protected intent that can only be sent
1394 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001395 */
1396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001397 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001398 /**
1399 * Broadcast Action: External power has been removed from the device.
1400 * This is intended for applications that wish to register specifically to this notification.
1401 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1402 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001403 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001404 *
1405 * <p class="note">This is a protected intent that can only be sent
1406 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001407 */
1408 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001409 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001410 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001411 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001412 * Broadcast Action: Device is shutting down.
1413 * This is broadcast when the device is being shut down (completely turned
1414 * off, not sleeping). Once the broadcast is complete, the final shutdown
1415 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001416 * to handle this, since the foreground activity will be paused as well.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001417 *
1418 * <p class="note">This is a protected intent that can only be sent
1419 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001420 */
1421 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001422 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001423 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001424 * Activity Action: Start this activity to request system shutdown.
1425 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1426 * to request confirmation from the user before shutting down.
1427 *
1428 * <p class="note">This is a protected intent that can only be sent
1429 * by the system.
1430 *
1431 * {@hide}
1432 */
1433 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1434 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 * Broadcast Action: Indicates low memory condition on the device
Dianne Hackborn854060af2009-07-09 18:14:31 -07001436 *
1437 * <p class="note">This is a protected intent that can only be sent
1438 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001439 */
1440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1441 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1442 /**
1443 * Broadcast Action: Indicates low memory condition on the device no longer exists
Dianne Hackborn854060af2009-07-09 18:14:31 -07001444 *
1445 * <p class="note">This is a protected intent that can only be sent
1446 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001447 */
1448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1449 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1450 /**
1451 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1452 * and package management should be started.
1453 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1454 * notification.
1455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1457 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1458 /**
1459 * Broadcast Action: The device has entered USB Mass Storage mode.
1460 * This is used mainly for the USB Settings panel.
1461 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1462 * when the SD card file system is mounted or unmounted
1463 */
1464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1465 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1466
1467 /**
1468 * Broadcast Action: The device has exited USB Mass Storage mode.
1469 * This is used mainly for the USB Settings panel.
1470 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1471 * when the SD card file system is mounted or unmounted
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1475
1476 /**
1477 * Broadcast Action: External media has been removed.
1478 * The path to the mount point for the removed media is contained in the Intent.mData field.
1479 */
1480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1481 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1482
1483 /**
1484 * Broadcast Action: External media is present, but not mounted at its mount point.
1485 * The path to the mount point for the removed media is contained in the Intent.mData field.
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1489
1490 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001491 * Broadcast Action: External media is present, and being disk-checked
1492 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1496
1497 /**
1498 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1499 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001500 */
1501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1502 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1503
1504 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 * Broadcast Action: External media is present and mounted at its mount point.
1506 * The path to the mount point for the removed media is contained in the Intent.mData field.
1507 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1508 * media was mounted read only.
1509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1512
1513 /**
1514 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1515 * The path to the mount point for the removed media is contained in the Intent.mData field.
1516 */
1517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1518 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1519
1520 /**
1521 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1522 * The path to the mount point for the removed media is contained in the Intent.mData field.
1523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1526
1527 /**
1528 * Broadcast Action: External media is present but cannot be mounted.
1529 * The path to the mount point for the removed media is contained in the Intent.mData field.
1530 */
1531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1532 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1533
1534 /**
1535 * Broadcast Action: User has expressed the desire to remove the external storage media.
1536 * Applications should close all files they have open within the mount point when they receive this intent.
1537 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1538 */
1539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1540 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1541
1542 /**
1543 * Broadcast Action: The media scanner has started scanning a directory.
1544 * The path to the directory being scanned is contained in the Intent.mData field.
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1548
1549 /**
1550 * Broadcast Action: The media scanner has finished scanning a directory.
1551 * The path to the scanned directory is contained in the Intent.mData field.
1552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1555
1556 /**
1557 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1558 * The path to the file is contained in the Intent.mData field.
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1562
1563 /**
1564 * Broadcast Action: The "Media Button" was pressed. Includes a single
1565 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1566 * caused the broadcast.
1567 */
1568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1569 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1570
1571 /**
1572 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1573 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1574 * caused the broadcast.
1575 */
1576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1577 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1578
1579 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1580 // location; they are not general-purpose actions.
1581
1582 /**
1583 * Broadcast Action: An GTalk connection has been established.
1584 */
1585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1587 "android.intent.action.GTALK_CONNECTED";
1588
1589 /**
1590 * Broadcast Action: An GTalk connection has been disconnected.
1591 */
1592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1593 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1594 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001595
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001596 /**
1597 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001598 */
1599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_INPUT_METHOD_CHANGED =
1601 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001602
1603 /**
1604 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1605 * more radios have been turned off or on. The intent will have the following extra value:</p>
1606 * <ul>
1607 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1608 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1609 * turned off</li>
1610 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001611 *
1612 * <p class="note">This is a protected intent that can only be sent
1613 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001614 */
1615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1616 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1617
1618 /**
1619 * Broadcast Action: Some content providers have parts of their namespace
1620 * where they publish new events or items that the user may be especially
1621 * interested in. For these things, they may broadcast this action when the
1622 * set of interesting items change.
1623 *
1624 * For example, GmailProvider sends this notification when the set of unread
1625 * mail in the inbox changes.
1626 *
1627 * <p>The data of the intent identifies which part of which provider
1628 * changed. When queried through the content resolver, the data URI will
1629 * return the data set in question.
1630 *
1631 * <p>The intent will have the following extra values:
1632 * <ul>
1633 * <li><em>count</em> - The number of items in the data set. This is the
1634 * same as the number of items in the cursor returned by querying the
1635 * data URI. </li>
1636 * </ul>
1637 *
1638 * This intent will be sent at boot (if the count is non-zero) and when the
1639 * data set changes. It is possible for the data set to change without the
1640 * count changing (for example, if a new unread message arrives in the same
1641 * sync operation in which a message is archived). The phone should still
1642 * ring/vibrate/etc as normal in this case.
1643 */
1644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1645 public static final String ACTION_PROVIDER_CHANGED =
1646 "android.intent.action.PROVIDER_CHANGED";
1647
1648 /**
1649 * Broadcast Action: Wired Headset plugged in or unplugged.
1650 *
1651 * <p>The intent will have the following extra values:
1652 * <ul>
1653 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1654 * <li><em>name</em> - Headset type, human readable string </li>
1655 * </ul>
1656 * </ul>
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_HEADSET_PLUG =
1660 "android.intent.action.HEADSET_PLUG";
1661
1662 /**
1663 * Broadcast Action: An outgoing call is about to be placed.
1664 *
1665 * <p>The Intent will have the following extra value:
1666 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001667 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001668 * the phone number originally intended to be dialed.</li>
1669 * </ul>
1670 * <p>Once the broadcast is finished, the resultData is used as the actual
1671 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001672 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001673 * outgoing call in turn: for example, a parental control application
1674 * might verify that the user is authorized to place the call at that
1675 * time, then a number-rewriting application might add an area code if
1676 * one was not specified.</p>
1677 * <p>For consistency, any receiver whose purpose is to prohibit phone
1678 * calls should have a priority of 0, to ensure it will see the final
1679 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001680 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001681 * should have a positive priority.
1682 * Negative priorities are reserved for the system for this broadcast;
1683 * using them may cause problems.</p>
1684 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1685 * abort the broadcast.</p>
1686 * <p>Emergency calls cannot be intercepted using this mechanism, and
1687 * other calls cannot be modified to call emergency numbers using this
1688 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001689 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001690 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1691 * permission to receive this Intent.</p>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001692 *
1693 * <p class="note">This is a protected intent that can only be sent
1694 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001695 */
1696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1697 public static final String ACTION_NEW_OUTGOING_CALL =
1698 "android.intent.action.NEW_OUTGOING_CALL";
1699
1700 /**
1701 * Broadcast Action: Have the device reboot. This is only for use by
1702 * system code.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001703 *
1704 * <p class="note">This is a protected intent that can only be sent
1705 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001706 */
1707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1708 public static final String ACTION_REBOOT =
1709 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001710
Wei Huang97ecc9c2009-05-11 17:44:20 -07001711 /**
1712 * Broadcast Action: a remote intent is to be broadcasted.
1713 *
1714 * A remote intent is used for remote RPC between devices. The remote intent
1715 * is serialized and sent from one device to another device. The receiving
1716 * device parses the remote intent and broadcasts it. Note that anyone can
1717 * broadcast a remote intent. However, if the intent receiver of the remote intent
1718 * does not trust intent broadcasts from arbitrary intent senders, it should require
1719 * the sender to hold certain permissions so only trusted sender's broadcast will be
1720 * let through.
1721 */
1722 public static final String ACTION_REMOTE_INTENT =
1723 "android.intent.action.REMOTE_INTENT";
1724
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001725 /**
1726 * Broadcast Action: hook for permforming cleanup after a system update.
1727 *
1728 * The broadcast is sent when the system is booting, before the
1729 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1730 * image. A receiver for this should do its work and then disable itself
1731 * so that it does not get run again at the next boot.
1732 * @hide
1733 */
1734 public static final String ACTION_PRE_BOOT_COMPLETED =
1735 "android.intent.action.PRE_BOOT_COMPLETED";
1736
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001737 // ---------------------------------------------------------------------
1738 // ---------------------------------------------------------------------
1739 // Standard intent categories (see addCategory()).
1740
1741 /**
1742 * Set if the activity should be an option for the default action
1743 * (center press) to perform on a piece of data. Setting this will
1744 * hide from the user any activities without it set when performing an
1745 * action on some data. Note that this is normal -not- set in the
1746 * Intent when initiating an action -- it is for use in intent filters
1747 * specified in packages.
1748 */
1749 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1750 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1751 /**
1752 * Activities that can be safely invoked from a browser must support this
1753 * category. For example, if the user is viewing a web page or an e-mail
1754 * and clicks on a link in the text, the Intent generated execute that
1755 * link will require the BROWSABLE category, so that only activities
1756 * supporting this category will be considered as possible actions. By
1757 * supporting this category, you are promising that there is nothing
1758 * damaging (without user intervention) that can happen by invoking any
1759 * matching Intent.
1760 */
1761 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1762 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1763 /**
1764 * Set if the activity should be considered as an alternative action to
1765 * the data the user is currently viewing. See also
1766 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1767 * applies to the selection in a list of items.
1768 *
1769 * <p>Supporting this category means that you would like your activity to be
1770 * displayed in the set of alternative things the user can do, usually as
1771 * part of the current activity's options menu. You will usually want to
1772 * include a specific label in the &lt;intent-filter&gt; of this action
1773 * describing to the user what it does.
1774 *
1775 * <p>The action of IntentFilter with this category is important in that it
1776 * describes the specific action the target will perform. This generally
1777 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1778 * a specific name such as "com.android.camera.action.CROP. Only one
1779 * alternative of any particular action will be shown to the user, so using
1780 * a specific action like this makes sure that your alternative will be
1781 * displayed while also allowing other applications to provide their own
1782 * overrides of that particular action.
1783 */
1784 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1785 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1786 /**
1787 * Set if the activity should be considered as an alternative selection
1788 * action to the data the user has currently selected. This is like
1789 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1790 * of items from which the user can select, giving them alternatives to the
1791 * default action that will be performed on it.
1792 */
1793 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1794 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1795 /**
1796 * Intended to be used as a tab inside of an containing TabActivity.
1797 */
1798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1799 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1800 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001801 * Should be displayed in the top-level launcher.
1802 */
1803 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1804 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1805 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001806 * Provides information about the package it is in; typically used if
1807 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1808 * a front-door to the user without having to be shown in the all apps list.
1809 */
1810 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1811 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1812 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001813 * This is the home activity, that is the first activity that is displayed
1814 * when the device boots.
1815 */
1816 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1817 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1818 /**
1819 * This activity is a preference panel.
1820 */
1821 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1822 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1823 /**
1824 * This activity is a development preference panel.
1825 */
1826 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1827 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1828 /**
1829 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 */
1831 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1832 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1833 /**
1834 * This activity may be exercised by the monkey or other automated test tools.
1835 */
1836 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1837 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1838 /**
1839 * To be used as a test (not part of the normal user experience).
1840 */
1841 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1842 /**
1843 * To be used as a unit test (run through the Test Harness).
1844 */
1845 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1846 /**
1847 * To be used as an sample code example (not part of the normal user
1848 * experience).
1849 */
1850 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1851 /**
1852 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1853 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1854 * when queried, though it is allowable for those columns to be blank.
1855 */
1856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1857 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1858
1859 /**
1860 * To be used as code under test for framework instrumentation tests.
1861 */
1862 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1863 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001864
1865 /**
1866 * Broadcast Action: The phone was docked or undocked. Includes the extra
1867 * field {@link #EXTRA_DOCK_STATE}, containing the current dock state.
1868 * @hide
1869 */
1870 public static final String ACTION_DOCK_EVENT = "android.intent.action.DOCK_EVENT";
1871
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001872 // ---------------------------------------------------------------------
1873 // ---------------------------------------------------------------------
1874 // Standard extra data keys.
1875
1876 /**
1877 * The initial data to place in a newly created record. Use with
1878 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1879 * fields as would be given to the underlying ContentProvider.insert()
1880 * call.
1881 */
1882 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1883
1884 /**
1885 * A constant CharSequence that is associated with the Intent, used with
1886 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1887 * this may be a styled CharSequence, so you must use
1888 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1889 * retrieve it.
1890 */
1891 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1892
1893 /**
1894 * A content: URI holding a stream of data associated with the Intent,
1895 * used with {@link #ACTION_SEND} to supply the data being sent.
1896 */
1897 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1898
1899 /**
1900 * A String[] holding e-mail addresses that should be delivered to.
1901 */
1902 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1903
1904 /**
1905 * A String[] holding e-mail addresses that should be carbon copied.
1906 */
1907 public static final String EXTRA_CC = "android.intent.extra.CC";
1908
1909 /**
1910 * A String[] holding e-mail addresses that should be blind carbon copied.
1911 */
1912 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1913
1914 /**
1915 * A constant string holding the desired subject line of a message.
1916 */
1917 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1918
1919 /**
1920 * An Intent describing the choices you would like shown with
1921 * {@link #ACTION_PICK_ACTIVITY}.
1922 */
1923 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1924
1925 /**
1926 * A CharSequence dialog title to provide to the user when used with a
1927 * {@link #ACTION_CHOOSER}.
1928 */
1929 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1930
1931 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07001932 * A Parcelable[] of {@link Intent} or
1933 * {@link android.content.pm.LabeledIntent} objects as set with
1934 * {@link #putExtra(String, Parcelable[])} of additional activities to place
1935 * a the front of the list of choices, when shown to the user with a
1936 * {@link #ACTION_CHOOSER}.
1937 */
1938 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
1939
1940 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001941 * A {@link android.view.KeyEvent} object containing the event that
1942 * triggered the creation of the Intent it is in.
1943 */
1944 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1945
1946 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001947 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
1948 * before shutting down.
1949 *
1950 * {@hide}
1951 */
1952 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
1953
1954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1956 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1957 * of restarting the application.
1958 */
1959 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1960
1961 /**
1962 * A String holding the phone number originally entered in
1963 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1964 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1965 */
1966 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1967 /**
1968 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1969 * intents to supply the uid the package had been assigned. Also an optional
1970 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1971 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1972 * purpose.
1973 */
1974 public static final String EXTRA_UID = "android.intent.extra.UID";
1975
1976 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001977 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1978 * intents to indicate whether this represents a full uninstall (removing
1979 * both the code and its data) or a partial uninstall (leaving its data,
1980 * implying that this is an update).
1981 */
1982 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001983
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 /**
1985 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1986 * intents to indicate that this is a replacement of the package, so this
1987 * broadcast will immediately be followed by an add broadcast for a
1988 * different version of the same package.
1989 */
1990 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001991
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 * Used as an int extra field in {@link android.app.AlarmManager} intents
1994 * to tell the application being invoked how many pending alarms are being
1995 * delievered with the intent. For one-shot alarms this will always be 1.
1996 * For recurring alarms, this might be greater than 1 if the device was
1997 * asleep or powered off at the time an earlier alarm would have been
1998 * delivered.
1999 */
2000 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002001
Jacek Surazski86b6c532009-05-13 14:38:28 +02002002 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002003 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2004 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002005 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2006 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2007 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002008 * @hide
2009 */
2010 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2011
2012 /**
2013 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2014 * to represent that the phone is not in any dock.
2015 * @hide
2016 */
2017 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2018
2019 /**
2020 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2021 * to represent that the phone is in a desk dock.
2022 * @hide
2023 */
2024 public static final int EXTRA_DOCK_STATE_DESK = 1;
2025
2026 /**
2027 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2028 * to represent that the phone is in a car dock.
2029 * @hide
2030 */
2031 public static final int EXTRA_DOCK_STATE_CAR = 2;
2032
2033 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002034 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2035 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002036 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002037 * @hide
2038 */
2039 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2040
2041 /**
Romain Guy4969af72009-06-17 10:53:19 -07002042 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002043 * package. Specifies the installer package name; this package will receive the
2044 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002045 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002046 * @hide
2047 */
Romain Guy4969af72009-06-17 10:53:19 -07002048 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002049 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002050
Wei Huang97ecc9c2009-05-11 17:44:20 -07002051 /**
2052 * Used in the extra field in the remote intent. It's astring token passed with the
2053 * remote intent.
2054 */
2055 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2056 "android.intent.extra.remote_intent_token";
2057
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002058 /**
2059 * Used as an int extra field in {@link android.content.Intent#ACTION_PACKAGE_CHANGED}
2060 * intent to supply the name of the component that changed.
Suchi Amalapurapu32f58902009-09-02 15:36:20 -07002061 *
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002062 */
2063 public static final String EXTRA_CHANGED_COMPONENT_NAME =
2064 "android.intent.extra.changed_component_name";
2065
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002066 /**
2067 * @hide
2068 * Magic extra system code can use when binding, to give a label for
2069 * who it is that has bound to a service. This is an integer giving
2070 * a framework string resource that can be displayed to the user.
2071 */
2072 public static final String EXTRA_CLIENT_LABEL =
2073 "android.intent.extra.client_label";
2074
2075 /**
2076 * @hide
2077 * Magic extra system code can use when binding, to give a PendingIntent object
2078 * that can be launched for the user to disable the system's use of this
2079 * service.
2080 */
2081 public static final String EXTRA_CLIENT_INTENT =
2082 "android.intent.extra.client_intent";
2083
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 // ---------------------------------------------------------------------
2085 // ---------------------------------------------------------------------
2086 // Intent flags (see mFlags variable).
2087
2088 /**
2089 * If set, the recipient of this Intent will be granted permission to
2090 * perform read operations on the Uri in the Intent's data.
2091 */
2092 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2093 /**
2094 * If set, the recipient of this Intent will be granted permission to
2095 * perform write operations on the Uri in the Intent's data.
2096 */
2097 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2098 /**
2099 * Can be set by the caller to indicate that this Intent is coming from
2100 * a background operation, not from direct user interaction.
2101 */
2102 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2103 /**
2104 * A flag you can enable for debugging: when set, log messages will be
2105 * printed during the resolution of this intent to show you what has
2106 * been found to create the final resolved list.
2107 */
2108 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2109
2110 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002111 * If set, the new activity is not kept in the history stack. As soon as
2112 * the user navigates away from it, the activity is finished. This may also
2113 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2114 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002115 */
2116 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2117 /**
2118 * If set, the activity will not be launched if it is already running
2119 * at the top of the history stack.
2120 */
2121 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2122 /**
2123 * If set, this activity will become the start of a new task on this
2124 * history stack. A task (from the activity that started it to the
2125 * next task activity) defines an atomic group of activities that the
2126 * user can move to. Tasks can be moved to the foreground and background;
2127 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002128 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002129 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2130 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002131 *
2132 * <p>This flag is generally used by activities that want
2133 * to present a "launcher" style behavior: they give the user a list of
2134 * separate things that can be done, which otherwise run completely
2135 * independently of the activity launching them.
2136 *
2137 * <p>When using this flag, if a task is already running for the activity
2138 * you are now starting, then a new activity will not be started; instead,
2139 * the current task will simply be brought to the front of the screen with
2140 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2141 * to disable this behavior.
2142 *
2143 * <p>This flag can not be used when the caller is requesting a result from
2144 * the activity being launched.
2145 */
2146 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2147 /**
2148 * <strong>Do not use this flag unless you are implementing your own
2149 * top-level application launcher.</strong> Used in conjunction with
2150 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2151 * behavior of bringing an existing task to the foreground. When set,
2152 * a new task is <em>always</em> started to host the Activity for the
2153 * Intent, regardless of whether there is already an existing task running
2154 * the same thing.
2155 *
2156 * <p><strong>Because the default system does not include graphical task management,
2157 * you should not use this flag unless you provide some way for a user to
2158 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002159 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002160 * <p>This flag is ignored if
2161 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2162 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002163 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2164 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002165 */
2166 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2167 /**
2168 * If set, and the activity being launched is already running in the
2169 * current task, then instead of launching a new instance of that activity,
2170 * all of the other activities on top of it will be closed and this Intent
2171 * will be delivered to the (now on top) old activity as a new Intent.
2172 *
2173 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2174 * If D calls startActivity() with an Intent that resolves to the component
2175 * of activity B, then C and D will be finished and B receive the given
2176 * Intent, resulting in the stack now being: A, B.
2177 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002178 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 * either receive the new intent you are starting here in its
2180 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002181 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002182 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2183 * the same intent, then it will be finished and re-created; for all other
2184 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2185 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002186 *
2187 * <p>This launch mode can also be used to good effect in conjunction with
2188 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2189 * of a task, it will bring any currently running instance of that task
2190 * to the foreground, and then clear it to its root state. This is
2191 * especially useful, for example, when launching an activity from the
2192 * notification manager.
2193 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002194 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2195 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002196 */
2197 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2198 /**
2199 * If set and this intent is being used to launch a new activity from an
2200 * existing one, then the reply target of the existing activity will be
2201 * transfered to the new activity. This way the new activity can call
2202 * {@link android.app.Activity#setResult} and have that result sent back to
2203 * the reply target of the original activity.
2204 */
2205 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2206 /**
2207 * If set and this intent is being used to launch a new activity from an
2208 * existing one, the current activity will not be counted as the top
2209 * activity for deciding whether the new intent should be delivered to
2210 * the top instead of starting a new one. The previous activity will
2211 * be used as the top, with the assumption being that the current activity
2212 * will finish itself immediately.
2213 */
2214 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2215 /**
2216 * If set, the new activity is not kept in the list of recently launched
2217 * activities.
2218 */
2219 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2220 /**
2221 * This flag is not normally set by application code, but set for you by
2222 * the system as described in the
2223 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2224 * launchMode} documentation for the singleTask mode.
2225 */
2226 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2227 /**
2228 * If set, and this activity is either being started in a new task or
2229 * bringing to the top an existing task, then it will be launched as
2230 * the front door of the task. This will result in the application of
2231 * any affinities needed to have that task in the proper state (either
2232 * moving activities to or from it), or simply resetting that task to
2233 * its initial state if needed.
2234 */
2235 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2236 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002237 * This flag is not normally set by application code, but set for you by
2238 * the system if this activity is being launched from history
2239 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002240 */
2241 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002242 /**
2243 * If set, this marks a point in the task's activity stack that should
2244 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002245 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002246 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2247 * the user re-launching it from home), this activity and all on top of
2248 * it will be finished so that the user does not return to them, but
2249 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002250 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002251 * <p>This is useful for cases where you have a logical break in your
2252 * application. For example, an e-mail application may have a command
2253 * to view an attachment, which launches an image view activity to
2254 * display it. This activity should be part of the e-mail application's
2255 * task, since it is a part of the task the user is involved in. However,
2256 * if the user leaves that task, and later selects the e-mail app from
2257 * home, we may like them to return to the conversation they were
2258 * viewing, not the picture attachment, since that is confusing. By
2259 * setting this flag when launching the image viewer, that viewer and
2260 * any activities it starts will be removed the next time the user returns
2261 * to mail.
2262 */
2263 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002264 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002265 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002266 * callback from occurring on the current frontmost activity before it is
2267 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002268 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002269 * <p>Typically, an activity can rely on that callback to indicate that an
2270 * explicit user action has caused their activity to be moved out of the
2271 * foreground. The callback marks an appropriate point in the activity's
2272 * lifecycle for it to dismiss any notifications that it intends to display
2273 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002274 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002275 * <p>If an activity is ever started via any non-user-driven events such as
2276 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2277 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002278 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002279 */
2280 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002281 /**
2282 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2283 * this flag will cause the launched activity to be brought to the front of its
2284 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002285 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002286 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2287 * If D calls startActivity() with an Intent that resolves to the component
2288 * of activity B, then B will be brought to the front of the history stack,
2289 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002290 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002291 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002292 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002293 */
2294 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002295 /**
2296 * If set, when sending a broadcast only registered receivers will be
2297 * called -- no BroadcastReceiver components will be launched.
2298 */
2299 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002300 /**
2301 * If set, when sending a broadcast <i>before boot has completed</i> only
2302 * registered receivers will be called -- no BroadcastReceiver components
2303 * will be launched. Sticky intent state will be recorded properly even
2304 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2305 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002306 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002307 * <p>This flag is only for use by system sevices as a convenience to
2308 * avoid having to implement a more complex mechanism around detection
2309 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002310 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002311 * @hide
2312 */
2313 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002314 /**
2315 * Set when this broadcast is for a boot upgrade, a special mode that
2316 * allows the broadcast to be sent before the system is ready and launches
2317 * the app process with no providers running in it.
2318 * @hide
2319 */
2320 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x10000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321
2322 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002323 // ---------------------------------------------------------------------
2324 // toUri() and parseUri() options.
2325
2326 /**
2327 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2328 * always has the "intent:" scheme. This syntax can be used when you want
2329 * to later disambiguate between URIs that are intended to describe an
2330 * Intent vs. all others that should be treated as raw URIs. When used
2331 * with {@link #parseUri}, any other scheme will result in a generic
2332 * VIEW action for that raw URI.
2333 */
2334 public static final int URI_INTENT_SCHEME = 1<<0;
2335
2336 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337
2338 private String mAction;
2339 private Uri mData;
2340 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002341 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002342 private ComponentName mComponent;
2343 private int mFlags;
2344 private HashSet<String> mCategories;
2345 private Bundle mExtras;
2346
2347 // ---------------------------------------------------------------------
2348
2349 /**
2350 * Create an empty intent.
2351 */
2352 public Intent() {
2353 }
2354
2355 /**
2356 * Copy constructor.
2357 */
2358 public Intent(Intent o) {
2359 this.mAction = o.mAction;
2360 this.mData = o.mData;
2361 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002362 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 this.mComponent = o.mComponent;
2364 this.mFlags = o.mFlags;
2365 if (o.mCategories != null) {
2366 this.mCategories = new HashSet<String>(o.mCategories);
2367 }
2368 if (o.mExtras != null) {
2369 this.mExtras = new Bundle(o.mExtras);
2370 }
2371 }
2372
2373 @Override
2374 public Object clone() {
2375 return new Intent(this);
2376 }
2377
2378 private Intent(Intent o, boolean all) {
2379 this.mAction = o.mAction;
2380 this.mData = o.mData;
2381 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002382 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002383 this.mComponent = o.mComponent;
2384 if (o.mCategories != null) {
2385 this.mCategories = new HashSet<String>(o.mCategories);
2386 }
2387 }
2388
2389 /**
2390 * Make a clone of only the parts of the Intent that are relevant for
2391 * filter matching: the action, data, type, component, and categories.
2392 */
2393 public Intent cloneFilter() {
2394 return new Intent(this, false);
2395 }
2396
2397 /**
2398 * Create an intent with a given action. All other fields (data, type,
2399 * class) are null. Note that the action <em>must</em> be in a
2400 * namespace because Intents are used globally in the system -- for
2401 * example the system VIEW action is android.intent.action.VIEW; an
2402 * application's custom action would be something like
2403 * com.google.app.myapp.CUSTOM_ACTION.
2404 *
2405 * @param action The Intent action, such as ACTION_VIEW.
2406 */
2407 public Intent(String action) {
2408 mAction = action;
2409 }
2410
2411 /**
2412 * Create an intent with a given action and for a given data url. Note
2413 * that the action <em>must</em> be in a namespace because Intents are
2414 * used globally in the system -- for example the system VIEW action is
2415 * android.intent.action.VIEW; an application's custom action would be
2416 * something like com.google.app.myapp.CUSTOM_ACTION.
2417 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002418 * <p><em>Note: scheme and host name matching in the Android framework is
2419 * case-sensitive, unlike the formal RFC. As a result,
2420 * you should always ensure that you write your Uri with these elements
2421 * using lower case letters, and normalize any Uris you receive from
2422 * outside of Android to ensure the scheme and host is lower case.</em></p>
2423 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002424 * @param action The Intent action, such as ACTION_VIEW.
2425 * @param uri The Intent data URI.
2426 */
2427 public Intent(String action, Uri uri) {
2428 mAction = action;
2429 mData = uri;
2430 }
2431
2432 /**
2433 * Create an intent for a specific component. All other fields (action, data,
2434 * type, class) are null, though they can be modified later with explicit
2435 * calls. This provides a convenient way to create an intent that is
2436 * intended to execute a hard-coded class name, rather than relying on the
2437 * system to find an appropriate class for you; see {@link #setComponent}
2438 * for more information on the repercussions of this.
2439 *
2440 * @param packageContext A Context of the application package implementing
2441 * this class.
2442 * @param cls The component class that is to be used for the intent.
2443 *
2444 * @see #setClass
2445 * @see #setComponent
2446 * @see #Intent(String, android.net.Uri , Context, Class)
2447 */
2448 public Intent(Context packageContext, Class<?> cls) {
2449 mComponent = new ComponentName(packageContext, cls);
2450 }
2451
2452 /**
2453 * Create an intent for a specific component with a specified action and data.
2454 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2455 * construct the Intent and then calling {@link #setClass} to set its
2456 * class.
2457 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002458 * <p><em>Note: scheme and host name matching in the Android framework is
2459 * case-sensitive, unlike the formal RFC. As a result,
2460 * you should always ensure that you write your Uri with these elements
2461 * using lower case letters, and normalize any Uris you receive from
2462 * outside of Android to ensure the scheme and host is lower case.</em></p>
2463 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002464 * @param action The Intent action, such as ACTION_VIEW.
2465 * @param uri The Intent data URI.
2466 * @param packageContext A Context of the application package implementing
2467 * this class.
2468 * @param cls The component class that is to be used for the intent.
2469 *
2470 * @see #Intent(String, android.net.Uri)
2471 * @see #Intent(Context, Class)
2472 * @see #setClass
2473 * @see #setComponent
2474 */
2475 public Intent(String action, Uri uri,
2476 Context packageContext, Class<?> cls) {
2477 mAction = action;
2478 mData = uri;
2479 mComponent = new ComponentName(packageContext, cls);
2480 }
2481
2482 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002483 * Call {@link #parseUri} with 0 flags.
2484 * @deprecated Use {@link #parseUri} instead.
2485 */
2486 @Deprecated
2487 public static Intent getIntent(String uri) throws URISyntaxException {
2488 return parseUri(uri, 0);
2489 }
2490
2491 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002492 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002493 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002494 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002495 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 *
2497 * <p>The URI given here must not be relative -- that is, it must include
2498 * the scheme and full path.
2499 *
2500 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002501 * @param flags Additional processing flags. Either 0 or
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002502 *
2503 * @return Intent The newly created Intent object.
2504 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002505 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2506 * it bad (as parsed by the Uri class) or the Intent data within the
2507 * URI is invalid.
2508 *
2509 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002510 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002511 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002512 int i = 0;
2513 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002514 // Validate intent scheme for if requested.
2515 if ((flags&URI_INTENT_SCHEME) != 0) {
2516 if (!uri.startsWith("intent:")) {
2517 Intent intent = new Intent(ACTION_VIEW);
2518 try {
2519 intent.setData(Uri.parse(uri));
2520 } catch (IllegalArgumentException e) {
2521 throw new URISyntaxException(uri, e.getMessage());
2522 }
2523 return intent;
2524 }
2525 }
2526
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002527 // simple case
2528 i = uri.lastIndexOf("#");
2529 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2530
2531 // old format Intent URI
2532 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002533
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 // new format
2535 Intent intent = new Intent(ACTION_VIEW);
2536
2537 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002538 String data = i >= 0 ? uri.substring(0, i) : null;
2539 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002540 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002541
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002542 // loop over contents of Intent, all name=value;
2543 while (!uri.startsWith("end", i)) {
2544 int eq = uri.indexOf('=', i);
2545 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002546 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547
2548 // action
2549 if (uri.startsWith("action=", i)) {
2550 intent.mAction = value;
2551 }
2552
2553 // categories
2554 else if (uri.startsWith("category=", i)) {
2555 intent.addCategory(value);
2556 }
2557
2558 // type
2559 else if (uri.startsWith("type=", i)) {
2560 intent.mType = value;
2561 }
2562
2563 // launch flags
2564 else if (uri.startsWith("launchFlags=", i)) {
2565 intent.mFlags = Integer.decode(value).intValue();
2566 }
2567
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002568 // package
2569 else if (uri.startsWith("package=", i)) {
2570 intent.mPackage = value;
2571 }
2572
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002573 // component
2574 else if (uri.startsWith("component=", i)) {
2575 intent.mComponent = ComponentName.unflattenFromString(value);
2576 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002577
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002578 // scheme
2579 else if (uri.startsWith("scheme=", i)) {
2580 scheme = value;
2581 }
2582
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002583 // extra
2584 else {
2585 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002586 // create Bundle if it doesn't already exist
2587 if (intent.mExtras == null) intent.mExtras = new Bundle();
2588 Bundle b = intent.mExtras;
2589 // add EXTRA
2590 if (uri.startsWith("S.", i)) b.putString(key, value);
2591 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2592 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2593 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2594 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2595 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2596 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2597 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2598 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2599 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2600 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002602 // move to the next item
2603 i = semi + 1;
2604 }
2605
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002606 if (data != null) {
2607 if (data.startsWith("intent:")) {
2608 data = data.substring(7);
2609 if (scheme != null) {
2610 data = scheme + ':' + data;
2611 }
2612 }
2613
2614 if (data.length() > 0) {
2615 try {
2616 intent.mData = Uri.parse(data);
2617 } catch (IllegalArgumentException e) {
2618 throw new URISyntaxException(uri, e.getMessage());
2619 }
2620 }
2621 }
2622
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002623 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 } catch (IndexOutOfBoundsException e) {
2626 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2627 }
2628 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002630 public static Intent getIntentOld(String uri) throws URISyntaxException {
2631 Intent intent;
2632
2633 int i = uri.lastIndexOf('#');
2634 if (i >= 0) {
2635 Uri data = null;
2636 String action = null;
2637 if (i > 0) {
2638 data = Uri.parse(uri.substring(0, i));
2639 }
2640
2641 i++;
2642
2643 if (uri.regionMatches(i, "action(", 0, 7)) {
2644 i += 7;
2645 int j = uri.indexOf(')', i);
2646 action = uri.substring(i, j);
2647 i = j + 1;
2648 }
2649
2650 intent = new Intent(action, data);
2651
2652 if (uri.regionMatches(i, "categories(", 0, 11)) {
2653 i += 11;
2654 int j = uri.indexOf(')', i);
2655 while (i < j) {
2656 int sep = uri.indexOf('!', i);
2657 if (sep < 0) sep = j;
2658 if (i < sep) {
2659 intent.addCategory(uri.substring(i, sep));
2660 }
2661 i = sep + 1;
2662 }
2663 i = j + 1;
2664 }
2665
2666 if (uri.regionMatches(i, "type(", 0, 5)) {
2667 i += 5;
2668 int j = uri.indexOf(')', i);
2669 intent.mType = uri.substring(i, j);
2670 i = j + 1;
2671 }
2672
2673 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2674 i += 12;
2675 int j = uri.indexOf(')', i);
2676 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2677 i = j + 1;
2678 }
2679
2680 if (uri.regionMatches(i, "component(", 0, 10)) {
2681 i += 10;
2682 int j = uri.indexOf(')', i);
2683 int sep = uri.indexOf('!', i);
2684 if (sep >= 0 && sep < j) {
2685 String pkg = uri.substring(i, sep);
2686 String cls = uri.substring(sep + 1, j);
2687 intent.mComponent = new ComponentName(pkg, cls);
2688 }
2689 i = j + 1;
2690 }
2691
2692 if (uri.regionMatches(i, "extras(", 0, 7)) {
2693 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002695 final int closeParen = uri.indexOf(')', i);
2696 if (closeParen == -1) throw new URISyntaxException(uri,
2697 "EXTRA missing trailing ')'", i);
2698
2699 while (i < closeParen) {
2700 // fetch the key value
2701 int j = uri.indexOf('=', i);
2702 if (j <= i + 1 || i >= closeParen) {
2703 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2704 }
2705 char type = uri.charAt(i);
2706 i++;
2707 String key = uri.substring(i, j);
2708 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002710 // get type-value
2711 j = uri.indexOf('!', i);
2712 if (j == -1 || j >= closeParen) j = closeParen;
2713 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2714 String value = uri.substring(i, j);
2715 i = j;
2716
2717 // create Bundle if it doesn't already exist
2718 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002719
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 // add item to bundle
2721 try {
2722 switch (type) {
2723 case 'S':
2724 intent.mExtras.putString(key, Uri.decode(value));
2725 break;
2726 case 'B':
2727 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2728 break;
2729 case 'b':
2730 intent.mExtras.putByte(key, Byte.parseByte(value));
2731 break;
2732 case 'c':
2733 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2734 break;
2735 case 'd':
2736 intent.mExtras.putDouble(key, Double.parseDouble(value));
2737 break;
2738 case 'f':
2739 intent.mExtras.putFloat(key, Float.parseFloat(value));
2740 break;
2741 case 'i':
2742 intent.mExtras.putInt(key, Integer.parseInt(value));
2743 break;
2744 case 'l':
2745 intent.mExtras.putLong(key, Long.parseLong(value));
2746 break;
2747 case 's':
2748 intent.mExtras.putShort(key, Short.parseShort(value));
2749 break;
2750 default:
2751 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2752 }
2753 } catch (NumberFormatException e) {
2754 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2755 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002756
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002757 char ch = uri.charAt(i);
2758 if (ch == ')') break;
2759 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2760 i++;
2761 }
2762 }
2763
2764 if (intent.mAction == null) {
2765 // By default, if no action is specified, then use VIEW.
2766 intent.mAction = ACTION_VIEW;
2767 }
2768
2769 } else {
2770 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2771 }
2772
2773 return intent;
2774 }
2775
2776 /**
2777 * Retrieve the general action to be performed, such as
2778 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2779 * the information in the intent should be interpreted -- most importantly,
2780 * what to do with the data returned by {@link #getData}.
2781 *
2782 * @return The action of this intent or null if none is specified.
2783 *
2784 * @see #setAction
2785 */
2786 public String getAction() {
2787 return mAction;
2788 }
2789
2790 /**
2791 * Retrieve data this intent is operating on. This URI specifies the name
2792 * of the data; often it uses the content: scheme, specifying data in a
2793 * content provider. Other schemes may be handled by specific activities,
2794 * such as http: by the web browser.
2795 *
2796 * @return The URI of the data this intent is targeting or null.
2797 *
2798 * @see #getScheme
2799 * @see #setData
2800 */
2801 public Uri getData() {
2802 return mData;
2803 }
2804
2805 /**
2806 * The same as {@link #getData()}, but returns the URI as an encoded
2807 * String.
2808 */
2809 public String getDataString() {
2810 return mData != null ? mData.toString() : null;
2811 }
2812
2813 /**
2814 * Return the scheme portion of the intent's data. If the data is null or
2815 * does not include a scheme, null is returned. Otherwise, the scheme
2816 * prefix without the final ':' is returned, i.e. "http".
2817 *
2818 * <p>This is the same as calling getData().getScheme() (and checking for
2819 * null data).
2820 *
2821 * @return The scheme of this intent.
2822 *
2823 * @see #getData
2824 */
2825 public String getScheme() {
2826 return mData != null ? mData.getScheme() : null;
2827 }
2828
2829 /**
2830 * Retrieve any explicit MIME type included in the intent. This is usually
2831 * null, as the type is determined by the intent data.
2832 *
2833 * @return If a type was manually set, it is returned; else null is
2834 * returned.
2835 *
2836 * @see #resolveType(ContentResolver)
2837 * @see #setType
2838 */
2839 public String getType() {
2840 return mType;
2841 }
2842
2843 /**
2844 * Return the MIME data type of this intent. If the type field is
2845 * explicitly set, that is simply returned. Otherwise, if the data is set,
2846 * the type of that data is returned. If neither fields are set, a null is
2847 * returned.
2848 *
2849 * @return The MIME type of this intent.
2850 *
2851 * @see #getType
2852 * @see #resolveType(ContentResolver)
2853 */
2854 public String resolveType(Context context) {
2855 return resolveType(context.getContentResolver());
2856 }
2857
2858 /**
2859 * Return the MIME data type of this intent. If the type field is
2860 * explicitly set, that is simply returned. Otherwise, if the data is set,
2861 * the type of that data is returned. If neither fields are set, a null is
2862 * returned.
2863 *
2864 * @param resolver A ContentResolver that can be used to determine the MIME
2865 * type of the intent's data.
2866 *
2867 * @return The MIME type of this intent.
2868 *
2869 * @see #getType
2870 * @see #resolveType(Context)
2871 */
2872 public String resolveType(ContentResolver resolver) {
2873 if (mType != null) {
2874 return mType;
2875 }
2876 if (mData != null) {
2877 if ("content".equals(mData.getScheme())) {
2878 return resolver.getType(mData);
2879 }
2880 }
2881 return null;
2882 }
2883
2884 /**
2885 * Return the MIME data type of this intent, only if it will be needed for
2886 * intent resolution. This is not generally useful for application code;
2887 * it is used by the frameworks for communicating with back-end system
2888 * services.
2889 *
2890 * @param resolver A ContentResolver that can be used to determine the MIME
2891 * type of the intent's data.
2892 *
2893 * @return The MIME type of this intent, or null if it is unknown or not
2894 * needed.
2895 */
2896 public String resolveTypeIfNeeded(ContentResolver resolver) {
2897 if (mComponent != null) {
2898 return mType;
2899 }
2900 return resolveType(resolver);
2901 }
2902
2903 /**
2904 * Check if an category exists in the intent.
2905 *
2906 * @param category The category to check.
2907 *
2908 * @return boolean True if the intent contains the category, else false.
2909 *
2910 * @see #getCategories
2911 * @see #addCategory
2912 */
2913 public boolean hasCategory(String category) {
2914 return mCategories != null && mCategories.contains(category);
2915 }
2916
2917 /**
2918 * Return the set of all categories in the intent. If there are no categories,
2919 * returns NULL.
2920 *
2921 * @return Set The set of categories you can examine. Do not modify!
2922 *
2923 * @see #hasCategory
2924 * @see #addCategory
2925 */
2926 public Set<String> getCategories() {
2927 return mCategories;
2928 }
2929
2930 /**
2931 * Sets the ClassLoader that will be used when unmarshalling
2932 * any Parcelable values from the extras of this Intent.
2933 *
2934 * @param loader a ClassLoader, or null to use the default loader
2935 * at the time of unmarshalling.
2936 */
2937 public void setExtrasClassLoader(ClassLoader loader) {
2938 if (mExtras != null) {
2939 mExtras.setClassLoader(loader);
2940 }
2941 }
2942
2943 /**
2944 * Returns true if an extra value is associated with the given name.
2945 * @param name the extra's name
2946 * @return true if the given extra is present.
2947 */
2948 public boolean hasExtra(String name) {
2949 return mExtras != null && mExtras.containsKey(name);
2950 }
2951
2952 /**
2953 * Returns true if the Intent's extras contain a parcelled file descriptor.
2954 * @return true if the Intent contains a parcelled file descriptor.
2955 */
2956 public boolean hasFileDescriptors() {
2957 return mExtras != null && mExtras.hasFileDescriptors();
2958 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002960 /**
2961 * Retrieve extended data from the intent.
2962 *
2963 * @param name The name of the desired item.
2964 *
2965 * @return the value of an item that previously added with putExtra()
2966 * or null if none was found.
2967 *
2968 * @deprecated
2969 * @hide
2970 */
2971 @Deprecated
2972 public Object getExtra(String name) {
2973 return getExtra(name, null);
2974 }
2975
2976 /**
2977 * Retrieve extended data from the intent.
2978 *
2979 * @param name The name of the desired item.
2980 * @param defaultValue the value to be returned if no value of the desired
2981 * type is stored with the given name.
2982 *
2983 * @return the value of an item that previously added with putExtra()
2984 * or the default value if none was found.
2985 *
2986 * @see #putExtra(String, boolean)
2987 */
2988 public boolean getBooleanExtra(String name, boolean defaultValue) {
2989 return mExtras == null ? defaultValue :
2990 mExtras.getBoolean(name, defaultValue);
2991 }
2992
2993 /**
2994 * Retrieve extended data from the intent.
2995 *
2996 * @param name The name of the desired item.
2997 * @param defaultValue the value to be returned if no value of the desired
2998 * type is stored with the given name.
2999 *
3000 * @return the value of an item that previously added with putExtra()
3001 * or the default value if none was found.
3002 *
3003 * @see #putExtra(String, byte)
3004 */
3005 public byte getByteExtra(String name, byte defaultValue) {
3006 return mExtras == null ? defaultValue :
3007 mExtras.getByte(name, defaultValue);
3008 }
3009
3010 /**
3011 * Retrieve extended data from the intent.
3012 *
3013 * @param name The name of the desired item.
3014 * @param defaultValue the value to be returned if no value of the desired
3015 * type is stored with the given name.
3016 *
3017 * @return the value of an item that previously added with putExtra()
3018 * or the default value if none was found.
3019 *
3020 * @see #putExtra(String, short)
3021 */
3022 public short getShortExtra(String name, short defaultValue) {
3023 return mExtras == null ? defaultValue :
3024 mExtras.getShort(name, defaultValue);
3025 }
3026
3027 /**
3028 * Retrieve extended data from the intent.
3029 *
3030 * @param name The name of the desired item.
3031 * @param defaultValue the value to be returned if no value of the desired
3032 * type is stored with the given name.
3033 *
3034 * @return the value of an item that previously added with putExtra()
3035 * or the default value if none was found.
3036 *
3037 * @see #putExtra(String, char)
3038 */
3039 public char getCharExtra(String name, char defaultValue) {
3040 return mExtras == null ? defaultValue :
3041 mExtras.getChar(name, defaultValue);
3042 }
3043
3044 /**
3045 * Retrieve extended data from the intent.
3046 *
3047 * @param name The name of the desired item.
3048 * @param defaultValue the value to be returned if no value of the desired
3049 * type is stored with the given name.
3050 *
3051 * @return the value of an item that previously added with putExtra()
3052 * or the default value if none was found.
3053 *
3054 * @see #putExtra(String, int)
3055 */
3056 public int getIntExtra(String name, int defaultValue) {
3057 return mExtras == null ? defaultValue :
3058 mExtras.getInt(name, defaultValue);
3059 }
3060
3061 /**
3062 * Retrieve extended data from the intent.
3063 *
3064 * @param name The name of the desired item.
3065 * @param defaultValue the value to be returned if no value of the desired
3066 * type is stored with the given name.
3067 *
3068 * @return the value of an item that previously added with putExtra()
3069 * or the default value if none was found.
3070 *
3071 * @see #putExtra(String, long)
3072 */
3073 public long getLongExtra(String name, long defaultValue) {
3074 return mExtras == null ? defaultValue :
3075 mExtras.getLong(name, defaultValue);
3076 }
3077
3078 /**
3079 * Retrieve extended data from the intent.
3080 *
3081 * @param name The name of the desired item.
3082 * @param defaultValue the value to be returned if no value of the desired
3083 * type is stored with the given name.
3084 *
3085 * @return the value of an item that previously added with putExtra(),
3086 * or the default value if no such item is present
3087 *
3088 * @see #putExtra(String, float)
3089 */
3090 public float getFloatExtra(String name, float defaultValue) {
3091 return mExtras == null ? defaultValue :
3092 mExtras.getFloat(name, defaultValue);
3093 }
3094
3095 /**
3096 * Retrieve extended data from the intent.
3097 *
3098 * @param name The name of the desired item.
3099 * @param defaultValue the value to be returned if no value of the desired
3100 * type is stored with the given name.
3101 *
3102 * @return the value of an item that previously added with putExtra()
3103 * or the default value if none was found.
3104 *
3105 * @see #putExtra(String, double)
3106 */
3107 public double getDoubleExtra(String name, double defaultValue) {
3108 return mExtras == null ? defaultValue :
3109 mExtras.getDouble(name, defaultValue);
3110 }
3111
3112 /**
3113 * Retrieve extended data from the intent.
3114 *
3115 * @param name The name of the desired item.
3116 *
3117 * @return the value of an item that previously added with putExtra()
3118 * or null if no String value was found.
3119 *
3120 * @see #putExtra(String, String)
3121 */
3122 public String getStringExtra(String name) {
3123 return mExtras == null ? null : mExtras.getString(name);
3124 }
3125
3126 /**
3127 * Retrieve extended data from the intent.
3128 *
3129 * @param name The name of the desired item.
3130 *
3131 * @return the value of an item that previously added with putExtra()
3132 * or null if no CharSequence value was found.
3133 *
3134 * @see #putExtra(String, CharSequence)
3135 */
3136 public CharSequence getCharSequenceExtra(String name) {
3137 return mExtras == null ? null : mExtras.getCharSequence(name);
3138 }
3139
3140 /**
3141 * Retrieve extended data from the intent.
3142 *
3143 * @param name The name of the desired item.
3144 *
3145 * @return the value of an item that previously added with putExtra()
3146 * or null if no Parcelable value was found.
3147 *
3148 * @see #putExtra(String, Parcelable)
3149 */
3150 public <T extends Parcelable> T getParcelableExtra(String name) {
3151 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3152 }
3153
3154 /**
3155 * Retrieve extended data from the intent.
3156 *
3157 * @param name The name of the desired item.
3158 *
3159 * @return the value of an item that previously added with putExtra()
3160 * or null if no Parcelable[] value was found.
3161 *
3162 * @see #putExtra(String, Parcelable[])
3163 */
3164 public Parcelable[] getParcelableArrayExtra(String name) {
3165 return mExtras == null ? null : mExtras.getParcelableArray(name);
3166 }
3167
3168 /**
3169 * Retrieve extended data from the intent.
3170 *
3171 * @param name The name of the desired item.
3172 *
3173 * @return the value of an item that previously added with putExtra()
3174 * or null if no ArrayList<Parcelable> value was found.
3175 *
3176 * @see #putParcelableArrayListExtra(String, ArrayList)
3177 */
3178 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3179 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3180 }
3181
3182 /**
3183 * Retrieve extended data from the intent.
3184 *
3185 * @param name The name of the desired item.
3186 *
3187 * @return the value of an item that previously added with putExtra()
3188 * or null if no Serializable value was found.
3189 *
3190 * @see #putExtra(String, Serializable)
3191 */
3192 public Serializable getSerializableExtra(String name) {
3193 return mExtras == null ? null : mExtras.getSerializable(name);
3194 }
3195
3196 /**
3197 * Retrieve extended data from the intent.
3198 *
3199 * @param name The name of the desired item.
3200 *
3201 * @return the value of an item that previously added with putExtra()
3202 * or null if no ArrayList<Integer> value was found.
3203 *
3204 * @see #putIntegerArrayListExtra(String, ArrayList)
3205 */
3206 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3207 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3208 }
3209
3210 /**
3211 * Retrieve extended data from the intent.
3212 *
3213 * @param name The name of the desired item.
3214 *
3215 * @return the value of an item that previously added with putExtra()
3216 * or null if no ArrayList<String> value was found.
3217 *
3218 * @see #putStringArrayListExtra(String, ArrayList)
3219 */
3220 public ArrayList<String> getStringArrayListExtra(String name) {
3221 return mExtras == null ? null : mExtras.getStringArrayList(name);
3222 }
3223
3224 /**
3225 * Retrieve extended data from the intent.
3226 *
3227 * @param name The name of the desired item.
3228 *
3229 * @return the value of an item that previously added with putExtra()
3230 * or null if no boolean array value was found.
3231 *
3232 * @see #putExtra(String, boolean[])
3233 */
3234 public boolean[] getBooleanArrayExtra(String name) {
3235 return mExtras == null ? null : mExtras.getBooleanArray(name);
3236 }
3237
3238 /**
3239 * Retrieve extended data from the intent.
3240 *
3241 * @param name The name of the desired item.
3242 *
3243 * @return the value of an item that previously added with putExtra()
3244 * or null if no byte array value was found.
3245 *
3246 * @see #putExtra(String, byte[])
3247 */
3248 public byte[] getByteArrayExtra(String name) {
3249 return mExtras == null ? null : mExtras.getByteArray(name);
3250 }
3251
3252 /**
3253 * Retrieve extended data from the intent.
3254 *
3255 * @param name The name of the desired item.
3256 *
3257 * @return the value of an item that previously added with putExtra()
3258 * or null if no short array value was found.
3259 *
3260 * @see #putExtra(String, short[])
3261 */
3262 public short[] getShortArrayExtra(String name) {
3263 return mExtras == null ? null : mExtras.getShortArray(name);
3264 }
3265
3266 /**
3267 * Retrieve extended data from the intent.
3268 *
3269 * @param name The name of the desired item.
3270 *
3271 * @return the value of an item that previously added with putExtra()
3272 * or null if no char array value was found.
3273 *
3274 * @see #putExtra(String, char[])
3275 */
3276 public char[] getCharArrayExtra(String name) {
3277 return mExtras == null ? null : mExtras.getCharArray(name);
3278 }
3279
3280 /**
3281 * Retrieve extended data from the intent.
3282 *
3283 * @param name The name of the desired item.
3284 *
3285 * @return the value of an item that previously added with putExtra()
3286 * or null if no int array value was found.
3287 *
3288 * @see #putExtra(String, int[])
3289 */
3290 public int[] getIntArrayExtra(String name) {
3291 return mExtras == null ? null : mExtras.getIntArray(name);
3292 }
3293
3294 /**
3295 * Retrieve extended data from the intent.
3296 *
3297 * @param name The name of the desired item.
3298 *
3299 * @return the value of an item that previously added with putExtra()
3300 * or null if no long array value was found.
3301 *
3302 * @see #putExtra(String, long[])
3303 */
3304 public long[] getLongArrayExtra(String name) {
3305 return mExtras == null ? null : mExtras.getLongArray(name);
3306 }
3307
3308 /**
3309 * Retrieve extended data from the intent.
3310 *
3311 * @param name The name of the desired item.
3312 *
3313 * @return the value of an item that previously added with putExtra()
3314 * or null if no float array value was found.
3315 *
3316 * @see #putExtra(String, float[])
3317 */
3318 public float[] getFloatArrayExtra(String name) {
3319 return mExtras == null ? null : mExtras.getFloatArray(name);
3320 }
3321
3322 /**
3323 * Retrieve extended data from the intent.
3324 *
3325 * @param name The name of the desired item.
3326 *
3327 * @return the value of an item that previously added with putExtra()
3328 * or null if no double array value was found.
3329 *
3330 * @see #putExtra(String, double[])
3331 */
3332 public double[] getDoubleArrayExtra(String name) {
3333 return mExtras == null ? null : mExtras.getDoubleArray(name);
3334 }
3335
3336 /**
3337 * Retrieve extended data from the intent.
3338 *
3339 * @param name The name of the desired item.
3340 *
3341 * @return the value of an item that previously added with putExtra()
3342 * or null if no String array value was found.
3343 *
3344 * @see #putExtra(String, String[])
3345 */
3346 public String[] getStringArrayExtra(String name) {
3347 return mExtras == null ? null : mExtras.getStringArray(name);
3348 }
3349
3350 /**
3351 * Retrieve extended data from the intent.
3352 *
3353 * @param name The name of the desired item.
3354 *
3355 * @return the value of an item that previously added with putExtra()
3356 * or null if no Bundle value was found.
3357 *
3358 * @see #putExtra(String, Bundle)
3359 */
3360 public Bundle getBundleExtra(String name) {
3361 return mExtras == null ? null : mExtras.getBundle(name);
3362 }
3363
3364 /**
3365 * Retrieve extended data from the intent.
3366 *
3367 * @param name The name of the desired item.
3368 *
3369 * @return the value of an item that previously added with putExtra()
3370 * or null if no IBinder value was found.
3371 *
3372 * @see #putExtra(String, IBinder)
3373 *
3374 * @deprecated
3375 * @hide
3376 */
3377 @Deprecated
3378 public IBinder getIBinderExtra(String name) {
3379 return mExtras == null ? null : mExtras.getIBinder(name);
3380 }
3381
3382 /**
3383 * Retrieve extended data from the intent.
3384 *
3385 * @param name The name of the desired item.
3386 * @param defaultValue The default value to return in case no item is
3387 * associated with the key 'name'
3388 *
3389 * @return the value of an item that previously added with putExtra()
3390 * or defaultValue if none was found.
3391 *
3392 * @see #putExtra
3393 *
3394 * @deprecated
3395 * @hide
3396 */
3397 @Deprecated
3398 public Object getExtra(String name, Object defaultValue) {
3399 Object result = defaultValue;
3400 if (mExtras != null) {
3401 Object result2 = mExtras.get(name);
3402 if (result2 != null) {
3403 result = result2;
3404 }
3405 }
3406
3407 return result;
3408 }
3409
3410 /**
3411 * Retrieves a map of extended data from the intent.
3412 *
3413 * @return the map of all extras previously added with putExtra(),
3414 * or null if none have been added.
3415 */
3416 public Bundle getExtras() {
3417 return (mExtras != null)
3418 ? new Bundle(mExtras)
3419 : null;
3420 }
3421
3422 /**
3423 * Retrieve any special flags associated with this intent. You will
3424 * normally just set them with {@link #setFlags} and let the system
3425 * take the appropriate action with them.
3426 *
3427 * @return int The currently set flags.
3428 *
3429 * @see #setFlags
3430 */
3431 public int getFlags() {
3432 return mFlags;
3433 }
3434
3435 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003436 * Retrieve the application package name this Intent is limited to. When
3437 * resolving an Intent, if non-null this limits the resolution to only
3438 * components in the given application package.
3439 *
3440 * @return The name of the application package for the Intent.
3441 *
3442 * @see #resolveActivity
3443 * @see #setPackage
3444 */
3445 public String getPackage() {
3446 return mPackage;
3447 }
3448
3449 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003450 * Retrieve the concrete component associated with the intent. When receiving
3451 * an intent, this is the component that was found to best handle it (that is,
3452 * yourself) and will always be non-null; in all other cases it will be
3453 * null unless explicitly set.
3454 *
3455 * @return The name of the application component to handle the intent.
3456 *
3457 * @see #resolveActivity
3458 * @see #setComponent
3459 */
3460 public ComponentName getComponent() {
3461 return mComponent;
3462 }
3463
3464 /**
3465 * Return the Activity component that should be used to handle this intent.
3466 * The appropriate component is determined based on the information in the
3467 * intent, evaluated as follows:
3468 *
3469 * <p>If {@link #getComponent} returns an explicit class, that is returned
3470 * without any further consideration.
3471 *
3472 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3473 * category to be considered.
3474 *
3475 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3476 * action.
3477 *
3478 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3479 * this type.
3480 *
3481 * <p>If {@link #addCategory} has added any categories, the activity must
3482 * handle ALL of the categories specified.
3483 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003484 * <p>If {@link #getPackage} is non-NULL, only activity components in
3485 * that application package will be considered.
3486 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003487 * <p>If there are no activities that satisfy all of these conditions, a
3488 * null string is returned.
3489 *
3490 * <p>If multiple activities are found to satisfy the intent, the one with
3491 * the highest priority will be used. If there are multiple activities
3492 * with the same priority, the system will either pick the best activity
3493 * based on user preference, or resolve to a system class that will allow
3494 * the user to pick an activity and forward from there.
3495 *
3496 * <p>This method is implemented simply by calling
3497 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3498 * true.</p>
3499 * <p> This API is called for you as part of starting an activity from an
3500 * intent. You do not normally need to call it yourself.</p>
3501 *
3502 * @param pm The package manager with which to resolve the Intent.
3503 *
3504 * @return Name of the component implementing an activity that can
3505 * display the intent.
3506 *
3507 * @see #setComponent
3508 * @see #getComponent
3509 * @see #resolveActivityInfo
3510 */
3511 public ComponentName resolveActivity(PackageManager pm) {
3512 if (mComponent != null) {
3513 return mComponent;
3514 }
3515
3516 ResolveInfo info = pm.resolveActivity(
3517 this, PackageManager.MATCH_DEFAULT_ONLY);
3518 if (info != null) {
3519 return new ComponentName(
3520 info.activityInfo.applicationInfo.packageName,
3521 info.activityInfo.name);
3522 }
3523
3524 return null;
3525 }
3526
3527 /**
3528 * Resolve the Intent into an {@link ActivityInfo}
3529 * describing the activity that should execute the intent. Resolution
3530 * follows the same rules as described for {@link #resolveActivity}, but
3531 * you get back the completely information about the resolved activity
3532 * instead of just its class name.
3533 *
3534 * @param pm The package manager with which to resolve the Intent.
3535 * @param flags Addition information to retrieve as per
3536 * {@link PackageManager#getActivityInfo(ComponentName, int)
3537 * PackageManager.getActivityInfo()}.
3538 *
3539 * @return PackageManager.ActivityInfo
3540 *
3541 * @see #resolveActivity
3542 */
3543 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3544 ActivityInfo ai = null;
3545 if (mComponent != null) {
3546 try {
3547 ai = pm.getActivityInfo(mComponent, flags);
3548 } catch (PackageManager.NameNotFoundException e) {
3549 // ignore
3550 }
3551 } else {
3552 ResolveInfo info = pm.resolveActivity(
3553 this, PackageManager.MATCH_DEFAULT_ONLY);
3554 if (info != null) {
3555 ai = info.activityInfo;
3556 }
3557 }
3558
3559 return ai;
3560 }
3561
3562 /**
3563 * Set the general action to be performed.
3564 *
3565 * @param action An action name, such as ACTION_VIEW. Application-specific
3566 * actions should be prefixed with the vendor's package name.
3567 *
3568 * @return Returns the same Intent object, for chaining multiple calls
3569 * into a single statement.
3570 *
3571 * @see #getAction
3572 */
3573 public Intent setAction(String action) {
3574 mAction = action;
3575 return this;
3576 }
3577
3578 /**
3579 * Set the data this intent is operating on. This method automatically
3580 * clears any type that was previously set by {@link #setType}.
3581 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003582 * <p><em>Note: scheme and host name matching in the Android framework is
3583 * case-sensitive, unlike the formal RFC. As a result,
3584 * you should always ensure that you write your Uri with these elements
3585 * using lower case letters, and normalize any Uris you receive from
3586 * outside of Android to ensure the scheme and host is lower case.</em></p>
3587 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003588 * @param data The URI of the data this intent is now targeting.
3589 *
3590 * @return Returns the same Intent object, for chaining multiple calls
3591 * into a single statement.
3592 *
3593 * @see #getData
3594 * @see #setType
3595 * @see #setDataAndType
3596 */
3597 public Intent setData(Uri data) {
3598 mData = data;
3599 mType = null;
3600 return this;
3601 }
3602
3603 /**
3604 * Set an explicit MIME data type. This is used to create intents that
3605 * only specify a type and not data, for example to indicate the type of
3606 * data to return. This method automatically clears any data that was
3607 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003608 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003609 * <p><em>Note: MIME type matching in the Android framework is
3610 * case-sensitive, unlike formal RFC MIME types. As a result,
3611 * you should always write your MIME types with lower case letters,
3612 * and any MIME types you receive from outside of Android should be
3613 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003614 *
3615 * @param type The MIME type of the data being handled by this intent.
3616 *
3617 * @return Returns the same Intent object, for chaining multiple calls
3618 * into a single statement.
3619 *
3620 * @see #getType
3621 * @see #setData
3622 * @see #setDataAndType
3623 */
3624 public Intent setType(String type) {
3625 mData = null;
3626 mType = type;
3627 return this;
3628 }
3629
3630 /**
3631 * (Usually optional) Set the data for the intent along with an explicit
3632 * MIME data type. This method should very rarely be used -- it allows you
3633 * to override the MIME type that would ordinarily be inferred from the
3634 * data with your own type given here.
3635 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003636 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3637 * Android framework is case-sensitive, unlike the formal RFC definitions.
3638 * As a result, you should always write these elements with lower case letters,
3639 * and normalize any MIME types or Uris you receive from
3640 * outside of Android to ensure these elements are lower case before
3641 * supplying them here.</em></p>
3642 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003643 * @param data The URI of the data this intent is now targeting.
3644 * @param type The MIME type of the data being handled by this intent.
3645 *
3646 * @return Returns the same Intent object, for chaining multiple calls
3647 * into a single statement.
3648 *
3649 * @see #setData
3650 * @see #setType
3651 */
3652 public Intent setDataAndType(Uri data, String type) {
3653 mData = data;
3654 mType = type;
3655 return this;
3656 }
3657
3658 /**
3659 * Add a new category to the intent. Categories provide additional detail
3660 * about the action the intent is perform. When resolving an intent, only
3661 * activities that provide <em>all</em> of the requested categories will be
3662 * used.
3663 *
3664 * @param category The desired category. This can be either one of the
3665 * predefined Intent categories, or a custom category in your own
3666 * namespace.
3667 *
3668 * @return Returns the same Intent object, for chaining multiple calls
3669 * into a single statement.
3670 *
3671 * @see #hasCategory
3672 * @see #removeCategory
3673 */
3674 public Intent addCategory(String category) {
3675 if (mCategories == null) {
3676 mCategories = new HashSet<String>();
3677 }
3678 mCategories.add(category);
3679 return this;
3680 }
3681
3682 /**
3683 * Remove an category from an intent.
3684 *
3685 * @param category The category to remove.
3686 *
3687 * @see #addCategory
3688 */
3689 public void removeCategory(String category) {
3690 if (mCategories != null) {
3691 mCategories.remove(category);
3692 if (mCategories.size() == 0) {
3693 mCategories = null;
3694 }
3695 }
3696 }
3697
3698 /**
3699 * Add extended data to the intent. The name must include a package
3700 * prefix, for example the app com.android.contacts would use names
3701 * like "com.android.contacts.ShowAll".
3702 *
3703 * @param name The name of the extra data, with package prefix.
3704 * @param value The boolean data value.
3705 *
3706 * @return Returns the same Intent object, for chaining multiple calls
3707 * into a single statement.
3708 *
3709 * @see #putExtras
3710 * @see #removeExtra
3711 * @see #getBooleanExtra(String, boolean)
3712 */
3713 public Intent putExtra(String name, boolean value) {
3714 if (mExtras == null) {
3715 mExtras = new Bundle();
3716 }
3717 mExtras.putBoolean(name, value);
3718 return this;
3719 }
3720
3721 /**
3722 * Add extended data to the intent. The name must include a package
3723 * prefix, for example the app com.android.contacts would use names
3724 * like "com.android.contacts.ShowAll".
3725 *
3726 * @param name The name of the extra data, with package prefix.
3727 * @param value The byte data value.
3728 *
3729 * @return Returns the same Intent object, for chaining multiple calls
3730 * into a single statement.
3731 *
3732 * @see #putExtras
3733 * @see #removeExtra
3734 * @see #getByteExtra(String, byte)
3735 */
3736 public Intent putExtra(String name, byte value) {
3737 if (mExtras == null) {
3738 mExtras = new Bundle();
3739 }
3740 mExtras.putByte(name, value);
3741 return this;
3742 }
3743
3744 /**
3745 * Add extended data to the intent. The name must include a package
3746 * prefix, for example the app com.android.contacts would use names
3747 * like "com.android.contacts.ShowAll".
3748 *
3749 * @param name The name of the extra data, with package prefix.
3750 * @param value The char data value.
3751 *
3752 * @return Returns the same Intent object, for chaining multiple calls
3753 * into a single statement.
3754 *
3755 * @see #putExtras
3756 * @see #removeExtra
3757 * @see #getCharExtra(String, char)
3758 */
3759 public Intent putExtra(String name, char value) {
3760 if (mExtras == null) {
3761 mExtras = new Bundle();
3762 }
3763 mExtras.putChar(name, value);
3764 return this;
3765 }
3766
3767 /**
3768 * Add extended data to the intent. The name must include a package
3769 * prefix, for example the app com.android.contacts would use names
3770 * like "com.android.contacts.ShowAll".
3771 *
3772 * @param name The name of the extra data, with package prefix.
3773 * @param value The short data value.
3774 *
3775 * @return Returns the same Intent object, for chaining multiple calls
3776 * into a single statement.
3777 *
3778 * @see #putExtras
3779 * @see #removeExtra
3780 * @see #getShortExtra(String, short)
3781 */
3782 public Intent putExtra(String name, short value) {
3783 if (mExtras == null) {
3784 mExtras = new Bundle();
3785 }
3786 mExtras.putShort(name, value);
3787 return this;
3788 }
3789
3790 /**
3791 * Add extended data to the intent. The name must include a package
3792 * prefix, for example the app com.android.contacts would use names
3793 * like "com.android.contacts.ShowAll".
3794 *
3795 * @param name The name of the extra data, with package prefix.
3796 * @param value The integer data value.
3797 *
3798 * @return Returns the same Intent object, for chaining multiple calls
3799 * into a single statement.
3800 *
3801 * @see #putExtras
3802 * @see #removeExtra
3803 * @see #getIntExtra(String, int)
3804 */
3805 public Intent putExtra(String name, int value) {
3806 if (mExtras == null) {
3807 mExtras = new Bundle();
3808 }
3809 mExtras.putInt(name, value);
3810 return this;
3811 }
3812
3813 /**
3814 * Add extended data to the intent. The name must include a package
3815 * prefix, for example the app com.android.contacts would use names
3816 * like "com.android.contacts.ShowAll".
3817 *
3818 * @param name The name of the extra data, with package prefix.
3819 * @param value The long data value.
3820 *
3821 * @return Returns the same Intent object, for chaining multiple calls
3822 * into a single statement.
3823 *
3824 * @see #putExtras
3825 * @see #removeExtra
3826 * @see #getLongExtra(String, long)
3827 */
3828 public Intent putExtra(String name, long value) {
3829 if (mExtras == null) {
3830 mExtras = new Bundle();
3831 }
3832 mExtras.putLong(name, value);
3833 return this;
3834 }
3835
3836 /**
3837 * Add extended data to the intent. The name must include a package
3838 * prefix, for example the app com.android.contacts would use names
3839 * like "com.android.contacts.ShowAll".
3840 *
3841 * @param name The name of the extra data, with package prefix.
3842 * @param value The float data value.
3843 *
3844 * @return Returns the same Intent object, for chaining multiple calls
3845 * into a single statement.
3846 *
3847 * @see #putExtras
3848 * @see #removeExtra
3849 * @see #getFloatExtra(String, float)
3850 */
3851 public Intent putExtra(String name, float value) {
3852 if (mExtras == null) {
3853 mExtras = new Bundle();
3854 }
3855 mExtras.putFloat(name, value);
3856 return this;
3857 }
3858
3859 /**
3860 * Add extended data to the intent. The name must include a package
3861 * prefix, for example the app com.android.contacts would use names
3862 * like "com.android.contacts.ShowAll".
3863 *
3864 * @param name The name of the extra data, with package prefix.
3865 * @param value The double data value.
3866 *
3867 * @return Returns the same Intent object, for chaining multiple calls
3868 * into a single statement.
3869 *
3870 * @see #putExtras
3871 * @see #removeExtra
3872 * @see #getDoubleExtra(String, double)
3873 */
3874 public Intent putExtra(String name, double value) {
3875 if (mExtras == null) {
3876 mExtras = new Bundle();
3877 }
3878 mExtras.putDouble(name, value);
3879 return this;
3880 }
3881
3882 /**
3883 * Add extended data to the intent. The name must include a package
3884 * prefix, for example the app com.android.contacts would use names
3885 * like "com.android.contacts.ShowAll".
3886 *
3887 * @param name The name of the extra data, with package prefix.
3888 * @param value The String data value.
3889 *
3890 * @return Returns the same Intent object, for chaining multiple calls
3891 * into a single statement.
3892 *
3893 * @see #putExtras
3894 * @see #removeExtra
3895 * @see #getStringExtra(String)
3896 */
3897 public Intent putExtra(String name, String value) {
3898 if (mExtras == null) {
3899 mExtras = new Bundle();
3900 }
3901 mExtras.putString(name, value);
3902 return this;
3903 }
3904
3905 /**
3906 * Add extended data to the intent. The name must include a package
3907 * prefix, for example the app com.android.contacts would use names
3908 * like "com.android.contacts.ShowAll".
3909 *
3910 * @param name The name of the extra data, with package prefix.
3911 * @param value The CharSequence data value.
3912 *
3913 * @return Returns the same Intent object, for chaining multiple calls
3914 * into a single statement.
3915 *
3916 * @see #putExtras
3917 * @see #removeExtra
3918 * @see #getCharSequenceExtra(String)
3919 */
3920 public Intent putExtra(String name, CharSequence value) {
3921 if (mExtras == null) {
3922 mExtras = new Bundle();
3923 }
3924 mExtras.putCharSequence(name, value);
3925 return this;
3926 }
3927
3928 /**
3929 * Add extended data to the intent. The name must include a package
3930 * prefix, for example the app com.android.contacts would use names
3931 * like "com.android.contacts.ShowAll".
3932 *
3933 * @param name The name of the extra data, with package prefix.
3934 * @param value The Parcelable data value.
3935 *
3936 * @return Returns the same Intent object, for chaining multiple calls
3937 * into a single statement.
3938 *
3939 * @see #putExtras
3940 * @see #removeExtra
3941 * @see #getParcelableExtra(String)
3942 */
3943 public Intent putExtra(String name, Parcelable value) {
3944 if (mExtras == null) {
3945 mExtras = new Bundle();
3946 }
3947 mExtras.putParcelable(name, value);
3948 return this;
3949 }
3950
3951 /**
3952 * Add extended data to the intent. The name must include a package
3953 * prefix, for example the app com.android.contacts would use names
3954 * like "com.android.contacts.ShowAll".
3955 *
3956 * @param name The name of the extra data, with package prefix.
3957 * @param value The Parcelable[] data value.
3958 *
3959 * @return Returns the same Intent object, for chaining multiple calls
3960 * into a single statement.
3961 *
3962 * @see #putExtras
3963 * @see #removeExtra
3964 * @see #getParcelableArrayExtra(String)
3965 */
3966 public Intent putExtra(String name, Parcelable[] value) {
3967 if (mExtras == null) {
3968 mExtras = new Bundle();
3969 }
3970 mExtras.putParcelableArray(name, value);
3971 return this;
3972 }
3973
3974 /**
3975 * Add extended data to the intent. The name must include a package
3976 * prefix, for example the app com.android.contacts would use names
3977 * like "com.android.contacts.ShowAll".
3978 *
3979 * @param name The name of the extra data, with package prefix.
3980 * @param value The ArrayList<Parcelable> data value.
3981 *
3982 * @return Returns the same Intent object, for chaining multiple calls
3983 * into a single statement.
3984 *
3985 * @see #putExtras
3986 * @see #removeExtra
3987 * @see #getParcelableArrayListExtra(String)
3988 */
3989 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3990 if (mExtras == null) {
3991 mExtras = new Bundle();
3992 }
3993 mExtras.putParcelableArrayList(name, value);
3994 return this;
3995 }
3996
3997 /**
3998 * Add extended data to the intent. The name must include a package
3999 * prefix, for example the app com.android.contacts would use names
4000 * like "com.android.contacts.ShowAll".
4001 *
4002 * @param name The name of the extra data, with package prefix.
4003 * @param value The ArrayList<Integer> data value.
4004 *
4005 * @return Returns the same Intent object, for chaining multiple calls
4006 * into a single statement.
4007 *
4008 * @see #putExtras
4009 * @see #removeExtra
4010 * @see #getIntegerArrayListExtra(String)
4011 */
4012 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4013 if (mExtras == null) {
4014 mExtras = new Bundle();
4015 }
4016 mExtras.putIntegerArrayList(name, value);
4017 return this;
4018 }
4019
4020 /**
4021 * Add extended data to the intent. The name must include a package
4022 * prefix, for example the app com.android.contacts would use names
4023 * like "com.android.contacts.ShowAll".
4024 *
4025 * @param name The name of the extra data, with package prefix.
4026 * @param value The ArrayList<String> data value.
4027 *
4028 * @return Returns the same Intent object, for chaining multiple calls
4029 * into a single statement.
4030 *
4031 * @see #putExtras
4032 * @see #removeExtra
4033 * @see #getStringArrayListExtra(String)
4034 */
4035 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4036 if (mExtras == null) {
4037 mExtras = new Bundle();
4038 }
4039 mExtras.putStringArrayList(name, value);
4040 return this;
4041 }
4042
4043 /**
4044 * Add extended data to the intent. The name must include a package
4045 * prefix, for example the app com.android.contacts would use names
4046 * like "com.android.contacts.ShowAll".
4047 *
4048 * @param name The name of the extra data, with package prefix.
4049 * @param value The Serializable data value.
4050 *
4051 * @return Returns the same Intent object, for chaining multiple calls
4052 * into a single statement.
4053 *
4054 * @see #putExtras
4055 * @see #removeExtra
4056 * @see #getSerializableExtra(String)
4057 */
4058 public Intent putExtra(String name, Serializable value) {
4059 if (mExtras == null) {
4060 mExtras = new Bundle();
4061 }
4062 mExtras.putSerializable(name, value);
4063 return this;
4064 }
4065
4066 /**
4067 * Add extended data to the intent. The name must include a package
4068 * prefix, for example the app com.android.contacts would use names
4069 * like "com.android.contacts.ShowAll".
4070 *
4071 * @param name The name of the extra data, with package prefix.
4072 * @param value The boolean array data value.
4073 *
4074 * @return Returns the same Intent object, for chaining multiple calls
4075 * into a single statement.
4076 *
4077 * @see #putExtras
4078 * @see #removeExtra
4079 * @see #getBooleanArrayExtra(String)
4080 */
4081 public Intent putExtra(String name, boolean[] value) {
4082 if (mExtras == null) {
4083 mExtras = new Bundle();
4084 }
4085 mExtras.putBooleanArray(name, value);
4086 return this;
4087 }
4088
4089 /**
4090 * Add extended data to the intent. The name must include a package
4091 * prefix, for example the app com.android.contacts would use names
4092 * like "com.android.contacts.ShowAll".
4093 *
4094 * @param name The name of the extra data, with package prefix.
4095 * @param value The byte array data value.
4096 *
4097 * @return Returns the same Intent object, for chaining multiple calls
4098 * into a single statement.
4099 *
4100 * @see #putExtras
4101 * @see #removeExtra
4102 * @see #getByteArrayExtra(String)
4103 */
4104 public Intent putExtra(String name, byte[] value) {
4105 if (mExtras == null) {
4106 mExtras = new Bundle();
4107 }
4108 mExtras.putByteArray(name, value);
4109 return this;
4110 }
4111
4112 /**
4113 * Add extended data to the intent. The name must include a package
4114 * prefix, for example the app com.android.contacts would use names
4115 * like "com.android.contacts.ShowAll".
4116 *
4117 * @param name The name of the extra data, with package prefix.
4118 * @param value The short array data value.
4119 *
4120 * @return Returns the same Intent object, for chaining multiple calls
4121 * into a single statement.
4122 *
4123 * @see #putExtras
4124 * @see #removeExtra
4125 * @see #getShortArrayExtra(String)
4126 */
4127 public Intent putExtra(String name, short[] value) {
4128 if (mExtras == null) {
4129 mExtras = new Bundle();
4130 }
4131 mExtras.putShortArray(name, value);
4132 return this;
4133 }
4134
4135 /**
4136 * Add extended data to the intent. The name must include a package
4137 * prefix, for example the app com.android.contacts would use names
4138 * like "com.android.contacts.ShowAll".
4139 *
4140 * @param name The name of the extra data, with package prefix.
4141 * @param value The char array data value.
4142 *
4143 * @return Returns the same Intent object, for chaining multiple calls
4144 * into a single statement.
4145 *
4146 * @see #putExtras
4147 * @see #removeExtra
4148 * @see #getCharArrayExtra(String)
4149 */
4150 public Intent putExtra(String name, char[] value) {
4151 if (mExtras == null) {
4152 mExtras = new Bundle();
4153 }
4154 mExtras.putCharArray(name, value);
4155 return this;
4156 }
4157
4158 /**
4159 * Add extended data to the intent. The name must include a package
4160 * prefix, for example the app com.android.contacts would use names
4161 * like "com.android.contacts.ShowAll".
4162 *
4163 * @param name The name of the extra data, with package prefix.
4164 * @param value The int array data value.
4165 *
4166 * @return Returns the same Intent object, for chaining multiple calls
4167 * into a single statement.
4168 *
4169 * @see #putExtras
4170 * @see #removeExtra
4171 * @see #getIntArrayExtra(String)
4172 */
4173 public Intent putExtra(String name, int[] value) {
4174 if (mExtras == null) {
4175 mExtras = new Bundle();
4176 }
4177 mExtras.putIntArray(name, value);
4178 return this;
4179 }
4180
4181 /**
4182 * Add extended data to the intent. The name must include a package
4183 * prefix, for example the app com.android.contacts would use names
4184 * like "com.android.contacts.ShowAll".
4185 *
4186 * @param name The name of the extra data, with package prefix.
4187 * @param value The byte array data value.
4188 *
4189 * @return Returns the same Intent object, for chaining multiple calls
4190 * into a single statement.
4191 *
4192 * @see #putExtras
4193 * @see #removeExtra
4194 * @see #getLongArrayExtra(String)
4195 */
4196 public Intent putExtra(String name, long[] value) {
4197 if (mExtras == null) {
4198 mExtras = new Bundle();
4199 }
4200 mExtras.putLongArray(name, value);
4201 return this;
4202 }
4203
4204 /**
4205 * Add extended data to the intent. The name must include a package
4206 * prefix, for example the app com.android.contacts would use names
4207 * like "com.android.contacts.ShowAll".
4208 *
4209 * @param name The name of the extra data, with package prefix.
4210 * @param value The float array data value.
4211 *
4212 * @return Returns the same Intent object, for chaining multiple calls
4213 * into a single statement.
4214 *
4215 * @see #putExtras
4216 * @see #removeExtra
4217 * @see #getFloatArrayExtra(String)
4218 */
4219 public Intent putExtra(String name, float[] value) {
4220 if (mExtras == null) {
4221 mExtras = new Bundle();
4222 }
4223 mExtras.putFloatArray(name, value);
4224 return this;
4225 }
4226
4227 /**
4228 * Add extended data to the intent. The name must include a package
4229 * prefix, for example the app com.android.contacts would use names
4230 * like "com.android.contacts.ShowAll".
4231 *
4232 * @param name The name of the extra data, with package prefix.
4233 * @param value The double array data value.
4234 *
4235 * @return Returns the same Intent object, for chaining multiple calls
4236 * into a single statement.
4237 *
4238 * @see #putExtras
4239 * @see #removeExtra
4240 * @see #getDoubleArrayExtra(String)
4241 */
4242 public Intent putExtra(String name, double[] value) {
4243 if (mExtras == null) {
4244 mExtras = new Bundle();
4245 }
4246 mExtras.putDoubleArray(name, value);
4247 return this;
4248 }
4249
4250 /**
4251 * Add extended data to the intent. The name must include a package
4252 * prefix, for example the app com.android.contacts would use names
4253 * like "com.android.contacts.ShowAll".
4254 *
4255 * @param name The name of the extra data, with package prefix.
4256 * @param value The String array data value.
4257 *
4258 * @return Returns the same Intent object, for chaining multiple calls
4259 * into a single statement.
4260 *
4261 * @see #putExtras
4262 * @see #removeExtra
4263 * @see #getStringArrayExtra(String)
4264 */
4265 public Intent putExtra(String name, String[] value) {
4266 if (mExtras == null) {
4267 mExtras = new Bundle();
4268 }
4269 mExtras.putStringArray(name, value);
4270 return this;
4271 }
4272
4273 /**
4274 * Add extended data to the intent. The name must include a package
4275 * prefix, for example the app com.android.contacts would use names
4276 * like "com.android.contacts.ShowAll".
4277 *
4278 * @param name The name of the extra data, with package prefix.
4279 * @param value The Bundle data value.
4280 *
4281 * @return Returns the same Intent object, for chaining multiple calls
4282 * into a single statement.
4283 *
4284 * @see #putExtras
4285 * @see #removeExtra
4286 * @see #getBundleExtra(String)
4287 */
4288 public Intent putExtra(String name, Bundle value) {
4289 if (mExtras == null) {
4290 mExtras = new Bundle();
4291 }
4292 mExtras.putBundle(name, value);
4293 return this;
4294 }
4295
4296 /**
4297 * Add extended data to the intent. The name must include a package
4298 * prefix, for example the app com.android.contacts would use names
4299 * like "com.android.contacts.ShowAll".
4300 *
4301 * @param name The name of the extra data, with package prefix.
4302 * @param value The IBinder data value.
4303 *
4304 * @return Returns the same Intent object, for chaining multiple calls
4305 * into a single statement.
4306 *
4307 * @see #putExtras
4308 * @see #removeExtra
4309 * @see #getIBinderExtra(String)
4310 *
4311 * @deprecated
4312 * @hide
4313 */
4314 @Deprecated
4315 public Intent putExtra(String name, IBinder value) {
4316 if (mExtras == null) {
4317 mExtras = new Bundle();
4318 }
4319 mExtras.putIBinder(name, value);
4320 return this;
4321 }
4322
4323 /**
4324 * Copy all extras in 'src' in to this intent.
4325 *
4326 * @param src Contains the extras to copy.
4327 *
4328 * @see #putExtra
4329 */
4330 public Intent putExtras(Intent src) {
4331 if (src.mExtras != null) {
4332 if (mExtras == null) {
4333 mExtras = new Bundle(src.mExtras);
4334 } else {
4335 mExtras.putAll(src.mExtras);
4336 }
4337 }
4338 return this;
4339 }
4340
4341 /**
4342 * Add a set of extended data to the intent. The keys must include a package
4343 * prefix, for example the app com.android.contacts would use names
4344 * like "com.android.contacts.ShowAll".
4345 *
4346 * @param extras The Bundle of extras to add to this intent.
4347 *
4348 * @see #putExtra
4349 * @see #removeExtra
4350 */
4351 public Intent putExtras(Bundle extras) {
4352 if (mExtras == null) {
4353 mExtras = new Bundle();
4354 }
4355 mExtras.putAll(extras);
4356 return this;
4357 }
4358
4359 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004360 * Completely replace the extras in the Intent with the extras in the
4361 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004362 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004363 * @param src The exact extras contained in this Intent are copied
4364 * into the target intent, replacing any that were previously there.
4365 */
4366 public Intent replaceExtras(Intent src) {
4367 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4368 return this;
4369 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004370
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004371 /**
4372 * Completely replace the extras in the Intent with the given Bundle of
4373 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004374 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004375 * @param extras The new set of extras in the Intent, or null to erase
4376 * all extras.
4377 */
4378 public Intent replaceExtras(Bundle extras) {
4379 mExtras = extras != null ? new Bundle(extras) : null;
4380 return this;
4381 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004382
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004383 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004384 * Remove extended data from the intent.
4385 *
4386 * @see #putExtra
4387 */
4388 public void removeExtra(String name) {
4389 if (mExtras != null) {
4390 mExtras.remove(name);
4391 if (mExtras.size() == 0) {
4392 mExtras = null;
4393 }
4394 }
4395 }
4396
4397 /**
4398 * Set special flags controlling how this intent is handled. Most values
4399 * here depend on the type of component being executed by the Intent,
4400 * specifically the FLAG_ACTIVITY_* flags are all for use with
4401 * {@link Context#startActivity Context.startActivity()} and the
4402 * FLAG_RECEIVER_* flags are all for use with
4403 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4404 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004405 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4406 * Activities and Tasks</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004407 * the behavior of your application.
4408 *
4409 * @param flags The desired flags.
4410 *
4411 * @return Returns the same Intent object, for chaining multiple calls
4412 * into a single statement.
4413 *
4414 * @see #getFlags
4415 * @see #addFlags
4416 *
4417 * @see #FLAG_GRANT_READ_URI_PERMISSION
4418 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4419 * @see #FLAG_DEBUG_LOG_RESOLUTION
4420 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004421 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004422 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004423 * @see #FLAG_ACTIVITY_CLEAR_TOP
4424 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4425 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004426 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004427 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4428 * @see #FLAG_ACTIVITY_NEW_TASK
4429 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004430 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004431 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4432 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004433 * @see #FLAG_ACTIVITY_SINGLE_TOP
4434 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4435 */
4436 public Intent setFlags(int flags) {
4437 mFlags = flags;
4438 return this;
4439 }
4440
4441 /**
4442 * Add additional flags to the intent (or with existing flags
4443 * value).
4444 *
4445 * @param flags The new flags to set.
4446 *
4447 * @return Returns the same Intent object, for chaining multiple calls
4448 * into a single statement.
4449 *
4450 * @see #setFlags
4451 */
4452 public Intent addFlags(int flags) {
4453 mFlags |= flags;
4454 return this;
4455 }
4456
4457 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004458 * (Usually optional) Set an explicit application package name that limits
4459 * the components this Intent will resolve to. If left to the default
4460 * value of null, all components in all applications will considered.
4461 * If non-null, the Intent can only match the components in the given
4462 * application package.
4463 *
4464 * @param packageName The name of the application package to handle the
4465 * intent, or null to allow any application package.
4466 *
4467 * @return Returns the same Intent object, for chaining multiple calls
4468 * into a single statement.
4469 *
4470 * @see #getPackage
4471 * @see #resolveActivity
4472 */
4473 public Intent setPackage(String packageName) {
4474 mPackage = packageName;
4475 return this;
4476 }
4477
4478 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004479 * (Usually optional) Explicitly set the component to handle the intent.
4480 * If left with the default value of null, the system will determine the
4481 * appropriate class to use based on the other fields (action, data,
4482 * type, categories) in the Intent. If this class is defined, the
4483 * specified class will always be used regardless of the other fields. You
4484 * should only set this value when you know you absolutely want a specific
4485 * class to be used; otherwise it is better to let the system find the
4486 * appropriate class so that you will respect the installed applications
4487 * and user preferences.
4488 *
4489 * @param component The name of the application component to handle the
4490 * intent, or null to let the system find one for you.
4491 *
4492 * @return Returns the same Intent object, for chaining multiple calls
4493 * into a single statement.
4494 *
4495 * @see #setClass
4496 * @see #setClassName(Context, String)
4497 * @see #setClassName(String, String)
4498 * @see #getComponent
4499 * @see #resolveActivity
4500 */
4501 public Intent setComponent(ComponentName component) {
4502 mComponent = component;
4503 return this;
4504 }
4505
4506 /**
4507 * Convenience for calling {@link #setComponent} with an
4508 * explicit class name.
4509 *
4510 * @param packageContext A Context of the application package implementing
4511 * this class.
4512 * @param className The name of a class inside of the application package
4513 * that will be used as the component for this Intent.
4514 *
4515 * @return Returns the same Intent object, for chaining multiple calls
4516 * into a single statement.
4517 *
4518 * @see #setComponent
4519 * @see #setClass
4520 */
4521 public Intent setClassName(Context packageContext, String className) {
4522 mComponent = new ComponentName(packageContext, className);
4523 return this;
4524 }
4525
4526 /**
4527 * Convenience for calling {@link #setComponent} with an
4528 * explicit application package name and class name.
4529 *
4530 * @param packageName The name of the package implementing the desired
4531 * component.
4532 * @param className The name of a class inside of the application package
4533 * that will be used as the component for this Intent.
4534 *
4535 * @return Returns the same Intent object, for chaining multiple calls
4536 * into a single statement.
4537 *
4538 * @see #setComponent
4539 * @see #setClass
4540 */
4541 public Intent setClassName(String packageName, String className) {
4542 mComponent = new ComponentName(packageName, className);
4543 return this;
4544 }
4545
4546 /**
4547 * Convenience for calling {@link #setComponent(ComponentName)} with the
4548 * name returned by a {@link Class} object.
4549 *
4550 * @param packageContext A Context of the application package implementing
4551 * this class.
4552 * @param cls The class name to set, equivalent to
4553 * <code>setClassName(context, cls.getName())</code>.
4554 *
4555 * @return Returns the same Intent object, for chaining multiple calls
4556 * into a single statement.
4557 *
4558 * @see #setComponent
4559 */
4560 public Intent setClass(Context packageContext, Class<?> cls) {
4561 mComponent = new ComponentName(packageContext, cls);
4562 return this;
4563 }
4564
4565 /**
4566 * Use with {@link #fillIn} to allow the current action value to be
4567 * overwritten, even if it is already set.
4568 */
4569 public static final int FILL_IN_ACTION = 1<<0;
4570
4571 /**
4572 * Use with {@link #fillIn} to allow the current data or type value
4573 * overwritten, even if it is already set.
4574 */
4575 public static final int FILL_IN_DATA = 1<<1;
4576
4577 /**
4578 * Use with {@link #fillIn} to allow the current categories to be
4579 * overwritten, even if they are already set.
4580 */
4581 public static final int FILL_IN_CATEGORIES = 1<<2;
4582
4583 /**
4584 * Use with {@link #fillIn} to allow the current component value to be
4585 * overwritten, even if it is already set.
4586 */
4587 public static final int FILL_IN_COMPONENT = 1<<3;
4588
4589 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004590 * Use with {@link #fillIn} to allow the current package value to be
4591 * overwritten, even if it is already set.
4592 */
4593 public static final int FILL_IN_PACKAGE = 1<<4;
4594
4595 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004596 * Copy the contents of <var>other</var> in to this object, but only
4597 * where fields are not defined by this object. For purposes of a field
4598 * being defined, the following pieces of data in the Intent are
4599 * considered to be separate fields:
4600 *
4601 * <ul>
4602 * <li> action, as set by {@link #setAction}.
4603 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4604 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4605 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004606 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004607 * <li> component, as set by {@link #setComponent(ComponentName)} or
4608 * related methods.
4609 * <li> each top-level name in the associated extras.
4610 * </ul>
4611 *
4612 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004613 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4614 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004615 * corresponding field will not be replaced if it is already set.
4616 *
Brett Chabot3e391752009-07-21 16:07:23 -07004617 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4618 * specified.
4619 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004620 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4621 * and Intent B with {action="gotit", data-type="some/thing",
4622 * categories="one","two"}.
4623 *
4624 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4625 * containing: {action="gotit", data-type="some/thing",
4626 * categories="bar"}.
4627 *
4628 * @param other Another Intent whose values are to be used to fill in
4629 * the current one.
4630 * @param flags Options to control which fields can be filled in.
4631 *
4632 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004633 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4634 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004635 */
4636 public int fillIn(Intent other, int flags) {
4637 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004638 if (other.mAction != null
4639 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004640 mAction = other.mAction;
4641 changes |= FILL_IN_ACTION;
4642 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004643 if ((other.mData != null || other.mType != null)
4644 && ((mData == null && mType == null)
4645 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646 mData = other.mData;
4647 mType = other.mType;
4648 changes |= FILL_IN_DATA;
4649 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004650 if (other.mCategories != null
4651 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004652 if (other.mCategories != null) {
4653 mCategories = new HashSet<String>(other.mCategories);
4654 }
4655 changes |= FILL_IN_CATEGORIES;
4656 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004657 if (other.mPackage != null
4658 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4659 mPackage = other.mPackage;
4660 changes |= FILL_IN_PACKAGE;
4661 }
4662 // Component is special: it can -only- be set if explicitly allowed,
4663 // since otherwise the sender could force the intent somewhere the
4664 // originator didn't intend.
4665 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004666 mComponent = other.mComponent;
4667 changes |= FILL_IN_COMPONENT;
4668 }
4669 mFlags |= other.mFlags;
4670 if (mExtras == null) {
4671 if (other.mExtras != null) {
4672 mExtras = new Bundle(other.mExtras);
4673 }
4674 } else if (other.mExtras != null) {
4675 try {
4676 Bundle newb = new Bundle(other.mExtras);
4677 newb.putAll(mExtras);
4678 mExtras = newb;
4679 } catch (RuntimeException e) {
4680 // Modifying the extras can cause us to unparcel the contents
4681 // of the bundle, and if we do this in the system process that
4682 // may fail. We really should handle this (i.e., the Bundle
4683 // impl shouldn't be on top of a plain map), but for now just
4684 // ignore it and keep the original contents. :(
4685 Log.w("Intent", "Failure filling in extras", e);
4686 }
4687 }
4688 return changes;
4689 }
4690
4691 /**
4692 * Wrapper class holding an Intent and implementing comparisons on it for
4693 * the purpose of filtering. The class implements its
4694 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4695 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4696 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4697 * on the wrapped Intent.
4698 */
4699 public static final class FilterComparison {
4700 private final Intent mIntent;
4701 private final int mHashCode;
4702
4703 public FilterComparison(Intent intent) {
4704 mIntent = intent;
4705 mHashCode = intent.filterHashCode();
4706 }
4707
4708 /**
4709 * Return the Intent that this FilterComparison represents.
4710 * @return Returns the Intent held by the FilterComparison. Do
4711 * not modify!
4712 */
4713 public Intent getIntent() {
4714 return mIntent;
4715 }
4716
4717 @Override
4718 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004719 if (obj instanceof FilterComparison) {
4720 Intent other = ((FilterComparison)obj).mIntent;
4721 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004722 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004723 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004724 }
4725
4726 @Override
4727 public int hashCode() {
4728 return mHashCode;
4729 }
4730 }
4731
4732 /**
4733 * Determine if two intents are the same for the purposes of intent
4734 * resolution (filtering). That is, if their action, data, type,
4735 * class, and categories are the same. This does <em>not</em> compare
4736 * any extra data included in the intents.
4737 *
4738 * @param other The other Intent to compare against.
4739 *
4740 * @return Returns true if action, data, type, class, and categories
4741 * are the same.
4742 */
4743 public boolean filterEquals(Intent other) {
4744 if (other == null) {
4745 return false;
4746 }
4747 if (mAction != other.mAction) {
4748 if (mAction != null) {
4749 if (!mAction.equals(other.mAction)) {
4750 return false;
4751 }
4752 } else {
4753 if (!other.mAction.equals(mAction)) {
4754 return false;
4755 }
4756 }
4757 }
4758 if (mData != other.mData) {
4759 if (mData != null) {
4760 if (!mData.equals(other.mData)) {
4761 return false;
4762 }
4763 } else {
4764 if (!other.mData.equals(mData)) {
4765 return false;
4766 }
4767 }
4768 }
4769 if (mType != other.mType) {
4770 if (mType != null) {
4771 if (!mType.equals(other.mType)) {
4772 return false;
4773 }
4774 } else {
4775 if (!other.mType.equals(mType)) {
4776 return false;
4777 }
4778 }
4779 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004780 if (mPackage != other.mPackage) {
4781 if (mPackage != null) {
4782 if (!mPackage.equals(other.mPackage)) {
4783 return false;
4784 }
4785 } else {
4786 if (!other.mPackage.equals(mPackage)) {
4787 return false;
4788 }
4789 }
4790 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004791 if (mComponent != other.mComponent) {
4792 if (mComponent != null) {
4793 if (!mComponent.equals(other.mComponent)) {
4794 return false;
4795 }
4796 } else {
4797 if (!other.mComponent.equals(mComponent)) {
4798 return false;
4799 }
4800 }
4801 }
4802 if (mCategories != other.mCategories) {
4803 if (mCategories != null) {
4804 if (!mCategories.equals(other.mCategories)) {
4805 return false;
4806 }
4807 } else {
4808 if (!other.mCategories.equals(mCategories)) {
4809 return false;
4810 }
4811 }
4812 }
4813
4814 return true;
4815 }
4816
4817 /**
4818 * Generate hash code that matches semantics of filterEquals().
4819 *
4820 * @return Returns the hash value of the action, data, type, class, and
4821 * categories.
4822 *
4823 * @see #filterEquals
4824 */
4825 public int filterHashCode() {
4826 int code = 0;
4827 if (mAction != null) {
4828 code += mAction.hashCode();
4829 }
4830 if (mData != null) {
4831 code += mData.hashCode();
4832 }
4833 if (mType != null) {
4834 code += mType.hashCode();
4835 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004836 if (mPackage != null) {
4837 code += mPackage.hashCode();
4838 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004839 if (mComponent != null) {
4840 code += mComponent.hashCode();
4841 }
4842 if (mCategories != null) {
4843 code += mCategories.hashCode();
4844 }
4845 return code;
4846 }
4847
4848 @Override
4849 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004850 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004851
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004852 b.append("Intent { ");
4853 toShortString(b, true, true);
4854 b.append(" }");
4855
4856 return b.toString();
4857 }
4858
4859 /** @hide */
4860 public String toShortString(boolean comp, boolean extras) {
4861 StringBuilder b = new StringBuilder(128);
4862 toShortString(b, comp, extras);
4863 return b.toString();
4864 }
Romain Guy4969af72009-06-17 10:53:19 -07004865
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004866 /** @hide */
4867 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4868 boolean first = true;
4869 if (mAction != null) {
4870 b.append("act=").append(mAction);
4871 first = false;
4872 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004874 if (!first) {
4875 b.append(' ');
4876 }
4877 first = false;
4878 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004879 Iterator<String> i = mCategories.iterator();
4880 boolean didone = false;
4881 while (i.hasNext()) {
4882 if (didone) b.append(",");
4883 didone = true;
4884 b.append(i.next());
4885 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004886 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004887 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004888 if (mData != null) {
4889 if (!first) {
4890 b.append(' ');
4891 }
4892 first = false;
4893 b.append("dat=").append(mData);
4894 }
4895 if (mType != null) {
4896 if (!first) {
4897 b.append(' ');
4898 }
4899 first = false;
4900 b.append("typ=").append(mType);
4901 }
4902 if (mFlags != 0) {
4903 if (!first) {
4904 b.append(' ');
4905 }
4906 first = false;
4907 b.append("flg=0x").append(Integer.toHexString(mFlags));
4908 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004909 if (mPackage != null) {
4910 if (!first) {
4911 b.append(' ');
4912 }
4913 first = false;
4914 b.append("pkg=").append(mPackage);
4915 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004916 if (comp && mComponent != null) {
4917 if (!first) {
4918 b.append(' ');
4919 }
4920 first = false;
4921 b.append("cmp=").append(mComponent.flattenToShortString());
4922 }
4923 if (extras && mExtras != null) {
4924 if (!first) {
4925 b.append(' ');
4926 }
4927 first = false;
4928 b.append("(has extras)");
4929 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004930 }
4931
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004932 /**
4933 * Call {@link #toUri} with 0 flags.
4934 * @deprecated Use {@link #toUri} instead.
4935 */
4936 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004937 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004938 return toUri(0);
4939 }
4940
4941 /**
4942 * Convert this Intent into a String holding a URI representation of it.
4943 * The returned URI string has been properly URI encoded, so it can be
4944 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
4945 * Intent's data as the base URI, with an additional fragment describing
4946 * the action, categories, type, flags, package, component, and extras.
4947 *
4948 * <p>You can convert the returned string back to an Intent with
4949 * {@link #getIntent}.
4950 *
4951 * @param flags Additional operating flags. Either 0 or
4952 * {@link #URI_INTENT_SCHEME}.
4953 *
4954 * @return Returns a URI encoding URI string describing the entire contents
4955 * of the Intent.
4956 */
4957 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004958 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004959 String scheme = null;
4960 if (mData != null) {
4961 String data = mData.toString();
4962 if ((flags&URI_INTENT_SCHEME) != 0) {
4963 final int N = data.length();
4964 for (int i=0; i<N; i++) {
4965 char c = data.charAt(i);
4966 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
4967 || c == '.' || c == '-') {
4968 continue;
4969 }
4970 if (c == ':' && i > 0) {
4971 // Valid scheme.
4972 scheme = data.substring(0, i);
4973 uri.append("intent:");
4974 data = data.substring(i+1);
4975 break;
4976 }
4977
4978 // No scheme.
4979 break;
4980 }
4981 }
4982 uri.append(data);
4983
4984 } else if ((flags&URI_INTENT_SCHEME) != 0) {
4985 uri.append("intent:");
4986 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004987
4988 uri.append("#Intent;");
4989
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004990 if (scheme != null) {
4991 uri.append("scheme=").append(scheme).append(';');
4992 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004993 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004994 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004995 }
4996 if (mCategories != null) {
4997 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004998 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004999 }
5000 }
5001 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005002 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003 }
5004 if (mFlags != 0) {
5005 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5006 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005007 if (mPackage != null) {
5008 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5009 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005010 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005011 uri.append("component=").append(Uri.encode(
5012 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005013 }
5014 if (mExtras != null) {
5015 for (String key : mExtras.keySet()) {
5016 final Object value = mExtras.get(key);
5017 char entryType =
5018 value instanceof String ? 'S' :
5019 value instanceof Boolean ? 'B' :
5020 value instanceof Byte ? 'b' :
5021 value instanceof Character ? 'c' :
5022 value instanceof Double ? 'd' :
5023 value instanceof Float ? 'f' :
5024 value instanceof Integer ? 'i' :
5025 value instanceof Long ? 'l' :
5026 value instanceof Short ? 's' :
5027 '\0';
5028
5029 if (entryType != '\0') {
5030 uri.append(entryType);
5031 uri.append('.');
5032 uri.append(Uri.encode(key));
5033 uri.append('=');
5034 uri.append(Uri.encode(value.toString()));
5035 uri.append(';');
5036 }
5037 }
5038 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005039
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005040 uri.append("end");
5041
5042 return uri.toString();
5043 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005044
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005045 public int describeContents() {
5046 return (mExtras != null) ? mExtras.describeContents() : 0;
5047 }
5048
5049 public void writeToParcel(Parcel out, int flags) {
5050 out.writeString(mAction);
5051 Uri.writeToParcel(out, mData);
5052 out.writeString(mType);
5053 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005054 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005055 ComponentName.writeToParcel(mComponent, out);
5056
5057 if (mCategories != null) {
5058 out.writeInt(mCategories.size());
5059 for (String category : mCategories) {
5060 out.writeString(category);
5061 }
5062 } else {
5063 out.writeInt(0);
5064 }
5065
5066 out.writeBundle(mExtras);
5067 }
5068
5069 public static final Parcelable.Creator<Intent> CREATOR
5070 = new Parcelable.Creator<Intent>() {
5071 public Intent createFromParcel(Parcel in) {
5072 return new Intent(in);
5073 }
5074 public Intent[] newArray(int size) {
5075 return new Intent[size];
5076 }
5077 };
5078
Dianne Hackborneb034652009-09-07 00:49:58 -07005079 /** @hide */
5080 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 readFromParcel(in);
5082 }
5083
5084 public void readFromParcel(Parcel in) {
5085 mAction = in.readString();
5086 mData = Uri.CREATOR.createFromParcel(in);
5087 mType = in.readString();
5088 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005089 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005090 mComponent = ComponentName.readFromParcel(in);
5091
5092 int N = in.readInt();
5093 if (N > 0) {
5094 mCategories = new HashSet<String>();
5095 int i;
5096 for (i=0; i<N; i++) {
5097 mCategories.add(in.readString());
5098 }
5099 } else {
5100 mCategories = null;
5101 }
5102
5103 mExtras = in.readBundle();
5104 }
5105
5106 /**
5107 * Parses the "intent" element (and its children) from XML and instantiates
5108 * an Intent object. The given XML parser should be located at the tag
5109 * where parsing should start (often named "intent"), from which the
5110 * basic action, data, type, and package and class name will be
5111 * retrieved. The function will then parse in to any child elements,
5112 * looking for <category android:name="xxx"> tags to add categories and
5113 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5114 * to the intent.
5115 *
5116 * @param resources The Resources to use when inflating resources.
5117 * @param parser The XML parser pointing at an "intent" tag.
5118 * @param attrs The AttributeSet interface for retrieving extended
5119 * attribute data at the current <var>parser</var> location.
5120 * @return An Intent object matching the XML data.
5121 * @throws XmlPullParserException If there was an XML parsing error.
5122 * @throws IOException If there was an I/O error.
5123 */
5124 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5125 throws XmlPullParserException, IOException {
5126 Intent intent = new Intent();
5127
5128 TypedArray sa = resources.obtainAttributes(attrs,
5129 com.android.internal.R.styleable.Intent);
5130
5131 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5132
5133 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5134 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5135 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5136
5137 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5138 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5139 if (packageName != null && className != null) {
5140 intent.setComponent(new ComponentName(packageName, className));
5141 }
5142
5143 sa.recycle();
5144
5145 int outerDepth = parser.getDepth();
5146 int type;
5147 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5148 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5149 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5150 continue;
5151 }
5152
5153 String nodeName = parser.getName();
5154 if (nodeName.equals("category")) {
5155 sa = resources.obtainAttributes(attrs,
5156 com.android.internal.R.styleable.IntentCategory);
5157 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5158 sa.recycle();
5159
5160 if (cat != null) {
5161 intent.addCategory(cat);
5162 }
5163 XmlUtils.skipCurrentTag(parser);
5164
5165 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005166 if (intent.mExtras == null) {
5167 intent.mExtras = new Bundle();
5168 }
5169 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5170 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005171
5172 } else {
5173 XmlUtils.skipCurrentTag(parser);
5174 }
5175 }
5176
5177 return intent;
5178 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005179}