blob: a43c92f16cc8e37ca2c38e3d6056ec818fd91c8d [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
Mike Lockwood7e4db372011-06-07 11:23:44 -07001657 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001658 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001659 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001660 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1661
1662 /**
1663 * Broadcast Action: The device has exited USB Mass Storage mode.
1664 * This is used mainly for the USB Settings panel.
1665 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1666 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001667 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001668 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001669 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001670 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1671
1672 /**
1673 * Broadcast Action: External media has been removed.
1674 * The path to the mount point for the removed media is contained in the Intent.mData field.
1675 */
1676 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1677 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1678
1679 /**
1680 * Broadcast Action: External media is present, but not mounted at its mount point.
1681 * The path to the mount point for the removed media is contained in the Intent.mData field.
1682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1685
1686 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001687 * Broadcast Action: External media is present, and being disk-checked
1688 * 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 -08001689 */
1690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1691 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1692
1693 /**
1694 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1695 * 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 -08001696 */
1697 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1698 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1699
1700 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001701 * Broadcast Action: External media is present and mounted at its mount point.
1702 * The path to the mount point for the removed media is contained in the Intent.mData field.
1703 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1704 * media was mounted read only.
1705 */
1706 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1707 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1708
1709 /**
1710 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001711 * 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 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1715
1716 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001717 * Broadcast Action: External media is no longer being shared via USB mass storage.
1718 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1719 *
1720 * @hide
1721 */
1722 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1723
1724 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001725 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1726 * The path to the mount point for the removed media is contained in the Intent.mData field.
1727 */
1728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1729 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1730
1731 /**
1732 * Broadcast Action: External media is present but cannot be mounted.
1733 * The path to the mount point for the removed media is contained in the Intent.mData field.
1734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1736 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1737
1738 /**
1739 * Broadcast Action: User has expressed the desire to remove the external storage media.
1740 * Applications should close all files they have open within the mount point when they receive this intent.
1741 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1742 */
1743 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1744 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1745
1746 /**
1747 * Broadcast Action: The media scanner has started scanning a directory.
1748 * The path to the directory being scanned is contained in the Intent.mData field.
1749 */
1750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1751 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1752
1753 /**
1754 * Broadcast Action: The media scanner has finished scanning a directory.
1755 * The path to the scanned directory is contained in the Intent.mData field.
1756 */
1757 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1758 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1759
1760 /**
1761 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1762 * The path to the file is contained in the Intent.mData field.
1763 */
1764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1765 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1766
1767 /**
1768 * Broadcast Action: The "Media Button" was pressed. Includes a single
1769 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1770 * caused the broadcast.
1771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1773 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1774
1775 /**
1776 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1777 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1778 * caused the broadcast.
1779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1782
1783 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1784 // location; they are not general-purpose actions.
1785
1786 /**
1787 * Broadcast Action: An GTalk connection has been established.
1788 */
1789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1790 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1791 "android.intent.action.GTALK_CONNECTED";
1792
1793 /**
1794 * Broadcast Action: An GTalk connection has been disconnected.
1795 */
1796 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1797 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1798 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001799
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001800 /**
1801 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001802 */
1803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1804 public static final String ACTION_INPUT_METHOD_CHANGED =
1805 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001806
1807 /**
1808 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1809 * more radios have been turned off or on. The intent will have the following extra value:</p>
1810 * <ul>
1811 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1812 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1813 * turned off</li>
1814 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001815 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001816 * <p class="note">This is a protected intent that can only be sent
1817 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 */
1819 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1820 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1821
1822 /**
1823 * Broadcast Action: Some content providers have parts of their namespace
1824 * where they publish new events or items that the user may be especially
1825 * interested in. For these things, they may broadcast this action when the
1826 * set of interesting items change.
1827 *
1828 * For example, GmailProvider sends this notification when the set of unread
1829 * mail in the inbox changes.
1830 *
1831 * <p>The data of the intent identifies which part of which provider
1832 * changed. When queried through the content resolver, the data URI will
1833 * return the data set in question.
1834 *
1835 * <p>The intent will have the following extra values:
1836 * <ul>
1837 * <li><em>count</em> - The number of items in the data set. This is the
1838 * same as the number of items in the cursor returned by querying the
1839 * data URI. </li>
1840 * </ul>
1841 *
1842 * This intent will be sent at boot (if the count is non-zero) and when the
1843 * data set changes. It is possible for the data set to change without the
1844 * count changing (for example, if a new unread message arrives in the same
1845 * sync operation in which a message is archived). The phone should still
1846 * ring/vibrate/etc as normal in this case.
1847 */
1848 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1849 public static final String ACTION_PROVIDER_CHANGED =
1850 "android.intent.action.PROVIDER_CHANGED";
1851
1852 /**
1853 * Broadcast Action: Wired Headset plugged in or unplugged.
1854 *
1855 * <p>The intent will have the following extra values:
1856 * <ul>
1857 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1858 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001859 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001860 * </ul>
1861 * </ul>
1862 */
1863 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1864 public static final String ACTION_HEADSET_PLUG =
1865 "android.intent.action.HEADSET_PLUG";
1866
1867 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001868 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1869 *
1870 * <p>The intent will have the following extra values:
1871 * <ul>
1872 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1873 * <li><em>name</em> - Headset type, human readable string </li>
1874 * </ul>
1875 * </ul>
1876 * @hide
1877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1879 public static final String ACTION_USB_ANLG_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08001880 "android.intent.action.USB_ANLG_HEADSET_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001881
1882 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07001883 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001884 *
1885 * <p>The intent will have the following extra values:
1886 * <ul>
1887 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1888 * <li><em>name</em> - Headset type, human readable string </li>
1889 * </ul>
1890 * </ul>
1891 * @hide
1892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1894 public static final String ACTION_USB_DGTL_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08001895 "android.intent.action.USB_DGTL_HEADSET_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07001896
1897 /**
1898 * Broadcast Action: A HMDI cable was plugged or unplugged
1899 *
1900 * <p>The intent will have the following extra values:
1901 * <ul>
1902 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1903 * <li><em>name</em> - HDMI cable, human readable string </li>
1904 * </ul>
1905 * </ul>
1906 * @hide
1907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_HDMI_AUDIO_PLUG =
1910 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001911
1912 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07001913 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
1914 * <ul>
1915 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
1916 * </ul>
1917 *
1918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
1920 *
1921 * @hide
1922 */
1923 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1924 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
1925 = "android.intent.action.ADVANCED_SETTINGS";
1926
1927 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 * Broadcast Action: An outgoing call is about to be placed.
1929 *
1930 * <p>The Intent will have the following extra value:
1931 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001932 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001933 * the phone number originally intended to be dialed.</li>
1934 * </ul>
1935 * <p>Once the broadcast is finished, the resultData is used as the actual
1936 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001937 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 * outgoing call in turn: for example, a parental control application
1939 * might verify that the user is authorized to place the call at that
1940 * time, then a number-rewriting application might add an area code if
1941 * one was not specified.</p>
1942 * <p>For consistency, any receiver whose purpose is to prohibit phone
1943 * calls should have a priority of 0, to ensure it will see the final
1944 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001945 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001946 * should have a positive priority.
1947 * Negative priorities are reserved for the system for this broadcast;
1948 * using them may cause problems.</p>
1949 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1950 * abort the broadcast.</p>
1951 * <p>Emergency calls cannot be intercepted using this mechanism, and
1952 * other calls cannot be modified to call emergency numbers using this
1953 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001954 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1956 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08001957 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001958 * <p class="note">This is a protected intent that can only be sent
1959 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1962 public static final String ACTION_NEW_OUTGOING_CALL =
1963 "android.intent.action.NEW_OUTGOING_CALL";
1964
1965 /**
1966 * Broadcast Action: Have the device reboot. This is only for use by
1967 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08001968 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001969 * <p class="note">This is a protected intent that can only be sent
1970 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_REBOOT =
1974 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001975
Wei Huang97ecc9c2009-05-11 17:44:20 -07001976 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08001977 * Broadcast Action: A sticky broadcast for changes in the physical
1978 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08001979 *
1980 * <p>The intent will have the following extra values:
1981 * <ul>
1982 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08001983 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08001984 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08001985 * <p>This is intended for monitoring the current physical dock state.
1986 * See {@link android.app.UiModeManager} for the normal API dealing with
1987 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_DOCK_EVENT =
1991 "android.intent.action.DOCK_EVENT";
1992
1993 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001994 * Broadcast Action: a remote intent is to be broadcasted.
1995 *
1996 * A remote intent is used for remote RPC between devices. The remote intent
1997 * is serialized and sent from one device to another device. The receiving
1998 * device parses the remote intent and broadcasts it. Note that anyone can
1999 * broadcast a remote intent. However, if the intent receiver of the remote intent
2000 * does not trust intent broadcasts from arbitrary intent senders, it should require
2001 * the sender to hold certain permissions so only trusted sender's broadcast will be
2002 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002003 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002004 */
2005 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002006 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002007
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002008 /**
2009 * Broadcast Action: hook for permforming cleanup after a system update.
2010 *
2011 * The broadcast is sent when the system is booting, before the
2012 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2013 * image. A receiver for this should do its work and then disable itself
2014 * so that it does not get run again at the next boot.
2015 * @hide
2016 */
2017 public static final String ACTION_PRE_BOOT_COMPLETED =
2018 "android.intent.action.PRE_BOOT_COMPLETED";
2019
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 // ---------------------------------------------------------------------
2021 // ---------------------------------------------------------------------
2022 // Standard intent categories (see addCategory()).
2023
2024 /**
2025 * Set if the activity should be an option for the default action
2026 * (center press) to perform on a piece of data. Setting this will
2027 * hide from the user any activities without it set when performing an
2028 * action on some data. Note that this is normal -not- set in the
2029 * Intent when initiating an action -- it is for use in intent filters
2030 * specified in packages.
2031 */
2032 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2033 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2034 /**
2035 * Activities that can be safely invoked from a browser must support this
2036 * category. For example, if the user is viewing a web page or an e-mail
2037 * and clicks on a link in the text, the Intent generated execute that
2038 * link will require the BROWSABLE category, so that only activities
2039 * supporting this category will be considered as possible actions. By
2040 * supporting this category, you are promising that there is nothing
2041 * damaging (without user intervention) that can happen by invoking any
2042 * matching Intent.
2043 */
2044 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2045 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2046 /**
2047 * Set if the activity should be considered as an alternative action to
2048 * the data the user is currently viewing. See also
2049 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2050 * applies to the selection in a list of items.
2051 *
2052 * <p>Supporting this category means that you would like your activity to be
2053 * displayed in the set of alternative things the user can do, usually as
2054 * part of the current activity's options menu. You will usually want to
2055 * include a specific label in the &lt;intent-filter&gt; of this action
2056 * describing to the user what it does.
2057 *
2058 * <p>The action of IntentFilter with this category is important in that it
2059 * describes the specific action the target will perform. This generally
2060 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2061 * a specific name such as "com.android.camera.action.CROP. Only one
2062 * alternative of any particular action will be shown to the user, so using
2063 * a specific action like this makes sure that your alternative will be
2064 * displayed while also allowing other applications to provide their own
2065 * overrides of that particular action.
2066 */
2067 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2068 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2069 /**
2070 * Set if the activity should be considered as an alternative selection
2071 * action to the data the user has currently selected. This is like
2072 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2073 * of items from which the user can select, giving them alternatives to the
2074 * default action that will be performed on it.
2075 */
2076 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2077 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2078 /**
2079 * Intended to be used as a tab inside of an containing TabActivity.
2080 */
2081 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2082 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2083 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 * Should be displayed in the top-level launcher.
2085 */
2086 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2087 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2088 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002089 * Provides information about the package it is in; typically used if
2090 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2091 * a front-door to the user without having to be shown in the all apps list.
2092 */
2093 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2094 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2095 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 * This is the home activity, that is the first activity that is displayed
2097 * when the device boots.
2098 */
2099 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2100 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2101 /**
2102 * This activity is a preference panel.
2103 */
2104 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2105 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2106 /**
2107 * This activity is a development preference panel.
2108 */
2109 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2110 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2111 /**
2112 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002113 */
2114 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2115 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2116 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002117 * This activity allows the user to browse and download new applications.
2118 */
2119 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2120 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2121 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 * This activity may be exercised by the monkey or other automated test tools.
2123 */
2124 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2125 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2126 /**
2127 * To be used as a test (not part of the normal user experience).
2128 */
2129 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2130 /**
2131 * To be used as a unit test (run through the Test Harness).
2132 */
2133 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2134 /**
2135 * To be used as an sample code example (not part of the normal user
2136 * experience).
2137 */
2138 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2139 /**
2140 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2141 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2142 * when queried, though it is allowable for those columns to be blank.
2143 */
2144 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2145 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2146
2147 /**
2148 * To be used as code under test for framework instrumentation tests.
2149 */
2150 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2151 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002152 /**
2153 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002154 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2155 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002156 */
2157 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2158 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2159 /**
2160 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002161 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2162 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002163 */
2164 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2165 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002166 /**
2167 * An activity to run when device is inserted into a analog (low end) dock.
2168 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2169 * information, see {@link android.app.UiModeManager}.
2170 */
2171 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2172 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2173
2174 /**
2175 * An activity to run when device is inserted into a digital (high end) dock.
2176 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2177 * information, see {@link android.app.UiModeManager}.
2178 */
2179 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2180 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002181
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002182 /**
2183 * Used to indicate that the activity can be used in a car environment.
2184 */
2185 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2186 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2187
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002188 // ---------------------------------------------------------------------
2189 // ---------------------------------------------------------------------
2190 // Standard extra data keys.
2191
2192 /**
2193 * The initial data to place in a newly created record. Use with
2194 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2195 * fields as would be given to the underlying ContentProvider.insert()
2196 * call.
2197 */
2198 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2199
2200 /**
2201 * A constant CharSequence that is associated with the Intent, used with
2202 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2203 * this may be a styled CharSequence, so you must use
2204 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2205 * retrieve it.
2206 */
2207 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2208
2209 /**
2210 * A content: URI holding a stream of data associated with the Intent,
2211 * used with {@link #ACTION_SEND} to supply the data being sent.
2212 */
2213 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2214
2215 /**
2216 * A String[] holding e-mail addresses that should be delivered to.
2217 */
2218 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2219
2220 /**
2221 * A String[] holding e-mail addresses that should be carbon copied.
2222 */
2223 public static final String EXTRA_CC = "android.intent.extra.CC";
2224
2225 /**
2226 * A String[] holding e-mail addresses that should be blind carbon copied.
2227 */
2228 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2229
2230 /**
2231 * A constant string holding the desired subject line of a message.
2232 */
2233 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2234
2235 /**
2236 * An Intent describing the choices you would like shown with
2237 * {@link #ACTION_PICK_ACTIVITY}.
2238 */
2239 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2240
2241 /**
2242 * A CharSequence dialog title to provide to the user when used with a
2243 * {@link #ACTION_CHOOSER}.
2244 */
2245 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2246
2247 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002248 * A Parcelable[] of {@link Intent} or
2249 * {@link android.content.pm.LabeledIntent} objects as set with
2250 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2251 * a the front of the list of choices, when shown to the user with a
2252 * {@link #ACTION_CHOOSER}.
2253 */
2254 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2255
2256 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002257 * A {@link android.view.KeyEvent} object containing the event that
2258 * triggered the creation of the Intent it is in.
2259 */
2260 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2261
2262 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002263 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2264 * before shutting down.
2265 *
2266 * {@hide}
2267 */
2268 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2269
2270 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2272 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2273 * of restarting the application.
2274 */
2275 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2276
2277 /**
2278 * A String holding the phone number originally entered in
2279 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2280 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2281 */
2282 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002283
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002284 /**
2285 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2286 * intents to supply the uid the package had been assigned. Also an optional
2287 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2288 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2289 * purpose.
2290 */
2291 public static final String EXTRA_UID = "android.intent.extra.UID";
2292
2293 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002294 * @hide String array of package names.
2295 */
2296 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2297
2298 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002299 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2300 * intents to indicate whether this represents a full uninstall (removing
2301 * both the code and its data) or a partial uninstall (leaving its data,
2302 * implying that this is an update).
2303 */
2304 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002305
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002306 /**
2307 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2308 * intents to indicate that this is a replacement of the package, so this
2309 * broadcast will immediately be followed by an add broadcast for a
2310 * different version of the same package.
2311 */
2312 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002313
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002314 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002315 * Used as an int extra field in {@link android.app.AlarmManager} intents
2316 * to tell the application being invoked how many pending alarms are being
2317 * delievered with the intent. For one-shot alarms this will always be 1.
2318 * For recurring alarms, this might be greater than 1 if the device was
2319 * asleep or powered off at the time an earlier alarm would have been
2320 * delivered.
2321 */
2322 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002323
Jacek Surazski86b6c532009-05-13 14:38:28 +02002324 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002325 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2326 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002327 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2328 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002329 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2330 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2331 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002332 */
2333 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2334
2335 /**
2336 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2337 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002338 */
2339 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2340
2341 /**
2342 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2343 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002344 */
2345 public static final int EXTRA_DOCK_STATE_DESK = 1;
2346
2347 /**
2348 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2349 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002350 */
2351 public static final int EXTRA_DOCK_STATE_CAR = 2;
2352
2353 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002354 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2355 * to represent that the phone is in a analog (low end) dock.
2356 */
2357 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2358
2359 /**
2360 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2361 * to represent that the phone is in a digital (high end) dock.
2362 */
2363 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2364
2365 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002366 * Boolean that can be supplied as meta-data with a dock activity, to
2367 * indicate that the dock should take over the home key when it is active.
2368 */
2369 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002370
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002371 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002372 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2373 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002374 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002375 * @hide
2376 */
2377 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2378
2379 /**
Romain Guy4969af72009-06-17 10:53:19 -07002380 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002381 * package. Specifies the installer package name; this package will receive the
2382 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002383 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002384 * @hide
2385 */
Romain Guy4969af72009-06-17 10:53:19 -07002386 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002387 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002388
Wei Huang97ecc9c2009-05-11 17:44:20 -07002389 /**
2390 * Used in the extra field in the remote intent. It's astring token passed with the
2391 * remote intent.
2392 */
2393 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2394 "android.intent.extra.remote_intent_token";
2395
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002396 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002397 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002398 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002399 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002400 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002401 "android.intent.extra.changed_component_name";
2402
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002403 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002404 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002405 * and contains a string array of all of the components that have changed.
2406 */
2407 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2408 "android.intent.extra.changed_component_name_list";
2409
2410 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002411 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002412 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2413 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002414 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002415 */
2416 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2417 "android.intent.extra.changed_package_list";
2418
2419 /**
2420 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002421 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2422 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002423 * and contains an integer array of uids of all of the components
2424 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002425 */
2426 public static final String EXTRA_CHANGED_UID_LIST =
2427 "android.intent.extra.changed_uid_list";
2428
2429 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002430 * @hide
2431 * Magic extra system code can use when binding, to give a label for
2432 * who it is that has bound to a service. This is an integer giving
2433 * a framework string resource that can be displayed to the user.
2434 */
2435 public static final String EXTRA_CLIENT_LABEL =
2436 "android.intent.extra.client_label";
2437
2438 /**
2439 * @hide
2440 * Magic extra system code can use when binding, to give a PendingIntent object
2441 * that can be launched for the user to disable the system's use of this
2442 * service.
2443 */
2444 public static final String EXTRA_CLIENT_INTENT =
2445 "android.intent.extra.client_intent";
2446
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002447 /**
2448 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2449 * data that is on the local device. This is a boolean extra; the default
2450 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2451 * the user to select media that is already on the device, not requiring it
2452 * be downloaded from a remote service when opened. Another way to look
2453 * at it is that such content should generally have a "_data" column to the
2454 * path of the content on local external storage.
2455 */
2456 public static final String EXTRA_LOCAL_ONLY =
2457 "android.intent.extra.LOCAL_ONLY";
2458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002459 // ---------------------------------------------------------------------
2460 // ---------------------------------------------------------------------
2461 // Intent flags (see mFlags variable).
2462
2463 /**
2464 * If set, the recipient of this Intent will be granted permission to
2465 * perform read operations on the Uri in the Intent's data.
2466 */
2467 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2468 /**
2469 * If set, the recipient of this Intent will be granted permission to
2470 * perform write operations on the Uri in the Intent's data.
2471 */
2472 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2473 /**
2474 * Can be set by the caller to indicate that this Intent is coming from
2475 * a background operation, not from direct user interaction.
2476 */
2477 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2478 /**
2479 * A flag you can enable for debugging: when set, log messages will be
2480 * printed during the resolution of this intent to show you what has
2481 * been found to create the final resolved list.
2482 */
2483 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002484 /**
2485 * If set, this intent will not match any components in packages that
2486 * are currently stopped. If this is not set, then the default behavior
2487 * is to include such applications in the result.
2488 */
2489 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2490 /**
2491 * If set, this intent will always match any components in packages that
2492 * are currently stopped. This is the default behavior when
2493 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2494 * flags are set, this one wins (it allows overriding of exclude for
2495 * places where the framework may automatically set the exclude flag).
2496 */
2497 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002498
2499 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002500 * If set, the new activity is not kept in the history stack. As soon as
2501 * the user navigates away from it, the activity is finished. This may also
2502 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2503 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002504 */
2505 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2506 /**
2507 * If set, the activity will not be launched if it is already running
2508 * at the top of the history stack.
2509 */
2510 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2511 /**
2512 * If set, this activity will become the start of a new task on this
2513 * history stack. A task (from the activity that started it to the
2514 * next task activity) defines an atomic group of activities that the
2515 * user can move to. Tasks can be moved to the foreground and background;
2516 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002517 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002518 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2519 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002520 *
2521 * <p>This flag is generally used by activities that want
2522 * to present a "launcher" style behavior: they give the user a list of
2523 * separate things that can be done, which otherwise run completely
2524 * independently of the activity launching them.
2525 *
2526 * <p>When using this flag, if a task is already running for the activity
2527 * you are now starting, then a new activity will not be started; instead,
2528 * the current task will simply be brought to the front of the screen with
2529 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2530 * to disable this behavior.
2531 *
2532 * <p>This flag can not be used when the caller is requesting a result from
2533 * the activity being launched.
2534 */
2535 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2536 /**
2537 * <strong>Do not use this flag unless you are implementing your own
2538 * top-level application launcher.</strong> Used in conjunction with
2539 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2540 * behavior of bringing an existing task to the foreground. When set,
2541 * a new task is <em>always</em> started to host the Activity for the
2542 * Intent, regardless of whether there is already an existing task running
2543 * the same thing.
2544 *
2545 * <p><strong>Because the default system does not include graphical task management,
2546 * you should not use this flag unless you provide some way for a user to
2547 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002548 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 * <p>This flag is ignored if
2550 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2551 *
Scott Main7aee61f2011-02-08 11:25:01 -08002552 * <p>See
2553 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2554 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002555 */
2556 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2557 /**
2558 * If set, and the activity being launched is already running in the
2559 * current task, then instead of launching a new instance of that activity,
2560 * all of the other activities on top of it will be closed and this Intent
2561 * will be delivered to the (now on top) old activity as a new Intent.
2562 *
2563 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2564 * If D calls startActivity() with an Intent that resolves to the component
2565 * of activity B, then C and D will be finished and B receive the given
2566 * Intent, resulting in the stack now being: A, B.
2567 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002568 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002569 * either receive the new intent you are starting here in its
2570 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002571 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002572 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2573 * the same intent, then it will be finished and re-created; for all other
2574 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2575 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002576 *
2577 * <p>This launch mode can also be used to good effect in conjunction with
2578 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2579 * of a task, it will bring any currently running instance of that task
2580 * to the foreground, and then clear it to its root state. This is
2581 * especially useful, for example, when launching an activity from the
2582 * notification manager.
2583 *
Scott Main7aee61f2011-02-08 11:25:01 -08002584 * <p>See
2585 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2586 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002587 */
2588 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2589 /**
2590 * If set and this intent is being used to launch a new activity from an
2591 * existing one, then the reply target of the existing activity will be
2592 * transfered to the new activity. This way the new activity can call
2593 * {@link android.app.Activity#setResult} and have that result sent back to
2594 * the reply target of the original activity.
2595 */
2596 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2597 /**
2598 * If set and this intent is being used to launch a new activity from an
2599 * existing one, the current activity will not be counted as the top
2600 * activity for deciding whether the new intent should be delivered to
2601 * the top instead of starting a new one. The previous activity will
2602 * be used as the top, with the assumption being that the current activity
2603 * will finish itself immediately.
2604 */
2605 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2606 /**
2607 * If set, the new activity is not kept in the list of recently launched
2608 * activities.
2609 */
2610 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2611 /**
2612 * This flag is not normally set by application code, but set for you by
2613 * the system as described in the
2614 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2615 * launchMode} documentation for the singleTask mode.
2616 */
2617 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2618 /**
2619 * If set, and this activity is either being started in a new task or
2620 * bringing to the top an existing task, then it will be launched as
2621 * the front door of the task. This will result in the application of
2622 * any affinities needed to have that task in the proper state (either
2623 * moving activities to or from it), or simply resetting that task to
2624 * its initial state if needed.
2625 */
2626 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2627 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002628 * This flag is not normally set by application code, but set for you by
2629 * the system if this activity is being launched from history
2630 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002631 */
2632 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002633 /**
2634 * If set, this marks a point in the task's activity stack that should
2635 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002636 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002637 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2638 * the user re-launching it from home), this activity and all on top of
2639 * it will be finished so that the user does not return to them, but
2640 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002641 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002642 * <p>This is useful for cases where you have a logical break in your
2643 * application. For example, an e-mail application may have a command
2644 * to view an attachment, which launches an image view activity to
2645 * display it. This activity should be part of the e-mail application's
2646 * task, since it is a part of the task the user is involved in. However,
2647 * if the user leaves that task, and later selects the e-mail app from
2648 * home, we may like them to return to the conversation they were
2649 * viewing, not the picture attachment, since that is confusing. By
2650 * setting this flag when launching the image viewer, that viewer and
2651 * any activities it starts will be removed the next time the user returns
2652 * to mail.
2653 */
2654 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002655 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002656 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002657 * callback from occurring on the current frontmost activity before it is
2658 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002659 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002660 * <p>Typically, an activity can rely on that callback to indicate that an
2661 * explicit user action has caused their activity to be moved out of the
2662 * foreground. The callback marks an appropriate point in the activity's
2663 * lifecycle for it to dismiss any notifications that it intends to display
2664 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002665 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002666 * <p>If an activity is ever started via any non-user-driven events such as
2667 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2668 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002669 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002670 */
2671 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002672 /**
2673 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2674 * this flag will cause the launched activity to be brought to the front of its
2675 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002676 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002677 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2678 * If D calls startActivity() with an Intent that resolves to the component
2679 * of activity B, then B will be brought to the front of the history stack,
2680 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002681 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002682 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002683 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002684 */
2685 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002686 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002687 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2688 * this flag will prevent the system from applying an activity transition
2689 * animation to go to the next activity state. This doesn't mean an
2690 * animation will never run -- if another activity change happens that doesn't
2691 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002692 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002693 * when you are going to do a series of activity operations but the
2694 * animation seen by the user shouldn't be driven by the first activity
2695 * change but rather a later one.
2696 */
2697 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2698 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002699 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2700 * this flag will cause any existing task that would be associated with the
2701 * activity to be cleared before the activity is started. That is, the activity
2702 * becomes the new root of an otherwise empty task, and any old activities
2703 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2704 */
2705 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
2706 /**
2707 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2708 * this flag will cause a newly launching task to be placed on top of the current
2709 * home activity task (if there is one). That is, pressing back from the task
2710 * will always return the user to home even if that was not the last activity they
2711 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2712 */
2713 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
2714 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 * If set, when sending a broadcast only registered receivers will be
2716 * called -- no BroadcastReceiver components will be launched.
2717 */
2718 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002719 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002720 * If set, when sending a broadcast the new broadcast will replace
2721 * any existing pending broadcast that matches it. Matching is defined
2722 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2723 * true for the intents of the two broadcasts. When a match is found,
2724 * the new broadcast (and receivers associated with it) will replace the
2725 * existing one in the pending broadcast list, remaining at the same
2726 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002727 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002728 * <p>This flag is most typically used with sticky broadcasts, which
2729 * only care about delivering the most recent values of the broadcast
2730 * to their receivers.
2731 */
2732 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2733 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002734 * If set, when sending a broadcast <i>before boot has completed</i> only
2735 * registered receivers will be called -- no BroadcastReceiver components
2736 * will be launched. Sticky intent state will be recorded properly even
2737 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2738 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002739 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002740 * <p>This flag is only for use by system sevices as a convenience to
2741 * avoid having to implement a more complex mechanism around detection
2742 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002743 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002744 * @hide
2745 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002746 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002747 /**
2748 * Set when this broadcast is for a boot upgrade, a special mode that
2749 * allows the broadcast to be sent before the system is ready and launches
2750 * the app process with no providers running in it.
2751 * @hide
2752 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002753 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002754
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002755 /**
2756 * @hide Flags that can't be changed with PendingIntent.
2757 */
2758 public static final int IMMUTABLE_FLAGS =
2759 FLAG_GRANT_READ_URI_PERMISSION
2760 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002761
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002762 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002763 // ---------------------------------------------------------------------
2764 // toUri() and parseUri() options.
2765
2766 /**
2767 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2768 * always has the "intent:" scheme. This syntax can be used when you want
2769 * to later disambiguate between URIs that are intended to describe an
2770 * Intent vs. all others that should be treated as raw URIs. When used
2771 * with {@link #parseUri}, any other scheme will result in a generic
2772 * VIEW action for that raw URI.
2773 */
2774 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002775
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002776 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002777
2778 private String mAction;
2779 private Uri mData;
2780 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002781 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002782 private ComponentName mComponent;
2783 private int mFlags;
2784 private HashSet<String> mCategories;
2785 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002786 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002787
2788 // ---------------------------------------------------------------------
2789
2790 /**
2791 * Create an empty intent.
2792 */
2793 public Intent() {
2794 }
2795
2796 /**
2797 * Copy constructor.
2798 */
2799 public Intent(Intent o) {
2800 this.mAction = o.mAction;
2801 this.mData = o.mData;
2802 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002803 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002804 this.mComponent = o.mComponent;
2805 this.mFlags = o.mFlags;
2806 if (o.mCategories != null) {
2807 this.mCategories = new HashSet<String>(o.mCategories);
2808 }
2809 if (o.mExtras != null) {
2810 this.mExtras = new Bundle(o.mExtras);
2811 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002812 if (o.mSourceBounds != null) {
2813 this.mSourceBounds = new Rect(o.mSourceBounds);
2814 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002815 }
2816
2817 @Override
2818 public Object clone() {
2819 return new Intent(this);
2820 }
2821
2822 private Intent(Intent o, boolean all) {
2823 this.mAction = o.mAction;
2824 this.mData = o.mData;
2825 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002826 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002827 this.mComponent = o.mComponent;
2828 if (o.mCategories != null) {
2829 this.mCategories = new HashSet<String>(o.mCategories);
2830 }
2831 }
2832
2833 /**
2834 * Make a clone of only the parts of the Intent that are relevant for
2835 * filter matching: the action, data, type, component, and categories.
2836 */
2837 public Intent cloneFilter() {
2838 return new Intent(this, false);
2839 }
2840
2841 /**
2842 * Create an intent with a given action. All other fields (data, type,
2843 * class) are null. Note that the action <em>must</em> be in a
2844 * namespace because Intents are used globally in the system -- for
2845 * example the system VIEW action is android.intent.action.VIEW; an
2846 * application's custom action would be something like
2847 * com.google.app.myapp.CUSTOM_ACTION.
2848 *
2849 * @param action The Intent action, such as ACTION_VIEW.
2850 */
2851 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002852 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002853 }
2854
2855 /**
2856 * Create an intent with a given action and for a given data url. Note
2857 * that the action <em>must</em> be in a namespace because Intents are
2858 * used globally in the system -- for example the system VIEW action is
2859 * android.intent.action.VIEW; an application's custom action would be
2860 * something like com.google.app.myapp.CUSTOM_ACTION.
2861 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002862 * <p><em>Note: scheme and host name matching in the Android framework is
2863 * case-sensitive, unlike the formal RFC. As a result,
2864 * you should always ensure that you write your Uri with these elements
2865 * using lower case letters, and normalize any Uris you receive from
2866 * outside of Android to ensure the scheme and host is lower case.</em></p>
2867 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002868 * @param action The Intent action, such as ACTION_VIEW.
2869 * @param uri The Intent data URI.
2870 */
2871 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002872 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002873 mData = uri;
2874 }
2875
2876 /**
2877 * Create an intent for a specific component. All other fields (action, data,
2878 * type, class) are null, though they can be modified later with explicit
2879 * calls. This provides a convenient way to create an intent that is
2880 * intended to execute a hard-coded class name, rather than relying on the
2881 * system to find an appropriate class for you; see {@link #setComponent}
2882 * for more information on the repercussions of this.
2883 *
2884 * @param packageContext A Context of the application package implementing
2885 * this class.
2886 * @param cls The component class that is to be used for the intent.
2887 *
2888 * @see #setClass
2889 * @see #setComponent
2890 * @see #Intent(String, android.net.Uri , Context, Class)
2891 */
2892 public Intent(Context packageContext, Class<?> cls) {
2893 mComponent = new ComponentName(packageContext, cls);
2894 }
2895
2896 /**
2897 * Create an intent for a specific component with a specified action and data.
2898 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2899 * construct the Intent and then calling {@link #setClass} to set its
2900 * class.
2901 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002902 * <p><em>Note: scheme and host name matching in the Android framework is
2903 * case-sensitive, unlike the formal RFC. As a result,
2904 * you should always ensure that you write your Uri with these elements
2905 * using lower case letters, and normalize any Uris you receive from
2906 * outside of Android to ensure the scheme and host is lower case.</em></p>
2907 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002908 * @param action The Intent action, such as ACTION_VIEW.
2909 * @param uri The Intent data URI.
2910 * @param packageContext A Context of the application package implementing
2911 * this class.
2912 * @param cls The component class that is to be used for the intent.
2913 *
2914 * @see #Intent(String, android.net.Uri)
2915 * @see #Intent(Context, Class)
2916 * @see #setClass
2917 * @see #setComponent
2918 */
2919 public Intent(String action, Uri uri,
2920 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002921 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002922 mData = uri;
2923 mComponent = new ComponentName(packageContext, cls);
2924 }
2925
2926 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08002927 * Create an intent to launch the main (root) activity of a task. This
2928 * is the Intent that is started when the application's is launched from
2929 * Home. For anything else that wants to launch an application in the
2930 * same way, it is important that they use an Intent structured the same
2931 * way, and can use this function to ensure this is the case.
2932 *
2933 * <p>The returned Intent has the given Activity component as its explicit
2934 * component, {@link #ACTION_MAIN} as its action, and includes the
2935 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
2936 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
2937 * to do that through {@link #addFlags(int)} on the returned Intent.
2938 *
2939 * @param mainActivity The main activity component that this Intent will
2940 * launch.
2941 * @return Returns a newly created Intent that can be used to launch the
2942 * activity as a main application entry.
2943 *
2944 * @see #setClass
2945 * @see #setComponent
2946 */
2947 public static Intent makeMainActivity(ComponentName mainActivity) {
2948 Intent intent = new Intent(ACTION_MAIN);
2949 intent.setComponent(mainActivity);
2950 intent.addCategory(CATEGORY_LAUNCHER);
2951 return intent;
2952 }
2953
2954 /**
2955 * Make an Intent that can be used to re-launch an application's task
2956 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
2957 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
2958 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
2959 *
2960 * @param mainActivity The activity component that is the root of the
2961 * task; this is the activity that has been published in the application's
2962 * manifest as the main launcher icon.
2963 *
2964 * @return Returns a newly created Intent that can be used to relaunch the
2965 * activity's task in its root state.
2966 */
2967 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
2968 Intent intent = makeMainActivity(mainActivity);
2969 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
2970 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
2971 return intent;
2972 }
2973
2974 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002975 * Call {@link #parseUri} with 0 flags.
2976 * @deprecated Use {@link #parseUri} instead.
2977 */
2978 @Deprecated
2979 public static Intent getIntent(String uri) throws URISyntaxException {
2980 return parseUri(uri, 0);
2981 }
Tom Taylord4a47292009-12-21 13:59:18 -08002982
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002984 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002985 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002986 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002987 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002988 *
2989 * <p>The URI given here must not be relative -- that is, it must include
2990 * the scheme and full path.
2991 *
2992 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002993 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002994 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002995 *
2996 * @return Intent The newly created Intent object.
2997 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002998 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2999 * it bad (as parsed by the Uri class) or the Intent data within the
3000 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003001 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003002 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003003 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003004 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003005 int i = 0;
3006 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003007 // Validate intent scheme for if requested.
3008 if ((flags&URI_INTENT_SCHEME) != 0) {
3009 if (!uri.startsWith("intent:")) {
3010 Intent intent = new Intent(ACTION_VIEW);
3011 try {
3012 intent.setData(Uri.parse(uri));
3013 } catch (IllegalArgumentException e) {
3014 throw new URISyntaxException(uri, e.getMessage());
3015 }
3016 return intent;
3017 }
3018 }
Tom Taylord4a47292009-12-21 13:59:18 -08003019
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003020 // simple case
3021 i = uri.lastIndexOf("#");
3022 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3023
3024 // old format Intent URI
3025 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003026
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003027 // new format
3028 Intent intent = new Intent(ACTION_VIEW);
3029
3030 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003031 String data = i >= 0 ? uri.substring(0, i) : null;
3032 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003033 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003034
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003035 // loop over contents of Intent, all name=value;
3036 while (!uri.startsWith("end", i)) {
3037 int eq = uri.indexOf('=', i);
3038 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003039 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003040
3041 // action
3042 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003043 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003044 }
3045
3046 // categories
3047 else if (uri.startsWith("category=", i)) {
3048 intent.addCategory(value);
3049 }
3050
3051 // type
3052 else if (uri.startsWith("type=", i)) {
3053 intent.mType = value;
3054 }
3055
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003056 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003057 else if (uri.startsWith("launchFlags=", i)) {
3058 intent.mFlags = Integer.decode(value).intValue();
3059 }
3060
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003061 // package
3062 else if (uri.startsWith("package=", i)) {
3063 intent.mPackage = value;
3064 }
3065
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003066 // component
3067 else if (uri.startsWith("component=", i)) {
3068 intent.mComponent = ComponentName.unflattenFromString(value);
3069 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003070
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003071 // scheme
3072 else if (uri.startsWith("scheme=", i)) {
3073 scheme = value;
3074 }
3075
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003076 // source bounds
3077 else if (uri.startsWith("sourceBounds=", i)) {
3078 intent.mSourceBounds = Rect.unflattenFromString(value);
3079 }
3080
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081 // extra
3082 else {
3083 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003084 // create Bundle if it doesn't already exist
3085 if (intent.mExtras == null) intent.mExtras = new Bundle();
3086 Bundle b = intent.mExtras;
3087 // add EXTRA
3088 if (uri.startsWith("S.", i)) b.putString(key, value);
3089 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3090 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3091 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3092 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3093 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3094 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3095 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3096 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3097 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3098 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003099
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003100 // move to the next item
3101 i = semi + 1;
3102 }
3103
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003104 if (data != null) {
3105 if (data.startsWith("intent:")) {
3106 data = data.substring(7);
3107 if (scheme != null) {
3108 data = scheme + ':' + data;
3109 }
3110 }
Tom Taylord4a47292009-12-21 13:59:18 -08003111
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003112 if (data.length() > 0) {
3113 try {
3114 intent.mData = Uri.parse(data);
3115 } catch (IllegalArgumentException e) {
3116 throw new URISyntaxException(uri, e.getMessage());
3117 }
3118 }
3119 }
Tom Taylord4a47292009-12-21 13:59:18 -08003120
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003121 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003122
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003123 } catch (IndexOutOfBoundsException e) {
3124 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3125 }
3126 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003127
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003128 public static Intent getIntentOld(String uri) throws URISyntaxException {
3129 Intent intent;
3130
3131 int i = uri.lastIndexOf('#');
3132 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003133 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003134 final int intentFragmentStart = i;
3135 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003136
3137 i++;
3138
3139 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003140 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003141 i += 7;
3142 int j = uri.indexOf(')', i);
3143 action = uri.substring(i, j);
3144 i = j + 1;
3145 }
3146
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003147 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003148
3149 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003150 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003151 i += 11;
3152 int j = uri.indexOf(')', i);
3153 while (i < j) {
3154 int sep = uri.indexOf('!', i);
3155 if (sep < 0) sep = j;
3156 if (i < sep) {
3157 intent.addCategory(uri.substring(i, sep));
3158 }
3159 i = sep + 1;
3160 }
3161 i = j + 1;
3162 }
3163
3164 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003165 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003166 i += 5;
3167 int j = uri.indexOf(')', i);
3168 intent.mType = uri.substring(i, j);
3169 i = j + 1;
3170 }
3171
3172 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003173 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003174 i += 12;
3175 int j = uri.indexOf(')', i);
3176 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3177 i = j + 1;
3178 }
3179
3180 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003181 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003182 i += 10;
3183 int j = uri.indexOf(')', i);
3184 int sep = uri.indexOf('!', i);
3185 if (sep >= 0 && sep < j) {
3186 String pkg = uri.substring(i, sep);
3187 String cls = uri.substring(sep + 1, j);
3188 intent.mComponent = new ComponentName(pkg, cls);
3189 }
3190 i = j + 1;
3191 }
3192
3193 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003194 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003196
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003197 final int closeParen = uri.indexOf(')', i);
3198 if (closeParen == -1) throw new URISyntaxException(uri,
3199 "EXTRA missing trailing ')'", i);
3200
3201 while (i < closeParen) {
3202 // fetch the key value
3203 int j = uri.indexOf('=', i);
3204 if (j <= i + 1 || i >= closeParen) {
3205 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3206 }
3207 char type = uri.charAt(i);
3208 i++;
3209 String key = uri.substring(i, j);
3210 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003211
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003212 // get type-value
3213 j = uri.indexOf('!', i);
3214 if (j == -1 || j >= closeParen) j = closeParen;
3215 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3216 String value = uri.substring(i, j);
3217 i = j;
3218
3219 // create Bundle if it doesn't already exist
3220 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003221
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003222 // add item to bundle
3223 try {
3224 switch (type) {
3225 case 'S':
3226 intent.mExtras.putString(key, Uri.decode(value));
3227 break;
3228 case 'B':
3229 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3230 break;
3231 case 'b':
3232 intent.mExtras.putByte(key, Byte.parseByte(value));
3233 break;
3234 case 'c':
3235 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3236 break;
3237 case 'd':
3238 intent.mExtras.putDouble(key, Double.parseDouble(value));
3239 break;
3240 case 'f':
3241 intent.mExtras.putFloat(key, Float.parseFloat(value));
3242 break;
3243 case 'i':
3244 intent.mExtras.putInt(key, Integer.parseInt(value));
3245 break;
3246 case 'l':
3247 intent.mExtras.putLong(key, Long.parseLong(value));
3248 break;
3249 case 's':
3250 intent.mExtras.putShort(key, Short.parseShort(value));
3251 break;
3252 default:
3253 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3254 }
3255 } catch (NumberFormatException e) {
3256 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3257 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003258
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003259 char ch = uri.charAt(i);
3260 if (ch == ')') break;
3261 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3262 i++;
3263 }
3264 }
3265
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003266 if (isIntentFragment) {
3267 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3268 } else {
3269 intent.mData = Uri.parse(uri);
3270 }
Tom Taylord4a47292009-12-21 13:59:18 -08003271
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003272 if (intent.mAction == null) {
3273 // By default, if no action is specified, then use VIEW.
3274 intent.mAction = ACTION_VIEW;
3275 }
3276
3277 } else {
3278 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3279 }
3280
3281 return intent;
3282 }
3283
3284 /**
3285 * Retrieve the general action to be performed, such as
3286 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3287 * the information in the intent should be interpreted -- most importantly,
3288 * what to do with the data returned by {@link #getData}.
3289 *
3290 * @return The action of this intent or null if none is specified.
3291 *
3292 * @see #setAction
3293 */
3294 public String getAction() {
3295 return mAction;
3296 }
3297
3298 /**
3299 * Retrieve data this intent is operating on. This URI specifies the name
3300 * of the data; often it uses the content: scheme, specifying data in a
3301 * content provider. Other schemes may be handled by specific activities,
3302 * such as http: by the web browser.
3303 *
3304 * @return The URI of the data this intent is targeting or null.
3305 *
3306 * @see #getScheme
3307 * @see #setData
3308 */
3309 public Uri getData() {
3310 return mData;
3311 }
3312
3313 /**
3314 * The same as {@link #getData()}, but returns the URI as an encoded
3315 * String.
3316 */
3317 public String getDataString() {
3318 return mData != null ? mData.toString() : null;
3319 }
3320
3321 /**
3322 * Return the scheme portion of the intent's data. If the data is null or
3323 * does not include a scheme, null is returned. Otherwise, the scheme
3324 * prefix without the final ':' is returned, i.e. "http".
3325 *
3326 * <p>This is the same as calling getData().getScheme() (and checking for
3327 * null data).
3328 *
3329 * @return The scheme of this intent.
3330 *
3331 * @see #getData
3332 */
3333 public String getScheme() {
3334 return mData != null ? mData.getScheme() : null;
3335 }
3336
3337 /**
3338 * Retrieve any explicit MIME type included in the intent. This is usually
3339 * null, as the type is determined by the intent data.
3340 *
3341 * @return If a type was manually set, it is returned; else null is
3342 * returned.
3343 *
3344 * @see #resolveType(ContentResolver)
3345 * @see #setType
3346 */
3347 public String getType() {
3348 return mType;
3349 }
3350
3351 /**
3352 * Return the MIME data type of this intent. If the type field is
3353 * explicitly set, that is simply returned. Otherwise, if the data is set,
3354 * the type of that data is returned. If neither fields are set, a null is
3355 * returned.
3356 *
3357 * @return The MIME type of this intent.
3358 *
3359 * @see #getType
3360 * @see #resolveType(ContentResolver)
3361 */
3362 public String resolveType(Context context) {
3363 return resolveType(context.getContentResolver());
3364 }
3365
3366 /**
3367 * Return the MIME data type of this intent. If the type field is
3368 * explicitly set, that is simply returned. Otherwise, if the data is set,
3369 * the type of that data is returned. If neither fields are set, a null is
3370 * returned.
3371 *
3372 * @param resolver A ContentResolver that can be used to determine the MIME
3373 * type of the intent's data.
3374 *
3375 * @return The MIME type of this intent.
3376 *
3377 * @see #getType
3378 * @see #resolveType(Context)
3379 */
3380 public String resolveType(ContentResolver resolver) {
3381 if (mType != null) {
3382 return mType;
3383 }
3384 if (mData != null) {
3385 if ("content".equals(mData.getScheme())) {
3386 return resolver.getType(mData);
3387 }
3388 }
3389 return null;
3390 }
3391
3392 /**
3393 * Return the MIME data type of this intent, only if it will be needed for
3394 * intent resolution. This is not generally useful for application code;
3395 * it is used by the frameworks for communicating with back-end system
3396 * services.
3397 *
3398 * @param resolver A ContentResolver that can be used to determine the MIME
3399 * type of the intent's data.
3400 *
3401 * @return The MIME type of this intent, or null if it is unknown or not
3402 * needed.
3403 */
3404 public String resolveTypeIfNeeded(ContentResolver resolver) {
3405 if (mComponent != null) {
3406 return mType;
3407 }
3408 return resolveType(resolver);
3409 }
3410
3411 /**
3412 * Check if an category exists in the intent.
3413 *
3414 * @param category The category to check.
3415 *
3416 * @return boolean True if the intent contains the category, else false.
3417 *
3418 * @see #getCategories
3419 * @see #addCategory
3420 */
3421 public boolean hasCategory(String category) {
3422 return mCategories != null && mCategories.contains(category);
3423 }
3424
3425 /**
3426 * Return the set of all categories in the intent. If there are no categories,
3427 * returns NULL.
3428 *
3429 * @return Set The set of categories you can examine. Do not modify!
3430 *
3431 * @see #hasCategory
3432 * @see #addCategory
3433 */
3434 public Set<String> getCategories() {
3435 return mCategories;
3436 }
3437
3438 /**
3439 * Sets the ClassLoader that will be used when unmarshalling
3440 * any Parcelable values from the extras of this Intent.
3441 *
3442 * @param loader a ClassLoader, or null to use the default loader
3443 * at the time of unmarshalling.
3444 */
3445 public void setExtrasClassLoader(ClassLoader loader) {
3446 if (mExtras != null) {
3447 mExtras.setClassLoader(loader);
3448 }
3449 }
3450
3451 /**
3452 * Returns true if an extra value is associated with the given name.
3453 * @param name the extra's name
3454 * @return true if the given extra is present.
3455 */
3456 public boolean hasExtra(String name) {
3457 return mExtras != null && mExtras.containsKey(name);
3458 }
3459
3460 /**
3461 * Returns true if the Intent's extras contain a parcelled file descriptor.
3462 * @return true if the Intent contains a parcelled file descriptor.
3463 */
3464 public boolean hasFileDescriptors() {
3465 return mExtras != null && mExtras.hasFileDescriptors();
3466 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003467
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 /**
3469 * Retrieve extended data from the intent.
3470 *
3471 * @param name The name of the desired item.
3472 *
3473 * @return the value of an item that previously added with putExtra()
3474 * or null if none was found.
3475 *
3476 * @deprecated
3477 * @hide
3478 */
3479 @Deprecated
3480 public Object getExtra(String name) {
3481 return getExtra(name, null);
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, boolean)
3495 */
3496 public boolean getBooleanExtra(String name, boolean defaultValue) {
3497 return mExtras == null ? defaultValue :
3498 mExtras.getBoolean(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, byte)
3512 */
3513 public byte getByteExtra(String name, byte defaultValue) {
3514 return mExtras == null ? defaultValue :
3515 mExtras.getByte(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, short)
3529 */
3530 public short getShortExtra(String name, short defaultValue) {
3531 return mExtras == null ? defaultValue :
3532 mExtras.getShort(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, char)
3546 */
3547 public char getCharExtra(String name, char defaultValue) {
3548 return mExtras == null ? defaultValue :
3549 mExtras.getChar(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, int)
3563 */
3564 public int getIntExtra(String name, int defaultValue) {
3565 return mExtras == null ? defaultValue :
3566 mExtras.getInt(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 none was found.
3578 *
3579 * @see #putExtra(String, long)
3580 */
3581 public long getLongExtra(String name, long defaultValue) {
3582 return mExtras == null ? defaultValue :
3583 mExtras.getLong(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 no such item is present
3595 *
3596 * @see #putExtra(String, float)
3597 */
3598 public float getFloatExtra(String name, float defaultValue) {
3599 return mExtras == null ? defaultValue :
3600 mExtras.getFloat(name, defaultValue);
3601 }
3602
3603 /**
3604 * Retrieve extended data from the intent.
3605 *
3606 * @param name The name of the desired item.
3607 * @param defaultValue the value to be returned if no value of the desired
3608 * type is stored with the given name.
3609 *
3610 * @return the value of an item that previously added with putExtra()
3611 * or the default value if none was found.
3612 *
3613 * @see #putExtra(String, double)
3614 */
3615 public double getDoubleExtra(String name, double defaultValue) {
3616 return mExtras == null ? defaultValue :
3617 mExtras.getDouble(name, defaultValue);
3618 }
3619
3620 /**
3621 * Retrieve extended data from the intent.
3622 *
3623 * @param name The name of the desired item.
3624 *
3625 * @return the value of an item that previously added with putExtra()
3626 * or null if no String value was found.
3627 *
3628 * @see #putExtra(String, String)
3629 */
3630 public String getStringExtra(String name) {
3631 return mExtras == null ? null : mExtras.getString(name);
3632 }
3633
3634 /**
3635 * Retrieve extended data from the intent.
3636 *
3637 * @param name The name of the desired item.
3638 *
3639 * @return the value of an item that previously added with putExtra()
3640 * or null if no CharSequence value was found.
3641 *
3642 * @see #putExtra(String, CharSequence)
3643 */
3644 public CharSequence getCharSequenceExtra(String name) {
3645 return mExtras == null ? null : mExtras.getCharSequence(name);
3646 }
3647
3648 /**
3649 * Retrieve extended data from the intent.
3650 *
3651 * @param name The name of the desired item.
3652 *
3653 * @return the value of an item that previously added with putExtra()
3654 * or null if no Parcelable value was found.
3655 *
3656 * @see #putExtra(String, Parcelable)
3657 */
3658 public <T extends Parcelable> T getParcelableExtra(String name) {
3659 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3660 }
3661
3662 /**
3663 * Retrieve extended data from the intent.
3664 *
3665 * @param name The name of the desired item.
3666 *
3667 * @return the value of an item that previously added with putExtra()
3668 * or null if no Parcelable[] value was found.
3669 *
3670 * @see #putExtra(String, Parcelable[])
3671 */
3672 public Parcelable[] getParcelableArrayExtra(String name) {
3673 return mExtras == null ? null : mExtras.getParcelableArray(name);
3674 }
3675
3676 /**
3677 * Retrieve extended data from the intent.
3678 *
3679 * @param name The name of the desired item.
3680 *
3681 * @return the value of an item that previously added with putExtra()
3682 * or null if no ArrayList<Parcelable> value was found.
3683 *
3684 * @see #putParcelableArrayListExtra(String, ArrayList)
3685 */
3686 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3687 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3688 }
3689
3690 /**
3691 * Retrieve extended data from the intent.
3692 *
3693 * @param name The name of the desired item.
3694 *
3695 * @return the value of an item that previously added with putExtra()
3696 * or null if no Serializable value was found.
3697 *
3698 * @see #putExtra(String, Serializable)
3699 */
3700 public Serializable getSerializableExtra(String name) {
3701 return mExtras == null ? null : mExtras.getSerializable(name);
3702 }
3703
3704 /**
3705 * Retrieve extended data from the intent.
3706 *
3707 * @param name The name of the desired item.
3708 *
3709 * @return the value of an item that previously added with putExtra()
3710 * or null if no ArrayList<Integer> value was found.
3711 *
3712 * @see #putIntegerArrayListExtra(String, ArrayList)
3713 */
3714 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3715 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3716 }
3717
3718 /**
3719 * Retrieve extended data from the intent.
3720 *
3721 * @param name The name of the desired item.
3722 *
3723 * @return the value of an item that previously added with putExtra()
3724 * or null if no ArrayList<String> value was found.
3725 *
3726 * @see #putStringArrayListExtra(String, ArrayList)
3727 */
3728 public ArrayList<String> getStringArrayListExtra(String name) {
3729 return mExtras == null ? null : mExtras.getStringArrayList(name);
3730 }
3731
3732 /**
3733 * Retrieve extended data from the intent.
3734 *
3735 * @param name The name of the desired item.
3736 *
3737 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003738 * or null if no ArrayList<CharSequence> value was found.
3739 *
3740 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3741 */
3742 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3743 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3744 }
3745
3746 /**
3747 * Retrieve extended data from the intent.
3748 *
3749 * @param name The name of the desired item.
3750 *
3751 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003752 * or null if no boolean array value was found.
3753 *
3754 * @see #putExtra(String, boolean[])
3755 */
3756 public boolean[] getBooleanArrayExtra(String name) {
3757 return mExtras == null ? null : mExtras.getBooleanArray(name);
3758 }
3759
3760 /**
3761 * Retrieve extended data from the intent.
3762 *
3763 * @param name The name of the desired item.
3764 *
3765 * @return the value of an item that previously added with putExtra()
3766 * or null if no byte array value was found.
3767 *
3768 * @see #putExtra(String, byte[])
3769 */
3770 public byte[] getByteArrayExtra(String name) {
3771 return mExtras == null ? null : mExtras.getByteArray(name);
3772 }
3773
3774 /**
3775 * Retrieve extended data from the intent.
3776 *
3777 * @param name The name of the desired item.
3778 *
3779 * @return the value of an item that previously added with putExtra()
3780 * or null if no short array value was found.
3781 *
3782 * @see #putExtra(String, short[])
3783 */
3784 public short[] getShortArrayExtra(String name) {
3785 return mExtras == null ? null : mExtras.getShortArray(name);
3786 }
3787
3788 /**
3789 * Retrieve extended data from the intent.
3790 *
3791 * @param name The name of the desired item.
3792 *
3793 * @return the value of an item that previously added with putExtra()
3794 * or null if no char array value was found.
3795 *
3796 * @see #putExtra(String, char[])
3797 */
3798 public char[] getCharArrayExtra(String name) {
3799 return mExtras == null ? null : mExtras.getCharArray(name);
3800 }
3801
3802 /**
3803 * Retrieve extended data from the intent.
3804 *
3805 * @param name The name of the desired item.
3806 *
3807 * @return the value of an item that previously added with putExtra()
3808 * or null if no int array value was found.
3809 *
3810 * @see #putExtra(String, int[])
3811 */
3812 public int[] getIntArrayExtra(String name) {
3813 return mExtras == null ? null : mExtras.getIntArray(name);
3814 }
3815
3816 /**
3817 * Retrieve extended data from the intent.
3818 *
3819 * @param name The name of the desired item.
3820 *
3821 * @return the value of an item that previously added with putExtra()
3822 * or null if no long array value was found.
3823 *
3824 * @see #putExtra(String, long[])
3825 */
3826 public long[] getLongArrayExtra(String name) {
3827 return mExtras == null ? null : mExtras.getLongArray(name);
3828 }
3829
3830 /**
3831 * Retrieve extended data from the intent.
3832 *
3833 * @param name The name of the desired item.
3834 *
3835 * @return the value of an item that previously added with putExtra()
3836 * or null if no float array value was found.
3837 *
3838 * @see #putExtra(String, float[])
3839 */
3840 public float[] getFloatArrayExtra(String name) {
3841 return mExtras == null ? null : mExtras.getFloatArray(name);
3842 }
3843
3844 /**
3845 * Retrieve extended data from the intent.
3846 *
3847 * @param name The name of the desired item.
3848 *
3849 * @return the value of an item that previously added with putExtra()
3850 * or null if no double array value was found.
3851 *
3852 * @see #putExtra(String, double[])
3853 */
3854 public double[] getDoubleArrayExtra(String name) {
3855 return mExtras == null ? null : mExtras.getDoubleArray(name);
3856 }
3857
3858 /**
3859 * Retrieve extended data from the intent.
3860 *
3861 * @param name The name of the desired item.
3862 *
3863 * @return the value of an item that previously added with putExtra()
3864 * or null if no String array value was found.
3865 *
3866 * @see #putExtra(String, String[])
3867 */
3868 public String[] getStringArrayExtra(String name) {
3869 return mExtras == null ? null : mExtras.getStringArray(name);
3870 }
3871
3872 /**
3873 * Retrieve extended data from the intent.
3874 *
3875 * @param name The name of the desired item.
3876 *
3877 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003878 * or null if no CharSequence array value was found.
3879 *
3880 * @see #putExtra(String, CharSequence[])
3881 */
3882 public CharSequence[] getCharSequenceArrayExtra(String name) {
3883 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3884 }
3885
3886 /**
3887 * Retrieve extended data from the intent.
3888 *
3889 * @param name The name of the desired item.
3890 *
3891 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003892 * or null if no Bundle value was found.
3893 *
3894 * @see #putExtra(String, Bundle)
3895 */
3896 public Bundle getBundleExtra(String name) {
3897 return mExtras == null ? null : mExtras.getBundle(name);
3898 }
3899
3900 /**
3901 * Retrieve extended data from the intent.
3902 *
3903 * @param name The name of the desired item.
3904 *
3905 * @return the value of an item that previously added with putExtra()
3906 * or null if no IBinder value was found.
3907 *
3908 * @see #putExtra(String, IBinder)
3909 *
3910 * @deprecated
3911 * @hide
3912 */
3913 @Deprecated
3914 public IBinder getIBinderExtra(String name) {
3915 return mExtras == null ? null : mExtras.getIBinder(name);
3916 }
3917
3918 /**
3919 * Retrieve extended data from the intent.
3920 *
3921 * @param name The name of the desired item.
3922 * @param defaultValue The default value to return in case no item is
3923 * associated with the key 'name'
3924 *
3925 * @return the value of an item that previously added with putExtra()
3926 * or defaultValue if none was found.
3927 *
3928 * @see #putExtra
3929 *
3930 * @deprecated
3931 * @hide
3932 */
3933 @Deprecated
3934 public Object getExtra(String name, Object defaultValue) {
3935 Object result = defaultValue;
3936 if (mExtras != null) {
3937 Object result2 = mExtras.get(name);
3938 if (result2 != null) {
3939 result = result2;
3940 }
3941 }
3942
3943 return result;
3944 }
3945
3946 /**
3947 * Retrieves a map of extended data from the intent.
3948 *
3949 * @return the map of all extras previously added with putExtra(),
3950 * or null if none have been added.
3951 */
3952 public Bundle getExtras() {
3953 return (mExtras != null)
3954 ? new Bundle(mExtras)
3955 : null;
3956 }
3957
3958 /**
3959 * Retrieve any special flags associated with this intent. You will
3960 * normally just set them with {@link #setFlags} and let the system
3961 * take the appropriate action with them.
3962 *
3963 * @return int The currently set flags.
3964 *
3965 * @see #setFlags
3966 */
3967 public int getFlags() {
3968 return mFlags;
3969 }
3970
Dianne Hackborne7f97212011-02-24 14:40:20 -08003971 /** @hide */
3972 public boolean isExcludingStopped() {
3973 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
3974 == FLAG_EXCLUDE_STOPPED_PACKAGES;
3975 }
3976
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003977 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003978 * Retrieve the application package name this Intent is limited to. When
3979 * resolving an Intent, if non-null this limits the resolution to only
3980 * components in the given application package.
3981 *
3982 * @return The name of the application package for the Intent.
3983 *
3984 * @see #resolveActivity
3985 * @see #setPackage
3986 */
3987 public String getPackage() {
3988 return mPackage;
3989 }
3990
3991 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003992 * Retrieve the concrete component associated with the intent. When receiving
3993 * an intent, this is the component that was found to best handle it (that is,
3994 * yourself) and will always be non-null; in all other cases it will be
3995 * null unless explicitly set.
3996 *
3997 * @return The name of the application component to handle the intent.
3998 *
3999 * @see #resolveActivity
4000 * @see #setComponent
4001 */
4002 public ComponentName getComponent() {
4003 return mComponent;
4004 }
4005
4006 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004007 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4008 * used as a hint to the receiver for animations and the like. Null means that there
4009 * is no source bounds.
4010 */
4011 public Rect getSourceBounds() {
4012 return mSourceBounds;
4013 }
4014
4015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004016 * Return the Activity component that should be used to handle this intent.
4017 * The appropriate component is determined based on the information in the
4018 * intent, evaluated as follows:
4019 *
4020 * <p>If {@link #getComponent} returns an explicit class, that is returned
4021 * without any further consideration.
4022 *
4023 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4024 * category to be considered.
4025 *
4026 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4027 * action.
4028 *
4029 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4030 * this type.
4031 *
4032 * <p>If {@link #addCategory} has added any categories, the activity must
4033 * handle ALL of the categories specified.
4034 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004035 * <p>If {@link #getPackage} is non-NULL, only activity components in
4036 * that application package will be considered.
4037 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004038 * <p>If there are no activities that satisfy all of these conditions, a
4039 * null string is returned.
4040 *
4041 * <p>If multiple activities are found to satisfy the intent, the one with
4042 * the highest priority will be used. If there are multiple activities
4043 * with the same priority, the system will either pick the best activity
4044 * based on user preference, or resolve to a system class that will allow
4045 * the user to pick an activity and forward from there.
4046 *
4047 * <p>This method is implemented simply by calling
4048 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4049 * true.</p>
4050 * <p> This API is called for you as part of starting an activity from an
4051 * intent. You do not normally need to call it yourself.</p>
4052 *
4053 * @param pm The package manager with which to resolve the Intent.
4054 *
4055 * @return Name of the component implementing an activity that can
4056 * display the intent.
4057 *
4058 * @see #setComponent
4059 * @see #getComponent
4060 * @see #resolveActivityInfo
4061 */
4062 public ComponentName resolveActivity(PackageManager pm) {
4063 if (mComponent != null) {
4064 return mComponent;
4065 }
4066
4067 ResolveInfo info = pm.resolveActivity(
4068 this, PackageManager.MATCH_DEFAULT_ONLY);
4069 if (info != null) {
4070 return new ComponentName(
4071 info.activityInfo.applicationInfo.packageName,
4072 info.activityInfo.name);
4073 }
4074
4075 return null;
4076 }
4077
4078 /**
4079 * Resolve the Intent into an {@link ActivityInfo}
4080 * describing the activity that should execute the intent. Resolution
4081 * follows the same rules as described for {@link #resolveActivity}, but
4082 * you get back the completely information about the resolved activity
4083 * instead of just its class name.
4084 *
4085 * @param pm The package manager with which to resolve the Intent.
4086 * @param flags Addition information to retrieve as per
4087 * {@link PackageManager#getActivityInfo(ComponentName, int)
4088 * PackageManager.getActivityInfo()}.
4089 *
4090 * @return PackageManager.ActivityInfo
4091 *
4092 * @see #resolveActivity
4093 */
4094 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4095 ActivityInfo ai = null;
4096 if (mComponent != null) {
4097 try {
4098 ai = pm.getActivityInfo(mComponent, flags);
4099 } catch (PackageManager.NameNotFoundException e) {
4100 // ignore
4101 }
4102 } else {
4103 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004104 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105 if (info != null) {
4106 ai = info.activityInfo;
4107 }
4108 }
4109
4110 return ai;
4111 }
4112
4113 /**
4114 * Set the general action to be performed.
4115 *
4116 * @param action An action name, such as ACTION_VIEW. Application-specific
4117 * actions should be prefixed with the vendor's package name.
4118 *
4119 * @return Returns the same Intent object, for chaining multiple calls
4120 * into a single statement.
4121 *
4122 * @see #getAction
4123 */
4124 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004125 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004126 return this;
4127 }
4128
4129 /**
4130 * Set the data this intent is operating on. This method automatically
4131 * clears any type that was previously set by {@link #setType}.
4132 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004133 * <p><em>Note: scheme and host name matching in the Android framework is
4134 * case-sensitive, unlike the formal RFC. As a result,
4135 * you should always ensure that you write your Uri with these elements
4136 * using lower case letters, and normalize any Uris you receive from
4137 * outside of Android to ensure the scheme and host is lower case.</em></p>
4138 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004139 * @param data The URI of the data this intent is now targeting.
4140 *
4141 * @return Returns the same Intent object, for chaining multiple calls
4142 * into a single statement.
4143 *
4144 * @see #getData
4145 * @see #setType
4146 * @see #setDataAndType
4147 */
4148 public Intent setData(Uri data) {
4149 mData = data;
4150 mType = null;
4151 return this;
4152 }
4153
4154 /**
4155 * Set an explicit MIME data type. This is used to create intents that
4156 * only specify a type and not data, for example to indicate the type of
4157 * data to return. This method automatically clears any data that was
4158 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07004159 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004160 * <p><em>Note: MIME type matching in the Android framework is
4161 * case-sensitive, unlike formal RFC MIME types. As a result,
4162 * you should always write your MIME types with lower case letters,
4163 * and any MIME types you receive from outside of Android should be
4164 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004165 *
4166 * @param type The MIME type of the data being handled by this intent.
4167 *
4168 * @return Returns the same Intent object, for chaining multiple calls
4169 * into a single statement.
4170 *
4171 * @see #getType
4172 * @see #setData
4173 * @see #setDataAndType
4174 */
4175 public Intent setType(String type) {
4176 mData = null;
4177 mType = type;
4178 return this;
4179 }
4180
4181 /**
4182 * (Usually optional) Set the data for the intent along with an explicit
4183 * MIME data type. This method should very rarely be used -- it allows you
4184 * to override the MIME type that would ordinarily be inferred from the
4185 * data with your own type given here.
4186 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004187 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
4188 * Android framework is case-sensitive, unlike the formal RFC definitions.
4189 * As a result, you should always write these elements with lower case letters,
4190 * and normalize any MIME types or Uris you receive from
4191 * outside of Android to ensure these elements are lower case before
4192 * supplying them here.</em></p>
4193 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004194 * @param data The URI of the data this intent is now targeting.
4195 * @param type The MIME type of the data being handled by this intent.
4196 *
4197 * @return Returns the same Intent object, for chaining multiple calls
4198 * into a single statement.
4199 *
4200 * @see #setData
4201 * @see #setType
4202 */
4203 public Intent setDataAndType(Uri data, String type) {
4204 mData = data;
4205 mType = type;
4206 return this;
4207 }
4208
4209 /**
4210 * Add a new category to the intent. Categories provide additional detail
4211 * about the action the intent is perform. When resolving an intent, only
4212 * activities that provide <em>all</em> of the requested categories will be
4213 * used.
4214 *
4215 * @param category The desired category. This can be either one of the
4216 * predefined Intent categories, or a custom category in your own
4217 * namespace.
4218 *
4219 * @return Returns the same Intent object, for chaining multiple calls
4220 * into a single statement.
4221 *
4222 * @see #hasCategory
4223 * @see #removeCategory
4224 */
4225 public Intent addCategory(String category) {
4226 if (mCategories == null) {
4227 mCategories = new HashSet<String>();
4228 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004229 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230 return this;
4231 }
4232
4233 /**
4234 * Remove an category from an intent.
4235 *
4236 * @param category The category to remove.
4237 *
4238 * @see #addCategory
4239 */
4240 public void removeCategory(String category) {
4241 if (mCategories != null) {
4242 mCategories.remove(category);
4243 if (mCategories.size() == 0) {
4244 mCategories = null;
4245 }
4246 }
4247 }
4248
4249 /**
4250 * Add extended data to the intent. The name must include a package
4251 * prefix, for example the app com.android.contacts would use names
4252 * like "com.android.contacts.ShowAll".
4253 *
4254 * @param name The name of the extra data, with package prefix.
4255 * @param value The boolean data value.
4256 *
4257 * @return Returns the same Intent object, for chaining multiple calls
4258 * into a single statement.
4259 *
4260 * @see #putExtras
4261 * @see #removeExtra
4262 * @see #getBooleanExtra(String, boolean)
4263 */
4264 public Intent putExtra(String name, boolean value) {
4265 if (mExtras == null) {
4266 mExtras = new Bundle();
4267 }
4268 mExtras.putBoolean(name, value);
4269 return this;
4270 }
4271
4272 /**
4273 * Add extended data to the intent. The name must include a package
4274 * prefix, for example the app com.android.contacts would use names
4275 * like "com.android.contacts.ShowAll".
4276 *
4277 * @param name The name of the extra data, with package prefix.
4278 * @param value The byte data value.
4279 *
4280 * @return Returns the same Intent object, for chaining multiple calls
4281 * into a single statement.
4282 *
4283 * @see #putExtras
4284 * @see #removeExtra
4285 * @see #getByteExtra(String, byte)
4286 */
4287 public Intent putExtra(String name, byte value) {
4288 if (mExtras == null) {
4289 mExtras = new Bundle();
4290 }
4291 mExtras.putByte(name, value);
4292 return this;
4293 }
4294
4295 /**
4296 * Add extended data to the intent. The name must include a package
4297 * prefix, for example the app com.android.contacts would use names
4298 * like "com.android.contacts.ShowAll".
4299 *
4300 * @param name The name of the extra data, with package prefix.
4301 * @param value The char data value.
4302 *
4303 * @return Returns the same Intent object, for chaining multiple calls
4304 * into a single statement.
4305 *
4306 * @see #putExtras
4307 * @see #removeExtra
4308 * @see #getCharExtra(String, char)
4309 */
4310 public Intent putExtra(String name, char value) {
4311 if (mExtras == null) {
4312 mExtras = new Bundle();
4313 }
4314 mExtras.putChar(name, value);
4315 return this;
4316 }
4317
4318 /**
4319 * Add extended data to the intent. The name must include a package
4320 * prefix, for example the app com.android.contacts would use names
4321 * like "com.android.contacts.ShowAll".
4322 *
4323 * @param name The name of the extra data, with package prefix.
4324 * @param value The short data value.
4325 *
4326 * @return Returns the same Intent object, for chaining multiple calls
4327 * into a single statement.
4328 *
4329 * @see #putExtras
4330 * @see #removeExtra
4331 * @see #getShortExtra(String, short)
4332 */
4333 public Intent putExtra(String name, short value) {
4334 if (mExtras == null) {
4335 mExtras = new Bundle();
4336 }
4337 mExtras.putShort(name, value);
4338 return this;
4339 }
4340
4341 /**
4342 * Add extended data to the intent. The name must include a package
4343 * prefix, for example the app com.android.contacts would use names
4344 * like "com.android.contacts.ShowAll".
4345 *
4346 * @param name The name of the extra data, with package prefix.
4347 * @param value The integer data value.
4348 *
4349 * @return Returns the same Intent object, for chaining multiple calls
4350 * into a single statement.
4351 *
4352 * @see #putExtras
4353 * @see #removeExtra
4354 * @see #getIntExtra(String, int)
4355 */
4356 public Intent putExtra(String name, int value) {
4357 if (mExtras == null) {
4358 mExtras = new Bundle();
4359 }
4360 mExtras.putInt(name, value);
4361 return this;
4362 }
4363
4364 /**
4365 * Add extended data to the intent. The name must include a package
4366 * prefix, for example the app com.android.contacts would use names
4367 * like "com.android.contacts.ShowAll".
4368 *
4369 * @param name The name of the extra data, with package prefix.
4370 * @param value The long data value.
4371 *
4372 * @return Returns the same Intent object, for chaining multiple calls
4373 * into a single statement.
4374 *
4375 * @see #putExtras
4376 * @see #removeExtra
4377 * @see #getLongExtra(String, long)
4378 */
4379 public Intent putExtra(String name, long value) {
4380 if (mExtras == null) {
4381 mExtras = new Bundle();
4382 }
4383 mExtras.putLong(name, value);
4384 return this;
4385 }
4386
4387 /**
4388 * Add extended data to the intent. The name must include a package
4389 * prefix, for example the app com.android.contacts would use names
4390 * like "com.android.contacts.ShowAll".
4391 *
4392 * @param name The name of the extra data, with package prefix.
4393 * @param value The float data value.
4394 *
4395 * @return Returns the same Intent object, for chaining multiple calls
4396 * into a single statement.
4397 *
4398 * @see #putExtras
4399 * @see #removeExtra
4400 * @see #getFloatExtra(String, float)
4401 */
4402 public Intent putExtra(String name, float value) {
4403 if (mExtras == null) {
4404 mExtras = new Bundle();
4405 }
4406 mExtras.putFloat(name, value);
4407 return this;
4408 }
4409
4410 /**
4411 * Add extended data to the intent. The name must include a package
4412 * prefix, for example the app com.android.contacts would use names
4413 * like "com.android.contacts.ShowAll".
4414 *
4415 * @param name The name of the extra data, with package prefix.
4416 * @param value The double data value.
4417 *
4418 * @return Returns the same Intent object, for chaining multiple calls
4419 * into a single statement.
4420 *
4421 * @see #putExtras
4422 * @see #removeExtra
4423 * @see #getDoubleExtra(String, double)
4424 */
4425 public Intent putExtra(String name, double value) {
4426 if (mExtras == null) {
4427 mExtras = new Bundle();
4428 }
4429 mExtras.putDouble(name, value);
4430 return this;
4431 }
4432
4433 /**
4434 * Add extended data to the intent. The name must include a package
4435 * prefix, for example the app com.android.contacts would use names
4436 * like "com.android.contacts.ShowAll".
4437 *
4438 * @param name The name of the extra data, with package prefix.
4439 * @param value The String data value.
4440 *
4441 * @return Returns the same Intent object, for chaining multiple calls
4442 * into a single statement.
4443 *
4444 * @see #putExtras
4445 * @see #removeExtra
4446 * @see #getStringExtra(String)
4447 */
4448 public Intent putExtra(String name, String value) {
4449 if (mExtras == null) {
4450 mExtras = new Bundle();
4451 }
4452 mExtras.putString(name, value);
4453 return this;
4454 }
4455
4456 /**
4457 * Add extended data to the intent. The name must include a package
4458 * prefix, for example the app com.android.contacts would use names
4459 * like "com.android.contacts.ShowAll".
4460 *
4461 * @param name The name of the extra data, with package prefix.
4462 * @param value The CharSequence data value.
4463 *
4464 * @return Returns the same Intent object, for chaining multiple calls
4465 * into a single statement.
4466 *
4467 * @see #putExtras
4468 * @see #removeExtra
4469 * @see #getCharSequenceExtra(String)
4470 */
4471 public Intent putExtra(String name, CharSequence value) {
4472 if (mExtras == null) {
4473 mExtras = new Bundle();
4474 }
4475 mExtras.putCharSequence(name, value);
4476 return this;
4477 }
4478
4479 /**
4480 * Add extended data to the intent. The name must include a package
4481 * prefix, for example the app com.android.contacts would use names
4482 * like "com.android.contacts.ShowAll".
4483 *
4484 * @param name The name of the extra data, with package prefix.
4485 * @param value The Parcelable data value.
4486 *
4487 * @return Returns the same Intent object, for chaining multiple calls
4488 * into a single statement.
4489 *
4490 * @see #putExtras
4491 * @see #removeExtra
4492 * @see #getParcelableExtra(String)
4493 */
4494 public Intent putExtra(String name, Parcelable value) {
4495 if (mExtras == null) {
4496 mExtras = new Bundle();
4497 }
4498 mExtras.putParcelable(name, value);
4499 return this;
4500 }
4501
4502 /**
4503 * Add extended data to the intent. The name must include a package
4504 * prefix, for example the app com.android.contacts would use names
4505 * like "com.android.contacts.ShowAll".
4506 *
4507 * @param name The name of the extra data, with package prefix.
4508 * @param value The Parcelable[] data value.
4509 *
4510 * @return Returns the same Intent object, for chaining multiple calls
4511 * into a single statement.
4512 *
4513 * @see #putExtras
4514 * @see #removeExtra
4515 * @see #getParcelableArrayExtra(String)
4516 */
4517 public Intent putExtra(String name, Parcelable[] value) {
4518 if (mExtras == null) {
4519 mExtras = new Bundle();
4520 }
4521 mExtras.putParcelableArray(name, value);
4522 return this;
4523 }
4524
4525 /**
4526 * Add extended data to the intent. The name must include a package
4527 * prefix, for example the app com.android.contacts would use names
4528 * like "com.android.contacts.ShowAll".
4529 *
4530 * @param name The name of the extra data, with package prefix.
4531 * @param value The ArrayList<Parcelable> data value.
4532 *
4533 * @return Returns the same Intent object, for chaining multiple calls
4534 * into a single statement.
4535 *
4536 * @see #putExtras
4537 * @see #removeExtra
4538 * @see #getParcelableArrayListExtra(String)
4539 */
4540 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4541 if (mExtras == null) {
4542 mExtras = new Bundle();
4543 }
4544 mExtras.putParcelableArrayList(name, value);
4545 return this;
4546 }
4547
4548 /**
4549 * Add extended data to the intent. The name must include a package
4550 * prefix, for example the app com.android.contacts would use names
4551 * like "com.android.contacts.ShowAll".
4552 *
4553 * @param name The name of the extra data, with package prefix.
4554 * @param value The ArrayList<Integer> data value.
4555 *
4556 * @return Returns the same Intent object, for chaining multiple calls
4557 * into a single statement.
4558 *
4559 * @see #putExtras
4560 * @see #removeExtra
4561 * @see #getIntegerArrayListExtra(String)
4562 */
4563 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4564 if (mExtras == null) {
4565 mExtras = new Bundle();
4566 }
4567 mExtras.putIntegerArrayList(name, value);
4568 return this;
4569 }
4570
4571 /**
4572 * Add extended data to the intent. The name must include a package
4573 * prefix, for example the app com.android.contacts would use names
4574 * like "com.android.contacts.ShowAll".
4575 *
4576 * @param name The name of the extra data, with package prefix.
4577 * @param value The ArrayList<String> data value.
4578 *
4579 * @return Returns the same Intent object, for chaining multiple calls
4580 * into a single statement.
4581 *
4582 * @see #putExtras
4583 * @see #removeExtra
4584 * @see #getStringArrayListExtra(String)
4585 */
4586 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4587 if (mExtras == null) {
4588 mExtras = new Bundle();
4589 }
4590 mExtras.putStringArrayList(name, value);
4591 return this;
4592 }
4593
4594 /**
4595 * Add extended data to the intent. The name must include a package
4596 * prefix, for example the app com.android.contacts would use names
4597 * like "com.android.contacts.ShowAll".
4598 *
4599 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004600 * @param value The ArrayList<CharSequence> data value.
4601 *
4602 * @return Returns the same Intent object, for chaining multiple calls
4603 * into a single statement.
4604 *
4605 * @see #putExtras
4606 * @see #removeExtra
4607 * @see #getCharSequenceArrayListExtra(String)
4608 */
4609 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4610 if (mExtras == null) {
4611 mExtras = new Bundle();
4612 }
4613 mExtras.putCharSequenceArrayList(name, value);
4614 return this;
4615 }
4616
4617 /**
4618 * Add extended data to the intent. The name must include a package
4619 * prefix, for example the app com.android.contacts would use names
4620 * like "com.android.contacts.ShowAll".
4621 *
4622 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004623 * @param value The Serializable data value.
4624 *
4625 * @return Returns the same Intent object, for chaining multiple calls
4626 * into a single statement.
4627 *
4628 * @see #putExtras
4629 * @see #removeExtra
4630 * @see #getSerializableExtra(String)
4631 */
4632 public Intent putExtra(String name, Serializable value) {
4633 if (mExtras == null) {
4634 mExtras = new Bundle();
4635 }
4636 mExtras.putSerializable(name, value);
4637 return this;
4638 }
4639
4640 /**
4641 * Add extended data to the intent. The name must include a package
4642 * prefix, for example the app com.android.contacts would use names
4643 * like "com.android.contacts.ShowAll".
4644 *
4645 * @param name The name of the extra data, with package prefix.
4646 * @param value The boolean array data value.
4647 *
4648 * @return Returns the same Intent object, for chaining multiple calls
4649 * into a single statement.
4650 *
4651 * @see #putExtras
4652 * @see #removeExtra
4653 * @see #getBooleanArrayExtra(String)
4654 */
4655 public Intent putExtra(String name, boolean[] value) {
4656 if (mExtras == null) {
4657 mExtras = new Bundle();
4658 }
4659 mExtras.putBooleanArray(name, value);
4660 return this;
4661 }
4662
4663 /**
4664 * Add extended data to the intent. The name must include a package
4665 * prefix, for example the app com.android.contacts would use names
4666 * like "com.android.contacts.ShowAll".
4667 *
4668 * @param name The name of the extra data, with package prefix.
4669 * @param value The byte array data value.
4670 *
4671 * @return Returns the same Intent object, for chaining multiple calls
4672 * into a single statement.
4673 *
4674 * @see #putExtras
4675 * @see #removeExtra
4676 * @see #getByteArrayExtra(String)
4677 */
4678 public Intent putExtra(String name, byte[] value) {
4679 if (mExtras == null) {
4680 mExtras = new Bundle();
4681 }
4682 mExtras.putByteArray(name, value);
4683 return this;
4684 }
4685
4686 /**
4687 * Add extended data to the intent. The name must include a package
4688 * prefix, for example the app com.android.contacts would use names
4689 * like "com.android.contacts.ShowAll".
4690 *
4691 * @param name The name of the extra data, with package prefix.
4692 * @param value The short array data value.
4693 *
4694 * @return Returns the same Intent object, for chaining multiple calls
4695 * into a single statement.
4696 *
4697 * @see #putExtras
4698 * @see #removeExtra
4699 * @see #getShortArrayExtra(String)
4700 */
4701 public Intent putExtra(String name, short[] value) {
4702 if (mExtras == null) {
4703 mExtras = new Bundle();
4704 }
4705 mExtras.putShortArray(name, value);
4706 return this;
4707 }
4708
4709 /**
4710 * Add extended data to the intent. The name must include a package
4711 * prefix, for example the app com.android.contacts would use names
4712 * like "com.android.contacts.ShowAll".
4713 *
4714 * @param name The name of the extra data, with package prefix.
4715 * @param value The char array data value.
4716 *
4717 * @return Returns the same Intent object, for chaining multiple calls
4718 * into a single statement.
4719 *
4720 * @see #putExtras
4721 * @see #removeExtra
4722 * @see #getCharArrayExtra(String)
4723 */
4724 public Intent putExtra(String name, char[] value) {
4725 if (mExtras == null) {
4726 mExtras = new Bundle();
4727 }
4728 mExtras.putCharArray(name, value);
4729 return this;
4730 }
4731
4732 /**
4733 * Add extended data to the intent. The name must include a package
4734 * prefix, for example the app com.android.contacts would use names
4735 * like "com.android.contacts.ShowAll".
4736 *
4737 * @param name The name of the extra data, with package prefix.
4738 * @param value The int array data value.
4739 *
4740 * @return Returns the same Intent object, for chaining multiple calls
4741 * into a single statement.
4742 *
4743 * @see #putExtras
4744 * @see #removeExtra
4745 * @see #getIntArrayExtra(String)
4746 */
4747 public Intent putExtra(String name, int[] value) {
4748 if (mExtras == null) {
4749 mExtras = new Bundle();
4750 }
4751 mExtras.putIntArray(name, value);
4752 return this;
4753 }
4754
4755 /**
4756 * Add extended data to the intent. The name must include a package
4757 * prefix, for example the app com.android.contacts would use names
4758 * like "com.android.contacts.ShowAll".
4759 *
4760 * @param name The name of the extra data, with package prefix.
4761 * @param value The byte array data value.
4762 *
4763 * @return Returns the same Intent object, for chaining multiple calls
4764 * into a single statement.
4765 *
4766 * @see #putExtras
4767 * @see #removeExtra
4768 * @see #getLongArrayExtra(String)
4769 */
4770 public Intent putExtra(String name, long[] value) {
4771 if (mExtras == null) {
4772 mExtras = new Bundle();
4773 }
4774 mExtras.putLongArray(name, value);
4775 return this;
4776 }
4777
4778 /**
4779 * Add extended data to the intent. The name must include a package
4780 * prefix, for example the app com.android.contacts would use names
4781 * like "com.android.contacts.ShowAll".
4782 *
4783 * @param name The name of the extra data, with package prefix.
4784 * @param value The float array data value.
4785 *
4786 * @return Returns the same Intent object, for chaining multiple calls
4787 * into a single statement.
4788 *
4789 * @see #putExtras
4790 * @see #removeExtra
4791 * @see #getFloatArrayExtra(String)
4792 */
4793 public Intent putExtra(String name, float[] value) {
4794 if (mExtras == null) {
4795 mExtras = new Bundle();
4796 }
4797 mExtras.putFloatArray(name, value);
4798 return this;
4799 }
4800
4801 /**
4802 * Add extended data to the intent. The name must include a package
4803 * prefix, for example the app com.android.contacts would use names
4804 * like "com.android.contacts.ShowAll".
4805 *
4806 * @param name The name of the extra data, with package prefix.
4807 * @param value The double array data value.
4808 *
4809 * @return Returns the same Intent object, for chaining multiple calls
4810 * into a single statement.
4811 *
4812 * @see #putExtras
4813 * @see #removeExtra
4814 * @see #getDoubleArrayExtra(String)
4815 */
4816 public Intent putExtra(String name, double[] value) {
4817 if (mExtras == null) {
4818 mExtras = new Bundle();
4819 }
4820 mExtras.putDoubleArray(name, value);
4821 return this;
4822 }
4823
4824 /**
4825 * Add extended data to the intent. The name must include a package
4826 * prefix, for example the app com.android.contacts would use names
4827 * like "com.android.contacts.ShowAll".
4828 *
4829 * @param name The name of the extra data, with package prefix.
4830 * @param value The String array data value.
4831 *
4832 * @return Returns the same Intent object, for chaining multiple calls
4833 * into a single statement.
4834 *
4835 * @see #putExtras
4836 * @see #removeExtra
4837 * @see #getStringArrayExtra(String)
4838 */
4839 public Intent putExtra(String name, String[] value) {
4840 if (mExtras == null) {
4841 mExtras = new Bundle();
4842 }
4843 mExtras.putStringArray(name, value);
4844 return this;
4845 }
4846
4847 /**
4848 * Add extended data to the intent. The name must include a package
4849 * prefix, for example the app com.android.contacts would use names
4850 * like "com.android.contacts.ShowAll".
4851 *
4852 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004853 * @param value The CharSequence array data value.
4854 *
4855 * @return Returns the same Intent object, for chaining multiple calls
4856 * into a single statement.
4857 *
4858 * @see #putExtras
4859 * @see #removeExtra
4860 * @see #getCharSequenceArrayExtra(String)
4861 */
4862 public Intent putExtra(String name, CharSequence[] value) {
4863 if (mExtras == null) {
4864 mExtras = new Bundle();
4865 }
4866 mExtras.putCharSequenceArray(name, value);
4867 return this;
4868 }
4869
4870 /**
4871 * Add extended data to the intent. The name must include a package
4872 * prefix, for example the app com.android.contacts would use names
4873 * like "com.android.contacts.ShowAll".
4874 *
4875 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004876 * @param value The Bundle data value.
4877 *
4878 * @return Returns the same Intent object, for chaining multiple calls
4879 * into a single statement.
4880 *
4881 * @see #putExtras
4882 * @see #removeExtra
4883 * @see #getBundleExtra(String)
4884 */
4885 public Intent putExtra(String name, Bundle value) {
4886 if (mExtras == null) {
4887 mExtras = new Bundle();
4888 }
4889 mExtras.putBundle(name, value);
4890 return this;
4891 }
4892
4893 /**
4894 * Add extended data to the intent. The name must include a package
4895 * prefix, for example the app com.android.contacts would use names
4896 * like "com.android.contacts.ShowAll".
4897 *
4898 * @param name The name of the extra data, with package prefix.
4899 * @param value The IBinder data value.
4900 *
4901 * @return Returns the same Intent object, for chaining multiple calls
4902 * into a single statement.
4903 *
4904 * @see #putExtras
4905 * @see #removeExtra
4906 * @see #getIBinderExtra(String)
4907 *
4908 * @deprecated
4909 * @hide
4910 */
4911 @Deprecated
4912 public Intent putExtra(String name, IBinder value) {
4913 if (mExtras == null) {
4914 mExtras = new Bundle();
4915 }
4916 mExtras.putIBinder(name, value);
4917 return this;
4918 }
4919
4920 /**
4921 * Copy all extras in 'src' in to this intent.
4922 *
4923 * @param src Contains the extras to copy.
4924 *
4925 * @see #putExtra
4926 */
4927 public Intent putExtras(Intent src) {
4928 if (src.mExtras != null) {
4929 if (mExtras == null) {
4930 mExtras = new Bundle(src.mExtras);
4931 } else {
4932 mExtras.putAll(src.mExtras);
4933 }
4934 }
4935 return this;
4936 }
4937
4938 /**
4939 * Add a set of extended data to the intent. The keys must include a package
4940 * prefix, for example the app com.android.contacts would use names
4941 * like "com.android.contacts.ShowAll".
4942 *
4943 * @param extras The Bundle of extras to add to this intent.
4944 *
4945 * @see #putExtra
4946 * @see #removeExtra
4947 */
4948 public Intent putExtras(Bundle extras) {
4949 if (mExtras == null) {
4950 mExtras = new Bundle();
4951 }
4952 mExtras.putAll(extras);
4953 return this;
4954 }
4955
4956 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004957 * Completely replace the extras in the Intent with the extras in the
4958 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004959 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004960 * @param src The exact extras contained in this Intent are copied
4961 * into the target intent, replacing any that were previously there.
4962 */
4963 public Intent replaceExtras(Intent src) {
4964 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4965 return this;
4966 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004967
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004968 /**
4969 * Completely replace the extras in the Intent with the given Bundle of
4970 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004971 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004972 * @param extras The new set of extras in the Intent, or null to erase
4973 * all extras.
4974 */
4975 public Intent replaceExtras(Bundle extras) {
4976 mExtras = extras != null ? new Bundle(extras) : null;
4977 return this;
4978 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004979
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004980 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004981 * Remove extended data from the intent.
4982 *
4983 * @see #putExtra
4984 */
4985 public void removeExtra(String name) {
4986 if (mExtras != null) {
4987 mExtras.remove(name);
4988 if (mExtras.size() == 0) {
4989 mExtras = null;
4990 }
4991 }
4992 }
4993
4994 /**
4995 * Set special flags controlling how this intent is handled. Most values
4996 * here depend on the type of component being executed by the Intent,
4997 * specifically the FLAG_ACTIVITY_* flags are all for use with
4998 * {@link Context#startActivity Context.startActivity()} and the
4999 * FLAG_RECEIVER_* flags are all for use with
5000 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5001 *
Scott Main7aee61f2011-02-08 11:25:01 -08005002 * <p>See the
5003 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5004 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005005 * the behavior of your application.
5006 *
5007 * @param flags The desired flags.
5008 *
5009 * @return Returns the same Intent object, for chaining multiple calls
5010 * into a single statement.
5011 *
5012 * @see #getFlags
5013 * @see #addFlags
5014 *
5015 * @see #FLAG_GRANT_READ_URI_PERMISSION
5016 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5017 * @see #FLAG_DEBUG_LOG_RESOLUTION
5018 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005020 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005022 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005023 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5024 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005025 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005026 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5027 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005028 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005029 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005030 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005031 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5032 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005033 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005035 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005036 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5037 */
5038 public Intent setFlags(int flags) {
5039 mFlags = flags;
5040 return this;
5041 }
5042
5043 /**
5044 * Add additional flags to the intent (or with existing flags
5045 * value).
5046 *
5047 * @param flags The new flags to set.
5048 *
5049 * @return Returns the same Intent object, for chaining multiple calls
5050 * into a single statement.
5051 *
5052 * @see #setFlags
5053 */
5054 public Intent addFlags(int flags) {
5055 mFlags |= flags;
5056 return this;
5057 }
5058
5059 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005060 * (Usually optional) Set an explicit application package name that limits
5061 * the components this Intent will resolve to. If left to the default
5062 * value of null, all components in all applications will considered.
5063 * If non-null, the Intent can only match the components in the given
5064 * application package.
5065 *
5066 * @param packageName The name of the application package to handle the
5067 * intent, or null to allow any application package.
5068 *
5069 * @return Returns the same Intent object, for chaining multiple calls
5070 * into a single statement.
5071 *
5072 * @see #getPackage
5073 * @see #resolveActivity
5074 */
5075 public Intent setPackage(String packageName) {
5076 mPackage = packageName;
5077 return this;
5078 }
5079
5080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 * (Usually optional) Explicitly set the component to handle the intent.
5082 * If left with the default value of null, the system will determine the
5083 * appropriate class to use based on the other fields (action, data,
5084 * type, categories) in the Intent. If this class is defined, the
5085 * specified class will always be used regardless of the other fields. You
5086 * should only set this value when you know you absolutely want a specific
5087 * class to be used; otherwise it is better to let the system find the
5088 * appropriate class so that you will respect the installed applications
5089 * and user preferences.
5090 *
5091 * @param component The name of the application component to handle the
5092 * intent, or null to let the system find one for you.
5093 *
5094 * @return Returns the same Intent object, for chaining multiple calls
5095 * into a single statement.
5096 *
5097 * @see #setClass
5098 * @see #setClassName(Context, String)
5099 * @see #setClassName(String, String)
5100 * @see #getComponent
5101 * @see #resolveActivity
5102 */
5103 public Intent setComponent(ComponentName component) {
5104 mComponent = component;
5105 return this;
5106 }
5107
5108 /**
5109 * Convenience for calling {@link #setComponent} with an
5110 * explicit class name.
5111 *
5112 * @param packageContext A Context of the application package implementing
5113 * this class.
5114 * @param className The name of a class inside of the application package
5115 * that will be used as the component for this Intent.
5116 *
5117 * @return Returns the same Intent object, for chaining multiple calls
5118 * into a single statement.
5119 *
5120 * @see #setComponent
5121 * @see #setClass
5122 */
5123 public Intent setClassName(Context packageContext, String className) {
5124 mComponent = new ComponentName(packageContext, className);
5125 return this;
5126 }
5127
5128 /**
5129 * Convenience for calling {@link #setComponent} with an
5130 * explicit application package name and class name.
5131 *
5132 * @param packageName The name of the package implementing the desired
5133 * component.
5134 * @param className The name of a class inside of the application package
5135 * that will be used as the component for this Intent.
5136 *
5137 * @return Returns the same Intent object, for chaining multiple calls
5138 * into a single statement.
5139 *
5140 * @see #setComponent
5141 * @see #setClass
5142 */
5143 public Intent setClassName(String packageName, String className) {
5144 mComponent = new ComponentName(packageName, className);
5145 return this;
5146 }
5147
5148 /**
5149 * Convenience for calling {@link #setComponent(ComponentName)} with the
5150 * name returned by a {@link Class} object.
5151 *
5152 * @param packageContext A Context of the application package implementing
5153 * this class.
5154 * @param cls The class name to set, equivalent to
5155 * <code>setClassName(context, cls.getName())</code>.
5156 *
5157 * @return Returns the same Intent object, for chaining multiple calls
5158 * into a single statement.
5159 *
5160 * @see #setComponent
5161 */
5162 public Intent setClass(Context packageContext, Class<?> cls) {
5163 mComponent = new ComponentName(packageContext, cls);
5164 return this;
5165 }
5166
5167 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005168 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5169 * used as a hint to the receiver for animations and the like. Null means that there
5170 * is no source bounds.
5171 */
5172 public void setSourceBounds(Rect r) {
5173 if (r != null) {
5174 mSourceBounds = new Rect(r);
5175 } else {
5176 r = null;
5177 }
5178 }
5179
5180 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005181 * Use with {@link #fillIn} to allow the current action value to be
5182 * overwritten, even if it is already set.
5183 */
5184 public static final int FILL_IN_ACTION = 1<<0;
5185
5186 /**
5187 * Use with {@link #fillIn} to allow the current data or type value
5188 * overwritten, even if it is already set.
5189 */
5190 public static final int FILL_IN_DATA = 1<<1;
5191
5192 /**
5193 * Use with {@link #fillIn} to allow the current categories to be
5194 * overwritten, even if they are already set.
5195 */
5196 public static final int FILL_IN_CATEGORIES = 1<<2;
5197
5198 /**
5199 * Use with {@link #fillIn} to allow the current component value to be
5200 * overwritten, even if it is already set.
5201 */
5202 public static final int FILL_IN_COMPONENT = 1<<3;
5203
5204 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005205 * Use with {@link #fillIn} to allow the current package value to be
5206 * overwritten, even if it is already set.
5207 */
5208 public static final int FILL_IN_PACKAGE = 1<<4;
5209
5210 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005211 * Use with {@link #fillIn} to allow the current package value to be
5212 * overwritten, even if it is already set.
5213 */
5214 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5215
5216 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 * Copy the contents of <var>other</var> in to this object, but only
5218 * where fields are not defined by this object. For purposes of a field
5219 * being defined, the following pieces of data in the Intent are
5220 * considered to be separate fields:
5221 *
5222 * <ul>
5223 * <li> action, as set by {@link #setAction}.
5224 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
5225 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5226 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005227 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005228 * <li> component, as set by {@link #setComponent(ComponentName)} or
5229 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005230 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005231 * <li> each top-level name in the associated extras.
5232 * </ul>
5233 *
5234 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005235 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5236 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 * corresponding field will not be replaced if it is already set.
5238 *
Brett Chabot3e391752009-07-21 16:07:23 -07005239 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
5240 * specified.
5241 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005242 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5243 * and Intent B with {action="gotit", data-type="some/thing",
5244 * categories="one","two"}.
5245 *
5246 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5247 * containing: {action="gotit", data-type="some/thing",
5248 * categories="bar"}.
5249 *
5250 * @param other Another Intent whose values are to be used to fill in
5251 * the current one.
5252 * @param flags Options to control which fields can be filled in.
5253 *
5254 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005255 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5256 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005257 */
5258 public int fillIn(Intent other, int flags) {
5259 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005260 if (other.mAction != null
5261 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262 mAction = other.mAction;
5263 changes |= FILL_IN_ACTION;
5264 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005265 if ((other.mData != null || other.mType != null)
5266 && ((mData == null && mType == null)
5267 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 mData = other.mData;
5269 mType = other.mType;
5270 changes |= FILL_IN_DATA;
5271 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005272 if (other.mCategories != null
5273 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005274 if (other.mCategories != null) {
5275 mCategories = new HashSet<String>(other.mCategories);
5276 }
5277 changes |= FILL_IN_CATEGORIES;
5278 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005279 if (other.mPackage != null
5280 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5281 mPackage = other.mPackage;
5282 changes |= FILL_IN_PACKAGE;
5283 }
5284 // Component is special: it can -only- be set if explicitly allowed,
5285 // since otherwise the sender could force the intent somewhere the
5286 // originator didn't intend.
5287 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005288 mComponent = other.mComponent;
5289 changes |= FILL_IN_COMPONENT;
5290 }
5291 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005292 if (other.mSourceBounds != null
5293 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5294 mSourceBounds = new Rect(other.mSourceBounds);
5295 changes |= FILL_IN_SOURCE_BOUNDS;
5296 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005297 if (mExtras == null) {
5298 if (other.mExtras != null) {
5299 mExtras = new Bundle(other.mExtras);
5300 }
5301 } else if (other.mExtras != null) {
5302 try {
5303 Bundle newb = new Bundle(other.mExtras);
5304 newb.putAll(mExtras);
5305 mExtras = newb;
5306 } catch (RuntimeException e) {
5307 // Modifying the extras can cause us to unparcel the contents
5308 // of the bundle, and if we do this in the system process that
5309 // may fail. We really should handle this (i.e., the Bundle
5310 // impl shouldn't be on top of a plain map), but for now just
5311 // ignore it and keep the original contents. :(
5312 Log.w("Intent", "Failure filling in extras", e);
5313 }
5314 }
5315 return changes;
5316 }
5317
5318 /**
5319 * Wrapper class holding an Intent and implementing comparisons on it for
5320 * the purpose of filtering. The class implements its
5321 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5322 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5323 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5324 * on the wrapped Intent.
5325 */
5326 public static final class FilterComparison {
5327 private final Intent mIntent;
5328 private final int mHashCode;
5329
5330 public FilterComparison(Intent intent) {
5331 mIntent = intent;
5332 mHashCode = intent.filterHashCode();
5333 }
5334
5335 /**
5336 * Return the Intent that this FilterComparison represents.
5337 * @return Returns the Intent held by the FilterComparison. Do
5338 * not modify!
5339 */
5340 public Intent getIntent() {
5341 return mIntent;
5342 }
5343
5344 @Override
5345 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005346 if (obj instanceof FilterComparison) {
5347 Intent other = ((FilterComparison)obj).mIntent;
5348 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005349 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005350 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005351 }
5352
5353 @Override
5354 public int hashCode() {
5355 return mHashCode;
5356 }
5357 }
5358
5359 /**
5360 * Determine if two intents are the same for the purposes of intent
5361 * resolution (filtering). That is, if their action, data, type,
5362 * class, and categories are the same. This does <em>not</em> compare
5363 * any extra data included in the intents.
5364 *
5365 * @param other The other Intent to compare against.
5366 *
5367 * @return Returns true if action, data, type, class, and categories
5368 * are the same.
5369 */
5370 public boolean filterEquals(Intent other) {
5371 if (other == null) {
5372 return false;
5373 }
5374 if (mAction != other.mAction) {
5375 if (mAction != null) {
5376 if (!mAction.equals(other.mAction)) {
5377 return false;
5378 }
5379 } else {
5380 if (!other.mAction.equals(mAction)) {
5381 return false;
5382 }
5383 }
5384 }
5385 if (mData != other.mData) {
5386 if (mData != null) {
5387 if (!mData.equals(other.mData)) {
5388 return false;
5389 }
5390 } else {
5391 if (!other.mData.equals(mData)) {
5392 return false;
5393 }
5394 }
5395 }
5396 if (mType != other.mType) {
5397 if (mType != null) {
5398 if (!mType.equals(other.mType)) {
5399 return false;
5400 }
5401 } else {
5402 if (!other.mType.equals(mType)) {
5403 return false;
5404 }
5405 }
5406 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005407 if (mPackage != other.mPackage) {
5408 if (mPackage != null) {
5409 if (!mPackage.equals(other.mPackage)) {
5410 return false;
5411 }
5412 } else {
5413 if (!other.mPackage.equals(mPackage)) {
5414 return false;
5415 }
5416 }
5417 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005418 if (mComponent != other.mComponent) {
5419 if (mComponent != null) {
5420 if (!mComponent.equals(other.mComponent)) {
5421 return false;
5422 }
5423 } else {
5424 if (!other.mComponent.equals(mComponent)) {
5425 return false;
5426 }
5427 }
5428 }
5429 if (mCategories != other.mCategories) {
5430 if (mCategories != null) {
5431 if (!mCategories.equals(other.mCategories)) {
5432 return false;
5433 }
5434 } else {
5435 if (!other.mCategories.equals(mCategories)) {
5436 return false;
5437 }
5438 }
5439 }
5440
5441 return true;
5442 }
5443
5444 /**
5445 * Generate hash code that matches semantics of filterEquals().
5446 *
5447 * @return Returns the hash value of the action, data, type, class, and
5448 * categories.
5449 *
5450 * @see #filterEquals
5451 */
5452 public int filterHashCode() {
5453 int code = 0;
5454 if (mAction != null) {
5455 code += mAction.hashCode();
5456 }
5457 if (mData != null) {
5458 code += mData.hashCode();
5459 }
5460 if (mType != null) {
5461 code += mType.hashCode();
5462 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005463 if (mPackage != null) {
5464 code += mPackage.hashCode();
5465 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005466 if (mComponent != null) {
5467 code += mComponent.hashCode();
5468 }
5469 if (mCategories != null) {
5470 code += mCategories.hashCode();
5471 }
5472 return code;
5473 }
5474
5475 @Override
5476 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005477 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005478
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005479 b.append("Intent { ");
5480 toShortString(b, true, true);
5481 b.append(" }");
5482
5483 return b.toString();
5484 }
5485
5486 /** @hide */
5487 public String toShortString(boolean comp, boolean extras) {
5488 StringBuilder b = new StringBuilder(128);
5489 toShortString(b, comp, extras);
5490 return b.toString();
5491 }
Romain Guy4969af72009-06-17 10:53:19 -07005492
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005493 /** @hide */
5494 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5495 boolean first = true;
5496 if (mAction != null) {
5497 b.append("act=").append(mAction);
5498 first = false;
5499 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005500 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005501 if (!first) {
5502 b.append(' ');
5503 }
5504 first = false;
5505 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005506 Iterator<String> i = mCategories.iterator();
5507 boolean didone = false;
5508 while (i.hasNext()) {
5509 if (didone) b.append(",");
5510 didone = true;
5511 b.append(i.next());
5512 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005513 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005514 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005515 if (mData != null) {
5516 if (!first) {
5517 b.append(' ');
5518 }
5519 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005520 b.append("dat=");
Wink Savillec491ee02010-10-13 11:40:10 -07005521 String scheme = mData.getScheme();
5522 if (scheme != null) {
5523 if (scheme.equalsIgnoreCase("tel")) {
5524 b.append("tel:xxx-xxx-xxxx");
5525 } else if (scheme.equalsIgnoreCase("smsto")) {
5526 b.append("smsto:xxx-xxx-xxxx");
5527 } else {
5528 b.append(mData);
5529 }
Wink Savillea4288072010-10-12 12:36:38 -07005530 } else {
5531 b.append(mData);
5532 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005533 }
5534 if (mType != null) {
5535 if (!first) {
5536 b.append(' ');
5537 }
5538 first = false;
5539 b.append("typ=").append(mType);
5540 }
5541 if (mFlags != 0) {
5542 if (!first) {
5543 b.append(' ');
5544 }
5545 first = false;
5546 b.append("flg=0x").append(Integer.toHexString(mFlags));
5547 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005548 if (mPackage != null) {
5549 if (!first) {
5550 b.append(' ');
5551 }
5552 first = false;
5553 b.append("pkg=").append(mPackage);
5554 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005555 if (comp && mComponent != null) {
5556 if (!first) {
5557 b.append(' ');
5558 }
5559 first = false;
5560 b.append("cmp=").append(mComponent.flattenToShortString());
5561 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005562 if (mSourceBounds != null) {
5563 if (!first) {
5564 b.append(' ');
5565 }
5566 first = false;
5567 b.append("bnds=").append(mSourceBounds.toShortString());
5568 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005569 if (extras && mExtras != null) {
5570 if (!first) {
5571 b.append(' ');
5572 }
5573 first = false;
5574 b.append("(has extras)");
5575 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005576 }
5577
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005578 /**
5579 * Call {@link #toUri} with 0 flags.
5580 * @deprecated Use {@link #toUri} instead.
5581 */
5582 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005583 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005584 return toUri(0);
5585 }
5586
5587 /**
5588 * Convert this Intent into a String holding a URI representation of it.
5589 * The returned URI string has been properly URI encoded, so it can be
5590 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5591 * Intent's data as the base URI, with an additional fragment describing
5592 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005593 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005594 * <p>You can convert the returned string back to an Intent with
5595 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005596 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005597 * @param flags Additional operating flags. Either 0 or
5598 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005599 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005600 * @return Returns a URI encoding URI string describing the entire contents
5601 * of the Intent.
5602 */
5603 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005604 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005605 String scheme = null;
5606 if (mData != null) {
5607 String data = mData.toString();
5608 if ((flags&URI_INTENT_SCHEME) != 0) {
5609 final int N = data.length();
5610 for (int i=0; i<N; i++) {
5611 char c = data.charAt(i);
5612 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5613 || c == '.' || c == '-') {
5614 continue;
5615 }
5616 if (c == ':' && i > 0) {
5617 // Valid scheme.
5618 scheme = data.substring(0, i);
5619 uri.append("intent:");
5620 data = data.substring(i+1);
5621 break;
5622 }
Tom Taylord4a47292009-12-21 13:59:18 -08005623
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005624 // No scheme.
5625 break;
5626 }
5627 }
5628 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005629
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005630 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5631 uri.append("intent:");
5632 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005633
5634 uri.append("#Intent;");
5635
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005636 if (scheme != null) {
5637 uri.append("scheme=").append(scheme).append(';');
5638 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005639 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005640 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005641 }
5642 if (mCategories != null) {
5643 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005644 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005645 }
5646 }
5647 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005648 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005649 }
5650 if (mFlags != 0) {
5651 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5652 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005653 if (mPackage != null) {
5654 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5655 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005656 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005657 uri.append("component=").append(Uri.encode(
5658 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005659 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005660 if (mSourceBounds != null) {
5661 uri.append("sourceBounds=")
5662 .append(Uri.encode(mSourceBounds.flattenToString()))
5663 .append(';');
5664 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005665 if (mExtras != null) {
5666 for (String key : mExtras.keySet()) {
5667 final Object value = mExtras.get(key);
5668 char entryType =
5669 value instanceof String ? 'S' :
5670 value instanceof Boolean ? 'B' :
5671 value instanceof Byte ? 'b' :
5672 value instanceof Character ? 'c' :
5673 value instanceof Double ? 'd' :
5674 value instanceof Float ? 'f' :
5675 value instanceof Integer ? 'i' :
5676 value instanceof Long ? 'l' :
5677 value instanceof Short ? 's' :
5678 '\0';
5679
5680 if (entryType != '\0') {
5681 uri.append(entryType);
5682 uri.append('.');
5683 uri.append(Uri.encode(key));
5684 uri.append('=');
5685 uri.append(Uri.encode(value.toString()));
5686 uri.append(';');
5687 }
5688 }
5689 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005691 uri.append("end");
5692
5693 return uri.toString();
5694 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005696 public int describeContents() {
5697 return (mExtras != null) ? mExtras.describeContents() : 0;
5698 }
5699
5700 public void writeToParcel(Parcel out, int flags) {
5701 out.writeString(mAction);
5702 Uri.writeToParcel(out, mData);
5703 out.writeString(mType);
5704 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005705 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005706 ComponentName.writeToParcel(mComponent, out);
5707
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005708 if (mSourceBounds != null) {
5709 out.writeInt(1);
5710 mSourceBounds.writeToParcel(out, flags);
5711 } else {
5712 out.writeInt(0);
5713 }
5714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005715 if (mCategories != null) {
5716 out.writeInt(mCategories.size());
5717 for (String category : mCategories) {
5718 out.writeString(category);
5719 }
5720 } else {
5721 out.writeInt(0);
5722 }
5723
5724 out.writeBundle(mExtras);
5725 }
5726
5727 public static final Parcelable.Creator<Intent> CREATOR
5728 = new Parcelable.Creator<Intent>() {
5729 public Intent createFromParcel(Parcel in) {
5730 return new Intent(in);
5731 }
5732 public Intent[] newArray(int size) {
5733 return new Intent[size];
5734 }
5735 };
5736
Dianne Hackborneb034652009-09-07 00:49:58 -07005737 /** @hide */
5738 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005739 readFromParcel(in);
5740 }
5741
5742 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005743 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005744 mData = Uri.CREATOR.createFromParcel(in);
5745 mType = in.readString();
5746 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005747 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005748 mComponent = ComponentName.readFromParcel(in);
5749
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005750 if (in.readInt() != 0) {
5751 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5752 }
5753
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005754 int N = in.readInt();
5755 if (N > 0) {
5756 mCategories = new HashSet<String>();
5757 int i;
5758 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005759 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005760 }
5761 } else {
5762 mCategories = null;
5763 }
5764
5765 mExtras = in.readBundle();
5766 }
5767
5768 /**
5769 * Parses the "intent" element (and its children) from XML and instantiates
5770 * an Intent object. The given XML parser should be located at the tag
5771 * where parsing should start (often named "intent"), from which the
5772 * basic action, data, type, and package and class name will be
5773 * retrieved. The function will then parse in to any child elements,
5774 * looking for <category android:name="xxx"> tags to add categories and
5775 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5776 * to the intent.
5777 *
5778 * @param resources The Resources to use when inflating resources.
5779 * @param parser The XML parser pointing at an "intent" tag.
5780 * @param attrs The AttributeSet interface for retrieving extended
5781 * attribute data at the current <var>parser</var> location.
5782 * @return An Intent object matching the XML data.
5783 * @throws XmlPullParserException If there was an XML parsing error.
5784 * @throws IOException If there was an I/O error.
5785 */
5786 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5787 throws XmlPullParserException, IOException {
5788 Intent intent = new Intent();
5789
5790 TypedArray sa = resources.obtainAttributes(attrs,
5791 com.android.internal.R.styleable.Intent);
5792
5793 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5794
5795 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5796 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5797 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5798
5799 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5800 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5801 if (packageName != null && className != null) {
5802 intent.setComponent(new ComponentName(packageName, className));
5803 }
5804
5805 sa.recycle();
5806
5807 int outerDepth = parser.getDepth();
5808 int type;
5809 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5810 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5811 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5812 continue;
5813 }
5814
5815 String nodeName = parser.getName();
5816 if (nodeName.equals("category")) {
5817 sa = resources.obtainAttributes(attrs,
5818 com.android.internal.R.styleable.IntentCategory);
5819 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5820 sa.recycle();
5821
5822 if (cat != null) {
5823 intent.addCategory(cat);
5824 }
5825 XmlUtils.skipCurrentTag(parser);
5826
5827 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005828 if (intent.mExtras == null) {
5829 intent.mExtras = new Bundle();
5830 }
5831 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5832 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005833
5834 } else {
5835 XmlUtils.skipCurrentTag(parser);
5836 }
5837 }
5838
5839 return intent;
5840 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005841}