blob: b785dbf76afcc9c11c7beb390960daadfc1d6628 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
29import android.net.Uri;
30import android.os.Bundle;
31import android.os.IBinder;
32import android.os.Parcel;
33import android.os.Parcelable;
34import android.util.AttributeSet;
35import android.util.Log;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import com.android.internal.util.XmlUtils;
37
38import java.io.IOException;
39import java.io.Serializable;
40import java.net.URISyntaxException;
41import java.util.ArrayList;
42import java.util.HashSet;
43import java.util.Iterator;
44import java.util.Set;
45
46/**
47 * An intent is an abstract description of an operation to be performed. It
48 * can be used with {@link Context#startActivity(Intent) startActivity} to
49 * launch an {@link android.app.Activity},
50 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
51 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
52 * and {@link android.content.Context#startService} or
53 * {@link android.content.Context#bindService} to communicate with a
54 * background {@link android.app.Service}.
55 *
56 * <p>An Intent provides a facility for performing late runtime binding between
57 * the code in different applications. Its most significant use is in the
58 * launching of activities, where it can be thought of as the glue between
59 * activities. It is
60 * basically a passive data structure holding an abstract description of an
61 * action to be performed. The primary pieces of information in an intent
62 * are:</p>
63 *
64 * <ul>
65 * <li> <p><b>action</b> -- The general action to be performed, such as
66 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
67 * etc.</p>
68 * </li>
69 * <li> <p><b>data</b> -- The data to operate on, such as a person record
70 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
71 * </li>
72 * </ul>
73 *
74 *
75 * <p>Some examples of action/data pairs are:</p>
76 *
77 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070078 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070079 * information about the person whose identifier is "1".</p>
80 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070081 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070082 * the phone dialer with the person filled in.</p>
83 * </li>
84 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
85 * the phone dialer with the given number filled in. Note how the
86 * VIEW action does what what is considered the most reasonable thing for
87 * a particular URI.</p>
88 * </li>
89 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
90 * the phone dialer with the given number filled in.</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * information about the person whose identifier is "1".</p>
94 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070095 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070096 * a list of people, which the user can browse through. This example is a
97 * typical top-level entry into the Contacts application, showing you the
98 * list of people. Selecting a particular person to view would result in a
99 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
100 * being used to start an activity to display that person.</p>
101 * </li>
102 * </ul>
103 *
104 * <p>In addition to these primary attributes, there are a number of secondary
105 * attributes that you can also include with an intent:</p>
106 *
107 * <ul>
108 * <li> <p><b>category</b> -- Gives additional information about the action
109 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
110 * appear in the Launcher as a top-level application, while
111 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
112 * of alternative actions the user can perform on a piece of data.</p>
113 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
114 * intent data. Normally the type is inferred from the data itself.
115 * By setting this attribute, you disable that evaluation and force
116 * an explicit type.</p>
117 * <li> <p><b>component</b> -- Specifies an explicit name of a component
118 * class to use for the intent. Normally this is determined by looking
119 * at the other information in the intent (the action, data/type, and
120 * categories) and matching that with a component that can handle it.
121 * If this attribute is set then none of the evaluation is performed,
122 * and this component is used exactly as is. By specifying this attribute,
123 * all of the other Intent attributes become optional.</p>
124 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
125 * This can be used to provide extended information to the component.
126 * For example, if we have a action to send an e-mail message, we could
127 * also include extra pieces of data here to supply a subject, body,
128 * etc.</p>
129 * </ul>
130 *
131 * <p>Here are some examples of other operations you can specify as intents
132 * using these additional parameters:</p>
133 *
134 * <ul>
135 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
136 * Launch the home screen.</p>
137 * </li>
138 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
139 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
140 * vnd.android.cursor.item/phone}</i></b>
141 * -- Display the list of people's phone numbers, allowing the user to
142 * browse through them and pick one and return it to the parent activity.</p>
143 * </li>
144 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
145 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
146 * -- Display all pickers for data that can be opened with
147 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
148 * allowing the user to pick one of them and then some data inside of it
149 * and returning the resulting URI to the caller. This can be used,
150 * for example, in an e-mail application to allow the user to pick some
151 * data to include as an attachment.</p>
152 * </li>
153 * </ul>
154 *
155 * <p>There are a variety of standard Intent action and category constants
156 * defined in the Intent class, but applications can also define their own.
157 * These strings use java style scoping, to ensure they are unique -- for
158 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700159 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700160 *
161 * <p>Put together, the set of actions, data types, categories, and extra data
162 * defines a language for the system allowing for the expression of phrases
163 * such as "call john smith's cell". As applications are added to the system,
164 * they can extend this language by adding new actions, types, and categories, or
165 * they can modify the behavior of existing phrases by supplying their own
166 * activities that handle them.</p>
167 *
168 * <a name="IntentResolution"></a>
169 * <h3>Intent Resolution</h3>
170 *
171 * <p>There are two primary forms of intents you will use.
172 *
173 * <ul>
174 * <li> <p><b>Explicit Intents</b> have specified a component (via
175 * {@link #setComponent} or {@link #setClass}), which provides the exact
176 * class to be run. Often these will not include any other information,
177 * simply being a way for an application to launch various internal
178 * activities it has as the user interacts with the application.
179 *
180 * <li> <p><b>Implicit Intents</b> have not specified a component;
181 * instead, they must include enough information for the system to
182 * determine which of the available components is best to run for that
183 * intent.
184 * </ul>
185 *
186 * <p>When using implicit intents, given such an arbitrary intent we need to
187 * know what to do with it. This is handled by the process of <em>Intent
188 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
189 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
190 * more activities/receivers) that can handle it.</p>
191 *
192 * <p>The intent resolution mechanism basically revolves around matching an
193 * Intent against all of the &lt;intent-filter&gt; descriptions in the
194 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
195 * objects explicitly registered with {@link Context#registerReceiver}.) More
196 * details on this can be found in the documentation on the {@link
197 * IntentFilter} class.</p>
198 *
199 * <p>There are three pieces of information in the Intent that are used for
200 * resolution: the action, type, and category. Using this information, a query
201 * is done on the {@link PackageManager} for a component that can handle the
202 * intent. The appropriate component is determined based on the intent
203 * information supplied in the <code>AndroidManifest.xml</code> file as
204 * follows:</p>
205 *
206 * <ul>
207 * <li> <p>The <b>action</b>, if given, must be listed by the component as
208 * one it handles.</p>
209 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
210 * already supplied in the Intent. Like the action, if a type is
211 * included in the intent (either explicitly or implicitly in its
212 * data), then this must be listed by the component as one it handles.</p>
213 * <li> For data that is not a <code>content:</code> URI and where no explicit
214 * type is included in the Intent, instead the <b>scheme</b> of the
215 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
216 * considered. Again like the action, if we are matching a scheme it
217 * must be listed by the component as one it can handle.
218 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
219 * by the activity as categories it handles. That is, if you include
220 * the categories {@link #CATEGORY_LAUNCHER} and
221 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
222 * with an intent that lists <em>both</em> of those categories.
223 * Activities will very often need to support the
224 * {@link #CATEGORY_DEFAULT} so that they can be found by
225 * {@link Context#startActivity Context.startActivity()}.</p>
226 * </ul>
227 *
228 * <p>For example, consider the Note Pad sample application that
229 * allows user to browse through a list of notes data and view details about
230 * individual items. Text in italics indicate places were you would replace a
231 * name with one specific to your own package.</p>
232 *
233 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
234 * package="<i>com.android.notepad</i>"&gt;
235 * &lt;application android:icon="@drawable/app_notes"
236 * android:label="@string/app_name"&gt;
237 *
238 * &lt;provider class=".NotePadProvider"
239 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
240 *
241 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
242 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700243 * &lt;action android:name="android.intent.action.MAIN" /&gt;
244 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700245 * &lt;/intent-filter&gt;
246 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700247 * &lt;action android:name="android.intent.action.VIEW" /&gt;
248 * &lt;action android:name="android.intent.action.EDIT" /&gt;
249 * &lt;action android:name="android.intent.action.PICK" /&gt;
250 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
251 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700252 * &lt;/intent-filter&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
255 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
256 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700257 * &lt;/intent-filter&gt;
258 * &lt;/activity&gt;
259 *
260 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
261 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.VIEW" /&gt;
263 * &lt;action android:name="android.intent.action.EDIT" /&gt;
264 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
265 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700266 * &lt;/intent-filter&gt;
267 *
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.INSERT" /&gt;
270 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
271 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700272 * &lt;/intent-filter&gt;
273 *
274 * &lt;/activity&gt;
275 *
276 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
277 * android:theme="@android:style/Theme.Dialog"&gt;
278 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
280 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
281 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
282 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;/activity&gt;
286 *
287 * &lt;/application&gt;
288 * &lt;/manifest&gt;</pre>
289 *
290 * <p>The first activity,
291 * <code>com.android.notepad.NotesList</code>, serves as our main
292 * entry into the app. It can do three things as described by its three intent
293 * templates:
294 * <ol>
295 * <li><pre>
296 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
298 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700299 * &lt;/intent-filter&gt;</pre>
300 * <p>This provides a top-level entry into the NotePad application: the standard
301 * MAIN action is a main entry point (not requiring any other information in
302 * the Intent), and the LAUNCHER category says that this entry point should be
303 * listed in the application launcher.</p>
304 * <li><pre>
305 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700306 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
307 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
308 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
310 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;</pre>
312 * <p>This declares the things that the activity can do on a directory of
313 * notes. The type being supported is given with the &lt;type&gt; tag, where
314 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
315 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
316 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
317 * The activity allows the user to view or edit the directory of data (via
318 * the VIEW and EDIT actions), or to pick a particular note and return it
319 * to the caller (via the PICK action). Note also the DEFAULT category
320 * supplied here: this is <em>required</em> for the
321 * {@link Context#startActivity Context.startActivity} method to resolve your
322 * activity when its component name is not explicitly specified.</p>
323 * <li><pre>
324 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700325 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
326 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
327 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700328 * &lt;/intent-filter&gt;</pre>
329 * <p>This filter describes the ability return to the caller a note selected by
330 * the user without needing to know where it came from. The data type
331 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
332 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
333 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
334 * The GET_CONTENT action is similar to the PICK action, where the activity
335 * will return to its caller a piece of data selected by the user. Here,
336 * however, the caller specifies the type of data they desire instead of
337 * the type of data the user will be picking from.</p>
338 * </ol>
339 *
340 * <p>Given these capabilities, the following intents will resolve to the
341 * NotesList activity:</p>
342 *
343 * <ul>
344 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
345 * activities that can be used as top-level entry points into an
346 * application.</p>
347 * <li> <p><b>{ action=android.app.action.MAIN,
348 * category=android.app.category.LAUNCHER }</b> is the actual intent
349 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700350 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * data=content://com.google.provider.NotePad/notes }</b>
352 * displays a list of all the notes under
353 * "content://com.google.provider.NotePad/notes", which
354 * the user can browse through and see the details on.</p>
355 * <li> <p><b>{ action=android.app.action.PICK
356 * data=content://com.google.provider.NotePad/notes }</b>
357 * provides a list of the notes under
358 * "content://com.google.provider.NotePad/notes", from which
359 * the user can pick a note whose data URL is returned back to the caller.</p>
360 * <li> <p><b>{ action=android.app.action.GET_CONTENT
361 * type=vnd.android.cursor.item/vnd.google.note }</b>
362 * is similar to the pick action, but allows the caller to specify the
363 * kind of data they want back so that the system can find the appropriate
364 * activity to pick something of that data type.</p>
365 * </ul>
366 *
367 * <p>The second activity,
368 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
369 * note entry and allows them to edit it. It can do two things as described
370 * by its two intent templates:
371 * <ol>
372 * <li><pre>
373 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700374 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
375 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
376 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
377 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700378 * &lt;/intent-filter&gt;</pre>
379 * <p>The first, primary, purpose of this activity is to let the user interact
380 * with a single note, as decribed by the MIME type
381 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
382 * either VIEW a note or allow the user to EDIT it. Again we support the
383 * DEFAULT category to allow the activity to be launched without explicitly
384 * specifying its component.</p>
385 * <li><pre>
386 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700387 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * &lt;/intent-filter&gt;</pre>
391 * <p>The secondary use of this activity is to insert a new note entry into
392 * an existing directory of notes. This is used when the user creates a new
393 * note: the INSERT action is executed on the directory of notes, causing
394 * this activity to run and have the user create the new note data which
395 * it then adds to the content provider.</p>
396 * </ol>
397 *
398 * <p>Given these capabilities, the following intents will resolve to the
399 * NoteEditor activity:</p>
400 *
401 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700402 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700403 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
404 * shows the user the content of note <var>{ID}</var>.</p>
405 * <li> <p><b>{ action=android.app.action.EDIT
406 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
407 * allows the user to edit the content of note <var>{ID}</var>.</p>
408 * <li> <p><b>{ action=android.app.action.INSERT
409 * data=content://com.google.provider.NotePad/notes }</b>
410 * creates a new, empty note in the notes list at
411 * "content://com.google.provider.NotePad/notes"
412 * and allows the user to edit it. If they keep their changes, the URI
413 * of the newly created note is returned to the caller.</p>
414 * </ul>
415 *
416 * <p>The last activity,
417 * <code>com.android.notepad.TitleEditor</code>, allows the user to
418 * edit the title of a note. This could be implemented as a class that the
419 * application directly invokes (by explicitly setting its component in
420 * the Intent), but here we show a way you can publish alternative
421 * operations on existing data:</p>
422 *
423 * <pre>
424 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700425 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
426 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
429 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700430 * &lt;/intent-filter&gt;</pre>
431 *
432 * <p>In the single intent template here, we
433 * have created our own private action called
434 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
435 * edit the title of a note. It must be invoked on a specific note
436 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
437 * view and edit actions, but here displays and edits the title contained
438 * in the note data.
439 *
440 * <p>In addition to supporting the default category as usual, our title editor
441 * also supports two other standard categories: ALTERNATIVE and
442 * SELECTED_ALTERNATIVE. Implementing
443 * these categories allows others to find the special action it provides
444 * without directly knowing about it, through the
445 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
446 * more often to build dynamic menu items with
447 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
448 * template here was also supply an explicit name for the template
449 * (via <code>android:label="@string/resolve_title"</code>) to better control
450 * what the user sees when presented with this activity as an alternative
451 * action to the data they are viewing.
452 *
453 * <p>Given these capabilities, the following intent will resolve to the
454 * TitleEditor activity:</p>
455 *
456 * <ul>
457 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
458 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
459 * displays and allows the user to edit the title associated
460 * with note <var>{ID}</var>.</p>
461 * </ul>
462 *
463 * <h3>Standard Activity Actions</h3>
464 *
465 * <p>These are the current standard actions that Intent defines for launching
466 * activities (usually through {@link Context#startActivity}. The most
467 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
468 * {@link #ACTION_EDIT}.
469 *
470 * <ul>
471 * <li> {@link #ACTION_MAIN}
472 * <li> {@link #ACTION_VIEW}
473 * <li> {@link #ACTION_ATTACH_DATA}
474 * <li> {@link #ACTION_EDIT}
475 * <li> {@link #ACTION_PICK}
476 * <li> {@link #ACTION_CHOOSER}
477 * <li> {@link #ACTION_GET_CONTENT}
478 * <li> {@link #ACTION_DIAL}
479 * <li> {@link #ACTION_CALL}
480 * <li> {@link #ACTION_SEND}
481 * <li> {@link #ACTION_SENDTO}
482 * <li> {@link #ACTION_ANSWER}
483 * <li> {@link #ACTION_INSERT}
484 * <li> {@link #ACTION_DELETE}
485 * <li> {@link #ACTION_RUN}
486 * <li> {@link #ACTION_SYNC}
487 * <li> {@link #ACTION_PICK_ACTIVITY}
488 * <li> {@link #ACTION_SEARCH}
489 * <li> {@link #ACTION_WEB_SEARCH}
490 * <li> {@link #ACTION_FACTORY_TEST}
491 * </ul>
492 *
493 * <h3>Standard Broadcast Actions</h3>
494 *
495 * <p>These are the current standard actions that Intent defines for receiving
496 * broadcasts (usually through {@link Context#registerReceiver} or a
497 * &lt;receiver&gt; tag in a manifest).
498 *
499 * <ul>
500 * <li> {@link #ACTION_TIME_TICK}
501 * <li> {@link #ACTION_TIME_CHANGED}
502 * <li> {@link #ACTION_TIMEZONE_CHANGED}
503 * <li> {@link #ACTION_BOOT_COMPLETED}
504 * <li> {@link #ACTION_PACKAGE_ADDED}
505 * <li> {@link #ACTION_PACKAGE_CHANGED}
506 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 * <li> {@link #ACTION_PACKAGE_RESTARTED}
508 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700509 * <li> {@link #ACTION_UID_REMOVED}
510 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700511 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700512 * <li> {@link #ACTION_POWER_DISCONNECTED}
513 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700514 * </ul>
515 *
516 * <h3>Standard Categories</h3>
517 *
518 * <p>These are the current standard categories that can be used to further
519 * clarify an Intent via {@link #addCategory}.
520 *
521 * <ul>
522 * <li> {@link #CATEGORY_DEFAULT}
523 * <li> {@link #CATEGORY_BROWSABLE}
524 * <li> {@link #CATEGORY_TAB}
525 * <li> {@link #CATEGORY_ALTERNATIVE}
526 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
527 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800528 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700529 * <li> {@link #CATEGORY_HOME}
530 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400532 * <li> {@link #CATEGORY_CAR_DOCK}
533 * <li> {@link #CATEGORY_DESK_DOCK}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700534 * </ul>
535 *
536 * <h3>Standard Extra Data</h3>
537 *
538 * <p>These are the current standard fields that can be used as extra data via
539 * {@link #putExtra}.
540 *
541 * <ul>
542 * <li> {@link #EXTRA_TEMPLATE}
543 * <li> {@link #EXTRA_INTENT}
544 * <li> {@link #EXTRA_STREAM}
545 * <li> {@link #EXTRA_TEXT}
546 * </ul>
547 *
548 * <h3>Flags</h3>
549 *
550 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800551 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
552 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700553 */
554public class Intent implements Parcelable {
555 // ---------------------------------------------------------------------
556 // ---------------------------------------------------------------------
557 // Standard intent activity actions (see action variable).
558
559 /**
560 * Activity Action: Start as a main entry point, does not expect to
561 * receive data.
562 * <p>Input: nothing
563 * <p>Output: nothing
564 */
565 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
566 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800567
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700568 /**
569 * Activity Action: Display the data to the user. This is the most common
570 * action performed on data -- it is the generic action you can use on
571 * a piece of data to get the most reasonable thing to occur. For example,
572 * when used on a contacts entry it will view the entry; when used on a
573 * mailto: URI it will bring up a compose window filled with the information
574 * supplied by the URI; when used with a tel: URI it will invoke the
575 * dialer.
576 * <p>Input: {@link #getData} is URI from which to retrieve data.
577 * <p>Output: nothing.
578 */
579 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
580 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800581
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 /**
583 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
584 * performed on a piece of data.
585 */
586 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800587
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 /**
589 * Used to indicate that some piece of data should be attached to some other
590 * place. For example, image data could be attached to a contact. It is up
591 * to the recipient to decide where the data should be attached; the intent
592 * does not specify the ultimate destination.
593 * <p>Input: {@link #getData} is URI of data to be attached.
594 * <p>Output: nothing.
595 */
596 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
597 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 /**
600 * Activity Action: Provide explicit editable access to the given data.
601 * <p>Input: {@link #getData} is URI of data to be edited.
602 * <p>Output: nothing.
603 */
604 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
605 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800606
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 /**
608 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
609 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
610 * The extras can contain type specific data to pass through to the editing/creating
611 * activity.
612 * <p>Output: The URI of the item that was picked. This must be a content:
613 * URI so that any receiver can access it.
614 */
615 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
616 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 /**
619 * Activity Action: Pick an item from the data, returning what was selected.
620 * <p>Input: {@link #getData} is URI containing a directory of data
621 * (vnd.android.cursor.dir/*) from which to pick an item.
622 * <p>Output: The URI of the item that was picked.
623 */
624 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
625 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 /**
628 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 * <p>Output: An Intent representing the shortcut. The intent must contain three
631 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
632 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800633 * (value: ShortcutIconResource).</p>
634 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700635 * @see #EXTRA_SHORTCUT_INTENT
636 * @see #EXTRA_SHORTCUT_NAME
637 * @see #EXTRA_SHORTCUT_ICON
638 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
639 * @see android.content.Intent.ShortcutIconResource
640 */
641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
642 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
643
644 /**
645 * The name of the extra used to define the Intent of a shortcut.
646 *
647 * @see #ACTION_CREATE_SHORTCUT
648 */
649 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
650 /**
651 * The name of the extra used to define the name of a shortcut.
652 *
653 * @see #ACTION_CREATE_SHORTCUT
654 */
655 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
656 /**
657 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
658 *
659 * @see #ACTION_CREATE_SHORTCUT
660 */
661 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
662 /**
663 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
664 *
665 * @see #ACTION_CREATE_SHORTCUT
666 * @see android.content.Intent.ShortcutIconResource
667 */
668 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
669 "android.intent.extra.shortcut.ICON_RESOURCE";
670
671 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800672 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 *
674 * @see Intent#ACTION_CREATE_SHORTCUT
675 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
677 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 */
679 public static class ShortcutIconResource implements Parcelable {
680 /**
681 * The package name of the application containing the icon.
682 */
683 public String packageName;
684
685 /**
686 * The resource name of the icon, including package, name and type.
687 */
688 public String resourceName;
689
690 /**
691 * Creates a new ShortcutIconResource for the specified context and resource
692 * identifier.
693 *
694 * @param context The context of the application.
695 * @param resourceId The resource idenfitier for the icon.
696 * @return A new ShortcutIconResource with the specified's context package name
697 * and icon resource idenfitier.
698 */
699 public static ShortcutIconResource fromContext(Context context, int resourceId) {
700 ShortcutIconResource icon = new ShortcutIconResource();
701 icon.packageName = context.getPackageName();
702 icon.resourceName = context.getResources().getResourceName(resourceId);
703 return icon;
704 }
705
706 /**
707 * Used to read a ShortcutIconResource from a Parcel.
708 */
709 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
710 new Parcelable.Creator<ShortcutIconResource>() {
711
712 public ShortcutIconResource createFromParcel(Parcel source) {
713 ShortcutIconResource icon = new ShortcutIconResource();
714 icon.packageName = source.readString();
715 icon.resourceName = source.readString();
716 return icon;
717 }
718
719 public ShortcutIconResource[] newArray(int size) {
720 return new ShortcutIconResource[size];
721 }
722 };
723
724 /**
725 * No special parcel contents.
726 */
727 public int describeContents() {
728 return 0;
729 }
730
731 public void writeToParcel(Parcel dest, int flags) {
732 dest.writeString(packageName);
733 dest.writeString(resourceName);
734 }
735
736 @Override
737 public String toString() {
738 return resourceName;
739 }
740 }
741
742 /**
743 * Activity Action: Display an activity chooser, allowing the user to pick
744 * what they want to before proceeding. This can be used as an alternative
745 * to the standard activity picker that is displayed by the system when
746 * you try to start an activity with multiple possible matches, with these
747 * differences in behavior:
748 * <ul>
749 * <li>You can specify the title that will appear in the activity chooser.
750 * <li>The user does not have the option to make one of the matching
751 * activities a preferred activity, and all possible activities will
752 * always be shown even if one of them is currently marked as the
753 * preferred activity.
754 * </ul>
755 * <p>
756 * This action should be used when the user will naturally expect to
757 * select an activity in order to proceed. An example if when not to use
758 * it is when the user clicks on a "mailto:" link. They would naturally
759 * expect to go directly to their mail app, so startActivity() should be
760 * called directly: it will
761 * either launch the current preferred app, or put up a dialog allowing the
762 * user to pick an app to use and optionally marking that as preferred.
763 * <p>
764 * In contrast, if the user is selecting a menu item to send a picture
765 * they are viewing to someone else, there are many different things they
766 * may want to do at this point: send it through e-mail, upload it to a
767 * web service, etc. In this case the CHOOSER action should be used, to
768 * always present to the user a list of the things they can do, with a
769 * nice title given by the caller such as "Send this photo with:".
770 * <p>
771 * As a convenience, an Intent of this form can be created with the
772 * {@link #createChooser} function.
773 * <p>Input: No data should be specified. get*Extra must have
774 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
775 * and can optionally have a {@link #EXTRA_TITLE} field containing the
776 * title text to display in the chooser.
777 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
778 */
779 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
780 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
781
782 /**
783 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
784 *
785 * @param target The Intent that the user will be selecting an activity
786 * to perform.
787 * @param title Optional title that will be displayed in the chooser.
788 * @return Return a new Intent object that you can hand to
789 * {@link Context#startActivity(Intent) Context.startActivity()} and
790 * related methods.
791 */
792 public static Intent createChooser(Intent target, CharSequence title) {
793 Intent intent = new Intent(ACTION_CHOOSER);
794 intent.putExtra(EXTRA_INTENT, target);
795 if (title != null) {
796 intent.putExtra(EXTRA_TITLE, title);
797 }
798 return intent;
799 }
800 /**
801 * Activity Action: Allow the user to select a particular kind of data and
802 * return it. This is different than {@link #ACTION_PICK} in that here we
803 * just say what kind of data is desired, not a URI of existing data from
804 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
805 * create the data as it runs (for example taking a picture or recording a
806 * sound), let them browser over the web and download the desired data,
807 * etc.
808 * <p>
809 * There are two main ways to use this action: if you want an specific kind
810 * of data, such as a person contact, you set the MIME type to the kind of
811 * data you want and launch it with {@link Context#startActivity(Intent)}.
812 * The system will then launch the best application to select that kind
813 * of data for you.
814 * <p>
815 * You may also be interested in any of a set of types of content the user
816 * can pick. For example, an e-mail application that wants to allow the
817 * user to add an attachment to an e-mail message can use this action to
818 * bring up a list of all of the types of content the user can attach.
819 * <p>
820 * In this case, you should wrap the GET_CONTENT intent with a chooser
821 * (through {@link #createChooser}), which will give the proper interface
822 * for the user to pick how to send your data and allow you to specify
823 * a prompt indicating what they are doing. You will usually specify a
824 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
825 * broad range of content types the user can select from.
826 * <p>
827 * When using such a broad GET_CONTENT action, it is often desireable to
828 * only pick from data that can be represented as a stream. This is
829 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
830 * <p>
831 * Input: {@link #getType} is the desired MIME type to retrieve. Note
832 * that no URI is supplied in the intent, as there are no constraints on
833 * where the returned data originally comes from. You may also include the
834 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
835 * opened as a stream.
836 * <p>
837 * Output: The URI of the item that was picked. This must be a content:
838 * URI so that any receiver can access it.
839 */
840 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
841 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
842 /**
843 * Activity Action: Dial a number as specified by the data. This shows a
844 * UI with the number being dialed, allowing the user to explicitly
845 * initiate the call.
846 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
847 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
848 * number.
849 * <p>Output: nothing.
850 */
851 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
852 public static final String ACTION_DIAL = "android.intent.action.DIAL";
853 /**
854 * Activity Action: Perform a call to someone specified by the data.
855 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
856 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
857 * number.
858 * <p>Output: nothing.
859 *
860 * <p>Note: there will be restrictions on which applications can initiate a
861 * call; most applications should use the {@link #ACTION_DIAL}.
862 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
863 * numbers. Applications can <strong>dial</strong> emergency numbers using
864 * {@link #ACTION_DIAL}, however.
865 */
866 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
867 public static final String ACTION_CALL = "android.intent.action.CALL";
868 /**
869 * Activity Action: Perform a call to an emergency number specified by the
870 * data.
871 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
872 * tel: URI of an explicit phone number.
873 * <p>Output: nothing.
874 * @hide
875 */
876 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
877 /**
878 * Activity action: Perform a call to any number (emergency or not)
879 * specified by the data.
880 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
881 * tel: URI of an explicit phone number.
882 * <p>Output: nothing.
883 * @hide
884 */
885 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
886 /**
887 * Activity Action: Send a message to someone specified by the data.
888 * <p>Input: {@link #getData} is URI describing the target.
889 * <p>Output: nothing.
890 */
891 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
892 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
893 /**
894 * Activity Action: Deliver some data to someone else. Who the data is
895 * being delivered to is not specified; it is up to the receiver of this
896 * action to ask the user where the data should be sent.
897 * <p>
898 * When launching a SEND intent, you should usually wrap it in a chooser
899 * (through {@link #createChooser}), which will give the proper interface
900 * for the user to pick how to send your data and allow you to specify
901 * a prompt indicating what they are doing.
902 * <p>
903 * Input: {@link #getType} is the MIME type of the data being sent.
904 * get*Extra can have either a {@link #EXTRA_TEXT}
905 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
906 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
907 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
908 * if the MIME type is unknown (this will only allow senders that can
909 * handle generic data streams).
910 * <p>
911 * Optional standard extras, which may be interpreted by some recipients as
912 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
913 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
914 * <p>
915 * Output: nothing.
916 */
917 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
918 public static final String ACTION_SEND = "android.intent.action.SEND";
919 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800920 * Activity Action: Deliver multiple data to someone else.
921 * <p>
922 * Like ACTION_SEND, except the data is multiple.
923 * <p>
924 * Input: {@link #getType} is the MIME type of the data being sent.
925 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
926 * #EXTRA_STREAM} field, containing the data to be sent.
927 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800928 * Multiple types are supported, and receivers should handle mixed types
929 * whenever possible. The right way for the receiver to check them is to
930 * use the content resolver on each URI. The intent sender should try to
931 * put the most concrete mime type in the intent type, but it can fall
932 * back to {@literal <type>/*} or {@literal *}/* as needed.
933 * <p>
934 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
935 * be image/jpg, but if you are sending image/jpg and image/png, then the
936 * intent's type should be image/*.
937 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800938 * Optional standard extras, which may be interpreted by some recipients as
939 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
940 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
941 * <p>
942 * Output: nothing.
943 */
944 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
945 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 * Activity Action: Handle an incoming phone call.
948 * <p>Input: nothing.
949 * <p>Output: nothing.
950 */
951 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
952 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
953 /**
954 * Activity Action: Insert an empty item into the given container.
955 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
956 * in which to place the data.
957 * <p>Output: URI of the new data that was created.
958 */
959 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
960 public static final String ACTION_INSERT = "android.intent.action.INSERT";
961 /**
962 * Activity Action: Delete the given data from its container.
963 * <p>Input: {@link #getData} is URI of data to be deleted.
964 * <p>Output: nothing.
965 */
966 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
967 public static final String ACTION_DELETE = "android.intent.action.DELETE";
968 /**
969 * Activity Action: Run the data, whatever that means.
970 * <p>Input: ? (Note: this is currently specific to the test harness.)
971 * <p>Output: nothing.
972 */
973 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
974 public static final String ACTION_RUN = "android.intent.action.RUN";
975 /**
976 * Activity Action: Perform a data synchronization.
977 * <p>Input: ?
978 * <p>Output: ?
979 */
980 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
981 public static final String ACTION_SYNC = "android.intent.action.SYNC";
982 /**
983 * Activity Action: Pick an activity given an intent, returning the class
984 * selected.
985 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
986 * used with {@link PackageManager#queryIntentActivities} to determine the
987 * set of activities from which to pick.
988 * <p>Output: Class name of the activity that was selected.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
992 /**
993 * Activity Action: Perform a search.
994 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
995 * is the text to search for. If empty, simply
996 * enter your search results Activity with the search UI activated.
997 * <p>Output: nothing.
998 */
999 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1000 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1001 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001002 * Activity Action: Start the platform-defined tutorial
1003 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1004 * is the text to search for. If empty, simply
1005 * enter your search results Activity with the search UI activated.
1006 * <p>Output: nothing.
1007 */
1008 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001012 * <p>
1013 * Input: {@link android.app.SearchManager#QUERY
1014 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1015 * a url starts with http or https, the site will be opened. If it is plain
1016 * text, Google search will be applied.
1017 * <p>
1018 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 */
1020 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1021 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1022 /**
1023 * Activity Action: List all available applications
1024 * <p>Input: Nothing.
1025 * <p>Output: nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1029 /**
1030 * Activity Action: Show settings for choosing wallpaper
1031 * <p>Input: Nothing.
1032 * <p>Output: Nothing.
1033 */
1034 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1035 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1036
1037 /**
1038 * Activity Action: Show activity for reporting a bug.
1039 * <p>Input: Nothing.
1040 * <p>Output: Nothing.
1041 */
1042 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1043 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1044
1045 /**
1046 * Activity Action: Main entry point for factory tests. Only used when
1047 * the device is booting in factory test node. The implementing package
1048 * must be installed in the system image.
1049 * <p>Input: nothing
1050 * <p>Output: nothing
1051 */
1052 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1053
1054 /**
1055 * Activity Action: The user pressed the "call" button to go to the dialer
1056 * or other appropriate UI for placing a call.
1057 * <p>Input: Nothing.
1058 * <p>Output: Nothing.
1059 */
1060 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1061 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1062
1063 /**
1064 * Activity Action: Start Voice Command.
1065 * <p>Input: Nothing.
1066 * <p>Output: Nothing.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001070
1071 /**
1072 * Activity Action: Start action associated with long pressing on the
1073 * search key.
1074 * <p>Input: Nothing.
1075 * <p>Output: Nothing.
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001079
Jacek Surazski86b6c532009-05-13 14:38:28 +02001080 /**
1081 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1082 * This intent is delivered to the package which installed the application, usually
1083 * the Market.
1084 * <p>Input: No data is specified. The bug report is passed in using
1085 * an {@link #EXTRA_BUG_REPORT} field.
1086 * <p>Output: Nothing.
1087 * @hide
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001091
1092 /**
1093 * Activity Action: Show power usage information to the user.
1094 * <p>Input: Nothing.
1095 * <p>Output: Nothing.
1096 */
1097 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1098 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1099
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001100 /**
1101 * Activity Action: Setup wizard to launch after a platform update. This
1102 * activity should have a string meta-data field associated with it,
1103 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1104 * the platform for setup. The activity will be launched only if
1105 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1106 * same value.
1107 * <p>Input: Nothing.
1108 * <p>Output: Nothing.
1109 * @hide
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1113
1114 /**
1115 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1116 * describing the last run version of the platform that was setup.
1117 * @hide
1118 */
1119 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1120
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001121 // ---------------------------------------------------------------------
1122 // ---------------------------------------------------------------------
1123 // Standard intent broadcast actions (see action variable).
1124
1125 /**
1126 * Broadcast Action: Sent after the screen turns off.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001127 *
1128 * <p class="note">This is a protected intent that can only be sent
1129 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001130 */
1131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1132 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1133 /**
1134 * Broadcast Action: Sent after the screen turns on.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001135 *
1136 * <p class="note">This is a protected intent that can only be sent
1137 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001138 */
1139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1140 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001141
1142 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001143 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001144 * keyguard is gone).
Dianne Hackborn854060af2009-07-09 18:14:31 -07001145 *
1146 * <p class="note">This is a protected intent that can only be sent
1147 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001148 */
1149 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1150 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1151
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 /**
1153 * Broadcast Action: The current time has changed. Sent every
1154 * minute. You can <em>not</em> receive this through components declared
1155 * in manifests, only by exlicitly registering for it with
1156 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1157 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001158 *
1159 * <p class="note">This is a protected intent that can only be sent
1160 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001161 */
1162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1163 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1164 /**
1165 * Broadcast Action: The time was set.
1166 */
1167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1168 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1169 /**
1170 * Broadcast Action: The date has changed.
1171 */
1172 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1173 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1174 /**
1175 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1176 * <ul>
1177 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1178 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001179 *
1180 * <p class="note">This is a protected intent that can only be sent
1181 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001182 */
1183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1184 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1185 /**
1186 * Alarm Changed Action: This is broadcast when the AlarmClock
1187 * application's alarm is set or unset. It is used by the
1188 * AlarmClock application and the StatusBar service.
1189 * @hide
1190 */
1191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1192 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1193 /**
1194 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1195 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1196 * @hide
1197 */
1198 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1199 public static final String ACTION_SYNC_STATE_CHANGED
1200 = "android.intent.action.SYNC_STATE_CHANGED";
1201 /**
1202 * Broadcast Action: This is broadcast once, after the system has finished
1203 * booting. It can be used to perform application-specific initialization,
1204 * such as installing alarms. You must hold the
1205 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1206 * in order to receive this broadcast.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001207 *
1208 * <p class="note">This is a protected intent that can only be sent
1209 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001210 */
1211 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1212 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1213 /**
1214 * Broadcast Action: This is broadcast when a user action should request a
1215 * temporary system dialog to dismiss. Some examples of temporary system
1216 * dialogs are the notification window-shade and the recent tasks dialog.
1217 */
1218 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1219 /**
1220 * Broadcast Action: Trigger the download and eventual installation
1221 * of a package.
1222 * <p>Input: {@link #getData} is the URI of the package file to download.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001223 *
1224 * <p class="note">This is a protected intent that can only be sent
1225 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001226 */
1227 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1228 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1229 /**
1230 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001231 * device. The data contains the name of the package. Note that the
1232 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001233 * <p>My include the following extras:
1234 * <ul>
1235 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1236 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1237 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1238 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001239 *
1240 * <p class="note">This is a protected intent that can only be sent
1241 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001242 */
1243 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1244 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1245 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001246 * Broadcast Action: A new version of an application package has been
1247 * installed, replacing an existing version that was previously installed.
1248 * The data contains the name of the package.
1249 * <p>My include the following extras:
1250 * <ul>
1251 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1252 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001253 *
1254 * <p class="note">This is a protected intent that can only be sent
1255 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001256 */
1257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1258 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1259 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001260 * Broadcast Action: An existing application package has been removed from
1261 * the device. The data contains the name of the package. The package
1262 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001263 * <ul>
1264 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1265 * to the package.
1266 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1267 * application -- data and code -- is being removed.
1268 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1269 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1270 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001271 *
1272 * <p class="note">This is a protected intent that can only be sent
1273 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001274 */
1275 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1276 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1277 /**
1278 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1279 * enabled or disabled. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001280 * <ul>
1281 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07001282 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME} containing the class name of the changed component.
1283 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001284 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001285 *
1286 * <p class="note">This is a protected intent that can only be sent
1287 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001288 */
1289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1290 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1291 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001292 * Broadcast Action: The user has restarted a package, and all of its
1293 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001294 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001295 * be removed. Note that the restarted package does <em>not</em>
1296 * receive this broadcast.
1297 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001298 * <ul>
1299 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1300 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001301 *
1302 * <p class="note">This is a protected intent that can only be sent
1303 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001304 */
1305 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1306 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1307 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001308 * Broadcast Action: The user has cleared the data of a package. This should
1309 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001310 * its persistent data is erased and this broadcast sent.
1311 * Note that the cleared package does <em>not</em>
1312 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001313 * <ul>
1314 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1315 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001316 *
1317 * <p class="note">This is a protected intent that can only be sent
1318 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001319 */
1320 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1321 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1322 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001323 * Broadcast Action: A user ID has been removed from the system. The user
1324 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001325 *
1326 * <p class="note">This is a protected intent that can only be sent
1327 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 */
1329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1330 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1331 /**
1332 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001333 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001334 */
1335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1336 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1337 /**
1338 * Broadcast Action: The current device {@link android.content.res.Configuration}
1339 * (orientation, locale, etc) has changed. When such a change happens, the
1340 * UIs (view hierarchy) will need to be rebuilt based on this new
1341 * information; for the most part, applications don't need to worry about
1342 * this, because the system will take care of stopping and restarting the
1343 * application to make sure it sees the new changes. Some system code that
1344 * can not be restarted will need to watch for this action and handle it
1345 * appropriately.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001346 *
1347 * <p class="note">This is a protected intent that can only be sent
1348 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001349 *
1350 * @see android.content.res.Configuration
1351 */
1352 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1353 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1354 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001355 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1356 * charging state, level, and other information about the battery.
1357 * See {@link android.os.BatteryManager} for documentation on the
1358 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001359 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001360 * <p class="note">
1361 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001362 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001363 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001364 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1365 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1366 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1367 * broadcasts that are sent and can be received through manifest
1368 * receivers.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001369 *
1370 * <p class="note">This is a protected intent that can only be sent
1371 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1375 /**
1376 * Broadcast Action: Indicates low battery condition on the device.
1377 * This broadcast corresponds to the "Low battery warning" system dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 *
1379 * <p class="note">This is a protected intent that can only be sent
1380 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001381 */
1382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1383 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1384 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001385 * Broadcast Action: Indicates the battery is now okay after being low.
1386 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1387 * gone back up to an okay state.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001388 *
1389 * <p class="note">This is a protected intent that can only be sent
1390 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001391 */
1392 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1393 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1394 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001395 * Broadcast Action: External power has been connected to the device.
1396 * This is intended for applications that wish to register specifically to this notification.
1397 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1398 * stay active to receive this notification. This action can be used to implement actions
1399 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001400 *
1401 * <p class="note">This is a protected intent that can only be sent
1402 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001403 */
1404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001405 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001406 /**
1407 * Broadcast Action: External power has been removed from the device.
1408 * This is intended for applications that wish to register specifically to this notification.
1409 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1410 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001411 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001412 *
1413 * <p class="note">This is a protected intent that can only be sent
1414 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001415 */
1416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001417 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001418 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001419 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001420 * Broadcast Action: Device is shutting down.
1421 * This is broadcast when the device is being shut down (completely turned
1422 * off, not sleeping). Once the broadcast is complete, the final shutdown
1423 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001424 * to handle this, since the foreground activity will be paused as well.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001425 *
1426 * <p class="note">This is a protected intent that can only be sent
1427 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001428 */
1429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001430 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001431 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001432 * Activity Action: Start this activity to request system shutdown.
1433 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1434 * to request confirmation from the user before shutting down.
1435 *
1436 * <p class="note">This is a protected intent that can only be sent
1437 * by the system.
1438 *
1439 * {@hide}
1440 */
1441 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1442 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001443 * Broadcast Action: A sticky broadcast that indicates low memory
1444 * condition on the device
Dianne Hackborn854060af2009-07-09 18:14:31 -07001445 *
1446 * <p class="note">This is a protected intent that can only be sent
1447 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001448 */
1449 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1450 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1451 /**
1452 * Broadcast Action: Indicates low memory condition on the device no longer exists
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 *
1454 * <p class="note">This is a protected intent that can only be sent
1455 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001456 */
1457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1458 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1459 /**
1460 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1461 * and package management should be started.
1462 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1463 * notification.
1464 */
1465 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1466 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1467 /**
1468 * Broadcast Action: The device has entered 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_CONNECTED = "android.intent.action.UMS_CONNECTED";
1475
1476 /**
1477 * Broadcast Action: The device has exited USB Mass Storage mode.
1478 * This is used mainly for the USB Settings panel.
1479 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1480 * when the SD card file system is mounted or unmounted
1481 */
1482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1483 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1484
1485 /**
1486 * Broadcast Action: External media has been removed.
1487 * The path to the mount point for the removed media is contained in the Intent.mData field.
1488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1491
1492 /**
1493 * Broadcast Action: External media is present, but not mounted at its mount point.
1494 * The path to the mount point for the removed media is contained in the Intent.mData field.
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1498
1499 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001500 * Broadcast Action: External media is present, and being disk-checked
1501 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1505
1506 /**
1507 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1508 * 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 -08001509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1512
1513 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 * Broadcast Action: External media is present and mounted at its mount point.
1515 * The path to the mount point for the removed media is contained in the Intent.mData field.
1516 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1517 * media was mounted read only.
1518 */
1519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1520 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1521
1522 /**
1523 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1524 * The path to the mount point for the removed media is contained in the Intent.mData field.
1525 */
1526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1527 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1528
1529 /**
1530 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1531 * The path to the mount point for the removed media is contained in the Intent.mData field.
1532 */
1533 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1534 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1535
1536 /**
1537 * Broadcast Action: External media is present but cannot be mounted.
1538 * The path to the mount point for the removed media is contained in the Intent.mData field.
1539 */
1540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1541 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1542
1543 /**
1544 * Broadcast Action: User has expressed the desire to remove the external storage media.
1545 * Applications should close all files they have open within the mount point when they receive this intent.
1546 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1547 */
1548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1549 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1550
1551 /**
1552 * Broadcast Action: The media scanner has started scanning a directory.
1553 * The path to the directory being scanned is contained in the Intent.mData field.
1554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1556 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1557
1558 /**
1559 * Broadcast Action: The media scanner has finished scanning a directory.
1560 * The path to the scanned directory is contained in the Intent.mData field.
1561 */
1562 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1563 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1564
1565 /**
1566 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1567 * The path to the file is contained in the Intent.mData field.
1568 */
1569 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1570 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1571
1572 /**
1573 * Broadcast Action: The "Media Button" was pressed. Includes a single
1574 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1575 * caused the broadcast.
1576 */
1577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1578 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1579
1580 /**
1581 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1582 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1583 * caused the broadcast.
1584 */
1585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1587
1588 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1589 // location; they are not general-purpose actions.
1590
1591 /**
1592 * Broadcast Action: An GTalk connection has been established.
1593 */
1594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1595 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1596 "android.intent.action.GTALK_CONNECTED";
1597
1598 /**
1599 * Broadcast Action: An GTalk connection has been disconnected.
1600 */
1601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1603 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001604
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001605 /**
1606 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1609 public static final String ACTION_INPUT_METHOD_CHANGED =
1610 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001611
1612 /**
1613 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1614 * more radios have been turned off or on. The intent will have the following extra value:</p>
1615 * <ul>
1616 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1617 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1618 * turned off</li>
1619 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001620 *
1621 * <p class="note">This is a protected intent that can only be sent
1622 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001623 */
1624 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1625 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1626
1627 /**
1628 * Broadcast Action: Some content providers have parts of their namespace
1629 * where they publish new events or items that the user may be especially
1630 * interested in. For these things, they may broadcast this action when the
1631 * set of interesting items change.
1632 *
1633 * For example, GmailProvider sends this notification when the set of unread
1634 * mail in the inbox changes.
1635 *
1636 * <p>The data of the intent identifies which part of which provider
1637 * changed. When queried through the content resolver, the data URI will
1638 * return the data set in question.
1639 *
1640 * <p>The intent will have the following extra values:
1641 * <ul>
1642 * <li><em>count</em> - The number of items in the data set. This is the
1643 * same as the number of items in the cursor returned by querying the
1644 * data URI. </li>
1645 * </ul>
1646 *
1647 * This intent will be sent at boot (if the count is non-zero) and when the
1648 * data set changes. It is possible for the data set to change without the
1649 * count changing (for example, if a new unread message arrives in the same
1650 * sync operation in which a message is archived). The phone should still
1651 * ring/vibrate/etc as normal in this case.
1652 */
1653 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1654 public static final String ACTION_PROVIDER_CHANGED =
1655 "android.intent.action.PROVIDER_CHANGED";
1656
1657 /**
1658 * Broadcast Action: Wired Headset plugged in or unplugged.
1659 *
1660 * <p>The intent will have the following extra values:
1661 * <ul>
1662 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1663 * <li><em>name</em> - Headset type, human readable string </li>
1664 * </ul>
1665 * </ul>
1666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_HEADSET_PLUG =
1669 "android.intent.action.HEADSET_PLUG";
1670
1671 /**
1672 * Broadcast Action: An outgoing call is about to be placed.
1673 *
1674 * <p>The Intent will have the following extra value:
1675 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001676 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001677 * the phone number originally intended to be dialed.</li>
1678 * </ul>
1679 * <p>Once the broadcast is finished, the resultData is used as the actual
1680 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001681 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001682 * outgoing call in turn: for example, a parental control application
1683 * might verify that the user is authorized to place the call at that
1684 * time, then a number-rewriting application might add an area code if
1685 * one was not specified.</p>
1686 * <p>For consistency, any receiver whose purpose is to prohibit phone
1687 * calls should have a priority of 0, to ensure it will see the final
1688 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001689 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001690 * should have a positive priority.
1691 * Negative priorities are reserved for the system for this broadcast;
1692 * using them may cause problems.</p>
1693 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1694 * abort the broadcast.</p>
1695 * <p>Emergency calls cannot be intercepted using this mechanism, and
1696 * other calls cannot be modified to call emergency numbers using this
1697 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001698 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001699 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1700 * permission to receive this Intent.</p>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001701 *
1702 * <p class="note">This is a protected intent that can only be sent
1703 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001704 */
1705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1706 public static final String ACTION_NEW_OUTGOING_CALL =
1707 "android.intent.action.NEW_OUTGOING_CALL";
1708
1709 /**
1710 * Broadcast Action: Have the device reboot. This is only for use by
1711 * system code.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001712 *
1713 * <p class="note">This is a protected intent that can only be sent
1714 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001715 */
1716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1717 public static final String ACTION_REBOOT =
1718 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001719
Wei Huang97ecc9c2009-05-11 17:44:20 -07001720 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001721 * Broadcast Action: A sticky broadcast indicating the phone was docked
1722 * or undocked. Includes the extra
1723 * field {@link #EXTRA_DOCK_STATE}, containing the current dock state.
1724 * This is intended for monitoring the current dock state.
1725 * To launch an activity from a dock state change, use {@link #CATEGORY_CAR_DOCK}
1726 * or {@link #CATEGORY_DESK_DOCK} instead.
1727 */
1728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1729 public static final String ACTION_DOCK_EVENT =
1730 "android.intent.action.DOCK_EVENT";
1731
1732 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001733 * Broadcast Action: a remote intent is to be broadcasted.
1734 *
1735 * A remote intent is used for remote RPC between devices. The remote intent
1736 * is serialized and sent from one device to another device. The receiving
1737 * device parses the remote intent and broadcasts it. Note that anyone can
1738 * broadcast a remote intent. However, if the intent receiver of the remote intent
1739 * does not trust intent broadcasts from arbitrary intent senders, it should require
1740 * the sender to hold certain permissions so only trusted sender's broadcast will be
1741 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001742 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07001743 */
1744 public static final String ACTION_REMOTE_INTENT =
1745 "android.intent.action.REMOTE_INTENT";
1746
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001747 /**
1748 * Broadcast Action: hook for permforming cleanup after a system update.
1749 *
1750 * The broadcast is sent when the system is booting, before the
1751 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1752 * image. A receiver for this should do its work and then disable itself
1753 * so that it does not get run again at the next boot.
1754 * @hide
1755 */
1756 public static final String ACTION_PRE_BOOT_COMPLETED =
1757 "android.intent.action.PRE_BOOT_COMPLETED";
1758
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001759 // ---------------------------------------------------------------------
1760 // ---------------------------------------------------------------------
1761 // Standard intent categories (see addCategory()).
1762
1763 /**
1764 * Set if the activity should be an option for the default action
1765 * (center press) to perform on a piece of data. Setting this will
1766 * hide from the user any activities without it set when performing an
1767 * action on some data. Note that this is normal -not- set in the
1768 * Intent when initiating an action -- it is for use in intent filters
1769 * specified in packages.
1770 */
1771 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1772 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1773 /**
1774 * Activities that can be safely invoked from a browser must support this
1775 * category. For example, if the user is viewing a web page or an e-mail
1776 * and clicks on a link in the text, the Intent generated execute that
1777 * link will require the BROWSABLE category, so that only activities
1778 * supporting this category will be considered as possible actions. By
1779 * supporting this category, you are promising that there is nothing
1780 * damaging (without user intervention) that can happen by invoking any
1781 * matching Intent.
1782 */
1783 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1784 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1785 /**
1786 * Set if the activity should be considered as an alternative action to
1787 * the data the user is currently viewing. See also
1788 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1789 * applies to the selection in a list of items.
1790 *
1791 * <p>Supporting this category means that you would like your activity to be
1792 * displayed in the set of alternative things the user can do, usually as
1793 * part of the current activity's options menu. You will usually want to
1794 * include a specific label in the &lt;intent-filter&gt; of this action
1795 * describing to the user what it does.
1796 *
1797 * <p>The action of IntentFilter with this category is important in that it
1798 * describes the specific action the target will perform. This generally
1799 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1800 * a specific name such as "com.android.camera.action.CROP. Only one
1801 * alternative of any particular action will be shown to the user, so using
1802 * a specific action like this makes sure that your alternative will be
1803 * displayed while also allowing other applications to provide their own
1804 * overrides of that particular action.
1805 */
1806 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1807 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1808 /**
1809 * Set if the activity should be considered as an alternative selection
1810 * action to the data the user has currently selected. This is like
1811 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1812 * of items from which the user can select, giving them alternatives to the
1813 * default action that will be performed on it.
1814 */
1815 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1816 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1817 /**
1818 * Intended to be used as a tab inside of an containing TabActivity.
1819 */
1820 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1821 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1822 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001823 * Should be displayed in the top-level launcher.
1824 */
1825 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1826 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1827 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001828 * Provides information about the package it is in; typically used if
1829 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1830 * a front-door to the user without having to be shown in the all apps list.
1831 */
1832 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1833 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1834 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 * This is the home activity, that is the first activity that is displayed
1836 * when the device boots.
1837 */
1838 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1839 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1840 /**
1841 * This activity is a preference panel.
1842 */
1843 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1844 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1845 /**
1846 * This activity is a development preference panel.
1847 */
1848 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1849 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1850 /**
1851 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 */
1853 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1854 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1855 /**
1856 * This activity may be exercised by the monkey or other automated test tools.
1857 */
1858 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1859 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1860 /**
1861 * To be used as a test (not part of the normal user experience).
1862 */
1863 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1864 /**
1865 * To be used as a unit test (run through the Test Harness).
1866 */
1867 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1868 /**
1869 * To be used as an sample code example (not part of the normal user
1870 * experience).
1871 */
1872 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1873 /**
1874 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1875 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1876 * when queried, though it is allowable for those columns to be blank.
1877 */
1878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1879 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1880
1881 /**
1882 * To be used as code under test for framework instrumentation tests.
1883 */
1884 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1885 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04001886 /**
1887 * An activity to run when device is inserted into a car dock.
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07001888 * Used with {@link #ACTION_MAIN} to launch an activity.
Mike Lockwood9092ab42009-09-16 13:01:32 -04001889 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
1890 */
1891 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1892 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
1893 /**
1894 * An activity to run when device is inserted into a car dock.
1895 * Used with {@link #ACTION_MAIN} to launch an activity.
1896 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
1897 */
1898 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1899 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 // ---------------------------------------------------------------------
1902 // ---------------------------------------------------------------------
1903 // Standard extra data keys.
1904
1905 /**
1906 * The initial data to place in a newly created record. Use with
1907 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1908 * fields as would be given to the underlying ContentProvider.insert()
1909 * call.
1910 */
1911 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1912
1913 /**
1914 * A constant CharSequence that is associated with the Intent, used with
1915 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1916 * this may be a styled CharSequence, so you must use
1917 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1918 * retrieve it.
1919 */
1920 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1921
1922 /**
1923 * A content: URI holding a stream of data associated with the Intent,
1924 * used with {@link #ACTION_SEND} to supply the data being sent.
1925 */
1926 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1927
1928 /**
1929 * A String[] holding e-mail addresses that should be delivered to.
1930 */
1931 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1932
1933 /**
1934 * A String[] holding e-mail addresses that should be carbon copied.
1935 */
1936 public static final String EXTRA_CC = "android.intent.extra.CC";
1937
1938 /**
1939 * A String[] holding e-mail addresses that should be blind carbon copied.
1940 */
1941 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1942
1943 /**
1944 * A constant string holding the desired subject line of a message.
1945 */
1946 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1947
1948 /**
1949 * An Intent describing the choices you would like shown with
1950 * {@link #ACTION_PICK_ACTIVITY}.
1951 */
1952 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1953
1954 /**
1955 * A CharSequence dialog title to provide to the user when used with a
1956 * {@link #ACTION_CHOOSER}.
1957 */
1958 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1959
1960 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07001961 * A Parcelable[] of {@link Intent} or
1962 * {@link android.content.pm.LabeledIntent} objects as set with
1963 * {@link #putExtra(String, Parcelable[])} of additional activities to place
1964 * a the front of the list of choices, when shown to the user with a
1965 * {@link #ACTION_CHOOSER}.
1966 */
1967 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
1968
1969 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001970 * A {@link android.view.KeyEvent} object containing the event that
1971 * triggered the creation of the Intent it is in.
1972 */
1973 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1974
1975 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001976 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
1977 * before shutting down.
1978 *
1979 * {@hide}
1980 */
1981 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
1982
1983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1985 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1986 * of restarting the application.
1987 */
1988 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1989
1990 /**
1991 * A String holding the phone number originally entered in
1992 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1993 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1994 */
1995 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1996 /**
1997 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1998 * intents to supply the uid the package had been assigned. Also an optional
1999 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2000 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2001 * purpose.
2002 */
2003 public static final String EXTRA_UID = "android.intent.extra.UID";
2004
2005 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002006 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2007 * intents to indicate whether this represents a full uninstall (removing
2008 * both the code and its data) or a partial uninstall (leaving its data,
2009 * implying that this is an update).
2010 */
2011 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002012
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002013 /**
2014 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2015 * intents to indicate that this is a replacement of the package, so this
2016 * broadcast will immediately be followed by an add broadcast for a
2017 * different version of the same package.
2018 */
2019 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002020
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002021 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 * Used as an int extra field in {@link android.app.AlarmManager} intents
2023 * to tell the application being invoked how many pending alarms are being
2024 * delievered with the intent. For one-shot alarms this will always be 1.
2025 * For recurring alarms, this might be greater than 1 if the device was
2026 * asleep or powered off at the time an earlier alarm would have been
2027 * delivered.
2028 */
2029 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002030
Jacek Surazski86b6c532009-05-13 14:38:28 +02002031 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002032 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2033 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002034 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2035 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2036 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002037 */
2038 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2039
2040 /**
2041 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2042 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002043 */
2044 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2045
2046 /**
2047 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2048 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002049 */
2050 public static final int EXTRA_DOCK_STATE_DESK = 1;
2051
2052 /**
2053 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2054 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002055 */
2056 public static final int EXTRA_DOCK_STATE_CAR = 2;
2057
2058 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002059 * Boolean that can be supplied as meta-data with a dock activity, to
2060 * indicate that the dock should take over the home key when it is active.
2061 */
2062 public static final String METADATA_DOCK_HOME = "android.dock_home";
2063
2064 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002065 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2066 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002067 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002068 * @hide
2069 */
2070 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2071
2072 /**
Romain Guy4969af72009-06-17 10:53:19 -07002073 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002074 * package. Specifies the installer package name; this package will receive the
2075 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002076 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002077 * @hide
2078 */
Romain Guy4969af72009-06-17 10:53:19 -07002079 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002080 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002081
Wei Huang97ecc9c2009-05-11 17:44:20 -07002082 /**
2083 * Used in the extra field in the remote intent. It's astring token passed with the
2084 * remote intent.
2085 */
2086 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2087 "android.intent.extra.remote_intent_token";
2088
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002089 /**
2090 * Used as an int extra field in {@link android.content.Intent#ACTION_PACKAGE_CHANGED}
2091 * intent to supply the name of the component that changed.
Suchi Amalapurapu32f58902009-09-02 15:36:20 -07002092 *
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002093 */
2094 public static final String EXTRA_CHANGED_COMPONENT_NAME =
2095 "android.intent.extra.changed_component_name";
2096
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002097 /**
2098 * @hide
2099 * Magic extra system code can use when binding, to give a label for
2100 * who it is that has bound to a service. This is an integer giving
2101 * a framework string resource that can be displayed to the user.
2102 */
2103 public static final String EXTRA_CLIENT_LABEL =
2104 "android.intent.extra.client_label";
2105
2106 /**
2107 * @hide
2108 * Magic extra system code can use when binding, to give a PendingIntent object
2109 * that can be launched for the user to disable the system's use of this
2110 * service.
2111 */
2112 public static final String EXTRA_CLIENT_INTENT =
2113 "android.intent.extra.client_intent";
2114
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002115 // ---------------------------------------------------------------------
2116 // ---------------------------------------------------------------------
2117 // Intent flags (see mFlags variable).
2118
2119 /**
2120 * If set, the recipient of this Intent will be granted permission to
2121 * perform read operations on the Uri in the Intent's data.
2122 */
2123 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2124 /**
2125 * If set, the recipient of this Intent will be granted permission to
2126 * perform write operations on the Uri in the Intent's data.
2127 */
2128 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2129 /**
2130 * Can be set by the caller to indicate that this Intent is coming from
2131 * a background operation, not from direct user interaction.
2132 */
2133 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2134 /**
2135 * A flag you can enable for debugging: when set, log messages will be
2136 * printed during the resolution of this intent to show you what has
2137 * been found to create the final resolved list.
2138 */
2139 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2140
2141 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002142 * If set, the new activity is not kept in the history stack. As soon as
2143 * the user navigates away from it, the activity is finished. This may also
2144 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2145 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002146 */
2147 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2148 /**
2149 * If set, the activity will not be launched if it is already running
2150 * at the top of the history stack.
2151 */
2152 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2153 /**
2154 * If set, this activity will become the start of a new task on this
2155 * history stack. A task (from the activity that started it to the
2156 * next task activity) defines an atomic group of activities that the
2157 * user can move to. Tasks can be moved to the foreground and background;
2158 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002159 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002160 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2161 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002162 *
2163 * <p>This flag is generally used by activities that want
2164 * to present a "launcher" style behavior: they give the user a list of
2165 * separate things that can be done, which otherwise run completely
2166 * independently of the activity launching them.
2167 *
2168 * <p>When using this flag, if a task is already running for the activity
2169 * you are now starting, then a new activity will not be started; instead,
2170 * the current task will simply be brought to the front of the screen with
2171 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2172 * to disable this behavior.
2173 *
2174 * <p>This flag can not be used when the caller is requesting a result from
2175 * the activity being launched.
2176 */
2177 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2178 /**
2179 * <strong>Do not use this flag unless you are implementing your own
2180 * top-level application launcher.</strong> Used in conjunction with
2181 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2182 * behavior of bringing an existing task to the foreground. When set,
2183 * a new task is <em>always</em> started to host the Activity for the
2184 * Intent, regardless of whether there is already an existing task running
2185 * the same thing.
2186 *
2187 * <p><strong>Because the default system does not include graphical task management,
2188 * you should not use this flag unless you provide some way for a user to
2189 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002190 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002191 * <p>This flag is ignored if
2192 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
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_MULTIPLE_TASK = 0x08000000;
2198 /**
2199 * If set, and the activity being launched is already running in the
2200 * current task, then instead of launching a new instance of that activity,
2201 * all of the other activities on top of it will be closed and this Intent
2202 * will be delivered to the (now on top) old activity as a new Intent.
2203 *
2204 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2205 * If D calls startActivity() with an Intent that resolves to the component
2206 * of activity B, then C and D will be finished and B receive the given
2207 * Intent, resulting in the stack now being: A, B.
2208 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002209 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002210 * either receive the new intent you are starting here in its
2211 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002212 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002213 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2214 * the same intent, then it will be finished and re-created; for all other
2215 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2216 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002217 *
2218 * <p>This launch mode can also be used to good effect in conjunction with
2219 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2220 * of a task, it will bring any currently running instance of that task
2221 * to the foreground, and then clear it to its root state. This is
2222 * especially useful, for example, when launching an activity from the
2223 * notification manager.
2224 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002225 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2226 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002227 */
2228 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2229 /**
2230 * If set and this intent is being used to launch a new activity from an
2231 * existing one, then the reply target of the existing activity will be
2232 * transfered to the new activity. This way the new activity can call
2233 * {@link android.app.Activity#setResult} and have that result sent back to
2234 * the reply target of the original activity.
2235 */
2236 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2237 /**
2238 * If set and this intent is being used to launch a new activity from an
2239 * existing one, the current activity will not be counted as the top
2240 * activity for deciding whether the new intent should be delivered to
2241 * the top instead of starting a new one. The previous activity will
2242 * be used as the top, with the assumption being that the current activity
2243 * will finish itself immediately.
2244 */
2245 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2246 /**
2247 * If set, the new activity is not kept in the list of recently launched
2248 * activities.
2249 */
2250 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2251 /**
2252 * This flag is not normally set by application code, but set for you by
2253 * the system as described in the
2254 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2255 * launchMode} documentation for the singleTask mode.
2256 */
2257 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2258 /**
2259 * If set, and this activity is either being started in a new task or
2260 * bringing to the top an existing task, then it will be launched as
2261 * the front door of the task. This will result in the application of
2262 * any affinities needed to have that task in the proper state (either
2263 * moving activities to or from it), or simply resetting that task to
2264 * its initial state if needed.
2265 */
2266 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2267 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002268 * This flag is not normally set by application code, but set for you by
2269 * the system if this activity is being launched from history
2270 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 */
2272 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002273 /**
2274 * If set, this marks a point in the task's activity stack that should
2275 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002276 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002277 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2278 * the user re-launching it from home), this activity and all on top of
2279 * it will be finished so that the user does not return to them, but
2280 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002281 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002282 * <p>This is useful for cases where you have a logical break in your
2283 * application. For example, an e-mail application may have a command
2284 * to view an attachment, which launches an image view activity to
2285 * display it. This activity should be part of the e-mail application's
2286 * task, since it is a part of the task the user is involved in. However,
2287 * if the user leaves that task, and later selects the e-mail app from
2288 * home, we may like them to return to the conversation they were
2289 * viewing, not the picture attachment, since that is confusing. By
2290 * setting this flag when launching the image viewer, that viewer and
2291 * any activities it starts will be removed the next time the user returns
2292 * to mail.
2293 */
2294 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002295 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002296 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002297 * callback from occurring on the current frontmost activity before it is
2298 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002299 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002300 * <p>Typically, an activity can rely on that callback to indicate that an
2301 * explicit user action has caused their activity to be moved out of the
2302 * foreground. The callback marks an appropriate point in the activity's
2303 * lifecycle for it to dismiss any notifications that it intends to display
2304 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002305 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002306 * <p>If an activity is ever started via any non-user-driven events such as
2307 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2308 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002309 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002310 */
2311 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002312 /**
2313 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2314 * this flag will cause the launched activity to be brought to the front of its
2315 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002316 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002317 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2318 * If D calls startActivity() with an Intent that resolves to the component
2319 * of activity B, then B will be brought to the front of the history stack,
2320 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002321 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002323 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002324 */
2325 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002326 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002327 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2328 * this flag will prevent the system from applying an activity transition
2329 * animation to go to the next activity state. This doesn't mean an
2330 * animation will never run -- if another activity change happens that doesn't
2331 * specify this flag before the activity started here is displayed, then
2332 * that transition will be used. This this flag can be put to good use
2333 * when you are going to do a series of activity operations but the
2334 * animation seen by the user shouldn't be driven by the first activity
2335 * change but rather a later one.
2336 */
2337 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2338 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002339 * If set, when sending a broadcast only registered receivers will be
2340 * called -- no BroadcastReceiver components will be launched.
2341 */
2342 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002343 /**
2344 * If set, when sending a broadcast <i>before boot has completed</i> only
2345 * registered receivers will be called -- no BroadcastReceiver components
2346 * will be launched. Sticky intent state will be recorded properly even
2347 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2348 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002349 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002350 * <p>This flag is only for use by system sevices as a convenience to
2351 * avoid having to implement a more complex mechanism around detection
2352 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002353 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002354 * @hide
2355 */
2356 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002357 /**
2358 * Set when this broadcast is for a boot upgrade, a special mode that
2359 * allows the broadcast to be sent before the system is ready and launches
2360 * the app process with no providers running in it.
2361 * @hide
2362 */
2363 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x10000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002365 /**
2366 * @hide Flags that can't be changed with PendingIntent.
2367 */
2368 public static final int IMMUTABLE_FLAGS =
2369 FLAG_GRANT_READ_URI_PERMISSION
2370 | FLAG_GRANT_WRITE_URI_PERMISSION;
2371
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002372 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002373 // ---------------------------------------------------------------------
2374 // toUri() and parseUri() options.
2375
2376 /**
2377 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2378 * always has the "intent:" scheme. This syntax can be used when you want
2379 * to later disambiguate between URIs that are intended to describe an
2380 * Intent vs. all others that should be treated as raw URIs. When used
2381 * with {@link #parseUri}, any other scheme will result in a generic
2382 * VIEW action for that raw URI.
2383 */
2384 public static final int URI_INTENT_SCHEME = 1<<0;
2385
2386 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002387
2388 private String mAction;
2389 private Uri mData;
2390 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002391 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002392 private ComponentName mComponent;
2393 private int mFlags;
2394 private HashSet<String> mCategories;
2395 private Bundle mExtras;
2396
2397 // ---------------------------------------------------------------------
2398
2399 /**
2400 * Create an empty intent.
2401 */
2402 public Intent() {
2403 }
2404
2405 /**
2406 * Copy constructor.
2407 */
2408 public Intent(Intent o) {
2409 this.mAction = o.mAction;
2410 this.mData = o.mData;
2411 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002412 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002413 this.mComponent = o.mComponent;
2414 this.mFlags = o.mFlags;
2415 if (o.mCategories != null) {
2416 this.mCategories = new HashSet<String>(o.mCategories);
2417 }
2418 if (o.mExtras != null) {
2419 this.mExtras = new Bundle(o.mExtras);
2420 }
2421 }
2422
2423 @Override
2424 public Object clone() {
2425 return new Intent(this);
2426 }
2427
2428 private Intent(Intent o, boolean all) {
2429 this.mAction = o.mAction;
2430 this.mData = o.mData;
2431 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002432 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 this.mComponent = o.mComponent;
2434 if (o.mCategories != null) {
2435 this.mCategories = new HashSet<String>(o.mCategories);
2436 }
2437 }
2438
2439 /**
2440 * Make a clone of only the parts of the Intent that are relevant for
2441 * filter matching: the action, data, type, component, and categories.
2442 */
2443 public Intent cloneFilter() {
2444 return new Intent(this, false);
2445 }
2446
2447 /**
2448 * Create an intent with a given action. All other fields (data, type,
2449 * class) are null. Note that the action <em>must</em> be in a
2450 * namespace because Intents are used globally in the system -- for
2451 * example the system VIEW action is android.intent.action.VIEW; an
2452 * application's custom action would be something like
2453 * com.google.app.myapp.CUSTOM_ACTION.
2454 *
2455 * @param action The Intent action, such as ACTION_VIEW.
2456 */
2457 public Intent(String action) {
2458 mAction = action;
2459 }
2460
2461 /**
2462 * Create an intent with a given action and for a given data url. Note
2463 * that the action <em>must</em> be in a namespace because Intents are
2464 * used globally in the system -- for example the system VIEW action is
2465 * android.intent.action.VIEW; an application's custom action would be
2466 * something like com.google.app.myapp.CUSTOM_ACTION.
2467 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002468 * <p><em>Note: scheme and host name matching in the Android framework is
2469 * case-sensitive, unlike the formal RFC. As a result,
2470 * you should always ensure that you write your Uri with these elements
2471 * using lower case letters, and normalize any Uris you receive from
2472 * outside of Android to ensure the scheme and host is lower case.</em></p>
2473 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002474 * @param action The Intent action, such as ACTION_VIEW.
2475 * @param uri The Intent data URI.
2476 */
2477 public Intent(String action, Uri uri) {
2478 mAction = action;
2479 mData = uri;
2480 }
2481
2482 /**
2483 * Create an intent for a specific component. All other fields (action, data,
2484 * type, class) are null, though they can be modified later with explicit
2485 * calls. This provides a convenient way to create an intent that is
2486 * intended to execute a hard-coded class name, rather than relying on the
2487 * system to find an appropriate class for you; see {@link #setComponent}
2488 * for more information on the repercussions of this.
2489 *
2490 * @param packageContext A Context of the application package implementing
2491 * this class.
2492 * @param cls The component class that is to be used for the intent.
2493 *
2494 * @see #setClass
2495 * @see #setComponent
2496 * @see #Intent(String, android.net.Uri , Context, Class)
2497 */
2498 public Intent(Context packageContext, Class<?> cls) {
2499 mComponent = new ComponentName(packageContext, cls);
2500 }
2501
2502 /**
2503 * Create an intent for a specific component with a specified action and data.
2504 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2505 * construct the Intent and then calling {@link #setClass} to set its
2506 * class.
2507 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002508 * <p><em>Note: scheme and host name matching in the Android framework is
2509 * case-sensitive, unlike the formal RFC. As a result,
2510 * you should always ensure that you write your Uri with these elements
2511 * using lower case letters, and normalize any Uris you receive from
2512 * outside of Android to ensure the scheme and host is lower case.</em></p>
2513 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002514 * @param action The Intent action, such as ACTION_VIEW.
2515 * @param uri The Intent data URI.
2516 * @param packageContext A Context of the application package implementing
2517 * this class.
2518 * @param cls The component class that is to be used for the intent.
2519 *
2520 * @see #Intent(String, android.net.Uri)
2521 * @see #Intent(Context, Class)
2522 * @see #setClass
2523 * @see #setComponent
2524 */
2525 public Intent(String action, Uri uri,
2526 Context packageContext, Class<?> cls) {
2527 mAction = action;
2528 mData = uri;
2529 mComponent = new ComponentName(packageContext, cls);
2530 }
2531
2532 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002533 * Call {@link #parseUri} with 0 flags.
2534 * @deprecated Use {@link #parseUri} instead.
2535 */
2536 @Deprecated
2537 public static Intent getIntent(String uri) throws URISyntaxException {
2538 return parseUri(uri, 0);
2539 }
2540
2541 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002542 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002543 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002544 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002545 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002546 *
2547 * <p>The URI given here must not be relative -- that is, it must include
2548 * the scheme and full path.
2549 *
2550 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002551 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002552 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 *
2554 * @return Intent The newly created Intent object.
2555 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002556 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2557 * it bad (as parsed by the Uri class) or the Intent data within the
2558 * URI is invalid.
2559 *
2560 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002561 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002562 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002563 int i = 0;
2564 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002565 // Validate intent scheme for if requested.
2566 if ((flags&URI_INTENT_SCHEME) != 0) {
2567 if (!uri.startsWith("intent:")) {
2568 Intent intent = new Intent(ACTION_VIEW);
2569 try {
2570 intent.setData(Uri.parse(uri));
2571 } catch (IllegalArgumentException e) {
2572 throw new URISyntaxException(uri, e.getMessage());
2573 }
2574 return intent;
2575 }
2576 }
2577
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002578 // simple case
2579 i = uri.lastIndexOf("#");
2580 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2581
2582 // old format Intent URI
2583 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002584
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002585 // new format
2586 Intent intent = new Intent(ACTION_VIEW);
2587
2588 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002589 String data = i >= 0 ? uri.substring(0, i) : null;
2590 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002591 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002592
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 // loop over contents of Intent, all name=value;
2594 while (!uri.startsWith("end", i)) {
2595 int eq = uri.indexOf('=', i);
2596 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002597 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002598
2599 // action
2600 if (uri.startsWith("action=", i)) {
2601 intent.mAction = value;
2602 }
2603
2604 // categories
2605 else if (uri.startsWith("category=", i)) {
2606 intent.addCategory(value);
2607 }
2608
2609 // type
2610 else if (uri.startsWith("type=", i)) {
2611 intent.mType = value;
2612 }
2613
2614 // launch flags
2615 else if (uri.startsWith("launchFlags=", i)) {
2616 intent.mFlags = Integer.decode(value).intValue();
2617 }
2618
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002619 // package
2620 else if (uri.startsWith("package=", i)) {
2621 intent.mPackage = value;
2622 }
2623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 // component
2625 else if (uri.startsWith("component=", i)) {
2626 intent.mComponent = ComponentName.unflattenFromString(value);
2627 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002628
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002629 // scheme
2630 else if (uri.startsWith("scheme=", i)) {
2631 scheme = value;
2632 }
2633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002634 // extra
2635 else {
2636 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002637 // create Bundle if it doesn't already exist
2638 if (intent.mExtras == null) intent.mExtras = new Bundle();
2639 Bundle b = intent.mExtras;
2640 // add EXTRA
2641 if (uri.startsWith("S.", i)) b.putString(key, value);
2642 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2643 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2644 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2645 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2646 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2647 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2648 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2649 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2650 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2651 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 // move to the next item
2654 i = semi + 1;
2655 }
2656
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002657 if (data != null) {
2658 if (data.startsWith("intent:")) {
2659 data = data.substring(7);
2660 if (scheme != null) {
2661 data = scheme + ':' + data;
2662 }
2663 }
2664
2665 if (data.length() > 0) {
2666 try {
2667 intent.mData = Uri.parse(data);
2668 } catch (IllegalArgumentException e) {
2669 throw new URISyntaxException(uri, e.getMessage());
2670 }
2671 }
2672 }
2673
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002674 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002676 } catch (IndexOutOfBoundsException e) {
2677 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2678 }
2679 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002680
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002681 public static Intent getIntentOld(String uri) throws URISyntaxException {
2682 Intent intent;
2683
2684 int i = uri.lastIndexOf('#');
2685 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002686 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002687 final int intentFragmentStart = i;
2688 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002689
2690 i++;
2691
2692 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002693 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002694 i += 7;
2695 int j = uri.indexOf(')', i);
2696 action = uri.substring(i, j);
2697 i = j + 1;
2698 }
2699
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002700 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002701
2702 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002703 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002704 i += 11;
2705 int j = uri.indexOf(')', i);
2706 while (i < j) {
2707 int sep = uri.indexOf('!', i);
2708 if (sep < 0) sep = j;
2709 if (i < sep) {
2710 intent.addCategory(uri.substring(i, sep));
2711 }
2712 i = sep + 1;
2713 }
2714 i = j + 1;
2715 }
2716
2717 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002718 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002719 i += 5;
2720 int j = uri.indexOf(')', i);
2721 intent.mType = uri.substring(i, j);
2722 i = j + 1;
2723 }
2724
2725 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002726 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002727 i += 12;
2728 int j = uri.indexOf(')', i);
2729 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2730 i = j + 1;
2731 }
2732
2733 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002734 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002735 i += 10;
2736 int j = uri.indexOf(')', i);
2737 int sep = uri.indexOf('!', i);
2738 if (sep >= 0 && sep < j) {
2739 String pkg = uri.substring(i, sep);
2740 String cls = uri.substring(sep + 1, j);
2741 intent.mComponent = new ComponentName(pkg, cls);
2742 }
2743 i = j + 1;
2744 }
2745
2746 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002747 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002748 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002749
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 final int closeParen = uri.indexOf(')', i);
2751 if (closeParen == -1) throw new URISyntaxException(uri,
2752 "EXTRA missing trailing ')'", i);
2753
2754 while (i < closeParen) {
2755 // fetch the key value
2756 int j = uri.indexOf('=', i);
2757 if (j <= i + 1 || i >= closeParen) {
2758 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2759 }
2760 char type = uri.charAt(i);
2761 i++;
2762 String key = uri.substring(i, j);
2763 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002764
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002765 // get type-value
2766 j = uri.indexOf('!', i);
2767 if (j == -1 || j >= closeParen) j = closeParen;
2768 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2769 String value = uri.substring(i, j);
2770 i = j;
2771
2772 // create Bundle if it doesn't already exist
2773 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002774
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002775 // add item to bundle
2776 try {
2777 switch (type) {
2778 case 'S':
2779 intent.mExtras.putString(key, Uri.decode(value));
2780 break;
2781 case 'B':
2782 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2783 break;
2784 case 'b':
2785 intent.mExtras.putByte(key, Byte.parseByte(value));
2786 break;
2787 case 'c':
2788 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2789 break;
2790 case 'd':
2791 intent.mExtras.putDouble(key, Double.parseDouble(value));
2792 break;
2793 case 'f':
2794 intent.mExtras.putFloat(key, Float.parseFloat(value));
2795 break;
2796 case 'i':
2797 intent.mExtras.putInt(key, Integer.parseInt(value));
2798 break;
2799 case 'l':
2800 intent.mExtras.putLong(key, Long.parseLong(value));
2801 break;
2802 case 's':
2803 intent.mExtras.putShort(key, Short.parseShort(value));
2804 break;
2805 default:
2806 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2807 }
2808 } catch (NumberFormatException e) {
2809 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2810 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002811
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002812 char ch = uri.charAt(i);
2813 if (ch == ')') break;
2814 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2815 i++;
2816 }
2817 }
2818
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002819 if (isIntentFragment) {
2820 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
2821 } else {
2822 intent.mData = Uri.parse(uri);
2823 }
2824
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002825 if (intent.mAction == null) {
2826 // By default, if no action is specified, then use VIEW.
2827 intent.mAction = ACTION_VIEW;
2828 }
2829
2830 } else {
2831 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2832 }
2833
2834 return intent;
2835 }
2836
2837 /**
2838 * Retrieve the general action to be performed, such as
2839 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2840 * the information in the intent should be interpreted -- most importantly,
2841 * what to do with the data returned by {@link #getData}.
2842 *
2843 * @return The action of this intent or null if none is specified.
2844 *
2845 * @see #setAction
2846 */
2847 public String getAction() {
2848 return mAction;
2849 }
2850
2851 /**
2852 * Retrieve data this intent is operating on. This URI specifies the name
2853 * of the data; often it uses the content: scheme, specifying data in a
2854 * content provider. Other schemes may be handled by specific activities,
2855 * such as http: by the web browser.
2856 *
2857 * @return The URI of the data this intent is targeting or null.
2858 *
2859 * @see #getScheme
2860 * @see #setData
2861 */
2862 public Uri getData() {
2863 return mData;
2864 }
2865
2866 /**
2867 * The same as {@link #getData()}, but returns the URI as an encoded
2868 * String.
2869 */
2870 public String getDataString() {
2871 return mData != null ? mData.toString() : null;
2872 }
2873
2874 /**
2875 * Return the scheme portion of the intent's data. If the data is null or
2876 * does not include a scheme, null is returned. Otherwise, the scheme
2877 * prefix without the final ':' is returned, i.e. "http".
2878 *
2879 * <p>This is the same as calling getData().getScheme() (and checking for
2880 * null data).
2881 *
2882 * @return The scheme of this intent.
2883 *
2884 * @see #getData
2885 */
2886 public String getScheme() {
2887 return mData != null ? mData.getScheme() : null;
2888 }
2889
2890 /**
2891 * Retrieve any explicit MIME type included in the intent. This is usually
2892 * null, as the type is determined by the intent data.
2893 *
2894 * @return If a type was manually set, it is returned; else null is
2895 * returned.
2896 *
2897 * @see #resolveType(ContentResolver)
2898 * @see #setType
2899 */
2900 public String getType() {
2901 return mType;
2902 }
2903
2904 /**
2905 * Return the MIME data type of this intent. If the type field is
2906 * explicitly set, that is simply returned. Otherwise, if the data is set,
2907 * the type of that data is returned. If neither fields are set, a null is
2908 * returned.
2909 *
2910 * @return The MIME type of this intent.
2911 *
2912 * @see #getType
2913 * @see #resolveType(ContentResolver)
2914 */
2915 public String resolveType(Context context) {
2916 return resolveType(context.getContentResolver());
2917 }
2918
2919 /**
2920 * Return the MIME data type of this intent. If the type field is
2921 * explicitly set, that is simply returned. Otherwise, if the data is set,
2922 * the type of that data is returned. If neither fields are set, a null is
2923 * returned.
2924 *
2925 * @param resolver A ContentResolver that can be used to determine the MIME
2926 * type of the intent's data.
2927 *
2928 * @return The MIME type of this intent.
2929 *
2930 * @see #getType
2931 * @see #resolveType(Context)
2932 */
2933 public String resolveType(ContentResolver resolver) {
2934 if (mType != null) {
2935 return mType;
2936 }
2937 if (mData != null) {
2938 if ("content".equals(mData.getScheme())) {
2939 return resolver.getType(mData);
2940 }
2941 }
2942 return null;
2943 }
2944
2945 /**
2946 * Return the MIME data type of this intent, only if it will be needed for
2947 * intent resolution. This is not generally useful for application code;
2948 * it is used by the frameworks for communicating with back-end system
2949 * services.
2950 *
2951 * @param resolver A ContentResolver that can be used to determine the MIME
2952 * type of the intent's data.
2953 *
2954 * @return The MIME type of this intent, or null if it is unknown or not
2955 * needed.
2956 */
2957 public String resolveTypeIfNeeded(ContentResolver resolver) {
2958 if (mComponent != null) {
2959 return mType;
2960 }
2961 return resolveType(resolver);
2962 }
2963
2964 /**
2965 * Check if an category exists in the intent.
2966 *
2967 * @param category The category to check.
2968 *
2969 * @return boolean True if the intent contains the category, else false.
2970 *
2971 * @see #getCategories
2972 * @see #addCategory
2973 */
2974 public boolean hasCategory(String category) {
2975 return mCategories != null && mCategories.contains(category);
2976 }
2977
2978 /**
2979 * Return the set of all categories in the intent. If there are no categories,
2980 * returns NULL.
2981 *
2982 * @return Set The set of categories you can examine. Do not modify!
2983 *
2984 * @see #hasCategory
2985 * @see #addCategory
2986 */
2987 public Set<String> getCategories() {
2988 return mCategories;
2989 }
2990
2991 /**
2992 * Sets the ClassLoader that will be used when unmarshalling
2993 * any Parcelable values from the extras of this Intent.
2994 *
2995 * @param loader a ClassLoader, or null to use the default loader
2996 * at the time of unmarshalling.
2997 */
2998 public void setExtrasClassLoader(ClassLoader loader) {
2999 if (mExtras != null) {
3000 mExtras.setClassLoader(loader);
3001 }
3002 }
3003
3004 /**
3005 * Returns true if an extra value is associated with the given name.
3006 * @param name the extra's name
3007 * @return true if the given extra is present.
3008 */
3009 public boolean hasExtra(String name) {
3010 return mExtras != null && mExtras.containsKey(name);
3011 }
3012
3013 /**
3014 * Returns true if the Intent's extras contain a parcelled file descriptor.
3015 * @return true if the Intent contains a parcelled file descriptor.
3016 */
3017 public boolean hasFileDescriptors() {
3018 return mExtras != null && mExtras.hasFileDescriptors();
3019 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003020
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003021 /**
3022 * Retrieve extended data from the intent.
3023 *
3024 * @param name The name of the desired item.
3025 *
3026 * @return the value of an item that previously added with putExtra()
3027 * or null if none was found.
3028 *
3029 * @deprecated
3030 * @hide
3031 */
3032 @Deprecated
3033 public Object getExtra(String name) {
3034 return getExtra(name, null);
3035 }
3036
3037 /**
3038 * Retrieve extended data from the intent.
3039 *
3040 * @param name The name of the desired item.
3041 * @param defaultValue the value to be returned if no value of the desired
3042 * type is stored with the given name.
3043 *
3044 * @return the value of an item that previously added with putExtra()
3045 * or the default value if none was found.
3046 *
3047 * @see #putExtra(String, boolean)
3048 */
3049 public boolean getBooleanExtra(String name, boolean defaultValue) {
3050 return mExtras == null ? defaultValue :
3051 mExtras.getBoolean(name, defaultValue);
3052 }
3053
3054 /**
3055 * Retrieve extended data from the intent.
3056 *
3057 * @param name The name of the desired item.
3058 * @param defaultValue the value to be returned if no value of the desired
3059 * type is stored with the given name.
3060 *
3061 * @return the value of an item that previously added with putExtra()
3062 * or the default value if none was found.
3063 *
3064 * @see #putExtra(String, byte)
3065 */
3066 public byte getByteExtra(String name, byte defaultValue) {
3067 return mExtras == null ? defaultValue :
3068 mExtras.getByte(name, defaultValue);
3069 }
3070
3071 /**
3072 * Retrieve extended data from the intent.
3073 *
3074 * @param name The name of the desired item.
3075 * @param defaultValue the value to be returned if no value of the desired
3076 * type is stored with the given name.
3077 *
3078 * @return the value of an item that previously added with putExtra()
3079 * or the default value if none was found.
3080 *
3081 * @see #putExtra(String, short)
3082 */
3083 public short getShortExtra(String name, short defaultValue) {
3084 return mExtras == null ? defaultValue :
3085 mExtras.getShort(name, defaultValue);
3086 }
3087
3088 /**
3089 * Retrieve extended data from the intent.
3090 *
3091 * @param name The name of the desired item.
3092 * @param defaultValue the value to be returned if no value of the desired
3093 * type is stored with the given name.
3094 *
3095 * @return the value of an item that previously added with putExtra()
3096 * or the default value if none was found.
3097 *
3098 * @see #putExtra(String, char)
3099 */
3100 public char getCharExtra(String name, char defaultValue) {
3101 return mExtras == null ? defaultValue :
3102 mExtras.getChar(name, defaultValue);
3103 }
3104
3105 /**
3106 * Retrieve extended data from the intent.
3107 *
3108 * @param name The name of the desired item.
3109 * @param defaultValue the value to be returned if no value of the desired
3110 * type is stored with the given name.
3111 *
3112 * @return the value of an item that previously added with putExtra()
3113 * or the default value if none was found.
3114 *
3115 * @see #putExtra(String, int)
3116 */
3117 public int getIntExtra(String name, int defaultValue) {
3118 return mExtras == null ? defaultValue :
3119 mExtras.getInt(name, defaultValue);
3120 }
3121
3122 /**
3123 * Retrieve extended data from the intent.
3124 *
3125 * @param name The name of the desired item.
3126 * @param defaultValue the value to be returned if no value of the desired
3127 * type is stored with the given name.
3128 *
3129 * @return the value of an item that previously added with putExtra()
3130 * or the default value if none was found.
3131 *
3132 * @see #putExtra(String, long)
3133 */
3134 public long getLongExtra(String name, long defaultValue) {
3135 return mExtras == null ? defaultValue :
3136 mExtras.getLong(name, defaultValue);
3137 }
3138
3139 /**
3140 * Retrieve extended data from the intent.
3141 *
3142 * @param name The name of the desired item.
3143 * @param defaultValue the value to be returned if no value of the desired
3144 * type is stored with the given name.
3145 *
3146 * @return the value of an item that previously added with putExtra(),
3147 * or the default value if no such item is present
3148 *
3149 * @see #putExtra(String, float)
3150 */
3151 public float getFloatExtra(String name, float defaultValue) {
3152 return mExtras == null ? defaultValue :
3153 mExtras.getFloat(name, defaultValue);
3154 }
3155
3156 /**
3157 * Retrieve extended data from the intent.
3158 *
3159 * @param name The name of the desired item.
3160 * @param defaultValue the value to be returned if no value of the desired
3161 * type is stored with the given name.
3162 *
3163 * @return the value of an item that previously added with putExtra()
3164 * or the default value if none was found.
3165 *
3166 * @see #putExtra(String, double)
3167 */
3168 public double getDoubleExtra(String name, double defaultValue) {
3169 return mExtras == null ? defaultValue :
3170 mExtras.getDouble(name, defaultValue);
3171 }
3172
3173 /**
3174 * Retrieve extended data from the intent.
3175 *
3176 * @param name The name of the desired item.
3177 *
3178 * @return the value of an item that previously added with putExtra()
3179 * or null if no String value was found.
3180 *
3181 * @see #putExtra(String, String)
3182 */
3183 public String getStringExtra(String name) {
3184 return mExtras == null ? null : mExtras.getString(name);
3185 }
3186
3187 /**
3188 * Retrieve extended data from the intent.
3189 *
3190 * @param name The name of the desired item.
3191 *
3192 * @return the value of an item that previously added with putExtra()
3193 * or null if no CharSequence value was found.
3194 *
3195 * @see #putExtra(String, CharSequence)
3196 */
3197 public CharSequence getCharSequenceExtra(String name) {
3198 return mExtras == null ? null : mExtras.getCharSequence(name);
3199 }
3200
3201 /**
3202 * Retrieve extended data from the intent.
3203 *
3204 * @param name The name of the desired item.
3205 *
3206 * @return the value of an item that previously added with putExtra()
3207 * or null if no Parcelable value was found.
3208 *
3209 * @see #putExtra(String, Parcelable)
3210 */
3211 public <T extends Parcelable> T getParcelableExtra(String name) {
3212 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3213 }
3214
3215 /**
3216 * Retrieve extended data from the intent.
3217 *
3218 * @param name The name of the desired item.
3219 *
3220 * @return the value of an item that previously added with putExtra()
3221 * or null if no Parcelable[] value was found.
3222 *
3223 * @see #putExtra(String, Parcelable[])
3224 */
3225 public Parcelable[] getParcelableArrayExtra(String name) {
3226 return mExtras == null ? null : mExtras.getParcelableArray(name);
3227 }
3228
3229 /**
3230 * Retrieve extended data from the intent.
3231 *
3232 * @param name The name of the desired item.
3233 *
3234 * @return the value of an item that previously added with putExtra()
3235 * or null if no ArrayList<Parcelable> value was found.
3236 *
3237 * @see #putParcelableArrayListExtra(String, ArrayList)
3238 */
3239 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3240 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3241 }
3242
3243 /**
3244 * Retrieve extended data from the intent.
3245 *
3246 * @param name The name of the desired item.
3247 *
3248 * @return the value of an item that previously added with putExtra()
3249 * or null if no Serializable value was found.
3250 *
3251 * @see #putExtra(String, Serializable)
3252 */
3253 public Serializable getSerializableExtra(String name) {
3254 return mExtras == null ? null : mExtras.getSerializable(name);
3255 }
3256
3257 /**
3258 * Retrieve extended data from the intent.
3259 *
3260 * @param name The name of the desired item.
3261 *
3262 * @return the value of an item that previously added with putExtra()
3263 * or null if no ArrayList<Integer> value was found.
3264 *
3265 * @see #putIntegerArrayListExtra(String, ArrayList)
3266 */
3267 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3268 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3269 }
3270
3271 /**
3272 * Retrieve extended data from the intent.
3273 *
3274 * @param name The name of the desired item.
3275 *
3276 * @return the value of an item that previously added with putExtra()
3277 * or null if no ArrayList<String> value was found.
3278 *
3279 * @see #putStringArrayListExtra(String, ArrayList)
3280 */
3281 public ArrayList<String> getStringArrayListExtra(String name) {
3282 return mExtras == null ? null : mExtras.getStringArrayList(name);
3283 }
3284
3285 /**
3286 * Retrieve extended data from the intent.
3287 *
3288 * @param name The name of the desired item.
3289 *
3290 * @return the value of an item that previously added with putExtra()
3291 * or null if no boolean array value was found.
3292 *
3293 * @see #putExtra(String, boolean[])
3294 */
3295 public boolean[] getBooleanArrayExtra(String name) {
3296 return mExtras == null ? null : mExtras.getBooleanArray(name);
3297 }
3298
3299 /**
3300 * Retrieve extended data from the intent.
3301 *
3302 * @param name The name of the desired item.
3303 *
3304 * @return the value of an item that previously added with putExtra()
3305 * or null if no byte array value was found.
3306 *
3307 * @see #putExtra(String, byte[])
3308 */
3309 public byte[] getByteArrayExtra(String name) {
3310 return mExtras == null ? null : mExtras.getByteArray(name);
3311 }
3312
3313 /**
3314 * Retrieve extended data from the intent.
3315 *
3316 * @param name The name of the desired item.
3317 *
3318 * @return the value of an item that previously added with putExtra()
3319 * or null if no short array value was found.
3320 *
3321 * @see #putExtra(String, short[])
3322 */
3323 public short[] getShortArrayExtra(String name) {
3324 return mExtras == null ? null : mExtras.getShortArray(name);
3325 }
3326
3327 /**
3328 * Retrieve extended data from the intent.
3329 *
3330 * @param name The name of the desired item.
3331 *
3332 * @return the value of an item that previously added with putExtra()
3333 * or null if no char array value was found.
3334 *
3335 * @see #putExtra(String, char[])
3336 */
3337 public char[] getCharArrayExtra(String name) {
3338 return mExtras == null ? null : mExtras.getCharArray(name);
3339 }
3340
3341 /**
3342 * Retrieve extended data from the intent.
3343 *
3344 * @param name The name of the desired item.
3345 *
3346 * @return the value of an item that previously added with putExtra()
3347 * or null if no int array value was found.
3348 *
3349 * @see #putExtra(String, int[])
3350 */
3351 public int[] getIntArrayExtra(String name) {
3352 return mExtras == null ? null : mExtras.getIntArray(name);
3353 }
3354
3355 /**
3356 * Retrieve extended data from the intent.
3357 *
3358 * @param name The name of the desired item.
3359 *
3360 * @return the value of an item that previously added with putExtra()
3361 * or null if no long array value was found.
3362 *
3363 * @see #putExtra(String, long[])
3364 */
3365 public long[] getLongArrayExtra(String name) {
3366 return mExtras == null ? null : mExtras.getLongArray(name);
3367 }
3368
3369 /**
3370 * Retrieve extended data from the intent.
3371 *
3372 * @param name The name of the desired item.
3373 *
3374 * @return the value of an item that previously added with putExtra()
3375 * or null if no float array value was found.
3376 *
3377 * @see #putExtra(String, float[])
3378 */
3379 public float[] getFloatArrayExtra(String name) {
3380 return mExtras == null ? null : mExtras.getFloatArray(name);
3381 }
3382
3383 /**
3384 * Retrieve extended data from the intent.
3385 *
3386 * @param name The name of the desired item.
3387 *
3388 * @return the value of an item that previously added with putExtra()
3389 * or null if no double array value was found.
3390 *
3391 * @see #putExtra(String, double[])
3392 */
3393 public double[] getDoubleArrayExtra(String name) {
3394 return mExtras == null ? null : mExtras.getDoubleArray(name);
3395 }
3396
3397 /**
3398 * Retrieve extended data from the intent.
3399 *
3400 * @param name The name of the desired item.
3401 *
3402 * @return the value of an item that previously added with putExtra()
3403 * or null if no String array value was found.
3404 *
3405 * @see #putExtra(String, String[])
3406 */
3407 public String[] getStringArrayExtra(String name) {
3408 return mExtras == null ? null : mExtras.getStringArray(name);
3409 }
3410
3411 /**
3412 * Retrieve extended data from the intent.
3413 *
3414 * @param name The name of the desired item.
3415 *
3416 * @return the value of an item that previously added with putExtra()
3417 * or null if no Bundle value was found.
3418 *
3419 * @see #putExtra(String, Bundle)
3420 */
3421 public Bundle getBundleExtra(String name) {
3422 return mExtras == null ? null : mExtras.getBundle(name);
3423 }
3424
3425 /**
3426 * Retrieve extended data from the intent.
3427 *
3428 * @param name The name of the desired item.
3429 *
3430 * @return the value of an item that previously added with putExtra()
3431 * or null if no IBinder value was found.
3432 *
3433 * @see #putExtra(String, IBinder)
3434 *
3435 * @deprecated
3436 * @hide
3437 */
3438 @Deprecated
3439 public IBinder getIBinderExtra(String name) {
3440 return mExtras == null ? null : mExtras.getIBinder(name);
3441 }
3442
3443 /**
3444 * Retrieve extended data from the intent.
3445 *
3446 * @param name The name of the desired item.
3447 * @param defaultValue The default value to return in case no item is
3448 * associated with the key 'name'
3449 *
3450 * @return the value of an item that previously added with putExtra()
3451 * or defaultValue if none was found.
3452 *
3453 * @see #putExtra
3454 *
3455 * @deprecated
3456 * @hide
3457 */
3458 @Deprecated
3459 public Object getExtra(String name, Object defaultValue) {
3460 Object result = defaultValue;
3461 if (mExtras != null) {
3462 Object result2 = mExtras.get(name);
3463 if (result2 != null) {
3464 result = result2;
3465 }
3466 }
3467
3468 return result;
3469 }
3470
3471 /**
3472 * Retrieves a map of extended data from the intent.
3473 *
3474 * @return the map of all extras previously added with putExtra(),
3475 * or null if none have been added.
3476 */
3477 public Bundle getExtras() {
3478 return (mExtras != null)
3479 ? new Bundle(mExtras)
3480 : null;
3481 }
3482
3483 /**
3484 * Retrieve any special flags associated with this intent. You will
3485 * normally just set them with {@link #setFlags} and let the system
3486 * take the appropriate action with them.
3487 *
3488 * @return int The currently set flags.
3489 *
3490 * @see #setFlags
3491 */
3492 public int getFlags() {
3493 return mFlags;
3494 }
3495
3496 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003497 * Retrieve the application package name this Intent is limited to. When
3498 * resolving an Intent, if non-null this limits the resolution to only
3499 * components in the given application package.
3500 *
3501 * @return The name of the application package for the Intent.
3502 *
3503 * @see #resolveActivity
3504 * @see #setPackage
3505 */
3506 public String getPackage() {
3507 return mPackage;
3508 }
3509
3510 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003511 * Retrieve the concrete component associated with the intent. When receiving
3512 * an intent, this is the component that was found to best handle it (that is,
3513 * yourself) and will always be non-null; in all other cases it will be
3514 * null unless explicitly set.
3515 *
3516 * @return The name of the application component to handle the intent.
3517 *
3518 * @see #resolveActivity
3519 * @see #setComponent
3520 */
3521 public ComponentName getComponent() {
3522 return mComponent;
3523 }
3524
3525 /**
3526 * Return the Activity component that should be used to handle this intent.
3527 * The appropriate component is determined based on the information in the
3528 * intent, evaluated as follows:
3529 *
3530 * <p>If {@link #getComponent} returns an explicit class, that is returned
3531 * without any further consideration.
3532 *
3533 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3534 * category to be considered.
3535 *
3536 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3537 * action.
3538 *
3539 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3540 * this type.
3541 *
3542 * <p>If {@link #addCategory} has added any categories, the activity must
3543 * handle ALL of the categories specified.
3544 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003545 * <p>If {@link #getPackage} is non-NULL, only activity components in
3546 * that application package will be considered.
3547 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548 * <p>If there are no activities that satisfy all of these conditions, a
3549 * null string is returned.
3550 *
3551 * <p>If multiple activities are found to satisfy the intent, the one with
3552 * the highest priority will be used. If there are multiple activities
3553 * with the same priority, the system will either pick the best activity
3554 * based on user preference, or resolve to a system class that will allow
3555 * the user to pick an activity and forward from there.
3556 *
3557 * <p>This method is implemented simply by calling
3558 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3559 * true.</p>
3560 * <p> This API is called for you as part of starting an activity from an
3561 * intent. You do not normally need to call it yourself.</p>
3562 *
3563 * @param pm The package manager with which to resolve the Intent.
3564 *
3565 * @return Name of the component implementing an activity that can
3566 * display the intent.
3567 *
3568 * @see #setComponent
3569 * @see #getComponent
3570 * @see #resolveActivityInfo
3571 */
3572 public ComponentName resolveActivity(PackageManager pm) {
3573 if (mComponent != null) {
3574 return mComponent;
3575 }
3576
3577 ResolveInfo info = pm.resolveActivity(
3578 this, PackageManager.MATCH_DEFAULT_ONLY);
3579 if (info != null) {
3580 return new ComponentName(
3581 info.activityInfo.applicationInfo.packageName,
3582 info.activityInfo.name);
3583 }
3584
3585 return null;
3586 }
3587
3588 /**
3589 * Resolve the Intent into an {@link ActivityInfo}
3590 * describing the activity that should execute the intent. Resolution
3591 * follows the same rules as described for {@link #resolveActivity}, but
3592 * you get back the completely information about the resolved activity
3593 * instead of just its class name.
3594 *
3595 * @param pm The package manager with which to resolve the Intent.
3596 * @param flags Addition information to retrieve as per
3597 * {@link PackageManager#getActivityInfo(ComponentName, int)
3598 * PackageManager.getActivityInfo()}.
3599 *
3600 * @return PackageManager.ActivityInfo
3601 *
3602 * @see #resolveActivity
3603 */
3604 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3605 ActivityInfo ai = null;
3606 if (mComponent != null) {
3607 try {
3608 ai = pm.getActivityInfo(mComponent, flags);
3609 } catch (PackageManager.NameNotFoundException e) {
3610 // ignore
3611 }
3612 } else {
3613 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003614 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003615 if (info != null) {
3616 ai = info.activityInfo;
3617 }
3618 }
3619
3620 return ai;
3621 }
3622
3623 /**
3624 * Set the general action to be performed.
3625 *
3626 * @param action An action name, such as ACTION_VIEW. Application-specific
3627 * actions should be prefixed with the vendor's package name.
3628 *
3629 * @return Returns the same Intent object, for chaining multiple calls
3630 * into a single statement.
3631 *
3632 * @see #getAction
3633 */
3634 public Intent setAction(String action) {
3635 mAction = action;
3636 return this;
3637 }
3638
3639 /**
3640 * Set the data this intent is operating on. This method automatically
3641 * clears any type that was previously set by {@link #setType}.
3642 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003643 * <p><em>Note: scheme and host name matching in the Android framework is
3644 * case-sensitive, unlike the formal RFC. As a result,
3645 * you should always ensure that you write your Uri with these elements
3646 * using lower case letters, and normalize any Uris you receive from
3647 * outside of Android to ensure the scheme and host is lower case.</em></p>
3648 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003649 * @param data The URI of the data this intent is now targeting.
3650 *
3651 * @return Returns the same Intent object, for chaining multiple calls
3652 * into a single statement.
3653 *
3654 * @see #getData
3655 * @see #setType
3656 * @see #setDataAndType
3657 */
3658 public Intent setData(Uri data) {
3659 mData = data;
3660 mType = null;
3661 return this;
3662 }
3663
3664 /**
3665 * Set an explicit MIME data type. This is used to create intents that
3666 * only specify a type and not data, for example to indicate the type of
3667 * data to return. This method automatically clears any data that was
3668 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003669 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003670 * <p><em>Note: MIME type matching in the Android framework is
3671 * case-sensitive, unlike formal RFC MIME types. As a result,
3672 * you should always write your MIME types with lower case letters,
3673 * and any MIME types you receive from outside of Android should be
3674 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675 *
3676 * @param type The MIME type of the data being handled by this intent.
3677 *
3678 * @return Returns the same Intent object, for chaining multiple calls
3679 * into a single statement.
3680 *
3681 * @see #getType
3682 * @see #setData
3683 * @see #setDataAndType
3684 */
3685 public Intent setType(String type) {
3686 mData = null;
3687 mType = type;
3688 return this;
3689 }
3690
3691 /**
3692 * (Usually optional) Set the data for the intent along with an explicit
3693 * MIME data type. This method should very rarely be used -- it allows you
3694 * to override the MIME type that would ordinarily be inferred from the
3695 * data with your own type given here.
3696 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003697 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3698 * Android framework is case-sensitive, unlike the formal RFC definitions.
3699 * As a result, you should always write these elements with lower case letters,
3700 * and normalize any MIME types or Uris you receive from
3701 * outside of Android to ensure these elements are lower case before
3702 * supplying them here.</em></p>
3703 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003704 * @param data The URI of the data this intent is now targeting.
3705 * @param type The MIME type of the data being handled by this intent.
3706 *
3707 * @return Returns the same Intent object, for chaining multiple calls
3708 * into a single statement.
3709 *
3710 * @see #setData
3711 * @see #setType
3712 */
3713 public Intent setDataAndType(Uri data, String type) {
3714 mData = data;
3715 mType = type;
3716 return this;
3717 }
3718
3719 /**
3720 * Add a new category to the intent. Categories provide additional detail
3721 * about the action the intent is perform. When resolving an intent, only
3722 * activities that provide <em>all</em> of the requested categories will be
3723 * used.
3724 *
3725 * @param category The desired category. This can be either one of the
3726 * predefined Intent categories, or a custom category in your own
3727 * namespace.
3728 *
3729 * @return Returns the same Intent object, for chaining multiple calls
3730 * into a single statement.
3731 *
3732 * @see #hasCategory
3733 * @see #removeCategory
3734 */
3735 public Intent addCategory(String category) {
3736 if (mCategories == null) {
3737 mCategories = new HashSet<String>();
3738 }
3739 mCategories.add(category);
3740 return this;
3741 }
3742
3743 /**
3744 * Remove an category from an intent.
3745 *
3746 * @param category The category to remove.
3747 *
3748 * @see #addCategory
3749 */
3750 public void removeCategory(String category) {
3751 if (mCategories != null) {
3752 mCategories.remove(category);
3753 if (mCategories.size() == 0) {
3754 mCategories = null;
3755 }
3756 }
3757 }
3758
3759 /**
3760 * Add extended data to the intent. The name must include a package
3761 * prefix, for example the app com.android.contacts would use names
3762 * like "com.android.contacts.ShowAll".
3763 *
3764 * @param name The name of the extra data, with package prefix.
3765 * @param value The boolean data value.
3766 *
3767 * @return Returns the same Intent object, for chaining multiple calls
3768 * into a single statement.
3769 *
3770 * @see #putExtras
3771 * @see #removeExtra
3772 * @see #getBooleanExtra(String, boolean)
3773 */
3774 public Intent putExtra(String name, boolean value) {
3775 if (mExtras == null) {
3776 mExtras = new Bundle();
3777 }
3778 mExtras.putBoolean(name, value);
3779 return this;
3780 }
3781
3782 /**
3783 * Add extended data to the intent. The name must include a package
3784 * prefix, for example the app com.android.contacts would use names
3785 * like "com.android.contacts.ShowAll".
3786 *
3787 * @param name The name of the extra data, with package prefix.
3788 * @param value The byte data value.
3789 *
3790 * @return Returns the same Intent object, for chaining multiple calls
3791 * into a single statement.
3792 *
3793 * @see #putExtras
3794 * @see #removeExtra
3795 * @see #getByteExtra(String, byte)
3796 */
3797 public Intent putExtra(String name, byte value) {
3798 if (mExtras == null) {
3799 mExtras = new Bundle();
3800 }
3801 mExtras.putByte(name, value);
3802 return this;
3803 }
3804
3805 /**
3806 * Add extended data to the intent. The name must include a package
3807 * prefix, for example the app com.android.contacts would use names
3808 * like "com.android.contacts.ShowAll".
3809 *
3810 * @param name The name of the extra data, with package prefix.
3811 * @param value The char data value.
3812 *
3813 * @return Returns the same Intent object, for chaining multiple calls
3814 * into a single statement.
3815 *
3816 * @see #putExtras
3817 * @see #removeExtra
3818 * @see #getCharExtra(String, char)
3819 */
3820 public Intent putExtra(String name, char value) {
3821 if (mExtras == null) {
3822 mExtras = new Bundle();
3823 }
3824 mExtras.putChar(name, value);
3825 return this;
3826 }
3827
3828 /**
3829 * Add extended data to the intent. The name must include a package
3830 * prefix, for example the app com.android.contacts would use names
3831 * like "com.android.contacts.ShowAll".
3832 *
3833 * @param name The name of the extra data, with package prefix.
3834 * @param value The short data value.
3835 *
3836 * @return Returns the same Intent object, for chaining multiple calls
3837 * into a single statement.
3838 *
3839 * @see #putExtras
3840 * @see #removeExtra
3841 * @see #getShortExtra(String, short)
3842 */
3843 public Intent putExtra(String name, short value) {
3844 if (mExtras == null) {
3845 mExtras = new Bundle();
3846 }
3847 mExtras.putShort(name, value);
3848 return this;
3849 }
3850
3851 /**
3852 * Add extended data to the intent. The name must include a package
3853 * prefix, for example the app com.android.contacts would use names
3854 * like "com.android.contacts.ShowAll".
3855 *
3856 * @param name The name of the extra data, with package prefix.
3857 * @param value The integer data value.
3858 *
3859 * @return Returns the same Intent object, for chaining multiple calls
3860 * into a single statement.
3861 *
3862 * @see #putExtras
3863 * @see #removeExtra
3864 * @see #getIntExtra(String, int)
3865 */
3866 public Intent putExtra(String name, int value) {
3867 if (mExtras == null) {
3868 mExtras = new Bundle();
3869 }
3870 mExtras.putInt(name, value);
3871 return this;
3872 }
3873
3874 /**
3875 * Add extended data to the intent. The name must include a package
3876 * prefix, for example the app com.android.contacts would use names
3877 * like "com.android.contacts.ShowAll".
3878 *
3879 * @param name The name of the extra data, with package prefix.
3880 * @param value The long data value.
3881 *
3882 * @return Returns the same Intent object, for chaining multiple calls
3883 * into a single statement.
3884 *
3885 * @see #putExtras
3886 * @see #removeExtra
3887 * @see #getLongExtra(String, long)
3888 */
3889 public Intent putExtra(String name, long value) {
3890 if (mExtras == null) {
3891 mExtras = new Bundle();
3892 }
3893 mExtras.putLong(name, value);
3894 return this;
3895 }
3896
3897 /**
3898 * Add extended data to the intent. The name must include a package
3899 * prefix, for example the app com.android.contacts would use names
3900 * like "com.android.contacts.ShowAll".
3901 *
3902 * @param name The name of the extra data, with package prefix.
3903 * @param value The float data value.
3904 *
3905 * @return Returns the same Intent object, for chaining multiple calls
3906 * into a single statement.
3907 *
3908 * @see #putExtras
3909 * @see #removeExtra
3910 * @see #getFloatExtra(String, float)
3911 */
3912 public Intent putExtra(String name, float value) {
3913 if (mExtras == null) {
3914 mExtras = new Bundle();
3915 }
3916 mExtras.putFloat(name, value);
3917 return this;
3918 }
3919
3920 /**
3921 * Add extended data to the intent. The name must include a package
3922 * prefix, for example the app com.android.contacts would use names
3923 * like "com.android.contacts.ShowAll".
3924 *
3925 * @param name The name of the extra data, with package prefix.
3926 * @param value The double data value.
3927 *
3928 * @return Returns the same Intent object, for chaining multiple calls
3929 * into a single statement.
3930 *
3931 * @see #putExtras
3932 * @see #removeExtra
3933 * @see #getDoubleExtra(String, double)
3934 */
3935 public Intent putExtra(String name, double value) {
3936 if (mExtras == null) {
3937 mExtras = new Bundle();
3938 }
3939 mExtras.putDouble(name, value);
3940 return this;
3941 }
3942
3943 /**
3944 * Add extended data to the intent. The name must include a package
3945 * prefix, for example the app com.android.contacts would use names
3946 * like "com.android.contacts.ShowAll".
3947 *
3948 * @param name The name of the extra data, with package prefix.
3949 * @param value The String data value.
3950 *
3951 * @return Returns the same Intent object, for chaining multiple calls
3952 * into a single statement.
3953 *
3954 * @see #putExtras
3955 * @see #removeExtra
3956 * @see #getStringExtra(String)
3957 */
3958 public Intent putExtra(String name, String value) {
3959 if (mExtras == null) {
3960 mExtras = new Bundle();
3961 }
3962 mExtras.putString(name, value);
3963 return this;
3964 }
3965
3966 /**
3967 * Add extended data to the intent. The name must include a package
3968 * prefix, for example the app com.android.contacts would use names
3969 * like "com.android.contacts.ShowAll".
3970 *
3971 * @param name The name of the extra data, with package prefix.
3972 * @param value The CharSequence data value.
3973 *
3974 * @return Returns the same Intent object, for chaining multiple calls
3975 * into a single statement.
3976 *
3977 * @see #putExtras
3978 * @see #removeExtra
3979 * @see #getCharSequenceExtra(String)
3980 */
3981 public Intent putExtra(String name, CharSequence value) {
3982 if (mExtras == null) {
3983 mExtras = new Bundle();
3984 }
3985 mExtras.putCharSequence(name, value);
3986 return this;
3987 }
3988
3989 /**
3990 * Add extended data to the intent. The name must include a package
3991 * prefix, for example the app com.android.contacts would use names
3992 * like "com.android.contacts.ShowAll".
3993 *
3994 * @param name The name of the extra data, with package prefix.
3995 * @param value The Parcelable data value.
3996 *
3997 * @return Returns the same Intent object, for chaining multiple calls
3998 * into a single statement.
3999 *
4000 * @see #putExtras
4001 * @see #removeExtra
4002 * @see #getParcelableExtra(String)
4003 */
4004 public Intent putExtra(String name, Parcelable value) {
4005 if (mExtras == null) {
4006 mExtras = new Bundle();
4007 }
4008 mExtras.putParcelable(name, value);
4009 return this;
4010 }
4011
4012 /**
4013 * Add extended data to the intent. The name must include a package
4014 * prefix, for example the app com.android.contacts would use names
4015 * like "com.android.contacts.ShowAll".
4016 *
4017 * @param name The name of the extra data, with package prefix.
4018 * @param value The Parcelable[] data value.
4019 *
4020 * @return Returns the same Intent object, for chaining multiple calls
4021 * into a single statement.
4022 *
4023 * @see #putExtras
4024 * @see #removeExtra
4025 * @see #getParcelableArrayExtra(String)
4026 */
4027 public Intent putExtra(String name, Parcelable[] value) {
4028 if (mExtras == null) {
4029 mExtras = new Bundle();
4030 }
4031 mExtras.putParcelableArray(name, value);
4032 return this;
4033 }
4034
4035 /**
4036 * Add extended data to the intent. The name must include a package
4037 * prefix, for example the app com.android.contacts would use names
4038 * like "com.android.contacts.ShowAll".
4039 *
4040 * @param name The name of the extra data, with package prefix.
4041 * @param value The ArrayList<Parcelable> data value.
4042 *
4043 * @return Returns the same Intent object, for chaining multiple calls
4044 * into a single statement.
4045 *
4046 * @see #putExtras
4047 * @see #removeExtra
4048 * @see #getParcelableArrayListExtra(String)
4049 */
4050 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4051 if (mExtras == null) {
4052 mExtras = new Bundle();
4053 }
4054 mExtras.putParcelableArrayList(name, value);
4055 return this;
4056 }
4057
4058 /**
4059 * Add extended data to the intent. The name must include a package
4060 * prefix, for example the app com.android.contacts would use names
4061 * like "com.android.contacts.ShowAll".
4062 *
4063 * @param name The name of the extra data, with package prefix.
4064 * @param value The ArrayList<Integer> data value.
4065 *
4066 * @return Returns the same Intent object, for chaining multiple calls
4067 * into a single statement.
4068 *
4069 * @see #putExtras
4070 * @see #removeExtra
4071 * @see #getIntegerArrayListExtra(String)
4072 */
4073 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4074 if (mExtras == null) {
4075 mExtras = new Bundle();
4076 }
4077 mExtras.putIntegerArrayList(name, value);
4078 return this;
4079 }
4080
4081 /**
4082 * Add extended data to the intent. The name must include a package
4083 * prefix, for example the app com.android.contacts would use names
4084 * like "com.android.contacts.ShowAll".
4085 *
4086 * @param name The name of the extra data, with package prefix.
4087 * @param value The ArrayList<String> data value.
4088 *
4089 * @return Returns the same Intent object, for chaining multiple calls
4090 * into a single statement.
4091 *
4092 * @see #putExtras
4093 * @see #removeExtra
4094 * @see #getStringArrayListExtra(String)
4095 */
4096 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4097 if (mExtras == null) {
4098 mExtras = new Bundle();
4099 }
4100 mExtras.putStringArrayList(name, value);
4101 return this;
4102 }
4103
4104 /**
4105 * Add extended data to the intent. The name must include a package
4106 * prefix, for example the app com.android.contacts would use names
4107 * like "com.android.contacts.ShowAll".
4108 *
4109 * @param name The name of the extra data, with package prefix.
4110 * @param value The Serializable data value.
4111 *
4112 * @return Returns the same Intent object, for chaining multiple calls
4113 * into a single statement.
4114 *
4115 * @see #putExtras
4116 * @see #removeExtra
4117 * @see #getSerializableExtra(String)
4118 */
4119 public Intent putExtra(String name, Serializable value) {
4120 if (mExtras == null) {
4121 mExtras = new Bundle();
4122 }
4123 mExtras.putSerializable(name, value);
4124 return this;
4125 }
4126
4127 /**
4128 * Add extended data to the intent. The name must include a package
4129 * prefix, for example the app com.android.contacts would use names
4130 * like "com.android.contacts.ShowAll".
4131 *
4132 * @param name The name of the extra data, with package prefix.
4133 * @param value The boolean array data value.
4134 *
4135 * @return Returns the same Intent object, for chaining multiple calls
4136 * into a single statement.
4137 *
4138 * @see #putExtras
4139 * @see #removeExtra
4140 * @see #getBooleanArrayExtra(String)
4141 */
4142 public Intent putExtra(String name, boolean[] value) {
4143 if (mExtras == null) {
4144 mExtras = new Bundle();
4145 }
4146 mExtras.putBooleanArray(name, value);
4147 return this;
4148 }
4149
4150 /**
4151 * Add extended data to the intent. The name must include a package
4152 * prefix, for example the app com.android.contacts would use names
4153 * like "com.android.contacts.ShowAll".
4154 *
4155 * @param name The name of the extra data, with package prefix.
4156 * @param value The byte array data value.
4157 *
4158 * @return Returns the same Intent object, for chaining multiple calls
4159 * into a single statement.
4160 *
4161 * @see #putExtras
4162 * @see #removeExtra
4163 * @see #getByteArrayExtra(String)
4164 */
4165 public Intent putExtra(String name, byte[] value) {
4166 if (mExtras == null) {
4167 mExtras = new Bundle();
4168 }
4169 mExtras.putByteArray(name, value);
4170 return this;
4171 }
4172
4173 /**
4174 * Add extended data to the intent. The name must include a package
4175 * prefix, for example the app com.android.contacts would use names
4176 * like "com.android.contacts.ShowAll".
4177 *
4178 * @param name The name of the extra data, with package prefix.
4179 * @param value The short array data value.
4180 *
4181 * @return Returns the same Intent object, for chaining multiple calls
4182 * into a single statement.
4183 *
4184 * @see #putExtras
4185 * @see #removeExtra
4186 * @see #getShortArrayExtra(String)
4187 */
4188 public Intent putExtra(String name, short[] value) {
4189 if (mExtras == null) {
4190 mExtras = new Bundle();
4191 }
4192 mExtras.putShortArray(name, value);
4193 return this;
4194 }
4195
4196 /**
4197 * Add extended data to the intent. The name must include a package
4198 * prefix, for example the app com.android.contacts would use names
4199 * like "com.android.contacts.ShowAll".
4200 *
4201 * @param name The name of the extra data, with package prefix.
4202 * @param value The char array data value.
4203 *
4204 * @return Returns the same Intent object, for chaining multiple calls
4205 * into a single statement.
4206 *
4207 * @see #putExtras
4208 * @see #removeExtra
4209 * @see #getCharArrayExtra(String)
4210 */
4211 public Intent putExtra(String name, char[] value) {
4212 if (mExtras == null) {
4213 mExtras = new Bundle();
4214 }
4215 mExtras.putCharArray(name, value);
4216 return this;
4217 }
4218
4219 /**
4220 * Add extended data to the intent. The name must include a package
4221 * prefix, for example the app com.android.contacts would use names
4222 * like "com.android.contacts.ShowAll".
4223 *
4224 * @param name The name of the extra data, with package prefix.
4225 * @param value The int array data value.
4226 *
4227 * @return Returns the same Intent object, for chaining multiple calls
4228 * into a single statement.
4229 *
4230 * @see #putExtras
4231 * @see #removeExtra
4232 * @see #getIntArrayExtra(String)
4233 */
4234 public Intent putExtra(String name, int[] value) {
4235 if (mExtras == null) {
4236 mExtras = new Bundle();
4237 }
4238 mExtras.putIntArray(name, value);
4239 return this;
4240 }
4241
4242 /**
4243 * Add extended data to the intent. The name must include a package
4244 * prefix, for example the app com.android.contacts would use names
4245 * like "com.android.contacts.ShowAll".
4246 *
4247 * @param name The name of the extra data, with package prefix.
4248 * @param value The byte array data value.
4249 *
4250 * @return Returns the same Intent object, for chaining multiple calls
4251 * into a single statement.
4252 *
4253 * @see #putExtras
4254 * @see #removeExtra
4255 * @see #getLongArrayExtra(String)
4256 */
4257 public Intent putExtra(String name, long[] value) {
4258 if (mExtras == null) {
4259 mExtras = new Bundle();
4260 }
4261 mExtras.putLongArray(name, value);
4262 return this;
4263 }
4264
4265 /**
4266 * Add extended data to the intent. The name must include a package
4267 * prefix, for example the app com.android.contacts would use names
4268 * like "com.android.contacts.ShowAll".
4269 *
4270 * @param name The name of the extra data, with package prefix.
4271 * @param value The float array data value.
4272 *
4273 * @return Returns the same Intent object, for chaining multiple calls
4274 * into a single statement.
4275 *
4276 * @see #putExtras
4277 * @see #removeExtra
4278 * @see #getFloatArrayExtra(String)
4279 */
4280 public Intent putExtra(String name, float[] value) {
4281 if (mExtras == null) {
4282 mExtras = new Bundle();
4283 }
4284 mExtras.putFloatArray(name, value);
4285 return this;
4286 }
4287
4288 /**
4289 * Add extended data to the intent. The name must include a package
4290 * prefix, for example the app com.android.contacts would use names
4291 * like "com.android.contacts.ShowAll".
4292 *
4293 * @param name The name of the extra data, with package prefix.
4294 * @param value The double array data value.
4295 *
4296 * @return Returns the same Intent object, for chaining multiple calls
4297 * into a single statement.
4298 *
4299 * @see #putExtras
4300 * @see #removeExtra
4301 * @see #getDoubleArrayExtra(String)
4302 */
4303 public Intent putExtra(String name, double[] value) {
4304 if (mExtras == null) {
4305 mExtras = new Bundle();
4306 }
4307 mExtras.putDoubleArray(name, value);
4308 return this;
4309 }
4310
4311 /**
4312 * Add extended data to the intent. The name must include a package
4313 * prefix, for example the app com.android.contacts would use names
4314 * like "com.android.contacts.ShowAll".
4315 *
4316 * @param name The name of the extra data, with package prefix.
4317 * @param value The String array data value.
4318 *
4319 * @return Returns the same Intent object, for chaining multiple calls
4320 * into a single statement.
4321 *
4322 * @see #putExtras
4323 * @see #removeExtra
4324 * @see #getStringArrayExtra(String)
4325 */
4326 public Intent putExtra(String name, String[] value) {
4327 if (mExtras == null) {
4328 mExtras = new Bundle();
4329 }
4330 mExtras.putStringArray(name, value);
4331 return this;
4332 }
4333
4334 /**
4335 * Add extended data to the intent. The name must include a package
4336 * prefix, for example the app com.android.contacts would use names
4337 * like "com.android.contacts.ShowAll".
4338 *
4339 * @param name The name of the extra data, with package prefix.
4340 * @param value The Bundle data value.
4341 *
4342 * @return Returns the same Intent object, for chaining multiple calls
4343 * into a single statement.
4344 *
4345 * @see #putExtras
4346 * @see #removeExtra
4347 * @see #getBundleExtra(String)
4348 */
4349 public Intent putExtra(String name, Bundle value) {
4350 if (mExtras == null) {
4351 mExtras = new Bundle();
4352 }
4353 mExtras.putBundle(name, value);
4354 return this;
4355 }
4356
4357 /**
4358 * Add extended data to the intent. The name must include a package
4359 * prefix, for example the app com.android.contacts would use names
4360 * like "com.android.contacts.ShowAll".
4361 *
4362 * @param name The name of the extra data, with package prefix.
4363 * @param value The IBinder data value.
4364 *
4365 * @return Returns the same Intent object, for chaining multiple calls
4366 * into a single statement.
4367 *
4368 * @see #putExtras
4369 * @see #removeExtra
4370 * @see #getIBinderExtra(String)
4371 *
4372 * @deprecated
4373 * @hide
4374 */
4375 @Deprecated
4376 public Intent putExtra(String name, IBinder value) {
4377 if (mExtras == null) {
4378 mExtras = new Bundle();
4379 }
4380 mExtras.putIBinder(name, value);
4381 return this;
4382 }
4383
4384 /**
4385 * Copy all extras in 'src' in to this intent.
4386 *
4387 * @param src Contains the extras to copy.
4388 *
4389 * @see #putExtra
4390 */
4391 public Intent putExtras(Intent src) {
4392 if (src.mExtras != null) {
4393 if (mExtras == null) {
4394 mExtras = new Bundle(src.mExtras);
4395 } else {
4396 mExtras.putAll(src.mExtras);
4397 }
4398 }
4399 return this;
4400 }
4401
4402 /**
4403 * Add a set of extended data to the intent. The keys must include a package
4404 * prefix, for example the app com.android.contacts would use names
4405 * like "com.android.contacts.ShowAll".
4406 *
4407 * @param extras The Bundle of extras to add to this intent.
4408 *
4409 * @see #putExtra
4410 * @see #removeExtra
4411 */
4412 public Intent putExtras(Bundle extras) {
4413 if (mExtras == null) {
4414 mExtras = new Bundle();
4415 }
4416 mExtras.putAll(extras);
4417 return this;
4418 }
4419
4420 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004421 * Completely replace the extras in the Intent with the extras in the
4422 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004423 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004424 * @param src The exact extras contained in this Intent are copied
4425 * into the target intent, replacing any that were previously there.
4426 */
4427 public Intent replaceExtras(Intent src) {
4428 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4429 return this;
4430 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004431
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004432 /**
4433 * Completely replace the extras in the Intent with the given Bundle of
4434 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004435 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004436 * @param extras The new set of extras in the Intent, or null to erase
4437 * all extras.
4438 */
4439 public Intent replaceExtras(Bundle extras) {
4440 mExtras = extras != null ? new Bundle(extras) : null;
4441 return this;
4442 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004443
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004444 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004445 * Remove extended data from the intent.
4446 *
4447 * @see #putExtra
4448 */
4449 public void removeExtra(String name) {
4450 if (mExtras != null) {
4451 mExtras.remove(name);
4452 if (mExtras.size() == 0) {
4453 mExtras = null;
4454 }
4455 }
4456 }
4457
4458 /**
4459 * Set special flags controlling how this intent is handled. Most values
4460 * here depend on the type of component being executed by the Intent,
4461 * specifically the FLAG_ACTIVITY_* flags are all for use with
4462 * {@link Context#startActivity Context.startActivity()} and the
4463 * FLAG_RECEIVER_* flags are all for use with
4464 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4465 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004466 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4467 * 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 -07004468 * the behavior of your application.
4469 *
4470 * @param flags The desired flags.
4471 *
4472 * @return Returns the same Intent object, for chaining multiple calls
4473 * into a single statement.
4474 *
4475 * @see #getFlags
4476 * @see #addFlags
4477 *
4478 * @see #FLAG_GRANT_READ_URI_PERMISSION
4479 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4480 * @see #FLAG_DEBUG_LOG_RESOLUTION
4481 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004482 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004483 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004484 * @see #FLAG_ACTIVITY_CLEAR_TOP
4485 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4486 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004487 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004488 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4489 * @see #FLAG_ACTIVITY_NEW_TASK
4490 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004491 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004492 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4493 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004494 * @see #FLAG_ACTIVITY_SINGLE_TOP
4495 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4496 */
4497 public Intent setFlags(int flags) {
4498 mFlags = flags;
4499 return this;
4500 }
4501
4502 /**
4503 * Add additional flags to the intent (or with existing flags
4504 * value).
4505 *
4506 * @param flags The new flags to set.
4507 *
4508 * @return Returns the same Intent object, for chaining multiple calls
4509 * into a single statement.
4510 *
4511 * @see #setFlags
4512 */
4513 public Intent addFlags(int flags) {
4514 mFlags |= flags;
4515 return this;
4516 }
4517
4518 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004519 * (Usually optional) Set an explicit application package name that limits
4520 * the components this Intent will resolve to. If left to the default
4521 * value of null, all components in all applications will considered.
4522 * If non-null, the Intent can only match the components in the given
4523 * application package.
4524 *
4525 * @param packageName The name of the application package to handle the
4526 * intent, or null to allow any application package.
4527 *
4528 * @return Returns the same Intent object, for chaining multiple calls
4529 * into a single statement.
4530 *
4531 * @see #getPackage
4532 * @see #resolveActivity
4533 */
4534 public Intent setPackage(String packageName) {
4535 mPackage = packageName;
4536 return this;
4537 }
4538
4539 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004540 * (Usually optional) Explicitly set the component to handle the intent.
4541 * If left with the default value of null, the system will determine the
4542 * appropriate class to use based on the other fields (action, data,
4543 * type, categories) in the Intent. If this class is defined, the
4544 * specified class will always be used regardless of the other fields. You
4545 * should only set this value when you know you absolutely want a specific
4546 * class to be used; otherwise it is better to let the system find the
4547 * appropriate class so that you will respect the installed applications
4548 * and user preferences.
4549 *
4550 * @param component The name of the application component to handle the
4551 * intent, or null to let the system find one for you.
4552 *
4553 * @return Returns the same Intent object, for chaining multiple calls
4554 * into a single statement.
4555 *
4556 * @see #setClass
4557 * @see #setClassName(Context, String)
4558 * @see #setClassName(String, String)
4559 * @see #getComponent
4560 * @see #resolveActivity
4561 */
4562 public Intent setComponent(ComponentName component) {
4563 mComponent = component;
4564 return this;
4565 }
4566
4567 /**
4568 * Convenience for calling {@link #setComponent} with an
4569 * explicit class name.
4570 *
4571 * @param packageContext A Context of the application package implementing
4572 * this class.
4573 * @param className The name of a class inside of the application package
4574 * that will be used as the component for this Intent.
4575 *
4576 * @return Returns the same Intent object, for chaining multiple calls
4577 * into a single statement.
4578 *
4579 * @see #setComponent
4580 * @see #setClass
4581 */
4582 public Intent setClassName(Context packageContext, String className) {
4583 mComponent = new ComponentName(packageContext, className);
4584 return this;
4585 }
4586
4587 /**
4588 * Convenience for calling {@link #setComponent} with an
4589 * explicit application package name and class name.
4590 *
4591 * @param packageName The name of the package implementing the desired
4592 * component.
4593 * @param className The name of a class inside of the application package
4594 * that will be used as the component for this Intent.
4595 *
4596 * @return Returns the same Intent object, for chaining multiple calls
4597 * into a single statement.
4598 *
4599 * @see #setComponent
4600 * @see #setClass
4601 */
4602 public Intent setClassName(String packageName, String className) {
4603 mComponent = new ComponentName(packageName, className);
4604 return this;
4605 }
4606
4607 /**
4608 * Convenience for calling {@link #setComponent(ComponentName)} with the
4609 * name returned by a {@link Class} object.
4610 *
4611 * @param packageContext A Context of the application package implementing
4612 * this class.
4613 * @param cls The class name to set, equivalent to
4614 * <code>setClassName(context, cls.getName())</code>.
4615 *
4616 * @return Returns the same Intent object, for chaining multiple calls
4617 * into a single statement.
4618 *
4619 * @see #setComponent
4620 */
4621 public Intent setClass(Context packageContext, Class<?> cls) {
4622 mComponent = new ComponentName(packageContext, cls);
4623 return this;
4624 }
4625
4626 /**
4627 * Use with {@link #fillIn} to allow the current action value to be
4628 * overwritten, even if it is already set.
4629 */
4630 public static final int FILL_IN_ACTION = 1<<0;
4631
4632 /**
4633 * Use with {@link #fillIn} to allow the current data or type value
4634 * overwritten, even if it is already set.
4635 */
4636 public static final int FILL_IN_DATA = 1<<1;
4637
4638 /**
4639 * Use with {@link #fillIn} to allow the current categories to be
4640 * overwritten, even if they are already set.
4641 */
4642 public static final int FILL_IN_CATEGORIES = 1<<2;
4643
4644 /**
4645 * Use with {@link #fillIn} to allow the current component value to be
4646 * overwritten, even if it is already set.
4647 */
4648 public static final int FILL_IN_COMPONENT = 1<<3;
4649
4650 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004651 * Use with {@link #fillIn} to allow the current package value to be
4652 * overwritten, even if it is already set.
4653 */
4654 public static final int FILL_IN_PACKAGE = 1<<4;
4655
4656 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 * Copy the contents of <var>other</var> in to this object, but only
4658 * where fields are not defined by this object. For purposes of a field
4659 * being defined, the following pieces of data in the Intent are
4660 * considered to be separate fields:
4661 *
4662 * <ul>
4663 * <li> action, as set by {@link #setAction}.
4664 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4665 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4666 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004667 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004668 * <li> component, as set by {@link #setComponent(ComponentName)} or
4669 * related methods.
4670 * <li> each top-level name in the associated extras.
4671 * </ul>
4672 *
4673 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004674 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4675 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004676 * corresponding field will not be replaced if it is already set.
4677 *
Brett Chabot3e391752009-07-21 16:07:23 -07004678 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4679 * specified.
4680 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004681 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4682 * and Intent B with {action="gotit", data-type="some/thing",
4683 * categories="one","two"}.
4684 *
4685 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4686 * containing: {action="gotit", data-type="some/thing",
4687 * categories="bar"}.
4688 *
4689 * @param other Another Intent whose values are to be used to fill in
4690 * the current one.
4691 * @param flags Options to control which fields can be filled in.
4692 *
4693 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004694 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4695 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004696 */
4697 public int fillIn(Intent other, int flags) {
4698 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004699 if (other.mAction != null
4700 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004701 mAction = other.mAction;
4702 changes |= FILL_IN_ACTION;
4703 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004704 if ((other.mData != null || other.mType != null)
4705 && ((mData == null && mType == null)
4706 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004707 mData = other.mData;
4708 mType = other.mType;
4709 changes |= FILL_IN_DATA;
4710 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004711 if (other.mCategories != null
4712 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004713 if (other.mCategories != null) {
4714 mCategories = new HashSet<String>(other.mCategories);
4715 }
4716 changes |= FILL_IN_CATEGORIES;
4717 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004718 if (other.mPackage != null
4719 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4720 mPackage = other.mPackage;
4721 changes |= FILL_IN_PACKAGE;
4722 }
4723 // Component is special: it can -only- be set if explicitly allowed,
4724 // since otherwise the sender could force the intent somewhere the
4725 // originator didn't intend.
4726 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004727 mComponent = other.mComponent;
4728 changes |= FILL_IN_COMPONENT;
4729 }
4730 mFlags |= other.mFlags;
4731 if (mExtras == null) {
4732 if (other.mExtras != null) {
4733 mExtras = new Bundle(other.mExtras);
4734 }
4735 } else if (other.mExtras != null) {
4736 try {
4737 Bundle newb = new Bundle(other.mExtras);
4738 newb.putAll(mExtras);
4739 mExtras = newb;
4740 } catch (RuntimeException e) {
4741 // Modifying the extras can cause us to unparcel the contents
4742 // of the bundle, and if we do this in the system process that
4743 // may fail. We really should handle this (i.e., the Bundle
4744 // impl shouldn't be on top of a plain map), but for now just
4745 // ignore it and keep the original contents. :(
4746 Log.w("Intent", "Failure filling in extras", e);
4747 }
4748 }
4749 return changes;
4750 }
4751
4752 /**
4753 * Wrapper class holding an Intent and implementing comparisons on it for
4754 * the purpose of filtering. The class implements its
4755 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4756 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4757 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4758 * on the wrapped Intent.
4759 */
4760 public static final class FilterComparison {
4761 private final Intent mIntent;
4762 private final int mHashCode;
4763
4764 public FilterComparison(Intent intent) {
4765 mIntent = intent;
4766 mHashCode = intent.filterHashCode();
4767 }
4768
4769 /**
4770 * Return the Intent that this FilterComparison represents.
4771 * @return Returns the Intent held by the FilterComparison. Do
4772 * not modify!
4773 */
4774 public Intent getIntent() {
4775 return mIntent;
4776 }
4777
4778 @Override
4779 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004780 if (obj instanceof FilterComparison) {
4781 Intent other = ((FilterComparison)obj).mIntent;
4782 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004783 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004784 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004785 }
4786
4787 @Override
4788 public int hashCode() {
4789 return mHashCode;
4790 }
4791 }
4792
4793 /**
4794 * Determine if two intents are the same for the purposes of intent
4795 * resolution (filtering). That is, if their action, data, type,
4796 * class, and categories are the same. This does <em>not</em> compare
4797 * any extra data included in the intents.
4798 *
4799 * @param other The other Intent to compare against.
4800 *
4801 * @return Returns true if action, data, type, class, and categories
4802 * are the same.
4803 */
4804 public boolean filterEquals(Intent other) {
4805 if (other == null) {
4806 return false;
4807 }
4808 if (mAction != other.mAction) {
4809 if (mAction != null) {
4810 if (!mAction.equals(other.mAction)) {
4811 return false;
4812 }
4813 } else {
4814 if (!other.mAction.equals(mAction)) {
4815 return false;
4816 }
4817 }
4818 }
4819 if (mData != other.mData) {
4820 if (mData != null) {
4821 if (!mData.equals(other.mData)) {
4822 return false;
4823 }
4824 } else {
4825 if (!other.mData.equals(mData)) {
4826 return false;
4827 }
4828 }
4829 }
4830 if (mType != other.mType) {
4831 if (mType != null) {
4832 if (!mType.equals(other.mType)) {
4833 return false;
4834 }
4835 } else {
4836 if (!other.mType.equals(mType)) {
4837 return false;
4838 }
4839 }
4840 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004841 if (mPackage != other.mPackage) {
4842 if (mPackage != null) {
4843 if (!mPackage.equals(other.mPackage)) {
4844 return false;
4845 }
4846 } else {
4847 if (!other.mPackage.equals(mPackage)) {
4848 return false;
4849 }
4850 }
4851 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004852 if (mComponent != other.mComponent) {
4853 if (mComponent != null) {
4854 if (!mComponent.equals(other.mComponent)) {
4855 return false;
4856 }
4857 } else {
4858 if (!other.mComponent.equals(mComponent)) {
4859 return false;
4860 }
4861 }
4862 }
4863 if (mCategories != other.mCategories) {
4864 if (mCategories != null) {
4865 if (!mCategories.equals(other.mCategories)) {
4866 return false;
4867 }
4868 } else {
4869 if (!other.mCategories.equals(mCategories)) {
4870 return false;
4871 }
4872 }
4873 }
4874
4875 return true;
4876 }
4877
4878 /**
4879 * Generate hash code that matches semantics of filterEquals().
4880 *
4881 * @return Returns the hash value of the action, data, type, class, and
4882 * categories.
4883 *
4884 * @see #filterEquals
4885 */
4886 public int filterHashCode() {
4887 int code = 0;
4888 if (mAction != null) {
4889 code += mAction.hashCode();
4890 }
4891 if (mData != null) {
4892 code += mData.hashCode();
4893 }
4894 if (mType != null) {
4895 code += mType.hashCode();
4896 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004897 if (mPackage != null) {
4898 code += mPackage.hashCode();
4899 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004900 if (mComponent != null) {
4901 code += mComponent.hashCode();
4902 }
4903 if (mCategories != null) {
4904 code += mCategories.hashCode();
4905 }
4906 return code;
4907 }
4908
4909 @Override
4910 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004911 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004912
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004913 b.append("Intent { ");
4914 toShortString(b, true, true);
4915 b.append(" }");
4916
4917 return b.toString();
4918 }
4919
4920 /** @hide */
4921 public String toShortString(boolean comp, boolean extras) {
4922 StringBuilder b = new StringBuilder(128);
4923 toShortString(b, comp, extras);
4924 return b.toString();
4925 }
Romain Guy4969af72009-06-17 10:53:19 -07004926
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004927 /** @hide */
4928 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4929 boolean first = true;
4930 if (mAction != null) {
4931 b.append("act=").append(mAction);
4932 first = false;
4933 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004934 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004935 if (!first) {
4936 b.append(' ');
4937 }
4938 first = false;
4939 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004940 Iterator<String> i = mCategories.iterator();
4941 boolean didone = false;
4942 while (i.hasNext()) {
4943 if (didone) b.append(",");
4944 didone = true;
4945 b.append(i.next());
4946 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004947 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004948 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004949 if (mData != null) {
4950 if (!first) {
4951 b.append(' ');
4952 }
4953 first = false;
4954 b.append("dat=").append(mData);
4955 }
4956 if (mType != null) {
4957 if (!first) {
4958 b.append(' ');
4959 }
4960 first = false;
4961 b.append("typ=").append(mType);
4962 }
4963 if (mFlags != 0) {
4964 if (!first) {
4965 b.append(' ');
4966 }
4967 first = false;
4968 b.append("flg=0x").append(Integer.toHexString(mFlags));
4969 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004970 if (mPackage != null) {
4971 if (!first) {
4972 b.append(' ');
4973 }
4974 first = false;
4975 b.append("pkg=").append(mPackage);
4976 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004977 if (comp && mComponent != null) {
4978 if (!first) {
4979 b.append(' ');
4980 }
4981 first = false;
4982 b.append("cmp=").append(mComponent.flattenToShortString());
4983 }
4984 if (extras && mExtras != null) {
4985 if (!first) {
4986 b.append(' ');
4987 }
4988 first = false;
4989 b.append("(has extras)");
4990 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004991 }
4992
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004993 /**
4994 * Call {@link #toUri} with 0 flags.
4995 * @deprecated Use {@link #toUri} instead.
4996 */
4997 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004998 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004999 return toUri(0);
5000 }
5001
5002 /**
5003 * Convert this Intent into a String holding a URI representation of it.
5004 * The returned URI string has been properly URI encoded, so it can be
5005 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5006 * Intent's data as the base URI, with an additional fragment describing
5007 * the action, categories, type, flags, package, component, and extras.
5008 *
5009 * <p>You can convert the returned string back to an Intent with
5010 * {@link #getIntent}.
5011 *
5012 * @param flags Additional operating flags. Either 0 or
5013 * {@link #URI_INTENT_SCHEME}.
5014 *
5015 * @return Returns a URI encoding URI string describing the entire contents
5016 * of the Intent.
5017 */
5018 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005019 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005020 String scheme = null;
5021 if (mData != null) {
5022 String data = mData.toString();
5023 if ((flags&URI_INTENT_SCHEME) != 0) {
5024 final int N = data.length();
5025 for (int i=0; i<N; i++) {
5026 char c = data.charAt(i);
5027 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5028 || c == '.' || c == '-') {
5029 continue;
5030 }
5031 if (c == ':' && i > 0) {
5032 // Valid scheme.
5033 scheme = data.substring(0, i);
5034 uri.append("intent:");
5035 data = data.substring(i+1);
5036 break;
5037 }
5038
5039 // No scheme.
5040 break;
5041 }
5042 }
5043 uri.append(data);
5044
5045 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5046 uri.append("intent:");
5047 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048
5049 uri.append("#Intent;");
5050
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005051 if (scheme != null) {
5052 uri.append("scheme=").append(scheme).append(';');
5053 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005055 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005056 }
5057 if (mCategories != null) {
5058 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005059 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005060 }
5061 }
5062 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005063 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 }
5065 if (mFlags != 0) {
5066 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5067 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005068 if (mPackage != null) {
5069 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5070 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005071 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005072 uri.append("component=").append(Uri.encode(
5073 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 }
5075 if (mExtras != null) {
5076 for (String key : mExtras.keySet()) {
5077 final Object value = mExtras.get(key);
5078 char entryType =
5079 value instanceof String ? 'S' :
5080 value instanceof Boolean ? 'B' :
5081 value instanceof Byte ? 'b' :
5082 value instanceof Character ? 'c' :
5083 value instanceof Double ? 'd' :
5084 value instanceof Float ? 'f' :
5085 value instanceof Integer ? 'i' :
5086 value instanceof Long ? 'l' :
5087 value instanceof Short ? 's' :
5088 '\0';
5089
5090 if (entryType != '\0') {
5091 uri.append(entryType);
5092 uri.append('.');
5093 uri.append(Uri.encode(key));
5094 uri.append('=');
5095 uri.append(Uri.encode(value.toString()));
5096 uri.append(';');
5097 }
5098 }
5099 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005100
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005101 uri.append("end");
5102
5103 return uri.toString();
5104 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005105
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 public int describeContents() {
5107 return (mExtras != null) ? mExtras.describeContents() : 0;
5108 }
5109
5110 public void writeToParcel(Parcel out, int flags) {
5111 out.writeString(mAction);
5112 Uri.writeToParcel(out, mData);
5113 out.writeString(mType);
5114 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005115 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 ComponentName.writeToParcel(mComponent, out);
5117
5118 if (mCategories != null) {
5119 out.writeInt(mCategories.size());
5120 for (String category : mCategories) {
5121 out.writeString(category);
5122 }
5123 } else {
5124 out.writeInt(0);
5125 }
5126
5127 out.writeBundle(mExtras);
5128 }
5129
5130 public static final Parcelable.Creator<Intent> CREATOR
5131 = new Parcelable.Creator<Intent>() {
5132 public Intent createFromParcel(Parcel in) {
5133 return new Intent(in);
5134 }
5135 public Intent[] newArray(int size) {
5136 return new Intent[size];
5137 }
5138 };
5139
Dianne Hackborneb034652009-09-07 00:49:58 -07005140 /** @hide */
5141 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005142 readFromParcel(in);
5143 }
5144
5145 public void readFromParcel(Parcel in) {
5146 mAction = in.readString();
5147 mData = Uri.CREATOR.createFromParcel(in);
5148 mType = in.readString();
5149 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005150 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005151 mComponent = ComponentName.readFromParcel(in);
5152
5153 int N = in.readInt();
5154 if (N > 0) {
5155 mCategories = new HashSet<String>();
5156 int i;
5157 for (i=0; i<N; i++) {
5158 mCategories.add(in.readString());
5159 }
5160 } else {
5161 mCategories = null;
5162 }
5163
5164 mExtras = in.readBundle();
5165 }
5166
5167 /**
5168 * Parses the "intent" element (and its children) from XML and instantiates
5169 * an Intent object. The given XML parser should be located at the tag
5170 * where parsing should start (often named "intent"), from which the
5171 * basic action, data, type, and package and class name will be
5172 * retrieved. The function will then parse in to any child elements,
5173 * looking for <category android:name="xxx"> tags to add categories and
5174 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5175 * to the intent.
5176 *
5177 * @param resources The Resources to use when inflating resources.
5178 * @param parser The XML parser pointing at an "intent" tag.
5179 * @param attrs The AttributeSet interface for retrieving extended
5180 * attribute data at the current <var>parser</var> location.
5181 * @return An Intent object matching the XML data.
5182 * @throws XmlPullParserException If there was an XML parsing error.
5183 * @throws IOException If there was an I/O error.
5184 */
5185 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5186 throws XmlPullParserException, IOException {
5187 Intent intent = new Intent();
5188
5189 TypedArray sa = resources.obtainAttributes(attrs,
5190 com.android.internal.R.styleable.Intent);
5191
5192 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5193
5194 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5195 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5196 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5197
5198 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5199 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5200 if (packageName != null && className != null) {
5201 intent.setComponent(new ComponentName(packageName, className));
5202 }
5203
5204 sa.recycle();
5205
5206 int outerDepth = parser.getDepth();
5207 int type;
5208 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5209 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5210 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5211 continue;
5212 }
5213
5214 String nodeName = parser.getName();
5215 if (nodeName.equals("category")) {
5216 sa = resources.obtainAttributes(attrs,
5217 com.android.internal.R.styleable.IntentCategory);
5218 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5219 sa.recycle();
5220
5221 if (cat != null) {
5222 intent.addCategory(cat);
5223 }
5224 XmlUtils.skipCurrentTag(parser);
5225
5226 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005227 if (intent.mExtras == null) {
5228 intent.mExtras = new Bundle();
5229 }
5230 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5231 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005232
5233 } else {
5234 XmlUtils.skipCurrentTag(parser);
5235 }
5236 }
5237
5238 return intent;
5239 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005240}