blob: b5349fdc95fc1696891f81e89da67a35ab09aa0d [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;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&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 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.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 existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
886 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
887 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900888 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * etc.
890 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * of data, such as a person contact, you set the MIME type to the kind of
893 * data you want and launch it with {@link Context#startActivity(Intent)}.
894 * The system will then launch the best application to select that kind
895 * of data for you.
896 * <p>
897 * You may also be interested in any of a set of types of content the user
898 * can pick. For example, an e-mail application that wants to allow the
899 * user to add an attachment to an e-mail message can use this action to
900 * bring up a list of all of the types of content the user can attach.
901 * <p>
902 * In this case, you should wrap the GET_CONTENT intent with a chooser
903 * (through {@link #createChooser}), which will give the proper interface
904 * for the user to pick how to send your data and allow you to specify
905 * a prompt indicating what they are doing. You will usually specify a
906 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
907 * broad range of content types the user can select from.
908 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * only pick from data that can be represented as a stream. This is
911 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
912 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800913 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900914 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800915 * is locally available on the device. For example, if this extra is set
916 * to true then an image picker should not show any pictures that are available
917 * from a remote server but not already on the local device (thus requiring
918 * they be downloaded when opened).
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * Input: {@link #getType} is the desired MIME type to retrieve. Note
921 * that no URI is supplied in the intent, as there are no constraints on
922 * where the returned data originally comes from. You may also include the
923 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800924 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
925 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * <p>
927 * Output: The URI of the item that was picked. This must be a content:
928 * URI so that any receiver can access it.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
932 /**
933 * Activity Action: Dial a number as specified by the data. This shows a
934 * UI with the number being dialed, allowing the user to explicitly
935 * initiate the call.
936 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
937 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
938 * number.
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_DIAL = "android.intent.action.DIAL";
943 /**
944 * Activity Action: Perform a call to someone specified by the data.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 *
950 * <p>Note: there will be restrictions on which applications can initiate a
951 * call; most applications should use the {@link #ACTION_DIAL}.
952 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
953 * numbers. Applications can <strong>dial</strong> emergency numbers using
954 * {@link #ACTION_DIAL}, however.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_CALL = "android.intent.action.CALL";
958 /**
959 * Activity Action: Perform a call to an emergency number specified by the
960 * data.
961 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
962 * tel: URI of an explicit phone number.
963 * <p>Output: nothing.
964 * @hide
965 */
966 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
967 /**
968 * Activity action: Perform a call to any number (emergency or not)
969 * specified by the data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
976 /**
977 * Activity Action: Send a message to someone specified by the data.
978 * <p>Input: {@link #getData} is URI describing the target.
979 * <p>Output: nothing.
980 */
981 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
982 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
983 /**
984 * Activity Action: Deliver some data to someone else. Who the data is
985 * being delivered to is not specified; it is up to the receiver of this
986 * action to ask the user where the data should be sent.
987 * <p>
988 * When launching a SEND intent, you should usually wrap it in a chooser
989 * (through {@link #createChooser}), which will give the proper interface
990 * for the user to pick how to send your data and allow you to specify
991 * a prompt indicating what they are doing.
992 * <p>
993 * Input: {@link #getType} is the MIME type of the data being sent.
994 * get*Extra can have either a {@link #EXTRA_TEXT}
995 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
996 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
997 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
998 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1000 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1001 * your text with HTML formatting.
1002 * <p>
1003 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1004 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1005 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1006 * content: URIs and other advanced features of {@link ClipData}. If
1007 * using this approach, you still must supply the same data through the
1008 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1009 * for compatibility with old applications. If you don't set a ClipData,
1010 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * <p>
1012 * Optional standard extras, which may be interpreted by some recipients as
1013 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1014 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1015 * <p>
1016 * Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_SEND = "android.intent.action.SEND";
1020 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001021 * Activity Action: Deliver multiple data to someone else.
1022 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001023 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001024 * <p>
1025 * Input: {@link #getType} is the MIME type of the data being sent.
1026 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001027 * #EXTRA_STREAM} field, containing the data to be sent. If using
1028 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1029 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001031 * Multiple types are supported, and receivers should handle mixed types
1032 * whenever possible. The right way for the receiver to check them is to
1033 * use the content resolver on each URI. The intent sender should try to
1034 * put the most concrete mime type in the intent type, but it can fall
1035 * back to {@literal <type>/*} or {@literal *}/* as needed.
1036 * <p>
1037 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1038 * be image/jpg, but if you are sending image/jpg and image/png, then the
1039 * intent's type should be image/*.
1040 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001041 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1042 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1043 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1044 * content: URIs and other advanced features of {@link ClipData}. If
1045 * using this approach, you still must supply the same data through the
1046 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1047 * for compatibility with old applications. If you don't set a ClipData,
1048 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1049 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * Optional standard extras, which may be interpreted by some recipients as
1051 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1052 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1053 * <p>
1054 * Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Handle an incoming phone call.
1060 * <p>Input: nothing.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1065 /**
1066 * Activity Action: Insert an empty item into the given container.
1067 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1068 * in which to place the data.
1069 * <p>Output: URI of the new data that was created.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1073 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001074 * Activity Action: Create a new item in the given container, initializing it
1075 * from the current contents of the clipboard.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001083 * Activity Action: Delete the given data from its container.
1084 * <p>Input: {@link #getData} is URI of data to be deleted.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1089 /**
1090 * Activity Action: Run the data, whatever that means.
1091 * <p>Input: ? (Note: this is currently specific to the test harness.)
1092 * <p>Output: nothing.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_RUN = "android.intent.action.RUN";
1096 /**
1097 * Activity Action: Perform a data synchronization.
1098 * <p>Input: ?
1099 * <p>Output: ?
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1103 /**
1104 * Activity Action: Pick an activity given an intent, returning the class
1105 * selected.
1106 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1107 * used with {@link PackageManager#queryIntentActivities} to determine the
1108 * set of activities from which to pick.
1109 * <p>Output: Class name of the activity that was selected.
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1113 /**
1114 * Activity Action: Perform a search.
1115 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1116 * is the text to search for. If empty, simply
1117 * enter your search results Activity with the search UI activated.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1122 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001123 * Activity Action: Start the platform-defined tutorial
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001133 * <p>
1134 * Input: {@link android.app.SearchManager#QUERY
1135 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1136 * a url starts with http or https, the site will be opened. If it is plain
1137 * text, Google search will be applied.
1138 * <p>
1139 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1143 /**
Jim Miller07994402012-05-02 14:22:27 -07001144 * Activity Action: Perform assist action.
1145 * <p>
1146 * Input: nothing
1147 * Output: nothing.
1148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * Activity Action: List all available applications
1153 * <p>Input: Nothing.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1158 /**
1159 * Activity Action: Show settings for choosing wallpaper
1160 * <p>Input: Nothing.
1161 * <p>Output: Nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1165
1166 /**
1167 * Activity Action: Show activity for reporting a bug.
1168 * <p>Input: Nothing.
1169 * <p>Output: Nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1173
1174 /**
1175 * Activity Action: Main entry point for factory tests. Only used when
1176 * the device is booting in factory test node. The implementing package
1177 * must be installed in the system image.
1178 * <p>Input: nothing
1179 * <p>Output: nothing
1180 */
1181 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1182
1183 /**
1184 * Activity Action: The user pressed the "call" button to go to the dialer
1185 * or other appropriate UI for placing a call.
1186 * <p>Input: Nothing.
1187 * <p>Output: Nothing.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1191
1192 /**
1193 * Activity Action: Start Voice Command.
1194 * <p>Input: Nothing.
1195 * <p>Output: Nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001199
1200 /**
1201 * Activity Action: Start action associated with long pressing on the
1202 * search key.
1203 * <p>Input: Nothing.
1204 * <p>Output: Nothing.
1205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001208
Jacek Surazski86b6c532009-05-13 14:38:28 +02001209 /**
1210 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1211 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001212 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001213 * <p>Input: No data is specified. The bug report is passed in using
1214 * an {@link #EXTRA_BUG_REPORT} field.
1215 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001216 *
1217 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001221
1222 /**
1223 * Activity Action: Show power usage information to the user.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001229
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001230 /**
1231 * Activity Action: Setup wizard to launch after a platform update. This
1232 * activity should have a string meta-data field associated with it,
1233 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1234 * the platform for setup. The activity will be launched only if
1235 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1236 * same value.
1237 * <p>Input: Nothing.
1238 * <p>Output: Nothing.
1239 * @hide
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001243
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001244 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001245 * Activity Action: Show settings for managing network data usage of a
1246 * specific application. Applications should define an activity that offers
1247 * options to control data usage.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_MANAGE_NETWORK_USAGE =
1251 "android.intent.action.MANAGE_NETWORK_USAGE";
1252
1253 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 * Activity Action: Launch application installer.
1255 * <p>
1256 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001257 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1258 * you can also use "package:<package-name>" to install an application for the
1259 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001260 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1261 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1262 * <p>
1263 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1264 * succeeded.
1265 *
1266 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1267 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1268 * @see #EXTRA_RETURN_RESULT
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1272
1273 /**
1274 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1275 * package. Specifies the installer package name; this package will receive the
1276 * {@link #ACTION_APP_ERROR} intent.
1277 */
1278 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1279 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1280
1281 /**
1282 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1283 * package. Specifies that the application being installed should not be
1284 * treated as coming from an unknown source, but as coming from the app
1285 * invoking the Intent. For this to work you must start the installer with
1286 * startActivityForResult().
1287 */
1288 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1289 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1290
1291 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001292 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1293 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001294 * data field originated from.
1295 */
rich cannings706e8ba2012-08-20 13:20:14 -07001296 public static final String EXTRA_ORIGINATING_URI
1297 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001298
1299 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001300 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1301 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1302 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001303 */
1304 public static final String EXTRA_REFERRER
1305 = "android.intent.extra.REFERRER";
1306
1307 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001308 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1309 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1310 * @hide
1311 */
1312 public static final String EXTRA_ORIGINATING_UID
1313 = "android.intent.extra.ORIGINATING_UID";
1314
1315 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001316 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1317 * package. Tells the installer UI to skip the confirmation with the user
1318 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001319 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1320 * will no longer show an interstitial message about updating existing
1321 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001322 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001323 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001324 public static final String EXTRA_ALLOW_REPLACE
1325 = "android.intent.extra.ALLOW_REPLACE";
1326
1327 /**
1328 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1329 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1330 * return to the application the result code of the install/uninstall. The returned result
1331 * code will be {@link android.app.Activity#RESULT_OK} on success or
1332 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1333 */
1334 public static final String EXTRA_RETURN_RESULT
1335 = "android.intent.extra.RETURN_RESULT";
1336
1337 /**
1338 * Package manager install result code. @hide because result codes are not
1339 * yet ready to be exposed.
1340 */
1341 public static final String EXTRA_INSTALL_RESULT
1342 = "android.intent.extra.INSTALL_RESULT";
1343
1344 /**
1345 * Activity Action: Launch application uninstaller.
1346 * <p>
1347 * Input: The data must be a package: URI whose scheme specific part is
1348 * the package name of the current installed package to be uninstalled.
1349 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1350 * <p>
1351 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1352 * succeeded.
1353 */
1354 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1355 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1356
1357 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001358 * Specify whether the package should be uninstalled for all users.
1359 * @hide because these should not be part of normal application flow.
1360 */
1361 public static final String EXTRA_UNINSTALL_ALL_USERS
1362 = "android.intent.extra.UNINSTALL_ALL_USERS";
1363
1364 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001365 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1366 * describing the last run version of the platform that was setup.
1367 * @hide
1368 */
1369 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1370
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001371 // ---------------------------------------------------------------------
1372 // ---------------------------------------------------------------------
1373 // Standard intent broadcast actions (see action variable).
1374
1375 /**
1376 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 * <p class="note">This is a protected intent that can only be sent
1379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 */
1381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1382 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1383 /**
1384 * Broadcast Action: Sent after the screen turns on.
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_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001391
1392 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001393 * Broadcast Action: Sent after the system stops dreaming.
1394 *
1395 * <p class="note">This is a protected intent that can only be sent by the system.
1396 * It is only sent to registered receivers.</p>
1397 */
1398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1399 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1400
1401 /**
1402 * Broadcast Action: Sent after the system starts dreaming.
1403 *
1404 * <p class="note">This is a protected intent that can only be sent by the system.
1405 * It is only sent to registered receivers.</p>
1406 */
1407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1408 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1409
1410 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001411 * 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 -07001412 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001413 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001414 * <p class="note">This is a protected intent that can only be sent
1415 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001416 */
1417 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001418 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001420 /**
1421 * Broadcast Action: The current time has changed. Sent every
1422 * minute. You can <em>not</em> receive this through components declared
1423 * in manifests, only by exlicitly registering for it with
1424 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1425 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001426 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001427 * <p class="note">This is a protected intent that can only be sent
1428 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1432 /**
1433 * Broadcast Action: The time was set.
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1437 /**
1438 * Broadcast Action: The date has changed.
1439 */
1440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1441 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1442 /**
1443 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1444 * <ul>
1445 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1446 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001447 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001448 * <p class="note">This is a protected intent that can only be sent
1449 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1453 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001454 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1455 * DNS entries should be tossed.
1456 * @hide
1457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1460 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001461 * Alarm Changed Action: This is broadcast when the AlarmClock
1462 * application's alarm is set or unset. It is used by the
1463 * AlarmClock application and the StatusBar service.
1464 * @hide
1465 */
1466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1467 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1468 /**
1469 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1470 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1471 * @hide
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_SYNC_STATE_CHANGED
1475 = "android.intent.action.SYNC_STATE_CHANGED";
1476 /**
1477 * Broadcast Action: This is broadcast once, after the system has finished
1478 * booting. It can be used to perform application-specific initialization,
1479 * such as installing alarms. You must hold the
1480 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1481 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001483 * <p class="note">This is a protected intent that can only be sent
1484 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 */
1486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1487 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1488 /**
1489 * Broadcast Action: This is broadcast when a user action should request a
1490 * temporary system dialog to dismiss. Some examples of temporary system
1491 * dialogs are the notification window-shade and the recent tasks dialog.
1492 */
1493 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1494 /**
1495 * Broadcast Action: Trigger the download and eventual installation
1496 * of a package.
1497 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001498 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001499 * <p class="note">This is a protected intent that can only be sent
1500 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001501 *
1502 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001503 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001504 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1507 /**
1508 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001509 * device. The data contains the name of the package. Note that the
1510 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001511 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 * <ul>
1513 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1514 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1515 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1516 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001517 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001518 * <p class="note">This is a protected intent that can only be sent
1519 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001520 */
1521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1522 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1523 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001524 * Broadcast Action: A new version of an application package has been
1525 * installed, replacing an existing version that was previously installed.
1526 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001527 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001528 * <ul>
1529 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1530 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001531 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001532 * <p class="note">This is a protected intent that can only be sent
1533 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001534 */
1535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1536 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1537 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001538 * Broadcast Action: A new version of your application has been installed
1539 * over an existing one. This is only sent to the application that was
1540 * replaced. It does not contain any additional data; to receive it, just
1541 * use an intent filter for this action.
1542 *
1543 * <p class="note">This is a protected intent that can only be sent
1544 * by the system.
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001549 * Broadcast Action: An existing application package has been removed from
1550 * the device. The data contains the name of the package. The package
1551 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 * <ul>
1553 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1554 * to the package.
1555 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1556 * application -- data and code -- is being removed.
1557 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1558 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1559 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001560 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001561 * <p class="note">This is a protected intent that can only be sent
1562 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1566 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001567 * Broadcast Action: An existing application package has been completely
1568 * removed from the device. The data contains the name of the package.
1569 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1570 * {@link #EXTRA_DATA_REMOVED} is true and
1571 * {@link #EXTRA_REPLACING} is false of that broadcast.
1572 *
1573 * <ul>
1574 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1575 * to the package.
1576 * </ul>
1577 *
1578 * <p class="note">This is a protected intent that can only be sent
1579 * by the system.
1580 */
1581 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1582 public static final String ACTION_PACKAGE_FULLY_REMOVED
1583 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1584 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001585 * Broadcast Action: An existing application package has been changed (e.g.
1586 * a component has been enabled or disabled). The data contains the name of
1587 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001588 * <ul>
1589 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001590 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001591 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001592 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1593 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001595 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001596 * <p class="note">This is a protected intent that can only be sent
1597 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001598 */
1599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1601 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001602 * @hide
1603 * Broadcast Action: Ask system services if there is any reason to
1604 * restart the given package. The data contains the name of the
1605 * package.
1606 * <ul>
1607 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1608 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1609 * </ul>
1610 *
1611 * <p class="note">This is a protected intent that can only be sent
1612 * by the system.
1613 */
1614 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1615 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1616 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 * Broadcast Action: The user has restarted a package, and all of its
1618 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001619 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001620 * be removed. Note that the restarted package does <em>not</em>
1621 * receive this broadcast.
1622 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001623 * <ul>
1624 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1625 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001626 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001627 * <p class="note">This is a protected intent that can only be sent
1628 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1632 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * Broadcast Action: The user has cleared the data of a package. This should
1634 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001635 * its persistent data is erased and this broadcast sent.
1636 * Note that the cleared package does <em>not</em>
1637 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 * <ul>
1639 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1640 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001641 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001642 * <p class="note">This is a protected intent that can only be sent
1643 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001644 */
1645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1646 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1647 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 * Broadcast Action: A user ID has been removed from the system. The user
1649 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001650 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001651 * <p class="note">This is a protected intent that can only be sent
1652 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001653 */
1654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001656
1657 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001658 * Broadcast Action: Sent to the installer package of an application
1659 * when that application is first launched (that is the first time it
1660 * is moved out of the stopped state). The data contains the name of the package.
1661 *
1662 * <p class="note">This is a protected intent that can only be sent
1663 * by the system.
1664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1667
1668 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001669 * Broadcast Action: Sent to the system package verifier when a package
1670 * needs to be verified. The data contains the package URI.
1671 * <p class="note">
1672 * This is a protected intent that can only be sent by the system.
1673 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1677
1678 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001679 * Broadcast Action: Sent to the system package verifier when a package is
1680 * verified. The data contains the package URI.
1681 * <p class="note">
1682 * This is a protected intent that can only be sent by the system.
1683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1686
1687 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001688 * Broadcast Action: Resources for a set of packages (which were
1689 * previously unavailable) are currently
1690 * available since the media on which they exist is available.
1691 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1692 * list of packages whose availability changed.
1693 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1694 * list of uids of packages whose availability changed.
1695 * Note that the
1696 * packages in this list do <em>not</em> receive this broadcast.
1697 * The specified set of packages are now available on the system.
1698 * <p>Includes the following extras:
1699 * <ul>
1700 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1701 * whose resources(were previously unavailable) are currently available.
1702 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1703 * packages whose resources(were previously unavailable)
1704 * are currently available.
1705 * </ul>
1706 *
1707 * <p class="note">This is a protected intent that can only be sent
1708 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001709 */
1710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001711 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1712 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001713
1714 /**
1715 * Broadcast Action: Resources for a set of packages are currently
1716 * unavailable since the media on which they exist is unavailable.
1717 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1718 * list of packages whose availability changed.
1719 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1720 * list of uids of packages whose availability changed.
1721 * The specified set of packages can no longer be
1722 * launched and are practically unavailable on the system.
1723 * <p>Inclues the following extras:
1724 * <ul>
1725 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1726 * whose resources are no longer available.
1727 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1728 * whose resources are no longer available.
1729 * </ul>
1730 *
1731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001735 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001736 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001738 /**
1739 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001740 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001741 * This should <em>only</em> be used to determine when the wallpaper
1742 * has changed to show the new wallpaper to the user. You should certainly
1743 * never, in response to this, change the wallpaper or other attributes of
1744 * it such as the suggested size. That would be crazy, right? You'd cause
1745 * all kinds of loops, especially if other apps are doing similar things,
1746 * right? Of course. So please don't do this.
1747 *
1748 * @deprecated Modern applications should use
1749 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1750 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1751 * shown behind their UI, rather than watching for this broadcast and
1752 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001753 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001754 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001755 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1756 /**
1757 * Broadcast Action: The current device {@link android.content.res.Configuration}
1758 * (orientation, locale, etc) has changed. When such a change happens, the
1759 * UIs (view hierarchy) will need to be rebuilt based on this new
1760 * information; for the most part, applications don't need to worry about
1761 * this, because the system will take care of stopping and restarting the
1762 * application to make sure it sees the new changes. Some system code that
1763 * can not be restarted will need to watch for this action and handle it
1764 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001765 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001766 * <p class="note">
1767 * You can <em>not</em> receive this through components declared
1768 * in manifests, only by explicitly registering for it with
1769 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1770 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001771 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001772 * <p class="note">This is a protected intent that can only be sent
1773 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774 *
1775 * @see android.content.res.Configuration
1776 */
1777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1778 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1779 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001780 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001781 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001782 * <p class="note">This is a protected intent that can only be sent
1783 * by the system.
1784 */
1785 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1786 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1787 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001788 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1789 * charging state, level, and other information about the battery.
1790 * See {@link android.os.BatteryManager} for documentation on the
1791 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001792 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 * <p class="note">
1794 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001795 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001796 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001797 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1798 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1799 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1800 * broadcasts that are sent and can be received through manifest
1801 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001802 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001803 * <p class="note">This is a protected intent that can only be sent
1804 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001805 */
1806 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1807 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1808 /**
1809 * Broadcast Action: Indicates low battery condition on the device.
1810 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1817 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001818 * Broadcast Action: Indicates the battery is now okay after being low.
1819 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1820 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001821 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1827 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001828 * Broadcast Action: External power has been connected to the device.
1829 * This is intended for applications that wish to register specifically to this notification.
1830 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1831 * stay active to receive this notification. This action can be used to implement actions
1832 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001833 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001838 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001839 /**
1840 * Broadcast Action: External power has been removed from the device.
1841 * This is intended for applications that wish to register specifically to this notification.
1842 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1843 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001844 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001846 * <p class="note">This is a protected intent that can only be sent
1847 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001850 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001851 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001852 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001853 * Broadcast Action: Device is shutting down.
1854 * This is broadcast when the device is being shut down (completely turned
1855 * off, not sleeping). Once the broadcast is complete, the final shutdown
1856 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001857 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001863 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001864 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001865 * Activity Action: Start this activity to request system shutdown.
1866 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1867 * to request confirmation from the user before shutting down.
1868 *
1869 * <p class="note">This is a protected intent that can only be sent
1870 * by the system.
1871 *
1872 * {@hide}
1873 */
1874 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1875 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001876 * Broadcast Action: A sticky broadcast that indicates low memory
1877 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001878 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001879 * <p class="note">This is a protected intent that can only be sent
1880 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1884 /**
1885 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001886 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001887 * <p class="note">This is a protected intent that can only be sent
1888 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001889 */
1890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1891 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1892 /**
Jake Hambybb371632010-08-23 18:16:48 -07001893 * Broadcast Action: A sticky broadcast that indicates a memory full
1894 * condition on the device. This is intended for activities that want
1895 * to be able to fill the data partition completely, leaving only
1896 * enough free space to prevent system-wide SQLite failures.
1897 *
1898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
1900 *
1901 * {@hide}
1902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1904 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1905 /**
1906 * Broadcast Action: Indicates memory full condition on the device
1907 * no longer exists.
1908 *
1909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
1911 *
1912 * {@hide}
1913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001917 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1918 * and package management should be started.
1919 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1920 * notification.
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1924 /**
1925 * Broadcast Action: The device has entered USB Mass Storage mode.
1926 * This is used mainly for the USB Settings panel.
1927 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1928 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001929 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001931 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1933
1934 /**
1935 * Broadcast Action: The device has exited USB Mass Storage mode.
1936 * This is used mainly for the USB Settings panel.
1937 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1938 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001939 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001940 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001941 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1943
1944 /**
1945 * Broadcast Action: External media has been removed.
1946 * The path to the mount point for the removed media is contained in the Intent.mData field.
1947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1950
1951 /**
1952 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001953 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1957
1958 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001959 * Broadcast Action: External media is present, and being disk-checked
1960 * 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 -08001961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1964
1965 /**
1966 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1967 * 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 -08001968 */
1969 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1970 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1971
1972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001974 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1976 * media was mounted read only.
1977 */
1978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1980
1981 /**
1982 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001983 * 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 -07001984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1987
1988 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001989 * Broadcast Action: External media is no longer being shared via USB mass storage.
1990 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1991 *
1992 * @hide
1993 */
1994 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1995
1996 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1998 * The path to the mount point for the removed media is contained in the Intent.mData field.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2002
2003 /**
2004 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002005 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2009
2010 /**
2011 * Broadcast Action: User has expressed the desire to remove the external storage media.
2012 * Applications should close all files they have open within the mount point when they receive this intent.
2013 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2014 */
2015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2017
2018 /**
2019 * Broadcast Action: The media scanner has started scanning a directory.
2020 * The path to the directory being scanned is contained in the Intent.mData field.
2021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2024
2025 /**
2026 * Broadcast Action: The media scanner has finished scanning a directory.
2027 * The path to the scanned directory is contained in the Intent.mData field.
2028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2031
2032 /**
2033 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2034 * The path to the file is contained in the Intent.mData field.
2035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2038
2039 /**
2040 * Broadcast Action: The "Media Button" was pressed. Includes a single
2041 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2042 * caused the broadcast.
2043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2046
2047 /**
2048 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2049 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2050 * caused the broadcast.
2051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2054
2055 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2056 // location; they are not general-purpose actions.
2057
2058 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002059 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2063 "android.intent.action.GTALK_CONNECTED";
2064
2065 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002066 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2070 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002071
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002072 /**
2073 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_INPUT_METHOD_CHANGED =
2077 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078
2079 /**
2080 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2081 * more radios have been turned off or on. The intent will have the following extra value:</p>
2082 * <ul>
2083 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2084 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2085 * turned off</li>
2086 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002087 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002088 * <p class="note">This is a protected intent that can only be sent
2089 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2093
2094 /**
2095 * Broadcast Action: Some content providers have parts of their namespace
2096 * where they publish new events or items that the user may be especially
2097 * interested in. For these things, they may broadcast this action when the
2098 * set of interesting items change.
2099 *
2100 * For example, GmailProvider sends this notification when the set of unread
2101 * mail in the inbox changes.
2102 *
2103 * <p>The data of the intent identifies which part of which provider
2104 * changed. When queried through the content resolver, the data URI will
2105 * return the data set in question.
2106 *
2107 * <p>The intent will have the following extra values:
2108 * <ul>
2109 * <li><em>count</em> - The number of items in the data set. This is the
2110 * same as the number of items in the cursor returned by querying the
2111 * data URI. </li>
2112 * </ul>
2113 *
2114 * This intent will be sent at boot (if the count is non-zero) and when the
2115 * data set changes. It is possible for the data set to change without the
2116 * count changing (for example, if a new unread message arrives in the same
2117 * sync operation in which a message is archived). The phone should still
2118 * ring/vibrate/etc as normal in this case.
2119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_PROVIDER_CHANGED =
2122 "android.intent.action.PROVIDER_CHANGED";
2123
2124 /**
2125 * Broadcast Action: Wired Headset plugged in or unplugged.
2126 *
2127 * <p>The intent will have the following extra values:
2128 * <ul>
2129 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2130 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002131 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 * </ul>
2133 * </ul>
2134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_HEADSET_PLUG =
2137 "android.intent.action.HEADSET_PLUG";
2138
2139 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002140 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2141 *
2142 * <p>The intent will have the following extra values:
2143 * <ul>
2144 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2145 * <li><em>name</em> - Headset type, human readable string </li>
2146 * </ul>
2147 * </ul>
2148 * @hide
2149 */
2150 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002151 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2152 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002153
2154 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002155 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002156 *
2157 * <p>The intent will have the following extra values:
2158 * <ul>
2159 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2160 * <li><em>name</em> - Headset type, human readable string </li>
2161 * </ul>
2162 * </ul>
2163 * @hide
2164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002166 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2167 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002168
2169 /**
2170 * Broadcast Action: A HMDI cable was plugged or unplugged
2171 *
2172 * <p>The intent will have the following extra values:
2173 * <ul>
2174 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2175 * <li><em>name</em> - HDMI cable, human readable string </li>
2176 * </ul>
2177 * </ul>
2178 * @hide
2179 */
2180 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2181 public static final String ACTION_HDMI_AUDIO_PLUG =
2182 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002183
2184 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002185 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2186 *
2187 * <p>The intent will have the following extra values:
2188 * <ul>
2189 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2190 * <li><em>card</em> - ALSA card number (integer) </li>
2191 * <li><em>device</em> - ALSA device number (integer) </li>
2192 * </ul>
2193 * </ul>
2194 * @hide
2195 */
2196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2197 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2198 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2199
2200 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002201 * Broadcast Action: A USB audio device was plugged in or unplugged.
2202 *
2203 * <p>The intent will have the following extra values:
2204 * <ul>
2205 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2206 * <li><em>card</em> - ALSA card number (integer) </li>
2207 * <li><em>device</em> - ALSA device number (integer) </li>
2208 * </ul>
2209 * </ul>
2210 * @hide
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2214 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2215
2216 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002217 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2218 * <ul>
2219 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2220 * </ul>
2221 *
2222 * <p class="note">This is a protected intent that can only be sent
2223 * by the system.
2224 *
2225 * @hide
2226 */
2227 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2228 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2229 = "android.intent.action.ADVANCED_SETTINGS";
2230
2231 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002232 * Broadcast Action: An outgoing call is about to be placed.
2233 *
2234 * <p>The Intent will have the following extra value:
2235 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002236 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002237 * the phone number originally intended to be dialed.</li>
2238 * </ul>
2239 * <p>Once the broadcast is finished, the resultData is used as the actual
2240 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002241 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002242 * outgoing call in turn: for example, a parental control application
2243 * might verify that the user is authorized to place the call at that
2244 * time, then a number-rewriting application might add an area code if
2245 * one was not specified.</p>
2246 * <p>For consistency, any receiver whose purpose is to prohibit phone
2247 * calls should have a priority of 0, to ensure it will see the final
2248 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002249 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002250 * should have a positive priority.
2251 * Negative priorities are reserved for the system for this broadcast;
2252 * using them may cause problems.</p>
2253 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2254 * abort the broadcast.</p>
2255 * <p>Emergency calls cannot be intercepted using this mechanism, and
2256 * other calls cannot be modified to call emergency numbers using this
2257 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002258 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002259 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2260 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002261 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002262 * <p class="note">This is a protected intent that can only be sent
2263 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_NEW_OUTGOING_CALL =
2267 "android.intent.action.NEW_OUTGOING_CALL";
2268
2269 /**
2270 * Broadcast Action: Have the device reboot. This is only for use by
2271 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002272 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002273 * <p class="note">This is a protected intent that can only be sent
2274 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 */
2276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_REBOOT =
2278 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002279
Wei Huang97ecc9c2009-05-11 17:44:20 -07002280 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002281 * Broadcast Action: A sticky broadcast for changes in the physical
2282 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002283 *
2284 * <p>The intent will have the following extra values:
2285 * <ul>
2286 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002287 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002288 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002289 * <p>This is intended for monitoring the current physical dock state.
2290 * See {@link android.app.UiModeManager} for the normal API dealing with
2291 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002292 */
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_DOCK_EVENT =
2295 "android.intent.action.DOCK_EVENT";
2296
2297 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002298 * Broadcast Action: a remote intent is to be broadcasted.
2299 *
2300 * A remote intent is used for remote RPC between devices. The remote intent
2301 * is serialized and sent from one device to another device. The receiving
2302 * device parses the remote intent and broadcasts it. Note that anyone can
2303 * broadcast a remote intent. However, if the intent receiver of the remote intent
2304 * does not trust intent broadcasts from arbitrary intent senders, it should require
2305 * the sender to hold certain permissions so only trusted sender's broadcast will be
2306 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002307 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002308 */
2309 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002310 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002311
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002312 /**
2313 * Broadcast Action: hook for permforming cleanup after a system update.
2314 *
2315 * The broadcast is sent when the system is booting, before the
2316 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2317 * image. A receiver for this should do its work and then disable itself
2318 * so that it does not get run again at the next boot.
2319 * @hide
2320 */
2321 public static final String ACTION_PRE_BOOT_COMPLETED =
2322 "android.intent.action.PRE_BOOT_COMPLETED";
2323
Amith Yamasani13593602012-03-22 16:16:17 -07002324 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002325 * Sent the first time a user is starting, to allow system apps to
2326 * perform one time initialization. (This will not be seen by third
2327 * party applications because a newly initialized user does not have any
2328 * third party applications installed for it.) This is sent early in
2329 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002330 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2331 * broadcast, since it is part of a visible user interaction; be as quick
2332 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002333 */
2334 public static final String ACTION_USER_INITIALIZE =
2335 "android.intent.action.USER_INITIALIZE";
2336
2337 /**
2338 * Sent when a user switch is happening, causing the process's user to be
2339 * brought to the foreground. This is only sent to receivers registered
2340 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2341 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002342 * foreground. This is sent as a foreground
2343 * broadcast, since it is part of a visible user interaction; be as quick
2344 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002345 */
2346 public static final String ACTION_USER_FOREGROUND =
2347 "android.intent.action.USER_FOREGROUND";
2348
2349 /**
2350 * Sent when a user switch is happening, causing the process's user to be
2351 * sent to the background. This is only sent to receivers registered
2352 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2353 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002354 * background. This is sent as a foreground
2355 * broadcast, since it is part of a visible user interaction; be as quick
2356 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002357 */
2358 public static final String ACTION_USER_BACKGROUND =
2359 "android.intent.action.USER_BACKGROUND";
2360
2361 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002362 * Broadcast sent to the system when a user is added. Carries an extra
2363 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2364 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002365 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002366 * @hide
2367 */
2368 public static final String ACTION_USER_ADDED =
2369 "android.intent.action.USER_ADDED";
2370
2371 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002372 * Broadcast sent by the system when a user is started. Carries an extra
2373 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002374 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002375 * that has been started. This is sent as a foreground
2376 * broadcast, since it is part of a visible user interaction; be as quick
2377 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002378 * @hide
2379 */
2380 public static final String ACTION_USER_STARTED =
2381 "android.intent.action.USER_STARTED";
2382
2383 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002384 * Broadcast sent when a user is in the process of starting. Carries an extra
2385 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2386 * sent to registered receivers, not manifest receivers. It is sent to all
2387 * users (including the one that is being started). You must hold
2388 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2389 * this broadcast. This is sent as a background broadcast, since
2390 * its result is not part of the primary UX flow; to safely keep track of
2391 * started/stopped state of a user you can use this in conjunction with
2392 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2393 * other user state broadcasts since those are foreground broadcasts so can
2394 * execute in a different order.
2395 * @hide
2396 */
2397 public static final String ACTION_USER_STARTING =
2398 "android.intent.action.USER_STARTING";
2399
2400 /**
2401 * Broadcast sent when a user is going to be stopped. Carries an extra
2402 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2403 * sent to registered receivers, not manifest receivers. It is sent to all
2404 * users (including the one that is being stopped). You must hold
2405 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2406 * this broadcast. The user will not stop until all receivers have
2407 * handled the broadcast. This is sent as a background broadcast, since
2408 * its result is not part of the primary UX flow; to safely keep track of
2409 * started/stopped state of a user you can use this in conjunction with
2410 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2411 * other user state broadcasts since those are foreground broadcasts so can
2412 * execute in a different order.
2413 * @hide
2414 */
2415 public static final String ACTION_USER_STOPPING =
2416 "android.intent.action.USER_STOPPING";
2417
2418 /**
2419 * Broadcast sent to the system when a user is stopped. Carries an extra
2420 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2421 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2422 * specific package. This is only sent to registered receivers, not manifest
2423 * receivers. It is sent to all running users <em>except</em> the one that
2424 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002425 * @hide
2426 */
2427 public static final String ACTION_USER_STOPPED =
2428 "android.intent.action.USER_STOPPED";
2429
2430 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002431 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002432 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002433 * one that has been removed. The user will not be completely removed until all receivers have
2434 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002435 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002436 * @hide
2437 */
2438 public static final String ACTION_USER_REMOVED =
2439 "android.intent.action.USER_REMOVED";
2440
2441 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002442 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002443 * the userHandle of the user to become the current one. This is only sent to
2444 * registered receivers, not manifest receivers. It is sent to all running users.
2445 * You must hold
2446 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002447 * @hide
2448 */
2449 public static final String ACTION_USER_SWITCHED =
2450 "android.intent.action.USER_SWITCHED";
2451
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002452 /**
2453 * Broadcast sent to the system when a user's information changes. Carries an extra
2454 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2455 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2456 * whose information has changed.
2457 * @hide
2458 */
2459 public static final String ACTION_USER_INFO_CHANGED =
2460 "android.intent.action.USER_INFO_CHANGED";
2461
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002462 /**
2463 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2464 */
2465 public static final String ACTION_QUICK_CLOCK =
2466 "android.intent.action.QUICK_CLOCK";
2467
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002468 // ---------------------------------------------------------------------
2469 // ---------------------------------------------------------------------
2470 // Standard intent categories (see addCategory()).
2471
2472 /**
2473 * Set if the activity should be an option for the default action
2474 * (center press) to perform on a piece of data. Setting this will
2475 * hide from the user any activities without it set when performing an
2476 * action on some data. Note that this is normal -not- set in the
2477 * Intent when initiating an action -- it is for use in intent filters
2478 * specified in packages.
2479 */
2480 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2481 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2482 /**
2483 * Activities that can be safely invoked from a browser must support this
2484 * category. For example, if the user is viewing a web page or an e-mail
2485 * and clicks on a link in the text, the Intent generated execute that
2486 * link will require the BROWSABLE category, so that only activities
2487 * supporting this category will be considered as possible actions. By
2488 * supporting this category, you are promising that there is nothing
2489 * damaging (without user intervention) that can happen by invoking any
2490 * matching Intent.
2491 */
2492 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2493 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2494 /**
2495 * Set if the activity should be considered as an alternative action to
2496 * the data the user is currently viewing. See also
2497 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2498 * applies to the selection in a list of items.
2499 *
2500 * <p>Supporting this category means that you would like your activity to be
2501 * displayed in the set of alternative things the user can do, usually as
2502 * part of the current activity's options menu. You will usually want to
2503 * include a specific label in the &lt;intent-filter&gt; of this action
2504 * describing to the user what it does.
2505 *
2506 * <p>The action of IntentFilter with this category is important in that it
2507 * describes the specific action the target will perform. This generally
2508 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2509 * a specific name such as "com.android.camera.action.CROP. Only one
2510 * alternative of any particular action will be shown to the user, so using
2511 * a specific action like this makes sure that your alternative will be
2512 * displayed while also allowing other applications to provide their own
2513 * overrides of that particular action.
2514 */
2515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2516 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2517 /**
2518 * Set if the activity should be considered as an alternative selection
2519 * action to the data the user has currently selected. This is like
2520 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2521 * of items from which the user can select, giving them alternatives to the
2522 * default action that will be performed on it.
2523 */
2524 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2525 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2526 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002527 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002528 */
2529 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2530 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2531 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002532 * Should be displayed in the top-level launcher.
2533 */
2534 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2535 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2536 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002537 * Provides information about the package it is in; typically used if
2538 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2539 * a front-door to the user without having to be shown in the all apps list.
2540 */
2541 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2542 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2543 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002544 * This is the home activity, that is the first activity that is displayed
2545 * when the device boots.
2546 */
2547 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2548 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2549 /**
2550 * This activity is a preference panel.
2551 */
2552 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2553 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2554 /**
2555 * This activity is a development preference panel.
2556 */
2557 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2558 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2559 /**
2560 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002561 */
2562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2563 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2564 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002565 * This activity allows the user to browse and download new applications.
2566 */
2567 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2568 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002570 * This activity may be exercised by the monkey or other automated test tools.
2571 */
2572 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2573 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2574 /**
2575 * To be used as a test (not part of the normal user experience).
2576 */
2577 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2578 /**
2579 * To be used as a unit test (run through the Test Harness).
2580 */
2581 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2582 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002583 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002584 * experience).
2585 */
2586 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2587 /**
2588 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2589 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2590 * when queried, though it is allowable for those columns to be blank.
2591 */
2592 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2593 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2594
2595 /**
2596 * To be used as code under test for framework instrumentation tests.
2597 */
2598 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2599 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002600 /**
2601 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002602 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2603 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002604 */
2605 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2606 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2607 /**
2608 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002609 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2610 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002611 */
2612 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2613 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002614 /**
2615 * An activity to run when device is inserted into a analog (low end) dock.
2616 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2617 * information, see {@link android.app.UiModeManager}.
2618 */
2619 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2620 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2621
2622 /**
2623 * An activity to run when device is inserted into a digital (high end) dock.
2624 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2625 * information, see {@link android.app.UiModeManager}.
2626 */
2627 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2628 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002629
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002630 /**
2631 * Used to indicate that the activity can be used in a car environment.
2632 */
2633 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2634 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002636 // ---------------------------------------------------------------------
2637 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002638 // Application launch intent categories (see addCategory()).
2639
2640 /**
2641 * Used with {@link #ACTION_MAIN} to launch the browser application.
2642 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002643 * <p>NOTE: This should not be used as the primary key of an Intent,
2644 * since it will not result in the app launching with the correct
2645 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002646 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002647 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002648 */
2649 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2650 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2651
2652 /**
2653 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2654 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002655 * <p>NOTE: This should not be used as the primary key of an Intent,
2656 * since it will not result in the app launching with the correct
2657 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002658 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002659 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002660 */
2661 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2662 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2663
2664 /**
2665 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2666 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002667 * <p>NOTE: This should not be used as the primary key of an Intent,
2668 * since it will not result in the app launching with the correct
2669 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002670 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002671 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002672 */
2673 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2674 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2675
2676 /**
2677 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2678 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002679 * <p>NOTE: This should not be used as the primary key of an Intent,
2680 * since it will not result in the app launching with the correct
2681 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002682 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002683 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002684 */
2685 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2686 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2687
2688 /**
2689 * Used with {@link #ACTION_MAIN} to launch the email application.
2690 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002691 * <p>NOTE: This should not be used as the primary key of an Intent,
2692 * since it will not result in the app launching with the correct
2693 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002694 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002695 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002696 */
2697 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2698 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2699
2700 /**
2701 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2702 * The activity should be able to view and manipulate image and video files
2703 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002704 * <p>NOTE: This should not be used as the primary key of an Intent,
2705 * since it will not result in the app launching with the correct
2706 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002707 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002708 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002709 */
2710 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2711 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2712
2713 /**
2714 * Used with {@link #ACTION_MAIN} to launch the maps application.
2715 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002716 * <p>NOTE: This should not be used as the primary key of an Intent,
2717 * since it will not result in the app launching with the correct
2718 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002719 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002720 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002721 */
2722 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2723 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2724
2725 /**
2726 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2727 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002728 * <p>NOTE: This should not be used as the primary key of an Intent,
2729 * since it will not result in the app launching with the correct
2730 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002731 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002732 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002733 */
2734 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2735 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2736
2737 /**
2738 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002739 * The activity should be able to play, browse, or manipulate music files
2740 * stored on the device.
2741 * <p>NOTE: This should not be used as the primary key of an Intent,
2742 * since it will not result in the app launching with the correct
2743 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002744 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002745 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002746 */
2747 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2748 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2749
2750 // ---------------------------------------------------------------------
2751 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002752 // Standard extra data keys.
2753
2754 /**
2755 * The initial data to place in a newly created record. Use with
2756 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2757 * fields as would be given to the underlying ContentProvider.insert()
2758 * call.
2759 */
2760 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2761
2762 /**
2763 * A constant CharSequence that is associated with the Intent, used with
2764 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2765 * this may be a styled CharSequence, so you must use
2766 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2767 * retrieve it.
2768 */
2769 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2770
2771 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002772 * A constant String that is associated with the Intent, used with
2773 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2774 * as HTML formatted text. Note that you <em>must</em> also supply
2775 * {@link #EXTRA_TEXT}.
2776 */
2777 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2778
2779 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002780 * A content: URI holding a stream of data associated with the Intent,
2781 * used with {@link #ACTION_SEND} to supply the data being sent.
2782 */
2783 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2784
2785 /**
2786 * A String[] holding e-mail addresses that should be delivered to.
2787 */
2788 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2789
2790 /**
2791 * A String[] holding e-mail addresses that should be carbon copied.
2792 */
2793 public static final String EXTRA_CC = "android.intent.extra.CC";
2794
2795 /**
2796 * A String[] holding e-mail addresses that should be blind carbon copied.
2797 */
2798 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2799
2800 /**
2801 * A constant string holding the desired subject line of a message.
2802 */
2803 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2804
2805 /**
2806 * An Intent describing the choices you would like shown with
2807 * {@link #ACTION_PICK_ACTIVITY}.
2808 */
2809 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2810
2811 /**
2812 * A CharSequence dialog title to provide to the user when used with a
2813 * {@link #ACTION_CHOOSER}.
2814 */
2815 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2816
2817 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002818 * A Parcelable[] of {@link Intent} or
2819 * {@link android.content.pm.LabeledIntent} objects as set with
2820 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2821 * a the front of the list of choices, when shown to the user with a
2822 * {@link #ACTION_CHOOSER}.
2823 */
2824 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2825
2826 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002827 * A {@link android.view.KeyEvent} object containing the event that
2828 * triggered the creation of the Intent it is in.
2829 */
2830 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2831
2832 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002833 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2834 * before shutting down.
2835 *
2836 * {@hide}
2837 */
2838 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2839
2840 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002841 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002842 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2843 * of restarting the application.
2844 */
2845 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2846
2847 /**
2848 * A String holding the phone number originally entered in
2849 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2850 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2851 */
2852 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002853
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002854 /**
2855 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2856 * intents to supply the uid the package had been assigned. Also an optional
2857 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2858 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2859 * purpose.
2860 */
2861 public static final String EXTRA_UID = "android.intent.extra.UID";
2862
2863 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002864 * @hide String array of package names.
2865 */
2866 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2867
2868 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002869 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2870 * intents to indicate whether this represents a full uninstall (removing
2871 * both the code and its data) or a partial uninstall (leaving its data,
2872 * implying that this is an update).
2873 */
2874 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002875
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002876 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002877 * @hide
2878 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2879 * intents to indicate that at this point the package has been removed for
2880 * all users on the device.
2881 */
2882 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2883 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2884
2885 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002886 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2887 * intents to indicate that this is a replacement of the package, so this
2888 * broadcast will immediately be followed by an add broadcast for a
2889 * different version of the same package.
2890 */
2891 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002892
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002893 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002894 * Used as an int extra field in {@link android.app.AlarmManager} intents
2895 * to tell the application being invoked how many pending alarms are being
2896 * delievered with the intent. For one-shot alarms this will always be 1.
2897 * For recurring alarms, this might be greater than 1 if the device was
2898 * asleep or powered off at the time an earlier alarm would have been
2899 * delivered.
2900 */
2901 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002902
Jacek Surazski86b6c532009-05-13 14:38:28 +02002903 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002904 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2905 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002906 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2907 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002908 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2909 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2910 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002911 */
2912 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2913
2914 /**
2915 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2916 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002917 */
2918 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2919
2920 /**
2921 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2922 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002923 */
2924 public static final int EXTRA_DOCK_STATE_DESK = 1;
2925
2926 /**
2927 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2928 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002929 */
2930 public static final int EXTRA_DOCK_STATE_CAR = 2;
2931
2932 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002933 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2934 * to represent that the phone is in a analog (low end) dock.
2935 */
2936 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2937
2938 /**
2939 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2940 * to represent that the phone is in a digital (high end) dock.
2941 */
2942 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2943
2944 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002945 * Boolean that can be supplied as meta-data with a dock activity, to
2946 * indicate that the dock should take over the home key when it is active.
2947 */
2948 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002949
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002950 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002951 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2952 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002953 */
2954 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2955
2956 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002957 * Used in the extra field in the remote intent. It's astring token passed with the
2958 * remote intent.
2959 */
2960 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2961 "android.intent.extra.remote_intent_token";
2962
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002963 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002964 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002965 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002966 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002967 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002968 "android.intent.extra.changed_component_name";
2969
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002970 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002971 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002972 * and contains a string array of all of the components that have changed. If
2973 * the state of the overall package has changed, then it will contain an entry
2974 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002975 */
2976 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2977 "android.intent.extra.changed_component_name_list";
2978
2979 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002980 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002981 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2982 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002983 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002984 */
2985 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2986 "android.intent.extra.changed_package_list";
2987
2988 /**
2989 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002990 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2991 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002992 * and contains an integer array of uids of all of the components
2993 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002994 */
2995 public static final String EXTRA_CHANGED_UID_LIST =
2996 "android.intent.extra.changed_uid_list";
2997
2998 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002999 * @hide
3000 * Magic extra system code can use when binding, to give a label for
3001 * who it is that has bound to a service. This is an integer giving
3002 * a framework string resource that can be displayed to the user.
3003 */
3004 public static final String EXTRA_CLIENT_LABEL =
3005 "android.intent.extra.client_label";
3006
3007 /**
3008 * @hide
3009 * Magic extra system code can use when binding, to give a PendingIntent object
3010 * that can be launched for the user to disable the system's use of this
3011 * service.
3012 */
3013 public static final String EXTRA_CLIENT_INTENT =
3014 "android.intent.extra.client_intent";
3015
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003016 /**
3017 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3018 * data that is on the local device. This is a boolean extra; the default
3019 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3020 * the user to select media that is already on the device, not requiring it
3021 * be downloaded from a remote service when opened. Another way to look
3022 * at it is that such content should generally have a "_data" column to the
3023 * path of the content on local external storage.
3024 */
3025 public static final String EXTRA_LOCAL_ONLY =
3026 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003027
Amith Yamasani13593602012-03-22 16:16:17 -07003028 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003029 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003030 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3031 * @hide
3032 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003033 public static final String EXTRA_USER_HANDLE =
3034 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003036 // ---------------------------------------------------------------------
3037 // ---------------------------------------------------------------------
3038 // Intent flags (see mFlags variable).
3039
3040 /**
3041 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003042 * perform read operations on the Uri in the Intent's data and any URIs
3043 * specified in its ClipData. When applying to an Intent's ClipData,
3044 * all URIs as well as recursive traversals through data or other ClipData
3045 * in Intent items will be granted; only the grant flags of the top-level
3046 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003047 */
3048 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3049 /**
3050 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003051 * perform write operations on the Uri in the Intent's data and any URIs
3052 * specified in its ClipData. When applying to an Intent's ClipData,
3053 * all URIs as well as recursive traversals through data or other ClipData
3054 * in Intent items will be granted; only the grant flags of the top-level
3055 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003056 */
3057 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3058 /**
3059 * Can be set by the caller to indicate that this Intent is coming from
3060 * a background operation, not from direct user interaction.
3061 */
3062 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3063 /**
3064 * A flag you can enable for debugging: when set, log messages will be
3065 * printed during the resolution of this intent to show you what has
3066 * been found to create the final resolved list.
3067 */
3068 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003069 /**
3070 * If set, this intent will not match any components in packages that
3071 * are currently stopped. If this is not set, then the default behavior
3072 * is to include such applications in the result.
3073 */
3074 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3075 /**
3076 * If set, this intent will always match any components in packages that
3077 * are currently stopped. This is the default behavior when
3078 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3079 * flags are set, this one wins (it allows overriding of exclude for
3080 * places where the framework may automatically set the exclude flag).
3081 */
3082 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003083
3084 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003085 * If set, the new activity is not kept in the history stack. As soon as
3086 * the user navigates away from it, the activity is finished. This may also
3087 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3088 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003089 */
3090 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3091 /**
3092 * If set, the activity will not be launched if it is already running
3093 * at the top of the history stack.
3094 */
3095 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3096 /**
3097 * If set, this activity will become the start of a new task on this
3098 * history stack. A task (from the activity that started it to the
3099 * next task activity) defines an atomic group of activities that the
3100 * user can move to. Tasks can be moved to the foreground and background;
3101 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003102 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003103 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3104 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003105 *
3106 * <p>This flag is generally used by activities that want
3107 * to present a "launcher" style behavior: they give the user a list of
3108 * separate things that can be done, which otherwise run completely
3109 * independently of the activity launching them.
3110 *
3111 * <p>When using this flag, if a task is already running for the activity
3112 * you are now starting, then a new activity will not be started; instead,
3113 * the current task will simply be brought to the front of the screen with
3114 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3115 * to disable this behavior.
3116 *
3117 * <p>This flag can not be used when the caller is requesting a result from
3118 * the activity being launched.
3119 */
3120 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3121 /**
3122 * <strong>Do not use this flag unless you are implementing your own
3123 * top-level application launcher.</strong> Used in conjunction with
3124 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3125 * behavior of bringing an existing task to the foreground. When set,
3126 * a new task is <em>always</em> started to host the Activity for the
3127 * Intent, regardless of whether there is already an existing task running
3128 * the same thing.
3129 *
3130 * <p><strong>Because the default system does not include graphical task management,
3131 * you should not use this flag unless you provide some way for a user to
3132 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003133 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003134 * <p>This flag is ignored if
3135 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3136 *
Scott Main7aee61f2011-02-08 11:25:01 -08003137 * <p>See
3138 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3139 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003140 */
3141 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3142 /**
3143 * If set, and the activity being launched is already running in the
3144 * current task, then instead of launching a new instance of that activity,
3145 * all of the other activities on top of it will be closed and this Intent
3146 * will be delivered to the (now on top) old activity as a new Intent.
3147 *
3148 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3149 * If D calls startActivity() with an Intent that resolves to the component
3150 * of activity B, then C and D will be finished and B receive the given
3151 * Intent, resulting in the stack now being: A, B.
3152 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003153 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003154 * either receive the new intent you are starting here in its
3155 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003156 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003157 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3158 * the same intent, then it will be finished and re-created; for all other
3159 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3160 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003161 *
3162 * <p>This launch mode can also be used to good effect in conjunction with
3163 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3164 * of a task, it will bring any currently running instance of that task
3165 * to the foreground, and then clear it to its root state. This is
3166 * especially useful, for example, when launching an activity from the
3167 * notification manager.
3168 *
Scott Main7aee61f2011-02-08 11:25:01 -08003169 * <p>See
3170 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3171 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003172 */
3173 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3174 /**
3175 * If set and this intent is being used to launch a new activity from an
3176 * existing one, then the reply target of the existing activity will be
3177 * transfered to the new activity. This way the new activity can call
3178 * {@link android.app.Activity#setResult} and have that result sent back to
3179 * the reply target of the original activity.
3180 */
3181 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3182 /**
3183 * If set and this intent is being used to launch a new activity from an
3184 * existing one, the current activity will not be counted as the top
3185 * activity for deciding whether the new intent should be delivered to
3186 * the top instead of starting a new one. The previous activity will
3187 * be used as the top, with the assumption being that the current activity
3188 * will finish itself immediately.
3189 */
3190 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3191 /**
3192 * If set, the new activity is not kept in the list of recently launched
3193 * activities.
3194 */
3195 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3196 /**
3197 * This flag is not normally set by application code, but set for you by
3198 * the system as described in the
3199 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3200 * launchMode} documentation for the singleTask mode.
3201 */
3202 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3203 /**
3204 * If set, and this activity is either being started in a new task or
3205 * bringing to the top an existing task, then it will be launched as
3206 * the front door of the task. This will result in the application of
3207 * any affinities needed to have that task in the proper state (either
3208 * moving activities to or from it), or simply resetting that task to
3209 * its initial state if needed.
3210 */
3211 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3212 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003213 * This flag is not normally set by application code, but set for you by
3214 * the system if this activity is being launched from history
3215 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003216 */
3217 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003218 /**
3219 * If set, this marks a point in the task's activity stack that should
3220 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003221 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003222 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3223 * the user re-launching it from home), this activity and all on top of
3224 * it will be finished so that the user does not return to them, but
3225 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003226 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003227 * <p>This is useful for cases where you have a logical break in your
3228 * application. For example, an e-mail application may have a command
3229 * to view an attachment, which launches an image view activity to
3230 * display it. This activity should be part of the e-mail application's
3231 * task, since it is a part of the task the user is involved in. However,
3232 * if the user leaves that task, and later selects the e-mail app from
3233 * home, we may like them to return to the conversation they were
3234 * viewing, not the picture attachment, since that is confusing. By
3235 * setting this flag when launching the image viewer, that viewer and
3236 * any activities it starts will be removed the next time the user returns
3237 * to mail.
3238 */
3239 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003240 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003241 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003242 * callback from occurring on the current frontmost activity before it is
3243 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003244 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003245 * <p>Typically, an activity can rely on that callback to indicate that an
3246 * explicit user action has caused their activity to be moved out of the
3247 * foreground. The callback marks an appropriate point in the activity's
3248 * lifecycle for it to dismiss any notifications that it intends to display
3249 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003250 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003251 * <p>If an activity is ever started via any non-user-driven events such as
3252 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3253 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003254 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003255 */
3256 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003257 /**
3258 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3259 * this flag will cause the launched activity to be brought to the front of its
3260 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003261 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003262 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3263 * If D calls startActivity() with an Intent that resolves to the component
3264 * of activity B, then B will be brought to the front of the history stack,
3265 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003266 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003267 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003268 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003269 */
3270 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003271 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003272 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3273 * this flag will prevent the system from applying an activity transition
3274 * animation to go to the next activity state. This doesn't mean an
3275 * animation will never run -- if another activity change happens that doesn't
3276 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003277 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003278 * when you are going to do a series of activity operations but the
3279 * animation seen by the user shouldn't be driven by the first activity
3280 * change but rather a later one.
3281 */
3282 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3283 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003284 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3285 * this flag will cause any existing task that would be associated with the
3286 * activity to be cleared before the activity is started. That is, the activity
3287 * becomes the new root of an otherwise empty task, and any old activities
3288 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3289 */
3290 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3291 /**
3292 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3293 * this flag will cause a newly launching task to be placed on top of the current
3294 * home activity task (if there is one). That is, pressing back from the task
3295 * will always return the user to home even if that was not the last activity they
3296 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3297 */
3298 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3299 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300 * If set, when sending a broadcast only registered receivers will be
3301 * called -- no BroadcastReceiver components will be launched.
3302 */
3303 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003304 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003305 * If set, when sending a broadcast the new broadcast will replace
3306 * any existing pending broadcast that matches it. Matching is defined
3307 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3308 * true for the intents of the two broadcasts. When a match is found,
3309 * the new broadcast (and receivers associated with it) will replace the
3310 * existing one in the pending broadcast list, remaining at the same
3311 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003312 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003313 * <p>This flag is most typically used with sticky broadcasts, which
3314 * only care about delivering the most recent values of the broadcast
3315 * to their receivers.
3316 */
3317 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3318 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003319 * If set, when sending a broadcast the recipient is allowed to run at
3320 * foreground priority, with a shorter timeout interval. During normal
3321 * broadcasts the receivers are not automatically hoisted out of the
3322 * background priority class.
3323 */
3324 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3325 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003326 * If set, when sending a broadcast <i>before boot has completed</i> only
3327 * registered receivers will be called -- no BroadcastReceiver components
3328 * will be launched. Sticky intent state will be recorded properly even
3329 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3330 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003331 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003332 * <p>This flag is only for use by system sevices as a convenience to
3333 * avoid having to implement a more complex mechanism around detection
3334 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003335 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003336 * @hide
3337 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003338 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003339 /**
3340 * Set when this broadcast is for a boot upgrade, a special mode that
3341 * allows the broadcast to be sent before the system is ready and launches
3342 * the app process with no providers running in it.
3343 * @hide
3344 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003345 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003346
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003347 /**
3348 * @hide Flags that can't be changed with PendingIntent.
3349 */
3350 public static final int IMMUTABLE_FLAGS =
3351 FLAG_GRANT_READ_URI_PERMISSION
3352 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003353
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003354 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003355 // ---------------------------------------------------------------------
3356 // toUri() and parseUri() options.
3357
3358 /**
3359 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3360 * always has the "intent:" scheme. This syntax can be used when you want
3361 * to later disambiguate between URIs that are intended to describe an
3362 * Intent vs. all others that should be treated as raw URIs. When used
3363 * with {@link #parseUri}, any other scheme will result in a generic
3364 * VIEW action for that raw URI.
3365 */
3366 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003367
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003368 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003369
3370 private String mAction;
3371 private Uri mData;
3372 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003373 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003374 private ComponentName mComponent;
3375 private int mFlags;
3376 private HashSet<String> mCategories;
3377 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003378 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003379 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003380 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003381
3382 // ---------------------------------------------------------------------
3383
3384 /**
3385 * Create an empty intent.
3386 */
3387 public Intent() {
3388 }
3389
3390 /**
3391 * Copy constructor.
3392 */
3393 public Intent(Intent o) {
3394 this.mAction = o.mAction;
3395 this.mData = o.mData;
3396 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003397 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003398 this.mComponent = o.mComponent;
3399 this.mFlags = o.mFlags;
3400 if (o.mCategories != null) {
3401 this.mCategories = new HashSet<String>(o.mCategories);
3402 }
3403 if (o.mExtras != null) {
3404 this.mExtras = new Bundle(o.mExtras);
3405 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003406 if (o.mSourceBounds != null) {
3407 this.mSourceBounds = new Rect(o.mSourceBounds);
3408 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003409 if (o.mSelector != null) {
3410 this.mSelector = new Intent(o.mSelector);
3411 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003412 if (o.mClipData != null) {
3413 this.mClipData = new ClipData(o.mClipData);
3414 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003415 }
3416
3417 @Override
3418 public Object clone() {
3419 return new Intent(this);
3420 }
3421
3422 private Intent(Intent o, boolean all) {
3423 this.mAction = o.mAction;
3424 this.mData = o.mData;
3425 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003426 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003427 this.mComponent = o.mComponent;
3428 if (o.mCategories != null) {
3429 this.mCategories = new HashSet<String>(o.mCategories);
3430 }
3431 }
3432
3433 /**
3434 * Make a clone of only the parts of the Intent that are relevant for
3435 * filter matching: the action, data, type, component, and categories.
3436 */
3437 public Intent cloneFilter() {
3438 return new Intent(this, false);
3439 }
3440
3441 /**
3442 * Create an intent with a given action. All other fields (data, type,
3443 * class) are null. Note that the action <em>must</em> be in a
3444 * namespace because Intents are used globally in the system -- for
3445 * example the system VIEW action is android.intent.action.VIEW; an
3446 * application's custom action would be something like
3447 * com.google.app.myapp.CUSTOM_ACTION.
3448 *
3449 * @param action The Intent action, such as ACTION_VIEW.
3450 */
3451 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003452 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003453 }
3454
3455 /**
3456 * Create an intent with a given action and for a given data url. Note
3457 * that the action <em>must</em> be in a namespace because Intents are
3458 * used globally in the system -- for example the system VIEW action is
3459 * android.intent.action.VIEW; an application's custom action would be
3460 * something like com.google.app.myapp.CUSTOM_ACTION.
3461 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003462 * <p><em>Note: scheme and host name matching in the Android framework is
3463 * case-sensitive, unlike the formal RFC. As a result,
3464 * you should always ensure that you write your Uri with these elements
3465 * using lower case letters, and normalize any Uris you receive from
3466 * outside of Android to ensure the scheme and host is lower case.</em></p>
3467 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 * @param action The Intent action, such as ACTION_VIEW.
3469 * @param uri The Intent data URI.
3470 */
3471 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003472 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003473 mData = uri;
3474 }
3475
3476 /**
3477 * Create an intent for a specific component. All other fields (action, data,
3478 * type, class) are null, though they can be modified later with explicit
3479 * calls. This provides a convenient way to create an intent that is
3480 * intended to execute a hard-coded class name, rather than relying on the
3481 * system to find an appropriate class for you; see {@link #setComponent}
3482 * for more information on the repercussions of this.
3483 *
3484 * @param packageContext A Context of the application package implementing
3485 * this class.
3486 * @param cls The component class that is to be used for the intent.
3487 *
3488 * @see #setClass
3489 * @see #setComponent
3490 * @see #Intent(String, android.net.Uri , Context, Class)
3491 */
3492 public Intent(Context packageContext, Class<?> cls) {
3493 mComponent = new ComponentName(packageContext, cls);
3494 }
3495
3496 /**
3497 * Create an intent for a specific component with a specified action and data.
3498 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3499 * construct the Intent and then calling {@link #setClass} to set its
3500 * class.
3501 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003502 * <p><em>Note: scheme and host name matching in the Android framework is
3503 * case-sensitive, unlike the formal RFC. As a result,
3504 * you should always ensure that you write your Uri with these elements
3505 * using lower case letters, and normalize any Uris you receive from
3506 * outside of Android to ensure the scheme and host is lower case.</em></p>
3507 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003508 * @param action The Intent action, such as ACTION_VIEW.
3509 * @param uri The Intent data URI.
3510 * @param packageContext A Context of the application package implementing
3511 * this class.
3512 * @param cls The component class that is to be used for the intent.
3513 *
3514 * @see #Intent(String, android.net.Uri)
3515 * @see #Intent(Context, Class)
3516 * @see #setClass
3517 * @see #setComponent
3518 */
3519 public Intent(String action, Uri uri,
3520 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003521 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003522 mData = uri;
3523 mComponent = new ComponentName(packageContext, cls);
3524 }
3525
3526 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003527 * Create an intent to launch the main (root) activity of a task. This
3528 * is the Intent that is started when the application's is launched from
3529 * Home. For anything else that wants to launch an application in the
3530 * same way, it is important that they use an Intent structured the same
3531 * way, and can use this function to ensure this is the case.
3532 *
3533 * <p>The returned Intent has the given Activity component as its explicit
3534 * component, {@link #ACTION_MAIN} as its action, and includes the
3535 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3536 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3537 * to do that through {@link #addFlags(int)} on the returned Intent.
3538 *
3539 * @param mainActivity The main activity component that this Intent will
3540 * launch.
3541 * @return Returns a newly created Intent that can be used to launch the
3542 * activity as a main application entry.
3543 *
3544 * @see #setClass
3545 * @see #setComponent
3546 */
3547 public static Intent makeMainActivity(ComponentName mainActivity) {
3548 Intent intent = new Intent(ACTION_MAIN);
3549 intent.setComponent(mainActivity);
3550 intent.addCategory(CATEGORY_LAUNCHER);
3551 return intent;
3552 }
3553
3554 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003555 * Make an Intent for the main activity of an application, without
3556 * specifying a specific activity to run but giving a selector to find
3557 * the activity. This results in a final Intent that is structured
3558 * the same as when the application is launched from
3559 * Home. For anything else that wants to launch an application in the
3560 * same way, it is important that they use an Intent structured the same
3561 * way, and can use this function to ensure this is the case.
3562 *
3563 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3564 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3565 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3566 * to do that through {@link #addFlags(int)} on the returned Intent.
3567 *
3568 * @param selectorAction The action name of the Intent's selector.
3569 * @param selectorCategory The name of a category to add to the Intent's
3570 * selector.
3571 * @return Returns a newly created Intent that can be used to launch the
3572 * activity as a main application entry.
3573 *
3574 * @see #setSelector(Intent)
3575 */
3576 public static Intent makeMainSelectorActivity(String selectorAction,
3577 String selectorCategory) {
3578 Intent intent = new Intent(ACTION_MAIN);
3579 intent.addCategory(CATEGORY_LAUNCHER);
3580 Intent selector = new Intent();
3581 selector.setAction(selectorAction);
3582 selector.addCategory(selectorCategory);
3583 intent.setSelector(selector);
3584 return intent;
3585 }
3586
3587 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003588 * Make an Intent that can be used to re-launch an application's task
3589 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3590 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3591 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3592 *
3593 * @param mainActivity The activity component that is the root of the
3594 * task; this is the activity that has been published in the application's
3595 * manifest as the main launcher icon.
3596 *
3597 * @return Returns a newly created Intent that can be used to relaunch the
3598 * activity's task in its root state.
3599 */
3600 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3601 Intent intent = makeMainActivity(mainActivity);
3602 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3603 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3604 return intent;
3605 }
3606
3607 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003608 * Call {@link #parseUri} with 0 flags.
3609 * @deprecated Use {@link #parseUri} instead.
3610 */
3611 @Deprecated
3612 public static Intent getIntent(String uri) throws URISyntaxException {
3613 return parseUri(uri, 0);
3614 }
Tom Taylord4a47292009-12-21 13:59:18 -08003615
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003616 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003618 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003619 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003620 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003621 *
3622 * <p>The URI given here must not be relative -- that is, it must include
3623 * the scheme and full path.
3624 *
3625 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003626 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003627 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628 *
3629 * @return Intent The newly created Intent object.
3630 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003631 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3632 * it bad (as parsed by the Uri class) or the Intent data within the
3633 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003634 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003635 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003636 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003637 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003638 int i = 0;
3639 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003640 // Validate intent scheme for if requested.
3641 if ((flags&URI_INTENT_SCHEME) != 0) {
3642 if (!uri.startsWith("intent:")) {
3643 Intent intent = new Intent(ACTION_VIEW);
3644 try {
3645 intent.setData(Uri.parse(uri));
3646 } catch (IllegalArgumentException e) {
3647 throw new URISyntaxException(uri, e.getMessage());
3648 }
3649 return intent;
3650 }
3651 }
Tom Taylord4a47292009-12-21 13:59:18 -08003652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003653 // simple case
3654 i = uri.lastIndexOf("#");
3655 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3656
3657 // old format Intent URI
3658 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003660 // new format
3661 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003662 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663
3664 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003665 String data = i >= 0 ? uri.substring(0, i) : null;
3666 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003667 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003669 // loop over contents of Intent, all name=value;
3670 while (!uri.startsWith("end", i)) {
3671 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003672 if (eq < 0) eq = i-1;
3673 int semi = uri.indexOf(';', i);
3674 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675
3676 // action
3677 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003678 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003679 }
3680
3681 // categories
3682 else if (uri.startsWith("category=", i)) {
3683 intent.addCategory(value);
3684 }
3685
3686 // type
3687 else if (uri.startsWith("type=", i)) {
3688 intent.mType = value;
3689 }
3690
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003691 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003692 else if (uri.startsWith("launchFlags=", i)) {
3693 intent.mFlags = Integer.decode(value).intValue();
3694 }
3695
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003696 // package
3697 else if (uri.startsWith("package=", i)) {
3698 intent.mPackage = value;
3699 }
3700
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003701 // component
3702 else if (uri.startsWith("component=", i)) {
3703 intent.mComponent = ComponentName.unflattenFromString(value);
3704 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003705
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003706 // scheme
3707 else if (uri.startsWith("scheme=", i)) {
3708 scheme = value;
3709 }
3710
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003711 // source bounds
3712 else if (uri.startsWith("sourceBounds=", i)) {
3713 intent.mSourceBounds = Rect.unflattenFromString(value);
3714 }
3715
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003716 // selector
3717 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3718 intent = new Intent();
3719 }
3720
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003721 // extra
3722 else {
3723 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003724 // create Bundle if it doesn't already exist
3725 if (intent.mExtras == null) intent.mExtras = new Bundle();
3726 Bundle b = intent.mExtras;
3727 // add EXTRA
3728 if (uri.startsWith("S.", i)) b.putString(key, value);
3729 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3730 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3731 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3732 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3733 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3734 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3735 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3736 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3737 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3738 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003739
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003740 // move to the next item
3741 i = semi + 1;
3742 }
3743
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003744 if (intent != baseIntent) {
3745 // The Intent had a selector; fix it up.
3746 baseIntent.setSelector(intent);
3747 intent = baseIntent;
3748 }
3749
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003750 if (data != null) {
3751 if (data.startsWith("intent:")) {
3752 data = data.substring(7);
3753 if (scheme != null) {
3754 data = scheme + ':' + data;
3755 }
3756 }
Tom Taylord4a47292009-12-21 13:59:18 -08003757
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003758 if (data.length() > 0) {
3759 try {
3760 intent.mData = Uri.parse(data);
3761 } catch (IllegalArgumentException e) {
3762 throw new URISyntaxException(uri, e.getMessage());
3763 }
3764 }
3765 }
Tom Taylord4a47292009-12-21 13:59:18 -08003766
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003767 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003768
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003769 } catch (IndexOutOfBoundsException e) {
3770 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3771 }
3772 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003773
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003774 public static Intent getIntentOld(String uri) throws URISyntaxException {
3775 Intent intent;
3776
3777 int i = uri.lastIndexOf('#');
3778 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003779 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003780 final int intentFragmentStart = i;
3781 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003782
3783 i++;
3784
3785 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003786 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003787 i += 7;
3788 int j = uri.indexOf(')', i);
3789 action = uri.substring(i, j);
3790 i = j + 1;
3791 }
3792
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003793 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794
3795 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003796 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003797 i += 11;
3798 int j = uri.indexOf(')', i);
3799 while (i < j) {
3800 int sep = uri.indexOf('!', i);
3801 if (sep < 0) sep = j;
3802 if (i < sep) {
3803 intent.addCategory(uri.substring(i, sep));
3804 }
3805 i = sep + 1;
3806 }
3807 i = j + 1;
3808 }
3809
3810 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003811 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003812 i += 5;
3813 int j = uri.indexOf(')', i);
3814 intent.mType = uri.substring(i, j);
3815 i = j + 1;
3816 }
3817
3818 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003819 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003820 i += 12;
3821 int j = uri.indexOf(')', i);
3822 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3823 i = j + 1;
3824 }
3825
3826 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003827 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003828 i += 10;
3829 int j = uri.indexOf(')', i);
3830 int sep = uri.indexOf('!', i);
3831 if (sep >= 0 && sep < j) {
3832 String pkg = uri.substring(i, sep);
3833 String cls = uri.substring(sep + 1, j);
3834 intent.mComponent = new ComponentName(pkg, cls);
3835 }
3836 i = j + 1;
3837 }
3838
3839 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003840 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003841 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003842
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003843 final int closeParen = uri.indexOf(')', i);
3844 if (closeParen == -1) throw new URISyntaxException(uri,
3845 "EXTRA missing trailing ')'", i);
3846
3847 while (i < closeParen) {
3848 // fetch the key value
3849 int j = uri.indexOf('=', i);
3850 if (j <= i + 1 || i >= closeParen) {
3851 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3852 }
3853 char type = uri.charAt(i);
3854 i++;
3855 String key = uri.substring(i, j);
3856 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003857
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003858 // get type-value
3859 j = uri.indexOf('!', i);
3860 if (j == -1 || j >= closeParen) j = closeParen;
3861 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3862 String value = uri.substring(i, j);
3863 i = j;
3864
3865 // create Bundle if it doesn't already exist
3866 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003867
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003868 // add item to bundle
3869 try {
3870 switch (type) {
3871 case 'S':
3872 intent.mExtras.putString(key, Uri.decode(value));
3873 break;
3874 case 'B':
3875 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3876 break;
3877 case 'b':
3878 intent.mExtras.putByte(key, Byte.parseByte(value));
3879 break;
3880 case 'c':
3881 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3882 break;
3883 case 'd':
3884 intent.mExtras.putDouble(key, Double.parseDouble(value));
3885 break;
3886 case 'f':
3887 intent.mExtras.putFloat(key, Float.parseFloat(value));
3888 break;
3889 case 'i':
3890 intent.mExtras.putInt(key, Integer.parseInt(value));
3891 break;
3892 case 'l':
3893 intent.mExtras.putLong(key, Long.parseLong(value));
3894 break;
3895 case 's':
3896 intent.mExtras.putShort(key, Short.parseShort(value));
3897 break;
3898 default:
3899 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3900 }
3901 } catch (NumberFormatException e) {
3902 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3903 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003904
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 char ch = uri.charAt(i);
3906 if (ch == ')') break;
3907 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3908 i++;
3909 }
3910 }
3911
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003912 if (isIntentFragment) {
3913 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3914 } else {
3915 intent.mData = Uri.parse(uri);
3916 }
Tom Taylord4a47292009-12-21 13:59:18 -08003917
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003918 if (intent.mAction == null) {
3919 // By default, if no action is specified, then use VIEW.
3920 intent.mAction = ACTION_VIEW;
3921 }
3922
3923 } else {
3924 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3925 }
3926
3927 return intent;
3928 }
3929
3930 /**
3931 * Retrieve the general action to be performed, such as
3932 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3933 * the information in the intent should be interpreted -- most importantly,
3934 * what to do with the data returned by {@link #getData}.
3935 *
3936 * @return The action of this intent or null if none is specified.
3937 *
3938 * @see #setAction
3939 */
3940 public String getAction() {
3941 return mAction;
3942 }
3943
3944 /**
3945 * Retrieve data this intent is operating on. This URI specifies the name
3946 * of the data; often it uses the content: scheme, specifying data in a
3947 * content provider. Other schemes may be handled by specific activities,
3948 * such as http: by the web browser.
3949 *
3950 * @return The URI of the data this intent is targeting or null.
3951 *
3952 * @see #getScheme
3953 * @see #setData
3954 */
3955 public Uri getData() {
3956 return mData;
3957 }
3958
3959 /**
3960 * The same as {@link #getData()}, but returns the URI as an encoded
3961 * String.
3962 */
3963 public String getDataString() {
3964 return mData != null ? mData.toString() : null;
3965 }
3966
3967 /**
3968 * Return the scheme portion of the intent's data. If the data is null or
3969 * does not include a scheme, null is returned. Otherwise, the scheme
3970 * prefix without the final ':' is returned, i.e. "http".
3971 *
3972 * <p>This is the same as calling getData().getScheme() (and checking for
3973 * null data).
3974 *
3975 * @return The scheme of this intent.
3976 *
3977 * @see #getData
3978 */
3979 public String getScheme() {
3980 return mData != null ? mData.getScheme() : null;
3981 }
3982
3983 /**
3984 * Retrieve any explicit MIME type included in the intent. This is usually
3985 * null, as the type is determined by the intent data.
3986 *
3987 * @return If a type was manually set, it is returned; else null is
3988 * returned.
3989 *
3990 * @see #resolveType(ContentResolver)
3991 * @see #setType
3992 */
3993 public String getType() {
3994 return mType;
3995 }
3996
3997 /**
3998 * Return the MIME data type of this intent. If the type field is
3999 * explicitly set, that is simply returned. Otherwise, if the data is set,
4000 * the type of that data is returned. If neither fields are set, a null is
4001 * returned.
4002 *
4003 * @return The MIME type of this intent.
4004 *
4005 * @see #getType
4006 * @see #resolveType(ContentResolver)
4007 */
4008 public String resolveType(Context context) {
4009 return resolveType(context.getContentResolver());
4010 }
4011
4012 /**
4013 * Return the MIME data type of this intent. If the type field is
4014 * explicitly set, that is simply returned. Otherwise, if the data is set,
4015 * the type of that data is returned. If neither fields are set, a null is
4016 * returned.
4017 *
4018 * @param resolver A ContentResolver that can be used to determine the MIME
4019 * type of the intent's data.
4020 *
4021 * @return The MIME type of this intent.
4022 *
4023 * @see #getType
4024 * @see #resolveType(Context)
4025 */
4026 public String resolveType(ContentResolver resolver) {
4027 if (mType != null) {
4028 return mType;
4029 }
4030 if (mData != null) {
4031 if ("content".equals(mData.getScheme())) {
4032 return resolver.getType(mData);
4033 }
4034 }
4035 return null;
4036 }
4037
4038 /**
4039 * Return the MIME data type of this intent, only if it will be needed for
4040 * intent resolution. This is not generally useful for application code;
4041 * it is used by the frameworks for communicating with back-end system
4042 * services.
4043 *
4044 * @param resolver A ContentResolver that can be used to determine the MIME
4045 * type of the intent's data.
4046 *
4047 * @return The MIME type of this intent, or null if it is unknown or not
4048 * needed.
4049 */
4050 public String resolveTypeIfNeeded(ContentResolver resolver) {
4051 if (mComponent != null) {
4052 return mType;
4053 }
4054 return resolveType(resolver);
4055 }
4056
4057 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004058 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004059 *
4060 * @param category The category to check.
4061 *
4062 * @return boolean True if the intent contains the category, else false.
4063 *
4064 * @see #getCategories
4065 * @see #addCategory
4066 */
4067 public boolean hasCategory(String category) {
4068 return mCategories != null && mCategories.contains(category);
4069 }
4070
4071 /**
4072 * Return the set of all categories in the intent. If there are no categories,
4073 * returns NULL.
4074 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004075 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004076 *
4077 * @see #hasCategory
4078 * @see #addCategory
4079 */
4080 public Set<String> getCategories() {
4081 return mCategories;
4082 }
4083
4084 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004085 * Return the specific selector associated with this Intent. If there is
4086 * none, returns null. See {@link #setSelector} for more information.
4087 *
4088 * @see #setSelector
4089 */
4090 public Intent getSelector() {
4091 return mSelector;
4092 }
4093
4094 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004095 * Return the {@link ClipData} associated with this Intent. If there is
4096 * none, returns null. See {@link #setClipData} for more information.
4097 *
4098 * @see #setClipData;
4099 */
4100 public ClipData getClipData() {
4101 return mClipData;
4102 }
4103
4104 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105 * Sets the ClassLoader that will be used when unmarshalling
4106 * any Parcelable values from the extras of this Intent.
4107 *
4108 * @param loader a ClassLoader, or null to use the default loader
4109 * at the time of unmarshalling.
4110 */
4111 public void setExtrasClassLoader(ClassLoader loader) {
4112 if (mExtras != null) {
4113 mExtras.setClassLoader(loader);
4114 }
4115 }
4116
4117 /**
4118 * Returns true if an extra value is associated with the given name.
4119 * @param name the extra's name
4120 * @return true if the given extra is present.
4121 */
4122 public boolean hasExtra(String name) {
4123 return mExtras != null && mExtras.containsKey(name);
4124 }
4125
4126 /**
4127 * Returns true if the Intent's extras contain a parcelled file descriptor.
4128 * @return true if the Intent contains a parcelled file descriptor.
4129 */
4130 public boolean hasFileDescriptors() {
4131 return mExtras != null && mExtras.hasFileDescriptors();
4132 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004133
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004134 /** @hide */
4135 public void setAllowFds(boolean allowFds) {
4136 if (mExtras != null) {
4137 mExtras.setAllowFds(allowFds);
4138 }
4139 }
4140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004141 /**
4142 * Retrieve extended data from the intent.
4143 *
4144 * @param name The name of the desired item.
4145 *
4146 * @return the value of an item that previously added with putExtra()
4147 * or null if none was found.
4148 *
4149 * @deprecated
4150 * @hide
4151 */
4152 @Deprecated
4153 public Object getExtra(String name) {
4154 return getExtra(name, null);
4155 }
4156
4157 /**
4158 * Retrieve extended data from the intent.
4159 *
4160 * @param name The name of the desired item.
4161 * @param defaultValue the value to be returned if no value of the desired
4162 * type is stored with the given name.
4163 *
4164 * @return the value of an item that previously added with putExtra()
4165 * or the default value if none was found.
4166 *
4167 * @see #putExtra(String, boolean)
4168 */
4169 public boolean getBooleanExtra(String name, boolean defaultValue) {
4170 return mExtras == null ? defaultValue :
4171 mExtras.getBoolean(name, defaultValue);
4172 }
4173
4174 /**
4175 * Retrieve extended data from the intent.
4176 *
4177 * @param name The name of the desired item.
4178 * @param defaultValue the value to be returned if no value of the desired
4179 * type is stored with the given name.
4180 *
4181 * @return the value of an item that previously added with putExtra()
4182 * or the default value if none was found.
4183 *
4184 * @see #putExtra(String, byte)
4185 */
4186 public byte getByteExtra(String name, byte defaultValue) {
4187 return mExtras == null ? defaultValue :
4188 mExtras.getByte(name, defaultValue);
4189 }
4190
4191 /**
4192 * Retrieve extended data from the intent.
4193 *
4194 * @param name The name of the desired item.
4195 * @param defaultValue the value to be returned if no value of the desired
4196 * type is stored with the given name.
4197 *
4198 * @return the value of an item that previously added with putExtra()
4199 * or the default value if none was found.
4200 *
4201 * @see #putExtra(String, short)
4202 */
4203 public short getShortExtra(String name, short defaultValue) {
4204 return mExtras == null ? defaultValue :
4205 mExtras.getShort(name, defaultValue);
4206 }
4207
4208 /**
4209 * Retrieve extended data from the intent.
4210 *
4211 * @param name The name of the desired item.
4212 * @param defaultValue the value to be returned if no value of the desired
4213 * type is stored with the given name.
4214 *
4215 * @return the value of an item that previously added with putExtra()
4216 * or the default value if none was found.
4217 *
4218 * @see #putExtra(String, char)
4219 */
4220 public char getCharExtra(String name, char defaultValue) {
4221 return mExtras == null ? defaultValue :
4222 mExtras.getChar(name, defaultValue);
4223 }
4224
4225 /**
4226 * Retrieve extended data from the intent.
4227 *
4228 * @param name The name of the desired item.
4229 * @param defaultValue the value to be returned if no value of the desired
4230 * type is stored with the given name.
4231 *
4232 * @return the value of an item that previously added with putExtra()
4233 * or the default value if none was found.
4234 *
4235 * @see #putExtra(String, int)
4236 */
4237 public int getIntExtra(String name, int defaultValue) {
4238 return mExtras == null ? defaultValue :
4239 mExtras.getInt(name, defaultValue);
4240 }
4241
4242 /**
4243 * Retrieve extended data from the intent.
4244 *
4245 * @param name The name of the desired item.
4246 * @param defaultValue the value to be returned if no value of the desired
4247 * type is stored with the given name.
4248 *
4249 * @return the value of an item that previously added with putExtra()
4250 * or the default value if none was found.
4251 *
4252 * @see #putExtra(String, long)
4253 */
4254 public long getLongExtra(String name, long defaultValue) {
4255 return mExtras == null ? defaultValue :
4256 mExtras.getLong(name, defaultValue);
4257 }
4258
4259 /**
4260 * Retrieve extended data from the intent.
4261 *
4262 * @param name The name of the desired item.
4263 * @param defaultValue the value to be returned if no value of the desired
4264 * type is stored with the given name.
4265 *
4266 * @return the value of an item that previously added with putExtra(),
4267 * or the default value if no such item is present
4268 *
4269 * @see #putExtra(String, float)
4270 */
4271 public float getFloatExtra(String name, float defaultValue) {
4272 return mExtras == null ? defaultValue :
4273 mExtras.getFloat(name, defaultValue);
4274 }
4275
4276 /**
4277 * Retrieve extended data from the intent.
4278 *
4279 * @param name The name of the desired item.
4280 * @param defaultValue the value to be returned if no value of the desired
4281 * type is stored with the given name.
4282 *
4283 * @return the value of an item that previously added with putExtra()
4284 * or the default value if none was found.
4285 *
4286 * @see #putExtra(String, double)
4287 */
4288 public double getDoubleExtra(String name, double defaultValue) {
4289 return mExtras == null ? defaultValue :
4290 mExtras.getDouble(name, defaultValue);
4291 }
4292
4293 /**
4294 * Retrieve extended data from the intent.
4295 *
4296 * @param name The name of the desired item.
4297 *
4298 * @return the value of an item that previously added with putExtra()
4299 * or null if no String value was found.
4300 *
4301 * @see #putExtra(String, String)
4302 */
4303 public String getStringExtra(String name) {
4304 return mExtras == null ? null : mExtras.getString(name);
4305 }
4306
4307 /**
4308 * Retrieve extended data from the intent.
4309 *
4310 * @param name The name of the desired item.
4311 *
4312 * @return the value of an item that previously added with putExtra()
4313 * or null if no CharSequence value was found.
4314 *
4315 * @see #putExtra(String, CharSequence)
4316 */
4317 public CharSequence getCharSequenceExtra(String name) {
4318 return mExtras == null ? null : mExtras.getCharSequence(name);
4319 }
4320
4321 /**
4322 * Retrieve extended data from the intent.
4323 *
4324 * @param name The name of the desired item.
4325 *
4326 * @return the value of an item that previously added with putExtra()
4327 * or null if no Parcelable value was found.
4328 *
4329 * @see #putExtra(String, Parcelable)
4330 */
4331 public <T extends Parcelable> T getParcelableExtra(String name) {
4332 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4333 }
4334
4335 /**
4336 * Retrieve extended data from the intent.
4337 *
4338 * @param name The name of the desired item.
4339 *
4340 * @return the value of an item that previously added with putExtra()
4341 * or null if no Parcelable[] value was found.
4342 *
4343 * @see #putExtra(String, Parcelable[])
4344 */
4345 public Parcelable[] getParcelableArrayExtra(String name) {
4346 return mExtras == null ? null : mExtras.getParcelableArray(name);
4347 }
4348
4349 /**
4350 * Retrieve extended data from the intent.
4351 *
4352 * @param name The name of the desired item.
4353 *
4354 * @return the value of an item that previously added with putExtra()
4355 * or null if no ArrayList<Parcelable> value was found.
4356 *
4357 * @see #putParcelableArrayListExtra(String, ArrayList)
4358 */
4359 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4360 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4361 }
4362
4363 /**
4364 * Retrieve extended data from the intent.
4365 *
4366 * @param name The name of the desired item.
4367 *
4368 * @return the value of an item that previously added with putExtra()
4369 * or null if no Serializable value was found.
4370 *
4371 * @see #putExtra(String, Serializable)
4372 */
4373 public Serializable getSerializableExtra(String name) {
4374 return mExtras == null ? null : mExtras.getSerializable(name);
4375 }
4376
4377 /**
4378 * Retrieve extended data from the intent.
4379 *
4380 * @param name The name of the desired item.
4381 *
4382 * @return the value of an item that previously added with putExtra()
4383 * or null if no ArrayList<Integer> value was found.
4384 *
4385 * @see #putIntegerArrayListExtra(String, ArrayList)
4386 */
4387 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4388 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4389 }
4390
4391 /**
4392 * Retrieve extended data from the intent.
4393 *
4394 * @param name The name of the desired item.
4395 *
4396 * @return the value of an item that previously added with putExtra()
4397 * or null if no ArrayList<String> value was found.
4398 *
4399 * @see #putStringArrayListExtra(String, ArrayList)
4400 */
4401 public ArrayList<String> getStringArrayListExtra(String name) {
4402 return mExtras == null ? null : mExtras.getStringArrayList(name);
4403 }
4404
4405 /**
4406 * Retrieve extended data from the intent.
4407 *
4408 * @param name The name of the desired item.
4409 *
4410 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004411 * or null if no ArrayList<CharSequence> value was found.
4412 *
4413 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4414 */
4415 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4416 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4417 }
4418
4419 /**
4420 * Retrieve extended data from the intent.
4421 *
4422 * @param name The name of the desired item.
4423 *
4424 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004425 * or null if no boolean array value was found.
4426 *
4427 * @see #putExtra(String, boolean[])
4428 */
4429 public boolean[] getBooleanArrayExtra(String name) {
4430 return mExtras == null ? null : mExtras.getBooleanArray(name);
4431 }
4432
4433 /**
4434 * Retrieve extended data from the intent.
4435 *
4436 * @param name The name of the desired item.
4437 *
4438 * @return the value of an item that previously added with putExtra()
4439 * or null if no byte array value was found.
4440 *
4441 * @see #putExtra(String, byte[])
4442 */
4443 public byte[] getByteArrayExtra(String name) {
4444 return mExtras == null ? null : mExtras.getByteArray(name);
4445 }
4446
4447 /**
4448 * Retrieve extended data from the intent.
4449 *
4450 * @param name The name of the desired item.
4451 *
4452 * @return the value of an item that previously added with putExtra()
4453 * or null if no short array value was found.
4454 *
4455 * @see #putExtra(String, short[])
4456 */
4457 public short[] getShortArrayExtra(String name) {
4458 return mExtras == null ? null : mExtras.getShortArray(name);
4459 }
4460
4461 /**
4462 * Retrieve extended data from the intent.
4463 *
4464 * @param name The name of the desired item.
4465 *
4466 * @return the value of an item that previously added with putExtra()
4467 * or null if no char array value was found.
4468 *
4469 * @see #putExtra(String, char[])
4470 */
4471 public char[] getCharArrayExtra(String name) {
4472 return mExtras == null ? null : mExtras.getCharArray(name);
4473 }
4474
4475 /**
4476 * Retrieve extended data from the intent.
4477 *
4478 * @param name The name of the desired item.
4479 *
4480 * @return the value of an item that previously added with putExtra()
4481 * or null if no int array value was found.
4482 *
4483 * @see #putExtra(String, int[])
4484 */
4485 public int[] getIntArrayExtra(String name) {
4486 return mExtras == null ? null : mExtras.getIntArray(name);
4487 }
4488
4489 /**
4490 * Retrieve extended data from the intent.
4491 *
4492 * @param name The name of the desired item.
4493 *
4494 * @return the value of an item that previously added with putExtra()
4495 * or null if no long array value was found.
4496 *
4497 * @see #putExtra(String, long[])
4498 */
4499 public long[] getLongArrayExtra(String name) {
4500 return mExtras == null ? null : mExtras.getLongArray(name);
4501 }
4502
4503 /**
4504 * Retrieve extended data from the intent.
4505 *
4506 * @param name The name of the desired item.
4507 *
4508 * @return the value of an item that previously added with putExtra()
4509 * or null if no float array value was found.
4510 *
4511 * @see #putExtra(String, float[])
4512 */
4513 public float[] getFloatArrayExtra(String name) {
4514 return mExtras == null ? null : mExtras.getFloatArray(name);
4515 }
4516
4517 /**
4518 * Retrieve extended data from the intent.
4519 *
4520 * @param name The name of the desired item.
4521 *
4522 * @return the value of an item that previously added with putExtra()
4523 * or null if no double array value was found.
4524 *
4525 * @see #putExtra(String, double[])
4526 */
4527 public double[] getDoubleArrayExtra(String name) {
4528 return mExtras == null ? null : mExtras.getDoubleArray(name);
4529 }
4530
4531 /**
4532 * Retrieve extended data from the intent.
4533 *
4534 * @param name The name of the desired item.
4535 *
4536 * @return the value of an item that previously added with putExtra()
4537 * or null if no String array value was found.
4538 *
4539 * @see #putExtra(String, String[])
4540 */
4541 public String[] getStringArrayExtra(String name) {
4542 return mExtras == null ? null : mExtras.getStringArray(name);
4543 }
4544
4545 /**
4546 * Retrieve extended data from the intent.
4547 *
4548 * @param name The name of the desired item.
4549 *
4550 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004551 * or null if no CharSequence array value was found.
4552 *
4553 * @see #putExtra(String, CharSequence[])
4554 */
4555 public CharSequence[] getCharSequenceArrayExtra(String name) {
4556 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4557 }
4558
4559 /**
4560 * Retrieve extended data from the intent.
4561 *
4562 * @param name The name of the desired item.
4563 *
4564 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004565 * or null if no Bundle value was found.
4566 *
4567 * @see #putExtra(String, Bundle)
4568 */
4569 public Bundle getBundleExtra(String name) {
4570 return mExtras == null ? null : mExtras.getBundle(name);
4571 }
4572
4573 /**
4574 * Retrieve extended data from the intent.
4575 *
4576 * @param name The name of the desired item.
4577 *
4578 * @return the value of an item that previously added with putExtra()
4579 * or null if no IBinder value was found.
4580 *
4581 * @see #putExtra(String, IBinder)
4582 *
4583 * @deprecated
4584 * @hide
4585 */
4586 @Deprecated
4587 public IBinder getIBinderExtra(String name) {
4588 return mExtras == null ? null : mExtras.getIBinder(name);
4589 }
4590
4591 /**
4592 * Retrieve extended data from the intent.
4593 *
4594 * @param name The name of the desired item.
4595 * @param defaultValue The default value to return in case no item is
4596 * associated with the key 'name'
4597 *
4598 * @return the value of an item that previously added with putExtra()
4599 * or defaultValue if none was found.
4600 *
4601 * @see #putExtra
4602 *
4603 * @deprecated
4604 * @hide
4605 */
4606 @Deprecated
4607 public Object getExtra(String name, Object defaultValue) {
4608 Object result = defaultValue;
4609 if (mExtras != null) {
4610 Object result2 = mExtras.get(name);
4611 if (result2 != null) {
4612 result = result2;
4613 }
4614 }
4615
4616 return result;
4617 }
4618
4619 /**
4620 * Retrieves a map of extended data from the intent.
4621 *
4622 * @return the map of all extras previously added with putExtra(),
4623 * or null if none have been added.
4624 */
4625 public Bundle getExtras() {
4626 return (mExtras != null)
4627 ? new Bundle(mExtras)
4628 : null;
4629 }
4630
4631 /**
4632 * Retrieve any special flags associated with this intent. You will
4633 * normally just set them with {@link #setFlags} and let the system
4634 * take the appropriate action with them.
4635 *
4636 * @return int The currently set flags.
4637 *
4638 * @see #setFlags
4639 */
4640 public int getFlags() {
4641 return mFlags;
4642 }
4643
Dianne Hackborne7f97212011-02-24 14:40:20 -08004644 /** @hide */
4645 public boolean isExcludingStopped() {
4646 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4647 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4648 }
4649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004651 * Retrieve the application package name this Intent is limited to. When
4652 * resolving an Intent, if non-null this limits the resolution to only
4653 * components in the given application package.
4654 *
4655 * @return The name of the application package for the Intent.
4656 *
4657 * @see #resolveActivity
4658 * @see #setPackage
4659 */
4660 public String getPackage() {
4661 return mPackage;
4662 }
4663
4664 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665 * Retrieve the concrete component associated with the intent. When receiving
4666 * an intent, this is the component that was found to best handle it (that is,
4667 * yourself) and will always be non-null; in all other cases it will be
4668 * null unless explicitly set.
4669 *
4670 * @return The name of the application component to handle the intent.
4671 *
4672 * @see #resolveActivity
4673 * @see #setComponent
4674 */
4675 public ComponentName getComponent() {
4676 return mComponent;
4677 }
4678
4679 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004680 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4681 * used as a hint to the receiver for animations and the like. Null means that there
4682 * is no source bounds.
4683 */
4684 public Rect getSourceBounds() {
4685 return mSourceBounds;
4686 }
4687
4688 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004689 * Return the Activity component that should be used to handle this intent.
4690 * The appropriate component is determined based on the information in the
4691 * intent, evaluated as follows:
4692 *
4693 * <p>If {@link #getComponent} returns an explicit class, that is returned
4694 * without any further consideration.
4695 *
4696 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4697 * category to be considered.
4698 *
4699 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4700 * action.
4701 *
4702 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4703 * this type.
4704 *
4705 * <p>If {@link #addCategory} has added any categories, the activity must
4706 * handle ALL of the categories specified.
4707 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004708 * <p>If {@link #getPackage} is non-NULL, only activity components in
4709 * that application package will be considered.
4710 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004711 * <p>If there are no activities that satisfy all of these conditions, a
4712 * null string is returned.
4713 *
4714 * <p>If multiple activities are found to satisfy the intent, the one with
4715 * the highest priority will be used. If there are multiple activities
4716 * with the same priority, the system will either pick the best activity
4717 * based on user preference, or resolve to a system class that will allow
4718 * the user to pick an activity and forward from there.
4719 *
4720 * <p>This method is implemented simply by calling
4721 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4722 * true.</p>
4723 * <p> This API is called for you as part of starting an activity from an
4724 * intent. You do not normally need to call it yourself.</p>
4725 *
4726 * @param pm The package manager with which to resolve the Intent.
4727 *
4728 * @return Name of the component implementing an activity that can
4729 * display the intent.
4730 *
4731 * @see #setComponent
4732 * @see #getComponent
4733 * @see #resolveActivityInfo
4734 */
4735 public ComponentName resolveActivity(PackageManager pm) {
4736 if (mComponent != null) {
4737 return mComponent;
4738 }
4739
4740 ResolveInfo info = pm.resolveActivity(
4741 this, PackageManager.MATCH_DEFAULT_ONLY);
4742 if (info != null) {
4743 return new ComponentName(
4744 info.activityInfo.applicationInfo.packageName,
4745 info.activityInfo.name);
4746 }
4747
4748 return null;
4749 }
4750
4751 /**
4752 * Resolve the Intent into an {@link ActivityInfo}
4753 * describing the activity that should execute the intent. Resolution
4754 * follows the same rules as described for {@link #resolveActivity}, but
4755 * you get back the completely information about the resolved activity
4756 * instead of just its class name.
4757 *
4758 * @param pm The package manager with which to resolve the Intent.
4759 * @param flags Addition information to retrieve as per
4760 * {@link PackageManager#getActivityInfo(ComponentName, int)
4761 * PackageManager.getActivityInfo()}.
4762 *
4763 * @return PackageManager.ActivityInfo
4764 *
4765 * @see #resolveActivity
4766 */
4767 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4768 ActivityInfo ai = null;
4769 if (mComponent != null) {
4770 try {
4771 ai = pm.getActivityInfo(mComponent, flags);
4772 } catch (PackageManager.NameNotFoundException e) {
4773 // ignore
4774 }
4775 } else {
4776 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004777 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004778 if (info != null) {
4779 ai = info.activityInfo;
4780 }
4781 }
4782
4783 return ai;
4784 }
4785
4786 /**
4787 * Set the general action to be performed.
4788 *
4789 * @param action An action name, such as ACTION_VIEW. Application-specific
4790 * actions should be prefixed with the vendor's package name.
4791 *
4792 * @return Returns the same Intent object, for chaining multiple calls
4793 * into a single statement.
4794 *
4795 * @see #getAction
4796 */
4797 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004798 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004799 return this;
4800 }
4801
4802 /**
4803 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004804 * clears any type that was previously set by {@link #setType} or
4805 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 *
Nick Pellyccae4122012-01-09 14:12:58 -08004807 * <p><em>Note: scheme matching in the Android framework is
4808 * case-sensitive, unlike the formal RFC. As a result,
4809 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004810 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004811 * {@link #setDataAndNormalize}
4812 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004813 *
Nick Pellyccae4122012-01-09 14:12:58 -08004814 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004815 *
4816 * @return Returns the same Intent object, for chaining multiple calls
4817 * into a single statement.
4818 *
4819 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004820 * @see #setDataAndNormalize
4821 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004822 */
4823 public Intent setData(Uri data) {
4824 mData = data;
4825 mType = null;
4826 return this;
4827 }
4828
4829 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004830 * Normalize and set the data this intent is operating on.
4831 *
4832 * <p>This method automatically clears any type that was
4833 * previously set (for example, by {@link #setType}).
4834 *
4835 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004836 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004837 * so really this is just a convenience method for
4838 * <pre>
4839 * setData(data.normalize())
4840 * </pre>
4841 *
4842 * @param data The Uri of the data this intent is now targeting.
4843 *
4844 * @return Returns the same Intent object, for chaining multiple calls
4845 * into a single statement.
4846 *
4847 * @see #getData
4848 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004849 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004850 */
4851 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004852 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004853 }
4854
4855 /**
4856 * Set an explicit MIME data type.
4857 *
4858 * <p>This is used to create intents that only specify a type and not data,
4859 * for example to indicate the type of data to return.
4860 *
4861 * <p>This method automatically clears any data that was
4862 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004863 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004864 * <p><em>Note: MIME type matching in the Android framework is
4865 * case-sensitive, unlike formal RFC MIME types. As a result,
4866 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004867 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4868 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004869 *
4870 * @param type The MIME type of the data being handled by this intent.
4871 *
4872 * @return Returns the same Intent object, for chaining multiple calls
4873 * into a single statement.
4874 *
4875 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004876 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004877 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004878 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004879 */
4880 public Intent setType(String type) {
4881 mData = null;
4882 mType = type;
4883 return this;
4884 }
4885
4886 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004887 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004888 *
Nick Pellyccae4122012-01-09 14:12:58 -08004889 * <p>This is used to create intents that only specify a type and not data,
4890 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004891 *
Nick Pellyccae4122012-01-09 14:12:58 -08004892 * <p>This method automatically clears any data that was
4893 * previously set (for example by {@link #setData}).
4894 *
4895 * <p>The MIME type is normalized using
4896 * {@link #normalizeMimeType} before it is set,
4897 * so really this is just a convenience method for
4898 * <pre>
4899 * setType(Intent.normalizeMimeType(type))
4900 * </pre>
4901 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004902 * @param type The MIME type of the data being handled by this intent.
4903 *
4904 * @return Returns the same Intent object, for chaining multiple calls
4905 * into a single statement.
4906 *
Nick Pellyccae4122012-01-09 14:12:58 -08004907 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004908 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004909 * @see #normalizeMimeType
4910 */
4911 public Intent setTypeAndNormalize(String type) {
4912 return setType(normalizeMimeType(type));
4913 }
4914
4915 /**
4916 * (Usually optional) Set the data for the intent along with an explicit
4917 * MIME data type. This method should very rarely be used -- it allows you
4918 * to override the MIME type that would ordinarily be inferred from the
4919 * data with your own type given here.
4920 *
4921 * <p><em>Note: MIME type and Uri scheme matching in the
4922 * Android framework is case-sensitive, unlike the formal RFC definitions.
4923 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004924 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004925 * {@link #setDataAndTypeAndNormalize}
4926 * to ensure that they are converted to lower case.</em>
4927 *
4928 * @param data The Uri of the data this intent is now targeting.
4929 * @param type The MIME type of the data being handled by this intent.
4930 *
4931 * @return Returns the same Intent object, for chaining multiple calls
4932 * into a single statement.
4933 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004934 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004935 * @see #setData
4936 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004937 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004938 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004939 */
4940 public Intent setDataAndType(Uri data, String type) {
4941 mData = data;
4942 mType = type;
4943 return this;
4944 }
4945
4946 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004947 * (Usually optional) Normalize and set both the data Uri and an explicit
4948 * MIME data type. This method should very rarely be used -- it allows you
4949 * to override the MIME type that would ordinarily be inferred from the
4950 * data with your own type given here.
4951 *
4952 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004953 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004954 * before they are set, so really this is just a convenience method for
4955 * <pre>
4956 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4957 * </pre>
4958 *
4959 * @param data The Uri of the data this intent is now targeting.
4960 * @param type The MIME type of the data being handled by this intent.
4961 *
4962 * @return Returns the same Intent object, for chaining multiple calls
4963 * into a single statement.
4964 *
4965 * @see #setType
4966 * @see #setData
4967 * @see #setDataAndType
4968 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004969 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004970 */
4971 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004972 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004973 }
4974
4975 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004976 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004977 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004978 * activities that provide <em>all</em> of the requested categories will be
4979 * used.
4980 *
4981 * @param category The desired category. This can be either one of the
4982 * predefined Intent categories, or a custom category in your own
4983 * namespace.
4984 *
4985 * @return Returns the same Intent object, for chaining multiple calls
4986 * into a single statement.
4987 *
4988 * @see #hasCategory
4989 * @see #removeCategory
4990 */
4991 public Intent addCategory(String category) {
4992 if (mCategories == null) {
4993 mCategories = new HashSet<String>();
4994 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004995 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004996 return this;
4997 }
4998
4999 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005000 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005001 *
5002 * @param category The category to remove.
5003 *
5004 * @see #addCategory
5005 */
5006 public void removeCategory(String category) {
5007 if (mCategories != null) {
5008 mCategories.remove(category);
5009 if (mCategories.size() == 0) {
5010 mCategories = null;
5011 }
5012 }
5013 }
5014
5015 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005016 * Set a selector for this Intent. This is a modification to the kinds of
5017 * things the Intent will match. If the selector is set, it will be used
5018 * when trying to find entities that can handle the Intent, instead of the
5019 * main contents of the Intent. This allows you build an Intent containing
5020 * a generic protocol while targeting it more specifically.
5021 *
5022 * <p>An example of where this may be used is with things like
5023 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5024 * Intent that will launch the Browser application. However, the correct
5025 * main entry point of an application is actually {@link #ACTION_MAIN}
5026 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5027 * used to specify the actual Activity to launch. If you launch the browser
5028 * with something different, undesired behavior may happen if the user has
5029 * previously or later launches it the normal way, since they do not match.
5030 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5031 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5032 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5033 *
5034 * <p>Setting a selector does not impact the behavior of
5035 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5036 * desired behavior of a selector -- it does not impact the base meaning
5037 * of the Intent, just what kinds of things will be matched against it
5038 * when determining who can handle it.</p>
5039 *
5040 * <p>You can not use both a selector and {@link #setPackage(String)} on
5041 * the same base Intent.</p>
5042 *
5043 * @param selector The desired selector Intent; set to null to not use
5044 * a special selector.
5045 */
5046 public void setSelector(Intent selector) {
5047 if (selector == this) {
5048 throw new IllegalArgumentException(
5049 "Intent being set as a selector of itself");
5050 }
5051 if (selector != null && mPackage != null) {
5052 throw new IllegalArgumentException(
5053 "Can't set selector when package name is already set");
5054 }
5055 mSelector = selector;
5056 }
5057
5058 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005059 * Set a {@link ClipData} associated with this Intent. This replaces any
5060 * previously set ClipData.
5061 *
5062 * <p>The ClipData in an intent is not used for Intent matching or other
5063 * such operations. Semantically it is like extras, used to transmit
5064 * additional data with the Intent. The main feature of using this over
5065 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5066 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5067 * items included in the clip data. This is useful, in particular, if
5068 * you want to transmit an Intent containing multiple <code>content:</code>
5069 * URIs for which the recipient may not have global permission to access the
5070 * content provider.
5071 *
5072 * <p>If the ClipData contains items that are themselves Intents, any
5073 * grant flags in those Intents will be ignored. Only the top-level flags
5074 * of the main Intent are respected, and will be applied to all Uri or
5075 * Intent items in the clip (or sub-items of the clip).
5076 *
5077 * <p>The MIME type, label, and icon in the ClipData object are not
5078 * directly used by Intent. Applications should generally rely on the
5079 * MIME type of the Intent itself, not what it may find in the ClipData.
5080 * A common practice is to construct a ClipData for use with an Intent
5081 * with a MIME type of "*\/*".
5082 *
5083 * @param clip The new clip to set. May be null to clear the current clip.
5084 */
5085 public void setClipData(ClipData clip) {
5086 mClipData = clip;
5087 }
5088
5089 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005090 * Add extended data to the intent. The name must include a package
5091 * prefix, for example the app com.android.contacts would use names
5092 * like "com.android.contacts.ShowAll".
5093 *
5094 * @param name The name of the extra data, with package prefix.
5095 * @param value The boolean data value.
5096 *
5097 * @return Returns the same Intent object, for chaining multiple calls
5098 * into a single statement.
5099 *
5100 * @see #putExtras
5101 * @see #removeExtra
5102 * @see #getBooleanExtra(String, boolean)
5103 */
5104 public Intent putExtra(String name, boolean value) {
5105 if (mExtras == null) {
5106 mExtras = new Bundle();
5107 }
5108 mExtras.putBoolean(name, value);
5109 return this;
5110 }
5111
5112 /**
5113 * Add extended data to the intent. The name must include a package
5114 * prefix, for example the app com.android.contacts would use names
5115 * like "com.android.contacts.ShowAll".
5116 *
5117 * @param name The name of the extra data, with package prefix.
5118 * @param value The byte data value.
5119 *
5120 * @return Returns the same Intent object, for chaining multiple calls
5121 * into a single statement.
5122 *
5123 * @see #putExtras
5124 * @see #removeExtra
5125 * @see #getByteExtra(String, byte)
5126 */
5127 public Intent putExtra(String name, byte value) {
5128 if (mExtras == null) {
5129 mExtras = new Bundle();
5130 }
5131 mExtras.putByte(name, value);
5132 return this;
5133 }
5134
5135 /**
5136 * Add extended data to the intent. The name must include a package
5137 * prefix, for example the app com.android.contacts would use names
5138 * like "com.android.contacts.ShowAll".
5139 *
5140 * @param name The name of the extra data, with package prefix.
5141 * @param value The char data value.
5142 *
5143 * @return Returns the same Intent object, for chaining multiple calls
5144 * into a single statement.
5145 *
5146 * @see #putExtras
5147 * @see #removeExtra
5148 * @see #getCharExtra(String, char)
5149 */
5150 public Intent putExtra(String name, char value) {
5151 if (mExtras == null) {
5152 mExtras = new Bundle();
5153 }
5154 mExtras.putChar(name, value);
5155 return this;
5156 }
5157
5158 /**
5159 * Add extended data to the intent. The name must include a package
5160 * prefix, for example the app com.android.contacts would use names
5161 * like "com.android.contacts.ShowAll".
5162 *
5163 * @param name The name of the extra data, with package prefix.
5164 * @param value The short data value.
5165 *
5166 * @return Returns the same Intent object, for chaining multiple calls
5167 * into a single statement.
5168 *
5169 * @see #putExtras
5170 * @see #removeExtra
5171 * @see #getShortExtra(String, short)
5172 */
5173 public Intent putExtra(String name, short value) {
5174 if (mExtras == null) {
5175 mExtras = new Bundle();
5176 }
5177 mExtras.putShort(name, value);
5178 return this;
5179 }
5180
5181 /**
5182 * Add extended data to the intent. The name must include a package
5183 * prefix, for example the app com.android.contacts would use names
5184 * like "com.android.contacts.ShowAll".
5185 *
5186 * @param name The name of the extra data, with package prefix.
5187 * @param value The integer data value.
5188 *
5189 * @return Returns the same Intent object, for chaining multiple calls
5190 * into a single statement.
5191 *
5192 * @see #putExtras
5193 * @see #removeExtra
5194 * @see #getIntExtra(String, int)
5195 */
5196 public Intent putExtra(String name, int value) {
5197 if (mExtras == null) {
5198 mExtras = new Bundle();
5199 }
5200 mExtras.putInt(name, value);
5201 return this;
5202 }
5203
5204 /**
5205 * Add extended data to the intent. The name must include a package
5206 * prefix, for example the app com.android.contacts would use names
5207 * like "com.android.contacts.ShowAll".
5208 *
5209 * @param name The name of the extra data, with package prefix.
5210 * @param value The long data value.
5211 *
5212 * @return Returns the same Intent object, for chaining multiple calls
5213 * into a single statement.
5214 *
5215 * @see #putExtras
5216 * @see #removeExtra
5217 * @see #getLongExtra(String, long)
5218 */
5219 public Intent putExtra(String name, long value) {
5220 if (mExtras == null) {
5221 mExtras = new Bundle();
5222 }
5223 mExtras.putLong(name, value);
5224 return this;
5225 }
5226
5227 /**
5228 * Add extended data to the intent. The name must include a package
5229 * prefix, for example the app com.android.contacts would use names
5230 * like "com.android.contacts.ShowAll".
5231 *
5232 * @param name The name of the extra data, with package prefix.
5233 * @param value The float data value.
5234 *
5235 * @return Returns the same Intent object, for chaining multiple calls
5236 * into a single statement.
5237 *
5238 * @see #putExtras
5239 * @see #removeExtra
5240 * @see #getFloatExtra(String, float)
5241 */
5242 public Intent putExtra(String name, float value) {
5243 if (mExtras == null) {
5244 mExtras = new Bundle();
5245 }
5246 mExtras.putFloat(name, value);
5247 return this;
5248 }
5249
5250 /**
5251 * Add extended data to the intent. The name must include a package
5252 * prefix, for example the app com.android.contacts would use names
5253 * like "com.android.contacts.ShowAll".
5254 *
5255 * @param name The name of the extra data, with package prefix.
5256 * @param value The double data value.
5257 *
5258 * @return Returns the same Intent object, for chaining multiple calls
5259 * into a single statement.
5260 *
5261 * @see #putExtras
5262 * @see #removeExtra
5263 * @see #getDoubleExtra(String, double)
5264 */
5265 public Intent putExtra(String name, double value) {
5266 if (mExtras == null) {
5267 mExtras = new Bundle();
5268 }
5269 mExtras.putDouble(name, value);
5270 return this;
5271 }
5272
5273 /**
5274 * Add extended data to the intent. The name must include a package
5275 * prefix, for example the app com.android.contacts would use names
5276 * like "com.android.contacts.ShowAll".
5277 *
5278 * @param name The name of the extra data, with package prefix.
5279 * @param value The String data value.
5280 *
5281 * @return Returns the same Intent object, for chaining multiple calls
5282 * into a single statement.
5283 *
5284 * @see #putExtras
5285 * @see #removeExtra
5286 * @see #getStringExtra(String)
5287 */
5288 public Intent putExtra(String name, String value) {
5289 if (mExtras == null) {
5290 mExtras = new Bundle();
5291 }
5292 mExtras.putString(name, value);
5293 return this;
5294 }
5295
5296 /**
5297 * Add extended data to the intent. The name must include a package
5298 * prefix, for example the app com.android.contacts would use names
5299 * like "com.android.contacts.ShowAll".
5300 *
5301 * @param name The name of the extra data, with package prefix.
5302 * @param value The CharSequence data value.
5303 *
5304 * @return Returns the same Intent object, for chaining multiple calls
5305 * into a single statement.
5306 *
5307 * @see #putExtras
5308 * @see #removeExtra
5309 * @see #getCharSequenceExtra(String)
5310 */
5311 public Intent putExtra(String name, CharSequence value) {
5312 if (mExtras == null) {
5313 mExtras = new Bundle();
5314 }
5315 mExtras.putCharSequence(name, value);
5316 return this;
5317 }
5318
5319 /**
5320 * Add extended data to the intent. The name must include a package
5321 * prefix, for example the app com.android.contacts would use names
5322 * like "com.android.contacts.ShowAll".
5323 *
5324 * @param name The name of the extra data, with package prefix.
5325 * @param value The Parcelable data value.
5326 *
5327 * @return Returns the same Intent object, for chaining multiple calls
5328 * into a single statement.
5329 *
5330 * @see #putExtras
5331 * @see #removeExtra
5332 * @see #getParcelableExtra(String)
5333 */
5334 public Intent putExtra(String name, Parcelable value) {
5335 if (mExtras == null) {
5336 mExtras = new Bundle();
5337 }
5338 mExtras.putParcelable(name, value);
5339 return this;
5340 }
5341
5342 /**
5343 * Add extended data to the intent. The name must include a package
5344 * prefix, for example the app com.android.contacts would use names
5345 * like "com.android.contacts.ShowAll".
5346 *
5347 * @param name The name of the extra data, with package prefix.
5348 * @param value The Parcelable[] data value.
5349 *
5350 * @return Returns the same Intent object, for chaining multiple calls
5351 * into a single statement.
5352 *
5353 * @see #putExtras
5354 * @see #removeExtra
5355 * @see #getParcelableArrayExtra(String)
5356 */
5357 public Intent putExtra(String name, Parcelable[] value) {
5358 if (mExtras == null) {
5359 mExtras = new Bundle();
5360 }
5361 mExtras.putParcelableArray(name, value);
5362 return this;
5363 }
5364
5365 /**
5366 * Add extended data to the intent. The name must include a package
5367 * prefix, for example the app com.android.contacts would use names
5368 * like "com.android.contacts.ShowAll".
5369 *
5370 * @param name The name of the extra data, with package prefix.
5371 * @param value The ArrayList<Parcelable> data value.
5372 *
5373 * @return Returns the same Intent object, for chaining multiple calls
5374 * into a single statement.
5375 *
5376 * @see #putExtras
5377 * @see #removeExtra
5378 * @see #getParcelableArrayListExtra(String)
5379 */
5380 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5381 if (mExtras == null) {
5382 mExtras = new Bundle();
5383 }
5384 mExtras.putParcelableArrayList(name, value);
5385 return this;
5386 }
5387
5388 /**
5389 * Add extended data to the intent. The name must include a package
5390 * prefix, for example the app com.android.contacts would use names
5391 * like "com.android.contacts.ShowAll".
5392 *
5393 * @param name The name of the extra data, with package prefix.
5394 * @param value The ArrayList<Integer> data value.
5395 *
5396 * @return Returns the same Intent object, for chaining multiple calls
5397 * into a single statement.
5398 *
5399 * @see #putExtras
5400 * @see #removeExtra
5401 * @see #getIntegerArrayListExtra(String)
5402 */
5403 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5404 if (mExtras == null) {
5405 mExtras = new Bundle();
5406 }
5407 mExtras.putIntegerArrayList(name, value);
5408 return this;
5409 }
5410
5411 /**
5412 * Add extended data to the intent. The name must include a package
5413 * prefix, for example the app com.android.contacts would use names
5414 * like "com.android.contacts.ShowAll".
5415 *
5416 * @param name The name of the extra data, with package prefix.
5417 * @param value The ArrayList<String> data value.
5418 *
5419 * @return Returns the same Intent object, for chaining multiple calls
5420 * into a single statement.
5421 *
5422 * @see #putExtras
5423 * @see #removeExtra
5424 * @see #getStringArrayListExtra(String)
5425 */
5426 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5427 if (mExtras == null) {
5428 mExtras = new Bundle();
5429 }
5430 mExtras.putStringArrayList(name, value);
5431 return this;
5432 }
5433
5434 /**
5435 * Add extended data to the intent. The name must include a package
5436 * prefix, for example the app com.android.contacts would use names
5437 * like "com.android.contacts.ShowAll".
5438 *
5439 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005440 * @param value The ArrayList<CharSequence> data value.
5441 *
5442 * @return Returns the same Intent object, for chaining multiple calls
5443 * into a single statement.
5444 *
5445 * @see #putExtras
5446 * @see #removeExtra
5447 * @see #getCharSequenceArrayListExtra(String)
5448 */
5449 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5450 if (mExtras == null) {
5451 mExtras = new Bundle();
5452 }
5453 mExtras.putCharSequenceArrayList(name, value);
5454 return this;
5455 }
5456
5457 /**
5458 * Add extended data to the intent. The name must include a package
5459 * prefix, for example the app com.android.contacts would use names
5460 * like "com.android.contacts.ShowAll".
5461 *
5462 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005463 * @param value The Serializable data value.
5464 *
5465 * @return Returns the same Intent object, for chaining multiple calls
5466 * into a single statement.
5467 *
5468 * @see #putExtras
5469 * @see #removeExtra
5470 * @see #getSerializableExtra(String)
5471 */
5472 public Intent putExtra(String name, Serializable value) {
5473 if (mExtras == null) {
5474 mExtras = new Bundle();
5475 }
5476 mExtras.putSerializable(name, value);
5477 return this;
5478 }
5479
5480 /**
5481 * Add extended data to the intent. The name must include a package
5482 * prefix, for example the app com.android.contacts would use names
5483 * like "com.android.contacts.ShowAll".
5484 *
5485 * @param name The name of the extra data, with package prefix.
5486 * @param value The boolean array data value.
5487 *
5488 * @return Returns the same Intent object, for chaining multiple calls
5489 * into a single statement.
5490 *
5491 * @see #putExtras
5492 * @see #removeExtra
5493 * @see #getBooleanArrayExtra(String)
5494 */
5495 public Intent putExtra(String name, boolean[] value) {
5496 if (mExtras == null) {
5497 mExtras = new Bundle();
5498 }
5499 mExtras.putBooleanArray(name, value);
5500 return this;
5501 }
5502
5503 /**
5504 * Add extended data to the intent. The name must include a package
5505 * prefix, for example the app com.android.contacts would use names
5506 * like "com.android.contacts.ShowAll".
5507 *
5508 * @param name The name of the extra data, with package prefix.
5509 * @param value The byte array data value.
5510 *
5511 * @return Returns the same Intent object, for chaining multiple calls
5512 * into a single statement.
5513 *
5514 * @see #putExtras
5515 * @see #removeExtra
5516 * @see #getByteArrayExtra(String)
5517 */
5518 public Intent putExtra(String name, byte[] value) {
5519 if (mExtras == null) {
5520 mExtras = new Bundle();
5521 }
5522 mExtras.putByteArray(name, value);
5523 return this;
5524 }
5525
5526 /**
5527 * Add extended data to the intent. The name must include a package
5528 * prefix, for example the app com.android.contacts would use names
5529 * like "com.android.contacts.ShowAll".
5530 *
5531 * @param name The name of the extra data, with package prefix.
5532 * @param value The short array data value.
5533 *
5534 * @return Returns the same Intent object, for chaining multiple calls
5535 * into a single statement.
5536 *
5537 * @see #putExtras
5538 * @see #removeExtra
5539 * @see #getShortArrayExtra(String)
5540 */
5541 public Intent putExtra(String name, short[] value) {
5542 if (mExtras == null) {
5543 mExtras = new Bundle();
5544 }
5545 mExtras.putShortArray(name, value);
5546 return this;
5547 }
5548
5549 /**
5550 * Add extended data to the intent. The name must include a package
5551 * prefix, for example the app com.android.contacts would use names
5552 * like "com.android.contacts.ShowAll".
5553 *
5554 * @param name The name of the extra data, with package prefix.
5555 * @param value The char array data value.
5556 *
5557 * @return Returns the same Intent object, for chaining multiple calls
5558 * into a single statement.
5559 *
5560 * @see #putExtras
5561 * @see #removeExtra
5562 * @see #getCharArrayExtra(String)
5563 */
5564 public Intent putExtra(String name, char[] value) {
5565 if (mExtras == null) {
5566 mExtras = new Bundle();
5567 }
5568 mExtras.putCharArray(name, value);
5569 return this;
5570 }
5571
5572 /**
5573 * Add extended data to the intent. The name must include a package
5574 * prefix, for example the app com.android.contacts would use names
5575 * like "com.android.contacts.ShowAll".
5576 *
5577 * @param name The name of the extra data, with package prefix.
5578 * @param value The int array data value.
5579 *
5580 * @return Returns the same Intent object, for chaining multiple calls
5581 * into a single statement.
5582 *
5583 * @see #putExtras
5584 * @see #removeExtra
5585 * @see #getIntArrayExtra(String)
5586 */
5587 public Intent putExtra(String name, int[] value) {
5588 if (mExtras == null) {
5589 mExtras = new Bundle();
5590 }
5591 mExtras.putIntArray(name, value);
5592 return this;
5593 }
5594
5595 /**
5596 * Add extended data to the intent. The name must include a package
5597 * prefix, for example the app com.android.contacts would use names
5598 * like "com.android.contacts.ShowAll".
5599 *
5600 * @param name The name of the extra data, with package prefix.
5601 * @param value The byte array data value.
5602 *
5603 * @return Returns the same Intent object, for chaining multiple calls
5604 * into a single statement.
5605 *
5606 * @see #putExtras
5607 * @see #removeExtra
5608 * @see #getLongArrayExtra(String)
5609 */
5610 public Intent putExtra(String name, long[] value) {
5611 if (mExtras == null) {
5612 mExtras = new Bundle();
5613 }
5614 mExtras.putLongArray(name, value);
5615 return this;
5616 }
5617
5618 /**
5619 * Add extended data to the intent. The name must include a package
5620 * prefix, for example the app com.android.contacts would use names
5621 * like "com.android.contacts.ShowAll".
5622 *
5623 * @param name The name of the extra data, with package prefix.
5624 * @param value The float array data value.
5625 *
5626 * @return Returns the same Intent object, for chaining multiple calls
5627 * into a single statement.
5628 *
5629 * @see #putExtras
5630 * @see #removeExtra
5631 * @see #getFloatArrayExtra(String)
5632 */
5633 public Intent putExtra(String name, float[] value) {
5634 if (mExtras == null) {
5635 mExtras = new Bundle();
5636 }
5637 mExtras.putFloatArray(name, value);
5638 return this;
5639 }
5640
5641 /**
5642 * Add extended data to the intent. The name must include a package
5643 * prefix, for example the app com.android.contacts would use names
5644 * like "com.android.contacts.ShowAll".
5645 *
5646 * @param name The name of the extra data, with package prefix.
5647 * @param value The double array data value.
5648 *
5649 * @return Returns the same Intent object, for chaining multiple calls
5650 * into a single statement.
5651 *
5652 * @see #putExtras
5653 * @see #removeExtra
5654 * @see #getDoubleArrayExtra(String)
5655 */
5656 public Intent putExtra(String name, double[] value) {
5657 if (mExtras == null) {
5658 mExtras = new Bundle();
5659 }
5660 mExtras.putDoubleArray(name, value);
5661 return this;
5662 }
5663
5664 /**
5665 * Add extended data to the intent. The name must include a package
5666 * prefix, for example the app com.android.contacts would use names
5667 * like "com.android.contacts.ShowAll".
5668 *
5669 * @param name The name of the extra data, with package prefix.
5670 * @param value The String array data value.
5671 *
5672 * @return Returns the same Intent object, for chaining multiple calls
5673 * into a single statement.
5674 *
5675 * @see #putExtras
5676 * @see #removeExtra
5677 * @see #getStringArrayExtra(String)
5678 */
5679 public Intent putExtra(String name, String[] value) {
5680 if (mExtras == null) {
5681 mExtras = new Bundle();
5682 }
5683 mExtras.putStringArray(name, value);
5684 return this;
5685 }
5686
5687 /**
5688 * Add extended data to the intent. The name must include a package
5689 * prefix, for example the app com.android.contacts would use names
5690 * like "com.android.contacts.ShowAll".
5691 *
5692 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005693 * @param value The CharSequence array data value.
5694 *
5695 * @return Returns the same Intent object, for chaining multiple calls
5696 * into a single statement.
5697 *
5698 * @see #putExtras
5699 * @see #removeExtra
5700 * @see #getCharSequenceArrayExtra(String)
5701 */
5702 public Intent putExtra(String name, CharSequence[] value) {
5703 if (mExtras == null) {
5704 mExtras = new Bundle();
5705 }
5706 mExtras.putCharSequenceArray(name, value);
5707 return this;
5708 }
5709
5710 /**
5711 * Add extended data to the intent. The name must include a package
5712 * prefix, for example the app com.android.contacts would use names
5713 * like "com.android.contacts.ShowAll".
5714 *
5715 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005716 * @param value The Bundle data value.
5717 *
5718 * @return Returns the same Intent object, for chaining multiple calls
5719 * into a single statement.
5720 *
5721 * @see #putExtras
5722 * @see #removeExtra
5723 * @see #getBundleExtra(String)
5724 */
5725 public Intent putExtra(String name, Bundle value) {
5726 if (mExtras == null) {
5727 mExtras = new Bundle();
5728 }
5729 mExtras.putBundle(name, value);
5730 return this;
5731 }
5732
5733 /**
5734 * Add extended data to the intent. The name must include a package
5735 * prefix, for example the app com.android.contacts would use names
5736 * like "com.android.contacts.ShowAll".
5737 *
5738 * @param name The name of the extra data, with package prefix.
5739 * @param value The IBinder data value.
5740 *
5741 * @return Returns the same Intent object, for chaining multiple calls
5742 * into a single statement.
5743 *
5744 * @see #putExtras
5745 * @see #removeExtra
5746 * @see #getIBinderExtra(String)
5747 *
5748 * @deprecated
5749 * @hide
5750 */
5751 @Deprecated
5752 public Intent putExtra(String name, IBinder value) {
5753 if (mExtras == null) {
5754 mExtras = new Bundle();
5755 }
5756 mExtras.putIBinder(name, value);
5757 return this;
5758 }
5759
5760 /**
5761 * Copy all extras in 'src' in to this intent.
5762 *
5763 * @param src Contains the extras to copy.
5764 *
5765 * @see #putExtra
5766 */
5767 public Intent putExtras(Intent src) {
5768 if (src.mExtras != null) {
5769 if (mExtras == null) {
5770 mExtras = new Bundle(src.mExtras);
5771 } else {
5772 mExtras.putAll(src.mExtras);
5773 }
5774 }
5775 return this;
5776 }
5777
5778 /**
5779 * Add a set of extended data to the intent. The keys must include a package
5780 * prefix, for example the app com.android.contacts would use names
5781 * like "com.android.contacts.ShowAll".
5782 *
5783 * @param extras The Bundle of extras to add to this intent.
5784 *
5785 * @see #putExtra
5786 * @see #removeExtra
5787 */
5788 public Intent putExtras(Bundle extras) {
5789 if (mExtras == null) {
5790 mExtras = new Bundle();
5791 }
5792 mExtras.putAll(extras);
5793 return this;
5794 }
5795
5796 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005797 * Completely replace the extras in the Intent with the extras in the
5798 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005799 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005800 * @param src The exact extras contained in this Intent are copied
5801 * into the target intent, replacing any that were previously there.
5802 */
5803 public Intent replaceExtras(Intent src) {
5804 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5805 return this;
5806 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005807
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005808 /**
5809 * Completely replace the extras in the Intent with the given Bundle of
5810 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005811 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005812 * @param extras The new set of extras in the Intent, or null to erase
5813 * all extras.
5814 */
5815 public Intent replaceExtras(Bundle extras) {
5816 mExtras = extras != null ? new Bundle(extras) : null;
5817 return this;
5818 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005819
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005820 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005821 * Remove extended data from the intent.
5822 *
5823 * @see #putExtra
5824 */
5825 public void removeExtra(String name) {
5826 if (mExtras != null) {
5827 mExtras.remove(name);
5828 if (mExtras.size() == 0) {
5829 mExtras = null;
5830 }
5831 }
5832 }
5833
5834 /**
5835 * Set special flags controlling how this intent is handled. Most values
5836 * here depend on the type of component being executed by the Intent,
5837 * specifically the FLAG_ACTIVITY_* flags are all for use with
5838 * {@link Context#startActivity Context.startActivity()} and the
5839 * FLAG_RECEIVER_* flags are all for use with
5840 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5841 *
Scott Main7aee61f2011-02-08 11:25:01 -08005842 * <p>See the
5843 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5844 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005845 * the behavior of your application.
5846 *
5847 * @param flags The desired flags.
5848 *
5849 * @return Returns the same Intent object, for chaining multiple calls
5850 * into a single statement.
5851 *
5852 * @see #getFlags
5853 * @see #addFlags
5854 *
5855 * @see #FLAG_GRANT_READ_URI_PERMISSION
5856 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5857 * @see #FLAG_DEBUG_LOG_RESOLUTION
5858 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005859 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005860 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005861 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005862 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005863 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5864 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005865 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005866 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5867 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005868 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005869 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005870 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005871 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5872 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005873 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005874 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005875 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005876 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5877 */
5878 public Intent setFlags(int flags) {
5879 mFlags = flags;
5880 return this;
5881 }
5882
5883 /**
5884 * Add additional flags to the intent (or with existing flags
5885 * value).
5886 *
5887 * @param flags The new flags to set.
5888 *
5889 * @return Returns the same Intent object, for chaining multiple calls
5890 * into a single statement.
5891 *
5892 * @see #setFlags
5893 */
5894 public Intent addFlags(int flags) {
5895 mFlags |= flags;
5896 return this;
5897 }
5898
5899 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005900 * (Usually optional) Set an explicit application package name that limits
5901 * the components this Intent will resolve to. If left to the default
5902 * value of null, all components in all applications will considered.
5903 * If non-null, the Intent can only match the components in the given
5904 * application package.
5905 *
5906 * @param packageName The name of the application package to handle the
5907 * intent, or null to allow any application package.
5908 *
5909 * @return Returns the same Intent object, for chaining multiple calls
5910 * into a single statement.
5911 *
5912 * @see #getPackage
5913 * @see #resolveActivity
5914 */
5915 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005916 if (packageName != null && mSelector != null) {
5917 throw new IllegalArgumentException(
5918 "Can't set package name when selector is already set");
5919 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005920 mPackage = packageName;
5921 return this;
5922 }
5923
5924 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005925 * (Usually optional) Explicitly set the component to handle the intent.
5926 * If left with the default value of null, the system will determine the
5927 * appropriate class to use based on the other fields (action, data,
5928 * type, categories) in the Intent. If this class is defined, the
5929 * specified class will always be used regardless of the other fields. You
5930 * should only set this value when you know you absolutely want a specific
5931 * class to be used; otherwise it is better to let the system find the
5932 * appropriate class so that you will respect the installed applications
5933 * and user preferences.
5934 *
5935 * @param component The name of the application component to handle the
5936 * intent, or null to let the system find one for you.
5937 *
5938 * @return Returns the same Intent object, for chaining multiple calls
5939 * into a single statement.
5940 *
5941 * @see #setClass
5942 * @see #setClassName(Context, String)
5943 * @see #setClassName(String, String)
5944 * @see #getComponent
5945 * @see #resolveActivity
5946 */
5947 public Intent setComponent(ComponentName component) {
5948 mComponent = component;
5949 return this;
5950 }
5951
5952 /**
5953 * Convenience for calling {@link #setComponent} with an
5954 * explicit class name.
5955 *
5956 * @param packageContext A Context of the application package implementing
5957 * this class.
5958 * @param className The name of a class inside of the application package
5959 * that will be used as the component for this Intent.
5960 *
5961 * @return Returns the same Intent object, for chaining multiple calls
5962 * into a single statement.
5963 *
5964 * @see #setComponent
5965 * @see #setClass
5966 */
5967 public Intent setClassName(Context packageContext, String className) {
5968 mComponent = new ComponentName(packageContext, className);
5969 return this;
5970 }
5971
5972 /**
5973 * Convenience for calling {@link #setComponent} with an
5974 * explicit application package name and class name.
5975 *
5976 * @param packageName The name of the package implementing the desired
5977 * component.
5978 * @param className The name of a class inside of the application package
5979 * that will be used as the component for this Intent.
5980 *
5981 * @return Returns the same Intent object, for chaining multiple calls
5982 * into a single statement.
5983 *
5984 * @see #setComponent
5985 * @see #setClass
5986 */
5987 public Intent setClassName(String packageName, String className) {
5988 mComponent = new ComponentName(packageName, className);
5989 return this;
5990 }
5991
5992 /**
5993 * Convenience for calling {@link #setComponent(ComponentName)} with the
5994 * name returned by a {@link Class} object.
5995 *
5996 * @param packageContext A Context of the application package implementing
5997 * this class.
5998 * @param cls The class name to set, equivalent to
5999 * <code>setClassName(context, cls.getName())</code>.
6000 *
6001 * @return Returns the same Intent object, for chaining multiple calls
6002 * into a single statement.
6003 *
6004 * @see #setComponent
6005 */
6006 public Intent setClass(Context packageContext, Class<?> cls) {
6007 mComponent = new ComponentName(packageContext, cls);
6008 return this;
6009 }
6010
6011 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006012 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6013 * used as a hint to the receiver for animations and the like. Null means that there
6014 * is no source bounds.
6015 */
6016 public void setSourceBounds(Rect r) {
6017 if (r != null) {
6018 mSourceBounds = new Rect(r);
6019 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006020 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006021 }
6022 }
6023
6024 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006025 * Use with {@link #fillIn} to allow the current action value to be
6026 * overwritten, even if it is already set.
6027 */
6028 public static final int FILL_IN_ACTION = 1<<0;
6029
6030 /**
6031 * Use with {@link #fillIn} to allow the current data or type value
6032 * overwritten, even if it is already set.
6033 */
6034 public static final int FILL_IN_DATA = 1<<1;
6035
6036 /**
6037 * Use with {@link #fillIn} to allow the current categories to be
6038 * overwritten, even if they are already set.
6039 */
6040 public static final int FILL_IN_CATEGORIES = 1<<2;
6041
6042 /**
6043 * Use with {@link #fillIn} to allow the current component value to be
6044 * overwritten, even if it is already set.
6045 */
6046 public static final int FILL_IN_COMPONENT = 1<<3;
6047
6048 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006049 * Use with {@link #fillIn} to allow the current package value to be
6050 * overwritten, even if it is already set.
6051 */
6052 public static final int FILL_IN_PACKAGE = 1<<4;
6053
6054 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006055 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006056 * overwritten, even if it is already set.
6057 */
6058 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6059
6060 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006061 * Use with {@link #fillIn} to allow the current selector to be
6062 * overwritten, even if it is already set.
6063 */
6064 public static final int FILL_IN_SELECTOR = 1<<6;
6065
6066 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006067 * Use with {@link #fillIn} to allow the current ClipData to be
6068 * overwritten, even if it is already set.
6069 */
6070 public static final int FILL_IN_CLIP_DATA = 1<<7;
6071
6072 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006073 * Copy the contents of <var>other</var> in to this object, but only
6074 * where fields are not defined by this object. For purposes of a field
6075 * being defined, the following pieces of data in the Intent are
6076 * considered to be separate fields:
6077 *
6078 * <ul>
6079 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006080 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6082 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006083 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006084 * <li> component, as set by {@link #setComponent(ComponentName)} or
6085 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006086 * <li> source bounds, as set by {@link #setSourceBounds}.
6087 * <li> selector, as set by {@link #setSelector(Intent)}.
6088 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006089 * <li> each top-level name in the associated extras.
6090 * </ul>
6091 *
6092 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006093 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006094 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6095 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6096 * the restriction where the corresponding field will not be replaced if
6097 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006098 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006099 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6100 * is explicitly specified. The selector will only be copied if
6101 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006102 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006103 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6104 * and Intent B with {action="gotit", data-type="some/thing",
6105 * categories="one","two"}.
6106 *
6107 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6108 * containing: {action="gotit", data-type="some/thing",
6109 * categories="bar"}.
6110 *
6111 * @param other Another Intent whose values are to be used to fill in
6112 * the current one.
6113 * @param flags Options to control which fields can be filled in.
6114 *
6115 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006116 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006117 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6118 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006119 */
6120 public int fillIn(Intent other, int flags) {
6121 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006122 if (other.mAction != null
6123 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006124 mAction = other.mAction;
6125 changes |= FILL_IN_ACTION;
6126 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006127 if ((other.mData != null || other.mType != null)
6128 && ((mData == null && mType == null)
6129 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006130 mData = other.mData;
6131 mType = other.mType;
6132 changes |= FILL_IN_DATA;
6133 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006134 if (other.mCategories != null
6135 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006136 if (other.mCategories != null) {
6137 mCategories = new HashSet<String>(other.mCategories);
6138 }
6139 changes |= FILL_IN_CATEGORIES;
6140 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006141 if (other.mPackage != null
6142 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006143 // Only do this if mSelector is not set.
6144 if (mSelector == null) {
6145 mPackage = other.mPackage;
6146 changes |= FILL_IN_PACKAGE;
6147 }
6148 }
6149 // Selector is special: it can only be set if explicitly allowed,
6150 // for the same reason as the component name.
6151 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6152 if (mPackage == null) {
6153 mSelector = new Intent(other.mSelector);
6154 mPackage = null;
6155 changes |= FILL_IN_SELECTOR;
6156 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006157 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006158 if (other.mClipData != null
6159 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6160 mClipData = other.mClipData;
6161 changes |= FILL_IN_CLIP_DATA;
6162 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006163 // Component is special: it can -only- be set if explicitly allowed,
6164 // since otherwise the sender could force the intent somewhere the
6165 // originator didn't intend.
6166 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006167 mComponent = other.mComponent;
6168 changes |= FILL_IN_COMPONENT;
6169 }
6170 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006171 if (other.mSourceBounds != null
6172 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6173 mSourceBounds = new Rect(other.mSourceBounds);
6174 changes |= FILL_IN_SOURCE_BOUNDS;
6175 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006176 if (mExtras == null) {
6177 if (other.mExtras != null) {
6178 mExtras = new Bundle(other.mExtras);
6179 }
6180 } else if (other.mExtras != null) {
6181 try {
6182 Bundle newb = new Bundle(other.mExtras);
6183 newb.putAll(mExtras);
6184 mExtras = newb;
6185 } catch (RuntimeException e) {
6186 // Modifying the extras can cause us to unparcel the contents
6187 // of the bundle, and if we do this in the system process that
6188 // may fail. We really should handle this (i.e., the Bundle
6189 // impl shouldn't be on top of a plain map), but for now just
6190 // ignore it and keep the original contents. :(
6191 Log.w("Intent", "Failure filling in extras", e);
6192 }
6193 }
6194 return changes;
6195 }
6196
6197 /**
6198 * Wrapper class holding an Intent and implementing comparisons on it for
6199 * the purpose of filtering. The class implements its
6200 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6201 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6202 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6203 * on the wrapped Intent.
6204 */
6205 public static final class FilterComparison {
6206 private final Intent mIntent;
6207 private final int mHashCode;
6208
6209 public FilterComparison(Intent intent) {
6210 mIntent = intent;
6211 mHashCode = intent.filterHashCode();
6212 }
6213
6214 /**
6215 * Return the Intent that this FilterComparison represents.
6216 * @return Returns the Intent held by the FilterComparison. Do
6217 * not modify!
6218 */
6219 public Intent getIntent() {
6220 return mIntent;
6221 }
6222
6223 @Override
6224 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006225 if (obj instanceof FilterComparison) {
6226 Intent other = ((FilterComparison)obj).mIntent;
6227 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006228 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006229 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006230 }
6231
6232 @Override
6233 public int hashCode() {
6234 return mHashCode;
6235 }
6236 }
6237
6238 /**
6239 * Determine if two intents are the same for the purposes of intent
6240 * resolution (filtering). That is, if their action, data, type,
6241 * class, and categories are the same. This does <em>not</em> compare
6242 * any extra data included in the intents.
6243 *
6244 * @param other The other Intent to compare against.
6245 *
6246 * @return Returns true if action, data, type, class, and categories
6247 * are the same.
6248 */
6249 public boolean filterEquals(Intent other) {
6250 if (other == null) {
6251 return false;
6252 }
6253 if (mAction != other.mAction) {
6254 if (mAction != null) {
6255 if (!mAction.equals(other.mAction)) {
6256 return false;
6257 }
6258 } else {
6259 if (!other.mAction.equals(mAction)) {
6260 return false;
6261 }
6262 }
6263 }
6264 if (mData != other.mData) {
6265 if (mData != null) {
6266 if (!mData.equals(other.mData)) {
6267 return false;
6268 }
6269 } else {
6270 if (!other.mData.equals(mData)) {
6271 return false;
6272 }
6273 }
6274 }
6275 if (mType != other.mType) {
6276 if (mType != null) {
6277 if (!mType.equals(other.mType)) {
6278 return false;
6279 }
6280 } else {
6281 if (!other.mType.equals(mType)) {
6282 return false;
6283 }
6284 }
6285 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006286 if (mPackage != other.mPackage) {
6287 if (mPackage != null) {
6288 if (!mPackage.equals(other.mPackage)) {
6289 return false;
6290 }
6291 } else {
6292 if (!other.mPackage.equals(mPackage)) {
6293 return false;
6294 }
6295 }
6296 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006297 if (mComponent != other.mComponent) {
6298 if (mComponent != null) {
6299 if (!mComponent.equals(other.mComponent)) {
6300 return false;
6301 }
6302 } else {
6303 if (!other.mComponent.equals(mComponent)) {
6304 return false;
6305 }
6306 }
6307 }
6308 if (mCategories != other.mCategories) {
6309 if (mCategories != null) {
6310 if (!mCategories.equals(other.mCategories)) {
6311 return false;
6312 }
6313 } else {
6314 if (!other.mCategories.equals(mCategories)) {
6315 return false;
6316 }
6317 }
6318 }
6319
6320 return true;
6321 }
6322
6323 /**
6324 * Generate hash code that matches semantics of filterEquals().
6325 *
6326 * @return Returns the hash value of the action, data, type, class, and
6327 * categories.
6328 *
6329 * @see #filterEquals
6330 */
6331 public int filterHashCode() {
6332 int code = 0;
6333 if (mAction != null) {
6334 code += mAction.hashCode();
6335 }
6336 if (mData != null) {
6337 code += mData.hashCode();
6338 }
6339 if (mType != null) {
6340 code += mType.hashCode();
6341 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006342 if (mPackage != null) {
6343 code += mPackage.hashCode();
6344 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006345 if (mComponent != null) {
6346 code += mComponent.hashCode();
6347 }
6348 if (mCategories != null) {
6349 code += mCategories.hashCode();
6350 }
6351 return code;
6352 }
6353
6354 @Override
6355 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006356 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006357
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006358 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006359 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006360 b.append(" }");
6361
6362 return b.toString();
6363 }
6364
6365 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006366 public String toInsecureString() {
6367 StringBuilder b = new StringBuilder(128);
6368
6369 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006370 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006371 b.append(" }");
6372
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006373 return b.toString();
6374 }
Romain Guy4969af72009-06-17 10:53:19 -07006375
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006376 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006377 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006378 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006379
6380 b.append("Intent { ");
6381 toShortString(b, false, true, true, true);
6382 b.append(" }");
6383
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006384 return b.toString();
6385 }
6386
6387 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006388 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6389 StringBuilder b = new StringBuilder(128);
6390 toShortString(b, secure, comp, extras, clip);
6391 return b.toString();
6392 }
6393
6394 /** @hide */
6395 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6396 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006397 boolean first = true;
6398 if (mAction != null) {
6399 b.append("act=").append(mAction);
6400 first = false;
6401 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006402 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006403 if (!first) {
6404 b.append(' ');
6405 }
6406 first = false;
6407 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006408 Iterator<String> i = mCategories.iterator();
6409 boolean didone = false;
6410 while (i.hasNext()) {
6411 if (didone) b.append(",");
6412 didone = true;
6413 b.append(i.next());
6414 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006415 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006416 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006417 if (mData != null) {
6418 if (!first) {
6419 b.append(' ');
6420 }
6421 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006422 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006423 if (secure) {
6424 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006425 } else {
6426 b.append(mData);
6427 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006428 }
6429 if (mType != null) {
6430 if (!first) {
6431 b.append(' ');
6432 }
6433 first = false;
6434 b.append("typ=").append(mType);
6435 }
6436 if (mFlags != 0) {
6437 if (!first) {
6438 b.append(' ');
6439 }
6440 first = false;
6441 b.append("flg=0x").append(Integer.toHexString(mFlags));
6442 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006443 if (mPackage != null) {
6444 if (!first) {
6445 b.append(' ');
6446 }
6447 first = false;
6448 b.append("pkg=").append(mPackage);
6449 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006450 if (comp && mComponent != null) {
6451 if (!first) {
6452 b.append(' ');
6453 }
6454 first = false;
6455 b.append("cmp=").append(mComponent.flattenToShortString());
6456 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006457 if (mSourceBounds != null) {
6458 if (!first) {
6459 b.append(' ');
6460 }
6461 first = false;
6462 b.append("bnds=").append(mSourceBounds.toShortString());
6463 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006464 if (mClipData != null) {
6465 if (!first) {
6466 b.append(' ');
6467 }
6468 first = false;
6469 if (clip) {
6470 b.append("clip={");
6471 mClipData.toShortString(b);
6472 b.append('}');
6473 } else {
6474 b.append("(has clip)");
6475 }
6476 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006477 if (extras && mExtras != null) {
6478 if (!first) {
6479 b.append(' ');
6480 }
6481 first = false;
6482 b.append("(has extras)");
6483 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006484 if (mSelector != null) {
6485 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006486 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006487 b.append("}");
6488 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006489 }
6490
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006491 /**
6492 * Call {@link #toUri} with 0 flags.
6493 * @deprecated Use {@link #toUri} instead.
6494 */
6495 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006496 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006497 return toUri(0);
6498 }
6499
6500 /**
6501 * Convert this Intent into a String holding a URI representation of it.
6502 * The returned URI string has been properly URI encoded, so it can be
6503 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6504 * Intent's data as the base URI, with an additional fragment describing
6505 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006506 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006507 * <p>You can convert the returned string back to an Intent with
6508 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006509 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006510 * @param flags Additional operating flags. Either 0 or
6511 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006512 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006513 * @return Returns a URI encoding URI string describing the entire contents
6514 * of the Intent.
6515 */
6516 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006517 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006518 String scheme = null;
6519 if (mData != null) {
6520 String data = mData.toString();
6521 if ((flags&URI_INTENT_SCHEME) != 0) {
6522 final int N = data.length();
6523 for (int i=0; i<N; i++) {
6524 char c = data.charAt(i);
6525 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6526 || c == '.' || c == '-') {
6527 continue;
6528 }
6529 if (c == ':' && i > 0) {
6530 // Valid scheme.
6531 scheme = data.substring(0, i);
6532 uri.append("intent:");
6533 data = data.substring(i+1);
6534 break;
6535 }
Tom Taylord4a47292009-12-21 13:59:18 -08006536
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006537 // No scheme.
6538 break;
6539 }
6540 }
6541 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006542
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006543 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6544 uri.append("intent:");
6545 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006546
6547 uri.append("#Intent;");
6548
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006549 toUriInner(uri, scheme, flags);
6550 if (mSelector != null) {
6551 uri.append("SEL;");
6552 // Note that for now we are not going to try to handle the
6553 // data part; not clear how to represent this as a URI, and
6554 // not much utility in it.
6555 mSelector.toUriInner(uri, null, flags);
6556 }
6557
6558 uri.append("end");
6559
6560 return uri.toString();
6561 }
6562
6563 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006564 if (scheme != null) {
6565 uri.append("scheme=").append(scheme).append(';');
6566 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006567 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006568 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006569 }
6570 if (mCategories != null) {
6571 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006572 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006573 }
6574 }
6575 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006576 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006577 }
6578 if (mFlags != 0) {
6579 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6580 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006581 if (mPackage != null) {
6582 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6583 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006584 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006585 uri.append("component=").append(Uri.encode(
6586 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006587 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006588 if (mSourceBounds != null) {
6589 uri.append("sourceBounds=")
6590 .append(Uri.encode(mSourceBounds.flattenToString()))
6591 .append(';');
6592 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006593 if (mExtras != null) {
6594 for (String key : mExtras.keySet()) {
6595 final Object value = mExtras.get(key);
6596 char entryType =
6597 value instanceof String ? 'S' :
6598 value instanceof Boolean ? 'B' :
6599 value instanceof Byte ? 'b' :
6600 value instanceof Character ? 'c' :
6601 value instanceof Double ? 'd' :
6602 value instanceof Float ? 'f' :
6603 value instanceof Integer ? 'i' :
6604 value instanceof Long ? 'l' :
6605 value instanceof Short ? 's' :
6606 '\0';
6607
6608 if (entryType != '\0') {
6609 uri.append(entryType);
6610 uri.append('.');
6611 uri.append(Uri.encode(key));
6612 uri.append('=');
6613 uri.append(Uri.encode(value.toString()));
6614 uri.append(';');
6615 }
6616 }
6617 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006618 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006619
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006620 public int describeContents() {
6621 return (mExtras != null) ? mExtras.describeContents() : 0;
6622 }
6623
6624 public void writeToParcel(Parcel out, int flags) {
6625 out.writeString(mAction);
6626 Uri.writeToParcel(out, mData);
6627 out.writeString(mType);
6628 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006629 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006630 ComponentName.writeToParcel(mComponent, out);
6631
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006632 if (mSourceBounds != null) {
6633 out.writeInt(1);
6634 mSourceBounds.writeToParcel(out, flags);
6635 } else {
6636 out.writeInt(0);
6637 }
6638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006639 if (mCategories != null) {
6640 out.writeInt(mCategories.size());
6641 for (String category : mCategories) {
6642 out.writeString(category);
6643 }
6644 } else {
6645 out.writeInt(0);
6646 }
6647
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006648 if (mSelector != null) {
6649 out.writeInt(1);
6650 mSelector.writeToParcel(out, flags);
6651 } else {
6652 out.writeInt(0);
6653 }
6654
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006655 if (mClipData != null) {
6656 out.writeInt(1);
6657 mClipData.writeToParcel(out, flags);
6658 } else {
6659 out.writeInt(0);
6660 }
6661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006662 out.writeBundle(mExtras);
6663 }
6664
6665 public static final Parcelable.Creator<Intent> CREATOR
6666 = new Parcelable.Creator<Intent>() {
6667 public Intent createFromParcel(Parcel in) {
6668 return new Intent(in);
6669 }
6670 public Intent[] newArray(int size) {
6671 return new Intent[size];
6672 }
6673 };
6674
Dianne Hackborneb034652009-09-07 00:49:58 -07006675 /** @hide */
6676 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006677 readFromParcel(in);
6678 }
6679
6680 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006681 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006682 mData = Uri.CREATOR.createFromParcel(in);
6683 mType = in.readString();
6684 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006685 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006686 mComponent = ComponentName.readFromParcel(in);
6687
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006688 if (in.readInt() != 0) {
6689 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6690 }
6691
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006692 int N = in.readInt();
6693 if (N > 0) {
6694 mCategories = new HashSet<String>();
6695 int i;
6696 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006697 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006698 }
6699 } else {
6700 mCategories = null;
6701 }
6702
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006703 if (in.readInt() != 0) {
6704 mSelector = new Intent(in);
6705 }
6706
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006707 if (in.readInt() != 0) {
6708 mClipData = new ClipData(in);
6709 }
6710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 mExtras = in.readBundle();
6712 }
6713
6714 /**
6715 * Parses the "intent" element (and its children) from XML and instantiates
6716 * an Intent object. The given XML parser should be located at the tag
6717 * where parsing should start (often named "intent"), from which the
6718 * basic action, data, type, and package and class name will be
6719 * retrieved. The function will then parse in to any child elements,
6720 * looking for <category android:name="xxx"> tags to add categories and
6721 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6722 * to the intent.
6723 *
6724 * @param resources The Resources to use when inflating resources.
6725 * @param parser The XML parser pointing at an "intent" tag.
6726 * @param attrs The AttributeSet interface for retrieving extended
6727 * attribute data at the current <var>parser</var> location.
6728 * @return An Intent object matching the XML data.
6729 * @throws XmlPullParserException If there was an XML parsing error.
6730 * @throws IOException If there was an I/O error.
6731 */
6732 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6733 throws XmlPullParserException, IOException {
6734 Intent intent = new Intent();
6735
6736 TypedArray sa = resources.obtainAttributes(attrs,
6737 com.android.internal.R.styleable.Intent);
6738
6739 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6740
6741 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6742 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6743 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6744
6745 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6746 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6747 if (packageName != null && className != null) {
6748 intent.setComponent(new ComponentName(packageName, className));
6749 }
6750
6751 sa.recycle();
6752
6753 int outerDepth = parser.getDepth();
6754 int type;
6755 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6756 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6757 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6758 continue;
6759 }
6760
6761 String nodeName = parser.getName();
6762 if (nodeName.equals("category")) {
6763 sa = resources.obtainAttributes(attrs,
6764 com.android.internal.R.styleable.IntentCategory);
6765 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6766 sa.recycle();
6767
6768 if (cat != null) {
6769 intent.addCategory(cat);
6770 }
6771 XmlUtils.skipCurrentTag(parser);
6772
6773 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006774 if (intent.mExtras == null) {
6775 intent.mExtras = new Bundle();
6776 }
6777 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6778 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006779
6780 } else {
6781 XmlUtils.skipCurrentTag(parser);
6782 }
6783 }
6784
6785 return intent;
6786 }
Nick Pellyccae4122012-01-09 14:12:58 -08006787
6788 /**
6789 * Normalize a MIME data type.
6790 *
6791 * <p>A normalized MIME type has white-space trimmed,
6792 * content-type parameters removed, and is lower-case.
6793 * This aligns the type with Android best practices for
6794 * intent filtering.
6795 *
6796 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6797 * "text/x-vCard" becomes "text/x-vcard".
6798 *
6799 * <p>All MIME types received from outside Android (such as user input,
6800 * or external sources like Bluetooth, NFC, or the Internet) should
6801 * be normalized before they are used to create an Intent.
6802 *
6803 * @param type MIME data type to normalize
6804 * @return normalized MIME data type, or null if the input was null
6805 * @see {@link #setType}
6806 * @see {@link #setTypeAndNormalize}
6807 */
6808 public static String normalizeMimeType(String type) {
6809 if (type == null) {
6810 return null;
6811 }
6812
6813 type = type.trim().toLowerCase(Locale.US);
6814
6815 final int semicolonIndex = type.indexOf(';');
6816 if (semicolonIndex != -1) {
6817 type = type.substring(0, semicolonIndex);
6818 }
6819 return type;
6820 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006821
6822 /**
6823 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006824 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6825 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006826 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006827 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006828 * @hide
6829 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006830 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006831 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006832 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006833
6834 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006835 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006836
6837 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006838 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006839 try {
6840 // Inspect target intent to see if we need to migrate
6841 final Intent target = getParcelableExtra(EXTRA_INTENT);
6842 if (target != null && target.migrateExtraStreamToClipData()) {
6843 // Since we migrated in child, we need to promote ClipData
6844 // and flags to ourselves to grant.
6845 setClipData(target.getClipData());
6846 addFlags(target.getFlags()
6847 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6848 return true;
6849 } else {
6850 return false;
6851 }
6852 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006853 }
6854
6855 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006856 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006857 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6858 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6859 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6860 if (stream != null || text != null || htmlText != null) {
6861 final ClipData clipData = new ClipData(
6862 null, new String[] { getType() },
6863 new ClipData.Item(text, htmlText, null, stream));
6864 setClipData(clipData);
6865 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006866 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006867 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006868 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006869 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006870
6871 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006872 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006873 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6874 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6875 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6876 int num = -1;
6877 if (streams != null) {
6878 num = streams.size();
6879 }
6880 if (texts != null) {
6881 if (num >= 0 && num != texts.size()) {
6882 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006883 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006884 }
6885 num = texts.size();
6886 }
6887 if (htmlTexts != null) {
6888 if (num >= 0 && num != htmlTexts.size()) {
6889 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006890 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006891 }
6892 num = htmlTexts.size();
6893 }
6894 if (num > 0) {
6895 final ClipData clipData = new ClipData(
6896 null, new String[] { getType() },
6897 makeClipItem(streams, texts, htmlTexts, 0));
6898
6899 for (int i = 1; i < num; i++) {
6900 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6901 }
6902
6903 setClipData(clipData);
6904 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006905 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006906 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006907 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006908 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006909 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006910
6911 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006912 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006913
6914 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6915 ArrayList<String> htmlTexts, int which) {
6916 Uri uri = streams != null ? streams.get(which) : null;
6917 CharSequence text = texts != null ? texts.get(which) : null;
6918 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6919 return new ClipData.Item(text, htmlText, null, uri);
6920 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006921}