blob: 7676e4b8d6fc3e4e6490f3244b2c1ee0f44a34a0 [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
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010020import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070021import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070023import org.xmlpull.v1.XmlPullParser;
24import org.xmlpull.v1.XmlPullParserException;
25
Tor Norbyed9273d62013-05-30 15:59:53 -070026import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant.SdkConstantType;
30import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070031
Nicolas Prevotd85fc722014-04-16 19:52:08 +010032import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070033
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.content.pm.PackageManager;
35import android.content.pm.ResolveInfo;
36import android.content.res.Resources;
37import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080038import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.net.Uri;
40import android.os.Bundle;
41import android.os.IBinder;
42import android.os.Parcel;
43import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070044import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010045import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070046import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070047import android.provider.DocumentsProvider;
48import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070049import android.util.AttributeSet;
50import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080051
52import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070053
Craig Mautner21d24a22014-04-23 11:45:37 -070054import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070055
56import java.io.IOException;
57import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070062import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080063import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070064import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065import java.util.Set;
66
67/**
68 * An intent is an abstract description of an operation to be performed. It
69 * can be used with {@link Context#startActivity(Intent) startActivity} to
70 * launch an {@link android.app.Activity},
71 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
72 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
73 * and {@link android.content.Context#startService} or
74 * {@link android.content.Context#bindService} to communicate with a
75 * background {@link android.app.Service}.
76 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070077 * <p>An Intent provides a facility for performing late runtime binding between the code in
78 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070079 * can be thought of as the glue between activities. It is basically a passive data structure
80 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070081 *
82 * <div class="special reference">
83 * <h3>Developer Guides</h3>
84 * <p>For information about how to create and resolve intents, read the
85 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
86 * developer guide.</p>
87 * </div>
88 *
89 * <a name="IntentStructure"></a>
90 * <h3>Intent Structure</h3>
91 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070092 *
93 * <ul>
94 * <li> <p><b>action</b> -- The general action to be performed, such as
95 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
96 * etc.</p>
97 * </li>
98 * <li> <p><b>data</b> -- The data to operate on, such as a person record
99 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
100 * </li>
101 * </ul>
102 *
103 *
104 * <p>Some examples of action/data pairs are:</p>
105 *
106 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700107 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700108 * information about the person whose identifier is "1".</p>
109 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * the phone dialer with the person filled in.</p>
112 * </li>
113 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
114 * the phone dialer with the given number filled in. Note how the
115 * VIEW action does what what is considered the most reasonable thing for
116 * a particular URI.</p>
117 * </li>
118 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
119 * the phone dialer with the given number filled in.</p>
120 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700121 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700122 * information about the person whose identifier is "1".</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * a list of people, which the user can browse through. This example is a
126 * typical top-level entry into the Contacts application, showing you the
127 * list of people. Selecting a particular person to view would result in a
128 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
129 * being used to start an activity to display that person.</p>
130 * </li>
131 * </ul>
132 *
133 * <p>In addition to these primary attributes, there are a number of secondary
134 * attributes that you can also include with an intent:</p>
135 *
136 * <ul>
137 * <li> <p><b>category</b> -- Gives additional information about the action
138 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
139 * appear in the Launcher as a top-level application, while
140 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
141 * of alternative actions the user can perform on a piece of data.</p>
142 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
143 * intent data. Normally the type is inferred from the data itself.
144 * By setting this attribute, you disable that evaluation and force
145 * an explicit type.</p>
146 * <li> <p><b>component</b> -- Specifies an explicit name of a component
147 * class to use for the intent. Normally this is determined by looking
148 * at the other information in the intent (the action, data/type, and
149 * categories) and matching that with a component that can handle it.
150 * If this attribute is set then none of the evaluation is performed,
151 * and this component is used exactly as is. By specifying this attribute,
152 * all of the other Intent attributes become optional.</p>
153 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
154 * This can be used to provide extended information to the component.
155 * For example, if we have a action to send an e-mail message, we could
156 * also include extra pieces of data here to supply a subject, body,
157 * etc.</p>
158 * </ul>
159 *
160 * <p>Here are some examples of other operations you can specify as intents
161 * using these additional parameters:</p>
162 *
163 * <ul>
164 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
165 * Launch the home screen.</p>
166 * </li>
167 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
168 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
169 * vnd.android.cursor.item/phone}</i></b>
170 * -- Display the list of people's phone numbers, allowing the user to
171 * browse through them and pick one and return it to the parent activity.</p>
172 * </li>
173 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
174 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
175 * -- Display all pickers for data that can be opened with
176 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
177 * allowing the user to pick one of them and then some data inside of it
178 * and returning the resulting URI to the caller. This can be used,
179 * for example, in an e-mail application to allow the user to pick some
180 * data to include as an attachment.</p>
181 * </li>
182 * </ul>
183 *
184 * <p>There are a variety of standard Intent action and category constants
185 * defined in the Intent class, but applications can also define their own.
186 * These strings use java style scoping, to ensure they are unique -- for
187 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700188 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700189 *
190 * <p>Put together, the set of actions, data types, categories, and extra data
191 * defines a language for the system allowing for the expression of phrases
192 * such as "call john smith's cell". As applications are added to the system,
193 * they can extend this language by adding new actions, types, and categories, or
194 * they can modify the behavior of existing phrases by supplying their own
195 * activities that handle them.</p>
196 *
197 * <a name="IntentResolution"></a>
198 * <h3>Intent Resolution</h3>
199 *
200 * <p>There are two primary forms of intents you will use.
201 *
202 * <ul>
203 * <li> <p><b>Explicit Intents</b> have specified a component (via
204 * {@link #setComponent} or {@link #setClass}), which provides the exact
205 * class to be run. Often these will not include any other information,
206 * simply being a way for an application to launch various internal
207 * activities it has as the user interacts with the application.
208 *
209 * <li> <p><b>Implicit Intents</b> have not specified a component;
210 * instead, they must include enough information for the system to
211 * determine which of the available components is best to run for that
212 * intent.
213 * </ul>
214 *
215 * <p>When using implicit intents, given such an arbitrary intent we need to
216 * know what to do with it. This is handled by the process of <em>Intent
217 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
218 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
219 * more activities/receivers) that can handle it.</p>
220 *
221 * <p>The intent resolution mechanism basically revolves around matching an
222 * Intent against all of the &lt;intent-filter&gt; descriptions in the
223 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
224 * objects explicitly registered with {@link Context#registerReceiver}.) More
225 * details on this can be found in the documentation on the {@link
226 * IntentFilter} class.</p>
227 *
228 * <p>There are three pieces of information in the Intent that are used for
229 * resolution: the action, type, and category. Using this information, a query
230 * is done on the {@link PackageManager} for a component that can handle the
231 * intent. The appropriate component is determined based on the intent
232 * information supplied in the <code>AndroidManifest.xml</code> file as
233 * follows:</p>
234 *
235 * <ul>
236 * <li> <p>The <b>action</b>, if given, must be listed by the component as
237 * one it handles.</p>
238 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
239 * already supplied in the Intent. Like the action, if a type is
240 * included in the intent (either explicitly or implicitly in its
241 * data), then this must be listed by the component as one it handles.</p>
242 * <li> For data that is not a <code>content:</code> URI and where no explicit
243 * type is included in the Intent, instead the <b>scheme</b> of the
244 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
245 * considered. Again like the action, if we are matching a scheme it
246 * must be listed by the component as one it can handle.
247 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
248 * by the activity as categories it handles. That is, if you include
249 * the categories {@link #CATEGORY_LAUNCHER} and
250 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
251 * with an intent that lists <em>both</em> of those categories.
252 * Activities will very often need to support the
253 * {@link #CATEGORY_DEFAULT} so that they can be found by
254 * {@link Context#startActivity Context.startActivity()}.</p>
255 * </ul>
256 *
257 * <p>For example, consider the Note Pad sample application that
258 * allows user to browse through a list of notes data and view details about
259 * individual items. Text in italics indicate places were you would replace a
260 * name with one specific to your own package.</p>
261 *
262 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
263 * package="<i>com.android.notepad</i>"&gt;
264 * &lt;application android:icon="@drawable/app_notes"
265 * android:label="@string/app_name"&gt;
266 *
267 * &lt;provider class=".NotePadProvider"
268 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
269 *
270 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
271 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700272 * &lt;action android:name="android.intent.action.MAIN" /&gt;
273 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * &lt;/intent-filter&gt;
275 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700276 * &lt;action android:name="android.intent.action.VIEW" /&gt;
277 * &lt;action android:name="android.intent.action.EDIT" /&gt;
278 * &lt;action android:name="android.intent.action.PICK" /&gt;
279 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
280 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
284 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;/activity&gt;
288 *
289 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
290 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="android.intent.action.VIEW" /&gt;
292 * &lt;action android:name="android.intent.action.EDIT" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&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 *
297 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="android.intent.action.INSERT" /&gt;
299 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
300 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;
302 *
303 * &lt;/activity&gt;
304 *
305 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
306 * android:theme="@android:style/Theme.Dialog"&gt;
307 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
309 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
310 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
311 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
312 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;
314 * &lt;/activity&gt;
315 *
316 * &lt;/application&gt;
317 * &lt;/manifest&gt;</pre>
318 *
319 * <p>The first activity,
320 * <code>com.android.notepad.NotesList</code>, serves as our main
321 * entry into the app. It can do three things as described by its three intent
322 * templates:
323 * <ol>
324 * <li><pre>
325 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700326 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
327 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700328 * &lt;/intent-filter&gt;</pre>
329 * <p>This provides a top-level entry into the NotePad application: the standard
330 * MAIN action is a main entry point (not requiring any other information in
331 * the Intent), and the LAUNCHER category says that this entry point should be
332 * listed in the application launcher.</p>
333 * <li><pre>
334 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700335 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
336 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
337 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
339 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700340 * &lt;/intent-filter&gt;</pre>
341 * <p>This declares the things that the activity can do on a directory of
342 * notes. The type being supported is given with the &lt;type&gt; tag, where
343 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
344 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
345 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
346 * The activity allows the user to view or edit the directory of data (via
347 * the VIEW and EDIT actions), or to pick a particular note and return it
348 * to the caller (via the PICK action). Note also the DEFAULT category
349 * supplied here: this is <em>required</em> for the
350 * {@link Context#startActivity Context.startActivity} method to resolve your
351 * activity when its component name is not explicitly specified.</p>
352 * <li><pre>
353 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700354 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
355 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
356 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700357 * &lt;/intent-filter&gt;</pre>
358 * <p>This filter describes the ability return to the caller a note selected by
359 * the user without needing to know where it came from. The data type
360 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
361 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
362 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
363 * The GET_CONTENT action is similar to the PICK action, where the activity
364 * will return to its caller a piece of data selected by the user. Here,
365 * however, the caller specifies the type of data they desire instead of
366 * the type of data the user will be picking from.</p>
367 * </ol>
368 *
369 * <p>Given these capabilities, the following intents will resolve to the
370 * NotesList activity:</p>
371 *
372 * <ul>
373 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
374 * activities that can be used as top-level entry points into an
375 * application.</p>
376 * <li> <p><b>{ action=android.app.action.MAIN,
377 * category=android.app.category.LAUNCHER }</b> is the actual intent
378 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700379 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700380 * data=content://com.google.provider.NotePad/notes }</b>
381 * displays a list of all the notes under
382 * "content://com.google.provider.NotePad/notes", which
383 * the user can browse through and see the details on.</p>
384 * <li> <p><b>{ action=android.app.action.PICK
385 * data=content://com.google.provider.NotePad/notes }</b>
386 * provides a list of the notes under
387 * "content://com.google.provider.NotePad/notes", from which
388 * the user can pick a note whose data URL is returned back to the caller.</p>
389 * <li> <p><b>{ action=android.app.action.GET_CONTENT
390 * type=vnd.android.cursor.item/vnd.google.note }</b>
391 * is similar to the pick action, but allows the caller to specify the
392 * kind of data they want back so that the system can find the appropriate
393 * activity to pick something of that data type.</p>
394 * </ul>
395 *
396 * <p>The second activity,
397 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
398 * note entry and allows them to edit it. It can do two things as described
399 * by its two intent templates:
400 * <ol>
401 * <li><pre>
402 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700403 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
404 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
405 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
406 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700407 * &lt;/intent-filter&gt;</pre>
408 * <p>The first, primary, purpose of this activity is to let the user interact
409 * with a single note, as decribed by the MIME type
410 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
411 * either VIEW a note or allow the user to EDIT it. Again we support the
412 * DEFAULT category to allow the activity to be launched without explicitly
413 * specifying its component.</p>
414 * <li><pre>
415 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700416 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
417 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
418 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700419 * &lt;/intent-filter&gt;</pre>
420 * <p>The secondary use of this activity is to insert a new note entry into
421 * an existing directory of notes. This is used when the user creates a new
422 * note: the INSERT action is executed on the directory of notes, causing
423 * this activity to run and have the user create the new note data which
424 * it then adds to the content provider.</p>
425 * </ol>
426 *
427 * <p>Given these capabilities, the following intents will resolve to the
428 * NoteEditor activity:</p>
429 *
430 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700431 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700432 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
433 * shows the user the content of note <var>{ID}</var>.</p>
434 * <li> <p><b>{ action=android.app.action.EDIT
435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * allows the user to edit the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.INSERT
438 * data=content://com.google.provider.NotePad/notes }</b>
439 * creates a new, empty note in the notes list at
440 * "content://com.google.provider.NotePad/notes"
441 * and allows the user to edit it. If they keep their changes, the URI
442 * of the newly created note is returned to the caller.</p>
443 * </ul>
444 *
445 * <p>The last activity,
446 * <code>com.android.notepad.TitleEditor</code>, allows the user to
447 * edit the title of a note. This could be implemented as a class that the
448 * application directly invokes (by explicitly setting its component in
449 * the Intent), but here we show a way you can publish alternative
450 * operations on existing data:</p>
451 *
452 * <pre>
453 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700454 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
455 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
456 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
457 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
458 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700459 * &lt;/intent-filter&gt;</pre>
460 *
461 * <p>In the single intent template here, we
462 * have created our own private action called
463 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
464 * edit the title of a note. It must be invoked on a specific note
465 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
466 * view and edit actions, but here displays and edits the title contained
467 * in the note data.
468 *
469 * <p>In addition to supporting the default category as usual, our title editor
470 * also supports two other standard categories: ALTERNATIVE and
471 * SELECTED_ALTERNATIVE. Implementing
472 * these categories allows others to find the special action it provides
473 * without directly knowing about it, through the
474 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
475 * more often to build dynamic menu items with
476 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
477 * template here was also supply an explicit name for the template
478 * (via <code>android:label="@string/resolve_title"</code>) to better control
479 * what the user sees when presented with this activity as an alternative
480 * action to the data they are viewing.
481 *
482 * <p>Given these capabilities, the following intent will resolve to the
483 * TitleEditor activity:</p>
484 *
485 * <ul>
486 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
487 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
488 * displays and allows the user to edit the title associated
489 * with note <var>{ID}</var>.</p>
490 * </ul>
491 *
492 * <h3>Standard Activity Actions</h3>
493 *
494 * <p>These are the current standard actions that Intent defines for launching
495 * activities (usually through {@link Context#startActivity}. The most
496 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
497 * {@link #ACTION_EDIT}.
498 *
499 * <ul>
500 * <li> {@link #ACTION_MAIN}
501 * <li> {@link #ACTION_VIEW}
502 * <li> {@link #ACTION_ATTACH_DATA}
503 * <li> {@link #ACTION_EDIT}
504 * <li> {@link #ACTION_PICK}
505 * <li> {@link #ACTION_CHOOSER}
506 * <li> {@link #ACTION_GET_CONTENT}
507 * <li> {@link #ACTION_DIAL}
508 * <li> {@link #ACTION_CALL}
509 * <li> {@link #ACTION_SEND}
510 * <li> {@link #ACTION_SENDTO}
511 * <li> {@link #ACTION_ANSWER}
512 * <li> {@link #ACTION_INSERT}
513 * <li> {@link #ACTION_DELETE}
514 * <li> {@link #ACTION_RUN}
515 * <li> {@link #ACTION_SYNC}
516 * <li> {@link #ACTION_PICK_ACTIVITY}
517 * <li> {@link #ACTION_SEARCH}
518 * <li> {@link #ACTION_WEB_SEARCH}
519 * <li> {@link #ACTION_FACTORY_TEST}
520 * </ul>
521 *
522 * <h3>Standard Broadcast Actions</h3>
523 *
524 * <p>These are the current standard actions that Intent defines for receiving
525 * broadcasts (usually through {@link Context#registerReceiver} or a
526 * &lt;receiver&gt; tag in a manifest).
527 *
528 * <ul>
529 * <li> {@link #ACTION_TIME_TICK}
530 * <li> {@link #ACTION_TIME_CHANGED}
531 * <li> {@link #ACTION_TIMEZONE_CHANGED}
532 * <li> {@link #ACTION_BOOT_COMPLETED}
533 * <li> {@link #ACTION_PACKAGE_ADDED}
534 * <li> {@link #ACTION_PACKAGE_CHANGED}
535 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800536 * <li> {@link #ACTION_PACKAGE_RESTARTED}
537 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700538 * <li> {@link #ACTION_UID_REMOVED}
539 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700540 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700541 * <li> {@link #ACTION_POWER_DISCONNECTED}
542 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * </ul>
544 *
545 * <h3>Standard Categories</h3>
546 *
547 * <p>These are the current standard categories that can be used to further
548 * clarify an Intent via {@link #addCategory}.
549 *
550 * <ul>
551 * <li> {@link #CATEGORY_DEFAULT}
552 * <li> {@link #CATEGORY_BROWSABLE}
553 * <li> {@link #CATEGORY_TAB}
554 * <li> {@link #CATEGORY_ALTERNATIVE}
555 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
556 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800557 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700558 * <li> {@link #CATEGORY_HOME}
559 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700560 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400561 * <li> {@link #CATEGORY_CAR_DOCK}
562 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #CATEGORY_LE_DESK_DOCK}
564 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200565 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700566 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * </ul>
568 *
569 * <h3>Standard Extra Data</h3>
570 *
571 * <p>These are the current standard fields that can be used as extra data via
572 * {@link #putExtra}.
573 *
574 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_ALARM_COUNT}
576 * <li> {@link #EXTRA_BCC}
577 * <li> {@link #EXTRA_CC}
578 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
579 * <li> {@link #EXTRA_DATA_REMOVED}
580 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500581 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
582 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_DOCK_STATE_CAR}
584 * <li> {@link #EXTRA_DOCK_STATE_DESK}
585 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
586 * <li> {@link #EXTRA_DONT_KILL_APP}
587 * <li> {@link #EXTRA_EMAIL}
588 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800590 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700591 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700593 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800594 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
595 * <li> {@link #EXTRA_REPLACING}
596 * <li> {@link #EXTRA_SHORTCUT_ICON}
597 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
598 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_SHORTCUT_NAME}
601 * <li> {@link #EXTRA_SUBJECT}
602 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700603 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_TITLE}
605 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * </ul>
607 *
608 * <h3>Flags</h3>
609 *
610 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800611 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
612 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800614public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700615 private static final String ATTR_ACTION = "action";
616 private static final String TAG_CATEGORIES = "categories";
617 private static final String ATTR_CATEGORY = "category";
618 private static final String TAG_EXTRA = "extra";
619 private static final String ATTR_TYPE = "type";
620 private static final String ATTR_COMPONENT = "component";
621 private static final String ATTR_DATA = "data";
622 private static final String ATTR_FLAGS = "flags";
623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 // ---------------------------------------------------------------------
625 // ---------------------------------------------------------------------
626 // Standard intent activity actions (see action variable).
627
628 /**
629 * Activity Action: Start as a main entry point, does not expect to
630 * receive data.
631 * <p>Input: nothing
632 * <p>Output: nothing
633 */
634 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
635 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700637 /**
638 * Activity Action: Display the data to the user. This is the most common
639 * action performed on data -- it is the generic action you can use on
640 * a piece of data to get the most reasonable thing to occur. For example,
641 * when used on a contacts entry it will view the entry; when used on a
642 * mailto: URI it will bring up a compose window filled with the information
643 * supplied by the URI; when used with a tel: URI it will invoke the
644 * dialer.
645 * <p>Input: {@link #getData} is URI from which to retrieve data.
646 * <p>Output: nothing.
647 */
648 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
649 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700651 /**
652 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
653 * performed on a piece of data.
654 */
655 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700657 /**
658 * Used to indicate that some piece of data should be attached to some other
659 * place. For example, image data could be attached to a contact. It is up
660 * to the recipient to decide where the data should be attached; the intent
661 * does not specify the ultimate destination.
662 * <p>Input: {@link #getData} is URI of data to be attached.
663 * <p>Output: nothing.
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700668 /**
669 * Activity Action: Provide explicit editable access to the given data.
670 * <p>Input: {@link #getData} is URI of data to be edited.
671 * <p>Output: nothing.
672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 /**
677 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
678 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
679 * The extras can contain type specific data to pass through to the editing/creating
680 * activity.
681 * <p>Output: The URI of the item that was picked. This must be a content:
682 * URI so that any receiver can access it.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Pick an item from the data, returning what was selected.
689 * <p>Input: {@link #getData} is URI containing a directory of data
690 * (vnd.android.cursor.dir/*) from which to pick an item.
691 * <p>Output: The URI of the item that was picked.
692 */
693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
694 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700696 /**
697 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800698 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700699 * <p>Output: An Intent representing the shortcut. The intent must contain three
700 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
701 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800702 * (value: ShortcutIconResource).</p>
703 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 * @see #EXTRA_SHORTCUT_INTENT
705 * @see #EXTRA_SHORTCUT_NAME
706 * @see #EXTRA_SHORTCUT_ICON
707 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
711 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
712
713 /**
714 * The name of the extra used to define the Intent of a shortcut.
715 *
716 * @see #ACTION_CREATE_SHORTCUT
717 */
718 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
719 /**
720 * The name of the extra used to define the name of a shortcut.
721 *
722 * @see #ACTION_CREATE_SHORTCUT
723 */
724 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
725 /**
726 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
727 *
728 * @see #ACTION_CREATE_SHORTCUT
729 */
730 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
731 /**
732 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
733 *
734 * @see #ACTION_CREATE_SHORTCUT
735 * @see android.content.Intent.ShortcutIconResource
736 */
737 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
738 "android.intent.extra.shortcut.ICON_RESOURCE";
739
740 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800741 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700742 *
743 * @see Intent#ACTION_CREATE_SHORTCUT
744 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800745 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
746 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700747 */
748 public static class ShortcutIconResource implements Parcelable {
749 /**
750 * The package name of the application containing the icon.
751 */
752 public String packageName;
753
754 /**
755 * The resource name of the icon, including package, name and type.
756 */
757 public String resourceName;
758
759 /**
760 * Creates a new ShortcutIconResource for the specified context and resource
761 * identifier.
762 *
763 * @param context The context of the application.
764 * @param resourceId The resource idenfitier for the icon.
765 * @return A new ShortcutIconResource with the specified's context package name
766 * and icon resource idenfitier.
767 */
768 public static ShortcutIconResource fromContext(Context context, int resourceId) {
769 ShortcutIconResource icon = new ShortcutIconResource();
770 icon.packageName = context.getPackageName();
771 icon.resourceName = context.getResources().getResourceName(resourceId);
772 return icon;
773 }
774
775 /**
776 * Used to read a ShortcutIconResource from a Parcel.
777 */
778 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
779 new Parcelable.Creator<ShortcutIconResource>() {
780
781 public ShortcutIconResource createFromParcel(Parcel source) {
782 ShortcutIconResource icon = new ShortcutIconResource();
783 icon.packageName = source.readString();
784 icon.resourceName = source.readString();
785 return icon;
786 }
787
788 public ShortcutIconResource[] newArray(int size) {
789 return new ShortcutIconResource[size];
790 }
791 };
792
793 /**
794 * No special parcel contents.
795 */
796 public int describeContents() {
797 return 0;
798 }
799
800 public void writeToParcel(Parcel dest, int flags) {
801 dest.writeString(packageName);
802 dest.writeString(resourceName);
803 }
804
805 @Override
806 public String toString() {
807 return resourceName;
808 }
809 }
810
811 /**
812 * Activity Action: Display an activity chooser, allowing the user to pick
813 * what they want to before proceeding. This can be used as an alternative
814 * to the standard activity picker that is displayed by the system when
815 * you try to start an activity with multiple possible matches, with these
816 * differences in behavior:
817 * <ul>
818 * <li>You can specify the title that will appear in the activity chooser.
819 * <li>The user does not have the option to make one of the matching
820 * activities a preferred activity, and all possible activities will
821 * always be shown even if one of them is currently marked as the
822 * preferred activity.
823 * </ul>
824 * <p>
825 * This action should be used when the user will naturally expect to
826 * select an activity in order to proceed. An example if when not to use
827 * it is when the user clicks on a "mailto:" link. They would naturally
828 * expect to go directly to their mail app, so startActivity() should be
829 * called directly: it will
830 * either launch the current preferred app, or put up a dialog allowing the
831 * user to pick an app to use and optionally marking that as preferred.
832 * <p>
833 * In contrast, if the user is selecting a menu item to send a picture
834 * they are viewing to someone else, there are many different things they
835 * may want to do at this point: send it through e-mail, upload it to a
836 * web service, etc. In this case the CHOOSER action should be used, to
837 * always present to the user a list of the things they can do, with a
838 * nice title given by the caller such as "Send this photo with:".
839 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700840 * If you need to grant URI permissions through a chooser, you must specify
841 * the permissions to be granted on the ACTION_CHOOSER Intent
842 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
843 * {@link #setClipData} to specify the URIs to be granted as well as
844 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
845 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
846 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * As a convenience, an Intent of this form can be created with the
848 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700849 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700850 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700851 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
852 * and can optionally have a {@link #EXTRA_TITLE} field containing the
853 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700854 * <p>
855 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700856 */
857 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
858 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
859
860 /**
861 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
862 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700863 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
864 * target intent, also optionally supplying a title. If the target
865 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
866 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
867 * set in the returned chooser intent, with its ClipData set appropriately:
868 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500869 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700870 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700871 * @param target The Intent that the user will be selecting an activity
872 * to perform.
873 * @param title Optional title that will be displayed in the chooser.
874 * @return Return a new Intent object that you can hand to
875 * {@link Context#startActivity(Intent) Context.startActivity()} and
876 * related methods.
877 */
878 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700879 return createChooser(target, title, null);
880 }
881
882 /**
883 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
884 *
885 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
886 * target intent, also optionally supplying a title. If the target
887 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
888 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
889 * set in the returned chooser intent, with its ClipData set appropriately:
890 * either a direct reflection of {@link #getClipData()} if that is non-null,
891 * or a new ClipData built from {@link #getData()}.</p>
892 *
893 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
894 * when the user makes a choice. This can be useful if the calling application wants
895 * to remember the last chosen target and surface it as a more prominent or one-touch
896 * affordance elsewhere in the UI for next time.</p>
897 *
898 * @param target The Intent that the user will be selecting an activity
899 * to perform.
900 * @param title Optional title that will be displayed in the chooser.
901 * @param sender Optional IntentSender to be called when a choice is made.
902 * @return Return a new Intent object that you can hand to
903 * {@link Context#startActivity(Intent) Context.startActivity()} and
904 * related methods.
905 */
906 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700907 Intent intent = new Intent(ACTION_CHOOSER);
908 intent.putExtra(EXTRA_INTENT, target);
909 if (title != null) {
910 intent.putExtra(EXTRA_TITLE, title);
911 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700912
Adam Powell0b3c1122014-10-09 12:50:14 -0700913 if (sender != null) {
914 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
915 }
916
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700917 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700918 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
919 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
920 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700921 if (permFlags != 0) {
922 ClipData targetClipData = target.getClipData();
923 if (targetClipData == null && target.getData() != null) {
924 ClipData.Item item = new ClipData.Item(target.getData());
925 String[] mimeTypes;
926 if (target.getType() != null) {
927 mimeTypes = new String[] { target.getType() };
928 } else {
929 mimeTypes = new String[] { };
930 }
931 targetClipData = new ClipData(null, mimeTypes, item);
932 }
933 if (targetClipData != null) {
934 intent.setClipData(targetClipData);
935 intent.addFlags(permFlags);
936 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700937 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700939 return intent;
940 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700942 /**
943 * Activity Action: Allow the user to select a particular kind of data and
944 * return it. This is different than {@link #ACTION_PICK} in that here we
945 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800946 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900948 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700949 * etc.
950 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900951 * 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 -0700952 * of data, such as a person contact, you set the MIME type to the kind of
953 * data you want and launch it with {@link Context#startActivity(Intent)}.
954 * The system will then launch the best application to select that kind
955 * of data for you.
956 * <p>
957 * You may also be interested in any of a set of types of content the user
958 * can pick. For example, an e-mail application that wants to allow the
959 * user to add an attachment to an e-mail message can use this action to
960 * bring up a list of all of the types of content the user can attach.
961 * <p>
962 * In this case, you should wrap the GET_CONTENT intent with a chooser
963 * (through {@link #createChooser}), which will give the proper interface
964 * for the user to pick how to send your data and allow you to specify
965 * a prompt indicating what they are doing. You will usually specify a
966 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
967 * broad range of content types the user can select from.
968 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900969 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700970 * only pick from data that can be represented as a stream. This is
971 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
972 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800973 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900974 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800975 * is locally available on the device. For example, if this extra is set
976 * to true then an image picker should not show any pictures that are available
977 * from a remote server but not already on the local device (thus requiring
978 * they be downloaded when opened).
979 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800980 * If the caller can handle multiple returned items (the user performing
981 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
982 * to indicate this.
983 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700984 * Input: {@link #getType} is the desired MIME type to retrieve. Note
985 * that no URI is supplied in the intent, as there are no constraints on
986 * where the returned data originally comes from. You may also include the
987 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800988 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800989 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
990 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700991 * <p>
992 * Output: The URI of the item that was picked. This must be a content:
993 * URI so that any receiver can access it.
994 */
995 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
996 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
997 /**
998 * Activity Action: Dial a number as specified by the data. This shows a
999 * UI with the number being dialed, allowing the user to explicitly
1000 * initiate the call.
1001 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1002 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1003 * number.
1004 * <p>Output: nothing.
1005 */
1006 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1007 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1008 /**
1009 * Activity Action: Perform a call to someone specified by the data.
1010 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1011 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1012 * number.
1013 * <p>Output: nothing.
1014 *
1015 * <p>Note: there will be restrictions on which applications can initiate a
1016 * call; most applications should use the {@link #ACTION_DIAL}.
1017 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1018 * numbers. Applications can <strong>dial</strong> emergency numbers using
1019 * {@link #ACTION_DIAL}, however.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_CALL = "android.intent.action.CALL";
1023 /**
1024 * Activity Action: Perform a call to an emergency number specified by the
1025 * data.
1026 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1027 * tel: URI of an explicit phone number.
1028 * <p>Output: nothing.
1029 * @hide
1030 */
1031 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1032 /**
1033 * Activity action: Perform a call to any number (emergency or not)
1034 * specified by the data.
1035 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1036 * tel: URI of an explicit phone number.
1037 * <p>Output: nothing.
1038 * @hide
1039 */
1040 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1041 /**
1042 * Activity Action: Send a message to someone specified by the data.
1043 * <p>Input: {@link #getData} is URI describing the target.
1044 * <p>Output: nothing.
1045 */
1046 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1047 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1048 /**
1049 * Activity Action: Deliver some data to someone else. Who the data is
1050 * being delivered to is not specified; it is up to the receiver of this
1051 * action to ask the user where the data should be sent.
1052 * <p>
1053 * When launching a SEND intent, you should usually wrap it in a chooser
1054 * (through {@link #createChooser}), which will give the proper interface
1055 * for the user to pick how to send your data and allow you to specify
1056 * a prompt indicating what they are doing.
1057 * <p>
1058 * Input: {@link #getType} is the MIME type of the data being sent.
1059 * get*Extra can have either a {@link #EXTRA_TEXT}
1060 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1061 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1062 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1063 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001064 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1065 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1066 * your text with HTML formatting.
1067 * <p>
1068 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1069 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1070 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1071 * content: URIs and other advanced features of {@link ClipData}. If
1072 * using this approach, you still must supply the same data through the
1073 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1074 * for compatibility with old applications. If you don't set a ClipData,
1075 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001076 * <p>
1077 * Optional standard extras, which may be interpreted by some recipients as
1078 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1079 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1080 * <p>
1081 * Output: nothing.
1082 */
1083 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1084 public static final String ACTION_SEND = "android.intent.action.SEND";
1085 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001086 * Activity Action: Deliver multiple data to someone else.
1087 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001088 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001089 * <p>
1090 * Input: {@link #getType} is the MIME type of the data being sent.
1091 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001092 * #EXTRA_STREAM} field, containing the data to be sent. If using
1093 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1094 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001095 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001096 * Multiple types are supported, and receivers should handle mixed types
1097 * whenever possible. The right way for the receiver to check them is to
1098 * use the content resolver on each URI. The intent sender should try to
1099 * put the most concrete mime type in the intent type, but it can fall
1100 * back to {@literal <type>/*} or {@literal *}/* as needed.
1101 * <p>
1102 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1103 * be image/jpg, but if you are sending image/jpg and image/png, then the
1104 * intent's type should be image/*.
1105 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001106 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1107 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1108 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1109 * content: URIs and other advanced features of {@link ClipData}. If
1110 * using this approach, you still must supply the same data through the
1111 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1112 * for compatibility with old applications. If you don't set a ClipData,
1113 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1114 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001115 * Optional standard extras, which may be interpreted by some recipients as
1116 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1117 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1118 * <p>
1119 * Output: nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1123 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001124 * Activity Action: Handle an incoming phone call.
1125 * <p>Input: nothing.
1126 * <p>Output: nothing.
1127 */
1128 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1129 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1130 /**
1131 * Activity Action: Insert an empty item into the given container.
1132 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1133 * in which to place the data.
1134 * <p>Output: URI of the new data that was created.
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1138 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001139 * Activity Action: Create a new item in the given container, initializing it
1140 * from the current contents of the clipboard.
1141 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1142 * in which to place the data.
1143 * <p>Output: URI of the new data that was created.
1144 */
1145 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1146 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1147 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001148 * Activity Action: Delete the given data from its container.
1149 * <p>Input: {@link #getData} is URI of data to be deleted.
1150 * <p>Output: nothing.
1151 */
1152 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1153 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1154 /**
1155 * Activity Action: Run the data, whatever that means.
1156 * <p>Input: ? (Note: this is currently specific to the test harness.)
1157 * <p>Output: nothing.
1158 */
1159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1160 public static final String ACTION_RUN = "android.intent.action.RUN";
1161 /**
1162 * Activity Action: Perform a data synchronization.
1163 * <p>Input: ?
1164 * <p>Output: ?
1165 */
1166 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1167 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1168 /**
1169 * Activity Action: Pick an activity given an intent, returning the class
1170 * selected.
1171 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1172 * used with {@link PackageManager#queryIntentActivities} to determine the
1173 * set of activities from which to pick.
1174 * <p>Output: Class name of the activity that was selected.
1175 */
1176 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1177 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1178 /**
1179 * Activity Action: Perform a search.
1180 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1181 * is the text to search for. If empty, simply
1182 * enter your search results Activity with the search UI activated.
1183 * <p>Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1187 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001188 * Activity Action: Start the platform-defined tutorial
1189 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1190 * is the text to search for. If empty, simply
1191 * enter your search results Activity with the search UI activated.
1192 * <p>Output: nothing.
1193 */
1194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1195 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1196 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001197 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001198 * <p>
1199 * Input: {@link android.app.SearchManager#QUERY
1200 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1201 * a url starts with http or https, the site will be opened. If it is plain
1202 * text, Google search will be applied.
1203 * <p>
1204 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001209 /**
Jim Miller07994402012-05-02 14:22:27 -07001210 * Activity Action: Perform assist action.
1211 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001212 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1213 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001214 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001215 * Output: nothing.
1216 */
1217 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1218 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001219
1220 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001221 * Activity Action: Perform voice assist action.
1222 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001223 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1224 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001225 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001226 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001227 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1231
1232 /**
Adam Skory7140a252013-09-11 12:04:58 +01001233 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1234 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001235 */
1236 public static final String EXTRA_ASSIST_PACKAGE
1237 = "android.intent.extra.ASSIST_PACKAGE";
1238
1239 /**
Adam Skory7140a252013-09-11 12:04:58 +01001240 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1241 * information supplied by the current foreground app at the time of the assist request.
1242 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001243 */
1244 public static final String EXTRA_ASSIST_CONTEXT
1245 = "android.intent.extra.ASSIST_CONTEXT";
1246
Jim Miller07994402012-05-02 14:22:27 -07001247 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001248 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1249 * keyboard as the primary input device for assistance.
1250 */
1251 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1252 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1253
1254 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001255 * Activity Action: List all available applications
1256 * <p>Input: Nothing.
1257 * <p>Output: nothing.
1258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1261 /**
1262 * Activity Action: Show settings for choosing wallpaper
1263 * <p>Input: Nothing.
1264 * <p>Output: Nothing.
1265 */
1266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1267 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1268
1269 /**
1270 * Activity Action: Show activity for reporting a bug.
1271 * <p>Input: Nothing.
1272 * <p>Output: Nothing.
1273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1276
1277 /**
1278 * Activity Action: Main entry point for factory tests. Only used when
1279 * the device is booting in factory test node. The implementing package
1280 * must be installed in the system image.
1281 * <p>Input: nothing
1282 * <p>Output: nothing
1283 */
1284 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1285
1286 /**
1287 * Activity Action: The user pressed the "call" button to go to the dialer
1288 * or other appropriate UI for placing a call.
1289 * <p>Input: Nothing.
1290 * <p>Output: Nothing.
1291 */
1292 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1293 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1294
1295 /**
1296 * Activity Action: Start Voice Command.
1297 * <p>Input: Nothing.
1298 * <p>Output: Nothing.
1299 */
1300 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1301 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001302
1303 /**
1304 * Activity Action: Start action associated with long pressing on the
1305 * search key.
1306 * <p>Input: Nothing.
1307 * <p>Output: Nothing.
1308 */
1309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1310 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001311
Jacek Surazski86b6c532009-05-13 14:38:28 +02001312 /**
1313 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1314 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001315 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001316 * <p>Input: No data is specified. The bug report is passed in using
1317 * an {@link #EXTRA_BUG_REPORT} field.
1318 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001319 *
1320 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001321 */
1322 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1323 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001324
1325 /**
1326 * Activity Action: Show power usage information to the user.
1327 * <p>Input: Nothing.
1328 * <p>Output: Nothing.
1329 */
1330 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1331 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001332
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001333 /**
1334 * Activity Action: Setup wizard to launch after a platform update. This
1335 * activity should have a string meta-data field associated with it,
1336 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1337 * the platform for setup. The activity will be launched only if
1338 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1339 * same value.
1340 * <p>Input: Nothing.
1341 * <p>Output: Nothing.
1342 * @hide
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001346
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001347 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001348 * Activity Action: Show settings for managing network data usage of a
1349 * specific application. Applications should define an activity that offers
1350 * options to control data usage.
1351 */
1352 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1353 public static final String ACTION_MANAGE_NETWORK_USAGE =
1354 "android.intent.action.MANAGE_NETWORK_USAGE";
1355
1356 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001357 * Activity Action: Launch application installer.
1358 * <p>
1359 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001360 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1361 * you can also use "package:<package-name>" to install an application for the
1362 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001363 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1364 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1365 * <p>
1366 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1367 * succeeded.
1368 *
1369 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1370 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1371 * @see #EXTRA_RETURN_RESULT
1372 */
1373 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1374 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1375
1376 /**
1377 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1378 * package. Specifies the installer package name; this package will receive the
1379 * {@link #ACTION_APP_ERROR} intent.
1380 */
1381 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1382 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1383
1384 /**
1385 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1386 * package. Specifies that the application being installed should not be
1387 * treated as coming from an unknown source, but as coming from the app
1388 * invoking the Intent. For this to work you must start the installer with
1389 * startActivityForResult().
1390 */
1391 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1392 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1393
1394 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001395 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1396 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001397 * data field originated from.
1398 */
rich cannings706e8ba2012-08-20 13:20:14 -07001399 public static final String EXTRA_ORIGINATING_URI
1400 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001401
1402 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001403 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1404 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1405 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001406 */
1407 public static final String EXTRA_REFERRER
1408 = "android.intent.extra.REFERRER";
1409
1410 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001411 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1412 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1413 * @hide
1414 */
1415 public static final String EXTRA_ORIGINATING_UID
1416 = "android.intent.extra.ORIGINATING_UID";
1417
1418 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001419 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1420 * package. Tells the installer UI to skip the confirmation with the user
1421 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001422 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1423 * will no longer show an interstitial message about updating existing
1424 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001425 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001426 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001427 public static final String EXTRA_ALLOW_REPLACE
1428 = "android.intent.extra.ALLOW_REPLACE";
1429
1430 /**
1431 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1432 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1433 * return to the application the result code of the install/uninstall. The returned result
1434 * code will be {@link android.app.Activity#RESULT_OK} on success or
1435 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1436 */
1437 public static final String EXTRA_RETURN_RESULT
1438 = "android.intent.extra.RETURN_RESULT";
1439
1440 /**
1441 * Package manager install result code. @hide because result codes are not
1442 * yet ready to be exposed.
1443 */
1444 public static final String EXTRA_INSTALL_RESULT
1445 = "android.intent.extra.INSTALL_RESULT";
1446
1447 /**
1448 * Activity Action: Launch application uninstaller.
1449 * <p>
1450 * Input: The data must be a package: URI whose scheme specific part is
1451 * the package name of the current installed package to be uninstalled.
1452 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1453 * <p>
1454 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1455 * succeeded.
1456 */
1457 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1458 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1459
1460 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001461 * Specify whether the package should be uninstalled for all users.
1462 * @hide because these should not be part of normal application flow.
1463 */
1464 public static final String EXTRA_UNINSTALL_ALL_USERS
1465 = "android.intent.extra.UNINSTALL_ALL_USERS";
1466
1467 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001468 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1469 * describing the last run version of the platform that was setup.
1470 * @hide
1471 */
1472 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1473
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001474 // ---------------------------------------------------------------------
1475 // ---------------------------------------------------------------------
1476 // Standard intent broadcast actions (see action variable).
1477
1478 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001479 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1480 * <p>
1481 * For historical reasons, the name of this broadcast action refers to the power
1482 * state of the screen but it is actually sent in response to changes in the
1483 * overall interactive state of the device.
1484 * </p><p>
1485 * This broadcast is sent when the device becomes non-interactive which may have
1486 * nothing to do with the screen turning off. To determine the
1487 * actual state of the screen, use {@link android.view.Display#getState}.
1488 * </p><p>
1489 * See {@link android.os.PowerManager#isInteractive} for details.
1490 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001491 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001492 * <p class="note">This is a protected intent that can only be sent
1493 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001494 */
1495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1496 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001497
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001498 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001499 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1500 * <p>
1501 * For historical reasons, the name of this broadcast action refers to the power
1502 * state of the screen but it is actually sent in response to changes in the
1503 * overall interactive state of the device.
1504 * </p><p>
1505 * This broadcast is sent when the device becomes interactive which may have
1506 * nothing to do with the screen turning on. To determine the
1507 * actual state of the screen, use {@link android.view.Display#getState}.
1508 * </p><p>
1509 * See {@link android.os.PowerManager#isInteractive} for details.
1510 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001511 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001512 * <p class="note">This is a protected intent that can only be sent
1513 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 */
1515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1516 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001517
1518 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001519 * Broadcast Action: Sent after the system stops dreaming.
1520 *
1521 * <p class="note">This is a protected intent that can only be sent by the system.
1522 * It is only sent to registered receivers.</p>
1523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1526
1527 /**
1528 * Broadcast Action: Sent after the system starts dreaming.
1529 *
1530 * <p class="note">This is a protected intent that can only be sent by the system.
1531 * It is only sent to registered receivers.</p>
1532 */
1533 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1534 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1535
1536 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001537 * 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 -07001538 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001539 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001540 * <p class="note">This is a protected intent that can only be sent
1541 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001542 */
1543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001544 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001545
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001546 /**
1547 * Broadcast Action: The current time has changed. Sent every
1548 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001549 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001550 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1551 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001552 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001553 * <p class="note">This is a protected intent that can only be sent
1554 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001555 */
1556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1557 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1558 /**
1559 * Broadcast Action: The time was set.
1560 */
1561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1562 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1563 /**
1564 * Broadcast Action: The date has changed.
1565 */
1566 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1567 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1568 /**
1569 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1570 * <ul>
1571 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1572 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001573 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001574 * <p class="note">This is a protected intent that can only be sent
1575 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001576 */
1577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1578 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1579 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001580 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1581 * DNS entries should be tossed.
1582 * @hide
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 * Alarm Changed Action: This is broadcast when the AlarmClock
1588 * application's alarm is set or unset. It is used by the
1589 * AlarmClock application and the StatusBar service.
1590 * @hide
1591 */
1592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1593 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1594 /**
1595 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1596 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1597 * @hide
1598 */
1599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_SYNC_STATE_CHANGED
1601 = "android.intent.action.SYNC_STATE_CHANGED";
1602 /**
1603 * Broadcast Action: This is broadcast once, after the system has finished
1604 * booting. It can be used to perform application-specific initialization,
1605 * such as installing alarms. You must hold the
1606 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1607 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001608 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001609 * <p class="note">This is a protected intent that can only be sent
1610 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001611 */
1612 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1613 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1614 /**
1615 * Broadcast Action: This is broadcast when a user action should request a
1616 * temporary system dialog to dismiss. Some examples of temporary system
1617 * dialogs are the notification window-shade and the recent tasks dialog.
1618 */
1619 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1620 /**
1621 * Broadcast Action: Trigger the download and eventual installation
1622 * of a package.
1623 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001624 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001625 * <p class="note">This is a protected intent that can only be sent
1626 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001627 *
1628 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001630 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1632 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1633 /**
1634 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001635 * device. The data contains the name of the package. Note that the
1636 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001637 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 * <ul>
1639 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1640 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1641 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1642 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001643 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001644 * <p class="note">This is a protected intent that can only be sent
1645 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001646 */
1647 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1648 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1649 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001650 * Broadcast Action: A new version of an application package has been
1651 * installed, replacing an existing version that was previously installed.
1652 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001653 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001654 * <ul>
1655 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1656 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001657 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001658 * <p class="note">This is a protected intent that can only be sent
1659 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001660 */
1661 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1662 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1663 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001664 * Broadcast Action: A new version of your application has been installed
1665 * over an existing one. This is only sent to the application that was
1666 * replaced. It does not contain any additional data; to receive it, just
1667 * use an intent filter for this action.
1668 *
1669 * <p class="note">This is a protected intent that can only be sent
1670 * by the system.
1671 */
1672 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1673 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001675 * Broadcast Action: An existing application package has been removed from
1676 * the device. The data contains the name of the package. The package
1677 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001678 * <ul>
1679 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1680 * to the package.
1681 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1682 * application -- data and code -- is being removed.
1683 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1684 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1685 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001686 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001687 * <p class="note">This is a protected intent that can only be sent
1688 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001689 */
1690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1691 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1692 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001693 * Broadcast Action: An existing application package has been completely
1694 * removed from the device. The data contains the name of the package.
1695 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1696 * {@link #EXTRA_DATA_REMOVED} is true and
1697 * {@link #EXTRA_REPLACING} is false of that broadcast.
1698 *
1699 * <ul>
1700 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1701 * to the package.
1702 * </ul>
1703 *
1704 * <p class="note">This is a protected intent that can only be sent
1705 * by the system.
1706 */
1707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1708 public static final String ACTION_PACKAGE_FULLY_REMOVED
1709 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1710 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001711 * Broadcast Action: An existing application package has been changed (e.g.
1712 * a component has been enabled or disabled). The data contains the name of
1713 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001714 * <ul>
1715 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001716 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001717 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001718 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1719 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001720 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001721 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001722 * <p class="note">This is a protected intent that can only be sent
1723 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001724 */
1725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1726 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1727 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001728 * @hide
1729 * Broadcast Action: Ask system services if there is any reason to
1730 * restart the given package. The data contains the name of the
1731 * package.
1732 * <ul>
1733 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1734 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1735 * </ul>
1736 *
1737 * <p class="note">This is a protected intent that can only be sent
1738 * by the system.
1739 */
1740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1741 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1742 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001743 * Broadcast Action: The user has restarted a package, and all of its
1744 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001745 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001746 * be removed. Note that the restarted package does <em>not</em>
1747 * receive this broadcast.
1748 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001749 * <ul>
1750 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1751 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001752 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001753 * <p class="note">This is a protected intent that can only be sent
1754 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001755 */
1756 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1757 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1758 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001759 * Broadcast Action: The user has cleared the data of a package. This should
1760 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001761 * its persistent data is erased and this broadcast sent.
1762 * Note that the cleared package does <em>not</em>
1763 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001764 * <ul>
1765 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1766 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001767 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001768 * <p class="note">This is a protected intent that can only be sent
1769 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1773 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774 * Broadcast Action: A user ID has been removed from the system. The user
1775 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001776 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001777 * <p class="note">This is a protected intent that can only be sent
1778 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001782
1783 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001784 * Broadcast Action: Sent to the installer package of an application
1785 * when that application is first launched (that is the first time it
1786 * is moved out of the stopped state). The data contains the name of the package.
1787 *
1788 * <p class="note">This is a protected intent that can only be sent
1789 * by the system.
1790 */
1791 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1792 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1793
1794 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001795 * Broadcast Action: Sent to the system package verifier when a package
1796 * needs to be verified. The data contains the package URI.
1797 * <p class="note">
1798 * This is a protected intent that can only be sent by the system.
1799 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001800 */
1801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1802 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1803
1804 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001805 * Broadcast Action: Sent to the system package verifier when a package is
1806 * verified. The data contains the package URI.
1807 * <p class="note">
1808 * This is a protected intent that can only be sent by the system.
1809 */
1810 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1811 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1812
1813 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001814 * Broadcast Action: Resources for a set of packages (which were
1815 * previously unavailable) are currently
1816 * available since the media on which they exist is available.
1817 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1818 * list of packages whose availability changed.
1819 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1820 * list of uids of packages whose availability changed.
1821 * Note that the
1822 * packages in this list do <em>not</em> receive this broadcast.
1823 * The specified set of packages are now available on the system.
1824 * <p>Includes the following extras:
1825 * <ul>
1826 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1827 * whose resources(were previously unavailable) are currently available.
1828 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1829 * packages whose resources(were previously unavailable)
1830 * are currently available.
1831 * </ul>
1832 *
1833 * <p class="note">This is a protected intent that can only be sent
1834 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001835 */
1836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001837 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1838 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001839
1840 /**
1841 * Broadcast Action: Resources for a set of packages are currently
1842 * unavailable since the media on which they exist is unavailable.
1843 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1844 * list of packages whose availability changed.
1845 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1846 * list of uids of packages whose availability changed.
1847 * The specified set of packages can no longer be
1848 * launched and are practically unavailable on the system.
1849 * <p>Inclues the following extras:
1850 * <ul>
1851 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1852 * whose resources are no longer available.
1853 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1854 * whose resources are no longer available.
1855 * </ul>
1856 *
1857 * <p class="note">This is a protected intent that can only be sent
1858 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001859 */
1860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001861 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001862 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001863
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001864 /**
1865 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001866 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001867 * This should <em>only</em> be used to determine when the wallpaper
1868 * has changed to show the new wallpaper to the user. You should certainly
1869 * never, in response to this, change the wallpaper or other attributes of
1870 * it such as the suggested size. That would be crazy, right? You'd cause
1871 * all kinds of loops, especially if other apps are doing similar things,
1872 * right? Of course. So please don't do this.
1873 *
1874 * @deprecated Modern applications should use
1875 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1876 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1877 * shown behind their UI, rather than watching for this broadcast and
1878 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001879 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001880 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1882 /**
1883 * Broadcast Action: The current device {@link android.content.res.Configuration}
1884 * (orientation, locale, etc) has changed. When such a change happens, the
1885 * UIs (view hierarchy) will need to be rebuilt based on this new
1886 * information; for the most part, applications don't need to worry about
1887 * this, because the system will take care of stopping and restarting the
1888 * application to make sure it sees the new changes. Some system code that
1889 * can not be restarted will need to watch for this action and handle it
1890 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001891 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001892 * <p class="note">
1893 * You can <em>not</em> receive this through components declared
1894 * in manifests, only by explicitly registering for it with
1895 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1896 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001897 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001900 *
1901 * @see android.content.res.Configuration
1902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1904 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1905 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001906 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001907 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001908 * <p class="note">This is a protected intent that can only be sent
1909 * by the system.
1910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1913 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001914 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1915 * charging state, level, and other information about the battery.
1916 * See {@link android.os.BatteryManager} for documentation on the
1917 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001918 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 * <p class="note">
1920 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001922 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001923 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1924 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1925 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1926 * broadcasts that are sent and can be received through manifest
1927 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001928 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001929 * <p class="note">This is a protected intent that can only be sent
1930 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 */
1932 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1933 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1934 /**
1935 * Broadcast Action: Indicates low battery condition on the device.
1936 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001937 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001938 * <p class="note">This is a protected intent that can only be sent
1939 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1943 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001944 * Broadcast Action: Indicates the battery is now okay after being low.
1945 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1946 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001947 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001948 * <p class="note">This is a protected intent that can only be sent
1949 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001950 */
1951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1952 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1953 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001954 * Broadcast Action: External power has been connected to the device.
1955 * This is intended for applications that wish to register specifically to this notification.
1956 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1957 * stay active to receive this notification. This action can be used to implement actions
1958 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001959 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001960 * <p class="note">This is a protected intent that can only be sent
1961 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001964 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001965 /**
1966 * Broadcast Action: External power has been removed from the device.
1967 * This is intended for applications that wish to register specifically to this notification.
1968 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1969 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001970 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001971 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001976 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001977 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001978 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001979 * Broadcast Action: Device is shutting down.
1980 * This is broadcast when the device is being shut down (completely turned
1981 * off, not sleeping). Once the broadcast is complete, the final shutdown
1982 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001983 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001984 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001985 * <p class="note">This is a protected intent that can only be sent
1986 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001987 * <p>May include the following extras:
1988 * <ul>
1989 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1990 * shutdown is only for userspace processes. If not set, assumed to be false.
1991 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001994 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001995 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001996 * Activity Action: Start this activity to request system shutdown.
1997 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1998 * to request confirmation from the user before shutting down.
1999 *
2000 * <p class="note">This is a protected intent that can only be sent
2001 * by the system.
2002 *
2003 * {@hide}
2004 */
2005 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2006 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002007 * Broadcast Action: A sticky broadcast that indicates low memory
2008 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002009 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002010 * <p class="note">This is a protected intent that can only be sent
2011 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2015 /**
2016 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002017 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002018 * <p class="note">This is a protected intent that can only be sent
2019 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2023 /**
Jake Hambybb371632010-08-23 18:16:48 -07002024 * Broadcast Action: A sticky broadcast that indicates a memory full
2025 * condition on the device. This is intended for activities that want
2026 * to be able to fill the data partition completely, leaving only
2027 * enough free space to prevent system-wide SQLite failures.
2028 *
2029 * <p class="note">This is a protected intent that can only be sent
2030 * by the system.
2031 *
2032 * {@hide}
2033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2036 /**
2037 * Broadcast Action: Indicates memory full condition on the device
2038 * no longer exists.
2039 *
2040 * <p class="note">This is a protected intent that can only be sent
2041 * by the system.
2042 *
2043 * {@hide}
2044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2047 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002048 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2049 * and package management should be started.
2050 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2051 * notification.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2055 /**
2056 * Broadcast Action: The device has entered USB Mass Storage mode.
2057 * This is used mainly for the USB Settings panel.
2058 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2059 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002060 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002061 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002062 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002063 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2064
2065 /**
2066 * Broadcast Action: The device has exited USB Mass Storage mode.
2067 * This is used mainly for the USB Settings panel.
2068 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2069 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002070 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002071 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002072 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2074
2075 /**
2076 * Broadcast Action: External media has been removed.
2077 * The path to the mount point for the removed media is contained in the Intent.mData field.
2078 */
2079 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2081
2082 /**
2083 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002084 * 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 -07002085 */
2086 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2087 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2088
2089 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002090 * Broadcast Action: External media is present, and being disk-checked
2091 * 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 -08002092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2095
2096 /**
2097 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2098 * 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 -08002099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2102
2103 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002104 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002105 * 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 -07002106 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2107 * media was mounted read only.
2108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2111
2112 /**
2113 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002114 * 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 -07002115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2118
2119 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002120 * Broadcast Action: External media is no longer being shared via USB mass storage.
2121 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2122 *
2123 * @hide
2124 */
2125 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2126
2127 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2129 * The path to the mount point for the removed media is contained in the Intent.mData field.
2130 */
2131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2132 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2133
2134 /**
2135 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002136 * 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 -07002137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2140
2141 /**
2142 * Broadcast Action: User has expressed the desire to remove the external storage media.
2143 * Applications should close all files they have open within the mount point when they receive this intent.
2144 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2145 */
2146 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2147 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2148
2149 /**
2150 * Broadcast Action: The media scanner has started scanning a directory.
2151 * The path to the directory being scanned is contained in the Intent.mData field.
2152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2155
2156 /**
2157 * Broadcast Action: The media scanner has finished scanning a directory.
2158 * The path to the scanned directory is contained in the Intent.mData field.
2159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2162
2163 /**
2164 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2165 * The path to the file is contained in the Intent.mData field.
2166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2169
2170 /**
2171 * Broadcast Action: The "Media Button" was pressed. Includes a single
2172 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2173 * caused the broadcast.
2174 */
2175 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2176 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2177
2178 /**
2179 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2180 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2181 * caused the broadcast.
2182 */
2183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2185
2186 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2187 // location; they are not general-purpose actions.
2188
2189 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002190 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2194 "android.intent.action.GTALK_CONNECTED";
2195
2196 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002197 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2201 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002202
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002203 /**
2204 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002205 */
2206 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2207 public static final String ACTION_INPUT_METHOD_CHANGED =
2208 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002209
2210 /**
2211 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2212 * more radios have been turned off or on. The intent will have the following extra value:</p>
2213 * <ul>
2214 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2215 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2216 * turned off</li>
2217 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002218 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002219 * <p class="note">This is a protected intent that can only be sent
2220 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002221 */
2222 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2223 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2224
2225 /**
2226 * Broadcast Action: Some content providers have parts of their namespace
2227 * where they publish new events or items that the user may be especially
2228 * interested in. For these things, they may broadcast this action when the
2229 * set of interesting items change.
2230 *
2231 * For example, GmailProvider sends this notification when the set of unread
2232 * mail in the inbox changes.
2233 *
2234 * <p>The data of the intent identifies which part of which provider
2235 * changed. When queried through the content resolver, the data URI will
2236 * return the data set in question.
2237 *
2238 * <p>The intent will have the following extra values:
2239 * <ul>
2240 * <li><em>count</em> - The number of items in the data set. This is the
2241 * same as the number of items in the cursor returned by querying the
2242 * data URI. </li>
2243 * </ul>
2244 *
2245 * This intent will be sent at boot (if the count is non-zero) and when the
2246 * data set changes. It is possible for the data set to change without the
2247 * count changing (for example, if a new unread message arrives in the same
2248 * sync operation in which a message is archived). The phone should still
2249 * ring/vibrate/etc as normal in this case.
2250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_PROVIDER_CHANGED =
2253 "android.intent.action.PROVIDER_CHANGED";
2254
2255 /**
2256 * Broadcast Action: Wired Headset plugged in or unplugged.
2257 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002258 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2259 * and documentation.
2260 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002261 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002262 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002263 */
2264 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002265 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002266
2267 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002268 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2269 * <ul>
2270 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2271 * </ul>
2272 *
2273 * <p class="note">This is a protected intent that can only be sent
2274 * by the system.
2275 *
2276 * @hide
2277 */
2278 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2279 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2280 = "android.intent.action.ADVANCED_SETTINGS";
2281
2282 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002283 * Broadcast Action: Sent after application restrictions are changed.
2284 *
2285 * <p class="note">This is a protected intent that can only be sent
2286 * by the system.</p>
2287 */
2288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2289 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2290 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2291
2292 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 * Broadcast Action: An outgoing call is about to be placed.
2294 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002295 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002296 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002297 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 * the phone number originally intended to be dialed.</li>
2299 * </ul>
2300 * <p>Once the broadcast is finished, the resultData is used as the actual
2301 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002302 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002303 * outgoing call in turn: for example, a parental control application
2304 * might verify that the user is authorized to place the call at that
2305 * time, then a number-rewriting application might add an area code if
2306 * one was not specified.</p>
2307 * <p>For consistency, any receiver whose purpose is to prohibit phone
2308 * calls should have a priority of 0, to ensure it will see the final
2309 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002310 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002311 * should have a positive priority.
2312 * Negative priorities are reserved for the system for this broadcast;
2313 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002314 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2315 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 * <p>Emergency calls cannot be intercepted using this mechanism, and
2317 * other calls cannot be modified to call emergency numbers using this
2318 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002319 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2320 * call to use their own service instead. Those apps should first prevent
2321 * the call from being placed by setting resultData to <code>null</code>
2322 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002323 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2325 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002326 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002327 * <p class="note">This is a protected intent that can only be sent
2328 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_NEW_OUTGOING_CALL =
2332 "android.intent.action.NEW_OUTGOING_CALL";
2333
2334 /**
2335 * Broadcast Action: Have the device reboot. This is only for use by
2336 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002337 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002338 * <p class="note">This is a protected intent that can only be sent
2339 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002340 */
2341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2342 public static final String ACTION_REBOOT =
2343 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002344
Wei Huang97ecc9c2009-05-11 17:44:20 -07002345 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002346 * Broadcast Action: A sticky broadcast for changes in the physical
2347 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002348 *
2349 * <p>The intent will have the following extra values:
2350 * <ul>
2351 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002352 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002353 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002354 * <p>This is intended for monitoring the current physical dock state.
2355 * See {@link android.app.UiModeManager} for the normal API dealing with
2356 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002357 */
2358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2359 public static final String ACTION_DOCK_EVENT =
2360 "android.intent.action.DOCK_EVENT";
2361
2362 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002363 * Broadcast Action: A broadcast when idle maintenance can be started.
2364 * This means that the user is not interacting with the device and is
2365 * not expected to do so soon. Typical use of the idle maintenance is
2366 * to perform somehow expensive tasks that can be postponed at a moment
2367 * when they will not degrade user experience.
2368 * <p>
2369 * <p class="note">In order to keep the device responsive in case of an
2370 * unexpected user interaction, implementations of a maintenance task
2371 * should be interruptible. In such a scenario a broadcast with action
2372 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2373 * should not do the maintenance work in
2374 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2375 * maintenance service by {@link Context#startService(Intent)}. Also
2376 * you should hold a wake lock while your maintenance service is running
2377 * to prevent the device going to sleep.
2378 * </p>
2379 * <p>
2380 * <p class="note">This is a protected intent that can only be sent by
2381 * the system.
2382 * </p>
2383 *
2384 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002385 *
2386 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002387 */
2388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2389 public static final String ACTION_IDLE_MAINTENANCE_START =
2390 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2391
2392 /**
2393 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2394 * This means that the user was not interacting with the device as a result
2395 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2396 * was sent and now the user started interacting with the device. Typical
2397 * use of the idle maintenance is to perform somehow expensive tasks that
2398 * can be postponed at a moment when they will not degrade user experience.
2399 * <p>
2400 * <p class="note">In order to keep the device responsive in case of an
2401 * unexpected user interaction, implementations of a maintenance task
2402 * should be interruptible. Hence, on receiving a broadcast with this
2403 * action, the maintenance task should be interrupted as soon as possible.
2404 * In other words, you should not do the maintenance work in
2405 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2406 * maintenance service that was started on receiving of
2407 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2408 * lock you acquired when your maintenance service started.
2409 * </p>
2410 * <p class="note">This is a protected intent that can only be sent
2411 * by the system.
2412 *
2413 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002414 *
2415 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002416 */
2417 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2418 public static final String ACTION_IDLE_MAINTENANCE_END =
2419 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2420
2421 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002422 * Broadcast Action: a remote intent is to be broadcasted.
2423 *
2424 * A remote intent is used for remote RPC between devices. The remote intent
2425 * is serialized and sent from one device to another device. The receiving
2426 * device parses the remote intent and broadcasts it. Note that anyone can
2427 * broadcast a remote intent. However, if the intent receiver of the remote intent
2428 * does not trust intent broadcasts from arbitrary intent senders, it should require
2429 * the sender to hold certain permissions so only trusted sender's broadcast will be
2430 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002431 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002432 */
2433 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002434 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002435
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002436 /**
2437 * Broadcast Action: hook for permforming cleanup after a system update.
2438 *
2439 * The broadcast is sent when the system is booting, before the
2440 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2441 * image. A receiver for this should do its work and then disable itself
2442 * so that it does not get run again at the next boot.
2443 * @hide
2444 */
2445 public static final String ACTION_PRE_BOOT_COMPLETED =
2446 "android.intent.action.PRE_BOOT_COMPLETED";
2447
Amith Yamasani13593602012-03-22 16:16:17 -07002448 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002449 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002450 * on restricted users. The broadcast intent contains an extra
2451 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2452 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2453 * String[] depending on the restriction type.<p/>
2454 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002455 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2456 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2457 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002458 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2459 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002460 * @see RestrictionEntry
2461 */
2462 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2463 "android.intent.action.GET_RESTRICTION_ENTRIES";
2464
2465 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002466 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002467 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002468 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2469 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2470 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002471 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2472 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2473 * challenge.<p/>
2474 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002475 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002476 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002477 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2478 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002479
2480 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002481 * Sent the first time a user is starting, to allow system apps to
2482 * perform one time initialization. (This will not be seen by third
2483 * party applications because a newly initialized user does not have any
2484 * third party applications installed for it.) This is sent early in
2485 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002486 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2487 * broadcast, since it is part of a visible user interaction; be as quick
2488 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002489 */
2490 public static final String ACTION_USER_INITIALIZE =
2491 "android.intent.action.USER_INITIALIZE";
2492
2493 /**
2494 * Sent when a user switch is happening, causing the process's user to be
2495 * brought to the foreground. This is only sent to receivers registered
2496 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2497 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002498 * foreground. This is sent as a foreground
2499 * broadcast, since it is part of a visible user interaction; be as quick
2500 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002501 */
2502 public static final String ACTION_USER_FOREGROUND =
2503 "android.intent.action.USER_FOREGROUND";
2504
2505 /**
2506 * Sent when a user switch is happening, causing the process's user to be
2507 * sent to the background. This is only sent to receivers registered
2508 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2509 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002510 * background. This is sent as a foreground
2511 * broadcast, since it is part of a visible user interaction; be as quick
2512 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002513 */
2514 public static final String ACTION_USER_BACKGROUND =
2515 "android.intent.action.USER_BACKGROUND";
2516
2517 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002518 * Broadcast sent to the system when a user is added. Carries an extra
2519 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2520 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002521 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002522 * @hide
2523 */
2524 public static final String ACTION_USER_ADDED =
2525 "android.intent.action.USER_ADDED";
2526
2527 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002528 * Broadcast sent by the system when a user is started. Carries an extra
2529 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002530 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002531 * that has been started. This is sent as a foreground
2532 * broadcast, since it is part of a visible user interaction; be as quick
2533 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002534 * @hide
2535 */
2536 public static final String ACTION_USER_STARTED =
2537 "android.intent.action.USER_STARTED";
2538
2539 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002540 * Broadcast sent when a user is in the process of starting. Carries an extra
2541 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2542 * sent to registered receivers, not manifest receivers. It is sent to all
2543 * users (including the one that is being started). You must hold
2544 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2545 * this broadcast. This is sent as a background broadcast, since
2546 * its result is not part of the primary UX flow; to safely keep track of
2547 * started/stopped state of a user you can use this in conjunction with
2548 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2549 * other user state broadcasts since those are foreground broadcasts so can
2550 * execute in a different order.
2551 * @hide
2552 */
2553 public static final String ACTION_USER_STARTING =
2554 "android.intent.action.USER_STARTING";
2555
2556 /**
2557 * Broadcast sent when a user is going to be stopped. Carries an extra
2558 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2559 * sent to registered receivers, not manifest receivers. It is sent to all
2560 * users (including the one that is being stopped). You must hold
2561 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2562 * this broadcast. The user will not stop until all receivers have
2563 * handled the broadcast. This is sent as a background broadcast, since
2564 * its result is not part of the primary UX flow; to safely keep track of
2565 * started/stopped state of a user you can use this in conjunction with
2566 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2567 * other user state broadcasts since those are foreground broadcasts so can
2568 * execute in a different order.
2569 * @hide
2570 */
2571 public static final String ACTION_USER_STOPPING =
2572 "android.intent.action.USER_STOPPING";
2573
2574 /**
2575 * Broadcast sent to the system when a user is stopped. Carries an extra
2576 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2577 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2578 * specific package. This is only sent to registered receivers, not manifest
2579 * receivers. It is sent to all running users <em>except</em> the one that
2580 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002581 * @hide
2582 */
2583 public static final String ACTION_USER_STOPPED =
2584 "android.intent.action.USER_STOPPED";
2585
2586 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002587 * 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 -07002588 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002589 * one that has been removed. The user will not be completely removed until all receivers have
2590 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002591 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002592 * @hide
2593 */
2594 public static final String ACTION_USER_REMOVED =
2595 "android.intent.action.USER_REMOVED";
2596
2597 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002598 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002599 * the userHandle of the user to become the current one. This is only sent to
2600 * registered receivers, not manifest receivers. It is sent to all running users.
2601 * You must hold
2602 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002603 * @hide
2604 */
2605 public static final String ACTION_USER_SWITCHED =
2606 "android.intent.action.USER_SWITCHED";
2607
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002608 /**
2609 * Broadcast sent to the system when a user's information changes. Carries an extra
2610 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002611 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002612 * @hide
2613 */
2614 public static final String ACTION_USER_INFO_CHANGED =
2615 "android.intent.action.USER_INFO_CHANGED";
2616
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002617 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002618 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2619 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002620 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2621 * that need to display merged content across both primary and managed profiles need to
2622 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002623 * not manifest receivers.
2624 */
2625 public static final String ACTION_MANAGED_PROFILE_ADDED =
2626 "android.intent.action.MANAGED_PROFILE_ADDED";
2627
2628 /**
2629 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002630 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2631 * Only applications (for example Launchers) that need to display merged content across both
2632 * primary and managed profiles need to worry about this broadcast. This is only sent to
2633 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002634 */
2635 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2636 "android.intent.action.MANAGED_PROFILE_REMOVED";
2637
2638 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002639 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2640 */
2641 public static final String ACTION_QUICK_CLOCK =
2642 "android.intent.action.QUICK_CLOCK";
2643
Michael Wright0087a142013-02-05 16:29:39 -08002644 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002645 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002646 * @hide
2647 */
2648 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2649 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2650
Justin Kohd378ad72013-04-01 12:18:26 -07002651 /**
2652 * Broadcast Action: A global button was pressed. Includes a single
2653 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2654 * caused the broadcast.
2655 * @hide
2656 */
2657 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2658
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002659 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002660 * Activity Action: Allow the user to select and return one or more existing
2661 * documents. When invoked, the system will display the various
2662 * {@link DocumentsProvider} instances installed on the device, letting the
2663 * user interactively navigate through them. These documents include local
2664 * media, such as photos and video, and documents provided by installed
2665 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002666 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002667 * Each document is represented as a {@code content://} URI backed by a
2668 * {@link DocumentsProvider}, which can be opened as a stream with
2669 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2670 * {@link android.provider.DocumentsContract.Document} metadata.
2671 * <p>
2672 * All selected documents are returned to the calling application with
2673 * persistable read and write permission grants. If you want to maintain
2674 * access to the documents across device reboots, you need to explicitly
2675 * take the persistable permissions using
2676 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2677 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002678 * Callers must indicate the acceptable document MIME types through
2679 * {@link #setType(String)}. For example, to select photos, use
2680 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2681 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2682 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002683 * <p>
2684 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002685 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2686 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002687 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002688 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2689 * returned URIs can be opened with
2690 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002691 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002692 * Output: The URI of the item that was picked, returned in
2693 * {@link #getData()}. This must be a {@code content://} URI so that any
2694 * receiver can access it. If multiple documents were selected, they are
2695 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002696 *
2697 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002698 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002699 * @see #ACTION_CREATE_DOCUMENT
2700 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002701 */
2702 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2703 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2704
2705 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002706 * Activity Action: Allow the user to create a new document. When invoked,
2707 * the system will display the various {@link DocumentsProvider} instances
2708 * installed on the device, letting the user navigate through them. The
2709 * returned document may be a newly created document with no content, or it
2710 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002711 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002712 * Each document is represented as a {@code content://} URI backed by a
2713 * {@link DocumentsProvider}, which can be opened as a stream with
2714 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2715 * {@link android.provider.DocumentsContract.Document} metadata.
2716 * <p>
2717 * Callers must indicate the concrete MIME type of the document being
2718 * created by setting {@link #setType(String)}. This MIME type cannot be
2719 * changed after the document is created.
2720 * <p>
2721 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2722 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002723 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002724 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2725 * returned URIs can be opened with
2726 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002727 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002728 * Output: The URI of the item that was created. This must be a
2729 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002730 *
2731 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002732 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002733 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002734 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002735 */
2736 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2737 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2738
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002739 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002740 * Activity Action: Allow the user to pick a directory subtree. When
2741 * invoked, the system will display the various {@link DocumentsProvider}
2742 * instances installed on the device, letting the user navigate through
2743 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002744 * <p>
2745 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002746 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2747 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2748 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002749 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002750 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002751 *
2752 * @see DocumentsContract
2753 */
2754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002755 public static final String
2756 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002757
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002758 /** {@hide} */
2759 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2760
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002761 // ---------------------------------------------------------------------
2762 // ---------------------------------------------------------------------
2763 // Standard intent categories (see addCategory()).
2764
2765 /**
2766 * Set if the activity should be an option for the default action
2767 * (center press) to perform on a piece of data. Setting this will
2768 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002769 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002770 * Intent when initiating an action -- it is for use in intent filters
2771 * specified in packages.
2772 */
2773 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2774 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2775 /**
2776 * Activities that can be safely invoked from a browser must support this
2777 * category. For example, if the user is viewing a web page or an e-mail
2778 * and clicks on a link in the text, the Intent generated execute that
2779 * link will require the BROWSABLE category, so that only activities
2780 * supporting this category will be considered as possible actions. By
2781 * supporting this category, you are promising that there is nothing
2782 * damaging (without user intervention) that can happen by invoking any
2783 * matching Intent.
2784 */
2785 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2786 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2787 /**
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002788 * @hide
Dianne Hackborn91097de2014-04-04 18:02:06 -07002789 * Categories for activities that can participate in voice interaction.
2790 * An activity that supports this category must be prepared to run with
2791 * no UI shown at all (though in some case it may have a UI shown), and
2792 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2793 */
2794 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002795 @SystemApi
Dianne Hackborn91097de2014-04-04 18:02:06 -07002796 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2797 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 * Set if the activity should be considered as an alternative action to
2799 * the data the user is currently viewing. See also
2800 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2801 * applies to the selection in a list of items.
2802 *
2803 * <p>Supporting this category means that you would like your activity to be
2804 * displayed in the set of alternative things the user can do, usually as
2805 * part of the current activity's options menu. You will usually want to
2806 * include a specific label in the &lt;intent-filter&gt; of this action
2807 * describing to the user what it does.
2808 *
2809 * <p>The action of IntentFilter with this category is important in that it
2810 * describes the specific action the target will perform. This generally
2811 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2812 * a specific name such as "com.android.camera.action.CROP. Only one
2813 * alternative of any particular action will be shown to the user, so using
2814 * a specific action like this makes sure that your alternative will be
2815 * displayed while also allowing other applications to provide their own
2816 * overrides of that particular action.
2817 */
2818 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2819 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2820 /**
2821 * Set if the activity should be considered as an alternative selection
2822 * action to the data the user has currently selected. This is like
2823 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2824 * of items from which the user can select, giving them alternatives to the
2825 * default action that will be performed on it.
2826 */
2827 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2828 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2829 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002830 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002831 */
2832 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2833 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2834 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002835 * Should be displayed in the top-level launcher.
2836 */
2837 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2838 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2839 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002840 * Indicates an activity optimized for Leanback mode, and that should
2841 * be displayed in the Leanback launcher.
2842 */
2843 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2844 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2845 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002846 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2847 * @hide
2848 */
2849 @SystemApi
2850 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2851 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002852 * Provides information about the package it is in; typically used if
2853 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2854 * a front-door to the user without having to be shown in the all apps list.
2855 */
2856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2857 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 * This is the home activity, that is the first activity that is displayed
2860 * when the device boots.
2861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2864 /**
2865 * This activity is a preference panel.
2866 */
2867 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2868 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2869 /**
2870 * This activity is a development preference panel.
2871 */
2872 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2873 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2874 /**
2875 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002876 */
2877 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2878 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2879 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002880 * This activity allows the user to browse and download new applications.
2881 */
2882 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2883 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2884 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002885 * This activity may be exercised by the monkey or other automated test tools.
2886 */
2887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2888 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2889 /**
2890 * To be used as a test (not part of the normal user experience).
2891 */
2892 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2893 /**
2894 * To be used as a unit test (run through the Test Harness).
2895 */
2896 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2897 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002898 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002899 * experience).
2900 */
2901 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002902
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002903 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002904 * Used to indicate that an intent only wants URIs that can be opened with
2905 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2906 * must support at least the columns defined in {@link OpenableColumns} when
2907 * queried.
2908 *
2909 * @see #ACTION_GET_CONTENT
2910 * @see #ACTION_OPEN_DOCUMENT
2911 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002912 */
2913 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2914 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2915
2916 /**
2917 * To be used as code under test for framework instrumentation tests.
2918 */
2919 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2920 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002921 /**
2922 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002923 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2924 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002925 */
2926 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2927 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2928 /**
2929 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002930 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2931 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002932 */
2933 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2934 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002935 /**
2936 * An activity to run when device is inserted into a analog (low end) dock.
2937 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2938 * information, see {@link android.app.UiModeManager}.
2939 */
2940 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2941 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2942
2943 /**
2944 * An activity to run when device is inserted into a digital (high end) dock.
2945 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2946 * information, see {@link android.app.UiModeManager}.
2947 */
2948 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2949 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002950
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002951 /**
2952 * Used to indicate that the activity can be used in a car environment.
2953 */
2954 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2955 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002957 // ---------------------------------------------------------------------
2958 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002959 // Application launch intent categories (see addCategory()).
2960
2961 /**
2962 * Used with {@link #ACTION_MAIN} to launch the browser application.
2963 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002964 * <p>NOTE: This should not be used as the primary key of an Intent,
2965 * since it will not result in the app launching with the correct
2966 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002967 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002968 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002969 */
2970 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2971 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2972
2973 /**
2974 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2975 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002976 * <p>NOTE: This should not be used as the primary key of an Intent,
2977 * since it will not result in the app launching with the correct
2978 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002979 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002980 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002981 */
2982 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2983 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2984
2985 /**
2986 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2987 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002988 * <p>NOTE: This should not be used as the primary key of an Intent,
2989 * since it will not result in the app launching with the correct
2990 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002991 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002992 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002993 */
2994 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2995 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2996
2997 /**
2998 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2999 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003000 * <p>NOTE: This should not be used as the primary key of an Intent,
3001 * since it will not result in the app launching with the correct
3002 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003003 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003004 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003005 */
3006 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3007 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3008
3009 /**
3010 * Used with {@link #ACTION_MAIN} to launch the email application.
3011 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003012 * <p>NOTE: This should not be used as the primary key of an Intent,
3013 * since it will not result in the app launching with the correct
3014 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003015 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003016 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003017 */
3018 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3019 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3020
3021 /**
3022 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3023 * The activity should be able to view and manipulate image and video files
3024 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003025 * <p>NOTE: This should not be used as the primary key of an Intent,
3026 * since it will not result in the app launching with the correct
3027 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003028 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003029 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003030 */
3031 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3032 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3033
3034 /**
3035 * Used with {@link #ACTION_MAIN} to launch the maps application.
3036 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003037 * <p>NOTE: This should not be used as the primary key of an Intent,
3038 * since it will not result in the app launching with the correct
3039 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003040 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003041 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003042 */
3043 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3044 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3045
3046 /**
3047 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3048 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003049 * <p>NOTE: This should not be used as the primary key of an Intent,
3050 * since it will not result in the app launching with the correct
3051 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003052 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003053 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003054 */
3055 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3056 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3057
3058 /**
3059 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003060 * The activity should be able to play, browse, or manipulate music files
3061 * stored on the device.
3062 * <p>NOTE: This should not be used as the primary key of an Intent,
3063 * since it will not result in the app launching with the correct
3064 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003065 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003066 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003067 */
3068 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3069 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3070
3071 // ---------------------------------------------------------------------
3072 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003073 // Standard extra data keys.
3074
3075 /**
3076 * The initial data to place in a newly created record. Use with
3077 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3078 * fields as would be given to the underlying ContentProvider.insert()
3079 * call.
3080 */
3081 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3082
3083 /**
3084 * A constant CharSequence that is associated with the Intent, used with
3085 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3086 * this may be a styled CharSequence, so you must use
3087 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3088 * retrieve it.
3089 */
3090 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3091
3092 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003093 * A constant String that is associated with the Intent, used with
3094 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3095 * as HTML formatted text. Note that you <em>must</em> also supply
3096 * {@link #EXTRA_TEXT}.
3097 */
3098 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3099
3100 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003101 * A content: URI holding a stream of data associated with the Intent,
3102 * used with {@link #ACTION_SEND} to supply the data being sent.
3103 */
3104 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3105
3106 /**
3107 * A String[] holding e-mail addresses that should be delivered to.
3108 */
3109 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3110
3111 /**
3112 * A String[] holding e-mail addresses that should be carbon copied.
3113 */
3114 public static final String EXTRA_CC = "android.intent.extra.CC";
3115
3116 /**
3117 * A String[] holding e-mail addresses that should be blind carbon copied.
3118 */
3119 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3120
3121 /**
3122 * A constant string holding the desired subject line of a message.
3123 */
3124 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3125
3126 /**
3127 * An Intent describing the choices you would like shown with
3128 * {@link #ACTION_PICK_ACTIVITY}.
3129 */
3130 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3131
3132 /**
3133 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003134 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003135 */
3136 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3137
3138 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003139 * A Parcelable[] of {@link Intent} or
3140 * {@link android.content.pm.LabeledIntent} objects as set with
3141 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3142 * a the front of the list of choices, when shown to the user with a
3143 * {@link #ACTION_CHOOSER}.
3144 */
3145 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3146
3147 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003148 * A Bundle forming a mapping of potential target package names to different extras Bundles
3149 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3150 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3151 * be currently installed on the device.
3152 *
3153 * <p>An application may choose to provide alternate extras for the case where a user
3154 * selects an activity from a predetermined set of target packages. If the activity
3155 * the user selects from the chooser belongs to a package with its package name as
3156 * a key in this bundle, the corresponding extras for that package will be merged with
3157 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3158 * extra has the same key as an extra already present in the intent it will overwrite
3159 * the extra from the intent.</p>
3160 *
3161 * <p><em>Examples:</em>
3162 * <ul>
3163 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3164 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3165 * parameters for that target.</li>
3166 * <li>An application may offer additional metadata for known targets of a given intent
3167 * to pass along information only relevant to that target such as account or content
3168 * identifiers already known to that application.</li>
3169 * </ul></p>
3170 */
3171 public static final String EXTRA_REPLACEMENT_EXTRAS =
3172 "android.intent.extra.REPLACEMENT_EXTRAS";
3173
3174 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003175 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3176 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3177 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3178 * {@link ComponentName} of the chosen component.
3179 *
3180 * <p>In some situations this callback may never come, for example if the user abandons
3181 * the chooser, switches to another task or any number of other reasons. Apps should not
3182 * be written assuming that this callback will always occur.</p>
3183 */
3184 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3185 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3186
3187 /**
3188 * The {@link ComponentName} chosen by the user to complete an action.
3189 *
3190 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3191 */
3192 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3193
3194 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 * A {@link android.view.KeyEvent} object containing the event that
3196 * triggered the creation of the Intent it is in.
3197 */
3198 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3199
3200 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003201 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3202 * before shutting down.
3203 *
3204 * {@hide}
3205 */
3206 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3207
3208 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003209 * 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 -07003210 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3211 * of restarting the application.
3212 */
3213 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3214
3215 /**
3216 * A String holding the phone number originally entered in
3217 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3218 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3219 */
3220 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003221
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003222 /**
3223 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3224 * intents to supply the uid the package had been assigned. Also an optional
3225 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3226 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3227 * purpose.
3228 */
3229 public static final String EXTRA_UID = "android.intent.extra.UID";
3230
3231 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003232 * @hide String array of package names.
3233 */
3234 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3235
3236 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003237 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3238 * intents to indicate whether this represents a full uninstall (removing
3239 * both the code and its data) or a partial uninstall (leaving its data,
3240 * implying that this is an update).
3241 */
3242 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003243
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003244 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003245 * @hide
3246 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3247 * intents to indicate that at this point the package has been removed for
3248 * all users on the device.
3249 */
3250 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3251 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3252
3253 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003254 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3255 * intents to indicate that this is a replacement of the package, so this
3256 * broadcast will immediately be followed by an add broadcast for a
3257 * different version of the same package.
3258 */
3259 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003260
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003261 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003262 * Used as an int extra field in {@link android.app.AlarmManager} intents
3263 * to tell the application being invoked how many pending alarms are being
3264 * delievered with the intent. For one-shot alarms this will always be 1.
3265 * For recurring alarms, this might be greater than 1 if the device was
3266 * asleep or powered off at the time an earlier alarm would have been
3267 * delivered.
3268 */
3269 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003270
Jacek Surazski86b6c532009-05-13 14:38:28 +02003271 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003272 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3273 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003274 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3275 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003276 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3277 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3278 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003279 */
3280 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3281
3282 /**
3283 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3284 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003285 */
3286 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3287
3288 /**
3289 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3290 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003291 */
3292 public static final int EXTRA_DOCK_STATE_DESK = 1;
3293
3294 /**
3295 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3296 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003297 */
3298 public static final int EXTRA_DOCK_STATE_CAR = 2;
3299
3300 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003301 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3302 * to represent that the phone is in a analog (low end) dock.
3303 */
3304 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3305
3306 /**
3307 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3308 * to represent that the phone is in a digital (high end) dock.
3309 */
3310 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3311
3312 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003313 * Boolean that can be supplied as meta-data with a dock activity, to
3314 * indicate that the dock should take over the home key when it is active.
3315 */
3316 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003317
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003318 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003319 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3320 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003321 */
3322 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3323
3324 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003325 * Used in the extra field in the remote intent. It's astring token passed with the
3326 * remote intent.
3327 */
3328 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3329 "android.intent.extra.remote_intent_token";
3330
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003331 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003332 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003333 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003334 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003335 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003336 "android.intent.extra.changed_component_name";
3337
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003338 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003339 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003340 * and contains a string array of all of the components that have changed. If
3341 * the state of the overall package has changed, then it will contain an entry
3342 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003343 */
3344 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3345 "android.intent.extra.changed_component_name_list";
3346
3347 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003348 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003349 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3350 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003351 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003352 */
3353 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3354 "android.intent.extra.changed_package_list";
3355
3356 /**
3357 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003358 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3359 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003360 * and contains an integer array of uids of all of the components
3361 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003362 */
3363 public static final String EXTRA_CHANGED_UID_LIST =
3364 "android.intent.extra.changed_uid_list";
3365
3366 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003367 * @hide
3368 * Magic extra system code can use when binding, to give a label for
3369 * who it is that has bound to a service. This is an integer giving
3370 * a framework string resource that can be displayed to the user.
3371 */
3372 public static final String EXTRA_CLIENT_LABEL =
3373 "android.intent.extra.client_label";
3374
3375 /**
3376 * @hide
3377 * Magic extra system code can use when binding, to give a PendingIntent object
3378 * that can be launched for the user to disable the system's use of this
3379 * service.
3380 */
3381 public static final String EXTRA_CLIENT_INTENT =
3382 "android.intent.extra.client_intent";
3383
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003384 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003385 * Extra used to indicate that an intent should only return data that is on
3386 * the local device. This is a boolean extra; the default is false. If true,
3387 * an implementation should only allow the user to select data that is
3388 * already on the device, not requiring it be downloaded from a remote
3389 * service when opened.
3390 *
3391 * @see #ACTION_GET_CONTENT
3392 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003393 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003394 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003395 */
3396 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003397 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003398
Amith Yamasani13593602012-03-22 16:16:17 -07003399 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003400 * Extra used to indicate that an intent can allow the user to select and
3401 * return multiple items. This is a boolean extra; the default is false. If
3402 * true, an implementation is allowed to present the user with a UI where
3403 * they can pick multiple items that are all returned to the caller. When
3404 * this happens, they should be returned as the {@link #getClipData()} part
3405 * of the result Intent.
3406 *
3407 * @see #ACTION_GET_CONTENT
3408 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003409 */
3410 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003411 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003412
3413 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003414 * The integer userHandle carried with broadcast intents related to addition, removal and
3415 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3416 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3417 *
Amith Yamasani13593602012-03-22 16:16:17 -07003418 * @hide
3419 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003420 public static final String EXTRA_USER_HANDLE =
3421 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003422
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003423 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003424 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3425 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3426 */
3427 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003428 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003429
3430 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003431 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003432 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3433 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003434 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003435 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3436
3437 /**
3438 * Extra sent in the intent to the BroadcastReceiver that handles
3439 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3440 * the restrictions as key/value pairs.
3441 */
3442 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3443 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003444
Amith Yamasani86118ba2013-03-28 14:33:16 -07003445 /**
3446 * Extra used in the response from a BroadcastReceiver that handles
3447 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3448 */
3449 public static final String EXTRA_RESTRICTIONS_INTENT =
3450 "android.intent.extra.restrictions_intent";
3451
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003452 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003453 * Extra used to communicate a set of acceptable MIME types. The type of the
3454 * extra is {@code String[]}. Values may be a combination of concrete MIME
3455 * types (such as "image/png") and/or partial MIME types (such as
3456 * "audio/*").
3457 *
3458 * @see #ACTION_GET_CONTENT
3459 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003460 */
3461 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3462
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003463 /**
3464 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3465 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003466 * When this is true, hardware devices can use this information to determine that
3467 * they shouldn't do a complete shutdown of their device since this is not a
3468 * complete shutdown down to the kernel, but only user space restarting.
3469 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003470 */
3471 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3472 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3473
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003474 /**
3475 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3476 * user has set their time format preferences to the 24 hour format.
3477 *
3478 * @hide for internal use only.
3479 */
3480 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3481 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3482
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003483 /** {@hide} */
3484 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3485
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003486 // ---------------------------------------------------------------------
3487 // ---------------------------------------------------------------------
3488 // Intent flags (see mFlags variable).
3489
Tor Norbyed9273d62013-05-30 15:59:53 -07003490 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003491 @IntDef(flag = true, value = {
3492 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3493 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003494 @Retention(RetentionPolicy.SOURCE)
3495 public @interface GrantUriMode {}
3496
Jeff Sharkey846318a2014-04-04 12:12:41 -07003497 /** @hide */
3498 @IntDef(flag = true, value = {
3499 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3500 @Retention(RetentionPolicy.SOURCE)
3501 public @interface AccessUriMode {}
3502
3503 /**
3504 * Test if given mode flags specify an access mode, which must be at least
3505 * read and/or write.
3506 *
3507 * @hide
3508 */
3509 public static boolean isAccessUriMode(int modeFlags) {
3510 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3511 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3512 }
3513
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003514 /**
3515 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003516 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003517 * specified in its ClipData. When applying to an Intent's ClipData,
3518 * all URIs as well as recursive traversals through data or other ClipData
3519 * in Intent items will be granted; only the grant flags of the top-level
3520 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003521 */
3522 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3523 /**
3524 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003525 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003526 * specified in its ClipData. When applying to an Intent's ClipData,
3527 * all URIs as well as recursive traversals through data or other ClipData
3528 * in Intent items will be granted; only the grant flags of the top-level
3529 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003530 */
3531 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3532 /**
3533 * Can be set by the caller to indicate that this Intent is coming from
3534 * a background operation, not from direct user interaction.
3535 */
3536 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3537 /**
3538 * A flag you can enable for debugging: when set, log messages will be
3539 * printed during the resolution of this intent to show you what has
3540 * been found to create the final resolved list.
3541 */
3542 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003543 /**
3544 * If set, this intent will not match any components in packages that
3545 * are currently stopped. If this is not set, then the default behavior
3546 * is to include such applications in the result.
3547 */
3548 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3549 /**
3550 * If set, this intent will always match any components in packages that
3551 * are currently stopped. This is the default behavior when
3552 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3553 * flags are set, this one wins (it allows overriding of exclude for
3554 * places where the framework may automatically set the exclude flag).
3555 */
3556 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003557
3558 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003559 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003560 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003561 * persisted across device reboots until explicitly revoked with
3562 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3563 * grant for possible persisting; the receiving application must call
3564 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3565 * actually persist.
3566 *
3567 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3568 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3569 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003570 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003571 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003572 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003573
3574 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003575 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3576 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3577 * applies to any URI that is a prefix match against the original granted
3578 * URI. (Without this flag, the URI must match exactly for access to be
3579 * granted.) Another URI is considered a prefix match only when scheme,
3580 * authority, and all path segments defined by the prefix are an exact
3581 * match.
3582 */
3583 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3584
3585 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003586 * If set, the new activity is not kept in the history stack. As soon as
3587 * the user navigates away from it, the activity is finished. This may also
3588 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3589 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003590 */
3591 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3592 /**
3593 * If set, the activity will not be launched if it is already running
3594 * at the top of the history stack.
3595 */
3596 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3597 /**
3598 * If set, this activity will become the start of a new task on this
3599 * history stack. A task (from the activity that started it to the
3600 * next task activity) defines an atomic group of activities that the
3601 * user can move to. Tasks can be moved to the foreground and background;
3602 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003603 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003604 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3605 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003606 *
3607 * <p>This flag is generally used by activities that want
3608 * to present a "launcher" style behavior: they give the user a list of
3609 * separate things that can be done, which otherwise run completely
3610 * independently of the activity launching them.
3611 *
3612 * <p>When using this flag, if a task is already running for the activity
3613 * you are now starting, then a new activity will not be started; instead,
3614 * the current task will simply be brought to the front of the screen with
3615 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3616 * to disable this behavior.
3617 *
3618 * <p>This flag can not be used when the caller is requesting a result from
3619 * the activity being launched.
3620 */
3621 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3622 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003623 * This flag is used to create a new task and launch an activity into it.
3624 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3625 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3626 * search through existing tasks for ones matching this Intent. Only if no such
3627 * task is found would a new task be created. When paired with
3628 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3629 * the search for a matching task and unconditionally start a new task.
3630 *
3631 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3632 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003633 * top-level application launcher.</strong> Used in conjunction with
3634 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3635 * behavior of bringing an existing task to the foreground. When set,
3636 * a new task is <em>always</em> started to host the Activity for the
3637 * Intent, regardless of whether there is already an existing task running
3638 * the same thing.
3639 *
3640 * <p><strong>Because the default system does not include graphical task management,
3641 * you should not use this flag unless you provide some way for a user to
3642 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003643 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003644 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3645 * creating new document tasks.
3646 *
3647 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003648 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003649 *
Scott Main7aee61f2011-02-08 11:25:01 -08003650 * <p>See
3651 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3652 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003653 *
3654 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3655 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 */
3657 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3658 /**
3659 * If set, and the activity being launched is already running in the
3660 * current task, then instead of launching a new instance of that activity,
3661 * all of the other activities on top of it will be closed and this Intent
3662 * will be delivered to the (now on top) old activity as a new Intent.
3663 *
3664 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3665 * If D calls startActivity() with an Intent that resolves to the component
3666 * of activity B, then C and D will be finished and B receive the given
3667 * Intent, resulting in the stack now being: A, B.
3668 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003669 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003670 * either receive the new intent you are starting here in its
3671 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003672 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003673 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3674 * the same intent, then it will be finished and re-created; for all other
3675 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3676 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 *
3678 * <p>This launch mode can also be used to good effect in conjunction with
3679 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3680 * of a task, it will bring any currently running instance of that task
3681 * to the foreground, and then clear it to its root state. This is
3682 * especially useful, for example, when launching an activity from the
3683 * notification manager.
3684 *
Scott Main7aee61f2011-02-08 11:25:01 -08003685 * <p>See
3686 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3687 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 */
3689 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3690 /**
3691 * If set and this intent is being used to launch a new activity from an
3692 * existing one, then the reply target of the existing activity will be
3693 * transfered to the new activity. This way the new activity can call
3694 * {@link android.app.Activity#setResult} and have that result sent back to
3695 * the reply target of the original activity.
3696 */
3697 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3698 /**
3699 * If set and this intent is being used to launch a new activity from an
3700 * existing one, the current activity will not be counted as the top
3701 * activity for deciding whether the new intent should be delivered to
3702 * the top instead of starting a new one. The previous activity will
3703 * be used as the top, with the assumption being that the current activity
3704 * will finish itself immediately.
3705 */
3706 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3707 /**
3708 * If set, the new activity is not kept in the list of recently launched
3709 * activities.
3710 */
3711 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3712 /**
3713 * This flag is not normally set by application code, but set for you by
3714 * the system as described in the
3715 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3716 * launchMode} documentation for the singleTask mode.
3717 */
3718 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3719 /**
3720 * If set, and this activity is either being started in a new task or
3721 * bringing to the top an existing task, then it will be launched as
3722 * the front door of the task. This will result in the application of
3723 * any affinities needed to have that task in the proper state (either
3724 * moving activities to or from it), or simply resetting that task to
3725 * its initial state if needed.
3726 */
3727 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3728 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003729 * This flag is not normally set by application code, but set for you by
3730 * the system if this activity is being launched from history
3731 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003732 */
3733 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003734 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003735 * @deprecated As of API 21 this performs identically to
3736 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003737 */
3738 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003739 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003740 * This flag is used to open a document into a new task rooted at the activity launched
3741 * by this Intent. Through the use of this flag, or its equivalent attribute,
3742 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3743 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003744 *
Craig Mautner026596b2014-05-21 15:35:44 -07003745 * <p>The use of the activity attribute form of this,
3746 * {@link android.R.attr#documentLaunchMode}, is
3747 * preferred over the Intent flag described here. The attribute form allows the
3748 * Activity to specify multiple document behavior for all launchers of the Activity
3749 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003750 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003751 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3752 * it is kept after the activity is finished is different than the use of
3753 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3754 * this flag is being used to create a new recents entry, then by default that entry
3755 * will be removed once the activity is finished. You can modify this behavior with
3756 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3757 *
Craig Mautner026596b2014-05-21 15:35:44 -07003758 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3759 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3760 * equivalent of the Activity manifest specifying {@link
3761 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3762 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3763 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003764 *
Craig Mautner026596b2014-05-21 15:35:44 -07003765 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003766 *
Craig Mautner026596b2014-05-21 15:35:44 -07003767 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003768 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3769 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003770 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003771 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003772 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003773 * callback from occurring on the current frontmost activity before it is
3774 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003775 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003776 * <p>Typically, an activity can rely on that callback to indicate that an
3777 * explicit user action has caused their activity to be moved out of the
3778 * foreground. The callback marks an appropriate point in the activity's
3779 * lifecycle for it to dismiss any notifications that it intends to display
3780 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003781 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003782 * <p>If an activity is ever started via any non-user-driven events such as
3783 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3784 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003785 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003786 */
3787 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003788 /**
3789 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3790 * this flag will cause the launched activity to be brought to the front of its
3791 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003792 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003793 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3794 * If D calls startActivity() with an Intent that resolves to the component
3795 * of activity B, then B will be brought to the front of the history stack,
3796 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003797 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003798 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003799 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003800 */
3801 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003802 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003803 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3804 * this flag will prevent the system from applying an activity transition
3805 * animation to go to the next activity state. This doesn't mean an
3806 * animation will never run -- if another activity change happens that doesn't
3807 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003808 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003809 * when you are going to do a series of activity operations but the
3810 * animation seen by the user shouldn't be driven by the first activity
3811 * change but rather a later one.
3812 */
3813 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3814 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003815 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3816 * this flag will cause any existing task that would be associated with the
3817 * activity to be cleared before the activity is started. That is, the activity
3818 * becomes the new root of an otherwise empty task, and any old activities
3819 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3820 */
3821 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3822 /**
3823 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3824 * this flag will cause a newly launching task to be placed on top of the current
3825 * home activity task (if there is one). That is, pressing back from the task
3826 * will always return the user to home even if that was not the last activity they
3827 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3828 */
3829 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3830 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003831 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3832 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003833 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003834 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003835 * this flag. When set and the task's activity is finished, the recents
3836 * entry will remain in the interface for the user to re-launch it, like a
3837 * recents entry for a top-level application.
3838 * <p>
3839 * The receiving activity can override this request with
3840 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3841 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003842 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003843 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003844 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003845
3846 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 * If set, when sending a broadcast only registered receivers will be
3848 * called -- no BroadcastReceiver components will be launched.
3849 */
3850 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003851 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003852 * If set, when sending a broadcast the new broadcast will replace
3853 * any existing pending broadcast that matches it. Matching is defined
3854 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3855 * true for the intents of the two broadcasts. When a match is found,
3856 * the new broadcast (and receivers associated with it) will replace the
3857 * existing one in the pending broadcast list, remaining at the same
3858 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003859 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003860 * <p>This flag is most typically used with sticky broadcasts, which
3861 * only care about delivering the most recent values of the broadcast
3862 * to their receivers.
3863 */
3864 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3865 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003866 * If set, when sending a broadcast the recipient is allowed to run at
3867 * foreground priority, with a shorter timeout interval. During normal
3868 * broadcasts the receivers are not automatically hoisted out of the
3869 * background priority class.
3870 */
3871 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3872 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003873 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3874 * They can still propagate results through to later receivers, but they can not prevent
3875 * later receivers from seeing the broadcast.
3876 */
3877 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3878 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003879 * If set, when sending a broadcast <i>before boot has completed</i> only
3880 * registered receivers will be called -- no BroadcastReceiver components
3881 * will be launched. Sticky intent state will be recorded properly even
3882 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3883 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003884 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003885 * <p>This flag is only for use by system sevices as a convenience to
3886 * avoid having to implement a more complex mechanism around detection
3887 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003888 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003889 * @hide
3890 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003891 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003892 /**
3893 * Set when this broadcast is for a boot upgrade, a special mode that
3894 * allows the broadcast to be sent before the system is ready and launches
3895 * the app process with no providers running in it.
3896 * @hide
3897 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003898 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003900 /**
3901 * @hide Flags that can't be changed with PendingIntent.
3902 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003903 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3904 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3905 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003906
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003907 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003908 // ---------------------------------------------------------------------
3909 // toUri() and parseUri() options.
3910
3911 /**
3912 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3913 * always has the "intent:" scheme. This syntax can be used when you want
3914 * to later disambiguate between URIs that are intended to describe an
3915 * Intent vs. all others that should be treated as raw URIs. When used
3916 * with {@link #parseUri}, any other scheme will result in a generic
3917 * VIEW action for that raw URI.
3918 */
3919 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003920
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003921 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922
3923 private String mAction;
3924 private Uri mData;
3925 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003926 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003927 private ComponentName mComponent;
3928 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003929 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003930 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003931 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003932 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003933 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003934 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003935
3936 // ---------------------------------------------------------------------
3937
3938 /**
3939 * Create an empty intent.
3940 */
3941 public Intent() {
3942 }
3943
3944 /**
3945 * Copy constructor.
3946 */
3947 public Intent(Intent o) {
3948 this.mAction = o.mAction;
3949 this.mData = o.mData;
3950 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003951 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003952 this.mComponent = o.mComponent;
3953 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003954 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003956 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003957 }
3958 if (o.mExtras != null) {
3959 this.mExtras = new Bundle(o.mExtras);
3960 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003961 if (o.mSourceBounds != null) {
3962 this.mSourceBounds = new Rect(o.mSourceBounds);
3963 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003964 if (o.mSelector != null) {
3965 this.mSelector = new Intent(o.mSelector);
3966 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003967 if (o.mClipData != null) {
3968 this.mClipData = new ClipData(o.mClipData);
3969 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003970 }
3971
3972 @Override
3973 public Object clone() {
3974 return new Intent(this);
3975 }
3976
3977 private Intent(Intent o, boolean all) {
3978 this.mAction = o.mAction;
3979 this.mData = o.mData;
3980 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003981 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003982 this.mComponent = o.mComponent;
3983 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003984 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985 }
3986 }
3987
3988 /**
3989 * Make a clone of only the parts of the Intent that are relevant for
3990 * filter matching: the action, data, type, component, and categories.
3991 */
3992 public Intent cloneFilter() {
3993 return new Intent(this, false);
3994 }
3995
3996 /**
3997 * Create an intent with a given action. All other fields (data, type,
3998 * class) are null. Note that the action <em>must</em> be in a
3999 * namespace because Intents are used globally in the system -- for
4000 * example the system VIEW action is android.intent.action.VIEW; an
4001 * application's custom action would be something like
4002 * com.google.app.myapp.CUSTOM_ACTION.
4003 *
4004 * @param action The Intent action, such as ACTION_VIEW.
4005 */
4006 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004007 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004008 }
4009
4010 /**
4011 * Create an intent with a given action and for a given data url. Note
4012 * that the action <em>must</em> be in a namespace because Intents are
4013 * used globally in the system -- for example the system VIEW action is
4014 * android.intent.action.VIEW; an application's custom action would be
4015 * something like com.google.app.myapp.CUSTOM_ACTION.
4016 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004017 * <p><em>Note: scheme and host name matching in the Android framework is
4018 * case-sensitive, unlike the formal RFC. As a result,
4019 * you should always ensure that you write your Uri with these elements
4020 * using lower case letters, and normalize any Uris you receive from
4021 * outside of Android to ensure the scheme and host is lower case.</em></p>
4022 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004023 * @param action The Intent action, such as ACTION_VIEW.
4024 * @param uri The Intent data URI.
4025 */
4026 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004027 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004028 mData = uri;
4029 }
4030
4031 /**
4032 * Create an intent for a specific component. All other fields (action, data,
4033 * type, class) are null, though they can be modified later with explicit
4034 * calls. This provides a convenient way to create an intent that is
4035 * intended to execute a hard-coded class name, rather than relying on the
4036 * system to find an appropriate class for you; see {@link #setComponent}
4037 * for more information on the repercussions of this.
4038 *
4039 * @param packageContext A Context of the application package implementing
4040 * this class.
4041 * @param cls The component class that is to be used for the intent.
4042 *
4043 * @see #setClass
4044 * @see #setComponent
4045 * @see #Intent(String, android.net.Uri , Context, Class)
4046 */
4047 public Intent(Context packageContext, Class<?> cls) {
4048 mComponent = new ComponentName(packageContext, cls);
4049 }
4050
4051 /**
4052 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004053 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004054 * construct the Intent and then calling {@link #setClass} to set its
4055 * class.
4056 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004057 * <p><em>Note: scheme and host name matching in the Android framework is
4058 * case-sensitive, unlike the formal RFC. As a result,
4059 * you should always ensure that you write your Uri with these elements
4060 * using lower case letters, and normalize any Uris you receive from
4061 * outside of Android to ensure the scheme and host is lower case.</em></p>
4062 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004063 * @param action The Intent action, such as ACTION_VIEW.
4064 * @param uri The Intent data URI.
4065 * @param packageContext A Context of the application package implementing
4066 * this class.
4067 * @param cls The component class that is to be used for the intent.
4068 *
4069 * @see #Intent(String, android.net.Uri)
4070 * @see #Intent(Context, Class)
4071 * @see #setClass
4072 * @see #setComponent
4073 */
4074 public Intent(String action, Uri uri,
4075 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004076 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004077 mData = uri;
4078 mComponent = new ComponentName(packageContext, cls);
4079 }
4080
4081 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004082 * Create an intent to launch the main (root) activity of a task. This
4083 * is the Intent that is started when the application's is launched from
4084 * Home. For anything else that wants to launch an application in the
4085 * same way, it is important that they use an Intent structured the same
4086 * way, and can use this function to ensure this is the case.
4087 *
4088 * <p>The returned Intent has the given Activity component as its explicit
4089 * component, {@link #ACTION_MAIN} as its action, and includes the
4090 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4091 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4092 * to do that through {@link #addFlags(int)} on the returned Intent.
4093 *
4094 * @param mainActivity The main activity component that this Intent will
4095 * launch.
4096 * @return Returns a newly created Intent that can be used to launch the
4097 * activity as a main application entry.
4098 *
4099 * @see #setClass
4100 * @see #setComponent
4101 */
4102 public static Intent makeMainActivity(ComponentName mainActivity) {
4103 Intent intent = new Intent(ACTION_MAIN);
4104 intent.setComponent(mainActivity);
4105 intent.addCategory(CATEGORY_LAUNCHER);
4106 return intent;
4107 }
4108
4109 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004110 * Make an Intent for the main activity of an application, without
4111 * specifying a specific activity to run but giving a selector to find
4112 * the activity. This results in a final Intent that is structured
4113 * the same as when the application is launched from
4114 * Home. For anything else that wants to launch an application in the
4115 * same way, it is important that they use an Intent structured the same
4116 * way, and can use this function to ensure this is the case.
4117 *
4118 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4119 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4120 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4121 * to do that through {@link #addFlags(int)} on the returned Intent.
4122 *
4123 * @param selectorAction The action name of the Intent's selector.
4124 * @param selectorCategory The name of a category to add to the Intent's
4125 * selector.
4126 * @return Returns a newly created Intent that can be used to launch the
4127 * activity as a main application entry.
4128 *
4129 * @see #setSelector(Intent)
4130 */
4131 public static Intent makeMainSelectorActivity(String selectorAction,
4132 String selectorCategory) {
4133 Intent intent = new Intent(ACTION_MAIN);
4134 intent.addCategory(CATEGORY_LAUNCHER);
4135 Intent selector = new Intent();
4136 selector.setAction(selectorAction);
4137 selector.addCategory(selectorCategory);
4138 intent.setSelector(selector);
4139 return intent;
4140 }
4141
4142 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004143 * Make an Intent that can be used to re-launch an application's task
4144 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4145 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4146 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4147 *
4148 * @param mainActivity The activity component that is the root of the
4149 * task; this is the activity that has been published in the application's
4150 * manifest as the main launcher icon.
4151 *
4152 * @return Returns a newly created Intent that can be used to relaunch the
4153 * activity's task in its root state.
4154 */
4155 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4156 Intent intent = makeMainActivity(mainActivity);
4157 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4158 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4159 return intent;
4160 }
4161
4162 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004163 * Call {@link #parseUri} with 0 flags.
4164 * @deprecated Use {@link #parseUri} instead.
4165 */
4166 @Deprecated
4167 public static Intent getIntent(String uri) throws URISyntaxException {
4168 return parseUri(uri, 0);
4169 }
Tom Taylord4a47292009-12-21 13:59:18 -08004170
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004171 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004172 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004173 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004174 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004175 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004176 *
4177 * <p>The URI given here must not be relative -- that is, it must include
4178 * the scheme and full path.
4179 *
4180 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004181 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004182 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 *
4184 * @return Intent The newly created Intent object.
4185 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004186 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4187 * it bad (as parsed by the Uri class) or the Intent data within the
4188 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004189 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004190 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004191 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004192 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004193 int i = 0;
4194 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004195 // Validate intent scheme for if requested.
4196 if ((flags&URI_INTENT_SCHEME) != 0) {
4197 if (!uri.startsWith("intent:")) {
4198 Intent intent = new Intent(ACTION_VIEW);
4199 try {
4200 intent.setData(Uri.parse(uri));
4201 } catch (IllegalArgumentException e) {
4202 throw new URISyntaxException(uri, e.getMessage());
4203 }
4204 return intent;
4205 }
4206 }
Tom Taylord4a47292009-12-21 13:59:18 -08004207
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004208 // simple case
4209 i = uri.lastIndexOf("#");
4210 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4211
4212 // old format Intent URI
4213 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004214
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004215 // new format
4216 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004217 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004218
4219 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004220 String data = i >= 0 ? uri.substring(0, i) : null;
4221 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004222 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004223
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004224 // loop over contents of Intent, all name=value;
4225 while (!uri.startsWith("end", i)) {
4226 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004227 if (eq < 0) eq = i-1;
4228 int semi = uri.indexOf(';', i);
4229 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230
4231 // action
4232 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004233 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004234 }
4235
4236 // categories
4237 else if (uri.startsWith("category=", i)) {
4238 intent.addCategory(value);
4239 }
4240
4241 // type
4242 else if (uri.startsWith("type=", i)) {
4243 intent.mType = value;
4244 }
4245
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004246 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004247 else if (uri.startsWith("launchFlags=", i)) {
4248 intent.mFlags = Integer.decode(value).intValue();
4249 }
4250
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004251 // package
4252 else if (uri.startsWith("package=", i)) {
4253 intent.mPackage = value;
4254 }
4255
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004256 // component
4257 else if (uri.startsWith("component=", i)) {
4258 intent.mComponent = ComponentName.unflattenFromString(value);
4259 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004260
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004261 // scheme
4262 else if (uri.startsWith("scheme=", i)) {
4263 scheme = value;
4264 }
4265
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004266 // source bounds
4267 else if (uri.startsWith("sourceBounds=", i)) {
4268 intent.mSourceBounds = Rect.unflattenFromString(value);
4269 }
4270
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004271 // selector
4272 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4273 intent = new Intent();
4274 }
4275
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004276 // extra
4277 else {
4278 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004279 // create Bundle if it doesn't already exist
4280 if (intent.mExtras == null) intent.mExtras = new Bundle();
4281 Bundle b = intent.mExtras;
4282 // add EXTRA
4283 if (uri.startsWith("S.", i)) b.putString(key, value);
4284 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4285 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4286 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4287 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4288 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4289 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4290 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4291 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4292 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4293 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004294
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004295 // move to the next item
4296 i = semi + 1;
4297 }
4298
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004299 if (intent != baseIntent) {
4300 // The Intent had a selector; fix it up.
4301 baseIntent.setSelector(intent);
4302 intent = baseIntent;
4303 }
4304
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004305 if (data != null) {
4306 if (data.startsWith("intent:")) {
4307 data = data.substring(7);
4308 if (scheme != null) {
4309 data = scheme + ':' + data;
4310 }
4311 }
Tom Taylord4a47292009-12-21 13:59:18 -08004312
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004313 if (data.length() > 0) {
4314 try {
4315 intent.mData = Uri.parse(data);
4316 } catch (IllegalArgumentException e) {
4317 throw new URISyntaxException(uri, e.getMessage());
4318 }
4319 }
4320 }
Tom Taylord4a47292009-12-21 13:59:18 -08004321
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004322 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004323
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004324 } catch (IndexOutOfBoundsException e) {
4325 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4326 }
4327 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004328
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004329 public static Intent getIntentOld(String uri) throws URISyntaxException {
4330 Intent intent;
4331
4332 int i = uri.lastIndexOf('#');
4333 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004334 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004335 final int intentFragmentStart = i;
4336 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004337
4338 i++;
4339
4340 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004341 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004342 i += 7;
4343 int j = uri.indexOf(')', i);
4344 action = uri.substring(i, j);
4345 i = j + 1;
4346 }
4347
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004348 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004349
4350 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004351 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004352 i += 11;
4353 int j = uri.indexOf(')', i);
4354 while (i < j) {
4355 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004356 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004357 if (i < sep) {
4358 intent.addCategory(uri.substring(i, sep));
4359 }
4360 i = sep + 1;
4361 }
4362 i = j + 1;
4363 }
4364
4365 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004366 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004367 i += 5;
4368 int j = uri.indexOf(')', i);
4369 intent.mType = uri.substring(i, j);
4370 i = j + 1;
4371 }
4372
4373 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004374 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004375 i += 12;
4376 int j = uri.indexOf(')', i);
4377 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4378 i = j + 1;
4379 }
4380
4381 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004382 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004383 i += 10;
4384 int j = uri.indexOf(')', i);
4385 int sep = uri.indexOf('!', i);
4386 if (sep >= 0 && sep < j) {
4387 String pkg = uri.substring(i, sep);
4388 String cls = uri.substring(sep + 1, j);
4389 intent.mComponent = new ComponentName(pkg, cls);
4390 }
4391 i = j + 1;
4392 }
4393
4394 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004395 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004396 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004397
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004398 final int closeParen = uri.indexOf(')', i);
4399 if (closeParen == -1) throw new URISyntaxException(uri,
4400 "EXTRA missing trailing ')'", i);
4401
4402 while (i < closeParen) {
4403 // fetch the key value
4404 int j = uri.indexOf('=', i);
4405 if (j <= i + 1 || i >= closeParen) {
4406 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4407 }
4408 char type = uri.charAt(i);
4409 i++;
4410 String key = uri.substring(i, j);
4411 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004412
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004413 // get type-value
4414 j = uri.indexOf('!', i);
4415 if (j == -1 || j >= closeParen) j = closeParen;
4416 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4417 String value = uri.substring(i, j);
4418 i = j;
4419
4420 // create Bundle if it doesn't already exist
4421 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004423 // add item to bundle
4424 try {
4425 switch (type) {
4426 case 'S':
4427 intent.mExtras.putString(key, Uri.decode(value));
4428 break;
4429 case 'B':
4430 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4431 break;
4432 case 'b':
4433 intent.mExtras.putByte(key, Byte.parseByte(value));
4434 break;
4435 case 'c':
4436 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4437 break;
4438 case 'd':
4439 intent.mExtras.putDouble(key, Double.parseDouble(value));
4440 break;
4441 case 'f':
4442 intent.mExtras.putFloat(key, Float.parseFloat(value));
4443 break;
4444 case 'i':
4445 intent.mExtras.putInt(key, Integer.parseInt(value));
4446 break;
4447 case 'l':
4448 intent.mExtras.putLong(key, Long.parseLong(value));
4449 break;
4450 case 's':
4451 intent.mExtras.putShort(key, Short.parseShort(value));
4452 break;
4453 default:
4454 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4455 }
4456 } catch (NumberFormatException e) {
4457 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4458 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004459
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004460 char ch = uri.charAt(i);
4461 if (ch == ')') break;
4462 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4463 i++;
4464 }
4465 }
4466
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004467 if (isIntentFragment) {
4468 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4469 } else {
4470 intent.mData = Uri.parse(uri);
4471 }
Tom Taylord4a47292009-12-21 13:59:18 -08004472
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004473 if (intent.mAction == null) {
4474 // By default, if no action is specified, then use VIEW.
4475 intent.mAction = ACTION_VIEW;
4476 }
4477
4478 } else {
4479 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4480 }
4481
4482 return intent;
4483 }
4484
4485 /**
4486 * Retrieve the general action to be performed, such as
4487 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4488 * the information in the intent should be interpreted -- most importantly,
4489 * what to do with the data returned by {@link #getData}.
4490 *
4491 * @return The action of this intent or null if none is specified.
4492 *
4493 * @see #setAction
4494 */
4495 public String getAction() {
4496 return mAction;
4497 }
4498
4499 /**
4500 * Retrieve data this intent is operating on. This URI specifies the name
4501 * of the data; often it uses the content: scheme, specifying data in a
4502 * content provider. Other schemes may be handled by specific activities,
4503 * such as http: by the web browser.
4504 *
4505 * @return The URI of the data this intent is targeting or null.
4506 *
4507 * @see #getScheme
4508 * @see #setData
4509 */
4510 public Uri getData() {
4511 return mData;
4512 }
4513
4514 /**
4515 * The same as {@link #getData()}, but returns the URI as an encoded
4516 * String.
4517 */
4518 public String getDataString() {
4519 return mData != null ? mData.toString() : null;
4520 }
4521
4522 /**
4523 * Return the scheme portion of the intent's data. If the data is null or
4524 * does not include a scheme, null is returned. Otherwise, the scheme
4525 * prefix without the final ':' is returned, i.e. "http".
4526 *
4527 * <p>This is the same as calling getData().getScheme() (and checking for
4528 * null data).
4529 *
4530 * @return The scheme of this intent.
4531 *
4532 * @see #getData
4533 */
4534 public String getScheme() {
4535 return mData != null ? mData.getScheme() : null;
4536 }
4537
4538 /**
4539 * Retrieve any explicit MIME type included in the intent. This is usually
4540 * null, as the type is determined by the intent data.
4541 *
4542 * @return If a type was manually set, it is returned; else null is
4543 * returned.
4544 *
4545 * @see #resolveType(ContentResolver)
4546 * @see #setType
4547 */
4548 public String getType() {
4549 return mType;
4550 }
4551
4552 /**
4553 * Return the MIME data type of this intent. If the type field is
4554 * explicitly set, that is simply returned. Otherwise, if the data is set,
4555 * the type of that data is returned. If neither fields are set, a null is
4556 * returned.
4557 *
4558 * @return The MIME type of this intent.
4559 *
4560 * @see #getType
4561 * @see #resolveType(ContentResolver)
4562 */
4563 public String resolveType(Context context) {
4564 return resolveType(context.getContentResolver());
4565 }
4566
4567 /**
4568 * Return the MIME data type of this intent. If the type field is
4569 * explicitly set, that is simply returned. Otherwise, if the data is set,
4570 * the type of that data is returned. If neither fields are set, a null is
4571 * returned.
4572 *
4573 * @param resolver A ContentResolver that can be used to determine the MIME
4574 * type of the intent's data.
4575 *
4576 * @return The MIME type of this intent.
4577 *
4578 * @see #getType
4579 * @see #resolveType(Context)
4580 */
4581 public String resolveType(ContentResolver resolver) {
4582 if (mType != null) {
4583 return mType;
4584 }
4585 if (mData != null) {
4586 if ("content".equals(mData.getScheme())) {
4587 return resolver.getType(mData);
4588 }
4589 }
4590 return null;
4591 }
4592
4593 /**
4594 * Return the MIME data type of this intent, only if it will be needed for
4595 * intent resolution. This is not generally useful for application code;
4596 * it is used by the frameworks for communicating with back-end system
4597 * services.
4598 *
4599 * @param resolver A ContentResolver that can be used to determine the MIME
4600 * type of the intent's data.
4601 *
4602 * @return The MIME type of this intent, or null if it is unknown or not
4603 * needed.
4604 */
4605 public String resolveTypeIfNeeded(ContentResolver resolver) {
4606 if (mComponent != null) {
4607 return mType;
4608 }
4609 return resolveType(resolver);
4610 }
4611
4612 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004613 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004614 *
4615 * @param category The category to check.
4616 *
4617 * @return boolean True if the intent contains the category, else false.
4618 *
4619 * @see #getCategories
4620 * @see #addCategory
4621 */
4622 public boolean hasCategory(String category) {
4623 return mCategories != null && mCategories.contains(category);
4624 }
4625
4626 /**
4627 * Return the set of all categories in the intent. If there are no categories,
4628 * returns NULL.
4629 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004630 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004631 *
4632 * @see #hasCategory
4633 * @see #addCategory
4634 */
4635 public Set<String> getCategories() {
4636 return mCategories;
4637 }
4638
4639 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004640 * Return the specific selector associated with this Intent. If there is
4641 * none, returns null. See {@link #setSelector} for more information.
4642 *
4643 * @see #setSelector
4644 */
4645 public Intent getSelector() {
4646 return mSelector;
4647 }
4648
4649 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004650 * Return the {@link ClipData} associated with this Intent. If there is
4651 * none, returns null. See {@link #setClipData} for more information.
4652 *
John Spurlock125d1332013-11-25 11:58:37 -05004653 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004654 */
4655 public ClipData getClipData() {
4656 return mClipData;
4657 }
4658
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004659 /** @hide */
4660 public int getContentUserHint() {
4661 return mContentUserHint;
4662 }
4663
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004664 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665 * Sets the ClassLoader that will be used when unmarshalling
4666 * any Parcelable values from the extras of this Intent.
4667 *
4668 * @param loader a ClassLoader, or null to use the default loader
4669 * at the time of unmarshalling.
4670 */
4671 public void setExtrasClassLoader(ClassLoader loader) {
4672 if (mExtras != null) {
4673 mExtras.setClassLoader(loader);
4674 }
4675 }
4676
4677 /**
4678 * Returns true if an extra value is associated with the given name.
4679 * @param name the extra's name
4680 * @return true if the given extra is present.
4681 */
4682 public boolean hasExtra(String name) {
4683 return mExtras != null && mExtras.containsKey(name);
4684 }
4685
4686 /**
4687 * Returns true if the Intent's extras contain a parcelled file descriptor.
4688 * @return true if the Intent contains a parcelled file descriptor.
4689 */
4690 public boolean hasFileDescriptors() {
4691 return mExtras != null && mExtras.hasFileDescriptors();
4692 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004693
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004694 /** @hide */
4695 public void setAllowFds(boolean allowFds) {
4696 if (mExtras != null) {
4697 mExtras.setAllowFds(allowFds);
4698 }
4699 }
4700
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004701 /**
4702 * Retrieve extended data from the intent.
4703 *
4704 * @param name The name of the desired item.
4705 *
4706 * @return the value of an item that previously added with putExtra()
4707 * or null if none was found.
4708 *
4709 * @deprecated
4710 * @hide
4711 */
4712 @Deprecated
4713 public Object getExtra(String name) {
4714 return getExtra(name, null);
4715 }
4716
4717 /**
4718 * Retrieve extended data from the intent.
4719 *
4720 * @param name The name of the desired item.
4721 * @param defaultValue the value to be returned if no value of the desired
4722 * type is stored with the given name.
4723 *
4724 * @return the value of an item that previously added with putExtra()
4725 * or the default value if none was found.
4726 *
4727 * @see #putExtra(String, boolean)
4728 */
4729 public boolean getBooleanExtra(String name, boolean defaultValue) {
4730 return mExtras == null ? defaultValue :
4731 mExtras.getBoolean(name, defaultValue);
4732 }
4733
4734 /**
4735 * Retrieve extended data from the intent.
4736 *
4737 * @param name The name of the desired item.
4738 * @param defaultValue the value to be returned if no value of the desired
4739 * type is stored with the given name.
4740 *
4741 * @return the value of an item that previously added with putExtra()
4742 * or the default value if none was found.
4743 *
4744 * @see #putExtra(String, byte)
4745 */
4746 public byte getByteExtra(String name, byte defaultValue) {
4747 return mExtras == null ? defaultValue :
4748 mExtras.getByte(name, defaultValue);
4749 }
4750
4751 /**
4752 * Retrieve extended data from the intent.
4753 *
4754 * @param name The name of the desired item.
4755 * @param defaultValue the value to be returned if no value of the desired
4756 * type is stored with the given name.
4757 *
4758 * @return the value of an item that previously added with putExtra()
4759 * or the default value if none was found.
4760 *
4761 * @see #putExtra(String, short)
4762 */
4763 public short getShortExtra(String name, short defaultValue) {
4764 return mExtras == null ? defaultValue :
4765 mExtras.getShort(name, defaultValue);
4766 }
4767
4768 /**
4769 * Retrieve extended data from the intent.
4770 *
4771 * @param name The name of the desired item.
4772 * @param defaultValue the value to be returned if no value of the desired
4773 * type is stored with the given name.
4774 *
4775 * @return the value of an item that previously added with putExtra()
4776 * or the default value if none was found.
4777 *
4778 * @see #putExtra(String, char)
4779 */
4780 public char getCharExtra(String name, char defaultValue) {
4781 return mExtras == null ? defaultValue :
4782 mExtras.getChar(name, defaultValue);
4783 }
4784
4785 /**
4786 * Retrieve extended data from the intent.
4787 *
4788 * @param name The name of the desired item.
4789 * @param defaultValue the value to be returned if no value of the desired
4790 * type is stored with the given name.
4791 *
4792 * @return the value of an item that previously added with putExtra()
4793 * or the default value if none was found.
4794 *
4795 * @see #putExtra(String, int)
4796 */
4797 public int getIntExtra(String name, int defaultValue) {
4798 return mExtras == null ? defaultValue :
4799 mExtras.getInt(name, defaultValue);
4800 }
4801
4802 /**
4803 * Retrieve extended data from the intent.
4804 *
4805 * @param name The name of the desired item.
4806 * @param defaultValue the value to be returned if no value of the desired
4807 * type is stored with the given name.
4808 *
4809 * @return the value of an item that previously added with putExtra()
4810 * or the default value if none was found.
4811 *
4812 * @see #putExtra(String, long)
4813 */
4814 public long getLongExtra(String name, long defaultValue) {
4815 return mExtras == null ? defaultValue :
4816 mExtras.getLong(name, defaultValue);
4817 }
4818
4819 /**
4820 * Retrieve extended data from the intent.
4821 *
4822 * @param name The name of the desired item.
4823 * @param defaultValue the value to be returned if no value of the desired
4824 * type is stored with the given name.
4825 *
4826 * @return the value of an item that previously added with putExtra(),
4827 * or the default value if no such item is present
4828 *
4829 * @see #putExtra(String, float)
4830 */
4831 public float getFloatExtra(String name, float defaultValue) {
4832 return mExtras == null ? defaultValue :
4833 mExtras.getFloat(name, defaultValue);
4834 }
4835
4836 /**
4837 * Retrieve extended data from the intent.
4838 *
4839 * @param name The name of the desired item.
4840 * @param defaultValue the value to be returned if no value of the desired
4841 * type is stored with the given name.
4842 *
4843 * @return the value of an item that previously added with putExtra()
4844 * or the default value if none was found.
4845 *
4846 * @see #putExtra(String, double)
4847 */
4848 public double getDoubleExtra(String name, double defaultValue) {
4849 return mExtras == null ? defaultValue :
4850 mExtras.getDouble(name, defaultValue);
4851 }
4852
4853 /**
4854 * Retrieve extended data from the intent.
4855 *
4856 * @param name The name of the desired item.
4857 *
4858 * @return the value of an item that previously added with putExtra()
4859 * or null if no String value was found.
4860 *
4861 * @see #putExtra(String, String)
4862 */
4863 public String getStringExtra(String name) {
4864 return mExtras == null ? null : mExtras.getString(name);
4865 }
4866
4867 /**
4868 * Retrieve extended data from the intent.
4869 *
4870 * @param name The name of the desired item.
4871 *
4872 * @return the value of an item that previously added with putExtra()
4873 * or null if no CharSequence value was found.
4874 *
4875 * @see #putExtra(String, CharSequence)
4876 */
4877 public CharSequence getCharSequenceExtra(String name) {
4878 return mExtras == null ? null : mExtras.getCharSequence(name);
4879 }
4880
4881 /**
4882 * Retrieve extended data from the intent.
4883 *
4884 * @param name The name of the desired item.
4885 *
4886 * @return the value of an item that previously added with putExtra()
4887 * or null if no Parcelable value was found.
4888 *
4889 * @see #putExtra(String, Parcelable)
4890 */
4891 public <T extends Parcelable> T getParcelableExtra(String name) {
4892 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4893 }
4894
4895 /**
4896 * Retrieve extended data from the intent.
4897 *
4898 * @param name The name of the desired item.
4899 *
4900 * @return the value of an item that previously added with putExtra()
4901 * or null if no Parcelable[] value was found.
4902 *
4903 * @see #putExtra(String, Parcelable[])
4904 */
4905 public Parcelable[] getParcelableArrayExtra(String name) {
4906 return mExtras == null ? null : mExtras.getParcelableArray(name);
4907 }
4908
4909 /**
4910 * Retrieve extended data from the intent.
4911 *
4912 * @param name The name of the desired item.
4913 *
4914 * @return the value of an item that previously added with putExtra()
4915 * or null if no ArrayList<Parcelable> value was found.
4916 *
4917 * @see #putParcelableArrayListExtra(String, ArrayList)
4918 */
4919 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4920 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4921 }
4922
4923 /**
4924 * Retrieve extended data from the intent.
4925 *
4926 * @param name The name of the desired item.
4927 *
4928 * @return the value of an item that previously added with putExtra()
4929 * or null if no Serializable value was found.
4930 *
4931 * @see #putExtra(String, Serializable)
4932 */
4933 public Serializable getSerializableExtra(String name) {
4934 return mExtras == null ? null : mExtras.getSerializable(name);
4935 }
4936
4937 /**
4938 * Retrieve extended data from the intent.
4939 *
4940 * @param name The name of the desired item.
4941 *
4942 * @return the value of an item that previously added with putExtra()
4943 * or null if no ArrayList<Integer> value was found.
4944 *
4945 * @see #putIntegerArrayListExtra(String, ArrayList)
4946 */
4947 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4948 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4949 }
4950
4951 /**
4952 * Retrieve extended data from the intent.
4953 *
4954 * @param name The name of the desired item.
4955 *
4956 * @return the value of an item that previously added with putExtra()
4957 * or null if no ArrayList<String> value was found.
4958 *
4959 * @see #putStringArrayListExtra(String, ArrayList)
4960 */
4961 public ArrayList<String> getStringArrayListExtra(String name) {
4962 return mExtras == null ? null : mExtras.getStringArrayList(name);
4963 }
4964
4965 /**
4966 * Retrieve extended data from the intent.
4967 *
4968 * @param name The name of the desired item.
4969 *
4970 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004971 * or null if no ArrayList<CharSequence> value was found.
4972 *
4973 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4974 */
4975 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4976 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4977 }
4978
4979 /**
4980 * Retrieve extended data from the intent.
4981 *
4982 * @param name The name of the desired item.
4983 *
4984 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004985 * or null if no boolean array value was found.
4986 *
4987 * @see #putExtra(String, boolean[])
4988 */
4989 public boolean[] getBooleanArrayExtra(String name) {
4990 return mExtras == null ? null : mExtras.getBooleanArray(name);
4991 }
4992
4993 /**
4994 * Retrieve extended data from the intent.
4995 *
4996 * @param name The name of the desired item.
4997 *
4998 * @return the value of an item that previously added with putExtra()
4999 * or null if no byte array value was found.
5000 *
5001 * @see #putExtra(String, byte[])
5002 */
5003 public byte[] getByteArrayExtra(String name) {
5004 return mExtras == null ? null : mExtras.getByteArray(name);
5005 }
5006
5007 /**
5008 * Retrieve extended data from the intent.
5009 *
5010 * @param name The name of the desired item.
5011 *
5012 * @return the value of an item that previously added with putExtra()
5013 * or null if no short array value was found.
5014 *
5015 * @see #putExtra(String, short[])
5016 */
5017 public short[] getShortArrayExtra(String name) {
5018 return mExtras == null ? null : mExtras.getShortArray(name);
5019 }
5020
5021 /**
5022 * Retrieve extended data from the intent.
5023 *
5024 * @param name The name of the desired item.
5025 *
5026 * @return the value of an item that previously added with putExtra()
5027 * or null if no char array value was found.
5028 *
5029 * @see #putExtra(String, char[])
5030 */
5031 public char[] getCharArrayExtra(String name) {
5032 return mExtras == null ? null : mExtras.getCharArray(name);
5033 }
5034
5035 /**
5036 * Retrieve extended data from the intent.
5037 *
5038 * @param name The name of the desired item.
5039 *
5040 * @return the value of an item that previously added with putExtra()
5041 * or null if no int array value was found.
5042 *
5043 * @see #putExtra(String, int[])
5044 */
5045 public int[] getIntArrayExtra(String name) {
5046 return mExtras == null ? null : mExtras.getIntArray(name);
5047 }
5048
5049 /**
5050 * Retrieve extended data from the intent.
5051 *
5052 * @param name The name of the desired item.
5053 *
5054 * @return the value of an item that previously added with putExtra()
5055 * or null if no long array value was found.
5056 *
5057 * @see #putExtra(String, long[])
5058 */
5059 public long[] getLongArrayExtra(String name) {
5060 return mExtras == null ? null : mExtras.getLongArray(name);
5061 }
5062
5063 /**
5064 * Retrieve extended data from the intent.
5065 *
5066 * @param name The name of the desired item.
5067 *
5068 * @return the value of an item that previously added with putExtra()
5069 * or null if no float array value was found.
5070 *
5071 * @see #putExtra(String, float[])
5072 */
5073 public float[] getFloatArrayExtra(String name) {
5074 return mExtras == null ? null : mExtras.getFloatArray(name);
5075 }
5076
5077 /**
5078 * Retrieve extended data from the intent.
5079 *
5080 * @param name The name of the desired item.
5081 *
5082 * @return the value of an item that previously added with putExtra()
5083 * or null if no double array value was found.
5084 *
5085 * @see #putExtra(String, double[])
5086 */
5087 public double[] getDoubleArrayExtra(String name) {
5088 return mExtras == null ? null : mExtras.getDoubleArray(name);
5089 }
5090
5091 /**
5092 * Retrieve extended data from the intent.
5093 *
5094 * @param name The name of the desired item.
5095 *
5096 * @return the value of an item that previously added with putExtra()
5097 * or null if no String array value was found.
5098 *
5099 * @see #putExtra(String, String[])
5100 */
5101 public String[] getStringArrayExtra(String name) {
5102 return mExtras == null ? null : mExtras.getStringArray(name);
5103 }
5104
5105 /**
5106 * Retrieve extended data from the intent.
5107 *
5108 * @param name The name of the desired item.
5109 *
5110 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005111 * or null if no CharSequence array value was found.
5112 *
5113 * @see #putExtra(String, CharSequence[])
5114 */
5115 public CharSequence[] getCharSequenceArrayExtra(String name) {
5116 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5117 }
5118
5119 /**
5120 * Retrieve extended data from the intent.
5121 *
5122 * @param name The name of the desired item.
5123 *
5124 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005125 * or null if no Bundle value was found.
5126 *
5127 * @see #putExtra(String, Bundle)
5128 */
5129 public Bundle getBundleExtra(String name) {
5130 return mExtras == null ? null : mExtras.getBundle(name);
5131 }
5132
5133 /**
5134 * Retrieve extended data from the intent.
5135 *
5136 * @param name The name of the desired item.
5137 *
5138 * @return the value of an item that previously added with putExtra()
5139 * or null if no IBinder value was found.
5140 *
5141 * @see #putExtra(String, IBinder)
5142 *
5143 * @deprecated
5144 * @hide
5145 */
5146 @Deprecated
5147 public IBinder getIBinderExtra(String name) {
5148 return mExtras == null ? null : mExtras.getIBinder(name);
5149 }
5150
5151 /**
5152 * Retrieve extended data from the intent.
5153 *
5154 * @param name The name of the desired item.
5155 * @param defaultValue The default value to return in case no item is
5156 * associated with the key 'name'
5157 *
5158 * @return the value of an item that previously added with putExtra()
5159 * or defaultValue if none was found.
5160 *
5161 * @see #putExtra
5162 *
5163 * @deprecated
5164 * @hide
5165 */
5166 @Deprecated
5167 public Object getExtra(String name, Object defaultValue) {
5168 Object result = defaultValue;
5169 if (mExtras != null) {
5170 Object result2 = mExtras.get(name);
5171 if (result2 != null) {
5172 result = result2;
5173 }
5174 }
5175
5176 return result;
5177 }
5178
5179 /**
5180 * Retrieves a map of extended data from the intent.
5181 *
5182 * @return the map of all extras previously added with putExtra(),
5183 * or null if none have been added.
5184 */
5185 public Bundle getExtras() {
5186 return (mExtras != null)
5187 ? new Bundle(mExtras)
5188 : null;
5189 }
5190
5191 /**
5192 * Retrieve any special flags associated with this intent. You will
5193 * normally just set them with {@link #setFlags} and let the system
5194 * take the appropriate action with them.
5195 *
5196 * @return int The currently set flags.
5197 *
5198 * @see #setFlags
5199 */
5200 public int getFlags() {
5201 return mFlags;
5202 }
5203
Dianne Hackborne7f97212011-02-24 14:40:20 -08005204 /** @hide */
5205 public boolean isExcludingStopped() {
5206 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5207 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5208 }
5209
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005210 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005211 * Retrieve the application package name this Intent is limited to. When
5212 * resolving an Intent, if non-null this limits the resolution to only
5213 * components in the given application package.
5214 *
5215 * @return The name of the application package for the Intent.
5216 *
5217 * @see #resolveActivity
5218 * @see #setPackage
5219 */
5220 public String getPackage() {
5221 return mPackage;
5222 }
5223
5224 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005225 * Retrieve the concrete component associated with the intent. When receiving
5226 * an intent, this is the component that was found to best handle it (that is,
5227 * yourself) and will always be non-null; in all other cases it will be
5228 * null unless explicitly set.
5229 *
5230 * @return The name of the application component to handle the intent.
5231 *
5232 * @see #resolveActivity
5233 * @see #setComponent
5234 */
5235 public ComponentName getComponent() {
5236 return mComponent;
5237 }
5238
5239 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005240 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5241 * used as a hint to the receiver for animations and the like. Null means that there
5242 * is no source bounds.
5243 */
5244 public Rect getSourceBounds() {
5245 return mSourceBounds;
5246 }
5247
5248 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 * Return the Activity component that should be used to handle this intent.
5250 * The appropriate component is determined based on the information in the
5251 * intent, evaluated as follows:
5252 *
5253 * <p>If {@link #getComponent} returns an explicit class, that is returned
5254 * without any further consideration.
5255 *
5256 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5257 * category to be considered.
5258 *
5259 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5260 * action.
5261 *
5262 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5263 * this type.
5264 *
5265 * <p>If {@link #addCategory} has added any categories, the activity must
5266 * handle ALL of the categories specified.
5267 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005268 * <p>If {@link #getPackage} is non-NULL, only activity components in
5269 * that application package will be considered.
5270 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005271 * <p>If there are no activities that satisfy all of these conditions, a
5272 * null string is returned.
5273 *
5274 * <p>If multiple activities are found to satisfy the intent, the one with
5275 * the highest priority will be used. If there are multiple activities
5276 * with the same priority, the system will either pick the best activity
5277 * based on user preference, or resolve to a system class that will allow
5278 * the user to pick an activity and forward from there.
5279 *
5280 * <p>This method is implemented simply by calling
5281 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5282 * true.</p>
5283 * <p> This API is called for you as part of starting an activity from an
5284 * intent. You do not normally need to call it yourself.</p>
5285 *
5286 * @param pm The package manager with which to resolve the Intent.
5287 *
5288 * @return Name of the component implementing an activity that can
5289 * display the intent.
5290 *
5291 * @see #setComponent
5292 * @see #getComponent
5293 * @see #resolveActivityInfo
5294 */
5295 public ComponentName resolveActivity(PackageManager pm) {
5296 if (mComponent != null) {
5297 return mComponent;
5298 }
5299
5300 ResolveInfo info = pm.resolveActivity(
5301 this, PackageManager.MATCH_DEFAULT_ONLY);
5302 if (info != null) {
5303 return new ComponentName(
5304 info.activityInfo.applicationInfo.packageName,
5305 info.activityInfo.name);
5306 }
5307
5308 return null;
5309 }
5310
5311 /**
5312 * Resolve the Intent into an {@link ActivityInfo}
5313 * describing the activity that should execute the intent. Resolution
5314 * follows the same rules as described for {@link #resolveActivity}, but
5315 * you get back the completely information about the resolved activity
5316 * instead of just its class name.
5317 *
5318 * @param pm The package manager with which to resolve the Intent.
5319 * @param flags Addition information to retrieve as per
5320 * {@link PackageManager#getActivityInfo(ComponentName, int)
5321 * PackageManager.getActivityInfo()}.
5322 *
5323 * @return PackageManager.ActivityInfo
5324 *
5325 * @see #resolveActivity
5326 */
5327 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5328 ActivityInfo ai = null;
5329 if (mComponent != null) {
5330 try {
5331 ai = pm.getActivityInfo(mComponent, flags);
5332 } catch (PackageManager.NameNotFoundException e) {
5333 // ignore
5334 }
5335 } else {
5336 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005337 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005338 if (info != null) {
5339 ai = info.activityInfo;
5340 }
5341 }
5342
5343 return ai;
5344 }
5345
5346 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005347 * Special function for use by the system to resolve service
5348 * intents to system apps. Throws an exception if there are
5349 * multiple potential matches to the Intent. Returns null if
5350 * there are no matches.
5351 * @hide
5352 */
5353 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5354 if (mComponent != null) {
5355 return mComponent;
5356 }
5357
5358 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5359 if (results == null) {
5360 return null;
5361 }
5362 ComponentName comp = null;
5363 for (int i=0; i<results.size(); i++) {
5364 ResolveInfo ri = results.get(i);
5365 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5366 continue;
5367 }
5368 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5369 ri.serviceInfo.name);
5370 if (comp != null) {
5371 throw new IllegalStateException("Multiple system services handle " + this
5372 + ": " + comp + ", " + foundComp);
5373 }
5374 comp = foundComp;
5375 }
5376 return comp;
5377 }
5378
5379 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005380 * Set the general action to be performed.
5381 *
5382 * @param action An action name, such as ACTION_VIEW. Application-specific
5383 * actions should be prefixed with the vendor's package name.
5384 *
5385 * @return Returns the same Intent object, for chaining multiple calls
5386 * into a single statement.
5387 *
5388 * @see #getAction
5389 */
5390 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005391 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005392 return this;
5393 }
5394
5395 /**
5396 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005397 * clears any type that was previously set by {@link #setType} or
5398 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005399 *
Nick Pellyccae4122012-01-09 14:12:58 -08005400 * <p><em>Note: scheme matching in the Android framework is
5401 * case-sensitive, unlike the formal RFC. As a result,
5402 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005403 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005404 * {@link #setDataAndNormalize}
5405 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005406 *
Nick Pellyccae4122012-01-09 14:12:58 -08005407 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005408 *
5409 * @return Returns the same Intent object, for chaining multiple calls
5410 * into a single statement.
5411 *
5412 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005413 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005414 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005415 */
5416 public Intent setData(Uri data) {
5417 mData = data;
5418 mType = null;
5419 return this;
5420 }
5421
5422 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005423 * Normalize and set the data this intent is operating on.
5424 *
5425 * <p>This method automatically clears any type that was
5426 * previously set (for example, by {@link #setType}).
5427 *
5428 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005429 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005430 * so really this is just a convenience method for
5431 * <pre>
5432 * setData(data.normalize())
5433 * </pre>
5434 *
5435 * @param data The Uri of the data this intent is now targeting.
5436 *
5437 * @return Returns the same Intent object, for chaining multiple calls
5438 * into a single statement.
5439 *
5440 * @see #getData
5441 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005442 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005443 */
5444 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005445 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005446 }
5447
5448 /**
5449 * Set an explicit MIME data type.
5450 *
5451 * <p>This is used to create intents that only specify a type and not data,
5452 * for example to indicate the type of data to return.
5453 *
5454 * <p>This method automatically clears any data that was
5455 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005456 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005457 * <p><em>Note: MIME type matching in the Android framework is
5458 * case-sensitive, unlike formal RFC MIME types. As a result,
5459 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005460 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5461 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005462 *
5463 * @param type The MIME type of the data being handled by this intent.
5464 *
5465 * @return Returns the same Intent object, for chaining multiple calls
5466 * into a single statement.
5467 *
5468 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005469 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005470 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005471 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005472 */
5473 public Intent setType(String type) {
5474 mData = null;
5475 mType = type;
5476 return this;
5477 }
5478
5479 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005480 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005481 *
Nick Pellyccae4122012-01-09 14:12:58 -08005482 * <p>This is used to create intents that only specify a type and not data,
5483 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005484 *
Nick Pellyccae4122012-01-09 14:12:58 -08005485 * <p>This method automatically clears any data that was
5486 * previously set (for example by {@link #setData}).
5487 *
5488 * <p>The MIME type is normalized using
5489 * {@link #normalizeMimeType} before it is set,
5490 * so really this is just a convenience method for
5491 * <pre>
5492 * setType(Intent.normalizeMimeType(type))
5493 * </pre>
5494 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005495 * @param type The MIME type of the data being handled by this intent.
5496 *
5497 * @return Returns the same Intent object, for chaining multiple calls
5498 * into a single statement.
5499 *
Nick Pellyccae4122012-01-09 14:12:58 -08005500 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005501 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005502 * @see #normalizeMimeType
5503 */
5504 public Intent setTypeAndNormalize(String type) {
5505 return setType(normalizeMimeType(type));
5506 }
5507
5508 /**
5509 * (Usually optional) Set the data for the intent along with an explicit
5510 * MIME data type. This method should very rarely be used -- it allows you
5511 * to override the MIME type that would ordinarily be inferred from the
5512 * data with your own type given here.
5513 *
5514 * <p><em>Note: MIME type and Uri scheme matching in the
5515 * Android framework is case-sensitive, unlike the formal RFC definitions.
5516 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005517 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005518 * {@link #setDataAndTypeAndNormalize}
5519 * to ensure that they are converted to lower case.</em>
5520 *
5521 * @param data The Uri of the data this intent is now targeting.
5522 * @param type The MIME type of the data being handled by this intent.
5523 *
5524 * @return Returns the same Intent object, for chaining multiple calls
5525 * into a single statement.
5526 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005528 * @see #setData
5529 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005530 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005531 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005532 */
5533 public Intent setDataAndType(Uri data, String type) {
5534 mData = data;
5535 mType = type;
5536 return this;
5537 }
5538
5539 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005540 * (Usually optional) Normalize and set both the data Uri and an explicit
5541 * MIME data type. This method should very rarely be used -- it allows you
5542 * to override the MIME type that would ordinarily be inferred from the
5543 * data with your own type given here.
5544 *
5545 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005546 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005547 * before they are set, so really this is just a convenience method for
5548 * <pre>
5549 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5550 * </pre>
5551 *
5552 * @param data The Uri of the data this intent is now targeting.
5553 * @param type The MIME type of the data being handled by this intent.
5554 *
5555 * @return Returns the same Intent object, for chaining multiple calls
5556 * into a single statement.
5557 *
5558 * @see #setType
5559 * @see #setData
5560 * @see #setDataAndType
5561 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005562 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005563 */
5564 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005565 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005566 }
5567
5568 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005569 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005570 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571 * activities that provide <em>all</em> of the requested categories will be
5572 * used.
5573 *
5574 * @param category The desired category. This can be either one of the
5575 * predefined Intent categories, or a custom category in your own
5576 * namespace.
5577 *
5578 * @return Returns the same Intent object, for chaining multiple calls
5579 * into a single statement.
5580 *
5581 * @see #hasCategory
5582 * @see #removeCategory
5583 */
5584 public Intent addCategory(String category) {
5585 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005586 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005588 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005589 return this;
5590 }
5591
5592 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005593 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005594 *
5595 * @param category The category to remove.
5596 *
5597 * @see #addCategory
5598 */
5599 public void removeCategory(String category) {
5600 if (mCategories != null) {
5601 mCategories.remove(category);
5602 if (mCategories.size() == 0) {
5603 mCategories = null;
5604 }
5605 }
5606 }
5607
5608 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005609 * Set a selector for this Intent. This is a modification to the kinds of
5610 * things the Intent will match. If the selector is set, it will be used
5611 * when trying to find entities that can handle the Intent, instead of the
5612 * main contents of the Intent. This allows you build an Intent containing
5613 * a generic protocol while targeting it more specifically.
5614 *
5615 * <p>An example of where this may be used is with things like
5616 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5617 * Intent that will launch the Browser application. However, the correct
5618 * main entry point of an application is actually {@link #ACTION_MAIN}
5619 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5620 * used to specify the actual Activity to launch. If you launch the browser
5621 * with something different, undesired behavior may happen if the user has
5622 * previously or later launches it the normal way, since they do not match.
5623 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5624 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5625 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5626 *
5627 * <p>Setting a selector does not impact the behavior of
5628 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5629 * desired behavior of a selector -- it does not impact the base meaning
5630 * of the Intent, just what kinds of things will be matched against it
5631 * when determining who can handle it.</p>
5632 *
5633 * <p>You can not use both a selector and {@link #setPackage(String)} on
5634 * the same base Intent.</p>
5635 *
5636 * @param selector The desired selector Intent; set to null to not use
5637 * a special selector.
5638 */
5639 public void setSelector(Intent selector) {
5640 if (selector == this) {
5641 throw new IllegalArgumentException(
5642 "Intent being set as a selector of itself");
5643 }
5644 if (selector != null && mPackage != null) {
5645 throw new IllegalArgumentException(
5646 "Can't set selector when package name is already set");
5647 }
5648 mSelector = selector;
5649 }
5650
5651 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005652 * Set a {@link ClipData} associated with this Intent. This replaces any
5653 * previously set ClipData.
5654 *
5655 * <p>The ClipData in an intent is not used for Intent matching or other
5656 * such operations. Semantically it is like extras, used to transmit
5657 * additional data with the Intent. The main feature of using this over
5658 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5659 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5660 * items included in the clip data. This is useful, in particular, if
5661 * you want to transmit an Intent containing multiple <code>content:</code>
5662 * URIs for which the recipient may not have global permission to access the
5663 * content provider.
5664 *
5665 * <p>If the ClipData contains items that are themselves Intents, any
5666 * grant flags in those Intents will be ignored. Only the top-level flags
5667 * of the main Intent are respected, and will be applied to all Uri or
5668 * Intent items in the clip (or sub-items of the clip).
5669 *
5670 * <p>The MIME type, label, and icon in the ClipData object are not
5671 * directly used by Intent. Applications should generally rely on the
5672 * MIME type of the Intent itself, not what it may find in the ClipData.
5673 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005674 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005675 *
5676 * @param clip The new clip to set. May be null to clear the current clip.
5677 */
5678 public void setClipData(ClipData clip) {
5679 mClipData = clip;
5680 }
5681
5682 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005683 * This is NOT a secure mechanism to identify the user who sent the intent.
5684 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5685 * who sent the intent.
5686 * @hide
5687 */
5688 public void setContentUserHint(int contentUserHint) {
5689 mContentUserHint = contentUserHint;
5690 }
5691
5692 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005693 * Add extended data to the intent. The name must include a package
5694 * prefix, for example the app com.android.contacts would use names
5695 * like "com.android.contacts.ShowAll".
5696 *
5697 * @param name The name of the extra data, with package prefix.
5698 * @param value The boolean data value.
5699 *
5700 * @return Returns the same Intent object, for chaining multiple calls
5701 * into a single statement.
5702 *
5703 * @see #putExtras
5704 * @see #removeExtra
5705 * @see #getBooleanExtra(String, boolean)
5706 */
5707 public Intent putExtra(String name, boolean value) {
5708 if (mExtras == null) {
5709 mExtras = new Bundle();
5710 }
5711 mExtras.putBoolean(name, value);
5712 return this;
5713 }
5714
5715 /**
5716 * Add extended data to the intent. The name must include a package
5717 * prefix, for example the app com.android.contacts would use names
5718 * like "com.android.contacts.ShowAll".
5719 *
5720 * @param name The name of the extra data, with package prefix.
5721 * @param value The byte data value.
5722 *
5723 * @return Returns the same Intent object, for chaining multiple calls
5724 * into a single statement.
5725 *
5726 * @see #putExtras
5727 * @see #removeExtra
5728 * @see #getByteExtra(String, byte)
5729 */
5730 public Intent putExtra(String name, byte value) {
5731 if (mExtras == null) {
5732 mExtras = new Bundle();
5733 }
5734 mExtras.putByte(name, value);
5735 return this;
5736 }
5737
5738 /**
5739 * Add extended data to the intent. The name must include a package
5740 * prefix, for example the app com.android.contacts would use names
5741 * like "com.android.contacts.ShowAll".
5742 *
5743 * @param name The name of the extra data, with package prefix.
5744 * @param value The char data value.
5745 *
5746 * @return Returns the same Intent object, for chaining multiple calls
5747 * into a single statement.
5748 *
5749 * @see #putExtras
5750 * @see #removeExtra
5751 * @see #getCharExtra(String, char)
5752 */
5753 public Intent putExtra(String name, char value) {
5754 if (mExtras == null) {
5755 mExtras = new Bundle();
5756 }
5757 mExtras.putChar(name, value);
5758 return this;
5759 }
5760
5761 /**
5762 * Add extended data to the intent. The name must include a package
5763 * prefix, for example the app com.android.contacts would use names
5764 * like "com.android.contacts.ShowAll".
5765 *
5766 * @param name The name of the extra data, with package prefix.
5767 * @param value The short data value.
5768 *
5769 * @return Returns the same Intent object, for chaining multiple calls
5770 * into a single statement.
5771 *
5772 * @see #putExtras
5773 * @see #removeExtra
5774 * @see #getShortExtra(String, short)
5775 */
5776 public Intent putExtra(String name, short value) {
5777 if (mExtras == null) {
5778 mExtras = new Bundle();
5779 }
5780 mExtras.putShort(name, value);
5781 return this;
5782 }
5783
5784 /**
5785 * Add extended data to the intent. The name must include a package
5786 * prefix, for example the app com.android.contacts would use names
5787 * like "com.android.contacts.ShowAll".
5788 *
5789 * @param name The name of the extra data, with package prefix.
5790 * @param value The integer data value.
5791 *
5792 * @return Returns the same Intent object, for chaining multiple calls
5793 * into a single statement.
5794 *
5795 * @see #putExtras
5796 * @see #removeExtra
5797 * @see #getIntExtra(String, int)
5798 */
5799 public Intent putExtra(String name, int value) {
5800 if (mExtras == null) {
5801 mExtras = new Bundle();
5802 }
5803 mExtras.putInt(name, value);
5804 return this;
5805 }
5806
5807 /**
5808 * Add extended data to the intent. The name must include a package
5809 * prefix, for example the app com.android.contacts would use names
5810 * like "com.android.contacts.ShowAll".
5811 *
5812 * @param name The name of the extra data, with package prefix.
5813 * @param value The long data value.
5814 *
5815 * @return Returns the same Intent object, for chaining multiple calls
5816 * into a single statement.
5817 *
5818 * @see #putExtras
5819 * @see #removeExtra
5820 * @see #getLongExtra(String, long)
5821 */
5822 public Intent putExtra(String name, long value) {
5823 if (mExtras == null) {
5824 mExtras = new Bundle();
5825 }
5826 mExtras.putLong(name, value);
5827 return this;
5828 }
5829
5830 /**
5831 * Add extended data to the intent. The name must include a package
5832 * prefix, for example the app com.android.contacts would use names
5833 * like "com.android.contacts.ShowAll".
5834 *
5835 * @param name The name of the extra data, with package prefix.
5836 * @param value The float data value.
5837 *
5838 * @return Returns the same Intent object, for chaining multiple calls
5839 * into a single statement.
5840 *
5841 * @see #putExtras
5842 * @see #removeExtra
5843 * @see #getFloatExtra(String, float)
5844 */
5845 public Intent putExtra(String name, float value) {
5846 if (mExtras == null) {
5847 mExtras = new Bundle();
5848 }
5849 mExtras.putFloat(name, value);
5850 return this;
5851 }
5852
5853 /**
5854 * Add extended data to the intent. The name must include a package
5855 * prefix, for example the app com.android.contacts would use names
5856 * like "com.android.contacts.ShowAll".
5857 *
5858 * @param name The name of the extra data, with package prefix.
5859 * @param value The double data value.
5860 *
5861 * @return Returns the same Intent object, for chaining multiple calls
5862 * into a single statement.
5863 *
5864 * @see #putExtras
5865 * @see #removeExtra
5866 * @see #getDoubleExtra(String, double)
5867 */
5868 public Intent putExtra(String name, double value) {
5869 if (mExtras == null) {
5870 mExtras = new Bundle();
5871 }
5872 mExtras.putDouble(name, value);
5873 return this;
5874 }
5875
5876 /**
5877 * Add extended data to the intent. The name must include a package
5878 * prefix, for example the app com.android.contacts would use names
5879 * like "com.android.contacts.ShowAll".
5880 *
5881 * @param name The name of the extra data, with package prefix.
5882 * @param value The String data value.
5883 *
5884 * @return Returns the same Intent object, for chaining multiple calls
5885 * into a single statement.
5886 *
5887 * @see #putExtras
5888 * @see #removeExtra
5889 * @see #getStringExtra(String)
5890 */
5891 public Intent putExtra(String name, String value) {
5892 if (mExtras == null) {
5893 mExtras = new Bundle();
5894 }
5895 mExtras.putString(name, value);
5896 return this;
5897 }
5898
5899 /**
5900 * Add extended data to the intent. The name must include a package
5901 * prefix, for example the app com.android.contacts would use names
5902 * like "com.android.contacts.ShowAll".
5903 *
5904 * @param name The name of the extra data, with package prefix.
5905 * @param value The CharSequence data value.
5906 *
5907 * @return Returns the same Intent object, for chaining multiple calls
5908 * into a single statement.
5909 *
5910 * @see #putExtras
5911 * @see #removeExtra
5912 * @see #getCharSequenceExtra(String)
5913 */
5914 public Intent putExtra(String name, CharSequence value) {
5915 if (mExtras == null) {
5916 mExtras = new Bundle();
5917 }
5918 mExtras.putCharSequence(name, value);
5919 return this;
5920 }
5921
5922 /**
5923 * Add extended data to the intent. The name must include a package
5924 * prefix, for example the app com.android.contacts would use names
5925 * like "com.android.contacts.ShowAll".
5926 *
5927 * @param name The name of the extra data, with package prefix.
5928 * @param value The Parcelable data value.
5929 *
5930 * @return Returns the same Intent object, for chaining multiple calls
5931 * into a single statement.
5932 *
5933 * @see #putExtras
5934 * @see #removeExtra
5935 * @see #getParcelableExtra(String)
5936 */
5937 public Intent putExtra(String name, Parcelable value) {
5938 if (mExtras == null) {
5939 mExtras = new Bundle();
5940 }
5941 mExtras.putParcelable(name, value);
5942 return this;
5943 }
5944
5945 /**
5946 * Add extended data to the intent. The name must include a package
5947 * prefix, for example the app com.android.contacts would use names
5948 * like "com.android.contacts.ShowAll".
5949 *
5950 * @param name The name of the extra data, with package prefix.
5951 * @param value The Parcelable[] data value.
5952 *
5953 * @return Returns the same Intent object, for chaining multiple calls
5954 * into a single statement.
5955 *
5956 * @see #putExtras
5957 * @see #removeExtra
5958 * @see #getParcelableArrayExtra(String)
5959 */
5960 public Intent putExtra(String name, Parcelable[] value) {
5961 if (mExtras == null) {
5962 mExtras = new Bundle();
5963 }
5964 mExtras.putParcelableArray(name, value);
5965 return this;
5966 }
5967
5968 /**
5969 * Add extended data to the intent. The name must include a package
5970 * prefix, for example the app com.android.contacts would use names
5971 * like "com.android.contacts.ShowAll".
5972 *
5973 * @param name The name of the extra data, with package prefix.
5974 * @param value The ArrayList<Parcelable> data value.
5975 *
5976 * @return Returns the same Intent object, for chaining multiple calls
5977 * into a single statement.
5978 *
5979 * @see #putExtras
5980 * @see #removeExtra
5981 * @see #getParcelableArrayListExtra(String)
5982 */
5983 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5984 if (mExtras == null) {
5985 mExtras = new Bundle();
5986 }
5987 mExtras.putParcelableArrayList(name, value);
5988 return this;
5989 }
5990
5991 /**
5992 * Add extended data to the intent. The name must include a package
5993 * prefix, for example the app com.android.contacts would use names
5994 * like "com.android.contacts.ShowAll".
5995 *
5996 * @param name The name of the extra data, with package prefix.
5997 * @param value The ArrayList<Integer> data value.
5998 *
5999 * @return Returns the same Intent object, for chaining multiple calls
6000 * into a single statement.
6001 *
6002 * @see #putExtras
6003 * @see #removeExtra
6004 * @see #getIntegerArrayListExtra(String)
6005 */
6006 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6007 if (mExtras == null) {
6008 mExtras = new Bundle();
6009 }
6010 mExtras.putIntegerArrayList(name, value);
6011 return this;
6012 }
6013
6014 /**
6015 * Add extended data to the intent. The name must include a package
6016 * prefix, for example the app com.android.contacts would use names
6017 * like "com.android.contacts.ShowAll".
6018 *
6019 * @param name The name of the extra data, with package prefix.
6020 * @param value The ArrayList<String> data value.
6021 *
6022 * @return Returns the same Intent object, for chaining multiple calls
6023 * into a single statement.
6024 *
6025 * @see #putExtras
6026 * @see #removeExtra
6027 * @see #getStringArrayListExtra(String)
6028 */
6029 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6030 if (mExtras == null) {
6031 mExtras = new Bundle();
6032 }
6033 mExtras.putStringArrayList(name, value);
6034 return this;
6035 }
6036
6037 /**
6038 * Add extended data to the intent. The name must include a package
6039 * prefix, for example the app com.android.contacts would use names
6040 * like "com.android.contacts.ShowAll".
6041 *
6042 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006043 * @param value The ArrayList<CharSequence> data value.
6044 *
6045 * @return Returns the same Intent object, for chaining multiple calls
6046 * into a single statement.
6047 *
6048 * @see #putExtras
6049 * @see #removeExtra
6050 * @see #getCharSequenceArrayListExtra(String)
6051 */
6052 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6053 if (mExtras == null) {
6054 mExtras = new Bundle();
6055 }
6056 mExtras.putCharSequenceArrayList(name, value);
6057 return this;
6058 }
6059
6060 /**
6061 * Add extended data to the intent. The name must include a package
6062 * prefix, for example the app com.android.contacts would use names
6063 * like "com.android.contacts.ShowAll".
6064 *
6065 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006066 * @param value The Serializable data value.
6067 *
6068 * @return Returns the same Intent object, for chaining multiple calls
6069 * into a single statement.
6070 *
6071 * @see #putExtras
6072 * @see #removeExtra
6073 * @see #getSerializableExtra(String)
6074 */
6075 public Intent putExtra(String name, Serializable value) {
6076 if (mExtras == null) {
6077 mExtras = new Bundle();
6078 }
6079 mExtras.putSerializable(name, value);
6080 return this;
6081 }
6082
6083 /**
6084 * Add extended data to the intent. The name must include a package
6085 * prefix, for example the app com.android.contacts would use names
6086 * like "com.android.contacts.ShowAll".
6087 *
6088 * @param name The name of the extra data, with package prefix.
6089 * @param value The boolean array data value.
6090 *
6091 * @return Returns the same Intent object, for chaining multiple calls
6092 * into a single statement.
6093 *
6094 * @see #putExtras
6095 * @see #removeExtra
6096 * @see #getBooleanArrayExtra(String)
6097 */
6098 public Intent putExtra(String name, boolean[] value) {
6099 if (mExtras == null) {
6100 mExtras = new Bundle();
6101 }
6102 mExtras.putBooleanArray(name, value);
6103 return this;
6104 }
6105
6106 /**
6107 * Add extended data to the intent. The name must include a package
6108 * prefix, for example the app com.android.contacts would use names
6109 * like "com.android.contacts.ShowAll".
6110 *
6111 * @param name The name of the extra data, with package prefix.
6112 * @param value The byte array data value.
6113 *
6114 * @return Returns the same Intent object, for chaining multiple calls
6115 * into a single statement.
6116 *
6117 * @see #putExtras
6118 * @see #removeExtra
6119 * @see #getByteArrayExtra(String)
6120 */
6121 public Intent putExtra(String name, byte[] value) {
6122 if (mExtras == null) {
6123 mExtras = new Bundle();
6124 }
6125 mExtras.putByteArray(name, value);
6126 return this;
6127 }
6128
6129 /**
6130 * Add extended data to the intent. The name must include a package
6131 * prefix, for example the app com.android.contacts would use names
6132 * like "com.android.contacts.ShowAll".
6133 *
6134 * @param name The name of the extra data, with package prefix.
6135 * @param value The short array data value.
6136 *
6137 * @return Returns the same Intent object, for chaining multiple calls
6138 * into a single statement.
6139 *
6140 * @see #putExtras
6141 * @see #removeExtra
6142 * @see #getShortArrayExtra(String)
6143 */
6144 public Intent putExtra(String name, short[] value) {
6145 if (mExtras == null) {
6146 mExtras = new Bundle();
6147 }
6148 mExtras.putShortArray(name, value);
6149 return this;
6150 }
6151
6152 /**
6153 * Add extended data to the intent. The name must include a package
6154 * prefix, for example the app com.android.contacts would use names
6155 * like "com.android.contacts.ShowAll".
6156 *
6157 * @param name The name of the extra data, with package prefix.
6158 * @param value The char array data value.
6159 *
6160 * @return Returns the same Intent object, for chaining multiple calls
6161 * into a single statement.
6162 *
6163 * @see #putExtras
6164 * @see #removeExtra
6165 * @see #getCharArrayExtra(String)
6166 */
6167 public Intent putExtra(String name, char[] value) {
6168 if (mExtras == null) {
6169 mExtras = new Bundle();
6170 }
6171 mExtras.putCharArray(name, value);
6172 return this;
6173 }
6174
6175 /**
6176 * Add extended data to the intent. The name must include a package
6177 * prefix, for example the app com.android.contacts would use names
6178 * like "com.android.contacts.ShowAll".
6179 *
6180 * @param name The name of the extra data, with package prefix.
6181 * @param value The int array data value.
6182 *
6183 * @return Returns the same Intent object, for chaining multiple calls
6184 * into a single statement.
6185 *
6186 * @see #putExtras
6187 * @see #removeExtra
6188 * @see #getIntArrayExtra(String)
6189 */
6190 public Intent putExtra(String name, int[] value) {
6191 if (mExtras == null) {
6192 mExtras = new Bundle();
6193 }
6194 mExtras.putIntArray(name, value);
6195 return this;
6196 }
6197
6198 /**
6199 * Add extended data to the intent. The name must include a package
6200 * prefix, for example the app com.android.contacts would use names
6201 * like "com.android.contacts.ShowAll".
6202 *
6203 * @param name The name of the extra data, with package prefix.
6204 * @param value The byte array data value.
6205 *
6206 * @return Returns the same Intent object, for chaining multiple calls
6207 * into a single statement.
6208 *
6209 * @see #putExtras
6210 * @see #removeExtra
6211 * @see #getLongArrayExtra(String)
6212 */
6213 public Intent putExtra(String name, long[] value) {
6214 if (mExtras == null) {
6215 mExtras = new Bundle();
6216 }
6217 mExtras.putLongArray(name, value);
6218 return this;
6219 }
6220
6221 /**
6222 * Add extended data to the intent. The name must include a package
6223 * prefix, for example the app com.android.contacts would use names
6224 * like "com.android.contacts.ShowAll".
6225 *
6226 * @param name The name of the extra data, with package prefix.
6227 * @param value The float array data value.
6228 *
6229 * @return Returns the same Intent object, for chaining multiple calls
6230 * into a single statement.
6231 *
6232 * @see #putExtras
6233 * @see #removeExtra
6234 * @see #getFloatArrayExtra(String)
6235 */
6236 public Intent putExtra(String name, float[] value) {
6237 if (mExtras == null) {
6238 mExtras = new Bundle();
6239 }
6240 mExtras.putFloatArray(name, value);
6241 return this;
6242 }
6243
6244 /**
6245 * Add extended data to the intent. The name must include a package
6246 * prefix, for example the app com.android.contacts would use names
6247 * like "com.android.contacts.ShowAll".
6248 *
6249 * @param name The name of the extra data, with package prefix.
6250 * @param value The double array data value.
6251 *
6252 * @return Returns the same Intent object, for chaining multiple calls
6253 * into a single statement.
6254 *
6255 * @see #putExtras
6256 * @see #removeExtra
6257 * @see #getDoubleArrayExtra(String)
6258 */
6259 public Intent putExtra(String name, double[] value) {
6260 if (mExtras == null) {
6261 mExtras = new Bundle();
6262 }
6263 mExtras.putDoubleArray(name, value);
6264 return this;
6265 }
6266
6267 /**
6268 * Add extended data to the intent. The name must include a package
6269 * prefix, for example the app com.android.contacts would use names
6270 * like "com.android.contacts.ShowAll".
6271 *
6272 * @param name The name of the extra data, with package prefix.
6273 * @param value The String array data value.
6274 *
6275 * @return Returns the same Intent object, for chaining multiple calls
6276 * into a single statement.
6277 *
6278 * @see #putExtras
6279 * @see #removeExtra
6280 * @see #getStringArrayExtra(String)
6281 */
6282 public Intent putExtra(String name, String[] value) {
6283 if (mExtras == null) {
6284 mExtras = new Bundle();
6285 }
6286 mExtras.putStringArray(name, value);
6287 return this;
6288 }
6289
6290 /**
6291 * Add extended data to the intent. The name must include a package
6292 * prefix, for example the app com.android.contacts would use names
6293 * like "com.android.contacts.ShowAll".
6294 *
6295 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006296 * @param value The CharSequence array data value.
6297 *
6298 * @return Returns the same Intent object, for chaining multiple calls
6299 * into a single statement.
6300 *
6301 * @see #putExtras
6302 * @see #removeExtra
6303 * @see #getCharSequenceArrayExtra(String)
6304 */
6305 public Intent putExtra(String name, CharSequence[] value) {
6306 if (mExtras == null) {
6307 mExtras = new Bundle();
6308 }
6309 mExtras.putCharSequenceArray(name, value);
6310 return this;
6311 }
6312
6313 /**
6314 * Add extended data to the intent. The name must include a package
6315 * prefix, for example the app com.android.contacts would use names
6316 * like "com.android.contacts.ShowAll".
6317 *
6318 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006319 * @param value The Bundle data value.
6320 *
6321 * @return Returns the same Intent object, for chaining multiple calls
6322 * into a single statement.
6323 *
6324 * @see #putExtras
6325 * @see #removeExtra
6326 * @see #getBundleExtra(String)
6327 */
6328 public Intent putExtra(String name, Bundle value) {
6329 if (mExtras == null) {
6330 mExtras = new Bundle();
6331 }
6332 mExtras.putBundle(name, value);
6333 return this;
6334 }
6335
6336 /**
6337 * Add extended data to the intent. The name must include a package
6338 * prefix, for example the app com.android.contacts would use names
6339 * like "com.android.contacts.ShowAll".
6340 *
6341 * @param name The name of the extra data, with package prefix.
6342 * @param value The IBinder data value.
6343 *
6344 * @return Returns the same Intent object, for chaining multiple calls
6345 * into a single statement.
6346 *
6347 * @see #putExtras
6348 * @see #removeExtra
6349 * @see #getIBinderExtra(String)
6350 *
6351 * @deprecated
6352 * @hide
6353 */
6354 @Deprecated
6355 public Intent putExtra(String name, IBinder value) {
6356 if (mExtras == null) {
6357 mExtras = new Bundle();
6358 }
6359 mExtras.putIBinder(name, value);
6360 return this;
6361 }
6362
6363 /**
6364 * Copy all extras in 'src' in to this intent.
6365 *
6366 * @param src Contains the extras to copy.
6367 *
6368 * @see #putExtra
6369 */
6370 public Intent putExtras(Intent src) {
6371 if (src.mExtras != null) {
6372 if (mExtras == null) {
6373 mExtras = new Bundle(src.mExtras);
6374 } else {
6375 mExtras.putAll(src.mExtras);
6376 }
6377 }
6378 return this;
6379 }
6380
6381 /**
6382 * Add a set of extended data to the intent. The keys must include a package
6383 * prefix, for example the app com.android.contacts would use names
6384 * like "com.android.contacts.ShowAll".
6385 *
6386 * @param extras The Bundle of extras to add to this intent.
6387 *
6388 * @see #putExtra
6389 * @see #removeExtra
6390 */
6391 public Intent putExtras(Bundle extras) {
6392 if (mExtras == null) {
6393 mExtras = new Bundle();
6394 }
6395 mExtras.putAll(extras);
6396 return this;
6397 }
6398
6399 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006400 * Completely replace the extras in the Intent with the extras in the
6401 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006402 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006403 * @param src The exact extras contained in this Intent are copied
6404 * into the target intent, replacing any that were previously there.
6405 */
6406 public Intent replaceExtras(Intent src) {
6407 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6408 return this;
6409 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006410
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006411 /**
6412 * Completely replace the extras in the Intent with the given Bundle of
6413 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006414 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006415 * @param extras The new set of extras in the Intent, or null to erase
6416 * all extras.
6417 */
6418 public Intent replaceExtras(Bundle extras) {
6419 mExtras = extras != null ? new Bundle(extras) : null;
6420 return this;
6421 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006422
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006423 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006424 * Remove extended data from the intent.
6425 *
6426 * @see #putExtra
6427 */
6428 public void removeExtra(String name) {
6429 if (mExtras != null) {
6430 mExtras.remove(name);
6431 if (mExtras.size() == 0) {
6432 mExtras = null;
6433 }
6434 }
6435 }
6436
6437 /**
6438 * Set special flags controlling how this intent is handled. Most values
6439 * here depend on the type of component being executed by the Intent,
6440 * specifically the FLAG_ACTIVITY_* flags are all for use with
6441 * {@link Context#startActivity Context.startActivity()} and the
6442 * FLAG_RECEIVER_* flags are all for use with
6443 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6444 *
Scott Main7aee61f2011-02-08 11:25:01 -08006445 * <p>See the
6446 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6447 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006448 * the behavior of your application.
6449 *
6450 * @param flags The desired flags.
6451 *
6452 * @return Returns the same Intent object, for chaining multiple calls
6453 * into a single statement.
6454 *
6455 * @see #getFlags
6456 * @see #addFlags
6457 *
6458 * @see #FLAG_GRANT_READ_URI_PERMISSION
6459 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006460 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6461 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006462 * @see #FLAG_DEBUG_LOG_RESOLUTION
6463 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006465 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006466 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006467 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006468 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6469 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006470 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006471 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006472 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006473 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006474 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006475 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006476 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006477 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6478 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006479 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006480 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006481 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006482 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6483 */
6484 public Intent setFlags(int flags) {
6485 mFlags = flags;
6486 return this;
6487 }
6488
6489 /**
6490 * Add additional flags to the intent (or with existing flags
6491 * value).
6492 *
6493 * @param flags The new flags to set.
6494 *
6495 * @return Returns the same Intent object, for chaining multiple calls
6496 * into a single statement.
6497 *
6498 * @see #setFlags
6499 */
6500 public Intent addFlags(int flags) {
6501 mFlags |= flags;
6502 return this;
6503 }
6504
6505 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006506 * (Usually optional) Set an explicit application package name that limits
6507 * the components this Intent will resolve to. If left to the default
6508 * value of null, all components in all applications will considered.
6509 * If non-null, the Intent can only match the components in the given
6510 * application package.
6511 *
6512 * @param packageName The name of the application package to handle the
6513 * intent, or null to allow any application package.
6514 *
6515 * @return Returns the same Intent object, for chaining multiple calls
6516 * into a single statement.
6517 *
6518 * @see #getPackage
6519 * @see #resolveActivity
6520 */
6521 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006522 if (packageName != null && mSelector != null) {
6523 throw new IllegalArgumentException(
6524 "Can't set package name when selector is already set");
6525 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006526 mPackage = packageName;
6527 return this;
6528 }
6529
6530 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006531 * (Usually optional) Explicitly set the component to handle the intent.
6532 * If left with the default value of null, the system will determine the
6533 * appropriate class to use based on the other fields (action, data,
6534 * type, categories) in the Intent. If this class is defined, the
6535 * specified class will always be used regardless of the other fields. You
6536 * should only set this value when you know you absolutely want a specific
6537 * class to be used; otherwise it is better to let the system find the
6538 * appropriate class so that you will respect the installed applications
6539 * and user preferences.
6540 *
6541 * @param component The name of the application component to handle the
6542 * intent, or null to let the system find one for you.
6543 *
6544 * @return Returns the same Intent object, for chaining multiple calls
6545 * into a single statement.
6546 *
6547 * @see #setClass
6548 * @see #setClassName(Context, String)
6549 * @see #setClassName(String, String)
6550 * @see #getComponent
6551 * @see #resolveActivity
6552 */
6553 public Intent setComponent(ComponentName component) {
6554 mComponent = component;
6555 return this;
6556 }
6557
6558 /**
6559 * Convenience for calling {@link #setComponent} with an
6560 * explicit class name.
6561 *
6562 * @param packageContext A Context of the application package implementing
6563 * this class.
6564 * @param className The name of a class inside of the application package
6565 * that will be used as the component for this Intent.
6566 *
6567 * @return Returns the same Intent object, for chaining multiple calls
6568 * into a single statement.
6569 *
6570 * @see #setComponent
6571 * @see #setClass
6572 */
6573 public Intent setClassName(Context packageContext, String className) {
6574 mComponent = new ComponentName(packageContext, className);
6575 return this;
6576 }
6577
6578 /**
6579 * Convenience for calling {@link #setComponent} with an
6580 * explicit application package name and class name.
6581 *
6582 * @param packageName The name of the package implementing the desired
6583 * component.
6584 * @param className The name of a class inside of the application package
6585 * that will be used as the component for this Intent.
6586 *
6587 * @return Returns the same Intent object, for chaining multiple calls
6588 * into a single statement.
6589 *
6590 * @see #setComponent
6591 * @see #setClass
6592 */
6593 public Intent setClassName(String packageName, String className) {
6594 mComponent = new ComponentName(packageName, className);
6595 return this;
6596 }
6597
6598 /**
6599 * Convenience for calling {@link #setComponent(ComponentName)} with the
6600 * name returned by a {@link Class} object.
6601 *
6602 * @param packageContext A Context of the application package implementing
6603 * this class.
6604 * @param cls The class name to set, equivalent to
6605 * <code>setClassName(context, cls.getName())</code>.
6606 *
6607 * @return Returns the same Intent object, for chaining multiple calls
6608 * into a single statement.
6609 *
6610 * @see #setComponent
6611 */
6612 public Intent setClass(Context packageContext, Class<?> cls) {
6613 mComponent = new ComponentName(packageContext, cls);
6614 return this;
6615 }
6616
6617 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006618 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6619 * used as a hint to the receiver for animations and the like. Null means that there
6620 * is no source bounds.
6621 */
6622 public void setSourceBounds(Rect r) {
6623 if (r != null) {
6624 mSourceBounds = new Rect(r);
6625 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006626 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006627 }
6628 }
6629
Tor Norbyed9273d62013-05-30 15:59:53 -07006630 /** @hide */
6631 @IntDef(flag = true,
6632 value = {
6633 FILL_IN_ACTION,
6634 FILL_IN_DATA,
6635 FILL_IN_CATEGORIES,
6636 FILL_IN_COMPONENT,
6637 FILL_IN_PACKAGE,
6638 FILL_IN_SOURCE_BOUNDS,
6639 FILL_IN_SELECTOR,
6640 FILL_IN_CLIP_DATA
6641 })
6642 @Retention(RetentionPolicy.SOURCE)
6643 public @interface FillInFlags {}
6644
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006645 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006646 * Use with {@link #fillIn} to allow the current action value to be
6647 * overwritten, even if it is already set.
6648 */
6649 public static final int FILL_IN_ACTION = 1<<0;
6650
6651 /**
6652 * Use with {@link #fillIn} to allow the current data or type value
6653 * overwritten, even if it is already set.
6654 */
6655 public static final int FILL_IN_DATA = 1<<1;
6656
6657 /**
6658 * Use with {@link #fillIn} to allow the current categories to be
6659 * overwritten, even if they are already set.
6660 */
6661 public static final int FILL_IN_CATEGORIES = 1<<2;
6662
6663 /**
6664 * Use with {@link #fillIn} to allow the current component value to be
6665 * overwritten, even if it is already set.
6666 */
6667 public static final int FILL_IN_COMPONENT = 1<<3;
6668
6669 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006670 * Use with {@link #fillIn} to allow the current package value to be
6671 * overwritten, even if it is already set.
6672 */
6673 public static final int FILL_IN_PACKAGE = 1<<4;
6674
6675 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006676 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006677 * overwritten, even if it is already set.
6678 */
6679 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6680
6681 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006682 * Use with {@link #fillIn} to allow the current selector to be
6683 * overwritten, even if it is already set.
6684 */
6685 public static final int FILL_IN_SELECTOR = 1<<6;
6686
6687 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006688 * Use with {@link #fillIn} to allow the current ClipData to be
6689 * overwritten, even if it is already set.
6690 */
6691 public static final int FILL_IN_CLIP_DATA = 1<<7;
6692
6693 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006694 * Copy the contents of <var>other</var> in to this object, but only
6695 * where fields are not defined by this object. For purposes of a field
6696 * being defined, the following pieces of data in the Intent are
6697 * considered to be separate fields:
6698 *
6699 * <ul>
6700 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006701 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006702 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6703 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006704 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006705 * <li> component, as set by {@link #setComponent(ComponentName)} or
6706 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006707 * <li> source bounds, as set by {@link #setSourceBounds}.
6708 * <li> selector, as set by {@link #setSelector(Intent)}.
6709 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006710 * <li> each top-level name in the associated extras.
6711 * </ul>
6712 *
6713 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006714 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006715 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6716 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6717 * the restriction where the corresponding field will not be replaced if
6718 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006719 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006720 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6721 * is explicitly specified. The selector will only be copied if
6722 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006723 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006724 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6725 * and Intent B with {action="gotit", data-type="some/thing",
6726 * categories="one","two"}.
6727 *
6728 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6729 * containing: {action="gotit", data-type="some/thing",
6730 * categories="bar"}.
6731 *
6732 * @param other Another Intent whose values are to be used to fill in
6733 * the current one.
6734 * @param flags Options to control which fields can be filled in.
6735 *
6736 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006737 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006738 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6739 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6740 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006741 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006742 @FillInFlags
6743 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006744 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006745 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006746 if (other.mAction != null
6747 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006748 mAction = other.mAction;
6749 changes |= FILL_IN_ACTION;
6750 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006751 if ((other.mData != null || other.mType != null)
6752 && ((mData == null && mType == null)
6753 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 mData = other.mData;
6755 mType = other.mType;
6756 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006757 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006758 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006759 if (other.mCategories != null
6760 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006761 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006762 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006763 }
6764 changes |= FILL_IN_CATEGORIES;
6765 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006766 if (other.mPackage != null
6767 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006768 // Only do this if mSelector is not set.
6769 if (mSelector == null) {
6770 mPackage = other.mPackage;
6771 changes |= FILL_IN_PACKAGE;
6772 }
6773 }
6774 // Selector is special: it can only be set if explicitly allowed,
6775 // for the same reason as the component name.
6776 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6777 if (mPackage == null) {
6778 mSelector = new Intent(other.mSelector);
6779 mPackage = null;
6780 changes |= FILL_IN_SELECTOR;
6781 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006782 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006783 if (other.mClipData != null
6784 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6785 mClipData = other.mClipData;
6786 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006787 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006788 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006789 // Component is special: it can -only- be set if explicitly allowed,
6790 // since otherwise the sender could force the intent somewhere the
6791 // originator didn't intend.
6792 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006793 mComponent = other.mComponent;
6794 changes |= FILL_IN_COMPONENT;
6795 }
6796 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006797 if (other.mSourceBounds != null
6798 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6799 mSourceBounds = new Rect(other.mSourceBounds);
6800 changes |= FILL_IN_SOURCE_BOUNDS;
6801 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006802 if (mExtras == null) {
6803 if (other.mExtras != null) {
6804 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006805 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006806 }
6807 } else if (other.mExtras != null) {
6808 try {
6809 Bundle newb = new Bundle(other.mExtras);
6810 newb.putAll(mExtras);
6811 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006812 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006813 } catch (RuntimeException e) {
6814 // Modifying the extras can cause us to unparcel the contents
6815 // of the bundle, and if we do this in the system process that
6816 // may fail. We really should handle this (i.e., the Bundle
6817 // impl shouldn't be on top of a plain map), but for now just
6818 // ignore it and keep the original contents. :(
6819 Log.w("Intent", "Failure filling in extras", e);
6820 }
6821 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006822 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
6823 && other.mContentUserHint != UserHandle.USER_CURRENT) {
6824 mContentUserHint = other.mContentUserHint;
6825 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006826 return changes;
6827 }
6828
6829 /**
6830 * Wrapper class holding an Intent and implementing comparisons on it for
6831 * the purpose of filtering. The class implements its
6832 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6833 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6834 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6835 * on the wrapped Intent.
6836 */
6837 public static final class FilterComparison {
6838 private final Intent mIntent;
6839 private final int mHashCode;
6840
6841 public FilterComparison(Intent intent) {
6842 mIntent = intent;
6843 mHashCode = intent.filterHashCode();
6844 }
6845
6846 /**
6847 * Return the Intent that this FilterComparison represents.
6848 * @return Returns the Intent held by the FilterComparison. Do
6849 * not modify!
6850 */
6851 public Intent getIntent() {
6852 return mIntent;
6853 }
6854
6855 @Override
6856 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006857 if (obj instanceof FilterComparison) {
6858 Intent other = ((FilterComparison)obj).mIntent;
6859 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006860 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006861 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006862 }
6863
6864 @Override
6865 public int hashCode() {
6866 return mHashCode;
6867 }
6868 }
6869
6870 /**
6871 * Determine if two intents are the same for the purposes of intent
6872 * resolution (filtering). That is, if their action, data, type,
6873 * class, and categories are the same. This does <em>not</em> compare
6874 * any extra data included in the intents.
6875 *
6876 * @param other The other Intent to compare against.
6877 *
6878 * @return Returns true if action, data, type, class, and categories
6879 * are the same.
6880 */
6881 public boolean filterEquals(Intent other) {
6882 if (other == null) {
6883 return false;
6884 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006885 if (!Objects.equals(this.mAction, other.mAction)) return false;
6886 if (!Objects.equals(this.mData, other.mData)) return false;
6887 if (!Objects.equals(this.mType, other.mType)) return false;
6888 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6889 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6890 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006891
6892 return true;
6893 }
6894
6895 /**
6896 * Generate hash code that matches semantics of filterEquals().
6897 *
6898 * @return Returns the hash value of the action, data, type, class, and
6899 * categories.
6900 *
6901 * @see #filterEquals
6902 */
6903 public int filterHashCode() {
6904 int code = 0;
6905 if (mAction != null) {
6906 code += mAction.hashCode();
6907 }
6908 if (mData != null) {
6909 code += mData.hashCode();
6910 }
6911 if (mType != null) {
6912 code += mType.hashCode();
6913 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006914 if (mPackage != null) {
6915 code += mPackage.hashCode();
6916 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006917 if (mComponent != null) {
6918 code += mComponent.hashCode();
6919 }
6920 if (mCategories != null) {
6921 code += mCategories.hashCode();
6922 }
6923 return code;
6924 }
6925
6926 @Override
6927 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006928 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006929
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006930 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006931 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006932 b.append(" }");
6933
6934 return b.toString();
6935 }
6936
6937 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006938 public String toInsecureString() {
6939 StringBuilder b = new StringBuilder(128);
6940
6941 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006942 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006943 b.append(" }");
6944
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006945 return b.toString();
6946 }
Romain Guy4969af72009-06-17 10:53:19 -07006947
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006948 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006949 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006950 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006951
6952 b.append("Intent { ");
6953 toShortString(b, false, true, true, true);
6954 b.append(" }");
6955
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006956 return b.toString();
6957 }
6958
6959 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006960 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6961 StringBuilder b = new StringBuilder(128);
6962 toShortString(b, secure, comp, extras, clip);
6963 return b.toString();
6964 }
6965
6966 /** @hide */
6967 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6968 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006969 boolean first = true;
6970 if (mAction != null) {
6971 b.append("act=").append(mAction);
6972 first = false;
6973 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006974 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006975 if (!first) {
6976 b.append(' ');
6977 }
6978 first = false;
6979 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006980 for (int i=0; i<mCategories.size(); i++) {
6981 if (i > 0) b.append(',');
6982 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006983 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006984 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006985 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006986 if (mData != null) {
6987 if (!first) {
6988 b.append(' ');
6989 }
6990 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006991 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006992 if (secure) {
6993 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006994 } else {
6995 b.append(mData);
6996 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006997 }
6998 if (mType != null) {
6999 if (!first) {
7000 b.append(' ');
7001 }
7002 first = false;
7003 b.append("typ=").append(mType);
7004 }
7005 if (mFlags != 0) {
7006 if (!first) {
7007 b.append(' ');
7008 }
7009 first = false;
7010 b.append("flg=0x").append(Integer.toHexString(mFlags));
7011 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007012 if (mPackage != null) {
7013 if (!first) {
7014 b.append(' ');
7015 }
7016 first = false;
7017 b.append("pkg=").append(mPackage);
7018 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007019 if (comp && mComponent != null) {
7020 if (!first) {
7021 b.append(' ');
7022 }
7023 first = false;
7024 b.append("cmp=").append(mComponent.flattenToShortString());
7025 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007026 if (mSourceBounds != null) {
7027 if (!first) {
7028 b.append(' ');
7029 }
7030 first = false;
7031 b.append("bnds=").append(mSourceBounds.toShortString());
7032 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007033 if (mClipData != null) {
7034 if (!first) {
7035 b.append(' ');
7036 }
7037 first = false;
7038 if (clip) {
7039 b.append("clip={");
7040 mClipData.toShortString(b);
7041 b.append('}');
7042 } else {
7043 b.append("(has clip)");
7044 }
7045 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007046 if (extras && mExtras != null) {
7047 if (!first) {
7048 b.append(' ');
7049 }
7050 first = false;
7051 b.append("(has extras)");
7052 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007053 if (mContentUserHint != UserHandle.USER_CURRENT) {
7054 if (!first) {
7055 b.append(' ');
7056 }
7057 first = false;
7058 b.append("u=").append(mContentUserHint);
7059 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007060 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007061 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007062 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007063 b.append("}");
7064 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007065 }
7066
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007067 /**
7068 * Call {@link #toUri} with 0 flags.
7069 * @deprecated Use {@link #toUri} instead.
7070 */
7071 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007072 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007073 return toUri(0);
7074 }
7075
7076 /**
7077 * Convert this Intent into a String holding a URI representation of it.
7078 * The returned URI string has been properly URI encoded, so it can be
7079 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7080 * Intent's data as the base URI, with an additional fragment describing
7081 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007082 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007083 * <p>You can convert the returned string back to an Intent with
7084 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007085 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007086 * @param flags Additional operating flags. Either 0 or
7087 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007088 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007089 * @return Returns a URI encoding URI string describing the entire contents
7090 * of the Intent.
7091 */
7092 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007093 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007094 String scheme = null;
7095 if (mData != null) {
7096 String data = mData.toString();
7097 if ((flags&URI_INTENT_SCHEME) != 0) {
7098 final int N = data.length();
7099 for (int i=0; i<N; i++) {
7100 char c = data.charAt(i);
7101 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7102 || c == '.' || c == '-') {
7103 continue;
7104 }
7105 if (c == ':' && i > 0) {
7106 // Valid scheme.
7107 scheme = data.substring(0, i);
7108 uri.append("intent:");
7109 data = data.substring(i+1);
7110 break;
7111 }
Tom Taylord4a47292009-12-21 13:59:18 -08007112
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007113 // No scheme.
7114 break;
7115 }
7116 }
7117 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007118
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007119 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7120 uri.append("intent:");
7121 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007122
7123 uri.append("#Intent;");
7124
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007125 toUriInner(uri, scheme, flags);
7126 if (mSelector != null) {
7127 uri.append("SEL;");
7128 // Note that for now we are not going to try to handle the
7129 // data part; not clear how to represent this as a URI, and
7130 // not much utility in it.
7131 mSelector.toUriInner(uri, null, flags);
7132 }
7133
7134 uri.append("end");
7135
7136 return uri.toString();
7137 }
7138
7139 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007140 if (scheme != null) {
7141 uri.append("scheme=").append(scheme).append(';');
7142 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007143 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007144 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007145 }
7146 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007147 for (int i=0; i<mCategories.size(); i++) {
7148 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007149 }
7150 }
7151 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007152 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007153 }
7154 if (mFlags != 0) {
7155 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7156 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007157 if (mPackage != null) {
7158 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7159 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007160 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007161 uri.append("component=").append(Uri.encode(
7162 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007163 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007164 if (mSourceBounds != null) {
7165 uri.append("sourceBounds=")
7166 .append(Uri.encode(mSourceBounds.flattenToString()))
7167 .append(';');
7168 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007169 if (mExtras != null) {
7170 for (String key : mExtras.keySet()) {
7171 final Object value = mExtras.get(key);
7172 char entryType =
7173 value instanceof String ? 'S' :
7174 value instanceof Boolean ? 'B' :
7175 value instanceof Byte ? 'b' :
7176 value instanceof Character ? 'c' :
7177 value instanceof Double ? 'd' :
7178 value instanceof Float ? 'f' :
7179 value instanceof Integer ? 'i' :
7180 value instanceof Long ? 'l' :
7181 value instanceof Short ? 's' :
7182 '\0';
7183
7184 if (entryType != '\0') {
7185 uri.append(entryType);
7186 uri.append('.');
7187 uri.append(Uri.encode(key));
7188 uri.append('=');
7189 uri.append(Uri.encode(value.toString()));
7190 uri.append(';');
7191 }
7192 }
7193 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007194 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007195
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007196 public int describeContents() {
7197 return (mExtras != null) ? mExtras.describeContents() : 0;
7198 }
7199
7200 public void writeToParcel(Parcel out, int flags) {
7201 out.writeString(mAction);
7202 Uri.writeToParcel(out, mData);
7203 out.writeString(mType);
7204 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007205 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007206 ComponentName.writeToParcel(mComponent, out);
7207
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007208 if (mSourceBounds != null) {
7209 out.writeInt(1);
7210 mSourceBounds.writeToParcel(out, flags);
7211 } else {
7212 out.writeInt(0);
7213 }
7214
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007215 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007216 final int N = mCategories.size();
7217 out.writeInt(N);
7218 for (int i=0; i<N; i++) {
7219 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007220 }
7221 } else {
7222 out.writeInt(0);
7223 }
7224
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007225 if (mSelector != null) {
7226 out.writeInt(1);
7227 mSelector.writeToParcel(out, flags);
7228 } else {
7229 out.writeInt(0);
7230 }
7231
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007232 if (mClipData != null) {
7233 out.writeInt(1);
7234 mClipData.writeToParcel(out, flags);
7235 } else {
7236 out.writeInt(0);
7237 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007238 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007239 out.writeBundle(mExtras);
7240 }
7241
7242 public static final Parcelable.Creator<Intent> CREATOR
7243 = new Parcelable.Creator<Intent>() {
7244 public Intent createFromParcel(Parcel in) {
7245 return new Intent(in);
7246 }
7247 public Intent[] newArray(int size) {
7248 return new Intent[size];
7249 }
7250 };
7251
Dianne Hackborneb034652009-09-07 00:49:58 -07007252 /** @hide */
7253 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007254 readFromParcel(in);
7255 }
7256
7257 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007258 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007259 mData = Uri.CREATOR.createFromParcel(in);
7260 mType = in.readString();
7261 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007262 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007263 mComponent = ComponentName.readFromParcel(in);
7264
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007265 if (in.readInt() != 0) {
7266 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7267 }
7268
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007269 int N = in.readInt();
7270 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007271 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007272 int i;
7273 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007274 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007275 }
7276 } else {
7277 mCategories = null;
7278 }
7279
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007280 if (in.readInt() != 0) {
7281 mSelector = new Intent(in);
7282 }
7283
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007284 if (in.readInt() != 0) {
7285 mClipData = new ClipData(in);
7286 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007287 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007288 mExtras = in.readBundle();
7289 }
7290
7291 /**
7292 * Parses the "intent" element (and its children) from XML and instantiates
7293 * an Intent object. The given XML parser should be located at the tag
7294 * where parsing should start (often named "intent"), from which the
7295 * basic action, data, type, and package and class name will be
7296 * retrieved. The function will then parse in to any child elements,
7297 * looking for <category android:name="xxx"> tags to add categories and
7298 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7299 * to the intent.
7300 *
7301 * @param resources The Resources to use when inflating resources.
7302 * @param parser The XML parser pointing at an "intent" tag.
7303 * @param attrs The AttributeSet interface for retrieving extended
7304 * attribute data at the current <var>parser</var> location.
7305 * @return An Intent object matching the XML data.
7306 * @throws XmlPullParserException If there was an XML parsing error.
7307 * @throws IOException If there was an I/O error.
7308 */
7309 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7310 throws XmlPullParserException, IOException {
7311 Intent intent = new Intent();
7312
7313 TypedArray sa = resources.obtainAttributes(attrs,
7314 com.android.internal.R.styleable.Intent);
7315
7316 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7317
7318 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7319 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7320 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7321
7322 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7323 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7324 if (packageName != null && className != null) {
7325 intent.setComponent(new ComponentName(packageName, className));
7326 }
7327
7328 sa.recycle();
7329
7330 int outerDepth = parser.getDepth();
7331 int type;
7332 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7333 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7334 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7335 continue;
7336 }
7337
7338 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007339 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007340 sa = resources.obtainAttributes(attrs,
7341 com.android.internal.R.styleable.IntentCategory);
7342 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7343 sa.recycle();
7344
7345 if (cat != null) {
7346 intent.addCategory(cat);
7347 }
7348 XmlUtils.skipCurrentTag(parser);
7349
Craig Mautner21d24a22014-04-23 11:45:37 -07007350 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007351 if (intent.mExtras == null) {
7352 intent.mExtras = new Bundle();
7353 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007354 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007355 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007356
7357 } else {
7358 XmlUtils.skipCurrentTag(parser);
7359 }
7360 }
7361
7362 return intent;
7363 }
Nick Pellyccae4122012-01-09 14:12:58 -08007364
Craig Mautner21d24a22014-04-23 11:45:37 -07007365 /** @hide */
7366 public void saveToXml(XmlSerializer out) throws IOException {
7367 if (mAction != null) {
7368 out.attribute(null, ATTR_ACTION, mAction);
7369 }
7370 if (mData != null) {
7371 out.attribute(null, ATTR_DATA, mData.toString());
7372 }
7373 if (mType != null) {
7374 out.attribute(null, ATTR_TYPE, mType);
7375 }
7376 if (mComponent != null) {
7377 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7378 }
7379 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7380
7381 if (mCategories != null) {
7382 out.startTag(null, TAG_CATEGORIES);
7383 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7384 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7385 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007386 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007387 }
7388 }
7389
7390 /** @hide */
7391 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7392 XmlPullParserException {
7393 Intent intent = new Intent();
7394 final int outerDepth = in.getDepth();
7395
7396 int attrCount = in.getAttributeCount();
7397 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7398 final String attrName = in.getAttributeName(attrNdx);
7399 final String attrValue = in.getAttributeValue(attrNdx);
7400 if (ATTR_ACTION.equals(attrName)) {
7401 intent.setAction(attrValue);
7402 } else if (ATTR_DATA.equals(attrName)) {
7403 intent.setData(Uri.parse(attrValue));
7404 } else if (ATTR_TYPE.equals(attrName)) {
7405 intent.setType(attrValue);
7406 } else if (ATTR_COMPONENT.equals(attrName)) {
7407 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7408 } else if (ATTR_FLAGS.equals(attrName)) {
7409 intent.setFlags(Integer.valueOf(attrValue, 16));
7410 } else {
7411 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7412 }
7413 }
7414
7415 int event;
7416 String name;
7417 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7418 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7419 if (event == XmlPullParser.START_TAG) {
7420 name = in.getName();
7421 if (TAG_CATEGORIES.equals(name)) {
7422 attrCount = in.getAttributeCount();
7423 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7424 intent.addCategory(in.getAttributeValue(attrNdx));
7425 }
7426 } else {
7427 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7428 XmlUtils.skipCurrentTag(in);
7429 }
7430 }
7431 }
7432
7433 return intent;
7434 }
7435
Nick Pellyccae4122012-01-09 14:12:58 -08007436 /**
7437 * Normalize a MIME data type.
7438 *
7439 * <p>A normalized MIME type has white-space trimmed,
7440 * content-type parameters removed, and is lower-case.
7441 * This aligns the type with Android best practices for
7442 * intent filtering.
7443 *
7444 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7445 * "text/x-vCard" becomes "text/x-vcard".
7446 *
7447 * <p>All MIME types received from outside Android (such as user input,
7448 * or external sources like Bluetooth, NFC, or the Internet) should
7449 * be normalized before they are used to create an Intent.
7450 *
7451 * @param type MIME data type to normalize
7452 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007453 * @see #setType
7454 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007455 */
7456 public static String normalizeMimeType(String type) {
7457 if (type == null) {
7458 return null;
7459 }
7460
Elliott Hughescb64d432013-08-02 10:00:44 -07007461 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007462
7463 final int semicolonIndex = type.indexOf(';');
7464 if (semicolonIndex != -1) {
7465 type = type.substring(0, semicolonIndex);
7466 }
7467 return type;
7468 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007469
7470 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007471 * Prepare this {@link Intent} to leave an app process.
7472 *
7473 * @hide
7474 */
7475 public void prepareToLeaveProcess() {
7476 setAllowFds(false);
7477
7478 if (mSelector != null) {
7479 mSelector.prepareToLeaveProcess();
7480 }
7481 if (mClipData != null) {
7482 mClipData.prepareToLeaveProcess();
7483 }
7484
7485 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7486 // There are several ACTION_MEDIA_* broadcasts that send file://
7487 // Uris, so only check common actions.
7488 if (ACTION_VIEW.equals(mAction) ||
7489 ACTION_EDIT.equals(mAction) ||
7490 ACTION_ATTACH_DATA.equals(mAction)) {
7491 mData.checkFileUriExposed("Intent.getData()");
7492 }
7493 }
7494 }
7495
7496 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007497 * @hide
7498 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007499 public void prepareToEnterProcess() {
7500 if (mContentUserHint != UserHandle.USER_CURRENT) {
7501 fixUris(mContentUserHint);
7502 mContentUserHint = UserHandle.USER_CURRENT;
7503 }
7504 }
7505
7506 /**
7507 * @hide
7508 */
7509 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007510 Uri data = getData();
7511 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007512 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007513 }
7514 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007515 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007516 }
7517 String action = getAction();
7518 if (ACTION_SEND.equals(action)) {
7519 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7520 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007521 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007522 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007523 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007524 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7525 if (streams != null) {
7526 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7527 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007528 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007529 }
7530 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7531 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007532 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7533 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7534 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7535 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7536 if (output != null) {
7537 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7538 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007539 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007540 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007541
7542 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007543 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007544 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7545 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007546 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007547 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007548 * @hide
7549 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007550 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007551 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007552 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007553
7554 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007555 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007556
7557 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007558 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007559 // Inspect contained intents to see if we need to migrate extras. We
7560 // don't promote ClipData to the parent, since ChooserActivity will
7561 // already start the picked item as the caller, and we can't combine
7562 // the flags in a safe way.
7563
7564 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07007565 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007566 final Intent intent = getParcelableExtra(EXTRA_INTENT);
7567 if (intent != null) {
7568 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07007569 }
7570 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007571 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007572 try {
7573 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
7574 if (intents != null) {
7575 for (int i = 0; i < intents.length; i++) {
7576 final Intent intent = (Intent) intents[i];
7577 if (intent != null) {
7578 migrated |= intent.migrateExtraStreamToClipData();
7579 }
7580 }
7581 }
7582 } catch (ClassCastException e) {
7583 }
7584 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007585
7586 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007587 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007588 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7589 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7590 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7591 if (stream != null || text != null || htmlText != null) {
7592 final ClipData clipData = new ClipData(
7593 null, new String[] { getType() },
7594 new ClipData.Item(text, htmlText, null, stream));
7595 setClipData(clipData);
7596 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007597 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007598 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007599 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007600 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007601
7602 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007603 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007604 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7605 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7606 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7607 int num = -1;
7608 if (streams != null) {
7609 num = streams.size();
7610 }
7611 if (texts != null) {
7612 if (num >= 0 && num != texts.size()) {
7613 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007614 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007615 }
7616 num = texts.size();
7617 }
7618 if (htmlTexts != null) {
7619 if (num >= 0 && num != htmlTexts.size()) {
7620 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007621 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007622 }
7623 num = htmlTexts.size();
7624 }
7625 if (num > 0) {
7626 final ClipData clipData = new ClipData(
7627 null, new String[] { getType() },
7628 makeClipItem(streams, texts, htmlTexts, 0));
7629
7630 for (int i = 1; i < num; i++) {
7631 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7632 }
7633
7634 setClipData(clipData);
7635 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007636 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007637 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007638 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007639 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007640 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7641 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7642 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7643 final Uri output;
7644 try {
7645 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7646 } catch (ClassCastException e) {
7647 return false;
7648 }
7649 if (output != null) {
7650 setClipData(ClipData.newRawUri("", output));
7651 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7652 return true;
7653 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007654 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007655
7656 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007657 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007658
7659 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7660 ArrayList<String> htmlTexts, int which) {
7661 Uri uri = streams != null ? streams.get(which) : null;
7662 CharSequence text = texts != null ? texts.get(which) : null;
7663 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7664 return new ClipData.Item(text, htmlText, null, uri);
7665 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007666
7667 /** @hide */
7668 public boolean isDocument() {
7669 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7670 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007671}