blob: 7bdd1b9df82b1e6b01302413447e0a61bd212d09 [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 /**
1881 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1882 *
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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 * Broadcast Action: An outgoing call is about to be placed.
1912 *
1913 * <p>The Intent will have the following extra value:
1914 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001915 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001916 * the phone number originally intended to be dialed.</li>
1917 * </ul>
1918 * <p>Once the broadcast is finished, the resultData is used as the actual
1919 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001920 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001921 * outgoing call in turn: for example, a parental control application
1922 * might verify that the user is authorized to place the call at that
1923 * time, then a number-rewriting application might add an area code if
1924 * one was not specified.</p>
1925 * <p>For consistency, any receiver whose purpose is to prohibit phone
1926 * calls should have a priority of 0, to ensure it will see the final
1927 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001928 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001929 * should have a positive priority.
1930 * Negative priorities are reserved for the system for this broadcast;
1931 * using them may cause problems.</p>
1932 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1933 * abort the broadcast.</p>
1934 * <p>Emergency calls cannot be intercepted using this mechanism, and
1935 * other calls cannot be modified to call emergency numbers using this
1936 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001937 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1939 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08001940 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001941 * <p class="note">This is a protected intent that can only be sent
1942 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_NEW_OUTGOING_CALL =
1946 "android.intent.action.NEW_OUTGOING_CALL";
1947
1948 /**
1949 * Broadcast Action: Have the device reboot. This is only for use by
1950 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08001951 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001952 * <p class="note">This is a protected intent that can only be sent
1953 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_REBOOT =
1957 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001958
Wei Huang97ecc9c2009-05-11 17:44:20 -07001959 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08001960 * Broadcast Action: A sticky broadcast for changes in the physical
1961 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08001962 *
1963 * <p>The intent will have the following extra values:
1964 * <ul>
1965 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08001966 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08001967 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08001968 * <p>This is intended for monitoring the current physical dock state.
1969 * See {@link android.app.UiModeManager} for the normal API dealing with
1970 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_DOCK_EVENT =
1974 "android.intent.action.DOCK_EVENT";
1975
1976 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001977 * Broadcast Action: a remote intent is to be broadcasted.
1978 *
1979 * A remote intent is used for remote RPC between devices. The remote intent
1980 * is serialized and sent from one device to another device. The receiving
1981 * device parses the remote intent and broadcasts it. Note that anyone can
1982 * broadcast a remote intent. However, if the intent receiver of the remote intent
1983 * does not trust intent broadcasts from arbitrary intent senders, it should require
1984 * the sender to hold certain permissions so only trusted sender's broadcast will be
1985 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001986 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07001987 */
1988 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07001989 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07001990
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001991 /**
1992 * Broadcast Action: hook for permforming cleanup after a system update.
1993 *
1994 * The broadcast is sent when the system is booting, before the
1995 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1996 * image. A receiver for this should do its work and then disable itself
1997 * so that it does not get run again at the next boot.
1998 * @hide
1999 */
2000 public static final String ACTION_PRE_BOOT_COMPLETED =
2001 "android.intent.action.PRE_BOOT_COMPLETED";
2002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 // ---------------------------------------------------------------------
2004 // ---------------------------------------------------------------------
2005 // Standard intent categories (see addCategory()).
2006
2007 /**
2008 * Set if the activity should be an option for the default action
2009 * (center press) to perform on a piece of data. Setting this will
2010 * hide from the user any activities without it set when performing an
2011 * action on some data. Note that this is normal -not- set in the
2012 * Intent when initiating an action -- it is for use in intent filters
2013 * specified in packages.
2014 */
2015 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2016 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2017 /**
2018 * Activities that can be safely invoked from a browser must support this
2019 * category. For example, if the user is viewing a web page or an e-mail
2020 * and clicks on a link in the text, the Intent generated execute that
2021 * link will require the BROWSABLE category, so that only activities
2022 * supporting this category will be considered as possible actions. By
2023 * supporting this category, you are promising that there is nothing
2024 * damaging (without user intervention) that can happen by invoking any
2025 * matching Intent.
2026 */
2027 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2028 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2029 /**
2030 * Set if the activity should be considered as an alternative action to
2031 * the data the user is currently viewing. See also
2032 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2033 * applies to the selection in a list of items.
2034 *
2035 * <p>Supporting this category means that you would like your activity to be
2036 * displayed in the set of alternative things the user can do, usually as
2037 * part of the current activity's options menu. You will usually want to
2038 * include a specific label in the &lt;intent-filter&gt; of this action
2039 * describing to the user what it does.
2040 *
2041 * <p>The action of IntentFilter with this category is important in that it
2042 * describes the specific action the target will perform. This generally
2043 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2044 * a specific name such as "com.android.camera.action.CROP. Only one
2045 * alternative of any particular action will be shown to the user, so using
2046 * a specific action like this makes sure that your alternative will be
2047 * displayed while also allowing other applications to provide their own
2048 * overrides of that particular action.
2049 */
2050 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2051 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2052 /**
2053 * Set if the activity should be considered as an alternative selection
2054 * action to the data the user has currently selected. This is like
2055 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2056 * of items from which the user can select, giving them alternatives to the
2057 * default action that will be performed on it.
2058 */
2059 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2060 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2061 /**
2062 * Intended to be used as a tab inside of an containing TabActivity.
2063 */
2064 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2065 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2066 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 * Should be displayed in the top-level launcher.
2068 */
2069 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2070 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2071 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002072 * Provides information about the package it is in; typically used if
2073 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2074 * a front-door to the user without having to be shown in the all apps list.
2075 */
2076 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2077 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2078 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002079 * This is the home activity, that is the first activity that is displayed
2080 * when the device boots.
2081 */
2082 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2083 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2084 /**
2085 * This activity is a preference panel.
2086 */
2087 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2088 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2089 /**
2090 * This activity is a development preference panel.
2091 */
2092 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2093 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2094 /**
2095 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 */
2097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2098 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2099 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002100 * This activity allows the user to browse and download new applications.
2101 */
2102 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2103 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2104 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 * This activity may be exercised by the monkey or other automated test tools.
2106 */
2107 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2108 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2109 /**
2110 * To be used as a test (not part of the normal user experience).
2111 */
2112 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2113 /**
2114 * To be used as a unit test (run through the Test Harness).
2115 */
2116 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2117 /**
2118 * To be used as an sample code example (not part of the normal user
2119 * experience).
2120 */
2121 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2122 /**
2123 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2124 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2125 * when queried, though it is allowable for those columns to be blank.
2126 */
2127 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2128 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2129
2130 /**
2131 * To be used as code under test for framework instrumentation tests.
2132 */
2133 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2134 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002135 /**
2136 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002137 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2138 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002139 */
2140 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2141 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2142 /**
2143 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002144 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2145 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002146 */
2147 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2148 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002149 /**
2150 * An activity to run when device is inserted into a analog (low end) dock.
2151 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2152 * information, see {@link android.app.UiModeManager}.
2153 */
2154 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2155 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2156
2157 /**
2158 * An activity to run when device is inserted into a digital (high end) dock.
2159 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2160 * information, see {@link android.app.UiModeManager}.
2161 */
2162 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2163 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002164
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002165 /**
2166 * Used to indicate that the activity can be used in a car environment.
2167 */
2168 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2169 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2170
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002171 // ---------------------------------------------------------------------
2172 // ---------------------------------------------------------------------
2173 // Standard extra data keys.
2174
2175 /**
2176 * The initial data to place in a newly created record. Use with
2177 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2178 * fields as would be given to the underlying ContentProvider.insert()
2179 * call.
2180 */
2181 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2182
2183 /**
2184 * A constant CharSequence that is associated with the Intent, used with
2185 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2186 * this may be a styled CharSequence, so you must use
2187 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2188 * retrieve it.
2189 */
2190 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2191
2192 /**
2193 * A content: URI holding a stream of data associated with the Intent,
2194 * used with {@link #ACTION_SEND} to supply the data being sent.
2195 */
2196 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2197
2198 /**
2199 * A String[] holding e-mail addresses that should be delivered to.
2200 */
2201 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2202
2203 /**
2204 * A String[] holding e-mail addresses that should be carbon copied.
2205 */
2206 public static final String EXTRA_CC = "android.intent.extra.CC";
2207
2208 /**
2209 * A String[] holding e-mail addresses that should be blind carbon copied.
2210 */
2211 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2212
2213 /**
2214 * A constant string holding the desired subject line of a message.
2215 */
2216 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2217
2218 /**
2219 * An Intent describing the choices you would like shown with
2220 * {@link #ACTION_PICK_ACTIVITY}.
2221 */
2222 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2223
2224 /**
2225 * A CharSequence dialog title to provide to the user when used with a
2226 * {@link #ACTION_CHOOSER}.
2227 */
2228 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2229
2230 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002231 * A Parcelable[] of {@link Intent} or
2232 * {@link android.content.pm.LabeledIntent} objects as set with
2233 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2234 * a the front of the list of choices, when shown to the user with a
2235 * {@link #ACTION_CHOOSER}.
2236 */
2237 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2238
2239 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002240 * A {@link android.view.KeyEvent} object containing the event that
2241 * triggered the creation of the Intent it is in.
2242 */
2243 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2244
2245 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002246 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2247 * before shutting down.
2248 *
2249 * {@hide}
2250 */
2251 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2252
2253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002254 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2255 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2256 * of restarting the application.
2257 */
2258 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2259
2260 /**
2261 * A String holding the phone number originally entered in
2262 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2263 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2264 */
2265 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002266
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002267 /**
2268 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2269 * intents to supply the uid the package had been assigned. Also an optional
2270 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2271 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2272 * purpose.
2273 */
2274 public static final String EXTRA_UID = "android.intent.extra.UID";
2275
2276 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002277 * @hide String array of package names.
2278 */
2279 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2280
2281 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002282 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2283 * intents to indicate whether this represents a full uninstall (removing
2284 * both the code and its data) or a partial uninstall (leaving its data,
2285 * implying that this is an update).
2286 */
2287 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002288
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002289 /**
2290 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2291 * intents to indicate that this is a replacement of the package, so this
2292 * broadcast will immediately be followed by an add broadcast for a
2293 * different version of the same package.
2294 */
2295 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002296
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002297 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 * Used as an int extra field in {@link android.app.AlarmManager} intents
2299 * to tell the application being invoked how many pending alarms are being
2300 * delievered with the intent. For one-shot alarms this will always be 1.
2301 * For recurring alarms, this might be greater than 1 if the device was
2302 * asleep or powered off at the time an earlier alarm would have been
2303 * delivered.
2304 */
2305 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002306
Jacek Surazski86b6c532009-05-13 14:38:28 +02002307 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002308 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2309 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002310 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2311 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002312 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2313 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2314 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002315 */
2316 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2317
2318 /**
2319 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2320 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002321 */
2322 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2323
2324 /**
2325 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2326 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002327 */
2328 public static final int EXTRA_DOCK_STATE_DESK = 1;
2329
2330 /**
2331 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2332 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002333 */
2334 public static final int EXTRA_DOCK_STATE_CAR = 2;
2335
2336 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002337 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2338 * to represent that the phone is in a analog (low end) dock.
2339 */
2340 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2341
2342 /**
2343 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2344 * to represent that the phone is in a digital (high end) dock.
2345 */
2346 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2347
2348 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002349 * Boolean that can be supplied as meta-data with a dock activity, to
2350 * indicate that the dock should take over the home key when it is active.
2351 */
2352 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002353
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002354 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002355 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2356 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002357 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002358 * @hide
2359 */
2360 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2361
2362 /**
Romain Guy4969af72009-06-17 10:53:19 -07002363 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002364 * package. Specifies the installer package name; this package will receive the
2365 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002366 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002367 * @hide
2368 */
Romain Guy4969af72009-06-17 10:53:19 -07002369 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002370 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002371
Wei Huang97ecc9c2009-05-11 17:44:20 -07002372 /**
2373 * Used in the extra field in the remote intent. It's astring token passed with the
2374 * remote intent.
2375 */
2376 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2377 "android.intent.extra.remote_intent_token";
2378
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002379 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002380 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002381 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002382 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002383 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002384 "android.intent.extra.changed_component_name";
2385
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002386 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002387 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002388 * and contains a string array of all of the components that have changed.
2389 */
2390 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2391 "android.intent.extra.changed_component_name_list";
2392
2393 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002394 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002395 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2396 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002397 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002398 */
2399 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2400 "android.intent.extra.changed_package_list";
2401
2402 /**
2403 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002404 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2405 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002406 * and contains an integer array of uids of all of the components
2407 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002408 */
2409 public static final String EXTRA_CHANGED_UID_LIST =
2410 "android.intent.extra.changed_uid_list";
2411
2412 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002413 * @hide
2414 * Magic extra system code can use when binding, to give a label for
2415 * who it is that has bound to a service. This is an integer giving
2416 * a framework string resource that can be displayed to the user.
2417 */
2418 public static final String EXTRA_CLIENT_LABEL =
2419 "android.intent.extra.client_label";
2420
2421 /**
2422 * @hide
2423 * Magic extra system code can use when binding, to give a PendingIntent object
2424 * that can be launched for the user to disable the system's use of this
2425 * service.
2426 */
2427 public static final String EXTRA_CLIENT_INTENT =
2428 "android.intent.extra.client_intent";
2429
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002430 /**
2431 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2432 * data that is on the local device. This is a boolean extra; the default
2433 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2434 * the user to select media that is already on the device, not requiring it
2435 * be downloaded from a remote service when opened. Another way to look
2436 * at it is that such content should generally have a "_data" column to the
2437 * path of the content on local external storage.
2438 */
2439 public static final String EXTRA_LOCAL_ONLY =
2440 "android.intent.extra.LOCAL_ONLY";
2441
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002442 // ---------------------------------------------------------------------
2443 // ---------------------------------------------------------------------
2444 // Intent flags (see mFlags variable).
2445
2446 /**
2447 * If set, the recipient of this Intent will be granted permission to
2448 * perform read operations on the Uri in the Intent's data.
2449 */
2450 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2451 /**
2452 * If set, the recipient of this Intent will be granted permission to
2453 * perform write operations on the Uri in the Intent's data.
2454 */
2455 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2456 /**
2457 * Can be set by the caller to indicate that this Intent is coming from
2458 * a background operation, not from direct user interaction.
2459 */
2460 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2461 /**
2462 * A flag you can enable for debugging: when set, log messages will be
2463 * printed during the resolution of this intent to show you what has
2464 * been found to create the final resolved list.
2465 */
2466 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002467 /**
2468 * If set, this intent will not match any components in packages that
2469 * are currently stopped. If this is not set, then the default behavior
2470 * is to include such applications in the result.
2471 */
2472 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2473 /**
2474 * If set, this intent will always match any components in packages that
2475 * are currently stopped. This is the default behavior when
2476 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2477 * flags are set, this one wins (it allows overriding of exclude for
2478 * places where the framework may automatically set the exclude flag).
2479 */
2480 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481
2482 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002483 * If set, the new activity is not kept in the history stack. As soon as
2484 * the user navigates away from it, the activity is finished. This may also
2485 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2486 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002487 */
2488 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2489 /**
2490 * If set, the activity will not be launched if it is already running
2491 * at the top of the history stack.
2492 */
2493 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2494 /**
2495 * If set, this activity will become the start of a new task on this
2496 * history stack. A task (from the activity that started it to the
2497 * next task activity) defines an atomic group of activities that the
2498 * user can move to. Tasks can be moved to the foreground and background;
2499 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002500 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002501 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2502 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002503 *
2504 * <p>This flag is generally used by activities that want
2505 * to present a "launcher" style behavior: they give the user a list of
2506 * separate things that can be done, which otherwise run completely
2507 * independently of the activity launching them.
2508 *
2509 * <p>When using this flag, if a task is already running for the activity
2510 * you are now starting, then a new activity will not be started; instead,
2511 * the current task will simply be brought to the front of the screen with
2512 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2513 * to disable this behavior.
2514 *
2515 * <p>This flag can not be used when the caller is requesting a result from
2516 * the activity being launched.
2517 */
2518 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2519 /**
2520 * <strong>Do not use this flag unless you are implementing your own
2521 * top-level application launcher.</strong> Used in conjunction with
2522 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2523 * behavior of bringing an existing task to the foreground. When set,
2524 * a new task is <em>always</em> started to host the Activity for the
2525 * Intent, regardless of whether there is already an existing task running
2526 * the same thing.
2527 *
2528 * <p><strong>Because the default system does not include graphical task management,
2529 * you should not use this flag unless you provide some way for a user to
2530 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002531 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002532 * <p>This flag is ignored if
2533 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2534 *
Scott Main7aee61f2011-02-08 11:25:01 -08002535 * <p>See
2536 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2537 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002538 */
2539 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2540 /**
2541 * If set, and the activity being launched is already running in the
2542 * current task, then instead of launching a new instance of that activity,
2543 * all of the other activities on top of it will be closed and this Intent
2544 * will be delivered to the (now on top) old activity as a new Intent.
2545 *
2546 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2547 * If D calls startActivity() with an Intent that resolves to the component
2548 * of activity B, then C and D will be finished and B receive the given
2549 * Intent, resulting in the stack now being: A, B.
2550 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002551 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002552 * either receive the new intent you are starting here in its
2553 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002554 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002555 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2556 * the same intent, then it will be finished and re-created; for all other
2557 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2558 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002559 *
2560 * <p>This launch mode can also be used to good effect in conjunction with
2561 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2562 * of a task, it will bring any currently running instance of that task
2563 * to the foreground, and then clear it to its root state. This is
2564 * especially useful, for example, when launching an activity from the
2565 * notification manager.
2566 *
Scott Main7aee61f2011-02-08 11:25:01 -08002567 * <p>See
2568 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2569 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002570 */
2571 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2572 /**
2573 * If set and this intent is being used to launch a new activity from an
2574 * existing one, then the reply target of the existing activity will be
2575 * transfered to the new activity. This way the new activity can call
2576 * {@link android.app.Activity#setResult} and have that result sent back to
2577 * the reply target of the original activity.
2578 */
2579 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2580 /**
2581 * If set and this intent is being used to launch a new activity from an
2582 * existing one, the current activity will not be counted as the top
2583 * activity for deciding whether the new intent should be delivered to
2584 * the top instead of starting a new one. The previous activity will
2585 * be used as the top, with the assumption being that the current activity
2586 * will finish itself immediately.
2587 */
2588 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2589 /**
2590 * If set, the new activity is not kept in the list of recently launched
2591 * activities.
2592 */
2593 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2594 /**
2595 * This flag is not normally set by application code, but set for you by
2596 * the system as described in the
2597 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2598 * launchMode} documentation for the singleTask mode.
2599 */
2600 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2601 /**
2602 * If set, and this activity is either being started in a new task or
2603 * bringing to the top an existing task, then it will be launched as
2604 * the front door of the task. This will result in the application of
2605 * any affinities needed to have that task in the proper state (either
2606 * moving activities to or from it), or simply resetting that task to
2607 * its initial state if needed.
2608 */
2609 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2610 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002611 * This flag is not normally set by application code, but set for you by
2612 * the system if this activity is being launched from history
2613 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002614 */
2615 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002616 /**
2617 * If set, this marks a point in the task's activity stack that should
2618 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002619 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002620 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2621 * the user re-launching it from home), this activity and all on top of
2622 * it will be finished so that the user does not return to them, but
2623 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002624 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002625 * <p>This is useful for cases where you have a logical break in your
2626 * application. For example, an e-mail application may have a command
2627 * to view an attachment, which launches an image view activity to
2628 * display it. This activity should be part of the e-mail application's
2629 * task, since it is a part of the task the user is involved in. However,
2630 * if the user leaves that task, and later selects the e-mail app from
2631 * home, we may like them to return to the conversation they were
2632 * viewing, not the picture attachment, since that is confusing. By
2633 * setting this flag when launching the image viewer, that viewer and
2634 * any activities it starts will be removed the next time the user returns
2635 * to mail.
2636 */
2637 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002638 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002639 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002640 * callback from occurring on the current frontmost activity before it is
2641 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002642 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002643 * <p>Typically, an activity can rely on that callback to indicate that an
2644 * explicit user action has caused their activity to be moved out of the
2645 * foreground. The callback marks an appropriate point in the activity's
2646 * lifecycle for it to dismiss any notifications that it intends to display
2647 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002648 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002649 * <p>If an activity is ever started via any non-user-driven events such as
2650 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2651 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002652 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002653 */
2654 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002655 /**
2656 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2657 * this flag will cause the launched activity to be brought to the front of its
2658 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002659 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002660 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2661 * If D calls startActivity() with an Intent that resolves to the component
2662 * of activity B, then B will be brought to the front of the history stack,
2663 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002664 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002665 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002666 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002667 */
2668 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002670 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2671 * this flag will prevent the system from applying an activity transition
2672 * animation to go to the next activity state. This doesn't mean an
2673 * animation will never run -- if another activity change happens that doesn't
2674 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002675 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002676 * when you are going to do a series of activity operations but the
2677 * animation seen by the user shouldn't be driven by the first activity
2678 * change but rather a later one.
2679 */
2680 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2681 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002682 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2683 * this flag will cause any existing task that would be associated with the
2684 * activity to be cleared before the activity is started. That is, the activity
2685 * becomes the new root of an otherwise empty task, and any old activities
2686 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2687 */
2688 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
2689 /**
2690 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2691 * this flag will cause a newly launching task to be placed on top of the current
2692 * home activity task (if there is one). That is, pressing back from the task
2693 * will always return the user to home even if that was not the last activity they
2694 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2695 */
2696 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
2697 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 * If set, when sending a broadcast only registered receivers will be
2699 * called -- no BroadcastReceiver components will be launched.
2700 */
2701 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002702 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002703 * If set, when sending a broadcast the new broadcast will replace
2704 * any existing pending broadcast that matches it. Matching is defined
2705 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2706 * true for the intents of the two broadcasts. When a match is found,
2707 * the new broadcast (and receivers associated with it) will replace the
2708 * existing one in the pending broadcast list, remaining at the same
2709 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002710 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002711 * <p>This flag is most typically used with sticky broadcasts, which
2712 * only care about delivering the most recent values of the broadcast
2713 * to their receivers.
2714 */
2715 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2716 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002717 * If set, when sending a broadcast <i>before boot has completed</i> only
2718 * registered receivers will be called -- no BroadcastReceiver components
2719 * will be launched. Sticky intent state will be recorded properly even
2720 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2721 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002722 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002723 * <p>This flag is only for use by system sevices as a convenience to
2724 * avoid having to implement a more complex mechanism around detection
2725 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002726 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002727 * @hide
2728 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002729 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002730 /**
2731 * Set when this broadcast is for a boot upgrade, a special mode that
2732 * allows the broadcast to be sent before the system is ready and launches
2733 * the app process with no providers running in it.
2734 * @hide
2735 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002736 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002737
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002738 /**
2739 * @hide Flags that can't be changed with PendingIntent.
2740 */
2741 public static final int IMMUTABLE_FLAGS =
2742 FLAG_GRANT_READ_URI_PERMISSION
2743 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002744
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002745 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002746 // ---------------------------------------------------------------------
2747 // toUri() and parseUri() options.
2748
2749 /**
2750 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2751 * always has the "intent:" scheme. This syntax can be used when you want
2752 * to later disambiguate between URIs that are intended to describe an
2753 * Intent vs. all others that should be treated as raw URIs. When used
2754 * with {@link #parseUri}, any other scheme will result in a generic
2755 * VIEW action for that raw URI.
2756 */
2757 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002758
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002759 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002760
2761 private String mAction;
2762 private Uri mData;
2763 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002764 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002765 private ComponentName mComponent;
2766 private int mFlags;
2767 private HashSet<String> mCategories;
2768 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002769 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002770
2771 // ---------------------------------------------------------------------
2772
2773 /**
2774 * Create an empty intent.
2775 */
2776 public Intent() {
2777 }
2778
2779 /**
2780 * Copy constructor.
2781 */
2782 public Intent(Intent o) {
2783 this.mAction = o.mAction;
2784 this.mData = o.mData;
2785 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002786 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002787 this.mComponent = o.mComponent;
2788 this.mFlags = o.mFlags;
2789 if (o.mCategories != null) {
2790 this.mCategories = new HashSet<String>(o.mCategories);
2791 }
2792 if (o.mExtras != null) {
2793 this.mExtras = new Bundle(o.mExtras);
2794 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002795 if (o.mSourceBounds != null) {
2796 this.mSourceBounds = new Rect(o.mSourceBounds);
2797 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 }
2799
2800 @Override
2801 public Object clone() {
2802 return new Intent(this);
2803 }
2804
2805 private Intent(Intent o, boolean all) {
2806 this.mAction = o.mAction;
2807 this.mData = o.mData;
2808 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002809 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002810 this.mComponent = o.mComponent;
2811 if (o.mCategories != null) {
2812 this.mCategories = new HashSet<String>(o.mCategories);
2813 }
2814 }
2815
2816 /**
2817 * Make a clone of only the parts of the Intent that are relevant for
2818 * filter matching: the action, data, type, component, and categories.
2819 */
2820 public Intent cloneFilter() {
2821 return new Intent(this, false);
2822 }
2823
2824 /**
2825 * Create an intent with a given action. All other fields (data, type,
2826 * class) are null. Note that the action <em>must</em> be in a
2827 * namespace because Intents are used globally in the system -- for
2828 * example the system VIEW action is android.intent.action.VIEW; an
2829 * application's custom action would be something like
2830 * com.google.app.myapp.CUSTOM_ACTION.
2831 *
2832 * @param action The Intent action, such as ACTION_VIEW.
2833 */
2834 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002835 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002836 }
2837
2838 /**
2839 * Create an intent with a given action and for a given data url. Note
2840 * that the action <em>must</em> be in a namespace because Intents are
2841 * used globally in the system -- for example the system VIEW action is
2842 * android.intent.action.VIEW; an application's custom action would be
2843 * something like com.google.app.myapp.CUSTOM_ACTION.
2844 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002845 * <p><em>Note: scheme and host name matching in the Android framework is
2846 * case-sensitive, unlike the formal RFC. As a result,
2847 * you should always ensure that you write your Uri with these elements
2848 * using lower case letters, and normalize any Uris you receive from
2849 * outside of Android to ensure the scheme and host is lower case.</em></p>
2850 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002851 * @param action The Intent action, such as ACTION_VIEW.
2852 * @param uri The Intent data URI.
2853 */
2854 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002855 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002856 mData = uri;
2857 }
2858
2859 /**
2860 * Create an intent for a specific component. All other fields (action, data,
2861 * type, class) are null, though they can be modified later with explicit
2862 * calls. This provides a convenient way to create an intent that is
2863 * intended to execute a hard-coded class name, rather than relying on the
2864 * system to find an appropriate class for you; see {@link #setComponent}
2865 * for more information on the repercussions of this.
2866 *
2867 * @param packageContext A Context of the application package implementing
2868 * this class.
2869 * @param cls The component class that is to be used for the intent.
2870 *
2871 * @see #setClass
2872 * @see #setComponent
2873 * @see #Intent(String, android.net.Uri , Context, Class)
2874 */
2875 public Intent(Context packageContext, Class<?> cls) {
2876 mComponent = new ComponentName(packageContext, cls);
2877 }
2878
2879 /**
2880 * Create an intent for a specific component with a specified action and data.
2881 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2882 * construct the Intent and then calling {@link #setClass} to set its
2883 * class.
2884 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002885 * <p><em>Note: scheme and host name matching in the Android framework is
2886 * case-sensitive, unlike the formal RFC. As a result,
2887 * you should always ensure that you write your Uri with these elements
2888 * using lower case letters, and normalize any Uris you receive from
2889 * outside of Android to ensure the scheme and host is lower case.</em></p>
2890 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002891 * @param action The Intent action, such as ACTION_VIEW.
2892 * @param uri The Intent data URI.
2893 * @param packageContext A Context of the application package implementing
2894 * this class.
2895 * @param cls The component class that is to be used for the intent.
2896 *
2897 * @see #Intent(String, android.net.Uri)
2898 * @see #Intent(Context, Class)
2899 * @see #setClass
2900 * @see #setComponent
2901 */
2902 public Intent(String action, Uri uri,
2903 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002904 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002905 mData = uri;
2906 mComponent = new ComponentName(packageContext, cls);
2907 }
2908
2909 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08002910 * Create an intent to launch the main (root) activity of a task. This
2911 * is the Intent that is started when the application's is launched from
2912 * Home. For anything else that wants to launch an application in the
2913 * same way, it is important that they use an Intent structured the same
2914 * way, and can use this function to ensure this is the case.
2915 *
2916 * <p>The returned Intent has the given Activity component as its explicit
2917 * component, {@link #ACTION_MAIN} as its action, and includes the
2918 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
2919 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
2920 * to do that through {@link #addFlags(int)} on the returned Intent.
2921 *
2922 * @param mainActivity The main activity component that this Intent will
2923 * launch.
2924 * @return Returns a newly created Intent that can be used to launch the
2925 * activity as a main application entry.
2926 *
2927 * @see #setClass
2928 * @see #setComponent
2929 */
2930 public static Intent makeMainActivity(ComponentName mainActivity) {
2931 Intent intent = new Intent(ACTION_MAIN);
2932 intent.setComponent(mainActivity);
2933 intent.addCategory(CATEGORY_LAUNCHER);
2934 return intent;
2935 }
2936
2937 /**
2938 * Make an Intent that can be used to re-launch an application's task
2939 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
2940 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
2941 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
2942 *
2943 * @param mainActivity The activity component that is the root of the
2944 * task; this is the activity that has been published in the application's
2945 * manifest as the main launcher icon.
2946 *
2947 * @return Returns a newly created Intent that can be used to relaunch the
2948 * activity's task in its root state.
2949 */
2950 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
2951 Intent intent = makeMainActivity(mainActivity);
2952 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
2953 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
2954 return intent;
2955 }
2956
2957 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002958 * Call {@link #parseUri} with 0 flags.
2959 * @deprecated Use {@link #parseUri} instead.
2960 */
2961 @Deprecated
2962 public static Intent getIntent(String uri) throws URISyntaxException {
2963 return parseUri(uri, 0);
2964 }
Tom Taylord4a47292009-12-21 13:59:18 -08002965
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002966 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002967 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002968 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002969 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002970 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002971 *
2972 * <p>The URI given here must not be relative -- that is, it must include
2973 * the scheme and full path.
2974 *
2975 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002976 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002977 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002978 *
2979 * @return Intent The newly created Intent object.
2980 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002981 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2982 * it bad (as parsed by the Uri class) or the Intent data within the
2983 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08002984 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002985 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002986 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002987 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002988 int i = 0;
2989 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002990 // Validate intent scheme for if requested.
2991 if ((flags&URI_INTENT_SCHEME) != 0) {
2992 if (!uri.startsWith("intent:")) {
2993 Intent intent = new Intent(ACTION_VIEW);
2994 try {
2995 intent.setData(Uri.parse(uri));
2996 } catch (IllegalArgumentException e) {
2997 throw new URISyntaxException(uri, e.getMessage());
2998 }
2999 return intent;
3000 }
3001 }
Tom Taylord4a47292009-12-21 13:59:18 -08003002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003003 // simple case
3004 i = uri.lastIndexOf("#");
3005 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3006
3007 // old format Intent URI
3008 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003009
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003010 // new format
3011 Intent intent = new Intent(ACTION_VIEW);
3012
3013 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003014 String data = i >= 0 ? uri.substring(0, i) : null;
3015 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003016 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003017
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003018 // loop over contents of Intent, all name=value;
3019 while (!uri.startsWith("end", i)) {
3020 int eq = uri.indexOf('=', i);
3021 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003022 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003023
3024 // action
3025 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003026 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003027 }
3028
3029 // categories
3030 else if (uri.startsWith("category=", i)) {
3031 intent.addCategory(value);
3032 }
3033
3034 // type
3035 else if (uri.startsWith("type=", i)) {
3036 intent.mType = value;
3037 }
3038
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003039 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003040 else if (uri.startsWith("launchFlags=", i)) {
3041 intent.mFlags = Integer.decode(value).intValue();
3042 }
3043
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003044 // package
3045 else if (uri.startsWith("package=", i)) {
3046 intent.mPackage = value;
3047 }
3048
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003049 // component
3050 else if (uri.startsWith("component=", i)) {
3051 intent.mComponent = ComponentName.unflattenFromString(value);
3052 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003053
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003054 // scheme
3055 else if (uri.startsWith("scheme=", i)) {
3056 scheme = value;
3057 }
3058
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003059 // source bounds
3060 else if (uri.startsWith("sourceBounds=", i)) {
3061 intent.mSourceBounds = Rect.unflattenFromString(value);
3062 }
3063
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003064 // extra
3065 else {
3066 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003067 // create Bundle if it doesn't already exist
3068 if (intent.mExtras == null) intent.mExtras = new Bundle();
3069 Bundle b = intent.mExtras;
3070 // add EXTRA
3071 if (uri.startsWith("S.", i)) b.putString(key, value);
3072 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3073 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3074 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3075 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3076 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3077 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3078 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3079 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3080 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3081 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003082
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003083 // move to the next item
3084 i = semi + 1;
3085 }
3086
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003087 if (data != null) {
3088 if (data.startsWith("intent:")) {
3089 data = data.substring(7);
3090 if (scheme != null) {
3091 data = scheme + ':' + data;
3092 }
3093 }
Tom Taylord4a47292009-12-21 13:59:18 -08003094
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003095 if (data.length() > 0) {
3096 try {
3097 intent.mData = Uri.parse(data);
3098 } catch (IllegalArgumentException e) {
3099 throw new URISyntaxException(uri, e.getMessage());
3100 }
3101 }
3102 }
Tom Taylord4a47292009-12-21 13:59:18 -08003103
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003104 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003105
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003106 } catch (IndexOutOfBoundsException e) {
3107 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3108 }
3109 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003110
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003111 public static Intent getIntentOld(String uri) throws URISyntaxException {
3112 Intent intent;
3113
3114 int i = uri.lastIndexOf('#');
3115 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003116 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003117 final int intentFragmentStart = i;
3118 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003119
3120 i++;
3121
3122 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003123 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003124 i += 7;
3125 int j = uri.indexOf(')', i);
3126 action = uri.substring(i, j);
3127 i = j + 1;
3128 }
3129
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003130 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003131
3132 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003133 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003134 i += 11;
3135 int j = uri.indexOf(')', i);
3136 while (i < j) {
3137 int sep = uri.indexOf('!', i);
3138 if (sep < 0) sep = j;
3139 if (i < sep) {
3140 intent.addCategory(uri.substring(i, sep));
3141 }
3142 i = sep + 1;
3143 }
3144 i = j + 1;
3145 }
3146
3147 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003148 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003149 i += 5;
3150 int j = uri.indexOf(')', i);
3151 intent.mType = uri.substring(i, j);
3152 i = j + 1;
3153 }
3154
3155 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003156 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003157 i += 12;
3158 int j = uri.indexOf(')', i);
3159 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3160 i = j + 1;
3161 }
3162
3163 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003164 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003165 i += 10;
3166 int j = uri.indexOf(')', i);
3167 int sep = uri.indexOf('!', i);
3168 if (sep >= 0 && sep < j) {
3169 String pkg = uri.substring(i, sep);
3170 String cls = uri.substring(sep + 1, j);
3171 intent.mComponent = new ComponentName(pkg, cls);
3172 }
3173 i = j + 1;
3174 }
3175
3176 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003177 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003178 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003179
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003180 final int closeParen = uri.indexOf(')', i);
3181 if (closeParen == -1) throw new URISyntaxException(uri,
3182 "EXTRA missing trailing ')'", i);
3183
3184 while (i < closeParen) {
3185 // fetch the key value
3186 int j = uri.indexOf('=', i);
3187 if (j <= i + 1 || i >= closeParen) {
3188 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3189 }
3190 char type = uri.charAt(i);
3191 i++;
3192 String key = uri.substring(i, j);
3193 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003194
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 // get type-value
3196 j = uri.indexOf('!', i);
3197 if (j == -1 || j >= closeParen) j = closeParen;
3198 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3199 String value = uri.substring(i, j);
3200 i = j;
3201
3202 // create Bundle if it doesn't already exist
3203 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003205 // add item to bundle
3206 try {
3207 switch (type) {
3208 case 'S':
3209 intent.mExtras.putString(key, Uri.decode(value));
3210 break;
3211 case 'B':
3212 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3213 break;
3214 case 'b':
3215 intent.mExtras.putByte(key, Byte.parseByte(value));
3216 break;
3217 case 'c':
3218 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3219 break;
3220 case 'd':
3221 intent.mExtras.putDouble(key, Double.parseDouble(value));
3222 break;
3223 case 'f':
3224 intent.mExtras.putFloat(key, Float.parseFloat(value));
3225 break;
3226 case 'i':
3227 intent.mExtras.putInt(key, Integer.parseInt(value));
3228 break;
3229 case 'l':
3230 intent.mExtras.putLong(key, Long.parseLong(value));
3231 break;
3232 case 's':
3233 intent.mExtras.putShort(key, Short.parseShort(value));
3234 break;
3235 default:
3236 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3237 }
3238 } catch (NumberFormatException e) {
3239 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3240 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003241
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003242 char ch = uri.charAt(i);
3243 if (ch == ')') break;
3244 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3245 i++;
3246 }
3247 }
3248
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003249 if (isIntentFragment) {
3250 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3251 } else {
3252 intent.mData = Uri.parse(uri);
3253 }
Tom Taylord4a47292009-12-21 13:59:18 -08003254
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003255 if (intent.mAction == null) {
3256 // By default, if no action is specified, then use VIEW.
3257 intent.mAction = ACTION_VIEW;
3258 }
3259
3260 } else {
3261 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3262 }
3263
3264 return intent;
3265 }
3266
3267 /**
3268 * Retrieve the general action to be performed, such as
3269 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3270 * the information in the intent should be interpreted -- most importantly,
3271 * what to do with the data returned by {@link #getData}.
3272 *
3273 * @return The action of this intent or null if none is specified.
3274 *
3275 * @see #setAction
3276 */
3277 public String getAction() {
3278 return mAction;
3279 }
3280
3281 /**
3282 * Retrieve data this intent is operating on. This URI specifies the name
3283 * of the data; often it uses the content: scheme, specifying data in a
3284 * content provider. Other schemes may be handled by specific activities,
3285 * such as http: by the web browser.
3286 *
3287 * @return The URI of the data this intent is targeting or null.
3288 *
3289 * @see #getScheme
3290 * @see #setData
3291 */
3292 public Uri getData() {
3293 return mData;
3294 }
3295
3296 /**
3297 * The same as {@link #getData()}, but returns the URI as an encoded
3298 * String.
3299 */
3300 public String getDataString() {
3301 return mData != null ? mData.toString() : null;
3302 }
3303
3304 /**
3305 * Return the scheme portion of the intent's data. If the data is null or
3306 * does not include a scheme, null is returned. Otherwise, the scheme
3307 * prefix without the final ':' is returned, i.e. "http".
3308 *
3309 * <p>This is the same as calling getData().getScheme() (and checking for
3310 * null data).
3311 *
3312 * @return The scheme of this intent.
3313 *
3314 * @see #getData
3315 */
3316 public String getScheme() {
3317 return mData != null ? mData.getScheme() : null;
3318 }
3319
3320 /**
3321 * Retrieve any explicit MIME type included in the intent. This is usually
3322 * null, as the type is determined by the intent data.
3323 *
3324 * @return If a type was manually set, it is returned; else null is
3325 * returned.
3326 *
3327 * @see #resolveType(ContentResolver)
3328 * @see #setType
3329 */
3330 public String getType() {
3331 return mType;
3332 }
3333
3334 /**
3335 * Return the MIME data type of this intent. If the type field is
3336 * explicitly set, that is simply returned. Otherwise, if the data is set,
3337 * the type of that data is returned. If neither fields are set, a null is
3338 * returned.
3339 *
3340 * @return The MIME type of this intent.
3341 *
3342 * @see #getType
3343 * @see #resolveType(ContentResolver)
3344 */
3345 public String resolveType(Context context) {
3346 return resolveType(context.getContentResolver());
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 * @param resolver A ContentResolver that can be used to determine the MIME
3356 * type of the intent's data.
3357 *
3358 * @return The MIME type of this intent.
3359 *
3360 * @see #getType
3361 * @see #resolveType(Context)
3362 */
3363 public String resolveType(ContentResolver resolver) {
3364 if (mType != null) {
3365 return mType;
3366 }
3367 if (mData != null) {
3368 if ("content".equals(mData.getScheme())) {
3369 return resolver.getType(mData);
3370 }
3371 }
3372 return null;
3373 }
3374
3375 /**
3376 * Return the MIME data type of this intent, only if it will be needed for
3377 * intent resolution. This is not generally useful for application code;
3378 * it is used by the frameworks for communicating with back-end system
3379 * services.
3380 *
3381 * @param resolver A ContentResolver that can be used to determine the MIME
3382 * type of the intent's data.
3383 *
3384 * @return The MIME type of this intent, or null if it is unknown or not
3385 * needed.
3386 */
3387 public String resolveTypeIfNeeded(ContentResolver resolver) {
3388 if (mComponent != null) {
3389 return mType;
3390 }
3391 return resolveType(resolver);
3392 }
3393
3394 /**
3395 * Check if an category exists in the intent.
3396 *
3397 * @param category The category to check.
3398 *
3399 * @return boolean True if the intent contains the category, else false.
3400 *
3401 * @see #getCategories
3402 * @see #addCategory
3403 */
3404 public boolean hasCategory(String category) {
3405 return mCategories != null && mCategories.contains(category);
3406 }
3407
3408 /**
3409 * Return the set of all categories in the intent. If there are no categories,
3410 * returns NULL.
3411 *
3412 * @return Set The set of categories you can examine. Do not modify!
3413 *
3414 * @see #hasCategory
3415 * @see #addCategory
3416 */
3417 public Set<String> getCategories() {
3418 return mCategories;
3419 }
3420
3421 /**
3422 * Sets the ClassLoader that will be used when unmarshalling
3423 * any Parcelable values from the extras of this Intent.
3424 *
3425 * @param loader a ClassLoader, or null to use the default loader
3426 * at the time of unmarshalling.
3427 */
3428 public void setExtrasClassLoader(ClassLoader loader) {
3429 if (mExtras != null) {
3430 mExtras.setClassLoader(loader);
3431 }
3432 }
3433
3434 /**
3435 * Returns true if an extra value is associated with the given name.
3436 * @param name the extra's name
3437 * @return true if the given extra is present.
3438 */
3439 public boolean hasExtra(String name) {
3440 return mExtras != null && mExtras.containsKey(name);
3441 }
3442
3443 /**
3444 * Returns true if the Intent's extras contain a parcelled file descriptor.
3445 * @return true if the Intent contains a parcelled file descriptor.
3446 */
3447 public boolean hasFileDescriptors() {
3448 return mExtras != null && mExtras.hasFileDescriptors();
3449 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003450
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003451 /**
3452 * Retrieve extended data from the intent.
3453 *
3454 * @param name The name of the desired item.
3455 *
3456 * @return the value of an item that previously added with putExtra()
3457 * or null if none was found.
3458 *
3459 * @deprecated
3460 * @hide
3461 */
3462 @Deprecated
3463 public Object getExtra(String name) {
3464 return getExtra(name, null);
3465 }
3466
3467 /**
3468 * Retrieve extended data from the intent.
3469 *
3470 * @param name The name of the desired item.
3471 * @param defaultValue the value to be returned if no value of the desired
3472 * type is stored with the given name.
3473 *
3474 * @return the value of an item that previously added with putExtra()
3475 * or the default value if none was found.
3476 *
3477 * @see #putExtra(String, boolean)
3478 */
3479 public boolean getBooleanExtra(String name, boolean defaultValue) {
3480 return mExtras == null ? defaultValue :
3481 mExtras.getBoolean(name, defaultValue);
3482 }
3483
3484 /**
3485 * Retrieve extended data from the intent.
3486 *
3487 * @param name The name of the desired item.
3488 * @param defaultValue the value to be returned if no value of the desired
3489 * type is stored with the given name.
3490 *
3491 * @return the value of an item that previously added with putExtra()
3492 * or the default value if none was found.
3493 *
3494 * @see #putExtra(String, byte)
3495 */
3496 public byte getByteExtra(String name, byte defaultValue) {
3497 return mExtras == null ? defaultValue :
3498 mExtras.getByte(name, defaultValue);
3499 }
3500
3501 /**
3502 * Retrieve extended data from the intent.
3503 *
3504 * @param name The name of the desired item.
3505 * @param defaultValue the value to be returned if no value of the desired
3506 * type is stored with the given name.
3507 *
3508 * @return the value of an item that previously added with putExtra()
3509 * or the default value if none was found.
3510 *
3511 * @see #putExtra(String, short)
3512 */
3513 public short getShortExtra(String name, short defaultValue) {
3514 return mExtras == null ? defaultValue :
3515 mExtras.getShort(name, defaultValue);
3516 }
3517
3518 /**
3519 * Retrieve extended data from the intent.
3520 *
3521 * @param name The name of the desired item.
3522 * @param defaultValue the value to be returned if no value of the desired
3523 * type is stored with the given name.
3524 *
3525 * @return the value of an item that previously added with putExtra()
3526 * or the default value if none was found.
3527 *
3528 * @see #putExtra(String, char)
3529 */
3530 public char getCharExtra(String name, char defaultValue) {
3531 return mExtras == null ? defaultValue :
3532 mExtras.getChar(name, defaultValue);
3533 }
3534
3535 /**
3536 * Retrieve extended data from the intent.
3537 *
3538 * @param name The name of the desired item.
3539 * @param defaultValue the value to be returned if no value of the desired
3540 * type is stored with the given name.
3541 *
3542 * @return the value of an item that previously added with putExtra()
3543 * or the default value if none was found.
3544 *
3545 * @see #putExtra(String, int)
3546 */
3547 public int getIntExtra(String name, int defaultValue) {
3548 return mExtras == null ? defaultValue :
3549 mExtras.getInt(name, defaultValue);
3550 }
3551
3552 /**
3553 * Retrieve extended data from the intent.
3554 *
3555 * @param name The name of the desired item.
3556 * @param defaultValue the value to be returned if no value of the desired
3557 * type is stored with the given name.
3558 *
3559 * @return the value of an item that previously added with putExtra()
3560 * or the default value if none was found.
3561 *
3562 * @see #putExtra(String, long)
3563 */
3564 public long getLongExtra(String name, long defaultValue) {
3565 return mExtras == null ? defaultValue :
3566 mExtras.getLong(name, defaultValue);
3567 }
3568
3569 /**
3570 * Retrieve extended data from the intent.
3571 *
3572 * @param name The name of the desired item.
3573 * @param defaultValue the value to be returned if no value of the desired
3574 * type is stored with the given name.
3575 *
3576 * @return the value of an item that previously added with putExtra(),
3577 * or the default value if no such item is present
3578 *
3579 * @see #putExtra(String, float)
3580 */
3581 public float getFloatExtra(String name, float defaultValue) {
3582 return mExtras == null ? defaultValue :
3583 mExtras.getFloat(name, defaultValue);
3584 }
3585
3586 /**
3587 * Retrieve extended data from the intent.
3588 *
3589 * @param name The name of the desired item.
3590 * @param defaultValue the value to be returned if no value of the desired
3591 * type is stored with the given name.
3592 *
3593 * @return the value of an item that previously added with putExtra()
3594 * or the default value if none was found.
3595 *
3596 * @see #putExtra(String, double)
3597 */
3598 public double getDoubleExtra(String name, double defaultValue) {
3599 return mExtras == null ? defaultValue :
3600 mExtras.getDouble(name, defaultValue);
3601 }
3602
3603 /**
3604 * Retrieve extended data from the intent.
3605 *
3606 * @param name The name of the desired item.
3607 *
3608 * @return the value of an item that previously added with putExtra()
3609 * or null if no String value was found.
3610 *
3611 * @see #putExtra(String, String)
3612 */
3613 public String getStringExtra(String name) {
3614 return mExtras == null ? null : mExtras.getString(name);
3615 }
3616
3617 /**
3618 * Retrieve extended data from the intent.
3619 *
3620 * @param name The name of the desired item.
3621 *
3622 * @return the value of an item that previously added with putExtra()
3623 * or null if no CharSequence value was found.
3624 *
3625 * @see #putExtra(String, CharSequence)
3626 */
3627 public CharSequence getCharSequenceExtra(String name) {
3628 return mExtras == null ? null : mExtras.getCharSequence(name);
3629 }
3630
3631 /**
3632 * Retrieve extended data from the intent.
3633 *
3634 * @param name The name of the desired item.
3635 *
3636 * @return the value of an item that previously added with putExtra()
3637 * or null if no Parcelable value was found.
3638 *
3639 * @see #putExtra(String, Parcelable)
3640 */
3641 public <T extends Parcelable> T getParcelableExtra(String name) {
3642 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3643 }
3644
3645 /**
3646 * Retrieve extended data from the intent.
3647 *
3648 * @param name The name of the desired item.
3649 *
3650 * @return the value of an item that previously added with putExtra()
3651 * or null if no Parcelable[] value was found.
3652 *
3653 * @see #putExtra(String, Parcelable[])
3654 */
3655 public Parcelable[] getParcelableArrayExtra(String name) {
3656 return mExtras == null ? null : mExtras.getParcelableArray(name);
3657 }
3658
3659 /**
3660 * Retrieve extended data from the intent.
3661 *
3662 * @param name The name of the desired item.
3663 *
3664 * @return the value of an item that previously added with putExtra()
3665 * or null if no ArrayList<Parcelable> value was found.
3666 *
3667 * @see #putParcelableArrayListExtra(String, ArrayList)
3668 */
3669 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3670 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3671 }
3672
3673 /**
3674 * Retrieve extended data from the intent.
3675 *
3676 * @param name The name of the desired item.
3677 *
3678 * @return the value of an item that previously added with putExtra()
3679 * or null if no Serializable value was found.
3680 *
3681 * @see #putExtra(String, Serializable)
3682 */
3683 public Serializable getSerializableExtra(String name) {
3684 return mExtras == null ? null : mExtras.getSerializable(name);
3685 }
3686
3687 /**
3688 * Retrieve extended data from the intent.
3689 *
3690 * @param name The name of the desired item.
3691 *
3692 * @return the value of an item that previously added with putExtra()
3693 * or null if no ArrayList<Integer> value was found.
3694 *
3695 * @see #putIntegerArrayListExtra(String, ArrayList)
3696 */
3697 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3698 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3699 }
3700
3701 /**
3702 * Retrieve extended data from the intent.
3703 *
3704 * @param name The name of the desired item.
3705 *
3706 * @return the value of an item that previously added with putExtra()
3707 * or null if no ArrayList<String> value was found.
3708 *
3709 * @see #putStringArrayListExtra(String, ArrayList)
3710 */
3711 public ArrayList<String> getStringArrayListExtra(String name) {
3712 return mExtras == null ? null : mExtras.getStringArrayList(name);
3713 }
3714
3715 /**
3716 * Retrieve extended data from the intent.
3717 *
3718 * @param name The name of the desired item.
3719 *
3720 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003721 * or null if no ArrayList<CharSequence> value was found.
3722 *
3723 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3724 */
3725 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3726 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3727 }
3728
3729 /**
3730 * Retrieve extended data from the intent.
3731 *
3732 * @param name The name of the desired item.
3733 *
3734 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003735 * or null if no boolean array value was found.
3736 *
3737 * @see #putExtra(String, boolean[])
3738 */
3739 public boolean[] getBooleanArrayExtra(String name) {
3740 return mExtras == null ? null : mExtras.getBooleanArray(name);
3741 }
3742
3743 /**
3744 * Retrieve extended data from the intent.
3745 *
3746 * @param name The name of the desired item.
3747 *
3748 * @return the value of an item that previously added with putExtra()
3749 * or null if no byte array value was found.
3750 *
3751 * @see #putExtra(String, byte[])
3752 */
3753 public byte[] getByteArrayExtra(String name) {
3754 return mExtras == null ? null : mExtras.getByteArray(name);
3755 }
3756
3757 /**
3758 * Retrieve extended data from the intent.
3759 *
3760 * @param name The name of the desired item.
3761 *
3762 * @return the value of an item that previously added with putExtra()
3763 * or null if no short array value was found.
3764 *
3765 * @see #putExtra(String, short[])
3766 */
3767 public short[] getShortArrayExtra(String name) {
3768 return mExtras == null ? null : mExtras.getShortArray(name);
3769 }
3770
3771 /**
3772 * Retrieve extended data from the intent.
3773 *
3774 * @param name The name of the desired item.
3775 *
3776 * @return the value of an item that previously added with putExtra()
3777 * or null if no char array value was found.
3778 *
3779 * @see #putExtra(String, char[])
3780 */
3781 public char[] getCharArrayExtra(String name) {
3782 return mExtras == null ? null : mExtras.getCharArray(name);
3783 }
3784
3785 /**
3786 * Retrieve extended data from the intent.
3787 *
3788 * @param name The name of the desired item.
3789 *
3790 * @return the value of an item that previously added with putExtra()
3791 * or null if no int array value was found.
3792 *
3793 * @see #putExtra(String, int[])
3794 */
3795 public int[] getIntArrayExtra(String name) {
3796 return mExtras == null ? null : mExtras.getIntArray(name);
3797 }
3798
3799 /**
3800 * Retrieve extended data from the intent.
3801 *
3802 * @param name The name of the desired item.
3803 *
3804 * @return the value of an item that previously added with putExtra()
3805 * or null if no long array value was found.
3806 *
3807 * @see #putExtra(String, long[])
3808 */
3809 public long[] getLongArrayExtra(String name) {
3810 return mExtras == null ? null : mExtras.getLongArray(name);
3811 }
3812
3813 /**
3814 * Retrieve extended data from the intent.
3815 *
3816 * @param name The name of the desired item.
3817 *
3818 * @return the value of an item that previously added with putExtra()
3819 * or null if no float array value was found.
3820 *
3821 * @see #putExtra(String, float[])
3822 */
3823 public float[] getFloatArrayExtra(String name) {
3824 return mExtras == null ? null : mExtras.getFloatArray(name);
3825 }
3826
3827 /**
3828 * Retrieve extended data from the intent.
3829 *
3830 * @param name The name of the desired item.
3831 *
3832 * @return the value of an item that previously added with putExtra()
3833 * or null if no double array value was found.
3834 *
3835 * @see #putExtra(String, double[])
3836 */
3837 public double[] getDoubleArrayExtra(String name) {
3838 return mExtras == null ? null : mExtras.getDoubleArray(name);
3839 }
3840
3841 /**
3842 * Retrieve extended data from the intent.
3843 *
3844 * @param name The name of the desired item.
3845 *
3846 * @return the value of an item that previously added with putExtra()
3847 * or null if no String array value was found.
3848 *
3849 * @see #putExtra(String, String[])
3850 */
3851 public String[] getStringArrayExtra(String name) {
3852 return mExtras == null ? null : mExtras.getStringArray(name);
3853 }
3854
3855 /**
3856 * Retrieve extended data from the intent.
3857 *
3858 * @param name The name of the desired item.
3859 *
3860 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003861 * or null if no CharSequence array value was found.
3862 *
3863 * @see #putExtra(String, CharSequence[])
3864 */
3865 public CharSequence[] getCharSequenceArrayExtra(String name) {
3866 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3867 }
3868
3869 /**
3870 * Retrieve extended data from the intent.
3871 *
3872 * @param name The name of the desired item.
3873 *
3874 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003875 * or null if no Bundle value was found.
3876 *
3877 * @see #putExtra(String, Bundle)
3878 */
3879 public Bundle getBundleExtra(String name) {
3880 return mExtras == null ? null : mExtras.getBundle(name);
3881 }
3882
3883 /**
3884 * Retrieve extended data from the intent.
3885 *
3886 * @param name The name of the desired item.
3887 *
3888 * @return the value of an item that previously added with putExtra()
3889 * or null if no IBinder value was found.
3890 *
3891 * @see #putExtra(String, IBinder)
3892 *
3893 * @deprecated
3894 * @hide
3895 */
3896 @Deprecated
3897 public IBinder getIBinderExtra(String name) {
3898 return mExtras == null ? null : mExtras.getIBinder(name);
3899 }
3900
3901 /**
3902 * Retrieve extended data from the intent.
3903 *
3904 * @param name The name of the desired item.
3905 * @param defaultValue The default value to return in case no item is
3906 * associated with the key 'name'
3907 *
3908 * @return the value of an item that previously added with putExtra()
3909 * or defaultValue if none was found.
3910 *
3911 * @see #putExtra
3912 *
3913 * @deprecated
3914 * @hide
3915 */
3916 @Deprecated
3917 public Object getExtra(String name, Object defaultValue) {
3918 Object result = defaultValue;
3919 if (mExtras != null) {
3920 Object result2 = mExtras.get(name);
3921 if (result2 != null) {
3922 result = result2;
3923 }
3924 }
3925
3926 return result;
3927 }
3928
3929 /**
3930 * Retrieves a map of extended data from the intent.
3931 *
3932 * @return the map of all extras previously added with putExtra(),
3933 * or null if none have been added.
3934 */
3935 public Bundle getExtras() {
3936 return (mExtras != null)
3937 ? new Bundle(mExtras)
3938 : null;
3939 }
3940
3941 /**
3942 * Retrieve any special flags associated with this intent. You will
3943 * normally just set them with {@link #setFlags} and let the system
3944 * take the appropriate action with them.
3945 *
3946 * @return int The currently set flags.
3947 *
3948 * @see #setFlags
3949 */
3950 public int getFlags() {
3951 return mFlags;
3952 }
3953
Dianne Hackborne7f97212011-02-24 14:40:20 -08003954 /** @hide */
3955 public boolean isExcludingStopped() {
3956 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
3957 == FLAG_EXCLUDE_STOPPED_PACKAGES;
3958 }
3959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003960 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003961 * Retrieve the application package name this Intent is limited to. When
3962 * resolving an Intent, if non-null this limits the resolution to only
3963 * components in the given application package.
3964 *
3965 * @return The name of the application package for the Intent.
3966 *
3967 * @see #resolveActivity
3968 * @see #setPackage
3969 */
3970 public String getPackage() {
3971 return mPackage;
3972 }
3973
3974 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 * Retrieve the concrete component associated with the intent. When receiving
3976 * an intent, this is the component that was found to best handle it (that is,
3977 * yourself) and will always be non-null; in all other cases it will be
3978 * null unless explicitly set.
3979 *
3980 * @return The name of the application component to handle the intent.
3981 *
3982 * @see #resolveActivity
3983 * @see #setComponent
3984 */
3985 public ComponentName getComponent() {
3986 return mComponent;
3987 }
3988
3989 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003990 * Get the bounds of the sender of this intent, in screen coordinates. This can be
3991 * used as a hint to the receiver for animations and the like. Null means that there
3992 * is no source bounds.
3993 */
3994 public Rect getSourceBounds() {
3995 return mSourceBounds;
3996 }
3997
3998 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003999 * Return the Activity component that should be used to handle this intent.
4000 * The appropriate component is determined based on the information in the
4001 * intent, evaluated as follows:
4002 *
4003 * <p>If {@link #getComponent} returns an explicit class, that is returned
4004 * without any further consideration.
4005 *
4006 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4007 * category to be considered.
4008 *
4009 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4010 * action.
4011 *
4012 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4013 * this type.
4014 *
4015 * <p>If {@link #addCategory} has added any categories, the activity must
4016 * handle ALL of the categories specified.
4017 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004018 * <p>If {@link #getPackage} is non-NULL, only activity components in
4019 * that application package will be considered.
4020 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004021 * <p>If there are no activities that satisfy all of these conditions, a
4022 * null string is returned.
4023 *
4024 * <p>If multiple activities are found to satisfy the intent, the one with
4025 * the highest priority will be used. If there are multiple activities
4026 * with the same priority, the system will either pick the best activity
4027 * based on user preference, or resolve to a system class that will allow
4028 * the user to pick an activity and forward from there.
4029 *
4030 * <p>This method is implemented simply by calling
4031 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4032 * true.</p>
4033 * <p> This API is called for you as part of starting an activity from an
4034 * intent. You do not normally need to call it yourself.</p>
4035 *
4036 * @param pm The package manager with which to resolve the Intent.
4037 *
4038 * @return Name of the component implementing an activity that can
4039 * display the intent.
4040 *
4041 * @see #setComponent
4042 * @see #getComponent
4043 * @see #resolveActivityInfo
4044 */
4045 public ComponentName resolveActivity(PackageManager pm) {
4046 if (mComponent != null) {
4047 return mComponent;
4048 }
4049
4050 ResolveInfo info = pm.resolveActivity(
4051 this, PackageManager.MATCH_DEFAULT_ONLY);
4052 if (info != null) {
4053 return new ComponentName(
4054 info.activityInfo.applicationInfo.packageName,
4055 info.activityInfo.name);
4056 }
4057
4058 return null;
4059 }
4060
4061 /**
4062 * Resolve the Intent into an {@link ActivityInfo}
4063 * describing the activity that should execute the intent. Resolution
4064 * follows the same rules as described for {@link #resolveActivity}, but
4065 * you get back the completely information about the resolved activity
4066 * instead of just its class name.
4067 *
4068 * @param pm The package manager with which to resolve the Intent.
4069 * @param flags Addition information to retrieve as per
4070 * {@link PackageManager#getActivityInfo(ComponentName, int)
4071 * PackageManager.getActivityInfo()}.
4072 *
4073 * @return PackageManager.ActivityInfo
4074 *
4075 * @see #resolveActivity
4076 */
4077 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4078 ActivityInfo ai = null;
4079 if (mComponent != null) {
4080 try {
4081 ai = pm.getActivityInfo(mComponent, flags);
4082 } catch (PackageManager.NameNotFoundException e) {
4083 // ignore
4084 }
4085 } else {
4086 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004087 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004088 if (info != null) {
4089 ai = info.activityInfo;
4090 }
4091 }
4092
4093 return ai;
4094 }
4095
4096 /**
4097 * Set the general action to be performed.
4098 *
4099 * @param action An action name, such as ACTION_VIEW. Application-specific
4100 * actions should be prefixed with the vendor's package name.
4101 *
4102 * @return Returns the same Intent object, for chaining multiple calls
4103 * into a single statement.
4104 *
4105 * @see #getAction
4106 */
4107 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004108 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004109 return this;
4110 }
4111
4112 /**
4113 * Set the data this intent is operating on. This method automatically
4114 * clears any type that was previously set by {@link #setType}.
4115 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004116 * <p><em>Note: scheme and host name matching in the Android framework is
4117 * case-sensitive, unlike the formal RFC. As a result,
4118 * you should always ensure that you write your Uri with these elements
4119 * using lower case letters, and normalize any Uris you receive from
4120 * outside of Android to ensure the scheme and host is lower case.</em></p>
4121 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004122 * @param data The URI of the data this intent is now targeting.
4123 *
4124 * @return Returns the same Intent object, for chaining multiple calls
4125 * into a single statement.
4126 *
4127 * @see #getData
4128 * @see #setType
4129 * @see #setDataAndType
4130 */
4131 public Intent setData(Uri data) {
4132 mData = data;
4133 mType = null;
4134 return this;
4135 }
4136
4137 /**
4138 * Set an explicit MIME data type. This is used to create intents that
4139 * only specify a type and not data, for example to indicate the type of
4140 * data to return. This method automatically clears any data that was
4141 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07004142 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004143 * <p><em>Note: MIME type matching in the Android framework is
4144 * case-sensitive, unlike formal RFC MIME types. As a result,
4145 * you should always write your MIME types with lower case letters,
4146 * and any MIME types you receive from outside of Android should be
4147 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004148 *
4149 * @param type The MIME type of the data being handled by this intent.
4150 *
4151 * @return Returns the same Intent object, for chaining multiple calls
4152 * into a single statement.
4153 *
4154 * @see #getType
4155 * @see #setData
4156 * @see #setDataAndType
4157 */
4158 public Intent setType(String type) {
4159 mData = null;
4160 mType = type;
4161 return this;
4162 }
4163
4164 /**
4165 * (Usually optional) Set the data for the intent along with an explicit
4166 * MIME data type. This method should very rarely be used -- it allows you
4167 * to override the MIME type that would ordinarily be inferred from the
4168 * data with your own type given here.
4169 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004170 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
4171 * Android framework is case-sensitive, unlike the formal RFC definitions.
4172 * As a result, you should always write these elements with lower case letters,
4173 * and normalize any MIME types or Uris you receive from
4174 * outside of Android to ensure these elements are lower case before
4175 * supplying them here.</em></p>
4176 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004177 * @param data The URI of the data this intent is now targeting.
4178 * @param type The MIME type of the data being handled by this intent.
4179 *
4180 * @return Returns the same Intent object, for chaining multiple calls
4181 * into a single statement.
4182 *
4183 * @see #setData
4184 * @see #setType
4185 */
4186 public Intent setDataAndType(Uri data, String type) {
4187 mData = data;
4188 mType = type;
4189 return this;
4190 }
4191
4192 /**
4193 * Add a new category to the intent. Categories provide additional detail
4194 * about the action the intent is perform. When resolving an intent, only
4195 * activities that provide <em>all</em> of the requested categories will be
4196 * used.
4197 *
4198 * @param category The desired category. This can be either one of the
4199 * predefined Intent categories, or a custom category in your own
4200 * namespace.
4201 *
4202 * @return Returns the same Intent object, for chaining multiple calls
4203 * into a single statement.
4204 *
4205 * @see #hasCategory
4206 * @see #removeCategory
4207 */
4208 public Intent addCategory(String category) {
4209 if (mCategories == null) {
4210 mCategories = new HashSet<String>();
4211 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004212 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004213 return this;
4214 }
4215
4216 /**
4217 * Remove an category from an intent.
4218 *
4219 * @param category The category to remove.
4220 *
4221 * @see #addCategory
4222 */
4223 public void removeCategory(String category) {
4224 if (mCategories != null) {
4225 mCategories.remove(category);
4226 if (mCategories.size() == 0) {
4227 mCategories = null;
4228 }
4229 }
4230 }
4231
4232 /**
4233 * Add extended data to the intent. The name must include a package
4234 * prefix, for example the app com.android.contacts would use names
4235 * like "com.android.contacts.ShowAll".
4236 *
4237 * @param name The name of the extra data, with package prefix.
4238 * @param value The boolean data value.
4239 *
4240 * @return Returns the same Intent object, for chaining multiple calls
4241 * into a single statement.
4242 *
4243 * @see #putExtras
4244 * @see #removeExtra
4245 * @see #getBooleanExtra(String, boolean)
4246 */
4247 public Intent putExtra(String name, boolean value) {
4248 if (mExtras == null) {
4249 mExtras = new Bundle();
4250 }
4251 mExtras.putBoolean(name, value);
4252 return this;
4253 }
4254
4255 /**
4256 * Add extended data to the intent. The name must include a package
4257 * prefix, for example the app com.android.contacts would use names
4258 * like "com.android.contacts.ShowAll".
4259 *
4260 * @param name The name of the extra data, with package prefix.
4261 * @param value The byte data value.
4262 *
4263 * @return Returns the same Intent object, for chaining multiple calls
4264 * into a single statement.
4265 *
4266 * @see #putExtras
4267 * @see #removeExtra
4268 * @see #getByteExtra(String, byte)
4269 */
4270 public Intent putExtra(String name, byte value) {
4271 if (mExtras == null) {
4272 mExtras = new Bundle();
4273 }
4274 mExtras.putByte(name, value);
4275 return this;
4276 }
4277
4278 /**
4279 * Add extended data to the intent. The name must include a package
4280 * prefix, for example the app com.android.contacts would use names
4281 * like "com.android.contacts.ShowAll".
4282 *
4283 * @param name The name of the extra data, with package prefix.
4284 * @param value The char data value.
4285 *
4286 * @return Returns the same Intent object, for chaining multiple calls
4287 * into a single statement.
4288 *
4289 * @see #putExtras
4290 * @see #removeExtra
4291 * @see #getCharExtra(String, char)
4292 */
4293 public Intent putExtra(String name, char value) {
4294 if (mExtras == null) {
4295 mExtras = new Bundle();
4296 }
4297 mExtras.putChar(name, value);
4298 return this;
4299 }
4300
4301 /**
4302 * Add extended data to the intent. The name must include a package
4303 * prefix, for example the app com.android.contacts would use names
4304 * like "com.android.contacts.ShowAll".
4305 *
4306 * @param name The name of the extra data, with package prefix.
4307 * @param value The short data value.
4308 *
4309 * @return Returns the same Intent object, for chaining multiple calls
4310 * into a single statement.
4311 *
4312 * @see #putExtras
4313 * @see #removeExtra
4314 * @see #getShortExtra(String, short)
4315 */
4316 public Intent putExtra(String name, short value) {
4317 if (mExtras == null) {
4318 mExtras = new Bundle();
4319 }
4320 mExtras.putShort(name, value);
4321 return this;
4322 }
4323
4324 /**
4325 * Add extended data to the intent. The name must include a package
4326 * prefix, for example the app com.android.contacts would use names
4327 * like "com.android.contacts.ShowAll".
4328 *
4329 * @param name The name of the extra data, with package prefix.
4330 * @param value The integer data value.
4331 *
4332 * @return Returns the same Intent object, for chaining multiple calls
4333 * into a single statement.
4334 *
4335 * @see #putExtras
4336 * @see #removeExtra
4337 * @see #getIntExtra(String, int)
4338 */
4339 public Intent putExtra(String name, int value) {
4340 if (mExtras == null) {
4341 mExtras = new Bundle();
4342 }
4343 mExtras.putInt(name, value);
4344 return this;
4345 }
4346
4347 /**
4348 * Add extended data to the intent. The name must include a package
4349 * prefix, for example the app com.android.contacts would use names
4350 * like "com.android.contacts.ShowAll".
4351 *
4352 * @param name The name of the extra data, with package prefix.
4353 * @param value The long data value.
4354 *
4355 * @return Returns the same Intent object, for chaining multiple calls
4356 * into a single statement.
4357 *
4358 * @see #putExtras
4359 * @see #removeExtra
4360 * @see #getLongExtra(String, long)
4361 */
4362 public Intent putExtra(String name, long value) {
4363 if (mExtras == null) {
4364 mExtras = new Bundle();
4365 }
4366 mExtras.putLong(name, value);
4367 return this;
4368 }
4369
4370 /**
4371 * Add extended data to the intent. The name must include a package
4372 * prefix, for example the app com.android.contacts would use names
4373 * like "com.android.contacts.ShowAll".
4374 *
4375 * @param name The name of the extra data, with package prefix.
4376 * @param value The float data value.
4377 *
4378 * @return Returns the same Intent object, for chaining multiple calls
4379 * into a single statement.
4380 *
4381 * @see #putExtras
4382 * @see #removeExtra
4383 * @see #getFloatExtra(String, float)
4384 */
4385 public Intent putExtra(String name, float value) {
4386 if (mExtras == null) {
4387 mExtras = new Bundle();
4388 }
4389 mExtras.putFloat(name, value);
4390 return this;
4391 }
4392
4393 /**
4394 * Add extended data to the intent. The name must include a package
4395 * prefix, for example the app com.android.contacts would use names
4396 * like "com.android.contacts.ShowAll".
4397 *
4398 * @param name The name of the extra data, with package prefix.
4399 * @param value The double data value.
4400 *
4401 * @return Returns the same Intent object, for chaining multiple calls
4402 * into a single statement.
4403 *
4404 * @see #putExtras
4405 * @see #removeExtra
4406 * @see #getDoubleExtra(String, double)
4407 */
4408 public Intent putExtra(String name, double value) {
4409 if (mExtras == null) {
4410 mExtras = new Bundle();
4411 }
4412 mExtras.putDouble(name, value);
4413 return this;
4414 }
4415
4416 /**
4417 * Add extended data to the intent. The name must include a package
4418 * prefix, for example the app com.android.contacts would use names
4419 * like "com.android.contacts.ShowAll".
4420 *
4421 * @param name The name of the extra data, with package prefix.
4422 * @param value The String data value.
4423 *
4424 * @return Returns the same Intent object, for chaining multiple calls
4425 * into a single statement.
4426 *
4427 * @see #putExtras
4428 * @see #removeExtra
4429 * @see #getStringExtra(String)
4430 */
4431 public Intent putExtra(String name, String value) {
4432 if (mExtras == null) {
4433 mExtras = new Bundle();
4434 }
4435 mExtras.putString(name, value);
4436 return this;
4437 }
4438
4439 /**
4440 * Add extended data to the intent. The name must include a package
4441 * prefix, for example the app com.android.contacts would use names
4442 * like "com.android.contacts.ShowAll".
4443 *
4444 * @param name The name of the extra data, with package prefix.
4445 * @param value The CharSequence data value.
4446 *
4447 * @return Returns the same Intent object, for chaining multiple calls
4448 * into a single statement.
4449 *
4450 * @see #putExtras
4451 * @see #removeExtra
4452 * @see #getCharSequenceExtra(String)
4453 */
4454 public Intent putExtra(String name, CharSequence value) {
4455 if (mExtras == null) {
4456 mExtras = new Bundle();
4457 }
4458 mExtras.putCharSequence(name, value);
4459 return this;
4460 }
4461
4462 /**
4463 * Add extended data to the intent. The name must include a package
4464 * prefix, for example the app com.android.contacts would use names
4465 * like "com.android.contacts.ShowAll".
4466 *
4467 * @param name The name of the extra data, with package prefix.
4468 * @param value The Parcelable data value.
4469 *
4470 * @return Returns the same Intent object, for chaining multiple calls
4471 * into a single statement.
4472 *
4473 * @see #putExtras
4474 * @see #removeExtra
4475 * @see #getParcelableExtra(String)
4476 */
4477 public Intent putExtra(String name, Parcelable value) {
4478 if (mExtras == null) {
4479 mExtras = new Bundle();
4480 }
4481 mExtras.putParcelable(name, value);
4482 return this;
4483 }
4484
4485 /**
4486 * Add extended data to the intent. The name must include a package
4487 * prefix, for example the app com.android.contacts would use names
4488 * like "com.android.contacts.ShowAll".
4489 *
4490 * @param name The name of the extra data, with package prefix.
4491 * @param value The Parcelable[] data value.
4492 *
4493 * @return Returns the same Intent object, for chaining multiple calls
4494 * into a single statement.
4495 *
4496 * @see #putExtras
4497 * @see #removeExtra
4498 * @see #getParcelableArrayExtra(String)
4499 */
4500 public Intent putExtra(String name, Parcelable[] value) {
4501 if (mExtras == null) {
4502 mExtras = new Bundle();
4503 }
4504 mExtras.putParcelableArray(name, value);
4505 return this;
4506 }
4507
4508 /**
4509 * Add extended data to the intent. The name must include a package
4510 * prefix, for example the app com.android.contacts would use names
4511 * like "com.android.contacts.ShowAll".
4512 *
4513 * @param name The name of the extra data, with package prefix.
4514 * @param value The ArrayList<Parcelable> data value.
4515 *
4516 * @return Returns the same Intent object, for chaining multiple calls
4517 * into a single statement.
4518 *
4519 * @see #putExtras
4520 * @see #removeExtra
4521 * @see #getParcelableArrayListExtra(String)
4522 */
4523 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4524 if (mExtras == null) {
4525 mExtras = new Bundle();
4526 }
4527 mExtras.putParcelableArrayList(name, value);
4528 return this;
4529 }
4530
4531 /**
4532 * Add extended data to the intent. The name must include a package
4533 * prefix, for example the app com.android.contacts would use names
4534 * like "com.android.contacts.ShowAll".
4535 *
4536 * @param name The name of the extra data, with package prefix.
4537 * @param value The ArrayList<Integer> data value.
4538 *
4539 * @return Returns the same Intent object, for chaining multiple calls
4540 * into a single statement.
4541 *
4542 * @see #putExtras
4543 * @see #removeExtra
4544 * @see #getIntegerArrayListExtra(String)
4545 */
4546 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4547 if (mExtras == null) {
4548 mExtras = new Bundle();
4549 }
4550 mExtras.putIntegerArrayList(name, value);
4551 return this;
4552 }
4553
4554 /**
4555 * Add extended data to the intent. The name must include a package
4556 * prefix, for example the app com.android.contacts would use names
4557 * like "com.android.contacts.ShowAll".
4558 *
4559 * @param name The name of the extra data, with package prefix.
4560 * @param value The ArrayList<String> data value.
4561 *
4562 * @return Returns the same Intent object, for chaining multiple calls
4563 * into a single statement.
4564 *
4565 * @see #putExtras
4566 * @see #removeExtra
4567 * @see #getStringArrayListExtra(String)
4568 */
4569 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4570 if (mExtras == null) {
4571 mExtras = new Bundle();
4572 }
4573 mExtras.putStringArrayList(name, value);
4574 return this;
4575 }
4576
4577 /**
4578 * Add extended data to the intent. The name must include a package
4579 * prefix, for example the app com.android.contacts would use names
4580 * like "com.android.contacts.ShowAll".
4581 *
4582 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004583 * @param value The ArrayList<CharSequence> data value.
4584 *
4585 * @return Returns the same Intent object, for chaining multiple calls
4586 * into a single statement.
4587 *
4588 * @see #putExtras
4589 * @see #removeExtra
4590 * @see #getCharSequenceArrayListExtra(String)
4591 */
4592 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4593 if (mExtras == null) {
4594 mExtras = new Bundle();
4595 }
4596 mExtras.putCharSequenceArrayList(name, value);
4597 return this;
4598 }
4599
4600 /**
4601 * Add extended data to the intent. The name must include a package
4602 * prefix, for example the app com.android.contacts would use names
4603 * like "com.android.contacts.ShowAll".
4604 *
4605 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004606 * @param value The Serializable data value.
4607 *
4608 * @return Returns the same Intent object, for chaining multiple calls
4609 * into a single statement.
4610 *
4611 * @see #putExtras
4612 * @see #removeExtra
4613 * @see #getSerializableExtra(String)
4614 */
4615 public Intent putExtra(String name, Serializable value) {
4616 if (mExtras == null) {
4617 mExtras = new Bundle();
4618 }
4619 mExtras.putSerializable(name, value);
4620 return this;
4621 }
4622
4623 /**
4624 * Add extended data to the intent. The name must include a package
4625 * prefix, for example the app com.android.contacts would use names
4626 * like "com.android.contacts.ShowAll".
4627 *
4628 * @param name The name of the extra data, with package prefix.
4629 * @param value The boolean array data value.
4630 *
4631 * @return Returns the same Intent object, for chaining multiple calls
4632 * into a single statement.
4633 *
4634 * @see #putExtras
4635 * @see #removeExtra
4636 * @see #getBooleanArrayExtra(String)
4637 */
4638 public Intent putExtra(String name, boolean[] value) {
4639 if (mExtras == null) {
4640 mExtras = new Bundle();
4641 }
4642 mExtras.putBooleanArray(name, value);
4643 return this;
4644 }
4645
4646 /**
4647 * Add extended data to the intent. The name must include a package
4648 * prefix, for example the app com.android.contacts would use names
4649 * like "com.android.contacts.ShowAll".
4650 *
4651 * @param name The name of the extra data, with package prefix.
4652 * @param value The byte array data value.
4653 *
4654 * @return Returns the same Intent object, for chaining multiple calls
4655 * into a single statement.
4656 *
4657 * @see #putExtras
4658 * @see #removeExtra
4659 * @see #getByteArrayExtra(String)
4660 */
4661 public Intent putExtra(String name, byte[] value) {
4662 if (mExtras == null) {
4663 mExtras = new Bundle();
4664 }
4665 mExtras.putByteArray(name, value);
4666 return this;
4667 }
4668
4669 /**
4670 * Add extended data to the intent. The name must include a package
4671 * prefix, for example the app com.android.contacts would use names
4672 * like "com.android.contacts.ShowAll".
4673 *
4674 * @param name The name of the extra data, with package prefix.
4675 * @param value The short array data value.
4676 *
4677 * @return Returns the same Intent object, for chaining multiple calls
4678 * into a single statement.
4679 *
4680 * @see #putExtras
4681 * @see #removeExtra
4682 * @see #getShortArrayExtra(String)
4683 */
4684 public Intent putExtra(String name, short[] value) {
4685 if (mExtras == null) {
4686 mExtras = new Bundle();
4687 }
4688 mExtras.putShortArray(name, value);
4689 return this;
4690 }
4691
4692 /**
4693 * Add extended data to the intent. The name must include a package
4694 * prefix, for example the app com.android.contacts would use names
4695 * like "com.android.contacts.ShowAll".
4696 *
4697 * @param name The name of the extra data, with package prefix.
4698 * @param value The char array data value.
4699 *
4700 * @return Returns the same Intent object, for chaining multiple calls
4701 * into a single statement.
4702 *
4703 * @see #putExtras
4704 * @see #removeExtra
4705 * @see #getCharArrayExtra(String)
4706 */
4707 public Intent putExtra(String name, char[] value) {
4708 if (mExtras == null) {
4709 mExtras = new Bundle();
4710 }
4711 mExtras.putCharArray(name, value);
4712 return this;
4713 }
4714
4715 /**
4716 * Add extended data to the intent. The name must include a package
4717 * prefix, for example the app com.android.contacts would use names
4718 * like "com.android.contacts.ShowAll".
4719 *
4720 * @param name The name of the extra data, with package prefix.
4721 * @param value The int array data value.
4722 *
4723 * @return Returns the same Intent object, for chaining multiple calls
4724 * into a single statement.
4725 *
4726 * @see #putExtras
4727 * @see #removeExtra
4728 * @see #getIntArrayExtra(String)
4729 */
4730 public Intent putExtra(String name, int[] value) {
4731 if (mExtras == null) {
4732 mExtras = new Bundle();
4733 }
4734 mExtras.putIntArray(name, value);
4735 return this;
4736 }
4737
4738 /**
4739 * Add extended data to the intent. The name must include a package
4740 * prefix, for example the app com.android.contacts would use names
4741 * like "com.android.contacts.ShowAll".
4742 *
4743 * @param name The name of the extra data, with package prefix.
4744 * @param value The byte array data value.
4745 *
4746 * @return Returns the same Intent object, for chaining multiple calls
4747 * into a single statement.
4748 *
4749 * @see #putExtras
4750 * @see #removeExtra
4751 * @see #getLongArrayExtra(String)
4752 */
4753 public Intent putExtra(String name, long[] value) {
4754 if (mExtras == null) {
4755 mExtras = new Bundle();
4756 }
4757 mExtras.putLongArray(name, value);
4758 return this;
4759 }
4760
4761 /**
4762 * Add extended data to the intent. The name must include a package
4763 * prefix, for example the app com.android.contacts would use names
4764 * like "com.android.contacts.ShowAll".
4765 *
4766 * @param name The name of the extra data, with package prefix.
4767 * @param value The float array data value.
4768 *
4769 * @return Returns the same Intent object, for chaining multiple calls
4770 * into a single statement.
4771 *
4772 * @see #putExtras
4773 * @see #removeExtra
4774 * @see #getFloatArrayExtra(String)
4775 */
4776 public Intent putExtra(String name, float[] value) {
4777 if (mExtras == null) {
4778 mExtras = new Bundle();
4779 }
4780 mExtras.putFloatArray(name, value);
4781 return this;
4782 }
4783
4784 /**
4785 * Add extended data to the intent. The name must include a package
4786 * prefix, for example the app com.android.contacts would use names
4787 * like "com.android.contacts.ShowAll".
4788 *
4789 * @param name The name of the extra data, with package prefix.
4790 * @param value The double array data value.
4791 *
4792 * @return Returns the same Intent object, for chaining multiple calls
4793 * into a single statement.
4794 *
4795 * @see #putExtras
4796 * @see #removeExtra
4797 * @see #getDoubleArrayExtra(String)
4798 */
4799 public Intent putExtra(String name, double[] value) {
4800 if (mExtras == null) {
4801 mExtras = new Bundle();
4802 }
4803 mExtras.putDoubleArray(name, value);
4804 return this;
4805 }
4806
4807 /**
4808 * Add extended data to the intent. The name must include a package
4809 * prefix, for example the app com.android.contacts would use names
4810 * like "com.android.contacts.ShowAll".
4811 *
4812 * @param name The name of the extra data, with package prefix.
4813 * @param value The String array data value.
4814 *
4815 * @return Returns the same Intent object, for chaining multiple calls
4816 * into a single statement.
4817 *
4818 * @see #putExtras
4819 * @see #removeExtra
4820 * @see #getStringArrayExtra(String)
4821 */
4822 public Intent putExtra(String name, String[] value) {
4823 if (mExtras == null) {
4824 mExtras = new Bundle();
4825 }
4826 mExtras.putStringArray(name, value);
4827 return this;
4828 }
4829
4830 /**
4831 * Add extended data to the intent. The name must include a package
4832 * prefix, for example the app com.android.contacts would use names
4833 * like "com.android.contacts.ShowAll".
4834 *
4835 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004836 * @param value The CharSequence array data value.
4837 *
4838 * @return Returns the same Intent object, for chaining multiple calls
4839 * into a single statement.
4840 *
4841 * @see #putExtras
4842 * @see #removeExtra
4843 * @see #getCharSequenceArrayExtra(String)
4844 */
4845 public Intent putExtra(String name, CharSequence[] value) {
4846 if (mExtras == null) {
4847 mExtras = new Bundle();
4848 }
4849 mExtras.putCharSequenceArray(name, value);
4850 return this;
4851 }
4852
4853 /**
4854 * Add extended data to the intent. The name must include a package
4855 * prefix, for example the app com.android.contacts would use names
4856 * like "com.android.contacts.ShowAll".
4857 *
4858 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004859 * @param value The Bundle data value.
4860 *
4861 * @return Returns the same Intent object, for chaining multiple calls
4862 * into a single statement.
4863 *
4864 * @see #putExtras
4865 * @see #removeExtra
4866 * @see #getBundleExtra(String)
4867 */
4868 public Intent putExtra(String name, Bundle value) {
4869 if (mExtras == null) {
4870 mExtras = new Bundle();
4871 }
4872 mExtras.putBundle(name, value);
4873 return this;
4874 }
4875
4876 /**
4877 * Add extended data to the intent. The name must include a package
4878 * prefix, for example the app com.android.contacts would use names
4879 * like "com.android.contacts.ShowAll".
4880 *
4881 * @param name The name of the extra data, with package prefix.
4882 * @param value The IBinder data value.
4883 *
4884 * @return Returns the same Intent object, for chaining multiple calls
4885 * into a single statement.
4886 *
4887 * @see #putExtras
4888 * @see #removeExtra
4889 * @see #getIBinderExtra(String)
4890 *
4891 * @deprecated
4892 * @hide
4893 */
4894 @Deprecated
4895 public Intent putExtra(String name, IBinder value) {
4896 if (mExtras == null) {
4897 mExtras = new Bundle();
4898 }
4899 mExtras.putIBinder(name, value);
4900 return this;
4901 }
4902
4903 /**
4904 * Copy all extras in 'src' in to this intent.
4905 *
4906 * @param src Contains the extras to copy.
4907 *
4908 * @see #putExtra
4909 */
4910 public Intent putExtras(Intent src) {
4911 if (src.mExtras != null) {
4912 if (mExtras == null) {
4913 mExtras = new Bundle(src.mExtras);
4914 } else {
4915 mExtras.putAll(src.mExtras);
4916 }
4917 }
4918 return this;
4919 }
4920
4921 /**
4922 * Add a set of extended data to the intent. The keys must include a package
4923 * prefix, for example the app com.android.contacts would use names
4924 * like "com.android.contacts.ShowAll".
4925 *
4926 * @param extras The Bundle of extras to add to this intent.
4927 *
4928 * @see #putExtra
4929 * @see #removeExtra
4930 */
4931 public Intent putExtras(Bundle extras) {
4932 if (mExtras == null) {
4933 mExtras = new Bundle();
4934 }
4935 mExtras.putAll(extras);
4936 return this;
4937 }
4938
4939 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004940 * Completely replace the extras in the Intent with the extras in the
4941 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004942 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004943 * @param src The exact extras contained in this Intent are copied
4944 * into the target intent, replacing any that were previously there.
4945 */
4946 public Intent replaceExtras(Intent src) {
4947 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4948 return this;
4949 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004950
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004951 /**
4952 * Completely replace the extras in the Intent with the given Bundle of
4953 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004954 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004955 * @param extras The new set of extras in the Intent, or null to erase
4956 * all extras.
4957 */
4958 public Intent replaceExtras(Bundle extras) {
4959 mExtras = extras != null ? new Bundle(extras) : null;
4960 return this;
4961 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004962
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004963 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004964 * Remove extended data from the intent.
4965 *
4966 * @see #putExtra
4967 */
4968 public void removeExtra(String name) {
4969 if (mExtras != null) {
4970 mExtras.remove(name);
4971 if (mExtras.size() == 0) {
4972 mExtras = null;
4973 }
4974 }
4975 }
4976
4977 /**
4978 * Set special flags controlling how this intent is handled. Most values
4979 * here depend on the type of component being executed by the Intent,
4980 * specifically the FLAG_ACTIVITY_* flags are all for use with
4981 * {@link Context#startActivity Context.startActivity()} and the
4982 * FLAG_RECEIVER_* flags are all for use with
4983 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4984 *
Scott Main7aee61f2011-02-08 11:25:01 -08004985 * <p>See the
4986 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4987 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004988 * the behavior of your application.
4989 *
4990 * @param flags The desired flags.
4991 *
4992 * @return Returns the same Intent object, for chaining multiple calls
4993 * into a single statement.
4994 *
4995 * @see #getFlags
4996 * @see #addFlags
4997 *
4998 * @see #FLAG_GRANT_READ_URI_PERMISSION
4999 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5000 * @see #FLAG_DEBUG_LOG_RESOLUTION
5001 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005002 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005003 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005004 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005005 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005006 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5007 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005008 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005009 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5010 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005011 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005012 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005013 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005014 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5015 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005016 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005018 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5020 */
5021 public Intent setFlags(int flags) {
5022 mFlags = flags;
5023 return this;
5024 }
5025
5026 /**
5027 * Add additional flags to the intent (or with existing flags
5028 * value).
5029 *
5030 * @param flags The new flags to set.
5031 *
5032 * @return Returns the same Intent object, for chaining multiple calls
5033 * into a single statement.
5034 *
5035 * @see #setFlags
5036 */
5037 public Intent addFlags(int flags) {
5038 mFlags |= flags;
5039 return this;
5040 }
5041
5042 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005043 * (Usually optional) Set an explicit application package name that limits
5044 * the components this Intent will resolve to. If left to the default
5045 * value of null, all components in all applications will considered.
5046 * If non-null, the Intent can only match the components in the given
5047 * application package.
5048 *
5049 * @param packageName The name of the application package to handle the
5050 * intent, or null to allow any application package.
5051 *
5052 * @return Returns the same Intent object, for chaining multiple calls
5053 * into a single statement.
5054 *
5055 * @see #getPackage
5056 * @see #resolveActivity
5057 */
5058 public Intent setPackage(String packageName) {
5059 mPackage = packageName;
5060 return this;
5061 }
5062
5063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 * (Usually optional) Explicitly set the component to handle the intent.
5065 * If left with the default value of null, the system will determine the
5066 * appropriate class to use based on the other fields (action, data,
5067 * type, categories) in the Intent. If this class is defined, the
5068 * specified class will always be used regardless of the other fields. You
5069 * should only set this value when you know you absolutely want a specific
5070 * class to be used; otherwise it is better to let the system find the
5071 * appropriate class so that you will respect the installed applications
5072 * and user preferences.
5073 *
5074 * @param component The name of the application component to handle the
5075 * intent, or null to let the system find one for you.
5076 *
5077 * @return Returns the same Intent object, for chaining multiple calls
5078 * into a single statement.
5079 *
5080 * @see #setClass
5081 * @see #setClassName(Context, String)
5082 * @see #setClassName(String, String)
5083 * @see #getComponent
5084 * @see #resolveActivity
5085 */
5086 public Intent setComponent(ComponentName component) {
5087 mComponent = component;
5088 return this;
5089 }
5090
5091 /**
5092 * Convenience for calling {@link #setComponent} with an
5093 * explicit class name.
5094 *
5095 * @param packageContext A Context of the application package implementing
5096 * this class.
5097 * @param className The name of a class inside of the application package
5098 * that will be used as the component for this Intent.
5099 *
5100 * @return Returns the same Intent object, for chaining multiple calls
5101 * into a single statement.
5102 *
5103 * @see #setComponent
5104 * @see #setClass
5105 */
5106 public Intent setClassName(Context packageContext, String className) {
5107 mComponent = new ComponentName(packageContext, className);
5108 return this;
5109 }
5110
5111 /**
5112 * Convenience for calling {@link #setComponent} with an
5113 * explicit application package name and class name.
5114 *
5115 * @param packageName The name of the package implementing the desired
5116 * component.
5117 * @param className The name of a class inside of the application package
5118 * that will be used as the component for this Intent.
5119 *
5120 * @return Returns the same Intent object, for chaining multiple calls
5121 * into a single statement.
5122 *
5123 * @see #setComponent
5124 * @see #setClass
5125 */
5126 public Intent setClassName(String packageName, String className) {
5127 mComponent = new ComponentName(packageName, className);
5128 return this;
5129 }
5130
5131 /**
5132 * Convenience for calling {@link #setComponent(ComponentName)} with the
5133 * name returned by a {@link Class} object.
5134 *
5135 * @param packageContext A Context of the application package implementing
5136 * this class.
5137 * @param cls The class name to set, equivalent to
5138 * <code>setClassName(context, cls.getName())</code>.
5139 *
5140 * @return Returns the same Intent object, for chaining multiple calls
5141 * into a single statement.
5142 *
5143 * @see #setComponent
5144 */
5145 public Intent setClass(Context packageContext, Class<?> cls) {
5146 mComponent = new ComponentName(packageContext, cls);
5147 return this;
5148 }
5149
5150 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005151 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5152 * used as a hint to the receiver for animations and the like. Null means that there
5153 * is no source bounds.
5154 */
5155 public void setSourceBounds(Rect r) {
5156 if (r != null) {
5157 mSourceBounds = new Rect(r);
5158 } else {
5159 r = null;
5160 }
5161 }
5162
5163 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005164 * Use with {@link #fillIn} to allow the current action value to be
5165 * overwritten, even if it is already set.
5166 */
5167 public static final int FILL_IN_ACTION = 1<<0;
5168
5169 /**
5170 * Use with {@link #fillIn} to allow the current data or type value
5171 * overwritten, even if it is already set.
5172 */
5173 public static final int FILL_IN_DATA = 1<<1;
5174
5175 /**
5176 * Use with {@link #fillIn} to allow the current categories to be
5177 * overwritten, even if they are already set.
5178 */
5179 public static final int FILL_IN_CATEGORIES = 1<<2;
5180
5181 /**
5182 * Use with {@link #fillIn} to allow the current component value to be
5183 * overwritten, even if it is already set.
5184 */
5185 public static final int FILL_IN_COMPONENT = 1<<3;
5186
5187 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005188 * Use with {@link #fillIn} to allow the current package value to be
5189 * overwritten, even if it is already set.
5190 */
5191 public static final int FILL_IN_PACKAGE = 1<<4;
5192
5193 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005194 * Use with {@link #fillIn} to allow the current package value to be
5195 * overwritten, even if it is already set.
5196 */
5197 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5198
5199 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005200 * Copy the contents of <var>other</var> in to this object, but only
5201 * where fields are not defined by this object. For purposes of a field
5202 * being defined, the following pieces of data in the Intent are
5203 * considered to be separate fields:
5204 *
5205 * <ul>
5206 * <li> action, as set by {@link #setAction}.
5207 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
5208 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5209 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005210 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005211 * <li> component, as set by {@link #setComponent(ComponentName)} or
5212 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005213 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005214 * <li> each top-level name in the associated extras.
5215 * </ul>
5216 *
5217 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005218 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5219 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005220 * corresponding field will not be replaced if it is already set.
5221 *
Brett Chabot3e391752009-07-21 16:07:23 -07005222 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
5223 * specified.
5224 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005225 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5226 * and Intent B with {action="gotit", data-type="some/thing",
5227 * categories="one","two"}.
5228 *
5229 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5230 * containing: {action="gotit", data-type="some/thing",
5231 * categories="bar"}.
5232 *
5233 * @param other Another Intent whose values are to be used to fill in
5234 * the current one.
5235 * @param flags Options to control which fields can be filled in.
5236 *
5237 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005238 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5239 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005240 */
5241 public int fillIn(Intent other, int flags) {
5242 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005243 if (other.mAction != null
5244 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005245 mAction = other.mAction;
5246 changes |= FILL_IN_ACTION;
5247 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005248 if ((other.mData != null || other.mType != null)
5249 && ((mData == null && mType == null)
5250 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005251 mData = other.mData;
5252 mType = other.mType;
5253 changes |= FILL_IN_DATA;
5254 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005255 if (other.mCategories != null
5256 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005257 if (other.mCategories != null) {
5258 mCategories = new HashSet<String>(other.mCategories);
5259 }
5260 changes |= FILL_IN_CATEGORIES;
5261 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005262 if (other.mPackage != null
5263 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5264 mPackage = other.mPackage;
5265 changes |= FILL_IN_PACKAGE;
5266 }
5267 // Component is special: it can -only- be set if explicitly allowed,
5268 // since otherwise the sender could force the intent somewhere the
5269 // originator didn't intend.
5270 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005271 mComponent = other.mComponent;
5272 changes |= FILL_IN_COMPONENT;
5273 }
5274 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005275 if (other.mSourceBounds != null
5276 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5277 mSourceBounds = new Rect(other.mSourceBounds);
5278 changes |= FILL_IN_SOURCE_BOUNDS;
5279 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280 if (mExtras == null) {
5281 if (other.mExtras != null) {
5282 mExtras = new Bundle(other.mExtras);
5283 }
5284 } else if (other.mExtras != null) {
5285 try {
5286 Bundle newb = new Bundle(other.mExtras);
5287 newb.putAll(mExtras);
5288 mExtras = newb;
5289 } catch (RuntimeException e) {
5290 // Modifying the extras can cause us to unparcel the contents
5291 // of the bundle, and if we do this in the system process that
5292 // may fail. We really should handle this (i.e., the Bundle
5293 // impl shouldn't be on top of a plain map), but for now just
5294 // ignore it and keep the original contents. :(
5295 Log.w("Intent", "Failure filling in extras", e);
5296 }
5297 }
5298 return changes;
5299 }
5300
5301 /**
5302 * Wrapper class holding an Intent and implementing comparisons on it for
5303 * the purpose of filtering. The class implements its
5304 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5305 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5306 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5307 * on the wrapped Intent.
5308 */
5309 public static final class FilterComparison {
5310 private final Intent mIntent;
5311 private final int mHashCode;
5312
5313 public FilterComparison(Intent intent) {
5314 mIntent = intent;
5315 mHashCode = intent.filterHashCode();
5316 }
5317
5318 /**
5319 * Return the Intent that this FilterComparison represents.
5320 * @return Returns the Intent held by the FilterComparison. Do
5321 * not modify!
5322 */
5323 public Intent getIntent() {
5324 return mIntent;
5325 }
5326
5327 @Override
5328 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005329 if (obj instanceof FilterComparison) {
5330 Intent other = ((FilterComparison)obj).mIntent;
5331 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005332 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005333 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005334 }
5335
5336 @Override
5337 public int hashCode() {
5338 return mHashCode;
5339 }
5340 }
5341
5342 /**
5343 * Determine if two intents are the same for the purposes of intent
5344 * resolution (filtering). That is, if their action, data, type,
5345 * class, and categories are the same. This does <em>not</em> compare
5346 * any extra data included in the intents.
5347 *
5348 * @param other The other Intent to compare against.
5349 *
5350 * @return Returns true if action, data, type, class, and categories
5351 * are the same.
5352 */
5353 public boolean filterEquals(Intent other) {
5354 if (other == null) {
5355 return false;
5356 }
5357 if (mAction != other.mAction) {
5358 if (mAction != null) {
5359 if (!mAction.equals(other.mAction)) {
5360 return false;
5361 }
5362 } else {
5363 if (!other.mAction.equals(mAction)) {
5364 return false;
5365 }
5366 }
5367 }
5368 if (mData != other.mData) {
5369 if (mData != null) {
5370 if (!mData.equals(other.mData)) {
5371 return false;
5372 }
5373 } else {
5374 if (!other.mData.equals(mData)) {
5375 return false;
5376 }
5377 }
5378 }
5379 if (mType != other.mType) {
5380 if (mType != null) {
5381 if (!mType.equals(other.mType)) {
5382 return false;
5383 }
5384 } else {
5385 if (!other.mType.equals(mType)) {
5386 return false;
5387 }
5388 }
5389 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005390 if (mPackage != other.mPackage) {
5391 if (mPackage != null) {
5392 if (!mPackage.equals(other.mPackage)) {
5393 return false;
5394 }
5395 } else {
5396 if (!other.mPackage.equals(mPackage)) {
5397 return false;
5398 }
5399 }
5400 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005401 if (mComponent != other.mComponent) {
5402 if (mComponent != null) {
5403 if (!mComponent.equals(other.mComponent)) {
5404 return false;
5405 }
5406 } else {
5407 if (!other.mComponent.equals(mComponent)) {
5408 return false;
5409 }
5410 }
5411 }
5412 if (mCategories != other.mCategories) {
5413 if (mCategories != null) {
5414 if (!mCategories.equals(other.mCategories)) {
5415 return false;
5416 }
5417 } else {
5418 if (!other.mCategories.equals(mCategories)) {
5419 return false;
5420 }
5421 }
5422 }
5423
5424 return true;
5425 }
5426
5427 /**
5428 * Generate hash code that matches semantics of filterEquals().
5429 *
5430 * @return Returns the hash value of the action, data, type, class, and
5431 * categories.
5432 *
5433 * @see #filterEquals
5434 */
5435 public int filterHashCode() {
5436 int code = 0;
5437 if (mAction != null) {
5438 code += mAction.hashCode();
5439 }
5440 if (mData != null) {
5441 code += mData.hashCode();
5442 }
5443 if (mType != null) {
5444 code += mType.hashCode();
5445 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005446 if (mPackage != null) {
5447 code += mPackage.hashCode();
5448 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005449 if (mComponent != null) {
5450 code += mComponent.hashCode();
5451 }
5452 if (mCategories != null) {
5453 code += mCategories.hashCode();
5454 }
5455 return code;
5456 }
5457
5458 @Override
5459 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005460 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005461
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005462 b.append("Intent { ");
5463 toShortString(b, true, true);
5464 b.append(" }");
5465
5466 return b.toString();
5467 }
5468
5469 /** @hide */
5470 public String toShortString(boolean comp, boolean extras) {
5471 StringBuilder b = new StringBuilder(128);
5472 toShortString(b, comp, extras);
5473 return b.toString();
5474 }
Romain Guy4969af72009-06-17 10:53:19 -07005475
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005476 /** @hide */
5477 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5478 boolean first = true;
5479 if (mAction != null) {
5480 b.append("act=").append(mAction);
5481 first = false;
5482 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005483 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005484 if (!first) {
5485 b.append(' ');
5486 }
5487 first = false;
5488 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005489 Iterator<String> i = mCategories.iterator();
5490 boolean didone = false;
5491 while (i.hasNext()) {
5492 if (didone) b.append(",");
5493 didone = true;
5494 b.append(i.next());
5495 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005496 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005497 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005498 if (mData != null) {
5499 if (!first) {
5500 b.append(' ');
5501 }
5502 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005503 b.append("dat=");
Wink Savillec491ee02010-10-13 11:40:10 -07005504 String scheme = mData.getScheme();
5505 if (scheme != null) {
5506 if (scheme.equalsIgnoreCase("tel")) {
5507 b.append("tel:xxx-xxx-xxxx");
5508 } else if (scheme.equalsIgnoreCase("smsto")) {
5509 b.append("smsto:xxx-xxx-xxxx");
5510 } else {
5511 b.append(mData);
5512 }
Wink Savillea4288072010-10-12 12:36:38 -07005513 } else {
5514 b.append(mData);
5515 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005516 }
5517 if (mType != null) {
5518 if (!first) {
5519 b.append(' ');
5520 }
5521 first = false;
5522 b.append("typ=").append(mType);
5523 }
5524 if (mFlags != 0) {
5525 if (!first) {
5526 b.append(' ');
5527 }
5528 first = false;
5529 b.append("flg=0x").append(Integer.toHexString(mFlags));
5530 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005531 if (mPackage != null) {
5532 if (!first) {
5533 b.append(' ');
5534 }
5535 first = false;
5536 b.append("pkg=").append(mPackage);
5537 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005538 if (comp && mComponent != null) {
5539 if (!first) {
5540 b.append(' ');
5541 }
5542 first = false;
5543 b.append("cmp=").append(mComponent.flattenToShortString());
5544 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005545 if (mSourceBounds != null) {
5546 if (!first) {
5547 b.append(' ');
5548 }
5549 first = false;
5550 b.append("bnds=").append(mSourceBounds.toShortString());
5551 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005552 if (extras && mExtras != null) {
5553 if (!first) {
5554 b.append(' ');
5555 }
5556 first = false;
5557 b.append("(has extras)");
5558 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005559 }
5560
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005561 /**
5562 * Call {@link #toUri} with 0 flags.
5563 * @deprecated Use {@link #toUri} instead.
5564 */
5565 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005566 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005567 return toUri(0);
5568 }
5569
5570 /**
5571 * Convert this Intent into a String holding a URI representation of it.
5572 * The returned URI string has been properly URI encoded, so it can be
5573 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5574 * Intent's data as the base URI, with an additional fragment describing
5575 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005576 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005577 * <p>You can convert the returned string back to an Intent with
5578 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005579 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005580 * @param flags Additional operating flags. Either 0 or
5581 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005582 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005583 * @return Returns a URI encoding URI string describing the entire contents
5584 * of the Intent.
5585 */
5586 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005587 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005588 String scheme = null;
5589 if (mData != null) {
5590 String data = mData.toString();
5591 if ((flags&URI_INTENT_SCHEME) != 0) {
5592 final int N = data.length();
5593 for (int i=0; i<N; i++) {
5594 char c = data.charAt(i);
5595 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5596 || c == '.' || c == '-') {
5597 continue;
5598 }
5599 if (c == ':' && i > 0) {
5600 // Valid scheme.
5601 scheme = data.substring(0, i);
5602 uri.append("intent:");
5603 data = data.substring(i+1);
5604 break;
5605 }
Tom Taylord4a47292009-12-21 13:59:18 -08005606
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005607 // No scheme.
5608 break;
5609 }
5610 }
5611 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005612
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005613 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5614 uri.append("intent:");
5615 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005616
5617 uri.append("#Intent;");
5618
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005619 if (scheme != null) {
5620 uri.append("scheme=").append(scheme).append(';');
5621 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005622 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005623 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005624 }
5625 if (mCategories != null) {
5626 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005627 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005628 }
5629 }
5630 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005631 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005632 }
5633 if (mFlags != 0) {
5634 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5635 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005636 if (mPackage != null) {
5637 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5638 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005639 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005640 uri.append("component=").append(Uri.encode(
5641 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005642 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005643 if (mSourceBounds != null) {
5644 uri.append("sourceBounds=")
5645 .append(Uri.encode(mSourceBounds.flattenToString()))
5646 .append(';');
5647 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005648 if (mExtras != null) {
5649 for (String key : mExtras.keySet()) {
5650 final Object value = mExtras.get(key);
5651 char entryType =
5652 value instanceof String ? 'S' :
5653 value instanceof Boolean ? 'B' :
5654 value instanceof Byte ? 'b' :
5655 value instanceof Character ? 'c' :
5656 value instanceof Double ? 'd' :
5657 value instanceof Float ? 'f' :
5658 value instanceof Integer ? 'i' :
5659 value instanceof Long ? 'l' :
5660 value instanceof Short ? 's' :
5661 '\0';
5662
5663 if (entryType != '\0') {
5664 uri.append(entryType);
5665 uri.append('.');
5666 uri.append(Uri.encode(key));
5667 uri.append('=');
5668 uri.append(Uri.encode(value.toString()));
5669 uri.append(';');
5670 }
5671 }
5672 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005673
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005674 uri.append("end");
5675
5676 return uri.toString();
5677 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005678
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005679 public int describeContents() {
5680 return (mExtras != null) ? mExtras.describeContents() : 0;
5681 }
5682
5683 public void writeToParcel(Parcel out, int flags) {
5684 out.writeString(mAction);
5685 Uri.writeToParcel(out, mData);
5686 out.writeString(mType);
5687 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005688 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005689 ComponentName.writeToParcel(mComponent, out);
5690
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005691 if (mSourceBounds != null) {
5692 out.writeInt(1);
5693 mSourceBounds.writeToParcel(out, flags);
5694 } else {
5695 out.writeInt(0);
5696 }
5697
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005698 if (mCategories != null) {
5699 out.writeInt(mCategories.size());
5700 for (String category : mCategories) {
5701 out.writeString(category);
5702 }
5703 } else {
5704 out.writeInt(0);
5705 }
5706
5707 out.writeBundle(mExtras);
5708 }
5709
5710 public static final Parcelable.Creator<Intent> CREATOR
5711 = new Parcelable.Creator<Intent>() {
5712 public Intent createFromParcel(Parcel in) {
5713 return new Intent(in);
5714 }
5715 public Intent[] newArray(int size) {
5716 return new Intent[size];
5717 }
5718 };
5719
Dianne Hackborneb034652009-09-07 00:49:58 -07005720 /** @hide */
5721 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005722 readFromParcel(in);
5723 }
5724
5725 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005726 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005727 mData = Uri.CREATOR.createFromParcel(in);
5728 mType = in.readString();
5729 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005730 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005731 mComponent = ComponentName.readFromParcel(in);
5732
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005733 if (in.readInt() != 0) {
5734 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5735 }
5736
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 int N = in.readInt();
5738 if (N > 0) {
5739 mCategories = new HashSet<String>();
5740 int i;
5741 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005742 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005743 }
5744 } else {
5745 mCategories = null;
5746 }
5747
5748 mExtras = in.readBundle();
5749 }
5750
5751 /**
5752 * Parses the "intent" element (and its children) from XML and instantiates
5753 * an Intent object. The given XML parser should be located at the tag
5754 * where parsing should start (often named "intent"), from which the
5755 * basic action, data, type, and package and class name will be
5756 * retrieved. The function will then parse in to any child elements,
5757 * looking for <category android:name="xxx"> tags to add categories and
5758 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5759 * to the intent.
5760 *
5761 * @param resources The Resources to use when inflating resources.
5762 * @param parser The XML parser pointing at an "intent" tag.
5763 * @param attrs The AttributeSet interface for retrieving extended
5764 * attribute data at the current <var>parser</var> location.
5765 * @return An Intent object matching the XML data.
5766 * @throws XmlPullParserException If there was an XML parsing error.
5767 * @throws IOException If there was an I/O error.
5768 */
5769 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5770 throws XmlPullParserException, IOException {
5771 Intent intent = new Intent();
5772
5773 TypedArray sa = resources.obtainAttributes(attrs,
5774 com.android.internal.R.styleable.Intent);
5775
5776 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5777
5778 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5779 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5780 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5781
5782 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5783 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5784 if (packageName != null && className != null) {
5785 intent.setComponent(new ComponentName(packageName, className));
5786 }
5787
5788 sa.recycle();
5789
5790 int outerDepth = parser.getDepth();
5791 int type;
5792 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5793 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5794 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5795 continue;
5796 }
5797
5798 String nodeName = parser.getName();
5799 if (nodeName.equals("category")) {
5800 sa = resources.obtainAttributes(attrs,
5801 com.android.internal.R.styleable.IntentCategory);
5802 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5803 sa.recycle();
5804
5805 if (cat != null) {
5806 intent.addCategory(cat);
5807 }
5808 XmlUtils.skipCurrentTag(parser);
5809
5810 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005811 if (intent.mExtras == null) {
5812 intent.mExtras = new Bundle();
5813 }
5814 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5815 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005816
5817 } else {
5818 XmlUtils.skipCurrentTag(parser);
5819 }
5820 }
5821
5822 return intent;
5823 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005824}