blob: 3d637e9e5dd8d37657021ec829360385bbd7d3d6 [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;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
46import java.util.Set;
47
48/**
49 * An intent is an abstract description of an operation to be performed. It
50 * can be used with {@link Context#startActivity(Intent) startActivity} to
51 * launch an {@link android.app.Activity},
52 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
53 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
54 * and {@link android.content.Context#startService} or
55 * {@link android.content.Context#bindService} to communicate with a
56 * background {@link android.app.Service}.
57 *
58 * <p>An Intent provides a facility for performing late runtime binding between
59 * the code in different applications. Its most significant use is in the
60 * launching of activities, where it can be thought of as the glue between
61 * activities. It is
62 * basically a passive data structure holding an abstract description of an
63 * action to be performed. The primary pieces of information in an intent
64 * are:</p>
65 *
66 * <ul>
67 * <li> <p><b>action</b> -- The general action to be performed, such as
68 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
69 * etc.</p>
70 * </li>
71 * <li> <p><b>data</b> -- The data to operate on, such as a person record
72 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
73 * </li>
74 * </ul>
75 *
76 *
77 * <p>Some examples of action/data pairs are:</p>
78 *
79 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070080 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070081 * information about the person whose identifier is "1".</p>
82 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070083 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070084 * the phone dialer with the person filled in.</p>
85 * </li>
86 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
87 * the phone dialer with the given number filled in. Note how the
88 * VIEW action does what what is considered the most reasonable thing for
89 * a particular URI.</p>
90 * </li>
91 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
92 * the phone dialer with the given number filled in.</p>
93 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070094 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 * information about the person whose identifier is "1".</p>
96 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070097 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 * a list of people, which the user can browse through. This example is a
99 * typical top-level entry into the Contacts application, showing you the
100 * list of people. Selecting a particular person to view would result in a
101 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
102 * being used to start an activity to display that person.</p>
103 * </li>
104 * </ul>
105 *
106 * <p>In addition to these primary attributes, there are a number of secondary
107 * attributes that you can also include with an intent:</p>
108 *
109 * <ul>
110 * <li> <p><b>category</b> -- Gives additional information about the action
111 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
112 * appear in the Launcher as a top-level application, while
113 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
114 * of alternative actions the user can perform on a piece of data.</p>
115 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
116 * intent data. Normally the type is inferred from the data itself.
117 * By setting this attribute, you disable that evaluation and force
118 * an explicit type.</p>
119 * <li> <p><b>component</b> -- Specifies an explicit name of a component
120 * class to use for the intent. Normally this is determined by looking
121 * at the other information in the intent (the action, data/type, and
122 * categories) and matching that with a component that can handle it.
123 * If this attribute is set then none of the evaluation is performed,
124 * and this component is used exactly as is. By specifying this attribute,
125 * all of the other Intent attributes become optional.</p>
126 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
127 * This can be used to provide extended information to the component.
128 * For example, if we have a action to send an e-mail message, we could
129 * also include extra pieces of data here to supply a subject, body,
130 * etc.</p>
131 * </ul>
132 *
133 * <p>Here are some examples of other operations you can specify as intents
134 * using these additional parameters:</p>
135 *
136 * <ul>
137 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
138 * Launch the home screen.</p>
139 * </li>
140 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
141 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
142 * vnd.android.cursor.item/phone}</i></b>
143 * -- Display the list of people's phone numbers, allowing the user to
144 * browse through them and pick one and return it to the parent activity.</p>
145 * </li>
146 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
147 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
148 * -- Display all pickers for data that can be opened with
149 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
150 * allowing the user to pick one of them and then some data inside of it
151 * and returning the resulting URI to the caller. This can be used,
152 * for example, in an e-mail application to allow the user to pick some
153 * data to include as an attachment.</p>
154 * </li>
155 * </ul>
156 *
157 * <p>There are a variety of standard Intent action and category constants
158 * defined in the Intent class, but applications can also define their own.
159 * These strings use java style scoping, to ensure they are unique -- for
160 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700161 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700162 *
163 * <p>Put together, the set of actions, data types, categories, and extra data
164 * defines a language for the system allowing for the expression of phrases
165 * such as "call john smith's cell". As applications are added to the system,
166 * they can extend this language by adding new actions, types, and categories, or
167 * they can modify the behavior of existing phrases by supplying their own
168 * activities that handle them.</p>
169 *
170 * <a name="IntentResolution"></a>
171 * <h3>Intent Resolution</h3>
172 *
173 * <p>There are two primary forms of intents you will use.
174 *
175 * <ul>
176 * <li> <p><b>Explicit Intents</b> have specified a component (via
177 * {@link #setComponent} or {@link #setClass}), which provides the exact
178 * class to be run. Often these will not include any other information,
179 * simply being a way for an application to launch various internal
180 * activities it has as the user interacts with the application.
181 *
182 * <li> <p><b>Implicit Intents</b> have not specified a component;
183 * instead, they must include enough information for the system to
184 * determine which of the available components is best to run for that
185 * intent.
186 * </ul>
187 *
188 * <p>When using implicit intents, given such an arbitrary intent we need to
189 * know what to do with it. This is handled by the process of <em>Intent
190 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
191 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
192 * more activities/receivers) that can handle it.</p>
193 *
194 * <p>The intent resolution mechanism basically revolves around matching an
195 * Intent against all of the &lt;intent-filter&gt; descriptions in the
196 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
197 * objects explicitly registered with {@link Context#registerReceiver}.) More
198 * details on this can be found in the documentation on the {@link
199 * IntentFilter} class.</p>
200 *
201 * <p>There are three pieces of information in the Intent that are used for
202 * resolution: the action, type, and category. Using this information, a query
203 * is done on the {@link PackageManager} for a component that can handle the
204 * intent. The appropriate component is determined based on the intent
205 * information supplied in the <code>AndroidManifest.xml</code> file as
206 * follows:</p>
207 *
208 * <ul>
209 * <li> <p>The <b>action</b>, if given, must be listed by the component as
210 * one it handles.</p>
211 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
212 * already supplied in the Intent. Like the action, if a type is
213 * included in the intent (either explicitly or implicitly in its
214 * data), then this must be listed by the component as one it handles.</p>
215 * <li> For data that is not a <code>content:</code> URI and where no explicit
216 * type is included in the Intent, instead the <b>scheme</b> of the
217 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
218 * considered. Again like the action, if we are matching a scheme it
219 * must be listed by the component as one it can handle.
220 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
221 * by the activity as categories it handles. That is, if you include
222 * the categories {@link #CATEGORY_LAUNCHER} and
223 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
224 * with an intent that lists <em>both</em> of those categories.
225 * Activities will very often need to support the
226 * {@link #CATEGORY_DEFAULT} so that they can be found by
227 * {@link Context#startActivity Context.startActivity()}.</p>
228 * </ul>
229 *
230 * <p>For example, consider the Note Pad sample application that
231 * allows user to browse through a list of notes data and view details about
232 * individual items. Text in italics indicate places were you would replace a
233 * name with one specific to your own package.</p>
234 *
235 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
236 * package="<i>com.android.notepad</i>"&gt;
237 * &lt;application android:icon="@drawable/app_notes"
238 * android:label="@string/app_name"&gt;
239 *
240 * &lt;provider class=".NotePadProvider"
241 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
242 *
243 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
244 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700245 * &lt;action android:name="android.intent.action.MAIN" /&gt;
246 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700247 * &lt;/intent-filter&gt;
248 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700249 * &lt;action android:name="android.intent.action.VIEW" /&gt;
250 * &lt;action android:name="android.intent.action.EDIT" /&gt;
251 * &lt;action android:name="android.intent.action.PICK" /&gt;
252 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
253 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700254 * &lt;/intent-filter&gt;
255 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700256 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
257 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
258 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700259 * &lt;/intent-filter&gt;
260 * &lt;/activity&gt;
261 *
262 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
263 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700264 * &lt;action android:name="android.intent.action.VIEW" /&gt;
265 * &lt;action android:name="android.intent.action.EDIT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 *
270 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700271 * &lt;action android:name="android.intent.action.INSERT" /&gt;
272 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
273 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * &lt;/intent-filter&gt;
275 *
276 * &lt;/activity&gt;
277 *
278 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
279 * android:theme="@android:style/Theme.Dialog"&gt;
280 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
284 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;/activity&gt;
288 *
289 * &lt;/application&gt;
290 * &lt;/manifest&gt;</pre>
291 *
292 * <p>The first activity,
293 * <code>com.android.notepad.NotesList</code>, serves as our main
294 * entry into the app. It can do three things as described by its three intent
295 * templates:
296 * <ol>
297 * <li><pre>
298 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700299 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
300 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;</pre>
302 * <p>This provides a top-level entry into the NotePad application: the standard
303 * MAIN action is a main entry point (not requiring any other information in
304 * the Intent), and the LAUNCHER category says that this entry point should be
305 * listed in the application launcher.</p>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
309 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
310 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
311 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
312 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;</pre>
314 * <p>This declares the things that the activity can do on a directory of
315 * notes. The type being supported is given with the &lt;type&gt; tag, where
316 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
317 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
318 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
319 * The activity allows the user to view or edit the directory of data (via
320 * the VIEW and EDIT actions), or to pick a particular note and return it
321 * to the caller (via the PICK action). Note also the DEFAULT category
322 * supplied here: this is <em>required</em> for the
323 * {@link Context#startActivity Context.startActivity} method to resolve your
324 * activity when its component name is not explicitly specified.</p>
325 * <li><pre>
326 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700327 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
329 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700330 * &lt;/intent-filter&gt;</pre>
331 * <p>This filter describes the ability return to the caller a note selected by
332 * the user without needing to know where it came from. The data type
333 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
334 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
335 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
336 * The GET_CONTENT action is similar to the PICK action, where the activity
337 * will return to its caller a piece of data selected by the user. Here,
338 * however, the caller specifies the type of data they desire instead of
339 * the type of data the user will be picking from.</p>
340 * </ol>
341 *
342 * <p>Given these capabilities, the following intents will resolve to the
343 * NotesList activity:</p>
344 *
345 * <ul>
346 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
347 * activities that can be used as top-level entry points into an
348 * application.</p>
349 * <li> <p><b>{ action=android.app.action.MAIN,
350 * category=android.app.category.LAUNCHER }</b> is the actual intent
351 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700352 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700353 * data=content://com.google.provider.NotePad/notes }</b>
354 * displays a list of all the notes under
355 * "content://com.google.provider.NotePad/notes", which
356 * the user can browse through and see the details on.</p>
357 * <li> <p><b>{ action=android.app.action.PICK
358 * data=content://com.google.provider.NotePad/notes }</b>
359 * provides a list of the notes under
360 * "content://com.google.provider.NotePad/notes", from which
361 * the user can pick a note whose data URL is returned back to the caller.</p>
362 * <li> <p><b>{ action=android.app.action.GET_CONTENT
363 * type=vnd.android.cursor.item/vnd.google.note }</b>
364 * is similar to the pick action, but allows the caller to specify the
365 * kind of data they want back so that the system can find the appropriate
366 * activity to pick something of that data type.</p>
367 * </ul>
368 *
369 * <p>The second activity,
370 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
371 * note entry and allows them to edit it. It can do two things as described
372 * by its two intent templates:
373 * <ol>
374 * <li><pre>
375 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700376 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
377 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
378 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
379 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700380 * &lt;/intent-filter&gt;</pre>
381 * <p>The first, primary, purpose of this activity is to let the user interact
382 * with a single note, as decribed by the MIME type
383 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
384 * either VIEW a note or allow the user to EDIT it. Again we support the
385 * DEFAULT category to allow the activity to be launched without explicitly
386 * specifying its component.</p>
387 * <li><pre>
388 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700389 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
390 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
391 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700392 * &lt;/intent-filter&gt;</pre>
393 * <p>The secondary use of this activity is to insert a new note entry into
394 * an existing directory of notes. This is used when the user creates a new
395 * note: the INSERT action is executed on the directory of notes, causing
396 * this activity to run and have the user create the new note data which
397 * it then adds to the content provider.</p>
398 * </ol>
399 *
400 * <p>Given these capabilities, the following intents will resolve to the
401 * NoteEditor activity:</p>
402 *
403 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700404 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700405 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
406 * shows the user the content of note <var>{ID}</var>.</p>
407 * <li> <p><b>{ action=android.app.action.EDIT
408 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
409 * allows the user to edit the content of note <var>{ID}</var>.</p>
410 * <li> <p><b>{ action=android.app.action.INSERT
411 * data=content://com.google.provider.NotePad/notes }</b>
412 * creates a new, empty note in the notes list at
413 * "content://com.google.provider.NotePad/notes"
414 * and allows the user to edit it. If they keep their changes, the URI
415 * of the newly created note is returned to the caller.</p>
416 * </ul>
417 *
418 * <p>The last activity,
419 * <code>com.android.notepad.TitleEditor</code>, allows the user to
420 * edit the title of a note. This could be implemented as a class that the
421 * application directly invokes (by explicitly setting its component in
422 * the Intent), but here we show a way you can publish alternative
423 * operations on existing data:</p>
424 *
425 * <pre>
426 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700427 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
429 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
430 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
431 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700432 * &lt;/intent-filter&gt;</pre>
433 *
434 * <p>In the single intent template here, we
435 * have created our own private action called
436 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
437 * edit the title of a note. It must be invoked on a specific note
438 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
439 * view and edit actions, but here displays and edits the title contained
440 * in the note data.
441 *
442 * <p>In addition to supporting the default category as usual, our title editor
443 * also supports two other standard categories: ALTERNATIVE and
444 * SELECTED_ALTERNATIVE. Implementing
445 * these categories allows others to find the special action it provides
446 * without directly knowing about it, through the
447 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
448 * more often to build dynamic menu items with
449 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
450 * template here was also supply an explicit name for the template
451 * (via <code>android:label="@string/resolve_title"</code>) to better control
452 * what the user sees when presented with this activity as an alternative
453 * action to the data they are viewing.
454 *
455 * <p>Given these capabilities, the following intent will resolve to the
456 * TitleEditor activity:</p>
457 *
458 * <ul>
459 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
460 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
461 * displays and allows the user to edit the title associated
462 * with note <var>{ID}</var>.</p>
463 * </ul>
464 *
465 * <h3>Standard Activity Actions</h3>
466 *
467 * <p>These are the current standard actions that Intent defines for launching
468 * activities (usually through {@link Context#startActivity}. The most
469 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
470 * {@link #ACTION_EDIT}.
471 *
472 * <ul>
473 * <li> {@link #ACTION_MAIN}
474 * <li> {@link #ACTION_VIEW}
475 * <li> {@link #ACTION_ATTACH_DATA}
476 * <li> {@link #ACTION_EDIT}
477 * <li> {@link #ACTION_PICK}
478 * <li> {@link #ACTION_CHOOSER}
479 * <li> {@link #ACTION_GET_CONTENT}
480 * <li> {@link #ACTION_DIAL}
481 * <li> {@link #ACTION_CALL}
482 * <li> {@link #ACTION_SEND}
483 * <li> {@link #ACTION_SENDTO}
484 * <li> {@link #ACTION_ANSWER}
485 * <li> {@link #ACTION_INSERT}
486 * <li> {@link #ACTION_DELETE}
487 * <li> {@link #ACTION_RUN}
488 * <li> {@link #ACTION_SYNC}
489 * <li> {@link #ACTION_PICK_ACTIVITY}
490 * <li> {@link #ACTION_SEARCH}
491 * <li> {@link #ACTION_WEB_SEARCH}
492 * <li> {@link #ACTION_FACTORY_TEST}
493 * </ul>
494 *
495 * <h3>Standard Broadcast Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for receiving
498 * broadcasts (usually through {@link Context#registerReceiver} or a
499 * &lt;receiver&gt; tag in a manifest).
500 *
501 * <ul>
502 * <li> {@link #ACTION_TIME_TICK}
503 * <li> {@link #ACTION_TIME_CHANGED}
504 * <li> {@link #ACTION_TIMEZONE_CHANGED}
505 * <li> {@link #ACTION_BOOT_COMPLETED}
506 * <li> {@link #ACTION_PACKAGE_ADDED}
507 * <li> {@link #ACTION_PACKAGE_CHANGED}
508 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800509 * <li> {@link #ACTION_PACKAGE_RESTARTED}
510 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700511 * <li> {@link #ACTION_UID_REMOVED}
512 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700513 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700514 * <li> {@link #ACTION_POWER_DISCONNECTED}
515 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700516 * </ul>
517 *
518 * <h3>Standard Categories</h3>
519 *
520 * <p>These are the current standard categories that can be used to further
521 * clarify an Intent via {@link #addCategory}.
522 *
523 * <ul>
524 * <li> {@link #CATEGORY_DEFAULT}
525 * <li> {@link #CATEGORY_BROWSABLE}
526 * <li> {@link #CATEGORY_TAB}
527 * <li> {@link #CATEGORY_ALTERNATIVE}
528 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
529 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800530 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_HOME}
532 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700533 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400534 * <li> {@link #CATEGORY_CAR_DOCK}
535 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500536 * <li> {@link #CATEGORY_LE_DESK_DOCK}
537 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200538 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700539 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * </ul>
541 *
542 * <h3>Standard Extra Data</h3>
543 *
544 * <p>These are the current standard fields that can be used as extra data via
545 * {@link #putExtra}.
546 *
547 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800548 * <li> {@link #EXTRA_ALARM_COUNT}
549 * <li> {@link #EXTRA_BCC}
550 * <li> {@link #EXTRA_CC}
551 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
552 * <li> {@link #EXTRA_DATA_REMOVED}
553 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500554 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
555 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800556 * <li> {@link #EXTRA_DOCK_STATE_CAR}
557 * <li> {@link #EXTRA_DOCK_STATE_DESK}
558 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
559 * <li> {@link #EXTRA_DONT_KILL_APP}
560 * <li> {@link #EXTRA_EMAIL}
561 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700562 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800563 * <li> {@link #EXTRA_KEY_EVENT}
564 * <li> {@link #EXTRA_PHONE_NUMBER}
565 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
566 * <li> {@link #EXTRA_REPLACING}
567 * <li> {@link #EXTRA_SHORTCUT_ICON}
568 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
569 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800571 * <li> {@link #EXTRA_SHORTCUT_NAME}
572 * <li> {@link #EXTRA_SUBJECT}
573 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_TITLE}
576 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700577 * </ul>
578 *
579 * <h3>Flags</h3>
580 *
581 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800582 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
583 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800585public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 // ---------------------------------------------------------------------
587 // ---------------------------------------------------------------------
588 // Standard intent activity actions (see action variable).
589
590 /**
591 * Activity Action: Start as a main entry point, does not expect to
592 * receive data.
593 * <p>Input: nothing
594 * <p>Output: nothing
595 */
596 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
597 public static final String ACTION_MAIN = "android.intent.action.MAIN";
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: Display the data to the user. This is the most common
601 * action performed on data -- it is the generic action you can use on
602 * a piece of data to get the most reasonable thing to occur. For example,
603 * when used on a contacts entry it will view the entry; when used on a
604 * mailto: URI it will bring up a compose window filled with the information
605 * supplied by the URI; when used with a tel: URI it will invoke the
606 * dialer.
607 * <p>Input: {@link #getData} is URI from which to retrieve data.
608 * <p>Output: nothing.
609 */
610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
611 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 /**
614 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
615 * performed on a piece of data.
616 */
617 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 /**
620 * Used to indicate that some piece of data should be attached to some other
621 * place. For example, image data could be attached to a contact. It is up
622 * to the recipient to decide where the data should be attached; the intent
623 * does not specify the ultimate destination.
624 * <p>Input: {@link #getData} is URI of data to be attached.
625 * <p>Output: nothing.
626 */
627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
628 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Activity Action: Provide explicit editable access to the given data.
632 * <p>Input: {@link #getData} is URI of data to be edited.
633 * <p>Output: nothing.
634 */
635 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
636 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
640 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
641 * The extras can contain type specific data to pass through to the editing/creating
642 * activity.
643 * <p>Output: The URI of the item that was picked. This must be a content:
644 * URI so that any receiver can access it.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an item from the data, returning what was selected.
651 * <p>Input: {@link #getData} is URI containing a directory of data
652 * (vnd.android.cursor.dir/*) from which to pick an item.
653 * <p>Output: The URI of the item that was picked.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 * <p>Output: An Intent representing the shortcut. The intent must contain three
662 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
663 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800664 * (value: ShortcutIconResource).</p>
665 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 * @see #EXTRA_SHORTCUT_INTENT
667 * @see #EXTRA_SHORTCUT_NAME
668 * @see #EXTRA_SHORTCUT_ICON
669 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
670 * @see android.content.Intent.ShortcutIconResource
671 */
672 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
673 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
674
675 /**
676 * The name of the extra used to define the Intent of a shortcut.
677 *
678 * @see #ACTION_CREATE_SHORTCUT
679 */
680 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
681 /**
682 * The name of the extra used to define the name of a shortcut.
683 *
684 * @see #ACTION_CREATE_SHORTCUT
685 */
686 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
687 /**
688 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 */
692 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
693 /**
694 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 * @see android.content.Intent.ShortcutIconResource
698 */
699 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
700 "android.intent.extra.shortcut.ICON_RESOURCE";
701
702 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 *
705 * @see Intent#ACTION_CREATE_SHORTCUT
706 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
708 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700709 */
710 public static class ShortcutIconResource implements Parcelable {
711 /**
712 * The package name of the application containing the icon.
713 */
714 public String packageName;
715
716 /**
717 * The resource name of the icon, including package, name and type.
718 */
719 public String resourceName;
720
721 /**
722 * Creates a new ShortcutIconResource for the specified context and resource
723 * identifier.
724 *
725 * @param context The context of the application.
726 * @param resourceId The resource idenfitier for the icon.
727 * @return A new ShortcutIconResource with the specified's context package name
728 * and icon resource idenfitier.
729 */
730 public static ShortcutIconResource fromContext(Context context, int resourceId) {
731 ShortcutIconResource icon = new ShortcutIconResource();
732 icon.packageName = context.getPackageName();
733 icon.resourceName = context.getResources().getResourceName(resourceId);
734 return icon;
735 }
736
737 /**
738 * Used to read a ShortcutIconResource from a Parcel.
739 */
740 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
741 new Parcelable.Creator<ShortcutIconResource>() {
742
743 public ShortcutIconResource createFromParcel(Parcel source) {
744 ShortcutIconResource icon = new ShortcutIconResource();
745 icon.packageName = source.readString();
746 icon.resourceName = source.readString();
747 return icon;
748 }
749
750 public ShortcutIconResource[] newArray(int size) {
751 return new ShortcutIconResource[size];
752 }
753 };
754
755 /**
756 * No special parcel contents.
757 */
758 public int describeContents() {
759 return 0;
760 }
761
762 public void writeToParcel(Parcel dest, int flags) {
763 dest.writeString(packageName);
764 dest.writeString(resourceName);
765 }
766
767 @Override
768 public String toString() {
769 return resourceName;
770 }
771 }
772
773 /**
774 * Activity Action: Display an activity chooser, allowing the user to pick
775 * what they want to before proceeding. This can be used as an alternative
776 * to the standard activity picker that is displayed by the system when
777 * you try to start an activity with multiple possible matches, with these
778 * differences in behavior:
779 * <ul>
780 * <li>You can specify the title that will appear in the activity chooser.
781 * <li>The user does not have the option to make one of the matching
782 * activities a preferred activity, and all possible activities will
783 * always be shown even if one of them is currently marked as the
784 * preferred activity.
785 * </ul>
786 * <p>
787 * This action should be used when the user will naturally expect to
788 * select an activity in order to proceed. An example if when not to use
789 * it is when the user clicks on a "mailto:" link. They would naturally
790 * expect to go directly to their mail app, so startActivity() should be
791 * called directly: it will
792 * either launch the current preferred app, or put up a dialog allowing the
793 * user to pick an app to use and optionally marking that as preferred.
794 * <p>
795 * In contrast, if the user is selecting a menu item to send a picture
796 * they are viewing to someone else, there are many different things they
797 * may want to do at this point: send it through e-mail, upload it to a
798 * web service, etc. In this case the CHOOSER action should be used, to
799 * always present to the user a list of the things they can do, with a
800 * nice title given by the caller such as "Send this photo with:".
801 * <p>
802 * As a convenience, an Intent of this form can be created with the
803 * {@link #createChooser} function.
804 * <p>Input: No data should be specified. get*Extra must have
805 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
806 * and can optionally have a {@link #EXTRA_TITLE} field containing the
807 * title text to display in the chooser.
808 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
809 */
810 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
811 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
812
813 /**
814 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
815 *
816 * @param target The Intent that the user will be selecting an activity
817 * to perform.
818 * @param title Optional title that will be displayed in the chooser.
819 * @return Return a new Intent object that you can hand to
820 * {@link Context#startActivity(Intent) Context.startActivity()} and
821 * related methods.
822 */
823 public static Intent createChooser(Intent target, CharSequence title) {
824 Intent intent = new Intent(ACTION_CHOOSER);
825 intent.putExtra(EXTRA_INTENT, target);
826 if (title != null) {
827 intent.putExtra(EXTRA_TITLE, title);
828 }
829 return intent;
830 }
831 /**
832 * Activity Action: Allow the user to select a particular kind of data and
833 * return it. This is different than {@link #ACTION_PICK} in that here we
834 * just say what kind of data is desired, not a URI of existing data from
835 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
836 * create the data as it runs (for example taking a picture or recording a
837 * sound), let them browser over the web and download the desired data,
838 * etc.
839 * <p>
840 * There are two main ways to use this action: if you want an specific kind
841 * of data, such as a person contact, you set the MIME type to the kind of
842 * data you want and launch it with {@link Context#startActivity(Intent)}.
843 * The system will then launch the best application to select that kind
844 * of data for you.
845 * <p>
846 * You may also be interested in any of a set of types of content the user
847 * can pick. For example, an e-mail application that wants to allow the
848 * user to add an attachment to an e-mail message can use this action to
849 * bring up a list of all of the types of content the user can attach.
850 * <p>
851 * In this case, you should wrap the GET_CONTENT intent with a chooser
852 * (through {@link #createChooser}), which will give the proper interface
853 * for the user to pick how to send your data and allow you to specify
854 * a prompt indicating what they are doing. You will usually specify a
855 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
856 * broad range of content types the user can select from.
857 * <p>
858 * When using such a broad GET_CONTENT action, it is often desireable to
859 * only pick from data that can be represented as a stream. This is
860 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
861 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800862 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
863 * the launched content chooser only return results representing data that
864 * is locally available on the device. For example, if this extra is set
865 * to true then an image picker should not show any pictures that are available
866 * from a remote server but not already on the local device (thus requiring
867 * they be downloaded when opened).
868 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700869 * Input: {@link #getType} is the desired MIME type to retrieve. Note
870 * that no URI is supplied in the intent, as there are no constraints on
871 * where the returned data originally comes from. You may also include the
872 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800873 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
874 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700875 * <p>
876 * Output: The URI of the item that was picked. This must be a content:
877 * URI so that any receiver can access it.
878 */
879 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
880 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
881 /**
882 * Activity Action: Dial a number as specified by the data. This shows a
883 * UI with the number being dialed, allowing the user to explicitly
884 * initiate the call.
885 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
886 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
887 * number.
888 * <p>Output: nothing.
889 */
890 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
891 public static final String ACTION_DIAL = "android.intent.action.DIAL";
892 /**
893 * Activity Action: Perform a call to someone specified by the data.
894 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
895 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
896 * number.
897 * <p>Output: nothing.
898 *
899 * <p>Note: there will be restrictions on which applications can initiate a
900 * call; most applications should use the {@link #ACTION_DIAL}.
901 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
902 * numbers. Applications can <strong>dial</strong> emergency numbers using
903 * {@link #ACTION_DIAL}, however.
904 */
905 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
906 public static final String ACTION_CALL = "android.intent.action.CALL";
907 /**
908 * Activity Action: Perform a call to an emergency number specified by the
909 * data.
910 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
911 * tel: URI of an explicit phone number.
912 * <p>Output: nothing.
913 * @hide
914 */
915 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
916 /**
917 * Activity action: Perform a call to any number (emergency or not)
918 * specified by the data.
919 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
920 * tel: URI of an explicit phone number.
921 * <p>Output: nothing.
922 * @hide
923 */
924 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
925 /**
926 * Activity Action: Send a message to someone specified by the data.
927 * <p>Input: {@link #getData} is URI describing the target.
928 * <p>Output: nothing.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
932 /**
933 * Activity Action: Deliver some data to someone else. Who the data is
934 * being delivered to is not specified; it is up to the receiver of this
935 * action to ask the user where the data should be sent.
936 * <p>
937 * When launching a SEND intent, you should usually wrap it in a chooser
938 * (through {@link #createChooser}), which will give the proper interface
939 * for the user to pick how to send your data and allow you to specify
940 * a prompt indicating what they are doing.
941 * <p>
942 * Input: {@link #getType} is the MIME type of the data being sent.
943 * get*Extra can have either a {@link #EXTRA_TEXT}
944 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
945 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
946 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
947 * if the MIME type is unknown (this will only allow senders that can
948 * handle generic data streams).
949 * <p>
950 * Optional standard extras, which may be interpreted by some recipients as
951 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
952 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
953 * <p>
954 * Output: nothing.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_SEND = "android.intent.action.SEND";
958 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800959 * Activity Action: Deliver multiple data to someone else.
960 * <p>
961 * Like ACTION_SEND, except the data is multiple.
962 * <p>
963 * Input: {@link #getType} is the MIME type of the data being sent.
964 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
965 * #EXTRA_STREAM} field, containing the data to be sent.
966 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800967 * Multiple types are supported, and receivers should handle mixed types
968 * whenever possible. The right way for the receiver to check them is to
969 * use the content resolver on each URI. The intent sender should try to
970 * put the most concrete mime type in the intent type, but it can fall
971 * back to {@literal <type>/*} or {@literal *}/* as needed.
972 * <p>
973 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
974 * be image/jpg, but if you are sending image/jpg and image/png, then the
975 * intent's type should be image/*.
976 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800977 * Optional standard extras, which may be interpreted by some recipients as
978 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
979 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
980 * <p>
981 * Output: nothing.
982 */
983 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
984 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
985 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700986 * Activity Action: Handle an incoming phone call.
987 * <p>Input: nothing.
988 * <p>Output: nothing.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
992 /**
993 * Activity Action: Insert an empty item into the given container.
994 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
995 * in which to place the data.
996 * <p>Output: URI of the new data that was created.
997 */
998 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
999 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1000 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001001 * Activity Action: Create a new item in the given container, initializing it
1002 * from the current contents of the clipboard.
1003 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1004 * in which to place the data.
1005 * <p>Output: URI of the new data that was created.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1009 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 * Activity Action: Delete the given data from its container.
1011 * <p>Input: {@link #getData} is URI of data to be deleted.
1012 * <p>Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1016 /**
1017 * Activity Action: Run the data, whatever that means.
1018 * <p>Input: ? (Note: this is currently specific to the test harness.)
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_RUN = "android.intent.action.RUN";
1023 /**
1024 * Activity Action: Perform a data synchronization.
1025 * <p>Input: ?
1026 * <p>Output: ?
1027 */
1028 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1029 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1030 /**
1031 * Activity Action: Pick an activity given an intent, returning the class
1032 * selected.
1033 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1034 * used with {@link PackageManager#queryIntentActivities} to determine the
1035 * set of activities from which to pick.
1036 * <p>Output: Class name of the activity that was selected.
1037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1040 /**
1041 * Activity Action: Perform a search.
1042 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1043 * is the text to search for. If empty, simply
1044 * enter your search results Activity with the search UI activated.
1045 * <p>Output: nothing.
1046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1049 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001050 * Activity Action: Start the platform-defined tutorial
1051 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1052 * is the text to search for. If empty, simply
1053 * enter your search results Activity with the search UI activated.
1054 * <p>Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001060 * <p>
1061 * Input: {@link android.app.SearchManager#QUERY
1062 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1063 * a url starts with http or https, the site will be opened. If it is plain
1064 * text, Google search will be applied.
1065 * <p>
1066 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1070 /**
1071 * Activity Action: List all available applications
1072 * <p>Input: Nothing.
1073 * <p>Output: nothing.
1074 */
1075 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1076 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1077 /**
1078 * Activity Action: Show settings for choosing wallpaper
1079 * <p>Input: Nothing.
1080 * <p>Output: Nothing.
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1084
1085 /**
1086 * Activity Action: Show activity for reporting a bug.
1087 * <p>Input: Nothing.
1088 * <p>Output: Nothing.
1089 */
1090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1092
1093 /**
1094 * Activity Action: Main entry point for factory tests. Only used when
1095 * the device is booting in factory test node. The implementing package
1096 * must be installed in the system image.
1097 * <p>Input: nothing
1098 * <p>Output: nothing
1099 */
1100 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1101
1102 /**
1103 * Activity Action: The user pressed the "call" button to go to the dialer
1104 * or other appropriate UI for placing a call.
1105 * <p>Input: Nothing.
1106 * <p>Output: Nothing.
1107 */
1108 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1109 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1110
1111 /**
1112 * Activity Action: Start Voice Command.
1113 * <p>Input: Nothing.
1114 * <p>Output: Nothing.
1115 */
1116 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1117 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001118
1119 /**
1120 * Activity Action: Start action associated with long pressing on the
1121 * search key.
1122 * <p>Input: Nothing.
1123 * <p>Output: Nothing.
1124 */
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1126 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001127
Jacek Surazski86b6c532009-05-13 14:38:28 +02001128 /**
1129 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1130 * This intent is delivered to the package which installed the application, usually
1131 * the Market.
1132 * <p>Input: No data is specified. The bug report is passed in using
1133 * an {@link #EXTRA_BUG_REPORT} field.
1134 * <p>Output: Nothing.
1135 * @hide
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001139
1140 /**
1141 * Activity Action: Show power usage information to the user.
1142 * <p>Input: Nothing.
1143 * <p>Output: Nothing.
1144 */
1145 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1146 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001147
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001148 /**
1149 * Activity Action: Setup wizard to launch after a platform update. This
1150 * activity should have a string meta-data field associated with it,
1151 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1152 * the platform for setup. The activity will be launched only if
1153 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1154 * same value.
1155 * <p>Input: Nothing.
1156 * <p>Output: Nothing.
1157 * @hide
1158 */
1159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1160 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001161
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001162 /**
1163 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1164 * describing the last run version of the platform that was setup.
1165 * @hide
1166 */
1167 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1168
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001169 // ---------------------------------------------------------------------
1170 // ---------------------------------------------------------------------
1171 // Standard intent broadcast actions (see action variable).
1172
1173 /**
1174 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001175 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001176 * <p class="note">This is a protected intent that can only be sent
1177 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001178 */
1179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1180 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1181 /**
1182 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001183 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001184 * <p class="note">This is a protected intent that can only be sent
1185 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001186 */
1187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1188 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001189
1190 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001191 * 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 -07001192 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001193 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001194 * <p class="note">This is a protected intent that can only be sent
1195 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001196 */
1197 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001198 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001199
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001200 /**
1201 * Broadcast Action: The current time has changed. Sent every
1202 * minute. You can <em>not</em> receive this through components declared
1203 * in manifests, only by exlicitly registering for it with
1204 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1205 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001206 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001207 * <p class="note">This is a protected intent that can only be sent
1208 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001209 */
1210 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1211 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1212 /**
1213 * Broadcast Action: The time was set.
1214 */
1215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1216 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1217 /**
1218 * Broadcast Action: The date has changed.
1219 */
1220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1221 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1222 /**
1223 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1224 * <ul>
1225 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1226 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001227 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001228 * <p class="note">This is a protected intent that can only be sent
1229 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001230 */
1231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1232 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1233 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001234 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1235 * DNS entries should be tossed.
1236 * @hide
1237 */
1238 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1239 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001241 * Alarm Changed Action: This is broadcast when the AlarmClock
1242 * application's alarm is set or unset. It is used by the
1243 * AlarmClock application and the StatusBar service.
1244 * @hide
1245 */
1246 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1247 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1248 /**
1249 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1250 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1251 * @hide
1252 */
1253 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1254 public static final String ACTION_SYNC_STATE_CHANGED
1255 = "android.intent.action.SYNC_STATE_CHANGED";
1256 /**
1257 * Broadcast Action: This is broadcast once, after the system has finished
1258 * booting. It can be used to perform application-specific initialization,
1259 * such as installing alarms. You must hold the
1260 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1261 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001262 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001263 * <p class="note">This is a protected intent that can only be sent
1264 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001265 */
1266 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1267 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1268 /**
1269 * Broadcast Action: This is broadcast when a user action should request a
1270 * temporary system dialog to dismiss. Some examples of temporary system
1271 * dialogs are the notification window-shade and the recent tasks dialog.
1272 */
1273 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1274 /**
1275 * Broadcast Action: Trigger the download and eventual installation
1276 * of a package.
1277 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001278 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001279 * <p class="note">This is a protected intent that can only be sent
1280 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001281 */
1282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1283 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1284 /**
1285 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001286 * device. The data contains the name of the package. Note that the
1287 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001288 * <p>My include the following extras:
1289 * <ul>
1290 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1291 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1292 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1293 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001294 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001295 * <p class="note">This is a protected intent that can only be sent
1296 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001297 */
1298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1299 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1300 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001301 * Broadcast Action: A new version of an application package has been
1302 * installed, replacing an existing version that was previously installed.
1303 * The data contains the name of the package.
1304 * <p>My include the following extras:
1305 * <ul>
1306 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1307 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001308 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001309 * <p class="note">This is a protected intent that can only be sent
1310 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001311 */
1312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1313 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1314 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001315 * Broadcast Action: A new version of your application has been installed
1316 * over an existing one. This is only sent to the application that was
1317 * replaced. It does not contain any additional data; to receive it, just
1318 * use an intent filter for this action.
1319 *
1320 * <p class="note">This is a protected intent that can only be sent
1321 * by the system.
1322 */
1323 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1324 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1325 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001326 * Broadcast Action: An existing application package has been removed from
1327 * the device. The data contains the name of the package. The package
1328 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001329 * <ul>
1330 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1331 * to the package.
1332 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1333 * application -- data and code -- is being removed.
1334 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1335 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1336 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001337 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001338 * <p class="note">This is a protected intent that can only be sent
1339 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001340 */
1341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1342 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1343 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001344 * Broadcast Action: An existing application package has been changed (e.g.
1345 * a component has been enabled or disabled). The data contains the name of
1346 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001347 * <ul>
1348 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001349 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1350 * of the changed components.
1351 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1352 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001353 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001354 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001355 * <p class="note">This is a protected intent that can only be sent
1356 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001357 */
1358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1359 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1360 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001361 * @hide
1362 * Broadcast Action: Ask system services if there is any reason to
1363 * restart the given package. The data contains the name of the
1364 * package.
1365 * <ul>
1366 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1367 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1368 * </ul>
1369 *
1370 * <p class="note">This is a protected intent that can only be sent
1371 * by the system.
1372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1375 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001376 * Broadcast Action: The user has restarted a package, and all of its
1377 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001378 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001379 * be removed. Note that the restarted package does <em>not</em>
1380 * receive this broadcast.
1381 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001382 * <ul>
1383 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1384 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001385 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001386 * <p class="note">This is a protected intent that can only be sent
1387 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001388 */
1389 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1390 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1391 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001392 * Broadcast Action: The user has cleared the data of a package. This should
1393 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001394 * its persistent data is erased and this broadcast sent.
1395 * Note that the cleared package does <em>not</em>
1396 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001397 * <ul>
1398 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1399 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001400 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001401 * <p class="note">This is a protected intent that can only be sent
1402 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001403 */
1404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1405 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1406 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001407 * Broadcast Action: A user ID has been removed from the system. The user
1408 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001409 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001410 * <p class="note">This is a protected intent that can only be sent
1411 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001412 */
1413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1414 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001415
1416 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001417 * Broadcast Action: Sent to the installer package of an application
1418 * when that application is first launched (that is the first time it
1419 * is moved out of the stopped state). The data contains the name of the package.
1420 *
1421 * <p class="note">This is a protected intent that can only be sent
1422 * by the system.
1423 */
1424 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1425 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1426
1427 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001428 * Broadcast Action: Resources for a set of packages (which were
1429 * previously unavailable) are currently
1430 * available since the media on which they exist is available.
1431 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1432 * list of packages whose availability changed.
1433 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1434 * list of uids of packages whose availability changed.
1435 * Note that the
1436 * packages in this list do <em>not</em> receive this broadcast.
1437 * The specified set of packages are now available on the system.
1438 * <p>Includes the following extras:
1439 * <ul>
1440 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1441 * whose resources(were previously unavailable) are currently available.
1442 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1443 * packages whose resources(were previously unavailable)
1444 * are currently available.
1445 * </ul>
1446 *
1447 * <p class="note">This is a protected intent that can only be sent
1448 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001449 */
1450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001451 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1452 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001453
1454 /**
1455 * Broadcast Action: Resources for a set of packages are currently
1456 * unavailable since the media on which they exist is unavailable.
1457 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1458 * list of packages whose availability changed.
1459 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1460 * list of uids of packages whose availability changed.
1461 * The specified set of packages can no longer be
1462 * launched and are practically unavailable on the system.
1463 * <p>Inclues the following extras:
1464 * <ul>
1465 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1466 * whose resources are no longer available.
1467 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1468 * whose resources are no longer available.
1469 * </ul>
1470 *
1471 * <p class="note">This is a protected intent that can only be sent
1472 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001473 */
1474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001475 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001476 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001477
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001478 /**
1479 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001480 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001481 */
1482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1483 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1484 /**
1485 * Broadcast Action: The current device {@link android.content.res.Configuration}
1486 * (orientation, locale, etc) has changed. When such a change happens, the
1487 * UIs (view hierarchy) will need to be rebuilt based on this new
1488 * information; for the most part, applications don't need to worry about
1489 * this, because the system will take care of stopping and restarting the
1490 * application to make sure it sees the new changes. Some system code that
1491 * can not be restarted will need to watch for this action and handle it
1492 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001493 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001494 * <p class="note">
1495 * You can <em>not</em> receive this through components declared
1496 * in manifests, only by explicitly registering for it with
1497 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1498 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001499 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001500 * <p class="note">This is a protected intent that can only be sent
1501 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001502 *
1503 * @see android.content.res.Configuration
1504 */
1505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1507 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001508 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001509 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001510 * <p class="note">This is a protected intent that can only be sent
1511 * by the system.
1512 */
1513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1515 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001516 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1517 * charging state, level, and other information about the battery.
1518 * See {@link android.os.BatteryManager} for documentation on the
1519 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001520 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001521 * <p class="note">
1522 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001523 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001524 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001525 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1526 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1527 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1528 * broadcasts that are sent and can be received through manifest
1529 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001530 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001531 * <p class="note">This is a protected intent that can only be sent
1532 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001533 */
1534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1535 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1536 /**
1537 * Broadcast Action: Indicates low battery condition on the device.
1538 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001539 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001540 * <p class="note">This is a protected intent that can only be sent
1541 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001542 */
1543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1544 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1545 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001546 * Broadcast Action: Indicates the battery is now okay after being low.
1547 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1548 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001549 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001550 * <p class="note">This is a protected intent that can only be sent
1551 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1555 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001556 * Broadcast Action: External power has been connected to the device.
1557 * This is intended for applications that wish to register specifically to this notification.
1558 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1559 * stay active to receive this notification. This action can be used to implement actions
1560 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001561 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001562 * <p class="note">This is a protected intent that can only be sent
1563 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001564 */
1565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001566 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001567 /**
1568 * Broadcast Action: External power has been removed from the device.
1569 * This is intended for applications that wish to register specifically to this notification.
1570 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1571 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001572 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001573 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001574 * <p class="note">This is a protected intent that can only be sent
1575 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001576 */
1577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001578 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001579 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001580 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001581 * Broadcast Action: Device is shutting down.
1582 * This is broadcast when the device is being shut down (completely turned
1583 * off, not sleeping). Once the broadcast is complete, the final shutdown
1584 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001585 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001586 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001587 * <p class="note">This is a protected intent that can only be sent
1588 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001589 */
1590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001591 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001592 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001593 * Activity Action: Start this activity to request system shutdown.
1594 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1595 * to request confirmation from the user before shutting down.
1596 *
1597 * <p class="note">This is a protected intent that can only be sent
1598 * by the system.
1599 *
1600 * {@hide}
1601 */
1602 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1603 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001604 * Broadcast Action: A sticky broadcast that indicates low memory
1605 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001606 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001607 * <p class="note">This is a protected intent that can only be sent
1608 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001609 */
1610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1611 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1612 /**
1613 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001614 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001615 * <p class="note">This is a protected intent that can only be sent
1616 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001617 */
1618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1619 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1620 /**
Jake Hambybb371632010-08-23 18:16:48 -07001621 * Broadcast Action: A sticky broadcast that indicates a memory full
1622 * condition on the device. This is intended for activities that want
1623 * to be able to fill the data partition completely, leaving only
1624 * enough free space to prevent system-wide SQLite failures.
1625 *
1626 * <p class="note">This is a protected intent that can only be sent
1627 * by the system.
1628 *
1629 * {@hide}
1630 */
1631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1632 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1633 /**
1634 * Broadcast Action: Indicates memory full condition on the device
1635 * no longer exists.
1636 *
1637 * <p class="note">This is a protected intent that can only be sent
1638 * by the system.
1639 *
1640 * {@hide}
1641 */
1642 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1643 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1644 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001645 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1646 * and package management should be started.
1647 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1648 * notification.
1649 */
1650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1651 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1652 /**
1653 * Broadcast Action: The device has entered USB Mass Storage mode.
1654 * This is used mainly for the USB Settings panel.
1655 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1656 * when the SD card file system is mounted or unmounted
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1660
1661 /**
1662 * Broadcast Action: The device has exited USB Mass Storage mode.
1663 * This is used mainly for the USB Settings panel.
1664 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1665 * when the SD card file system is mounted or unmounted
1666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1669
1670 /**
1671 * Broadcast Action: External media has been removed.
1672 * The path to the mount point for the removed media is contained in the Intent.mData field.
1673 */
1674 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1675 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1676
1677 /**
1678 * Broadcast Action: External media is present, but not mounted at its mount point.
1679 * The path to the mount point for the removed media is contained in the Intent.mData field.
1680 */
1681 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1682 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1683
1684 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001685 * Broadcast Action: External media is present, and being disk-checked
1686 * 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 -08001687 */
1688 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1689 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1690
1691 /**
1692 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1693 * 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 -08001694 */
1695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1696 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1697
1698 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001699 * Broadcast Action: External media is present and mounted at its mount point.
1700 * The path to the mount point for the removed media is contained in the Intent.mData field.
1701 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1702 * media was mounted read only.
1703 */
1704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1705 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1706
1707 /**
1708 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001709 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001710 */
1711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1712 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1713
1714 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001715 * Broadcast Action: External media is no longer being shared via USB mass storage.
1716 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1717 *
1718 * @hide
1719 */
1720 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1721
1722 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001723 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1724 * The path to the mount point for the removed media is contained in the Intent.mData field.
1725 */
1726 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1727 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1728
1729 /**
1730 * Broadcast Action: External media is present but cannot be mounted.
1731 * The path to the mount point for the removed media is contained in the Intent.mData field.
1732 */
1733 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1734 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1735
1736 /**
1737 * Broadcast Action: User has expressed the desire to remove the external storage media.
1738 * Applications should close all files they have open within the mount point when they receive this intent.
1739 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1740 */
1741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1742 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1743
1744 /**
1745 * Broadcast Action: The media scanner has started scanning a directory.
1746 * The path to the directory being scanned is contained in the Intent.mData field.
1747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1749 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1750
1751 /**
1752 * Broadcast Action: The media scanner has finished scanning a directory.
1753 * The path to the scanned directory is contained in the Intent.mData field.
1754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1757
1758 /**
1759 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1760 * The path to the file is contained in the Intent.mData field.
1761 */
1762 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1763 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1764
1765 /**
1766 * Broadcast Action: The "Media Button" was pressed. Includes a single
1767 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1768 * caused the broadcast.
1769 */
1770 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1771 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1772
1773 /**
1774 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1775 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1776 * caused the broadcast.
1777 */
1778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1779 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1780
1781 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1782 // location; they are not general-purpose actions.
1783
1784 /**
1785 * Broadcast Action: An GTalk connection has been established.
1786 */
1787 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1788 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1789 "android.intent.action.GTALK_CONNECTED";
1790
1791 /**
1792 * Broadcast Action: An GTalk connection has been disconnected.
1793 */
1794 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1795 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1796 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001797
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001798 /**
1799 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001800 */
1801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1802 public static final String ACTION_INPUT_METHOD_CHANGED =
1803 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001804
1805 /**
1806 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1807 * more radios have been turned off or on. The intent will have the following extra value:</p>
1808 * <ul>
1809 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1810 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1811 * turned off</li>
1812 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001813 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001814 * <p class="note">This is a protected intent that can only be sent
1815 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001816 */
1817 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1818 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1819
1820 /**
1821 * Broadcast Action: Some content providers have parts of their namespace
1822 * where they publish new events or items that the user may be especially
1823 * interested in. For these things, they may broadcast this action when the
1824 * set of interesting items change.
1825 *
1826 * For example, GmailProvider sends this notification when the set of unread
1827 * mail in the inbox changes.
1828 *
1829 * <p>The data of the intent identifies which part of which provider
1830 * changed. When queried through the content resolver, the data URI will
1831 * return the data set in question.
1832 *
1833 * <p>The intent will have the following extra values:
1834 * <ul>
1835 * <li><em>count</em> - The number of items in the data set. This is the
1836 * same as the number of items in the cursor returned by querying the
1837 * data URI. </li>
1838 * </ul>
1839 *
1840 * This intent will be sent at boot (if the count is non-zero) and when the
1841 * data set changes. It is possible for the data set to change without the
1842 * count changing (for example, if a new unread message arrives in the same
1843 * sync operation in which a message is archived). The phone should still
1844 * ring/vibrate/etc as normal in this case.
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_PROVIDER_CHANGED =
1848 "android.intent.action.PROVIDER_CHANGED";
1849
1850 /**
1851 * Broadcast Action: Wired Headset plugged in or unplugged.
1852 *
1853 * <p>The intent will have the following extra values:
1854 * <ul>
1855 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1856 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001857 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001858 * </ul>
1859 * </ul>
1860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1862 public static final String ACTION_HEADSET_PLUG =
1863 "android.intent.action.HEADSET_PLUG";
1864
1865 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001866 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1867 *
1868 * <p>The intent will have the following extra values:
1869 * <ul>
1870 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1871 * <li><em>name</em> - Headset type, human readable string </li>
1872 * </ul>
1873 * </ul>
1874 * @hide
1875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1877 public static final String ACTION_USB_ANLG_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08001878 "android.intent.action.USB_ANLG_HEADSET_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001879
1880 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07001881 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001882 *
1883 * <p>The intent will have the following extra values:
1884 * <ul>
1885 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1886 * <li><em>name</em> - Headset type, human readable string </li>
1887 * </ul>
1888 * </ul>
1889 * @hide
1890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_USB_DGTL_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08001893 "android.intent.action.USB_DGTL_HEADSET_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07001894
1895 /**
1896 * Broadcast Action: A HMDI cable was plugged or unplugged
1897 *
1898 * <p>The intent will have the following extra values:
1899 * <ul>
1900 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1901 * <li><em>name</em> - HDMI cable, human readable string </li>
1902 * </ul>
1903 * </ul>
1904 * @hide
1905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_HDMI_AUDIO_PLUG =
1908 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001909
1910 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07001911 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
1912 * <ul>
1913 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
1914 * </ul>
1915 *
1916 * <p class="note">This is a protected intent that can only be sent
1917 * by the system.
1918 *
1919 * @hide
1920 */
1921 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
1923 = "android.intent.action.ADVANCED_SETTINGS";
1924
1925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 * Broadcast Action: An outgoing call is about to be placed.
1927 *
1928 * <p>The Intent will have the following extra value:
1929 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001930 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 * the phone number originally intended to be dialed.</li>
1932 * </ul>
1933 * <p>Once the broadcast is finished, the resultData is used as the actual
1934 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001935 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001936 * outgoing call in turn: for example, a parental control application
1937 * might verify that the user is authorized to place the call at that
1938 * time, then a number-rewriting application might add an area code if
1939 * one was not specified.</p>
1940 * <p>For consistency, any receiver whose purpose is to prohibit phone
1941 * calls should have a priority of 0, to ensure it will see the final
1942 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001943 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001944 * should have a positive priority.
1945 * Negative priorities are reserved for the system for this broadcast;
1946 * using them may cause problems.</p>
1947 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1948 * abort the broadcast.</p>
1949 * <p>Emergency calls cannot be intercepted using this mechanism, and
1950 * other calls cannot be modified to call emergency numbers using this
1951 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001952 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1954 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08001955 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001956 * <p class="note">This is a protected intent that can only be sent
1957 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_NEW_OUTGOING_CALL =
1961 "android.intent.action.NEW_OUTGOING_CALL";
1962
1963 /**
1964 * Broadcast Action: Have the device reboot. This is only for use by
1965 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08001966 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001967 * <p class="note">This is a protected intent that can only be sent
1968 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001969 */
1970 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1971 public static final String ACTION_REBOOT =
1972 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001973
Wei Huang97ecc9c2009-05-11 17:44:20 -07001974 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08001975 * Broadcast Action: A sticky broadcast for changes in the physical
1976 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08001977 *
1978 * <p>The intent will have the following extra values:
1979 * <ul>
1980 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08001981 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08001982 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08001983 * <p>This is intended for monitoring the current physical dock state.
1984 * See {@link android.app.UiModeManager} for the normal API dealing with
1985 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_DOCK_EVENT =
1989 "android.intent.action.DOCK_EVENT";
1990
1991 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001992 * Broadcast Action: a remote intent is to be broadcasted.
1993 *
1994 * A remote intent is used for remote RPC between devices. The remote intent
1995 * is serialized and sent from one device to another device. The receiving
1996 * device parses the remote intent and broadcasts it. Note that anyone can
1997 * broadcast a remote intent. However, if the intent receiver of the remote intent
1998 * does not trust intent broadcasts from arbitrary intent senders, it should require
1999 * the sender to hold certain permissions so only trusted sender's broadcast will be
2000 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002001 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002002 */
2003 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002004 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002005
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002006 /**
2007 * Broadcast Action: hook for permforming cleanup after a system update.
2008 *
2009 * The broadcast is sent when the system is booting, before the
2010 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2011 * image. A receiver for this should do its work and then disable itself
2012 * so that it does not get run again at the next boot.
2013 * @hide
2014 */
2015 public static final String ACTION_PRE_BOOT_COMPLETED =
2016 "android.intent.action.PRE_BOOT_COMPLETED";
2017
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 // ---------------------------------------------------------------------
2019 // ---------------------------------------------------------------------
2020 // Standard intent categories (see addCategory()).
2021
2022 /**
2023 * Set if the activity should be an option for the default action
2024 * (center press) to perform on a piece of data. Setting this will
2025 * hide from the user any activities without it set when performing an
2026 * action on some data. Note that this is normal -not- set in the
2027 * Intent when initiating an action -- it is for use in intent filters
2028 * specified in packages.
2029 */
2030 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2031 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2032 /**
2033 * Activities that can be safely invoked from a browser must support this
2034 * category. For example, if the user is viewing a web page or an e-mail
2035 * and clicks on a link in the text, the Intent generated execute that
2036 * link will require the BROWSABLE category, so that only activities
2037 * supporting this category will be considered as possible actions. By
2038 * supporting this category, you are promising that there is nothing
2039 * damaging (without user intervention) that can happen by invoking any
2040 * matching Intent.
2041 */
2042 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2043 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2044 /**
2045 * Set if the activity should be considered as an alternative action to
2046 * the data the user is currently viewing. See also
2047 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2048 * applies to the selection in a list of items.
2049 *
2050 * <p>Supporting this category means that you would like your activity to be
2051 * displayed in the set of alternative things the user can do, usually as
2052 * part of the current activity's options menu. You will usually want to
2053 * include a specific label in the &lt;intent-filter&gt; of this action
2054 * describing to the user what it does.
2055 *
2056 * <p>The action of IntentFilter with this category is important in that it
2057 * describes the specific action the target will perform. This generally
2058 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2059 * a specific name such as "com.android.camera.action.CROP. Only one
2060 * alternative of any particular action will be shown to the user, so using
2061 * a specific action like this makes sure that your alternative will be
2062 * displayed while also allowing other applications to provide their own
2063 * overrides of that particular action.
2064 */
2065 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2066 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2067 /**
2068 * Set if the activity should be considered as an alternative selection
2069 * action to the data the user has currently selected. This is like
2070 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2071 * of items from which the user can select, giving them alternatives to the
2072 * default action that will be performed on it.
2073 */
2074 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2075 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2076 /**
2077 * Intended to be used as a tab inside of an containing TabActivity.
2078 */
2079 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2080 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2081 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002082 * Should be displayed in the top-level launcher.
2083 */
2084 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2085 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2086 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002087 * Provides information about the package it is in; typically used if
2088 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2089 * a front-door to the user without having to be shown in the all apps list.
2090 */
2091 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2092 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2093 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002094 * This is the home activity, that is the first activity that is displayed
2095 * when the device boots.
2096 */
2097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2098 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2099 /**
2100 * This activity is a preference panel.
2101 */
2102 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2103 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2104 /**
2105 * This activity is a development preference panel.
2106 */
2107 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2108 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2109 /**
2110 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002111 */
2112 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2113 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2114 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002115 * This activity allows the user to browse and download new applications.
2116 */
2117 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2118 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2119 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002120 * This activity may be exercised by the monkey or other automated test tools.
2121 */
2122 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2123 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2124 /**
2125 * To be used as a test (not part of the normal user experience).
2126 */
2127 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2128 /**
2129 * To be used as a unit test (run through the Test Harness).
2130 */
2131 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2132 /**
2133 * To be used as an sample code example (not part of the normal user
2134 * experience).
2135 */
2136 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2137 /**
2138 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2139 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2140 * when queried, though it is allowable for those columns to be blank.
2141 */
2142 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2143 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2144
2145 /**
2146 * To be used as code under test for framework instrumentation tests.
2147 */
2148 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2149 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002150 /**
2151 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002152 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2153 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002154 */
2155 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2156 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2157 /**
2158 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002159 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2160 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002161 */
2162 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2163 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002164 /**
2165 * An activity to run when device is inserted into a analog (low end) dock.
2166 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2167 * information, see {@link android.app.UiModeManager}.
2168 */
2169 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2170 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2171
2172 /**
2173 * An activity to run when device is inserted into a digital (high end) dock.
2174 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2175 * information, see {@link android.app.UiModeManager}.
2176 */
2177 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2178 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002179
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002180 /**
2181 * Used to indicate that the activity can be used in a car environment.
2182 */
2183 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2184 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2185
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002186 // ---------------------------------------------------------------------
2187 // ---------------------------------------------------------------------
2188 // Standard extra data keys.
2189
2190 /**
2191 * The initial data to place in a newly created record. Use with
2192 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2193 * fields as would be given to the underlying ContentProvider.insert()
2194 * call.
2195 */
2196 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2197
2198 /**
2199 * A constant CharSequence that is associated with the Intent, used with
2200 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2201 * this may be a styled CharSequence, so you must use
2202 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2203 * retrieve it.
2204 */
2205 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2206
2207 /**
2208 * A content: URI holding a stream of data associated with the Intent,
2209 * used with {@link #ACTION_SEND} to supply the data being sent.
2210 */
2211 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2212
2213 /**
2214 * A String[] holding e-mail addresses that should be delivered to.
2215 */
2216 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2217
2218 /**
2219 * A String[] holding e-mail addresses that should be carbon copied.
2220 */
2221 public static final String EXTRA_CC = "android.intent.extra.CC";
2222
2223 /**
2224 * A String[] holding e-mail addresses that should be blind carbon copied.
2225 */
2226 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2227
2228 /**
2229 * A constant string holding the desired subject line of a message.
2230 */
2231 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2232
2233 /**
2234 * An Intent describing the choices you would like shown with
2235 * {@link #ACTION_PICK_ACTIVITY}.
2236 */
2237 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2238
2239 /**
2240 * A CharSequence dialog title to provide to the user when used with a
2241 * {@link #ACTION_CHOOSER}.
2242 */
2243 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2244
2245 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002246 * A Parcelable[] of {@link Intent} or
2247 * {@link android.content.pm.LabeledIntent} objects as set with
2248 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2249 * a the front of the list of choices, when shown to the user with a
2250 * {@link #ACTION_CHOOSER}.
2251 */
2252 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2253
2254 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002255 * A {@link android.view.KeyEvent} object containing the event that
2256 * triggered the creation of the Intent it is in.
2257 */
2258 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2259
2260 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002261 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2262 * before shutting down.
2263 *
2264 * {@hide}
2265 */
2266 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2267
2268 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002269 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2270 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2271 * of restarting the application.
2272 */
2273 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2274
2275 /**
2276 * A String holding the phone number originally entered in
2277 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2278 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2279 */
2280 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002281
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002282 /**
2283 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2284 * intents to supply the uid the package had been assigned. Also an optional
2285 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2286 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2287 * purpose.
2288 */
2289 public static final String EXTRA_UID = "android.intent.extra.UID";
2290
2291 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002292 * @hide String array of package names.
2293 */
2294 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2295
2296 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002297 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2298 * intents to indicate whether this represents a full uninstall (removing
2299 * both the code and its data) or a partial uninstall (leaving its data,
2300 * implying that this is an update).
2301 */
2302 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002303
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002304 /**
2305 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2306 * intents to indicate that this is a replacement of the package, so this
2307 * broadcast will immediately be followed by an add broadcast for a
2308 * different version of the same package.
2309 */
2310 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002311
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002312 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 * Used as an int extra field in {@link android.app.AlarmManager} intents
2314 * to tell the application being invoked how many pending alarms are being
2315 * delievered with the intent. For one-shot alarms this will always be 1.
2316 * For recurring alarms, this might be greater than 1 if the device was
2317 * asleep or powered off at the time an earlier alarm would have been
2318 * delivered.
2319 */
2320 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002321
Jacek Surazski86b6c532009-05-13 14:38:28 +02002322 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002323 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2324 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002325 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2326 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002327 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2328 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2329 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002330 */
2331 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2332
2333 /**
2334 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2335 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002336 */
2337 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2338
2339 /**
2340 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2341 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002342 */
2343 public static final int EXTRA_DOCK_STATE_DESK = 1;
2344
2345 /**
2346 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2347 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002348 */
2349 public static final int EXTRA_DOCK_STATE_CAR = 2;
2350
2351 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002352 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2353 * to represent that the phone is in a analog (low end) dock.
2354 */
2355 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2356
2357 /**
2358 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2359 * to represent that the phone is in a digital (high end) dock.
2360 */
2361 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2362
2363 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002364 * Boolean that can be supplied as meta-data with a dock activity, to
2365 * indicate that the dock should take over the home key when it is active.
2366 */
2367 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002368
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002369 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002370 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2371 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002372 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002373 * @hide
2374 */
2375 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2376
2377 /**
Romain Guy4969af72009-06-17 10:53:19 -07002378 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002379 * package. Specifies the installer package name; this package will receive the
2380 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002381 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002382 * @hide
2383 */
Romain Guy4969af72009-06-17 10:53:19 -07002384 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002385 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002386
Wei Huang97ecc9c2009-05-11 17:44:20 -07002387 /**
2388 * Used in the extra field in the remote intent. It's astring token passed with the
2389 * remote intent.
2390 */
2391 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2392 "android.intent.extra.remote_intent_token";
2393
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002394 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002395 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002396 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002397 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002398 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002399 "android.intent.extra.changed_component_name";
2400
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002401 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002402 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002403 * and contains a string array of all of the components that have changed.
2404 */
2405 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2406 "android.intent.extra.changed_component_name_list";
2407
2408 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002409 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002410 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2411 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002412 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002413 */
2414 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2415 "android.intent.extra.changed_package_list";
2416
2417 /**
2418 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002419 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2420 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002421 * and contains an integer array of uids of all of the components
2422 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002423 */
2424 public static final String EXTRA_CHANGED_UID_LIST =
2425 "android.intent.extra.changed_uid_list";
2426
2427 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002428 * @hide
2429 * Magic extra system code can use when binding, to give a label for
2430 * who it is that has bound to a service. This is an integer giving
2431 * a framework string resource that can be displayed to the user.
2432 */
2433 public static final String EXTRA_CLIENT_LABEL =
2434 "android.intent.extra.client_label";
2435
2436 /**
2437 * @hide
2438 * Magic extra system code can use when binding, to give a PendingIntent object
2439 * that can be launched for the user to disable the system's use of this
2440 * service.
2441 */
2442 public static final String EXTRA_CLIENT_INTENT =
2443 "android.intent.extra.client_intent";
2444
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002445 /**
2446 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2447 * data that is on the local device. This is a boolean extra; the default
2448 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2449 * the user to select media that is already on the device, not requiring it
2450 * be downloaded from a remote service when opened. Another way to look
2451 * at it is that such content should generally have a "_data" column to the
2452 * path of the content on local external storage.
2453 */
2454 public static final String EXTRA_LOCAL_ONLY =
2455 "android.intent.extra.LOCAL_ONLY";
2456
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002457 // ---------------------------------------------------------------------
2458 // ---------------------------------------------------------------------
2459 // Intent flags (see mFlags variable).
2460
2461 /**
2462 * If set, the recipient of this Intent will be granted permission to
2463 * perform read operations on the Uri in the Intent's data.
2464 */
2465 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2466 /**
2467 * If set, the recipient of this Intent will be granted permission to
2468 * perform write operations on the Uri in the Intent's data.
2469 */
2470 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2471 /**
2472 * Can be set by the caller to indicate that this Intent is coming from
2473 * a background operation, not from direct user interaction.
2474 */
2475 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2476 /**
2477 * A flag you can enable for debugging: when set, log messages will be
2478 * printed during the resolution of this intent to show you what has
2479 * been found to create the final resolved list.
2480 */
2481 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002482 /**
2483 * If set, this intent will not match any components in packages that
2484 * are currently stopped. If this is not set, then the default behavior
2485 * is to include such applications in the result.
2486 */
2487 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2488 /**
2489 * If set, this intent will always match any components in packages that
2490 * are currently stopped. This is the default behavior when
2491 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2492 * flags are set, this one wins (it allows overriding of exclude for
2493 * places where the framework may automatically set the exclude flag).
2494 */
2495 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496
2497 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002498 * If set, the new activity is not kept in the history stack. As soon as
2499 * the user navigates away from it, the activity is finished. This may also
2500 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2501 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002502 */
2503 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2504 /**
2505 * If set, the activity will not be launched if it is already running
2506 * at the top of the history stack.
2507 */
2508 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2509 /**
2510 * If set, this activity will become the start of a new task on this
2511 * history stack. A task (from the activity that started it to the
2512 * next task activity) defines an atomic group of activities that the
2513 * user can move to. Tasks can be moved to the foreground and background;
2514 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002515 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002516 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2517 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002518 *
2519 * <p>This flag is generally used by activities that want
2520 * to present a "launcher" style behavior: they give the user a list of
2521 * separate things that can be done, which otherwise run completely
2522 * independently of the activity launching them.
2523 *
2524 * <p>When using this flag, if a task is already running for the activity
2525 * you are now starting, then a new activity will not be started; instead,
2526 * the current task will simply be brought to the front of the screen with
2527 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2528 * to disable this behavior.
2529 *
2530 * <p>This flag can not be used when the caller is requesting a result from
2531 * the activity being launched.
2532 */
2533 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2534 /**
2535 * <strong>Do not use this flag unless you are implementing your own
2536 * top-level application launcher.</strong> Used in conjunction with
2537 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2538 * behavior of bringing an existing task to the foreground. When set,
2539 * a new task is <em>always</em> started to host the Activity for the
2540 * Intent, regardless of whether there is already an existing task running
2541 * the same thing.
2542 *
2543 * <p><strong>Because the default system does not include graphical task management,
2544 * you should not use this flag unless you provide some way for a user to
2545 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002546 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 * <p>This flag is ignored if
2548 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2549 *
Scott Main7aee61f2011-02-08 11:25:01 -08002550 * <p>See
2551 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2552 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 */
2554 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2555 /**
2556 * If set, and the activity being launched is already running in the
2557 * current task, then instead of launching a new instance of that activity,
2558 * all of the other activities on top of it will be closed and this Intent
2559 * will be delivered to the (now on top) old activity as a new Intent.
2560 *
2561 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2562 * If D calls startActivity() with an Intent that resolves to the component
2563 * of activity B, then C and D will be finished and B receive the given
2564 * Intent, resulting in the stack now being: A, B.
2565 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002566 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002567 * either receive the new intent you are starting here in its
2568 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002569 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002570 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2571 * the same intent, then it will be finished and re-created; for all other
2572 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2573 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002574 *
2575 * <p>This launch mode can also be used to good effect in conjunction with
2576 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2577 * of a task, it will bring any currently running instance of that task
2578 * to the foreground, and then clear it to its root state. This is
2579 * especially useful, for example, when launching an activity from the
2580 * notification manager.
2581 *
Scott Main7aee61f2011-02-08 11:25:01 -08002582 * <p>See
2583 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2584 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002585 */
2586 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2587 /**
2588 * If set and this intent is being used to launch a new activity from an
2589 * existing one, then the reply target of the existing activity will be
2590 * transfered to the new activity. This way the new activity can call
2591 * {@link android.app.Activity#setResult} and have that result sent back to
2592 * the reply target of the original activity.
2593 */
2594 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2595 /**
2596 * If set and this intent is being used to launch a new activity from an
2597 * existing one, the current activity will not be counted as the top
2598 * activity for deciding whether the new intent should be delivered to
2599 * the top instead of starting a new one. The previous activity will
2600 * be used as the top, with the assumption being that the current activity
2601 * will finish itself immediately.
2602 */
2603 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2604 /**
2605 * If set, the new activity is not kept in the list of recently launched
2606 * activities.
2607 */
2608 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2609 /**
2610 * This flag is not normally set by application code, but set for you by
2611 * the system as described in the
2612 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2613 * launchMode} documentation for the singleTask mode.
2614 */
2615 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2616 /**
2617 * If set, and this activity is either being started in a new task or
2618 * bringing to the top an existing task, then it will be launched as
2619 * the front door of the task. This will result in the application of
2620 * any affinities needed to have that task in the proper state (either
2621 * moving activities to or from it), or simply resetting that task to
2622 * its initial state if needed.
2623 */
2624 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2625 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002626 * This flag is not normally set by application code, but set for you by
2627 * the system if this activity is being launched from history
2628 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002629 */
2630 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002631 /**
2632 * If set, this marks a point in the task's activity stack that should
2633 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002634 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002635 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2636 * the user re-launching it from home), this activity and all on top of
2637 * it will be finished so that the user does not return to them, but
2638 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002639 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002640 * <p>This is useful for cases where you have a logical break in your
2641 * application. For example, an e-mail application may have a command
2642 * to view an attachment, which launches an image view activity to
2643 * display it. This activity should be part of the e-mail application's
2644 * task, since it is a part of the task the user is involved in. However,
2645 * if the user leaves that task, and later selects the e-mail app from
2646 * home, we may like them to return to the conversation they were
2647 * viewing, not the picture attachment, since that is confusing. By
2648 * setting this flag when launching the image viewer, that viewer and
2649 * any activities it starts will be removed the next time the user returns
2650 * to mail.
2651 */
2652 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002653 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002654 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002655 * callback from occurring on the current frontmost activity before it is
2656 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002657 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002658 * <p>Typically, an activity can rely on that callback to indicate that an
2659 * explicit user action has caused their activity to be moved out of the
2660 * foreground. The callback marks an appropriate point in the activity's
2661 * lifecycle for it to dismiss any notifications that it intends to display
2662 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002663 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002664 * <p>If an activity is ever started via any non-user-driven events such as
2665 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2666 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002667 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002668 */
2669 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002670 /**
2671 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2672 * this flag will cause the launched activity to be brought to the front of its
2673 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002674 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002675 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2676 * If D calls startActivity() with an Intent that resolves to the component
2677 * of activity B, then B will be brought to the front of the history stack,
2678 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002679 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002680 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002681 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002682 */
2683 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002684 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002685 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2686 * this flag will prevent the system from applying an activity transition
2687 * animation to go to the next activity state. This doesn't mean an
2688 * animation will never run -- if another activity change happens that doesn't
2689 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002690 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002691 * when you are going to do a series of activity operations but the
2692 * animation seen by the user shouldn't be driven by the first activity
2693 * change but rather a later one.
2694 */
2695 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2696 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002697 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2698 * this flag will cause any existing task that would be associated with the
2699 * activity to be cleared before the activity is started. That is, the activity
2700 * becomes the new root of an otherwise empty task, and any old activities
2701 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2702 */
2703 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
2704 /**
2705 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2706 * this flag will cause a newly launching task to be placed on top of the current
2707 * home activity task (if there is one). That is, pressing back from the task
2708 * will always return the user to home even if that was not the last activity they
2709 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2710 */
2711 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
2712 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 * If set, when sending a broadcast only registered receivers will be
2714 * called -- no BroadcastReceiver components will be launched.
2715 */
2716 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002717 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002718 * If set, when sending a broadcast the new broadcast will replace
2719 * any existing pending broadcast that matches it. Matching is defined
2720 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2721 * true for the intents of the two broadcasts. When a match is found,
2722 * the new broadcast (and receivers associated with it) will replace the
2723 * existing one in the pending broadcast list, remaining at the same
2724 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002725 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002726 * <p>This flag is most typically used with sticky broadcasts, which
2727 * only care about delivering the most recent values of the broadcast
2728 * to their receivers.
2729 */
2730 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2731 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002732 * If set, when sending a broadcast <i>before boot has completed</i> only
2733 * registered receivers will be called -- no BroadcastReceiver components
2734 * will be launched. Sticky intent state will be recorded properly even
2735 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2736 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002737 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002738 * <p>This flag is only for use by system sevices as a convenience to
2739 * avoid having to implement a more complex mechanism around detection
2740 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002741 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002742 * @hide
2743 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002744 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002745 /**
2746 * Set when this broadcast is for a boot upgrade, a special mode that
2747 * allows the broadcast to be sent before the system is ready and launches
2748 * the app process with no providers running in it.
2749 * @hide
2750 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002751 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002752
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002753 /**
2754 * @hide Flags that can't be changed with PendingIntent.
2755 */
2756 public static final int IMMUTABLE_FLAGS =
2757 FLAG_GRANT_READ_URI_PERMISSION
2758 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002759
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002760 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002761 // ---------------------------------------------------------------------
2762 // toUri() and parseUri() options.
2763
2764 /**
2765 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2766 * always has the "intent:" scheme. This syntax can be used when you want
2767 * to later disambiguate between URIs that are intended to describe an
2768 * Intent vs. all others that should be treated as raw URIs. When used
2769 * with {@link #parseUri}, any other scheme will result in a generic
2770 * VIEW action for that raw URI.
2771 */
2772 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002773
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002774 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002775
2776 private String mAction;
2777 private Uri mData;
2778 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002779 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002780 private ComponentName mComponent;
2781 private int mFlags;
2782 private HashSet<String> mCategories;
2783 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002784 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002785
2786 // ---------------------------------------------------------------------
2787
2788 /**
2789 * Create an empty intent.
2790 */
2791 public Intent() {
2792 }
2793
2794 /**
2795 * Copy constructor.
2796 */
2797 public Intent(Intent o) {
2798 this.mAction = o.mAction;
2799 this.mData = o.mData;
2800 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002801 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002802 this.mComponent = o.mComponent;
2803 this.mFlags = o.mFlags;
2804 if (o.mCategories != null) {
2805 this.mCategories = new HashSet<String>(o.mCategories);
2806 }
2807 if (o.mExtras != null) {
2808 this.mExtras = new Bundle(o.mExtras);
2809 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002810 if (o.mSourceBounds != null) {
2811 this.mSourceBounds = new Rect(o.mSourceBounds);
2812 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002813 }
2814
2815 @Override
2816 public Object clone() {
2817 return new Intent(this);
2818 }
2819
2820 private Intent(Intent o, boolean all) {
2821 this.mAction = o.mAction;
2822 this.mData = o.mData;
2823 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002824 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002825 this.mComponent = o.mComponent;
2826 if (o.mCategories != null) {
2827 this.mCategories = new HashSet<String>(o.mCategories);
2828 }
2829 }
2830
2831 /**
2832 * Make a clone of only the parts of the Intent that are relevant for
2833 * filter matching: the action, data, type, component, and categories.
2834 */
2835 public Intent cloneFilter() {
2836 return new Intent(this, false);
2837 }
2838
2839 /**
2840 * Create an intent with a given action. All other fields (data, type,
2841 * class) are null. Note that the action <em>must</em> be in a
2842 * namespace because Intents are used globally in the system -- for
2843 * example the system VIEW action is android.intent.action.VIEW; an
2844 * application's custom action would be something like
2845 * com.google.app.myapp.CUSTOM_ACTION.
2846 *
2847 * @param action The Intent action, such as ACTION_VIEW.
2848 */
2849 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002850 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002851 }
2852
2853 /**
2854 * Create an intent with a given action and for a given data url. Note
2855 * that the action <em>must</em> be in a namespace because Intents are
2856 * used globally in the system -- for example the system VIEW action is
2857 * android.intent.action.VIEW; an application's custom action would be
2858 * something like com.google.app.myapp.CUSTOM_ACTION.
2859 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002860 * <p><em>Note: scheme and host name matching in the Android framework is
2861 * case-sensitive, unlike the formal RFC. As a result,
2862 * you should always ensure that you write your Uri with these elements
2863 * using lower case letters, and normalize any Uris you receive from
2864 * outside of Android to ensure the scheme and host is lower case.</em></p>
2865 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002866 * @param action The Intent action, such as ACTION_VIEW.
2867 * @param uri The Intent data URI.
2868 */
2869 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002870 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002871 mData = uri;
2872 }
2873
2874 /**
2875 * Create an intent for a specific component. All other fields (action, data,
2876 * type, class) are null, though they can be modified later with explicit
2877 * calls. This provides a convenient way to create an intent that is
2878 * intended to execute a hard-coded class name, rather than relying on the
2879 * system to find an appropriate class for you; see {@link #setComponent}
2880 * for more information on the repercussions of this.
2881 *
2882 * @param packageContext A Context of the application package implementing
2883 * this class.
2884 * @param cls The component class that is to be used for the intent.
2885 *
2886 * @see #setClass
2887 * @see #setComponent
2888 * @see #Intent(String, android.net.Uri , Context, Class)
2889 */
2890 public Intent(Context packageContext, Class<?> cls) {
2891 mComponent = new ComponentName(packageContext, cls);
2892 }
2893
2894 /**
2895 * Create an intent for a specific component with a specified action and data.
2896 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2897 * construct the Intent and then calling {@link #setClass} to set its
2898 * class.
2899 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002900 * <p><em>Note: scheme and host name matching in the Android framework is
2901 * case-sensitive, unlike the formal RFC. As a result,
2902 * you should always ensure that you write your Uri with these elements
2903 * using lower case letters, and normalize any Uris you receive from
2904 * outside of Android to ensure the scheme and host is lower case.</em></p>
2905 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002906 * @param action The Intent action, such as ACTION_VIEW.
2907 * @param uri The Intent data URI.
2908 * @param packageContext A Context of the application package implementing
2909 * this class.
2910 * @param cls The component class that is to be used for the intent.
2911 *
2912 * @see #Intent(String, android.net.Uri)
2913 * @see #Intent(Context, Class)
2914 * @see #setClass
2915 * @see #setComponent
2916 */
2917 public Intent(String action, Uri uri,
2918 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002919 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002920 mData = uri;
2921 mComponent = new ComponentName(packageContext, cls);
2922 }
2923
2924 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08002925 * Create an intent to launch the main (root) activity of a task. This
2926 * is the Intent that is started when the application's is launched from
2927 * Home. For anything else that wants to launch an application in the
2928 * same way, it is important that they use an Intent structured the same
2929 * way, and can use this function to ensure this is the case.
2930 *
2931 * <p>The returned Intent has the given Activity component as its explicit
2932 * component, {@link #ACTION_MAIN} as its action, and includes the
2933 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
2934 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
2935 * to do that through {@link #addFlags(int)} on the returned Intent.
2936 *
2937 * @param mainActivity The main activity component that this Intent will
2938 * launch.
2939 * @return Returns a newly created Intent that can be used to launch the
2940 * activity as a main application entry.
2941 *
2942 * @see #setClass
2943 * @see #setComponent
2944 */
2945 public static Intent makeMainActivity(ComponentName mainActivity) {
2946 Intent intent = new Intent(ACTION_MAIN);
2947 intent.setComponent(mainActivity);
2948 intent.addCategory(CATEGORY_LAUNCHER);
2949 return intent;
2950 }
2951
2952 /**
2953 * Make an Intent that can be used to re-launch an application's task
2954 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
2955 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
2956 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
2957 *
2958 * @param mainActivity The activity component that is the root of the
2959 * task; this is the activity that has been published in the application's
2960 * manifest as the main launcher icon.
2961 *
2962 * @return Returns a newly created Intent that can be used to relaunch the
2963 * activity's task in its root state.
2964 */
2965 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
2966 Intent intent = makeMainActivity(mainActivity);
2967 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
2968 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
2969 return intent;
2970 }
2971
2972 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002973 * Call {@link #parseUri} with 0 flags.
2974 * @deprecated Use {@link #parseUri} instead.
2975 */
2976 @Deprecated
2977 public static Intent getIntent(String uri) throws URISyntaxException {
2978 return parseUri(uri, 0);
2979 }
Tom Taylord4a47292009-12-21 13:59:18 -08002980
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002981 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002983 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002984 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002985 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002986 *
2987 * <p>The URI given here must not be relative -- that is, it must include
2988 * the scheme and full path.
2989 *
2990 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002991 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002992 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002993 *
2994 * @return Intent The newly created Intent object.
2995 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002996 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2997 * it bad (as parsed by the Uri class) or the Intent data within the
2998 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08002999 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003000 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003001 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003002 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003003 int i = 0;
3004 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003005 // Validate intent scheme for if requested.
3006 if ((flags&URI_INTENT_SCHEME) != 0) {
3007 if (!uri.startsWith("intent:")) {
3008 Intent intent = new Intent(ACTION_VIEW);
3009 try {
3010 intent.setData(Uri.parse(uri));
3011 } catch (IllegalArgumentException e) {
3012 throw new URISyntaxException(uri, e.getMessage());
3013 }
3014 return intent;
3015 }
3016 }
Tom Taylord4a47292009-12-21 13:59:18 -08003017
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003018 // simple case
3019 i = uri.lastIndexOf("#");
3020 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3021
3022 // old format Intent URI
3023 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003024
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003025 // new format
3026 Intent intent = new Intent(ACTION_VIEW);
3027
3028 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003029 String data = i >= 0 ? uri.substring(0, i) : null;
3030 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003031 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003032
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003033 // loop over contents of Intent, all name=value;
3034 while (!uri.startsWith("end", i)) {
3035 int eq = uri.indexOf('=', i);
3036 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003037 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003038
3039 // action
3040 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003041 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003042 }
3043
3044 // categories
3045 else if (uri.startsWith("category=", i)) {
3046 intent.addCategory(value);
3047 }
3048
3049 // type
3050 else if (uri.startsWith("type=", i)) {
3051 intent.mType = value;
3052 }
3053
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003054 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003055 else if (uri.startsWith("launchFlags=", i)) {
3056 intent.mFlags = Integer.decode(value).intValue();
3057 }
3058
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003059 // package
3060 else if (uri.startsWith("package=", i)) {
3061 intent.mPackage = value;
3062 }
3063
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003064 // component
3065 else if (uri.startsWith("component=", i)) {
3066 intent.mComponent = ComponentName.unflattenFromString(value);
3067 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003068
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003069 // scheme
3070 else if (uri.startsWith("scheme=", i)) {
3071 scheme = value;
3072 }
3073
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003074 // source bounds
3075 else if (uri.startsWith("sourceBounds=", i)) {
3076 intent.mSourceBounds = Rect.unflattenFromString(value);
3077 }
3078
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003079 // extra
3080 else {
3081 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003082 // create Bundle if it doesn't already exist
3083 if (intent.mExtras == null) intent.mExtras = new Bundle();
3084 Bundle b = intent.mExtras;
3085 // add EXTRA
3086 if (uri.startsWith("S.", i)) b.putString(key, value);
3087 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3088 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3089 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3090 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3091 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3092 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3093 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3094 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3095 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3096 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003097
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003098 // move to the next item
3099 i = semi + 1;
3100 }
3101
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003102 if (data != null) {
3103 if (data.startsWith("intent:")) {
3104 data = data.substring(7);
3105 if (scheme != null) {
3106 data = scheme + ':' + data;
3107 }
3108 }
Tom Taylord4a47292009-12-21 13:59:18 -08003109
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003110 if (data.length() > 0) {
3111 try {
3112 intent.mData = Uri.parse(data);
3113 } catch (IllegalArgumentException e) {
3114 throw new URISyntaxException(uri, e.getMessage());
3115 }
3116 }
3117 }
Tom Taylord4a47292009-12-21 13:59:18 -08003118
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003119 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003120
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003121 } catch (IndexOutOfBoundsException e) {
3122 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3123 }
3124 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003125
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126 public static Intent getIntentOld(String uri) throws URISyntaxException {
3127 Intent intent;
3128
3129 int i = uri.lastIndexOf('#');
3130 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003131 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003132 final int intentFragmentStart = i;
3133 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003134
3135 i++;
3136
3137 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003138 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003139 i += 7;
3140 int j = uri.indexOf(')', i);
3141 action = uri.substring(i, j);
3142 i = j + 1;
3143 }
3144
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003145 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003146
3147 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003148 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003149 i += 11;
3150 int j = uri.indexOf(')', i);
3151 while (i < j) {
3152 int sep = uri.indexOf('!', i);
3153 if (sep < 0) sep = j;
3154 if (i < sep) {
3155 intent.addCategory(uri.substring(i, sep));
3156 }
3157 i = sep + 1;
3158 }
3159 i = j + 1;
3160 }
3161
3162 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003163 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003164 i += 5;
3165 int j = uri.indexOf(')', i);
3166 intent.mType = uri.substring(i, j);
3167 i = j + 1;
3168 }
3169
3170 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003171 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003172 i += 12;
3173 int j = uri.indexOf(')', i);
3174 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3175 i = j + 1;
3176 }
3177
3178 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003179 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003180 i += 10;
3181 int j = uri.indexOf(')', i);
3182 int sep = uri.indexOf('!', i);
3183 if (sep >= 0 && sep < j) {
3184 String pkg = uri.substring(i, sep);
3185 String cls = uri.substring(sep + 1, j);
3186 intent.mComponent = new ComponentName(pkg, cls);
3187 }
3188 i = j + 1;
3189 }
3190
3191 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003192 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003193 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003194
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 final int closeParen = uri.indexOf(')', i);
3196 if (closeParen == -1) throw new URISyntaxException(uri,
3197 "EXTRA missing trailing ')'", i);
3198
3199 while (i < closeParen) {
3200 // fetch the key value
3201 int j = uri.indexOf('=', i);
3202 if (j <= i + 1 || i >= closeParen) {
3203 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3204 }
3205 char type = uri.charAt(i);
3206 i++;
3207 String key = uri.substring(i, j);
3208 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003209
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003210 // get type-value
3211 j = uri.indexOf('!', i);
3212 if (j == -1 || j >= closeParen) j = closeParen;
3213 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3214 String value = uri.substring(i, j);
3215 i = j;
3216
3217 // create Bundle if it doesn't already exist
3218 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003219
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003220 // add item to bundle
3221 try {
3222 switch (type) {
3223 case 'S':
3224 intent.mExtras.putString(key, Uri.decode(value));
3225 break;
3226 case 'B':
3227 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3228 break;
3229 case 'b':
3230 intent.mExtras.putByte(key, Byte.parseByte(value));
3231 break;
3232 case 'c':
3233 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3234 break;
3235 case 'd':
3236 intent.mExtras.putDouble(key, Double.parseDouble(value));
3237 break;
3238 case 'f':
3239 intent.mExtras.putFloat(key, Float.parseFloat(value));
3240 break;
3241 case 'i':
3242 intent.mExtras.putInt(key, Integer.parseInt(value));
3243 break;
3244 case 'l':
3245 intent.mExtras.putLong(key, Long.parseLong(value));
3246 break;
3247 case 's':
3248 intent.mExtras.putShort(key, Short.parseShort(value));
3249 break;
3250 default:
3251 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3252 }
3253 } catch (NumberFormatException e) {
3254 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3255 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003257 char ch = uri.charAt(i);
3258 if (ch == ')') break;
3259 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3260 i++;
3261 }
3262 }
3263
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003264 if (isIntentFragment) {
3265 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3266 } else {
3267 intent.mData = Uri.parse(uri);
3268 }
Tom Taylord4a47292009-12-21 13:59:18 -08003269
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003270 if (intent.mAction == null) {
3271 // By default, if no action is specified, then use VIEW.
3272 intent.mAction = ACTION_VIEW;
3273 }
3274
3275 } else {
3276 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3277 }
3278
3279 return intent;
3280 }
3281
3282 /**
3283 * Retrieve the general action to be performed, such as
3284 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3285 * the information in the intent should be interpreted -- most importantly,
3286 * what to do with the data returned by {@link #getData}.
3287 *
3288 * @return The action of this intent or null if none is specified.
3289 *
3290 * @see #setAction
3291 */
3292 public String getAction() {
3293 return mAction;
3294 }
3295
3296 /**
3297 * Retrieve data this intent is operating on. This URI specifies the name
3298 * of the data; often it uses the content: scheme, specifying data in a
3299 * content provider. Other schemes may be handled by specific activities,
3300 * such as http: by the web browser.
3301 *
3302 * @return The URI of the data this intent is targeting or null.
3303 *
3304 * @see #getScheme
3305 * @see #setData
3306 */
3307 public Uri getData() {
3308 return mData;
3309 }
3310
3311 /**
3312 * The same as {@link #getData()}, but returns the URI as an encoded
3313 * String.
3314 */
3315 public String getDataString() {
3316 return mData != null ? mData.toString() : null;
3317 }
3318
3319 /**
3320 * Return the scheme portion of the intent's data. If the data is null or
3321 * does not include a scheme, null is returned. Otherwise, the scheme
3322 * prefix without the final ':' is returned, i.e. "http".
3323 *
3324 * <p>This is the same as calling getData().getScheme() (and checking for
3325 * null data).
3326 *
3327 * @return The scheme of this intent.
3328 *
3329 * @see #getData
3330 */
3331 public String getScheme() {
3332 return mData != null ? mData.getScheme() : null;
3333 }
3334
3335 /**
3336 * Retrieve any explicit MIME type included in the intent. This is usually
3337 * null, as the type is determined by the intent data.
3338 *
3339 * @return If a type was manually set, it is returned; else null is
3340 * returned.
3341 *
3342 * @see #resolveType(ContentResolver)
3343 * @see #setType
3344 */
3345 public String getType() {
3346 return mType;
3347 }
3348
3349 /**
3350 * Return the MIME data type of this intent. If the type field is
3351 * explicitly set, that is simply returned. Otherwise, if the data is set,
3352 * the type of that data is returned. If neither fields are set, a null is
3353 * returned.
3354 *
3355 * @return The MIME type of this intent.
3356 *
3357 * @see #getType
3358 * @see #resolveType(ContentResolver)
3359 */
3360 public String resolveType(Context context) {
3361 return resolveType(context.getContentResolver());
3362 }
3363
3364 /**
3365 * Return the MIME data type of this intent. If the type field is
3366 * explicitly set, that is simply returned. Otherwise, if the data is set,
3367 * the type of that data is returned. If neither fields are set, a null is
3368 * returned.
3369 *
3370 * @param resolver A ContentResolver that can be used to determine the MIME
3371 * type of the intent's data.
3372 *
3373 * @return The MIME type of this intent.
3374 *
3375 * @see #getType
3376 * @see #resolveType(Context)
3377 */
3378 public String resolveType(ContentResolver resolver) {
3379 if (mType != null) {
3380 return mType;
3381 }
3382 if (mData != null) {
3383 if ("content".equals(mData.getScheme())) {
3384 return resolver.getType(mData);
3385 }
3386 }
3387 return null;
3388 }
3389
3390 /**
3391 * Return the MIME data type of this intent, only if it will be needed for
3392 * intent resolution. This is not generally useful for application code;
3393 * it is used by the frameworks for communicating with back-end system
3394 * services.
3395 *
3396 * @param resolver A ContentResolver that can be used to determine the MIME
3397 * type of the intent's data.
3398 *
3399 * @return The MIME type of this intent, or null if it is unknown or not
3400 * needed.
3401 */
3402 public String resolveTypeIfNeeded(ContentResolver resolver) {
3403 if (mComponent != null) {
3404 return mType;
3405 }
3406 return resolveType(resolver);
3407 }
3408
3409 /**
3410 * Check if an category exists in the intent.
3411 *
3412 * @param category The category to check.
3413 *
3414 * @return boolean True if the intent contains the category, else false.
3415 *
3416 * @see #getCategories
3417 * @see #addCategory
3418 */
3419 public boolean hasCategory(String category) {
3420 return mCategories != null && mCategories.contains(category);
3421 }
3422
3423 /**
3424 * Return the set of all categories in the intent. If there are no categories,
3425 * returns NULL.
3426 *
3427 * @return Set The set of categories you can examine. Do not modify!
3428 *
3429 * @see #hasCategory
3430 * @see #addCategory
3431 */
3432 public Set<String> getCategories() {
3433 return mCategories;
3434 }
3435
3436 /**
3437 * Sets the ClassLoader that will be used when unmarshalling
3438 * any Parcelable values from the extras of this Intent.
3439 *
3440 * @param loader a ClassLoader, or null to use the default loader
3441 * at the time of unmarshalling.
3442 */
3443 public void setExtrasClassLoader(ClassLoader loader) {
3444 if (mExtras != null) {
3445 mExtras.setClassLoader(loader);
3446 }
3447 }
3448
3449 /**
3450 * Returns true if an extra value is associated with the given name.
3451 * @param name the extra's name
3452 * @return true if the given extra is present.
3453 */
3454 public boolean hasExtra(String name) {
3455 return mExtras != null && mExtras.containsKey(name);
3456 }
3457
3458 /**
3459 * Returns true if the Intent's extras contain a parcelled file descriptor.
3460 * @return true if the Intent contains a parcelled file descriptor.
3461 */
3462 public boolean hasFileDescriptors() {
3463 return mExtras != null && mExtras.hasFileDescriptors();
3464 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003465
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003466 /**
3467 * Retrieve extended data from the intent.
3468 *
3469 * @param name The name of the desired item.
3470 *
3471 * @return the value of an item that previously added with putExtra()
3472 * or null if none was found.
3473 *
3474 * @deprecated
3475 * @hide
3476 */
3477 @Deprecated
3478 public Object getExtra(String name) {
3479 return getExtra(name, null);
3480 }
3481
3482 /**
3483 * Retrieve extended data from the intent.
3484 *
3485 * @param name The name of the desired item.
3486 * @param defaultValue the value to be returned if no value of the desired
3487 * type is stored with the given name.
3488 *
3489 * @return the value of an item that previously added with putExtra()
3490 * or the default value if none was found.
3491 *
3492 * @see #putExtra(String, boolean)
3493 */
3494 public boolean getBooleanExtra(String name, boolean defaultValue) {
3495 return mExtras == null ? defaultValue :
3496 mExtras.getBoolean(name, defaultValue);
3497 }
3498
3499 /**
3500 * Retrieve extended data from the intent.
3501 *
3502 * @param name The name of the desired item.
3503 * @param defaultValue the value to be returned if no value of the desired
3504 * type is stored with the given name.
3505 *
3506 * @return the value of an item that previously added with putExtra()
3507 * or the default value if none was found.
3508 *
3509 * @see #putExtra(String, byte)
3510 */
3511 public byte getByteExtra(String name, byte defaultValue) {
3512 return mExtras == null ? defaultValue :
3513 mExtras.getByte(name, defaultValue);
3514 }
3515
3516 /**
3517 * Retrieve extended data from the intent.
3518 *
3519 * @param name The name of the desired item.
3520 * @param defaultValue the value to be returned if no value of the desired
3521 * type is stored with the given name.
3522 *
3523 * @return the value of an item that previously added with putExtra()
3524 * or the default value if none was found.
3525 *
3526 * @see #putExtra(String, short)
3527 */
3528 public short getShortExtra(String name, short defaultValue) {
3529 return mExtras == null ? defaultValue :
3530 mExtras.getShort(name, defaultValue);
3531 }
3532
3533 /**
3534 * Retrieve extended data from the intent.
3535 *
3536 * @param name The name of the desired item.
3537 * @param defaultValue the value to be returned if no value of the desired
3538 * type is stored with the given name.
3539 *
3540 * @return the value of an item that previously added with putExtra()
3541 * or the default value if none was found.
3542 *
3543 * @see #putExtra(String, char)
3544 */
3545 public char getCharExtra(String name, char defaultValue) {
3546 return mExtras == null ? defaultValue :
3547 mExtras.getChar(name, defaultValue);
3548 }
3549
3550 /**
3551 * Retrieve extended data from the intent.
3552 *
3553 * @param name The name of the desired item.
3554 * @param defaultValue the value to be returned if no value of the desired
3555 * type is stored with the given name.
3556 *
3557 * @return the value of an item that previously added with putExtra()
3558 * or the default value if none was found.
3559 *
3560 * @see #putExtra(String, int)
3561 */
3562 public int getIntExtra(String name, int defaultValue) {
3563 return mExtras == null ? defaultValue :
3564 mExtras.getInt(name, defaultValue);
3565 }
3566
3567 /**
3568 * Retrieve extended data from the intent.
3569 *
3570 * @param name The name of the desired item.
3571 * @param defaultValue the value to be returned if no value of the desired
3572 * type is stored with the given name.
3573 *
3574 * @return the value of an item that previously added with putExtra()
3575 * or the default value if none was found.
3576 *
3577 * @see #putExtra(String, long)
3578 */
3579 public long getLongExtra(String name, long defaultValue) {
3580 return mExtras == null ? defaultValue :
3581 mExtras.getLong(name, defaultValue);
3582 }
3583
3584 /**
3585 * Retrieve extended data from the intent.
3586 *
3587 * @param name The name of the desired item.
3588 * @param defaultValue the value to be returned if no value of the desired
3589 * type is stored with the given name.
3590 *
3591 * @return the value of an item that previously added with putExtra(),
3592 * or the default value if no such item is present
3593 *
3594 * @see #putExtra(String, float)
3595 */
3596 public float getFloatExtra(String name, float defaultValue) {
3597 return mExtras == null ? defaultValue :
3598 mExtras.getFloat(name, defaultValue);
3599 }
3600
3601 /**
3602 * Retrieve extended data from the intent.
3603 *
3604 * @param name The name of the desired item.
3605 * @param defaultValue the value to be returned if no value of the desired
3606 * type is stored with the given name.
3607 *
3608 * @return the value of an item that previously added with putExtra()
3609 * or the default value if none was found.
3610 *
3611 * @see #putExtra(String, double)
3612 */
3613 public double getDoubleExtra(String name, double defaultValue) {
3614 return mExtras == null ? defaultValue :
3615 mExtras.getDouble(name, defaultValue);
3616 }
3617
3618 /**
3619 * Retrieve extended data from the intent.
3620 *
3621 * @param name The name of the desired item.
3622 *
3623 * @return the value of an item that previously added with putExtra()
3624 * or null if no String value was found.
3625 *
3626 * @see #putExtra(String, String)
3627 */
3628 public String getStringExtra(String name) {
3629 return mExtras == null ? null : mExtras.getString(name);
3630 }
3631
3632 /**
3633 * Retrieve extended data from the intent.
3634 *
3635 * @param name The name of the desired item.
3636 *
3637 * @return the value of an item that previously added with putExtra()
3638 * or null if no CharSequence value was found.
3639 *
3640 * @see #putExtra(String, CharSequence)
3641 */
3642 public CharSequence getCharSequenceExtra(String name) {
3643 return mExtras == null ? null : mExtras.getCharSequence(name);
3644 }
3645
3646 /**
3647 * Retrieve extended data from the intent.
3648 *
3649 * @param name The name of the desired item.
3650 *
3651 * @return the value of an item that previously added with putExtra()
3652 * or null if no Parcelable value was found.
3653 *
3654 * @see #putExtra(String, Parcelable)
3655 */
3656 public <T extends Parcelable> T getParcelableExtra(String name) {
3657 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3658 }
3659
3660 /**
3661 * Retrieve extended data from the intent.
3662 *
3663 * @param name The name of the desired item.
3664 *
3665 * @return the value of an item that previously added with putExtra()
3666 * or null if no Parcelable[] value was found.
3667 *
3668 * @see #putExtra(String, Parcelable[])
3669 */
3670 public Parcelable[] getParcelableArrayExtra(String name) {
3671 return mExtras == null ? null : mExtras.getParcelableArray(name);
3672 }
3673
3674 /**
3675 * Retrieve extended data from the intent.
3676 *
3677 * @param name The name of the desired item.
3678 *
3679 * @return the value of an item that previously added with putExtra()
3680 * or null if no ArrayList<Parcelable> value was found.
3681 *
3682 * @see #putParcelableArrayListExtra(String, ArrayList)
3683 */
3684 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3685 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3686 }
3687
3688 /**
3689 * Retrieve extended data from the intent.
3690 *
3691 * @param name The name of the desired item.
3692 *
3693 * @return the value of an item that previously added with putExtra()
3694 * or null if no Serializable value was found.
3695 *
3696 * @see #putExtra(String, Serializable)
3697 */
3698 public Serializable getSerializableExtra(String name) {
3699 return mExtras == null ? null : mExtras.getSerializable(name);
3700 }
3701
3702 /**
3703 * Retrieve extended data from the intent.
3704 *
3705 * @param name The name of the desired item.
3706 *
3707 * @return the value of an item that previously added with putExtra()
3708 * or null if no ArrayList<Integer> value was found.
3709 *
3710 * @see #putIntegerArrayListExtra(String, ArrayList)
3711 */
3712 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3713 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3714 }
3715
3716 /**
3717 * Retrieve extended data from the intent.
3718 *
3719 * @param name The name of the desired item.
3720 *
3721 * @return the value of an item that previously added with putExtra()
3722 * or null if no ArrayList<String> value was found.
3723 *
3724 * @see #putStringArrayListExtra(String, ArrayList)
3725 */
3726 public ArrayList<String> getStringArrayListExtra(String name) {
3727 return mExtras == null ? null : mExtras.getStringArrayList(name);
3728 }
3729
3730 /**
3731 * Retrieve extended data from the intent.
3732 *
3733 * @param name The name of the desired item.
3734 *
3735 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003736 * or null if no ArrayList<CharSequence> value was found.
3737 *
3738 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3739 */
3740 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3741 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3742 }
3743
3744 /**
3745 * Retrieve extended data from the intent.
3746 *
3747 * @param name The name of the desired item.
3748 *
3749 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003750 * or null if no boolean array value was found.
3751 *
3752 * @see #putExtra(String, boolean[])
3753 */
3754 public boolean[] getBooleanArrayExtra(String name) {
3755 return mExtras == null ? null : mExtras.getBooleanArray(name);
3756 }
3757
3758 /**
3759 * Retrieve extended data from the intent.
3760 *
3761 * @param name The name of the desired item.
3762 *
3763 * @return the value of an item that previously added with putExtra()
3764 * or null if no byte array value was found.
3765 *
3766 * @see #putExtra(String, byte[])
3767 */
3768 public byte[] getByteArrayExtra(String name) {
3769 return mExtras == null ? null : mExtras.getByteArray(name);
3770 }
3771
3772 /**
3773 * Retrieve extended data from the intent.
3774 *
3775 * @param name The name of the desired item.
3776 *
3777 * @return the value of an item that previously added with putExtra()
3778 * or null if no short array value was found.
3779 *
3780 * @see #putExtra(String, short[])
3781 */
3782 public short[] getShortArrayExtra(String name) {
3783 return mExtras == null ? null : mExtras.getShortArray(name);
3784 }
3785
3786 /**
3787 * Retrieve extended data from the intent.
3788 *
3789 * @param name The name of the desired item.
3790 *
3791 * @return the value of an item that previously added with putExtra()
3792 * or null if no char array value was found.
3793 *
3794 * @see #putExtra(String, char[])
3795 */
3796 public char[] getCharArrayExtra(String name) {
3797 return mExtras == null ? null : mExtras.getCharArray(name);
3798 }
3799
3800 /**
3801 * Retrieve extended data from the intent.
3802 *
3803 * @param name The name of the desired item.
3804 *
3805 * @return the value of an item that previously added with putExtra()
3806 * or null if no int array value was found.
3807 *
3808 * @see #putExtra(String, int[])
3809 */
3810 public int[] getIntArrayExtra(String name) {
3811 return mExtras == null ? null : mExtras.getIntArray(name);
3812 }
3813
3814 /**
3815 * Retrieve extended data from the intent.
3816 *
3817 * @param name The name of the desired item.
3818 *
3819 * @return the value of an item that previously added with putExtra()
3820 * or null if no long array value was found.
3821 *
3822 * @see #putExtra(String, long[])
3823 */
3824 public long[] getLongArrayExtra(String name) {
3825 return mExtras == null ? null : mExtras.getLongArray(name);
3826 }
3827
3828 /**
3829 * Retrieve extended data from the intent.
3830 *
3831 * @param name The name of the desired item.
3832 *
3833 * @return the value of an item that previously added with putExtra()
3834 * or null if no float array value was found.
3835 *
3836 * @see #putExtra(String, float[])
3837 */
3838 public float[] getFloatArrayExtra(String name) {
3839 return mExtras == null ? null : mExtras.getFloatArray(name);
3840 }
3841
3842 /**
3843 * Retrieve extended data from the intent.
3844 *
3845 * @param name The name of the desired item.
3846 *
3847 * @return the value of an item that previously added with putExtra()
3848 * or null if no double array value was found.
3849 *
3850 * @see #putExtra(String, double[])
3851 */
3852 public double[] getDoubleArrayExtra(String name) {
3853 return mExtras == null ? null : mExtras.getDoubleArray(name);
3854 }
3855
3856 /**
3857 * Retrieve extended data from the intent.
3858 *
3859 * @param name The name of the desired item.
3860 *
3861 * @return the value of an item that previously added with putExtra()
3862 * or null if no String array value was found.
3863 *
3864 * @see #putExtra(String, String[])
3865 */
3866 public String[] getStringArrayExtra(String name) {
3867 return mExtras == null ? null : mExtras.getStringArray(name);
3868 }
3869
3870 /**
3871 * Retrieve extended data from the intent.
3872 *
3873 * @param name The name of the desired item.
3874 *
3875 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003876 * or null if no CharSequence array value was found.
3877 *
3878 * @see #putExtra(String, CharSequence[])
3879 */
3880 public CharSequence[] getCharSequenceArrayExtra(String name) {
3881 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3882 }
3883
3884 /**
3885 * Retrieve extended data from the intent.
3886 *
3887 * @param name The name of the desired item.
3888 *
3889 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 * or null if no Bundle value was found.
3891 *
3892 * @see #putExtra(String, Bundle)
3893 */
3894 public Bundle getBundleExtra(String name) {
3895 return mExtras == null ? null : mExtras.getBundle(name);
3896 }
3897
3898 /**
3899 * Retrieve extended data from the intent.
3900 *
3901 * @param name The name of the desired item.
3902 *
3903 * @return the value of an item that previously added with putExtra()
3904 * or null if no IBinder value was found.
3905 *
3906 * @see #putExtra(String, IBinder)
3907 *
3908 * @deprecated
3909 * @hide
3910 */
3911 @Deprecated
3912 public IBinder getIBinderExtra(String name) {
3913 return mExtras == null ? null : mExtras.getIBinder(name);
3914 }
3915
3916 /**
3917 * Retrieve extended data from the intent.
3918 *
3919 * @param name The name of the desired item.
3920 * @param defaultValue The default value to return in case no item is
3921 * associated with the key 'name'
3922 *
3923 * @return the value of an item that previously added with putExtra()
3924 * or defaultValue if none was found.
3925 *
3926 * @see #putExtra
3927 *
3928 * @deprecated
3929 * @hide
3930 */
3931 @Deprecated
3932 public Object getExtra(String name, Object defaultValue) {
3933 Object result = defaultValue;
3934 if (mExtras != null) {
3935 Object result2 = mExtras.get(name);
3936 if (result2 != null) {
3937 result = result2;
3938 }
3939 }
3940
3941 return result;
3942 }
3943
3944 /**
3945 * Retrieves a map of extended data from the intent.
3946 *
3947 * @return the map of all extras previously added with putExtra(),
3948 * or null if none have been added.
3949 */
3950 public Bundle getExtras() {
3951 return (mExtras != null)
3952 ? new Bundle(mExtras)
3953 : null;
3954 }
3955
3956 /**
3957 * Retrieve any special flags associated with this intent. You will
3958 * normally just set them with {@link #setFlags} and let the system
3959 * take the appropriate action with them.
3960 *
3961 * @return int The currently set flags.
3962 *
3963 * @see #setFlags
3964 */
3965 public int getFlags() {
3966 return mFlags;
3967 }
3968
Dianne Hackborne7f97212011-02-24 14:40:20 -08003969 /** @hide */
3970 public boolean isExcludingStopped() {
3971 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
3972 == FLAG_EXCLUDE_STOPPED_PACKAGES;
3973 }
3974
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003976 * Retrieve the application package name this Intent is limited to. When
3977 * resolving an Intent, if non-null this limits the resolution to only
3978 * components in the given application package.
3979 *
3980 * @return The name of the application package for the Intent.
3981 *
3982 * @see #resolveActivity
3983 * @see #setPackage
3984 */
3985 public String getPackage() {
3986 return mPackage;
3987 }
3988
3989 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003990 * Retrieve the concrete component associated with the intent. When receiving
3991 * an intent, this is the component that was found to best handle it (that is,
3992 * yourself) and will always be non-null; in all other cases it will be
3993 * null unless explicitly set.
3994 *
3995 * @return The name of the application component to handle the intent.
3996 *
3997 * @see #resolveActivity
3998 * @see #setComponent
3999 */
4000 public ComponentName getComponent() {
4001 return mComponent;
4002 }
4003
4004 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004005 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4006 * used as a hint to the receiver for animations and the like. Null means that there
4007 * is no source bounds.
4008 */
4009 public Rect getSourceBounds() {
4010 return mSourceBounds;
4011 }
4012
4013 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004014 * Return the Activity component that should be used to handle this intent.
4015 * The appropriate component is determined based on the information in the
4016 * intent, evaluated as follows:
4017 *
4018 * <p>If {@link #getComponent} returns an explicit class, that is returned
4019 * without any further consideration.
4020 *
4021 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4022 * category to be considered.
4023 *
4024 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4025 * action.
4026 *
4027 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4028 * this type.
4029 *
4030 * <p>If {@link #addCategory} has added any categories, the activity must
4031 * handle ALL of the categories specified.
4032 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004033 * <p>If {@link #getPackage} is non-NULL, only activity components in
4034 * that application package will be considered.
4035 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004036 * <p>If there are no activities that satisfy all of these conditions, a
4037 * null string is returned.
4038 *
4039 * <p>If multiple activities are found to satisfy the intent, the one with
4040 * the highest priority will be used. If there are multiple activities
4041 * with the same priority, the system will either pick the best activity
4042 * based on user preference, or resolve to a system class that will allow
4043 * the user to pick an activity and forward from there.
4044 *
4045 * <p>This method is implemented simply by calling
4046 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4047 * true.</p>
4048 * <p> This API is called for you as part of starting an activity from an
4049 * intent. You do not normally need to call it yourself.</p>
4050 *
4051 * @param pm The package manager with which to resolve the Intent.
4052 *
4053 * @return Name of the component implementing an activity that can
4054 * display the intent.
4055 *
4056 * @see #setComponent
4057 * @see #getComponent
4058 * @see #resolveActivityInfo
4059 */
4060 public ComponentName resolveActivity(PackageManager pm) {
4061 if (mComponent != null) {
4062 return mComponent;
4063 }
4064
4065 ResolveInfo info = pm.resolveActivity(
4066 this, PackageManager.MATCH_DEFAULT_ONLY);
4067 if (info != null) {
4068 return new ComponentName(
4069 info.activityInfo.applicationInfo.packageName,
4070 info.activityInfo.name);
4071 }
4072
4073 return null;
4074 }
4075
4076 /**
4077 * Resolve the Intent into an {@link ActivityInfo}
4078 * describing the activity that should execute the intent. Resolution
4079 * follows the same rules as described for {@link #resolveActivity}, but
4080 * you get back the completely information about the resolved activity
4081 * instead of just its class name.
4082 *
4083 * @param pm The package manager with which to resolve the Intent.
4084 * @param flags Addition information to retrieve as per
4085 * {@link PackageManager#getActivityInfo(ComponentName, int)
4086 * PackageManager.getActivityInfo()}.
4087 *
4088 * @return PackageManager.ActivityInfo
4089 *
4090 * @see #resolveActivity
4091 */
4092 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4093 ActivityInfo ai = null;
4094 if (mComponent != null) {
4095 try {
4096 ai = pm.getActivityInfo(mComponent, flags);
4097 } catch (PackageManager.NameNotFoundException e) {
4098 // ignore
4099 }
4100 } else {
4101 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004102 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004103 if (info != null) {
4104 ai = info.activityInfo;
4105 }
4106 }
4107
4108 return ai;
4109 }
4110
4111 /**
4112 * Set the general action to be performed.
4113 *
4114 * @param action An action name, such as ACTION_VIEW. Application-specific
4115 * actions should be prefixed with the vendor's package name.
4116 *
4117 * @return Returns the same Intent object, for chaining multiple calls
4118 * into a single statement.
4119 *
4120 * @see #getAction
4121 */
4122 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004123 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004124 return this;
4125 }
4126
4127 /**
4128 * Set the data this intent is operating on. This method automatically
4129 * clears any type that was previously set by {@link #setType}.
4130 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004131 * <p><em>Note: scheme and host name matching in the Android framework is
4132 * case-sensitive, unlike the formal RFC. As a result,
4133 * you should always ensure that you write your Uri with these elements
4134 * using lower case letters, and normalize any Uris you receive from
4135 * outside of Android to ensure the scheme and host is lower case.</em></p>
4136 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004137 * @param data The URI of the data this intent is now targeting.
4138 *
4139 * @return Returns the same Intent object, for chaining multiple calls
4140 * into a single statement.
4141 *
4142 * @see #getData
4143 * @see #setType
4144 * @see #setDataAndType
4145 */
4146 public Intent setData(Uri data) {
4147 mData = data;
4148 mType = null;
4149 return this;
4150 }
4151
4152 /**
4153 * Set an explicit MIME data type. This is used to create intents that
4154 * only specify a type and not data, for example to indicate the type of
4155 * data to return. This method automatically clears any data that was
4156 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07004157 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004158 * <p><em>Note: MIME type matching in the Android framework is
4159 * case-sensitive, unlike formal RFC MIME types. As a result,
4160 * you should always write your MIME types with lower case letters,
4161 * and any MIME types you receive from outside of Android should be
4162 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004163 *
4164 * @param type The MIME type of the data being handled by this intent.
4165 *
4166 * @return Returns the same Intent object, for chaining multiple calls
4167 * into a single statement.
4168 *
4169 * @see #getType
4170 * @see #setData
4171 * @see #setDataAndType
4172 */
4173 public Intent setType(String type) {
4174 mData = null;
4175 mType = type;
4176 return this;
4177 }
4178
4179 /**
4180 * (Usually optional) Set the data for the intent along with an explicit
4181 * MIME data type. This method should very rarely be used -- it allows you
4182 * to override the MIME type that would ordinarily be inferred from the
4183 * data with your own type given here.
4184 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004185 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
4186 * Android framework is case-sensitive, unlike the formal RFC definitions.
4187 * As a result, you should always write these elements with lower case letters,
4188 * and normalize any MIME types or Uris you receive from
4189 * outside of Android to ensure these elements are lower case before
4190 * supplying them here.</em></p>
4191 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004192 * @param data The URI of the data this intent is now targeting.
4193 * @param type The MIME type of the data being handled by this intent.
4194 *
4195 * @return Returns the same Intent object, for chaining multiple calls
4196 * into a single statement.
4197 *
4198 * @see #setData
4199 * @see #setType
4200 */
4201 public Intent setDataAndType(Uri data, String type) {
4202 mData = data;
4203 mType = type;
4204 return this;
4205 }
4206
4207 /**
4208 * Add a new category to the intent. Categories provide additional detail
4209 * about the action the intent is perform. When resolving an intent, only
4210 * activities that provide <em>all</em> of the requested categories will be
4211 * used.
4212 *
4213 * @param category The desired category. This can be either one of the
4214 * predefined Intent categories, or a custom category in your own
4215 * namespace.
4216 *
4217 * @return Returns the same Intent object, for chaining multiple calls
4218 * into a single statement.
4219 *
4220 * @see #hasCategory
4221 * @see #removeCategory
4222 */
4223 public Intent addCategory(String category) {
4224 if (mCategories == null) {
4225 mCategories = new HashSet<String>();
4226 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004227 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004228 return this;
4229 }
4230
4231 /**
4232 * Remove an category from an intent.
4233 *
4234 * @param category The category to remove.
4235 *
4236 * @see #addCategory
4237 */
4238 public void removeCategory(String category) {
4239 if (mCategories != null) {
4240 mCategories.remove(category);
4241 if (mCategories.size() == 0) {
4242 mCategories = null;
4243 }
4244 }
4245 }
4246
4247 /**
4248 * Add extended data to the intent. The name must include a package
4249 * prefix, for example the app com.android.contacts would use names
4250 * like "com.android.contacts.ShowAll".
4251 *
4252 * @param name The name of the extra data, with package prefix.
4253 * @param value The boolean data value.
4254 *
4255 * @return Returns the same Intent object, for chaining multiple calls
4256 * into a single statement.
4257 *
4258 * @see #putExtras
4259 * @see #removeExtra
4260 * @see #getBooleanExtra(String, boolean)
4261 */
4262 public Intent putExtra(String name, boolean value) {
4263 if (mExtras == null) {
4264 mExtras = new Bundle();
4265 }
4266 mExtras.putBoolean(name, value);
4267 return this;
4268 }
4269
4270 /**
4271 * Add extended data to the intent. The name must include a package
4272 * prefix, for example the app com.android.contacts would use names
4273 * like "com.android.contacts.ShowAll".
4274 *
4275 * @param name The name of the extra data, with package prefix.
4276 * @param value The byte data value.
4277 *
4278 * @return Returns the same Intent object, for chaining multiple calls
4279 * into a single statement.
4280 *
4281 * @see #putExtras
4282 * @see #removeExtra
4283 * @see #getByteExtra(String, byte)
4284 */
4285 public Intent putExtra(String name, byte value) {
4286 if (mExtras == null) {
4287 mExtras = new Bundle();
4288 }
4289 mExtras.putByte(name, value);
4290 return this;
4291 }
4292
4293 /**
4294 * Add extended data to the intent. The name must include a package
4295 * prefix, for example the app com.android.contacts would use names
4296 * like "com.android.contacts.ShowAll".
4297 *
4298 * @param name The name of the extra data, with package prefix.
4299 * @param value The char data value.
4300 *
4301 * @return Returns the same Intent object, for chaining multiple calls
4302 * into a single statement.
4303 *
4304 * @see #putExtras
4305 * @see #removeExtra
4306 * @see #getCharExtra(String, char)
4307 */
4308 public Intent putExtra(String name, char value) {
4309 if (mExtras == null) {
4310 mExtras = new Bundle();
4311 }
4312 mExtras.putChar(name, value);
4313 return this;
4314 }
4315
4316 /**
4317 * Add extended data to the intent. The name must include a package
4318 * prefix, for example the app com.android.contacts would use names
4319 * like "com.android.contacts.ShowAll".
4320 *
4321 * @param name The name of the extra data, with package prefix.
4322 * @param value The short data value.
4323 *
4324 * @return Returns the same Intent object, for chaining multiple calls
4325 * into a single statement.
4326 *
4327 * @see #putExtras
4328 * @see #removeExtra
4329 * @see #getShortExtra(String, short)
4330 */
4331 public Intent putExtra(String name, short value) {
4332 if (mExtras == null) {
4333 mExtras = new Bundle();
4334 }
4335 mExtras.putShort(name, value);
4336 return this;
4337 }
4338
4339 /**
4340 * Add extended data to the intent. The name must include a package
4341 * prefix, for example the app com.android.contacts would use names
4342 * like "com.android.contacts.ShowAll".
4343 *
4344 * @param name The name of the extra data, with package prefix.
4345 * @param value The integer data value.
4346 *
4347 * @return Returns the same Intent object, for chaining multiple calls
4348 * into a single statement.
4349 *
4350 * @see #putExtras
4351 * @see #removeExtra
4352 * @see #getIntExtra(String, int)
4353 */
4354 public Intent putExtra(String name, int value) {
4355 if (mExtras == null) {
4356 mExtras = new Bundle();
4357 }
4358 mExtras.putInt(name, value);
4359 return this;
4360 }
4361
4362 /**
4363 * Add extended data to the intent. The name must include a package
4364 * prefix, for example the app com.android.contacts would use names
4365 * like "com.android.contacts.ShowAll".
4366 *
4367 * @param name The name of the extra data, with package prefix.
4368 * @param value The long data value.
4369 *
4370 * @return Returns the same Intent object, for chaining multiple calls
4371 * into a single statement.
4372 *
4373 * @see #putExtras
4374 * @see #removeExtra
4375 * @see #getLongExtra(String, long)
4376 */
4377 public Intent putExtra(String name, long value) {
4378 if (mExtras == null) {
4379 mExtras = new Bundle();
4380 }
4381 mExtras.putLong(name, value);
4382 return this;
4383 }
4384
4385 /**
4386 * Add extended data to the intent. The name must include a package
4387 * prefix, for example the app com.android.contacts would use names
4388 * like "com.android.contacts.ShowAll".
4389 *
4390 * @param name The name of the extra data, with package prefix.
4391 * @param value The float data value.
4392 *
4393 * @return Returns the same Intent object, for chaining multiple calls
4394 * into a single statement.
4395 *
4396 * @see #putExtras
4397 * @see #removeExtra
4398 * @see #getFloatExtra(String, float)
4399 */
4400 public Intent putExtra(String name, float value) {
4401 if (mExtras == null) {
4402 mExtras = new Bundle();
4403 }
4404 mExtras.putFloat(name, value);
4405 return this;
4406 }
4407
4408 /**
4409 * Add extended data to the intent. The name must include a package
4410 * prefix, for example the app com.android.contacts would use names
4411 * like "com.android.contacts.ShowAll".
4412 *
4413 * @param name The name of the extra data, with package prefix.
4414 * @param value The double data value.
4415 *
4416 * @return Returns the same Intent object, for chaining multiple calls
4417 * into a single statement.
4418 *
4419 * @see #putExtras
4420 * @see #removeExtra
4421 * @see #getDoubleExtra(String, double)
4422 */
4423 public Intent putExtra(String name, double value) {
4424 if (mExtras == null) {
4425 mExtras = new Bundle();
4426 }
4427 mExtras.putDouble(name, value);
4428 return this;
4429 }
4430
4431 /**
4432 * Add extended data to the intent. The name must include a package
4433 * prefix, for example the app com.android.contacts would use names
4434 * like "com.android.contacts.ShowAll".
4435 *
4436 * @param name The name of the extra data, with package prefix.
4437 * @param value The String data value.
4438 *
4439 * @return Returns the same Intent object, for chaining multiple calls
4440 * into a single statement.
4441 *
4442 * @see #putExtras
4443 * @see #removeExtra
4444 * @see #getStringExtra(String)
4445 */
4446 public Intent putExtra(String name, String value) {
4447 if (mExtras == null) {
4448 mExtras = new Bundle();
4449 }
4450 mExtras.putString(name, value);
4451 return this;
4452 }
4453
4454 /**
4455 * Add extended data to the intent. The name must include a package
4456 * prefix, for example the app com.android.contacts would use names
4457 * like "com.android.contacts.ShowAll".
4458 *
4459 * @param name The name of the extra data, with package prefix.
4460 * @param value The CharSequence data value.
4461 *
4462 * @return Returns the same Intent object, for chaining multiple calls
4463 * into a single statement.
4464 *
4465 * @see #putExtras
4466 * @see #removeExtra
4467 * @see #getCharSequenceExtra(String)
4468 */
4469 public Intent putExtra(String name, CharSequence value) {
4470 if (mExtras == null) {
4471 mExtras = new Bundle();
4472 }
4473 mExtras.putCharSequence(name, value);
4474 return this;
4475 }
4476
4477 /**
4478 * Add extended data to the intent. The name must include a package
4479 * prefix, for example the app com.android.contacts would use names
4480 * like "com.android.contacts.ShowAll".
4481 *
4482 * @param name The name of the extra data, with package prefix.
4483 * @param value The Parcelable data value.
4484 *
4485 * @return Returns the same Intent object, for chaining multiple calls
4486 * into a single statement.
4487 *
4488 * @see #putExtras
4489 * @see #removeExtra
4490 * @see #getParcelableExtra(String)
4491 */
4492 public Intent putExtra(String name, Parcelable value) {
4493 if (mExtras == null) {
4494 mExtras = new Bundle();
4495 }
4496 mExtras.putParcelable(name, value);
4497 return this;
4498 }
4499
4500 /**
4501 * Add extended data to the intent. The name must include a package
4502 * prefix, for example the app com.android.contacts would use names
4503 * like "com.android.contacts.ShowAll".
4504 *
4505 * @param name The name of the extra data, with package prefix.
4506 * @param value The Parcelable[] data value.
4507 *
4508 * @return Returns the same Intent object, for chaining multiple calls
4509 * into a single statement.
4510 *
4511 * @see #putExtras
4512 * @see #removeExtra
4513 * @see #getParcelableArrayExtra(String)
4514 */
4515 public Intent putExtra(String name, Parcelable[] value) {
4516 if (mExtras == null) {
4517 mExtras = new Bundle();
4518 }
4519 mExtras.putParcelableArray(name, value);
4520 return this;
4521 }
4522
4523 /**
4524 * Add extended data to the intent. The name must include a package
4525 * prefix, for example the app com.android.contacts would use names
4526 * like "com.android.contacts.ShowAll".
4527 *
4528 * @param name The name of the extra data, with package prefix.
4529 * @param value The ArrayList<Parcelable> data value.
4530 *
4531 * @return Returns the same Intent object, for chaining multiple calls
4532 * into a single statement.
4533 *
4534 * @see #putExtras
4535 * @see #removeExtra
4536 * @see #getParcelableArrayListExtra(String)
4537 */
4538 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4539 if (mExtras == null) {
4540 mExtras = new Bundle();
4541 }
4542 mExtras.putParcelableArrayList(name, value);
4543 return this;
4544 }
4545
4546 /**
4547 * Add extended data to the intent. The name must include a package
4548 * prefix, for example the app com.android.contacts would use names
4549 * like "com.android.contacts.ShowAll".
4550 *
4551 * @param name The name of the extra data, with package prefix.
4552 * @param value The ArrayList<Integer> data value.
4553 *
4554 * @return Returns the same Intent object, for chaining multiple calls
4555 * into a single statement.
4556 *
4557 * @see #putExtras
4558 * @see #removeExtra
4559 * @see #getIntegerArrayListExtra(String)
4560 */
4561 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4562 if (mExtras == null) {
4563 mExtras = new Bundle();
4564 }
4565 mExtras.putIntegerArrayList(name, value);
4566 return this;
4567 }
4568
4569 /**
4570 * Add extended data to the intent. The name must include a package
4571 * prefix, for example the app com.android.contacts would use names
4572 * like "com.android.contacts.ShowAll".
4573 *
4574 * @param name The name of the extra data, with package prefix.
4575 * @param value The ArrayList<String> data value.
4576 *
4577 * @return Returns the same Intent object, for chaining multiple calls
4578 * into a single statement.
4579 *
4580 * @see #putExtras
4581 * @see #removeExtra
4582 * @see #getStringArrayListExtra(String)
4583 */
4584 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4585 if (mExtras == null) {
4586 mExtras = new Bundle();
4587 }
4588 mExtras.putStringArrayList(name, value);
4589 return this;
4590 }
4591
4592 /**
4593 * Add extended data to the intent. The name must include a package
4594 * prefix, for example the app com.android.contacts would use names
4595 * like "com.android.contacts.ShowAll".
4596 *
4597 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004598 * @param value The ArrayList<CharSequence> data value.
4599 *
4600 * @return Returns the same Intent object, for chaining multiple calls
4601 * into a single statement.
4602 *
4603 * @see #putExtras
4604 * @see #removeExtra
4605 * @see #getCharSequenceArrayListExtra(String)
4606 */
4607 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4608 if (mExtras == null) {
4609 mExtras = new Bundle();
4610 }
4611 mExtras.putCharSequenceArrayList(name, value);
4612 return this;
4613 }
4614
4615 /**
4616 * Add extended data to the intent. The name must include a package
4617 * prefix, for example the app com.android.contacts would use names
4618 * like "com.android.contacts.ShowAll".
4619 *
4620 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004621 * @param value The Serializable data value.
4622 *
4623 * @return Returns the same Intent object, for chaining multiple calls
4624 * into a single statement.
4625 *
4626 * @see #putExtras
4627 * @see #removeExtra
4628 * @see #getSerializableExtra(String)
4629 */
4630 public Intent putExtra(String name, Serializable value) {
4631 if (mExtras == null) {
4632 mExtras = new Bundle();
4633 }
4634 mExtras.putSerializable(name, value);
4635 return this;
4636 }
4637
4638 /**
4639 * Add extended data to the intent. The name must include a package
4640 * prefix, for example the app com.android.contacts would use names
4641 * like "com.android.contacts.ShowAll".
4642 *
4643 * @param name The name of the extra data, with package prefix.
4644 * @param value The boolean array data value.
4645 *
4646 * @return Returns the same Intent object, for chaining multiple calls
4647 * into a single statement.
4648 *
4649 * @see #putExtras
4650 * @see #removeExtra
4651 * @see #getBooleanArrayExtra(String)
4652 */
4653 public Intent putExtra(String name, boolean[] value) {
4654 if (mExtras == null) {
4655 mExtras = new Bundle();
4656 }
4657 mExtras.putBooleanArray(name, value);
4658 return this;
4659 }
4660
4661 /**
4662 * Add extended data to the intent. The name must include a package
4663 * prefix, for example the app com.android.contacts would use names
4664 * like "com.android.contacts.ShowAll".
4665 *
4666 * @param name The name of the extra data, with package prefix.
4667 * @param value The byte array data value.
4668 *
4669 * @return Returns the same Intent object, for chaining multiple calls
4670 * into a single statement.
4671 *
4672 * @see #putExtras
4673 * @see #removeExtra
4674 * @see #getByteArrayExtra(String)
4675 */
4676 public Intent putExtra(String name, byte[] value) {
4677 if (mExtras == null) {
4678 mExtras = new Bundle();
4679 }
4680 mExtras.putByteArray(name, value);
4681 return this;
4682 }
4683
4684 /**
4685 * Add extended data to the intent. The name must include a package
4686 * prefix, for example the app com.android.contacts would use names
4687 * like "com.android.contacts.ShowAll".
4688 *
4689 * @param name The name of the extra data, with package prefix.
4690 * @param value The short array data value.
4691 *
4692 * @return Returns the same Intent object, for chaining multiple calls
4693 * into a single statement.
4694 *
4695 * @see #putExtras
4696 * @see #removeExtra
4697 * @see #getShortArrayExtra(String)
4698 */
4699 public Intent putExtra(String name, short[] value) {
4700 if (mExtras == null) {
4701 mExtras = new Bundle();
4702 }
4703 mExtras.putShortArray(name, value);
4704 return this;
4705 }
4706
4707 /**
4708 * Add extended data to the intent. The name must include a package
4709 * prefix, for example the app com.android.contacts would use names
4710 * like "com.android.contacts.ShowAll".
4711 *
4712 * @param name The name of the extra data, with package prefix.
4713 * @param value The char array data value.
4714 *
4715 * @return Returns the same Intent object, for chaining multiple calls
4716 * into a single statement.
4717 *
4718 * @see #putExtras
4719 * @see #removeExtra
4720 * @see #getCharArrayExtra(String)
4721 */
4722 public Intent putExtra(String name, char[] value) {
4723 if (mExtras == null) {
4724 mExtras = new Bundle();
4725 }
4726 mExtras.putCharArray(name, value);
4727 return this;
4728 }
4729
4730 /**
4731 * Add extended data to the intent. The name must include a package
4732 * prefix, for example the app com.android.contacts would use names
4733 * like "com.android.contacts.ShowAll".
4734 *
4735 * @param name The name of the extra data, with package prefix.
4736 * @param value The int array data value.
4737 *
4738 * @return Returns the same Intent object, for chaining multiple calls
4739 * into a single statement.
4740 *
4741 * @see #putExtras
4742 * @see #removeExtra
4743 * @see #getIntArrayExtra(String)
4744 */
4745 public Intent putExtra(String name, int[] value) {
4746 if (mExtras == null) {
4747 mExtras = new Bundle();
4748 }
4749 mExtras.putIntArray(name, value);
4750 return this;
4751 }
4752
4753 /**
4754 * Add extended data to the intent. The name must include a package
4755 * prefix, for example the app com.android.contacts would use names
4756 * like "com.android.contacts.ShowAll".
4757 *
4758 * @param name The name of the extra data, with package prefix.
4759 * @param value The byte array data value.
4760 *
4761 * @return Returns the same Intent object, for chaining multiple calls
4762 * into a single statement.
4763 *
4764 * @see #putExtras
4765 * @see #removeExtra
4766 * @see #getLongArrayExtra(String)
4767 */
4768 public Intent putExtra(String name, long[] value) {
4769 if (mExtras == null) {
4770 mExtras = new Bundle();
4771 }
4772 mExtras.putLongArray(name, value);
4773 return this;
4774 }
4775
4776 /**
4777 * Add extended data to the intent. The name must include a package
4778 * prefix, for example the app com.android.contacts would use names
4779 * like "com.android.contacts.ShowAll".
4780 *
4781 * @param name The name of the extra data, with package prefix.
4782 * @param value The float array data value.
4783 *
4784 * @return Returns the same Intent object, for chaining multiple calls
4785 * into a single statement.
4786 *
4787 * @see #putExtras
4788 * @see #removeExtra
4789 * @see #getFloatArrayExtra(String)
4790 */
4791 public Intent putExtra(String name, float[] value) {
4792 if (mExtras == null) {
4793 mExtras = new Bundle();
4794 }
4795 mExtras.putFloatArray(name, value);
4796 return this;
4797 }
4798
4799 /**
4800 * Add extended data to the intent. The name must include a package
4801 * prefix, for example the app com.android.contacts would use names
4802 * like "com.android.contacts.ShowAll".
4803 *
4804 * @param name The name of the extra data, with package prefix.
4805 * @param value The double array data value.
4806 *
4807 * @return Returns the same Intent object, for chaining multiple calls
4808 * into a single statement.
4809 *
4810 * @see #putExtras
4811 * @see #removeExtra
4812 * @see #getDoubleArrayExtra(String)
4813 */
4814 public Intent putExtra(String name, double[] value) {
4815 if (mExtras == null) {
4816 mExtras = new Bundle();
4817 }
4818 mExtras.putDoubleArray(name, value);
4819 return this;
4820 }
4821
4822 /**
4823 * Add extended data to the intent. The name must include a package
4824 * prefix, for example the app com.android.contacts would use names
4825 * like "com.android.contacts.ShowAll".
4826 *
4827 * @param name The name of the extra data, with package prefix.
4828 * @param value The String array data value.
4829 *
4830 * @return Returns the same Intent object, for chaining multiple calls
4831 * into a single statement.
4832 *
4833 * @see #putExtras
4834 * @see #removeExtra
4835 * @see #getStringArrayExtra(String)
4836 */
4837 public Intent putExtra(String name, String[] value) {
4838 if (mExtras == null) {
4839 mExtras = new Bundle();
4840 }
4841 mExtras.putStringArray(name, value);
4842 return this;
4843 }
4844
4845 /**
4846 * Add extended data to the intent. The name must include a package
4847 * prefix, for example the app com.android.contacts would use names
4848 * like "com.android.contacts.ShowAll".
4849 *
4850 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004851 * @param value The CharSequence array data value.
4852 *
4853 * @return Returns the same Intent object, for chaining multiple calls
4854 * into a single statement.
4855 *
4856 * @see #putExtras
4857 * @see #removeExtra
4858 * @see #getCharSequenceArrayExtra(String)
4859 */
4860 public Intent putExtra(String name, CharSequence[] value) {
4861 if (mExtras == null) {
4862 mExtras = new Bundle();
4863 }
4864 mExtras.putCharSequenceArray(name, value);
4865 return this;
4866 }
4867
4868 /**
4869 * Add extended data to the intent. The name must include a package
4870 * prefix, for example the app com.android.contacts would use names
4871 * like "com.android.contacts.ShowAll".
4872 *
4873 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 * @param value The Bundle data value.
4875 *
4876 * @return Returns the same Intent object, for chaining multiple calls
4877 * into a single statement.
4878 *
4879 * @see #putExtras
4880 * @see #removeExtra
4881 * @see #getBundleExtra(String)
4882 */
4883 public Intent putExtra(String name, Bundle value) {
4884 if (mExtras == null) {
4885 mExtras = new Bundle();
4886 }
4887 mExtras.putBundle(name, value);
4888 return this;
4889 }
4890
4891 /**
4892 * Add extended data to the intent. The name must include a package
4893 * prefix, for example the app com.android.contacts would use names
4894 * like "com.android.contacts.ShowAll".
4895 *
4896 * @param name The name of the extra data, with package prefix.
4897 * @param value The IBinder data value.
4898 *
4899 * @return Returns the same Intent object, for chaining multiple calls
4900 * into a single statement.
4901 *
4902 * @see #putExtras
4903 * @see #removeExtra
4904 * @see #getIBinderExtra(String)
4905 *
4906 * @deprecated
4907 * @hide
4908 */
4909 @Deprecated
4910 public Intent putExtra(String name, IBinder value) {
4911 if (mExtras == null) {
4912 mExtras = new Bundle();
4913 }
4914 mExtras.putIBinder(name, value);
4915 return this;
4916 }
4917
4918 /**
4919 * Copy all extras in 'src' in to this intent.
4920 *
4921 * @param src Contains the extras to copy.
4922 *
4923 * @see #putExtra
4924 */
4925 public Intent putExtras(Intent src) {
4926 if (src.mExtras != null) {
4927 if (mExtras == null) {
4928 mExtras = new Bundle(src.mExtras);
4929 } else {
4930 mExtras.putAll(src.mExtras);
4931 }
4932 }
4933 return this;
4934 }
4935
4936 /**
4937 * Add a set of extended data to the intent. The keys must include a package
4938 * prefix, for example the app com.android.contacts would use names
4939 * like "com.android.contacts.ShowAll".
4940 *
4941 * @param extras The Bundle of extras to add to this intent.
4942 *
4943 * @see #putExtra
4944 * @see #removeExtra
4945 */
4946 public Intent putExtras(Bundle extras) {
4947 if (mExtras == null) {
4948 mExtras = new Bundle();
4949 }
4950 mExtras.putAll(extras);
4951 return this;
4952 }
4953
4954 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004955 * Completely replace the extras in the Intent with the extras in the
4956 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004957 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004958 * @param src The exact extras contained in this Intent are copied
4959 * into the target intent, replacing any that were previously there.
4960 */
4961 public Intent replaceExtras(Intent src) {
4962 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4963 return this;
4964 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004965
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004966 /**
4967 * Completely replace the extras in the Intent with the given Bundle of
4968 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004969 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004970 * @param extras The new set of extras in the Intent, or null to erase
4971 * all extras.
4972 */
4973 public Intent replaceExtras(Bundle extras) {
4974 mExtras = extras != null ? new Bundle(extras) : null;
4975 return this;
4976 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004977
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004978 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004979 * Remove extended data from the intent.
4980 *
4981 * @see #putExtra
4982 */
4983 public void removeExtra(String name) {
4984 if (mExtras != null) {
4985 mExtras.remove(name);
4986 if (mExtras.size() == 0) {
4987 mExtras = null;
4988 }
4989 }
4990 }
4991
4992 /**
4993 * Set special flags controlling how this intent is handled. Most values
4994 * here depend on the type of component being executed by the Intent,
4995 * specifically the FLAG_ACTIVITY_* flags are all for use with
4996 * {@link Context#startActivity Context.startActivity()} and the
4997 * FLAG_RECEIVER_* flags are all for use with
4998 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4999 *
Scott Main7aee61f2011-02-08 11:25:01 -08005000 * <p>See the
5001 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5002 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003 * the behavior of your application.
5004 *
5005 * @param flags The desired flags.
5006 *
5007 * @return Returns the same Intent object, for chaining multiple calls
5008 * into a single statement.
5009 *
5010 * @see #getFlags
5011 * @see #addFlags
5012 *
5013 * @see #FLAG_GRANT_READ_URI_PERMISSION
5014 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5015 * @see #FLAG_DEBUG_LOG_RESOLUTION
5016 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005018 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005020 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5022 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005023 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005024 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5025 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005026 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005027 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005028 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005029 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5030 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005031 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005032 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005033 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5035 */
5036 public Intent setFlags(int flags) {
5037 mFlags = flags;
5038 return this;
5039 }
5040
5041 /**
5042 * Add additional flags to the intent (or with existing flags
5043 * value).
5044 *
5045 * @param flags The new flags to set.
5046 *
5047 * @return Returns the same Intent object, for chaining multiple calls
5048 * into a single statement.
5049 *
5050 * @see #setFlags
5051 */
5052 public Intent addFlags(int flags) {
5053 mFlags |= flags;
5054 return this;
5055 }
5056
5057 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005058 * (Usually optional) Set an explicit application package name that limits
5059 * the components this Intent will resolve to. If left to the default
5060 * value of null, all components in all applications will considered.
5061 * If non-null, the Intent can only match the components in the given
5062 * application package.
5063 *
5064 * @param packageName The name of the application package to handle the
5065 * intent, or null to allow any application package.
5066 *
5067 * @return Returns the same Intent object, for chaining multiple calls
5068 * into a single statement.
5069 *
5070 * @see #getPackage
5071 * @see #resolveActivity
5072 */
5073 public Intent setPackage(String packageName) {
5074 mPackage = packageName;
5075 return this;
5076 }
5077
5078 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005079 * (Usually optional) Explicitly set the component to handle the intent.
5080 * If left with the default value of null, the system will determine the
5081 * appropriate class to use based on the other fields (action, data,
5082 * type, categories) in the Intent. If this class is defined, the
5083 * specified class will always be used regardless of the other fields. You
5084 * should only set this value when you know you absolutely want a specific
5085 * class to be used; otherwise it is better to let the system find the
5086 * appropriate class so that you will respect the installed applications
5087 * and user preferences.
5088 *
5089 * @param component The name of the application component to handle the
5090 * intent, or null to let the system find one for you.
5091 *
5092 * @return Returns the same Intent object, for chaining multiple calls
5093 * into a single statement.
5094 *
5095 * @see #setClass
5096 * @see #setClassName(Context, String)
5097 * @see #setClassName(String, String)
5098 * @see #getComponent
5099 * @see #resolveActivity
5100 */
5101 public Intent setComponent(ComponentName component) {
5102 mComponent = component;
5103 return this;
5104 }
5105
5106 /**
5107 * Convenience for calling {@link #setComponent} with an
5108 * explicit class name.
5109 *
5110 * @param packageContext A Context of the application package implementing
5111 * this class.
5112 * @param className The name of a class inside of the application package
5113 * that will be used as the component for this Intent.
5114 *
5115 * @return Returns the same Intent object, for chaining multiple calls
5116 * into a single statement.
5117 *
5118 * @see #setComponent
5119 * @see #setClass
5120 */
5121 public Intent setClassName(Context packageContext, String className) {
5122 mComponent = new ComponentName(packageContext, className);
5123 return this;
5124 }
5125
5126 /**
5127 * Convenience for calling {@link #setComponent} with an
5128 * explicit application package name and class name.
5129 *
5130 * @param packageName The name of the package implementing the desired
5131 * component.
5132 * @param className The name of a class inside of the application package
5133 * that will be used as the component for this Intent.
5134 *
5135 * @return Returns the same Intent object, for chaining multiple calls
5136 * into a single statement.
5137 *
5138 * @see #setComponent
5139 * @see #setClass
5140 */
5141 public Intent setClassName(String packageName, String className) {
5142 mComponent = new ComponentName(packageName, className);
5143 return this;
5144 }
5145
5146 /**
5147 * Convenience for calling {@link #setComponent(ComponentName)} with the
5148 * name returned by a {@link Class} object.
5149 *
5150 * @param packageContext A Context of the application package implementing
5151 * this class.
5152 * @param cls The class name to set, equivalent to
5153 * <code>setClassName(context, cls.getName())</code>.
5154 *
5155 * @return Returns the same Intent object, for chaining multiple calls
5156 * into a single statement.
5157 *
5158 * @see #setComponent
5159 */
5160 public Intent setClass(Context packageContext, Class<?> cls) {
5161 mComponent = new ComponentName(packageContext, cls);
5162 return this;
5163 }
5164
5165 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005166 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5167 * used as a hint to the receiver for animations and the like. Null means that there
5168 * is no source bounds.
5169 */
5170 public void setSourceBounds(Rect r) {
5171 if (r != null) {
5172 mSourceBounds = new Rect(r);
5173 } else {
5174 r = null;
5175 }
5176 }
5177
5178 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005179 * Use with {@link #fillIn} to allow the current action value to be
5180 * overwritten, even if it is already set.
5181 */
5182 public static final int FILL_IN_ACTION = 1<<0;
5183
5184 /**
5185 * Use with {@link #fillIn} to allow the current data or type value
5186 * overwritten, even if it is already set.
5187 */
5188 public static final int FILL_IN_DATA = 1<<1;
5189
5190 /**
5191 * Use with {@link #fillIn} to allow the current categories to be
5192 * overwritten, even if they are already set.
5193 */
5194 public static final int FILL_IN_CATEGORIES = 1<<2;
5195
5196 /**
5197 * Use with {@link #fillIn} to allow the current component value to be
5198 * overwritten, even if it is already set.
5199 */
5200 public static final int FILL_IN_COMPONENT = 1<<3;
5201
5202 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005203 * Use with {@link #fillIn} to allow the current package value to be
5204 * overwritten, even if it is already set.
5205 */
5206 public static final int FILL_IN_PACKAGE = 1<<4;
5207
5208 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005209 * Use with {@link #fillIn} to allow the current package value to be
5210 * overwritten, even if it is already set.
5211 */
5212 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5213
5214 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005215 * Copy the contents of <var>other</var> in to this object, but only
5216 * where fields are not defined by this object. For purposes of a field
5217 * being defined, the following pieces of data in the Intent are
5218 * considered to be separate fields:
5219 *
5220 * <ul>
5221 * <li> action, as set by {@link #setAction}.
5222 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
5223 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5224 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005225 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005226 * <li> component, as set by {@link #setComponent(ComponentName)} or
5227 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005228 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 * <li> each top-level name in the associated extras.
5230 * </ul>
5231 *
5232 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005233 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5234 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005235 * corresponding field will not be replaced if it is already set.
5236 *
Brett Chabot3e391752009-07-21 16:07:23 -07005237 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
5238 * specified.
5239 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005240 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5241 * and Intent B with {action="gotit", data-type="some/thing",
5242 * categories="one","two"}.
5243 *
5244 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5245 * containing: {action="gotit", data-type="some/thing",
5246 * categories="bar"}.
5247 *
5248 * @param other Another Intent whose values are to be used to fill in
5249 * the current one.
5250 * @param flags Options to control which fields can be filled in.
5251 *
5252 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005253 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5254 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005255 */
5256 public int fillIn(Intent other, int flags) {
5257 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005258 if (other.mAction != null
5259 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005260 mAction = other.mAction;
5261 changes |= FILL_IN_ACTION;
5262 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005263 if ((other.mData != null || other.mType != null)
5264 && ((mData == null && mType == null)
5265 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 mData = other.mData;
5267 mType = other.mType;
5268 changes |= FILL_IN_DATA;
5269 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005270 if (other.mCategories != null
5271 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 if (other.mCategories != null) {
5273 mCategories = new HashSet<String>(other.mCategories);
5274 }
5275 changes |= FILL_IN_CATEGORIES;
5276 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005277 if (other.mPackage != null
5278 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5279 mPackage = other.mPackage;
5280 changes |= FILL_IN_PACKAGE;
5281 }
5282 // Component is special: it can -only- be set if explicitly allowed,
5283 // since otherwise the sender could force the intent somewhere the
5284 // originator didn't intend.
5285 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 mComponent = other.mComponent;
5287 changes |= FILL_IN_COMPONENT;
5288 }
5289 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005290 if (other.mSourceBounds != null
5291 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5292 mSourceBounds = new Rect(other.mSourceBounds);
5293 changes |= FILL_IN_SOURCE_BOUNDS;
5294 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 if (mExtras == null) {
5296 if (other.mExtras != null) {
5297 mExtras = new Bundle(other.mExtras);
5298 }
5299 } else if (other.mExtras != null) {
5300 try {
5301 Bundle newb = new Bundle(other.mExtras);
5302 newb.putAll(mExtras);
5303 mExtras = newb;
5304 } catch (RuntimeException e) {
5305 // Modifying the extras can cause us to unparcel the contents
5306 // of the bundle, and if we do this in the system process that
5307 // may fail. We really should handle this (i.e., the Bundle
5308 // impl shouldn't be on top of a plain map), but for now just
5309 // ignore it and keep the original contents. :(
5310 Log.w("Intent", "Failure filling in extras", e);
5311 }
5312 }
5313 return changes;
5314 }
5315
5316 /**
5317 * Wrapper class holding an Intent and implementing comparisons on it for
5318 * the purpose of filtering. The class implements its
5319 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5320 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5321 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5322 * on the wrapped Intent.
5323 */
5324 public static final class FilterComparison {
5325 private final Intent mIntent;
5326 private final int mHashCode;
5327
5328 public FilterComparison(Intent intent) {
5329 mIntent = intent;
5330 mHashCode = intent.filterHashCode();
5331 }
5332
5333 /**
5334 * Return the Intent that this FilterComparison represents.
5335 * @return Returns the Intent held by the FilterComparison. Do
5336 * not modify!
5337 */
5338 public Intent getIntent() {
5339 return mIntent;
5340 }
5341
5342 @Override
5343 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005344 if (obj instanceof FilterComparison) {
5345 Intent other = ((FilterComparison)obj).mIntent;
5346 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005347 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005348 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005349 }
5350
5351 @Override
5352 public int hashCode() {
5353 return mHashCode;
5354 }
5355 }
5356
5357 /**
5358 * Determine if two intents are the same for the purposes of intent
5359 * resolution (filtering). That is, if their action, data, type,
5360 * class, and categories are the same. This does <em>not</em> compare
5361 * any extra data included in the intents.
5362 *
5363 * @param other The other Intent to compare against.
5364 *
5365 * @return Returns true if action, data, type, class, and categories
5366 * are the same.
5367 */
5368 public boolean filterEquals(Intent other) {
5369 if (other == null) {
5370 return false;
5371 }
5372 if (mAction != other.mAction) {
5373 if (mAction != null) {
5374 if (!mAction.equals(other.mAction)) {
5375 return false;
5376 }
5377 } else {
5378 if (!other.mAction.equals(mAction)) {
5379 return false;
5380 }
5381 }
5382 }
5383 if (mData != other.mData) {
5384 if (mData != null) {
5385 if (!mData.equals(other.mData)) {
5386 return false;
5387 }
5388 } else {
5389 if (!other.mData.equals(mData)) {
5390 return false;
5391 }
5392 }
5393 }
5394 if (mType != other.mType) {
5395 if (mType != null) {
5396 if (!mType.equals(other.mType)) {
5397 return false;
5398 }
5399 } else {
5400 if (!other.mType.equals(mType)) {
5401 return false;
5402 }
5403 }
5404 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005405 if (mPackage != other.mPackage) {
5406 if (mPackage != null) {
5407 if (!mPackage.equals(other.mPackage)) {
5408 return false;
5409 }
5410 } else {
5411 if (!other.mPackage.equals(mPackage)) {
5412 return false;
5413 }
5414 }
5415 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005416 if (mComponent != other.mComponent) {
5417 if (mComponent != null) {
5418 if (!mComponent.equals(other.mComponent)) {
5419 return false;
5420 }
5421 } else {
5422 if (!other.mComponent.equals(mComponent)) {
5423 return false;
5424 }
5425 }
5426 }
5427 if (mCategories != other.mCategories) {
5428 if (mCategories != null) {
5429 if (!mCategories.equals(other.mCategories)) {
5430 return false;
5431 }
5432 } else {
5433 if (!other.mCategories.equals(mCategories)) {
5434 return false;
5435 }
5436 }
5437 }
5438
5439 return true;
5440 }
5441
5442 /**
5443 * Generate hash code that matches semantics of filterEquals().
5444 *
5445 * @return Returns the hash value of the action, data, type, class, and
5446 * categories.
5447 *
5448 * @see #filterEquals
5449 */
5450 public int filterHashCode() {
5451 int code = 0;
5452 if (mAction != null) {
5453 code += mAction.hashCode();
5454 }
5455 if (mData != null) {
5456 code += mData.hashCode();
5457 }
5458 if (mType != null) {
5459 code += mType.hashCode();
5460 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005461 if (mPackage != null) {
5462 code += mPackage.hashCode();
5463 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005464 if (mComponent != null) {
5465 code += mComponent.hashCode();
5466 }
5467 if (mCategories != null) {
5468 code += mCategories.hashCode();
5469 }
5470 return code;
5471 }
5472
5473 @Override
5474 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005475 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005476
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005477 b.append("Intent { ");
5478 toShortString(b, true, true);
5479 b.append(" }");
5480
5481 return b.toString();
5482 }
5483
5484 /** @hide */
5485 public String toShortString(boolean comp, boolean extras) {
5486 StringBuilder b = new StringBuilder(128);
5487 toShortString(b, comp, extras);
5488 return b.toString();
5489 }
Romain Guy4969af72009-06-17 10:53:19 -07005490
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005491 /** @hide */
5492 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5493 boolean first = true;
5494 if (mAction != null) {
5495 b.append("act=").append(mAction);
5496 first = false;
5497 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005498 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005499 if (!first) {
5500 b.append(' ');
5501 }
5502 first = false;
5503 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005504 Iterator<String> i = mCategories.iterator();
5505 boolean didone = false;
5506 while (i.hasNext()) {
5507 if (didone) b.append(",");
5508 didone = true;
5509 b.append(i.next());
5510 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005511 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005512 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005513 if (mData != null) {
5514 if (!first) {
5515 b.append(' ');
5516 }
5517 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005518 b.append("dat=");
Wink Savillec491ee02010-10-13 11:40:10 -07005519 String scheme = mData.getScheme();
5520 if (scheme != null) {
5521 if (scheme.equalsIgnoreCase("tel")) {
5522 b.append("tel:xxx-xxx-xxxx");
5523 } else if (scheme.equalsIgnoreCase("smsto")) {
5524 b.append("smsto:xxx-xxx-xxxx");
5525 } else {
5526 b.append(mData);
5527 }
Wink Savillea4288072010-10-12 12:36:38 -07005528 } else {
5529 b.append(mData);
5530 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005531 }
5532 if (mType != null) {
5533 if (!first) {
5534 b.append(' ');
5535 }
5536 first = false;
5537 b.append("typ=").append(mType);
5538 }
5539 if (mFlags != 0) {
5540 if (!first) {
5541 b.append(' ');
5542 }
5543 first = false;
5544 b.append("flg=0x").append(Integer.toHexString(mFlags));
5545 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005546 if (mPackage != null) {
5547 if (!first) {
5548 b.append(' ');
5549 }
5550 first = false;
5551 b.append("pkg=").append(mPackage);
5552 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005553 if (comp && mComponent != null) {
5554 if (!first) {
5555 b.append(' ');
5556 }
5557 first = false;
5558 b.append("cmp=").append(mComponent.flattenToShortString());
5559 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005560 if (mSourceBounds != null) {
5561 if (!first) {
5562 b.append(' ');
5563 }
5564 first = false;
5565 b.append("bnds=").append(mSourceBounds.toShortString());
5566 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005567 if (extras && mExtras != null) {
5568 if (!first) {
5569 b.append(' ');
5570 }
5571 first = false;
5572 b.append("(has extras)");
5573 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005574 }
5575
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005576 /**
5577 * Call {@link #toUri} with 0 flags.
5578 * @deprecated Use {@link #toUri} instead.
5579 */
5580 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005581 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005582 return toUri(0);
5583 }
5584
5585 /**
5586 * Convert this Intent into a String holding a URI representation of it.
5587 * The returned URI string has been properly URI encoded, so it can be
5588 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5589 * Intent's data as the base URI, with an additional fragment describing
5590 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005591 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005592 * <p>You can convert the returned string back to an Intent with
5593 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005594 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005595 * @param flags Additional operating flags. Either 0 or
5596 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005597 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005598 * @return Returns a URI encoding URI string describing the entire contents
5599 * of the Intent.
5600 */
5601 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005602 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005603 String scheme = null;
5604 if (mData != null) {
5605 String data = mData.toString();
5606 if ((flags&URI_INTENT_SCHEME) != 0) {
5607 final int N = data.length();
5608 for (int i=0; i<N; i++) {
5609 char c = data.charAt(i);
5610 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5611 || c == '.' || c == '-') {
5612 continue;
5613 }
5614 if (c == ':' && i > 0) {
5615 // Valid scheme.
5616 scheme = data.substring(0, i);
5617 uri.append("intent:");
5618 data = data.substring(i+1);
5619 break;
5620 }
Tom Taylord4a47292009-12-21 13:59:18 -08005621
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005622 // No scheme.
5623 break;
5624 }
5625 }
5626 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005627
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005628 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5629 uri.append("intent:");
5630 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005631
5632 uri.append("#Intent;");
5633
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005634 if (scheme != null) {
5635 uri.append("scheme=").append(scheme).append(';');
5636 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005637 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005638 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005639 }
5640 if (mCategories != null) {
5641 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005642 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005643 }
5644 }
5645 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005646 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005647 }
5648 if (mFlags != 0) {
5649 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5650 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005651 if (mPackage != null) {
5652 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5653 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005654 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005655 uri.append("component=").append(Uri.encode(
5656 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005657 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005658 if (mSourceBounds != null) {
5659 uri.append("sourceBounds=")
5660 .append(Uri.encode(mSourceBounds.flattenToString()))
5661 .append(';');
5662 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005663 if (mExtras != null) {
5664 for (String key : mExtras.keySet()) {
5665 final Object value = mExtras.get(key);
5666 char entryType =
5667 value instanceof String ? 'S' :
5668 value instanceof Boolean ? 'B' :
5669 value instanceof Byte ? 'b' :
5670 value instanceof Character ? 'c' :
5671 value instanceof Double ? 'd' :
5672 value instanceof Float ? 'f' :
5673 value instanceof Integer ? 'i' :
5674 value instanceof Long ? 'l' :
5675 value instanceof Short ? 's' :
5676 '\0';
5677
5678 if (entryType != '\0') {
5679 uri.append(entryType);
5680 uri.append('.');
5681 uri.append(Uri.encode(key));
5682 uri.append('=');
5683 uri.append(Uri.encode(value.toString()));
5684 uri.append(';');
5685 }
5686 }
5687 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005689 uri.append("end");
5690
5691 return uri.toString();
5692 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005693
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005694 public int describeContents() {
5695 return (mExtras != null) ? mExtras.describeContents() : 0;
5696 }
5697
5698 public void writeToParcel(Parcel out, int flags) {
5699 out.writeString(mAction);
5700 Uri.writeToParcel(out, mData);
5701 out.writeString(mType);
5702 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005703 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005704 ComponentName.writeToParcel(mComponent, out);
5705
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005706 if (mSourceBounds != null) {
5707 out.writeInt(1);
5708 mSourceBounds.writeToParcel(out, flags);
5709 } else {
5710 out.writeInt(0);
5711 }
5712
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005713 if (mCategories != null) {
5714 out.writeInt(mCategories.size());
5715 for (String category : mCategories) {
5716 out.writeString(category);
5717 }
5718 } else {
5719 out.writeInt(0);
5720 }
5721
5722 out.writeBundle(mExtras);
5723 }
5724
5725 public static final Parcelable.Creator<Intent> CREATOR
5726 = new Parcelable.Creator<Intent>() {
5727 public Intent createFromParcel(Parcel in) {
5728 return new Intent(in);
5729 }
5730 public Intent[] newArray(int size) {
5731 return new Intent[size];
5732 }
5733 };
5734
Dianne Hackborneb034652009-09-07 00:49:58 -07005735 /** @hide */
5736 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 readFromParcel(in);
5738 }
5739
5740 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005741 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005742 mData = Uri.CREATOR.createFromParcel(in);
5743 mType = in.readString();
5744 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005745 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005746 mComponent = ComponentName.readFromParcel(in);
5747
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005748 if (in.readInt() != 0) {
5749 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5750 }
5751
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005752 int N = in.readInt();
5753 if (N > 0) {
5754 mCategories = new HashSet<String>();
5755 int i;
5756 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005757 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005758 }
5759 } else {
5760 mCategories = null;
5761 }
5762
5763 mExtras = in.readBundle();
5764 }
5765
5766 /**
5767 * Parses the "intent" element (and its children) from XML and instantiates
5768 * an Intent object. The given XML parser should be located at the tag
5769 * where parsing should start (often named "intent"), from which the
5770 * basic action, data, type, and package and class name will be
5771 * retrieved. The function will then parse in to any child elements,
5772 * looking for <category android:name="xxx"> tags to add categories and
5773 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5774 * to the intent.
5775 *
5776 * @param resources The Resources to use when inflating resources.
5777 * @param parser The XML parser pointing at an "intent" tag.
5778 * @param attrs The AttributeSet interface for retrieving extended
5779 * attribute data at the current <var>parser</var> location.
5780 * @return An Intent object matching the XML data.
5781 * @throws XmlPullParserException If there was an XML parsing error.
5782 * @throws IOException If there was an I/O error.
5783 */
5784 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5785 throws XmlPullParserException, IOException {
5786 Intent intent = new Intent();
5787
5788 TypedArray sa = resources.obtainAttributes(attrs,
5789 com.android.internal.R.styleable.Intent);
5790
5791 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5792
5793 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5794 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5795 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5796
5797 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5798 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5799 if (packageName != null && className != null) {
5800 intent.setComponent(new ComponentName(packageName, className));
5801 }
5802
5803 sa.recycle();
5804
5805 int outerDepth = parser.getDepth();
5806 int type;
5807 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5808 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5809 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5810 continue;
5811 }
5812
5813 String nodeName = parser.getName();
5814 if (nodeName.equals("category")) {
5815 sa = resources.obtainAttributes(attrs,
5816 com.android.internal.R.styleable.IntentCategory);
5817 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5818 sa.recycle();
5819
5820 if (cat != null) {
5821 intent.addCategory(cat);
5822 }
5823 XmlUtils.skipCurrentTag(parser);
5824
5825 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005826 if (intent.mExtras == null) {
5827 intent.mExtras = new Bundle();
5828 }
5829 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5830 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005831
5832 } else {
5833 XmlUtils.skipCurrentTag(parser);
5834 }
5835 }
5836
5837 return intent;
5838 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005839}