blob: 61e105b7a24e7f37b2f5fe5347bbf222b5224b22 [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) {
879 Intent intent = new Intent(ACTION_CHOOSER);
880 intent.putExtra(EXTRA_INTENT, target);
881 if (title != null) {
882 intent.putExtra(EXTRA_TITLE, title);
883 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700884
885 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700886 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
887 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
888 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700889 if (permFlags != 0) {
890 ClipData targetClipData = target.getClipData();
891 if (targetClipData == null && target.getData() != null) {
892 ClipData.Item item = new ClipData.Item(target.getData());
893 String[] mimeTypes;
894 if (target.getType() != null) {
895 mimeTypes = new String[] { target.getType() };
896 } else {
897 mimeTypes = new String[] { };
898 }
899 targetClipData = new ClipData(null, mimeTypes, item);
900 }
901 if (targetClipData != null) {
902 intent.setClipData(targetClipData);
903 intent.addFlags(permFlags);
904 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700905 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700906
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700907 return intent;
908 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700909
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 /**
911 * Activity Action: Allow the user to select a particular kind of data and
912 * return it. This is different than {@link #ACTION_PICK} in that here we
913 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800914 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700915 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900916 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700917 * etc.
918 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900919 * 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 -0700920 * of data, such as a person contact, you set the MIME type to the kind of
921 * data you want and launch it with {@link Context#startActivity(Intent)}.
922 * The system will then launch the best application to select that kind
923 * of data for you.
924 * <p>
925 * You may also be interested in any of a set of types of content the user
926 * can pick. For example, an e-mail application that wants to allow the
927 * user to add an attachment to an e-mail message can use this action to
928 * bring up a list of all of the types of content the user can attach.
929 * <p>
930 * In this case, you should wrap the GET_CONTENT intent with a chooser
931 * (through {@link #createChooser}), which will give the proper interface
932 * for the user to pick how to send your data and allow you to specify
933 * a prompt indicating what they are doing. You will usually specify a
934 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
935 * broad range of content types the user can select from.
936 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900937 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700938 * only pick from data that can be represented as a stream. This is
939 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
940 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800941 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900942 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800943 * is locally available on the device. For example, if this extra is set
944 * to true then an image picker should not show any pictures that are available
945 * from a remote server but not already on the local device (thus requiring
946 * they be downloaded when opened).
947 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800948 * If the caller can handle multiple returned items (the user performing
949 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
950 * to indicate this.
951 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700952 * Input: {@link #getType} is the desired MIME type to retrieve. Note
953 * that no URI is supplied in the intent, as there are no constraints on
954 * where the returned data originally comes from. You may also include the
955 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800956 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800957 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
958 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700959 * <p>
960 * Output: The URI of the item that was picked. This must be a content:
961 * URI so that any receiver can access it.
962 */
963 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
964 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
965 /**
966 * Activity Action: Dial a number as specified by the data. This shows a
967 * UI with the number being dialed, allowing the user to explicitly
968 * initiate the call.
969 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
970 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
971 * number.
972 * <p>Output: nothing.
973 */
974 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
975 public static final String ACTION_DIAL = "android.intent.action.DIAL";
976 /**
977 * Activity Action: Perform a call to someone specified by the data.
978 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
979 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
980 * number.
981 * <p>Output: nothing.
982 *
983 * <p>Note: there will be restrictions on which applications can initiate a
984 * call; most applications should use the {@link #ACTION_DIAL}.
985 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
986 * numbers. Applications can <strong>dial</strong> emergency numbers using
987 * {@link #ACTION_DIAL}, however.
988 */
989 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
990 public static final String ACTION_CALL = "android.intent.action.CALL";
991 /**
992 * Activity Action: Perform a call to an emergency number specified by the
993 * data.
994 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
995 * tel: URI of an explicit phone number.
996 * <p>Output: nothing.
997 * @hide
998 */
999 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1000 /**
1001 * Activity action: Perform a call to any number (emergency or not)
1002 * specified by the data.
1003 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1004 * tel: URI of an explicit phone number.
1005 * <p>Output: nothing.
1006 * @hide
1007 */
1008 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1009 /**
1010 * Activity Action: Send a message to someone specified by the data.
1011 * <p>Input: {@link #getData} is URI describing the target.
1012 * <p>Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1016 /**
1017 * Activity Action: Deliver some data to someone else. Who the data is
1018 * being delivered to is not specified; it is up to the receiver of this
1019 * action to ask the user where the data should be sent.
1020 * <p>
1021 * When launching a SEND intent, you should usually wrap it in a chooser
1022 * (through {@link #createChooser}), which will give the proper interface
1023 * for the user to pick how to send your data and allow you to specify
1024 * a prompt indicating what they are doing.
1025 * <p>
1026 * Input: {@link #getType} is the MIME type of the data being sent.
1027 * get*Extra can have either a {@link #EXTRA_TEXT}
1028 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1029 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1030 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1031 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001032 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1033 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1034 * your text with HTML formatting.
1035 * <p>
1036 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1037 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1038 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1039 * content: URIs and other advanced features of {@link ClipData}. If
1040 * using this approach, you still must supply the same data through the
1041 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1042 * for compatibility with old applications. If you don't set a ClipData,
1043 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001044 * <p>
1045 * Optional standard extras, which may be interpreted by some recipients as
1046 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1047 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1048 * <p>
1049 * Output: nothing.
1050 */
1051 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1052 public static final String ACTION_SEND = "android.intent.action.SEND";
1053 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001054 * Activity Action: Deliver multiple data to someone else.
1055 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001056 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001057 * <p>
1058 * Input: {@link #getType} is the MIME type of the data being sent.
1059 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001060 * #EXTRA_STREAM} field, containing the data to be sent. If using
1061 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1062 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001063 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001064 * Multiple types are supported, and receivers should handle mixed types
1065 * whenever possible. The right way for the receiver to check them is to
1066 * use the content resolver on each URI. The intent sender should try to
1067 * put the most concrete mime type in the intent type, but it can fall
1068 * back to {@literal <type>/*} or {@literal *}/* as needed.
1069 * <p>
1070 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1071 * be image/jpg, but if you are sending image/jpg and image/png, then the
1072 * intent's type should be image/*.
1073 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001074 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1075 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1076 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1077 * content: URIs and other advanced features of {@link ClipData}. If
1078 * using this approach, you still must supply the same data through the
1079 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1080 * for compatibility with old applications. If you don't set a ClipData,
1081 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1082 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001083 * Optional standard extras, which may be interpreted by some recipients as
1084 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1085 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1086 * <p>
1087 * Output: nothing.
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1091 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001092 * Activity Action: Handle an incoming phone call.
1093 * <p>Input: nothing.
1094 * <p>Output: nothing.
1095 */
1096 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1097 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1098 /**
1099 * Activity Action: Insert an empty item into the given container.
1100 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1101 * in which to place the data.
1102 * <p>Output: URI of the new data that was created.
1103 */
1104 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1105 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1106 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001107 * Activity Action: Create a new item in the given container, initializing it
1108 * from the current contents of the clipboard.
1109 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1110 * in which to place the data.
1111 * <p>Output: URI of the new data that was created.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1115 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001116 * Activity Action: Delete the given data from its container.
1117 * <p>Input: {@link #getData} is URI of data to be deleted.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1122 /**
1123 * Activity Action: Run the data, whatever that means.
1124 * <p>Input: ? (Note: this is currently specific to the test harness.)
1125 * <p>Output: nothing.
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_RUN = "android.intent.action.RUN";
1129 /**
1130 * Activity Action: Perform a data synchronization.
1131 * <p>Input: ?
1132 * <p>Output: ?
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1136 /**
1137 * Activity Action: Pick an activity given an intent, returning the class
1138 * selected.
1139 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1140 * used with {@link PackageManager#queryIntentActivities} to determine the
1141 * set of activities from which to pick.
1142 * <p>Output: Class name of the activity that was selected.
1143 */
1144 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1145 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1146 /**
1147 * Activity Action: Perform a search.
1148 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1149 * is the text to search for. If empty, simply
1150 * enter your search results Activity with the search UI activated.
1151 * <p>Output: nothing.
1152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1155 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001156 * Activity Action: Start the platform-defined tutorial
1157 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1158 * is the text to search for. If empty, simply
1159 * enter your search results Activity with the search UI activated.
1160 * <p>Output: nothing.
1161 */
1162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1163 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1164 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001165 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001166 * <p>
1167 * Input: {@link android.app.SearchManager#QUERY
1168 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1169 * a url starts with http or https, the site will be opened. If it is plain
1170 * text, Google search will be applied.
1171 * <p>
1172 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001176
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 /**
Jim Miller07994402012-05-02 14:22:27 -07001178 * Activity Action: Perform assist action.
1179 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001180 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1181 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001182 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001183 * Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001187
1188 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001189 * Activity Action: Perform voice assist action.
1190 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001191 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1192 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001193 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001194 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001195 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1199
1200 /**
Adam Skory7140a252013-09-11 12:04:58 +01001201 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1202 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001203 */
1204 public static final String EXTRA_ASSIST_PACKAGE
1205 = "android.intent.extra.ASSIST_PACKAGE";
1206
1207 /**
Adam Skory7140a252013-09-11 12:04:58 +01001208 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1209 * information supplied by the current foreground app at the time of the assist request.
1210 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001211 */
1212 public static final String EXTRA_ASSIST_CONTEXT
1213 = "android.intent.extra.ASSIST_CONTEXT";
1214
Jim Miller07994402012-05-02 14:22:27 -07001215 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001216 * Activity Action: List all available applications
1217 * <p>Input: Nothing.
1218 * <p>Output: nothing.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1222 /**
1223 * Activity Action: Show settings for choosing wallpaper
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1229
1230 /**
1231 * Activity Action: Show activity for reporting a bug.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1237
1238 /**
1239 * Activity Action: Main entry point for factory tests. Only used when
1240 * the device is booting in factory test node. The implementing package
1241 * must be installed in the system image.
1242 * <p>Input: nothing
1243 * <p>Output: nothing
1244 */
1245 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1246
1247 /**
1248 * Activity Action: The user pressed the "call" button to go to the dialer
1249 * or other appropriate UI for placing a call.
1250 * <p>Input: Nothing.
1251 * <p>Output: Nothing.
1252 */
1253 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1254 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1255
1256 /**
1257 * Activity Action: Start Voice Command.
1258 * <p>Input: Nothing.
1259 * <p>Output: Nothing.
1260 */
1261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1262 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001263
1264 /**
1265 * Activity Action: Start action associated with long pressing on the
1266 * search key.
1267 * <p>Input: Nothing.
1268 * <p>Output: Nothing.
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001272
Jacek Surazski86b6c532009-05-13 14:38:28 +02001273 /**
1274 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1275 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001276 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001277 * <p>Input: No data is specified. The bug report is passed in using
1278 * an {@link #EXTRA_BUG_REPORT} field.
1279 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001280 *
1281 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001282 */
1283 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1284 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001285
1286 /**
1287 * Activity Action: Show power usage information to the user.
1288 * <p>Input: Nothing.
1289 * <p>Output: Nothing.
1290 */
1291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1292 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001293
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001294 /**
1295 * Activity Action: Setup wizard to launch after a platform update. This
1296 * activity should have a string meta-data field associated with it,
1297 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1298 * the platform for setup. The activity will be launched only if
1299 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1300 * same value.
1301 * <p>Input: Nothing.
1302 * <p>Output: Nothing.
1303 * @hide
1304 */
1305 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1306 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001307
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001308 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001309 * Activity Action: Show settings for managing network data usage of a
1310 * specific application. Applications should define an activity that offers
1311 * options to control data usage.
1312 */
1313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1314 public static final String ACTION_MANAGE_NETWORK_USAGE =
1315 "android.intent.action.MANAGE_NETWORK_USAGE";
1316
1317 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001318 * Activity Action: Launch application installer.
1319 * <p>
1320 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001321 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1322 * you can also use "package:<package-name>" to install an application for the
1323 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001324 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1325 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1326 * <p>
1327 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1328 * succeeded.
1329 *
1330 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1331 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1332 * @see #EXTRA_RETURN_RESULT
1333 */
1334 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1335 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1336
1337 /**
1338 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1339 * package. Specifies the installer package name; this package will receive the
1340 * {@link #ACTION_APP_ERROR} intent.
1341 */
1342 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1343 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1344
1345 /**
1346 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1347 * package. Specifies that the application being installed should not be
1348 * treated as coming from an unknown source, but as coming from the app
1349 * invoking the Intent. For this to work you must start the installer with
1350 * startActivityForResult().
1351 */
1352 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1353 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1354
1355 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001356 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1357 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001358 * data field originated from.
1359 */
rich cannings706e8ba2012-08-20 13:20:14 -07001360 public static final String EXTRA_ORIGINATING_URI
1361 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001362
1363 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001364 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1365 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1366 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001367 */
1368 public static final String EXTRA_REFERRER
1369 = "android.intent.extra.REFERRER";
1370
1371 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001372 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1373 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1374 * @hide
1375 */
1376 public static final String EXTRA_ORIGINATING_UID
1377 = "android.intent.extra.ORIGINATING_UID";
1378
1379 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001380 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1381 * package. Tells the installer UI to skip the confirmation with the user
1382 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001383 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1384 * will no longer show an interstitial message about updating existing
1385 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001386 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001387 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001388 public static final String EXTRA_ALLOW_REPLACE
1389 = "android.intent.extra.ALLOW_REPLACE";
1390
1391 /**
1392 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1393 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1394 * return to the application the result code of the install/uninstall. The returned result
1395 * code will be {@link android.app.Activity#RESULT_OK} on success or
1396 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1397 */
1398 public static final String EXTRA_RETURN_RESULT
1399 = "android.intent.extra.RETURN_RESULT";
1400
1401 /**
1402 * Package manager install result code. @hide because result codes are not
1403 * yet ready to be exposed.
1404 */
1405 public static final String EXTRA_INSTALL_RESULT
1406 = "android.intent.extra.INSTALL_RESULT";
1407
1408 /**
1409 * Activity Action: Launch application uninstaller.
1410 * <p>
1411 * Input: The data must be a package: URI whose scheme specific part is
1412 * the package name of the current installed package to be uninstalled.
1413 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1414 * <p>
1415 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1416 * succeeded.
1417 */
1418 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1419 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1420
1421 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001422 * Specify whether the package should be uninstalled for all users.
1423 * @hide because these should not be part of normal application flow.
1424 */
1425 public static final String EXTRA_UNINSTALL_ALL_USERS
1426 = "android.intent.extra.UNINSTALL_ALL_USERS";
1427
1428 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001429 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1430 * describing the last run version of the platform that was setup.
1431 * @hide
1432 */
1433 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1434
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 // ---------------------------------------------------------------------
1436 // ---------------------------------------------------------------------
1437 // Standard intent broadcast actions (see action variable).
1438
1439 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001440 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1441 * <p>
1442 * For historical reasons, the name of this broadcast action refers to the power
1443 * state of the screen but it is actually sent in response to changes in the
1444 * overall interactive state of the device.
1445 * </p><p>
1446 * This broadcast is sent when the device becomes non-interactive which may have
1447 * nothing to do with the screen turning off. To determine the
1448 * actual state of the screen, use {@link android.view.Display#getState}.
1449 * </p><p>
1450 * See {@link android.os.PowerManager#isInteractive} for details.
1451 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001452 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 * <p class="note">This is a protected intent that can only be sent
1454 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1457 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001459 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001460 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1461 * <p>
1462 * For historical reasons, the name of this broadcast action refers to the power
1463 * state of the screen but it is actually sent in response to changes in the
1464 * overall interactive state of the device.
1465 * </p><p>
1466 * This broadcast is sent when the device becomes interactive which may have
1467 * nothing to do with the screen turning on. To determine the
1468 * actual state of the screen, use {@link android.view.Display#getState}.
1469 * </p><p>
1470 * See {@link android.os.PowerManager#isInteractive} for details.
1471 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001472 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001473 * <p class="note">This is a protected intent that can only be sent
1474 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001475 */
1476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1477 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001478
1479 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001480 * Broadcast Action: Sent after the system stops dreaming.
1481 *
1482 * <p class="note">This is a protected intent that can only be sent by the system.
1483 * It is only sent to registered receivers.</p>
1484 */
1485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1486 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1487
1488 /**
1489 * Broadcast Action: Sent after the system starts dreaming.
1490 *
1491 * <p class="note">This is a protected intent that can only be sent by the system.
1492 * It is only sent to registered receivers.</p>
1493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1496
1497 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001498 * 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 -07001499 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001500 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001501 * <p class="note">This is a protected intent that can only be sent
1502 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001505 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001506
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001507 /**
1508 * Broadcast Action: The current time has changed. Sent every
1509 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001510 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001511 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1512 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001513 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001514 * <p class="note">This is a protected intent that can only be sent
1515 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001516 */
1517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1518 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1519 /**
1520 * Broadcast Action: The time was set.
1521 */
1522 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1523 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1524 /**
1525 * Broadcast Action: The date has changed.
1526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1529 /**
1530 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1531 * <ul>
1532 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1533 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001534 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1540 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001541 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1542 * DNS entries should be tossed.
1543 * @hide
1544 */
1545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1546 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1547 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001548 * Alarm Changed Action: This is broadcast when the AlarmClock
1549 * application's alarm is set or unset. It is used by the
1550 * AlarmClock application and the StatusBar service.
1551 * @hide
1552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1555 /**
1556 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1557 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1558 * @hide
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_SYNC_STATE_CHANGED
1562 = "android.intent.action.SYNC_STATE_CHANGED";
1563 /**
1564 * Broadcast Action: This is broadcast once, after the system has finished
1565 * booting. It can be used to perform application-specific initialization,
1566 * such as installing alarms. You must hold the
1567 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1568 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1575 /**
1576 * Broadcast Action: This is broadcast when a user action should request a
1577 * temporary system dialog to dismiss. Some examples of temporary system
1578 * dialogs are the notification window-shade and the recent tasks dialog.
1579 */
1580 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1581 /**
1582 * Broadcast Action: Trigger the download and eventual installation
1583 * of a package.
1584 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001585 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001586 * <p class="note">This is a protected intent that can only be sent
1587 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001588 *
1589 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001590 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001591 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1593 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1594 /**
1595 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001596 * device. The data contains the name of the package. Note that the
1597 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001598 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001599 * <ul>
1600 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1601 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1602 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1603 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001604 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1609 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1610 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001611 * Broadcast Action: A new version of an application package has been
1612 * installed, replacing an existing version that was previously installed.
1613 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001614 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001615 * <ul>
1616 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1617 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001618 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001619 * <p class="note">This is a protected intent that can only be sent
1620 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001621 */
1622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1623 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1624 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001625 * Broadcast Action: A new version of your application has been installed
1626 * over an existing one. This is only sent to the application that was
1627 * replaced. It does not contain any additional data; to receive it, just
1628 * use an intent filter for this action.
1629 *
1630 * <p class="note">This is a protected intent that can only be sent
1631 * by the system.
1632 */
1633 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1634 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 * Broadcast Action: An existing application package has been removed from
1637 * the device. The data contains the name of the package. The package
1638 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001639 * <ul>
1640 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1641 * to the package.
1642 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1643 * application -- data and code -- is being removed.
1644 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1645 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1646 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001647 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001648 * <p class="note">This is a protected intent that can only be sent
1649 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1653 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001654 * Broadcast Action: An existing application package has been completely
1655 * removed from the device. The data contains the name of the package.
1656 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1657 * {@link #EXTRA_DATA_REMOVED} is true and
1658 * {@link #EXTRA_REPLACING} is false of that broadcast.
1659 *
1660 * <ul>
1661 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1662 * to the package.
1663 * </ul>
1664 *
1665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
1667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_FULLY_REMOVED
1670 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1671 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001672 * Broadcast Action: An existing application package has been changed (e.g.
1673 * a component has been enabled or disabled). The data contains the name of
1674 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001675 * <ul>
1676 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001677 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001678 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001679 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1680 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001681 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001682 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001683 * <p class="note">This is a protected intent that can only be sent
1684 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001685 */
1686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1687 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1688 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001689 * @hide
1690 * Broadcast Action: Ask system services if there is any reason to
1691 * restart the given package. The data contains the name of the
1692 * package.
1693 * <ul>
1694 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1695 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1696 * </ul>
1697 *
1698 * <p class="note">This is a protected intent that can only be sent
1699 * by the system.
1700 */
1701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1702 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1703 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001704 * Broadcast Action: The user has restarted a package, and all of its
1705 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001706 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001707 * be removed. Note that the restarted package does <em>not</em>
1708 * receive this broadcast.
1709 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001710 * <ul>
1711 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1712 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001713 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001714 * <p class="note">This is a protected intent that can only be sent
1715 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001716 */
1717 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1718 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1719 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001720 * Broadcast Action: The user has cleared the data of a package. This should
1721 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001722 * its persistent data is erased and this broadcast sent.
1723 * Note that the cleared package does <em>not</em>
1724 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001725 * <ul>
1726 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1727 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001728 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001729 * <p class="note">This is a protected intent that can only be sent
1730 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001731 */
1732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1733 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1734 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001735 * Broadcast Action: A user ID has been removed from the system. The user
1736 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001737 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001738 * <p class="note">This is a protected intent that can only be sent
1739 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001740 */
1741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1742 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001743
1744 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001745 * Broadcast Action: Sent to the installer package of an application
1746 * when that application is first launched (that is the first time it
1747 * is moved out of the stopped state). The data contains the name of the package.
1748 *
1749 * <p class="note">This is a protected intent that can only be sent
1750 * by the system.
1751 */
1752 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1753 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1754
1755 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001756 * Broadcast Action: Sent to the system package verifier when a package
1757 * needs to be verified. The data contains the package URI.
1758 * <p class="note">
1759 * This is a protected intent that can only be sent by the system.
1760 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001761 */
1762 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1763 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1764
1765 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001766 * Broadcast Action: Sent to the system package verifier when a package is
1767 * verified. The data contains the package URI.
1768 * <p class="note">
1769 * This is a protected intent that can only be sent by the system.
1770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1773
1774 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775 * Broadcast Action: Resources for a set of packages (which were
1776 * previously unavailable) are currently
1777 * available since the media on which they exist is available.
1778 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1779 * list of packages whose availability changed.
1780 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1781 * list of uids of packages whose availability changed.
1782 * Note that the
1783 * packages in this list do <em>not</em> receive this broadcast.
1784 * The specified set of packages are now available on the system.
1785 * <p>Includes the following extras:
1786 * <ul>
1787 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1788 * whose resources(were previously unavailable) are currently available.
1789 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1790 * packages whose resources(were previously unavailable)
1791 * are currently available.
1792 * </ul>
1793 *
1794 * <p class="note">This is a protected intent that can only be sent
1795 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001796 */
1797 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001798 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1799 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001800
1801 /**
1802 * Broadcast Action: Resources for a set of packages are currently
1803 * unavailable since the media on which they exist is unavailable.
1804 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1805 * list of packages whose availability changed.
1806 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1807 * list of uids of packages whose availability changed.
1808 * The specified set of packages can no longer be
1809 * launched and are practically unavailable on the system.
1810 * <p>Inclues the following extras:
1811 * <ul>
1812 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1813 * whose resources are no longer available.
1814 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1815 * whose resources are no longer available.
1816 * </ul>
1817 *
1818 * <p class="note">This is a protected intent that can only be sent
1819 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001822 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001823 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001824
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 /**
1826 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001827 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001828 * This should <em>only</em> be used to determine when the wallpaper
1829 * has changed to show the new wallpaper to the user. You should certainly
1830 * never, in response to this, change the wallpaper or other attributes of
1831 * it such as the suggested size. That would be crazy, right? You'd cause
1832 * all kinds of loops, especially if other apps are doing similar things,
1833 * right? Of course. So please don't do this.
1834 *
1835 * @deprecated Modern applications should use
1836 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1837 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1838 * shown behind their UI, rather than watching for this broadcast and
1839 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001841 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001842 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1843 /**
1844 * Broadcast Action: The current device {@link android.content.res.Configuration}
1845 * (orientation, locale, etc) has changed. When such a change happens, the
1846 * UIs (view hierarchy) will need to be rebuilt based on this new
1847 * information; for the most part, applications don't need to worry about
1848 * this, because the system will take care of stopping and restarting the
1849 * application to make sure it sees the new changes. Some system code that
1850 * can not be restarted will need to watch for this action and handle it
1851 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001853 * <p class="note">
1854 * You can <em>not</em> receive this through components declared
1855 * in manifests, only by explicitly registering for it with
1856 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1857 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001861 *
1862 * @see android.content.res.Configuration
1863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1866 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001867 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001868 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001869 * <p class="note">This is a protected intent that can only be sent
1870 * by the system.
1871 */
1872 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1873 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1874 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001875 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1876 * charging state, level, and other information about the battery.
1877 * See {@link android.os.BatteryManager} for documentation on the
1878 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001879 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001880 * <p class="note">
1881 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001882 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001883 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001884 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1885 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1886 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1887 * broadcasts that are sent and can be received through manifest
1888 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001889 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001890 * <p class="note">This is a protected intent that can only be sent
1891 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1894 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1895 /**
1896 * Broadcast Action: Indicates low battery condition on the device.
1897 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1904 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001905 * Broadcast Action: Indicates the battery is now okay after being low.
1906 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1907 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001908 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1914 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001915 * Broadcast Action: External power has been connected to the device.
1916 * This is intended for applications that wish to register specifically to this notification.
1917 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1918 * stay active to receive this notification. This action can be used to implement actions
1919 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001923 */
1924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001925 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001926 /**
1927 * Broadcast Action: External power has been removed from the device.
1928 * This is intended for applications that wish to register specifically to this notification.
1929 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1930 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001931 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001932 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001933 * <p class="note">This is a protected intent that can only be sent
1934 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001937 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001938 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001939 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001940 * Broadcast Action: Device is shutting down.
1941 * This is broadcast when the device is being shut down (completely turned
1942 * off, not sleeping). Once the broadcast is complete, the final shutdown
1943 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001944 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001945 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001946 * <p class="note">This is a protected intent that can only be sent
1947 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001948 * <p>May include the following extras:
1949 * <ul>
1950 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1951 * shutdown is only for userspace processes. If not set, assumed to be false.
1952 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001953 */
1954 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001955 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001956 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001957 * Activity Action: Start this activity to request system shutdown.
1958 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1959 * to request confirmation from the user before shutting down.
1960 *
1961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
1963 *
1964 * {@hide}
1965 */
1966 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1967 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001968 * Broadcast Action: A sticky broadcast that indicates low memory
1969 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001970 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001971 * <p class="note">This is a protected intent that can only be sent
1972 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1976 /**
1977 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001978 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001979 * <p class="note">This is a protected intent that can only be sent
1980 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 */
1982 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1983 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1984 /**
Jake Hambybb371632010-08-23 18:16:48 -07001985 * Broadcast Action: A sticky broadcast that indicates a memory full
1986 * condition on the device. This is intended for activities that want
1987 * to be able to fill the data partition completely, leaving only
1988 * enough free space to prevent system-wide SQLite failures.
1989 *
1990 * <p class="note">This is a protected intent that can only be sent
1991 * by the system.
1992 *
1993 * {@hide}
1994 */
1995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1996 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1997 /**
1998 * Broadcast Action: Indicates memory full condition on the device
1999 * no longer exists.
2000 *
2001 * <p class="note">This is a protected intent that can only be sent
2002 * by the system.
2003 *
2004 * {@hide}
2005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002009 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2010 * and package management should be started.
2011 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2012 * notification.
2013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2016 /**
2017 * Broadcast Action: The device has entered USB Mass Storage mode.
2018 * This is used mainly for the USB Settings panel.
2019 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2020 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002021 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002023 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002024 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2025
2026 /**
2027 * Broadcast Action: The device has exited USB Mass Storage mode.
2028 * This is used mainly for the USB Settings panel.
2029 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2030 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002031 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002033 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002034 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2035
2036 /**
2037 * Broadcast Action: External media has been removed.
2038 * The path to the mount point for the removed media is contained in the Intent.mData field.
2039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2042
2043 /**
2044 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002045 * 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 -07002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2049
2050 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002051 * Broadcast Action: External media is present, and being disk-checked
2052 * 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 -08002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2056
2057 /**
2058 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2059 * 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 -08002060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2063
2064 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002065 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002066 * 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 -07002067 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2068 * media was mounted read only.
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2072
2073 /**
2074 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002075 * 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 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2079
2080 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002081 * Broadcast Action: External media is no longer being shared via USB mass storage.
2082 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2083 *
2084 * @hide
2085 */
2086 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2087
2088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002089 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2090 * The path to the mount point for the removed media is contained in the Intent.mData field.
2091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2094
2095 /**
2096 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002097 * 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 -07002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2101
2102 /**
2103 * Broadcast Action: User has expressed the desire to remove the external storage media.
2104 * Applications should close all files they have open within the mount point when they receive this intent.
2105 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2109
2110 /**
2111 * Broadcast Action: The media scanner has started scanning a directory.
2112 * The path to the directory being scanned is contained in the Intent.mData field.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2116
2117 /**
2118 * Broadcast Action: The media scanner has finished scanning a directory.
2119 * The path to the scanned directory is contained in the Intent.mData field.
2120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2123
2124 /**
2125 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2126 * The path to the file is contained in the Intent.mData field.
2127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2130
2131 /**
2132 * Broadcast Action: The "Media Button" was pressed. Includes a single
2133 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2134 * caused the broadcast.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2138
2139 /**
2140 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2141 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2142 * caused the broadcast.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2146
2147 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2148 // location; they are not general-purpose actions.
2149
2150 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002151 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2155 "android.intent.action.GTALK_CONNECTED";
2156
2157 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002158 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2162 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002163
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002164 /**
2165 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_INPUT_METHOD_CHANGED =
2169 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170
2171 /**
2172 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2173 * more radios have been turned off or on. The intent will have the following extra value:</p>
2174 * <ul>
2175 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2176 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2177 * turned off</li>
2178 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002179 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002180 * <p class="note">This is a protected intent that can only be sent
2181 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002182 */
2183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2185
2186 /**
2187 * Broadcast Action: Some content providers have parts of their namespace
2188 * where they publish new events or items that the user may be especially
2189 * interested in. For these things, they may broadcast this action when the
2190 * set of interesting items change.
2191 *
2192 * For example, GmailProvider sends this notification when the set of unread
2193 * mail in the inbox changes.
2194 *
2195 * <p>The data of the intent identifies which part of which provider
2196 * changed. When queried through the content resolver, the data URI will
2197 * return the data set in question.
2198 *
2199 * <p>The intent will have the following extra values:
2200 * <ul>
2201 * <li><em>count</em> - The number of items in the data set. This is the
2202 * same as the number of items in the cursor returned by querying the
2203 * data URI. </li>
2204 * </ul>
2205 *
2206 * This intent will be sent at boot (if the count is non-zero) and when the
2207 * data set changes. It is possible for the data set to change without the
2208 * count changing (for example, if a new unread message arrives in the same
2209 * sync operation in which a message is archived). The phone should still
2210 * ring/vibrate/etc as normal in this case.
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_PROVIDER_CHANGED =
2214 "android.intent.action.PROVIDER_CHANGED";
2215
2216 /**
2217 * Broadcast Action: Wired Headset plugged in or unplugged.
2218 *
Matt Casey79867f52014-03-26 15:20:25 -07002219 * You <em>cannot</em> receive this through components declared
2220 * in manifests, only by explicitly registering for it with
2221 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2222 * Context.registerReceiver()}.
2223 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 * <p>The intent will have the following extra values:
2225 * <ul>
2226 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2227 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002228 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002229 * </ul>
2230 * </ul>
2231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2233 public static final String ACTION_HEADSET_PLUG =
2234 "android.intent.action.HEADSET_PLUG";
2235
2236 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002237 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2238 *
2239 * <p>The intent will have the following extra values:
2240 * <ul>
2241 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2242 * <li><em>name</em> - Headset type, human readable string </li>
2243 * </ul>
2244 * </ul>
2245 * @hide
2246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002248 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2249 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002250
2251 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002252 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002253 *
2254 * <p>The intent will have the following extra values:
2255 * <ul>
2256 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2257 * <li><em>name</em> - Headset type, human readable string </li>
2258 * </ul>
2259 * </ul>
2260 * @hide
2261 */
2262 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002263 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2264 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002265
2266 /**
Jean-Michel Trivi37d78042014-08-10 14:59:15 -07002267 * Broadcast Action: A sticky broadcast indicating an HMDI cable was plugged or unplugged
Praveen Bharathi26e37342010-11-02 19:23:30 -07002268 *
2269 * <p>The intent will have the following extra values:
2270 * <ul>
2271 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2272 * <li><em>name</em> - HDMI cable, human readable string </li>
Jean-Michel Trivi37d78042014-08-10 14:59:15 -07002273 * <li><em>maxChannelCount</em> - the maximum number of output channels supported by the
2274 * connected HDMI device, only available when <i>state</i> is 1.</li>
2275 * <li><em>encodings</em> - an array of formats supported by the connected HDMI device,
2276 * only available when <i>state</i> is 1. Encoding values are defined in
2277 * {@link android.media.AudioFormat} (for instance see
2278 * {@link android.media.AudioFormat#ENCODING_PCM_16BIT}). Use
2279 * {@link #getIntArrayExtra(String)} to retrieve the encoding values.</li>
Praveen Bharathi26e37342010-11-02 19:23:30 -07002280 * </ul>
Praveen Bharathi26e37342010-11-02 19:23:30 -07002281 */
2282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2283 public static final String ACTION_HDMI_AUDIO_PLUG =
2284 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002285
2286 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002287 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2288 *
2289 * <p>The intent will have the following extra values:
2290 * <ul>
2291 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2292 * <li><em>card</em> - ALSA card number (integer) </li>
2293 * <li><em>device</em> - ALSA device number (integer) </li>
2294 * </ul>
2295 * </ul>
2296 * @hide
2297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2300 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2301
2302 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002303 * Broadcast Action: A USB audio device was plugged in or unplugged.
2304 *
2305 * <p>The intent will have the following extra values:
2306 * <ul>
2307 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2308 * <li><em>card</em> - ALSA card number (integer) </li>
2309 * <li><em>device</em> - ALSA device number (integer) </li>
2310 * </ul>
2311 * </ul>
2312 * @hide
2313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2316 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2317
2318 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002319 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2320 * <ul>
2321 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2322 * </ul>
2323 *
2324 * <p class="note">This is a protected intent that can only be sent
2325 * by the system.
2326 *
2327 * @hide
2328 */
2329 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2330 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2331 = "android.intent.action.ADVANCED_SETTINGS";
2332
2333 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002334 * Broadcast Action: Sent after application restrictions are changed.
2335 *
2336 * <p class="note">This is a protected intent that can only be sent
2337 * by the system.</p>
2338 */
2339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2340 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2341 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2342
2343 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 * Broadcast Action: An outgoing call is about to be placed.
2345 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002346 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002347 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002348 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002349 * the phone number originally intended to be dialed.</li>
2350 * </ul>
2351 * <p>Once the broadcast is finished, the resultData is used as the actual
2352 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002353 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002354 * outgoing call in turn: for example, a parental control application
2355 * might verify that the user is authorized to place the call at that
2356 * time, then a number-rewriting application might add an area code if
2357 * one was not specified.</p>
2358 * <p>For consistency, any receiver whose purpose is to prohibit phone
2359 * calls should have a priority of 0, to ensure it will see the final
2360 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002361 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002362 * should have a positive priority.
2363 * Negative priorities are reserved for the system for this broadcast;
2364 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002365 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2366 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002367 * <p>Emergency calls cannot be intercepted using this mechanism, and
2368 * other calls cannot be modified to call emergency numbers using this
2369 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002370 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2371 * call to use their own service instead. Those apps should first prevent
2372 * the call from being placed by setting resultData to <code>null</code>
2373 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002374 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002375 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2376 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002378 * <p class="note">This is a protected intent that can only be sent
2379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002380 */
2381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2382 public static final String ACTION_NEW_OUTGOING_CALL =
2383 "android.intent.action.NEW_OUTGOING_CALL";
2384
2385 /**
2386 * Broadcast Action: Have the device reboot. This is only for use by
2387 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002388 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002389 * <p class="note">This is a protected intent that can only be sent
2390 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002391 */
2392 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2393 public static final String ACTION_REBOOT =
2394 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002395
Wei Huang97ecc9c2009-05-11 17:44:20 -07002396 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002397 * Broadcast Action: A sticky broadcast for changes in the physical
2398 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002399 *
2400 * <p>The intent will have the following extra values:
2401 * <ul>
2402 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002403 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002404 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002405 * <p>This is intended for monitoring the current physical dock state.
2406 * See {@link android.app.UiModeManager} for the normal API dealing with
2407 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002408 */
2409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2410 public static final String ACTION_DOCK_EVENT =
2411 "android.intent.action.DOCK_EVENT";
2412
2413 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002414 * Broadcast Action: A broadcast when idle maintenance can be started.
2415 * This means that the user is not interacting with the device and is
2416 * not expected to do so soon. Typical use of the idle maintenance is
2417 * to perform somehow expensive tasks that can be postponed at a moment
2418 * when they will not degrade user experience.
2419 * <p>
2420 * <p class="note">In order to keep the device responsive in case of an
2421 * unexpected user interaction, implementations of a maintenance task
2422 * should be interruptible. In such a scenario a broadcast with action
2423 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2424 * should not do the maintenance work in
2425 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2426 * maintenance service by {@link Context#startService(Intent)}. Also
2427 * you should hold a wake lock while your maintenance service is running
2428 * to prevent the device going to sleep.
2429 * </p>
2430 * <p>
2431 * <p class="note">This is a protected intent that can only be sent by
2432 * the system.
2433 * </p>
2434 *
2435 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002436 *
2437 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002438 */
2439 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2440 public static final String ACTION_IDLE_MAINTENANCE_START =
2441 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2442
2443 /**
2444 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2445 * This means that the user was not interacting with the device as a result
2446 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2447 * was sent and now the user started interacting with the device. Typical
2448 * use of the idle maintenance is to perform somehow expensive tasks that
2449 * can be postponed at a moment when they will not degrade user experience.
2450 * <p>
2451 * <p class="note">In order to keep the device responsive in case of an
2452 * unexpected user interaction, implementations of a maintenance task
2453 * should be interruptible. Hence, on receiving a broadcast with this
2454 * action, the maintenance task should be interrupted as soon as possible.
2455 * In other words, you should not do the maintenance work in
2456 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2457 * maintenance service that was started on receiving of
2458 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2459 * lock you acquired when your maintenance service started.
2460 * </p>
2461 * <p class="note">This is a protected intent that can only be sent
2462 * by the system.
2463 *
2464 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002465 *
2466 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_IDLE_MAINTENANCE_END =
2470 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2471
2472 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002473 * Broadcast Action: a remote intent is to be broadcasted.
2474 *
2475 * A remote intent is used for remote RPC between devices. The remote intent
2476 * is serialized and sent from one device to another device. The receiving
2477 * device parses the remote intent and broadcasts it. Note that anyone can
2478 * broadcast a remote intent. However, if the intent receiver of the remote intent
2479 * does not trust intent broadcasts from arbitrary intent senders, it should require
2480 * the sender to hold certain permissions so only trusted sender's broadcast will be
2481 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002482 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002483 */
2484 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002485 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002486
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002487 /**
2488 * Broadcast Action: hook for permforming cleanup after a system update.
2489 *
2490 * The broadcast is sent when the system is booting, before the
2491 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2492 * image. A receiver for this should do its work and then disable itself
2493 * so that it does not get run again at the next boot.
2494 * @hide
2495 */
2496 public static final String ACTION_PRE_BOOT_COMPLETED =
2497 "android.intent.action.PRE_BOOT_COMPLETED";
2498
Amith Yamasani13593602012-03-22 16:16:17 -07002499 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002500 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002501 * on restricted users. The broadcast intent contains an extra
2502 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2503 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2504 * String[] depending on the restriction type.<p/>
2505 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002506 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2507 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2508 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002509 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2510 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002511 * @see RestrictionEntry
2512 */
2513 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2514 "android.intent.action.GET_RESTRICTION_ENTRIES";
2515
2516 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002517 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002518 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002519 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2520 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2521 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002522 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2523 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2524 * challenge.<p/>
2525 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002526 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002527 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002528 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2529 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002530
2531 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002532 * Sent the first time a user is starting, to allow system apps to
2533 * perform one time initialization. (This will not be seen by third
2534 * party applications because a newly initialized user does not have any
2535 * third party applications installed for it.) This is sent early in
2536 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002537 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2538 * broadcast, since it is part of a visible user interaction; be as quick
2539 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002540 */
2541 public static final String ACTION_USER_INITIALIZE =
2542 "android.intent.action.USER_INITIALIZE";
2543
2544 /**
2545 * Sent when a user switch is happening, causing the process's user to be
2546 * brought to the foreground. This is only sent to receivers registered
2547 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2548 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002549 * foreground. This is sent as a foreground
2550 * broadcast, since it is part of a visible user interaction; be as quick
2551 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002552 */
2553 public static final String ACTION_USER_FOREGROUND =
2554 "android.intent.action.USER_FOREGROUND";
2555
2556 /**
2557 * Sent when a user switch is happening, causing the process's user to be
2558 * sent to the background. This is only sent to receivers registered
2559 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2560 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002561 * background. This is sent as a foreground
2562 * broadcast, since it is part of a visible user interaction; be as quick
2563 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002564 */
2565 public static final String ACTION_USER_BACKGROUND =
2566 "android.intent.action.USER_BACKGROUND";
2567
2568 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002569 * Broadcast sent to the system when a user is added. Carries an extra
2570 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2571 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002572 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002573 * @hide
2574 */
2575 public static final String ACTION_USER_ADDED =
2576 "android.intent.action.USER_ADDED";
2577
2578 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002579 * Broadcast sent by the system when a user is started. Carries an extra
2580 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002581 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002582 * that has been started. This is sent as a foreground
2583 * broadcast, since it is part of a visible user interaction; be as quick
2584 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002585 * @hide
2586 */
2587 public static final String ACTION_USER_STARTED =
2588 "android.intent.action.USER_STARTED";
2589
2590 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002591 * Broadcast sent when a user is in the process of starting. Carries an extra
2592 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2593 * sent to registered receivers, not manifest receivers. It is sent to all
2594 * users (including the one that is being started). You must hold
2595 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2596 * this broadcast. This is sent as a background broadcast, since
2597 * its result is not part of the primary UX flow; to safely keep track of
2598 * started/stopped state of a user you can use this in conjunction with
2599 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2600 * other user state broadcasts since those are foreground broadcasts so can
2601 * execute in a different order.
2602 * @hide
2603 */
2604 public static final String ACTION_USER_STARTING =
2605 "android.intent.action.USER_STARTING";
2606
2607 /**
2608 * Broadcast sent when a user is going to be stopped. Carries an extra
2609 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2610 * sent to registered receivers, not manifest receivers. It is sent to all
2611 * users (including the one that is being stopped). You must hold
2612 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2613 * this broadcast. The user will not stop until all receivers have
2614 * handled the broadcast. This is sent as a background broadcast, since
2615 * its result is not part of the primary UX flow; to safely keep track of
2616 * started/stopped state of a user you can use this in conjunction with
2617 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2618 * other user state broadcasts since those are foreground broadcasts so can
2619 * execute in a different order.
2620 * @hide
2621 */
2622 public static final String ACTION_USER_STOPPING =
2623 "android.intent.action.USER_STOPPING";
2624
2625 /**
2626 * Broadcast sent to the system when a user is stopped. Carries an extra
2627 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2628 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2629 * specific package. This is only sent to registered receivers, not manifest
2630 * receivers. It is sent to all running users <em>except</em> the one that
2631 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002632 * @hide
2633 */
2634 public static final String ACTION_USER_STOPPED =
2635 "android.intent.action.USER_STOPPED";
2636
2637 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002638 * 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 -07002639 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002640 * one that has been removed. The user will not be completely removed until all receivers have
2641 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002642 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002643 * @hide
2644 */
2645 public static final String ACTION_USER_REMOVED =
2646 "android.intent.action.USER_REMOVED";
2647
2648 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002649 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002650 * the userHandle of the user to become the current one. This is only sent to
2651 * registered receivers, not manifest receivers. It is sent to all running users.
2652 * You must hold
2653 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002654 * @hide
2655 */
2656 public static final String ACTION_USER_SWITCHED =
2657 "android.intent.action.USER_SWITCHED";
2658
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002659 /**
2660 * Broadcast sent to the system when a user's information changes. Carries an extra
2661 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002662 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002663 * @hide
2664 */
2665 public static final String ACTION_USER_INFO_CHANGED =
2666 "android.intent.action.USER_INFO_CHANGED";
2667
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002668 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002669 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2670 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002671 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2672 * that need to display merged content across both primary and managed profiles need to
2673 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002674 * not manifest receivers.
2675 */
2676 public static final String ACTION_MANAGED_PROFILE_ADDED =
2677 "android.intent.action.MANAGED_PROFILE_ADDED";
2678
2679 /**
2680 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002681 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2682 * Only applications (for example Launchers) that need to display merged content across both
2683 * primary and managed profiles need to worry about this broadcast. This is only sent to
2684 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002685 */
2686 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2687 "android.intent.action.MANAGED_PROFILE_REMOVED";
2688
2689 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002690 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2691 */
2692 public static final String ACTION_QUICK_CLOCK =
2693 "android.intent.action.QUICK_CLOCK";
2694
Michael Wright0087a142013-02-05 16:29:39 -08002695 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002696 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002697 * @hide
2698 */
2699 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2700 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2701
Justin Kohd378ad72013-04-01 12:18:26 -07002702 /**
2703 * Broadcast Action: A global button was pressed. Includes a single
2704 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2705 * caused the broadcast.
2706 * @hide
2707 */
2708 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2709
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002710 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002711 * Activity Action: Allow the user to select and return one or more existing
2712 * documents. When invoked, the system will display the various
2713 * {@link DocumentsProvider} instances installed on the device, letting the
2714 * user interactively navigate through them. These documents include local
2715 * media, such as photos and video, and documents provided by installed
2716 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002717 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002718 * Each document is represented as a {@code content://} URI backed by a
2719 * {@link DocumentsProvider}, which can be opened as a stream with
2720 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2721 * {@link android.provider.DocumentsContract.Document} metadata.
2722 * <p>
2723 * All selected documents are returned to the calling application with
2724 * persistable read and write permission grants. If you want to maintain
2725 * access to the documents across device reboots, you need to explicitly
2726 * take the persistable permissions using
2727 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2728 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002729 * Callers must indicate the acceptable document MIME types through
2730 * {@link #setType(String)}. For example, to select photos, use
2731 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2732 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2733 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002734 * <p>
2735 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002736 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2737 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002738 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002739 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2740 * returned URIs can be opened with
2741 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002742 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002743 * Output: The URI of the item that was picked, returned in
2744 * {@link #getData()}. This must be a {@code content://} URI so that any
2745 * receiver can access it. If multiple documents were selected, they are
2746 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002747 *
2748 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002749 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002750 * @see #ACTION_CREATE_DOCUMENT
2751 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002752 */
2753 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2754 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2755
2756 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002757 * Activity Action: Allow the user to create a new document. When invoked,
2758 * the system will display the various {@link DocumentsProvider} instances
2759 * installed on the device, letting the user navigate through them. The
2760 * returned document may be a newly created document with no content, or it
2761 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002762 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002763 * Each document is represented as a {@code content://} URI backed by a
2764 * {@link DocumentsProvider}, which can be opened as a stream with
2765 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2766 * {@link android.provider.DocumentsContract.Document} metadata.
2767 * <p>
2768 * Callers must indicate the concrete MIME type of the document being
2769 * created by setting {@link #setType(String)}. This MIME type cannot be
2770 * changed after the document is created.
2771 * <p>
2772 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2773 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002774 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002775 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2776 * returned URIs can be opened with
2777 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002778 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002779 * Output: The URI of the item that was created. This must be a
2780 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002781 *
2782 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002783 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002784 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002785 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002786 */
2787 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2788 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2789
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002790 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002791 * Activity Action: Allow the user to pick a directory subtree. When
2792 * invoked, the system will display the various {@link DocumentsProvider}
2793 * instances installed on the device, letting the user navigate through
2794 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002795 * <p>
2796 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002797 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2798 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2799 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002800 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002801 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002802 *
2803 * @see DocumentsContract
2804 */
2805 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002806 public static final String
2807 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002808
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002809 // ---------------------------------------------------------------------
2810 // ---------------------------------------------------------------------
2811 // Standard intent categories (see addCategory()).
2812
2813 /**
2814 * Set if the activity should be an option for the default action
2815 * (center press) to perform on a piece of data. Setting this will
2816 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002817 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002818 * Intent when initiating an action -- it is for use in intent filters
2819 * specified in packages.
2820 */
2821 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2822 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2823 /**
2824 * Activities that can be safely invoked from a browser must support this
2825 * category. For example, if the user is viewing a web page or an e-mail
2826 * and clicks on a link in the text, the Intent generated execute that
2827 * link will require the BROWSABLE category, so that only activities
2828 * supporting this category will be considered as possible actions. By
2829 * supporting this category, you are promising that there is nothing
2830 * damaging (without user intervention) that can happen by invoking any
2831 * matching Intent.
2832 */
2833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2834 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2835 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002836 * Categories for activities that can participate in voice interaction.
2837 * An activity that supports this category must be prepared to run with
2838 * no UI shown at all (though in some case it may have a UI shown), and
2839 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2840 */
2841 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2842 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2843 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002844 * Set if the activity should be considered as an alternative action to
2845 * the data the user is currently viewing. See also
2846 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2847 * applies to the selection in a list of items.
2848 *
2849 * <p>Supporting this category means that you would like your activity to be
2850 * displayed in the set of alternative things the user can do, usually as
2851 * part of the current activity's options menu. You will usually want to
2852 * include a specific label in the &lt;intent-filter&gt; of this action
2853 * describing to the user what it does.
2854 *
2855 * <p>The action of IntentFilter with this category is important in that it
2856 * describes the specific action the target will perform. This generally
2857 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2858 * a specific name such as "com.android.camera.action.CROP. Only one
2859 * alternative of any particular action will be shown to the user, so using
2860 * a specific action like this makes sure that your alternative will be
2861 * displayed while also allowing other applications to provide their own
2862 * overrides of that particular action.
2863 */
2864 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2865 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2866 /**
2867 * Set if the activity should be considered as an alternative selection
2868 * action to the data the user has currently selected. This is like
2869 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2870 * of items from which the user can select, giving them alternatives to the
2871 * default action that will be performed on it.
2872 */
2873 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2874 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2875 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002876 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002877 */
2878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2880 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002881 * Should be displayed in the top-level launcher.
2882 */
2883 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2884 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2885 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002886 * Indicates an activity optimized for Leanback mode, and that should
2887 * be displayed in the Leanback launcher.
2888 */
2889 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2890 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2891 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002892 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2893 * @hide
2894 */
2895 @SystemApi
2896 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2897 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002898 * Provides information about the package it is in; typically used if
2899 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2900 * a front-door to the user without having to be shown in the all apps list.
2901 */
2902 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2903 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2904 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002905 * This is the home activity, that is the first activity that is displayed
2906 * when the device boots.
2907 */
2908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2909 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2910 /**
2911 * This activity is a preference panel.
2912 */
2913 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2914 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2915 /**
2916 * This activity is a development preference panel.
2917 */
2918 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2919 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2920 /**
2921 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002922 */
2923 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2924 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2925 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002926 * This activity allows the user to browse and download new applications.
2927 */
2928 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2929 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2930 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002931 * This activity may be exercised by the monkey or other automated test tools.
2932 */
2933 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2934 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2935 /**
2936 * To be used as a test (not part of the normal user experience).
2937 */
2938 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2939 /**
2940 * To be used as a unit test (run through the Test Harness).
2941 */
2942 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2943 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002944 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002945 * experience).
2946 */
2947 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002948
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002949 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002950 * Used to indicate that an intent only wants URIs that can be opened with
2951 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2952 * must support at least the columns defined in {@link OpenableColumns} when
2953 * queried.
2954 *
2955 * @see #ACTION_GET_CONTENT
2956 * @see #ACTION_OPEN_DOCUMENT
2957 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 */
2959 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2960 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2961
2962 /**
2963 * To be used as code under test for framework instrumentation tests.
2964 */
2965 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2966 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002967 /**
2968 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002969 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2970 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002971 */
2972 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2973 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2974 /**
2975 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002976 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2977 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002978 */
2979 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2980 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002981 /**
2982 * An activity to run when device is inserted into a analog (low end) dock.
2983 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2984 * information, see {@link android.app.UiModeManager}.
2985 */
2986 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2987 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2988
2989 /**
2990 * An activity to run when device is inserted into a digital (high end) dock.
2991 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2992 * information, see {@link android.app.UiModeManager}.
2993 */
2994 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2995 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002996
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002997 /**
2998 * Used to indicate that the activity can be used in a car environment.
2999 */
3000 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3001 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003003 // ---------------------------------------------------------------------
3004 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003005 // Application launch intent categories (see addCategory()).
3006
3007 /**
3008 * Used with {@link #ACTION_MAIN} to launch the browser application.
3009 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003010 * <p>NOTE: This should not be used as the primary key of an Intent,
3011 * since it will not result in the app launching with the correct
3012 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003013 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003014 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003015 */
3016 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3017 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3018
3019 /**
3020 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3021 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003022 * <p>NOTE: This should not be used as the primary key of an Intent,
3023 * since it will not result in the app launching with the correct
3024 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003025 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003026 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003027 */
3028 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3029 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3030
3031 /**
3032 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3033 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003034 * <p>NOTE: This should not be used as the primary key of an Intent,
3035 * since it will not result in the app launching with the correct
3036 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003037 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003038 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003039 */
3040 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3041 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3042
3043 /**
3044 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3045 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003046 * <p>NOTE: This should not be used as the primary key of an Intent,
3047 * since it will not result in the app launching with the correct
3048 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003049 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003050 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003051 */
3052 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3053 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3054
3055 /**
3056 * Used with {@link #ACTION_MAIN} to launch the email application.
3057 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003058 * <p>NOTE: This should not be used as the primary key of an Intent,
3059 * since it will not result in the app launching with the correct
3060 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003061 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003062 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003063 */
3064 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3065 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3066
3067 /**
3068 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3069 * The activity should be able to view and manipulate image and video files
3070 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003071 * <p>NOTE: This should not be used as the primary key of an Intent,
3072 * since it will not result in the app launching with the correct
3073 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003074 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003075 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003076 */
3077 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3078 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3079
3080 /**
3081 * Used with {@link #ACTION_MAIN} to launch the maps application.
3082 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003083 * <p>NOTE: This should not be used as the primary key of an Intent,
3084 * since it will not result in the app launching with the correct
3085 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003086 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003087 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003088 */
3089 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3090 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3091
3092 /**
3093 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3094 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003095 * <p>NOTE: This should not be used as the primary key of an Intent,
3096 * since it will not result in the app launching with the correct
3097 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003098 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003099 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003100 */
3101 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3102 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3103
3104 /**
3105 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003106 * The activity should be able to play, browse, or manipulate music files
3107 * stored on the device.
3108 * <p>NOTE: This should not be used as the primary key of an Intent,
3109 * since it will not result in the app launching with the correct
3110 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003111 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003112 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003113 */
3114 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3115 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3116
3117 // ---------------------------------------------------------------------
3118 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003119 // Standard extra data keys.
3120
3121 /**
3122 * The initial data to place in a newly created record. Use with
3123 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3124 * fields as would be given to the underlying ContentProvider.insert()
3125 * call.
3126 */
3127 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3128
3129 /**
3130 * A constant CharSequence that is associated with the Intent, used with
3131 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3132 * this may be a styled CharSequence, so you must use
3133 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3134 * retrieve it.
3135 */
3136 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3137
3138 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003139 * A constant String that is associated with the Intent, used with
3140 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3141 * as HTML formatted text. Note that you <em>must</em> also supply
3142 * {@link #EXTRA_TEXT}.
3143 */
3144 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3145
3146 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003147 * A content: URI holding a stream of data associated with the Intent,
3148 * used with {@link #ACTION_SEND} to supply the data being sent.
3149 */
3150 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3151
3152 /**
3153 * A String[] holding e-mail addresses that should be delivered to.
3154 */
3155 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3156
3157 /**
3158 * A String[] holding e-mail addresses that should be carbon copied.
3159 */
3160 public static final String EXTRA_CC = "android.intent.extra.CC";
3161
3162 /**
3163 * A String[] holding e-mail addresses that should be blind carbon copied.
3164 */
3165 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3166
3167 /**
3168 * A constant string holding the desired subject line of a message.
3169 */
3170 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3171
3172 /**
3173 * An Intent describing the choices you would like shown with
3174 * {@link #ACTION_PICK_ACTIVITY}.
3175 */
3176 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3177
3178 /**
3179 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003180 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003181 */
3182 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3183
3184 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003185 * A Parcelable[] of {@link Intent} or
3186 * {@link android.content.pm.LabeledIntent} objects as set with
3187 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3188 * a the front of the list of choices, when shown to the user with a
3189 * {@link #ACTION_CHOOSER}.
3190 */
3191 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3192
3193 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003194 * A Bundle forming a mapping of potential target package names to different extras Bundles
3195 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3196 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3197 * be currently installed on the device.
3198 *
3199 * <p>An application may choose to provide alternate extras for the case where a user
3200 * selects an activity from a predetermined set of target packages. If the activity
3201 * the user selects from the chooser belongs to a package with its package name as
3202 * a key in this bundle, the corresponding extras for that package will be merged with
3203 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3204 * extra has the same key as an extra already present in the intent it will overwrite
3205 * the extra from the intent.</p>
3206 *
3207 * <p><em>Examples:</em>
3208 * <ul>
3209 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3210 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3211 * parameters for that target.</li>
3212 * <li>An application may offer additional metadata for known targets of a given intent
3213 * to pass along information only relevant to that target such as account or content
3214 * identifiers already known to that application.</li>
3215 * </ul></p>
3216 */
3217 public static final String EXTRA_REPLACEMENT_EXTRAS =
3218 "android.intent.extra.REPLACEMENT_EXTRAS";
3219
3220 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003221 * A {@link android.view.KeyEvent} object containing the event that
3222 * triggered the creation of the Intent it is in.
3223 */
3224 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3225
3226 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003227 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3228 * before shutting down.
3229 *
3230 * {@hide}
3231 */
3232 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3233
3234 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003235 * 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 -07003236 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3237 * of restarting the application.
3238 */
3239 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3240
3241 /**
3242 * A String holding the phone number originally entered in
3243 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3244 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3245 */
3246 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003247
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003248 /**
3249 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3250 * intents to supply the uid the package had been assigned. Also an optional
3251 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3252 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3253 * purpose.
3254 */
3255 public static final String EXTRA_UID = "android.intent.extra.UID";
3256
3257 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003258 * @hide String array of package names.
3259 */
3260 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3261
3262 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003263 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3264 * intents to indicate whether this represents a full uninstall (removing
3265 * both the code and its data) or a partial uninstall (leaving its data,
3266 * implying that this is an update).
3267 */
3268 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003269
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003270 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003271 * @hide
3272 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3273 * intents to indicate that at this point the package has been removed for
3274 * all users on the device.
3275 */
3276 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3277 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3278
3279 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003280 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3281 * intents to indicate that this is a replacement of the package, so this
3282 * broadcast will immediately be followed by an add broadcast for a
3283 * different version of the same package.
3284 */
3285 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003286
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003287 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 * Used as an int extra field in {@link android.app.AlarmManager} intents
3289 * to tell the application being invoked how many pending alarms are being
3290 * delievered with the intent. For one-shot alarms this will always be 1.
3291 * For recurring alarms, this might be greater than 1 if the device was
3292 * asleep or powered off at the time an earlier alarm would have been
3293 * delivered.
3294 */
3295 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003296
Jacek Surazski86b6c532009-05-13 14:38:28 +02003297 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003298 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3299 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003300 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3301 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003302 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3303 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3304 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003305 */
3306 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3307
3308 /**
3309 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3310 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003311 */
3312 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3313
3314 /**
3315 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3316 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003317 */
3318 public static final int EXTRA_DOCK_STATE_DESK = 1;
3319
3320 /**
3321 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3322 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003323 */
3324 public static final int EXTRA_DOCK_STATE_CAR = 2;
3325
3326 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003327 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3328 * to represent that the phone is in a analog (low end) dock.
3329 */
3330 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3331
3332 /**
3333 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3334 * to represent that the phone is in a digital (high end) dock.
3335 */
3336 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3337
3338 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003339 * Boolean that can be supplied as meta-data with a dock activity, to
3340 * indicate that the dock should take over the home key when it is active.
3341 */
3342 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003343
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003344 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003345 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3346 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003347 */
3348 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3349
3350 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003351 * Used in the extra field in the remote intent. It's astring token passed with the
3352 * remote intent.
3353 */
3354 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3355 "android.intent.extra.remote_intent_token";
3356
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003357 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003358 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003359 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003360 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003361 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003362 "android.intent.extra.changed_component_name";
3363
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003364 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003365 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003366 * and contains a string array of all of the components that have changed. If
3367 * the state of the overall package has changed, then it will contain an entry
3368 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003369 */
3370 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3371 "android.intent.extra.changed_component_name_list";
3372
3373 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003374 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003375 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3376 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003377 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003378 */
3379 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3380 "android.intent.extra.changed_package_list";
3381
3382 /**
3383 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003384 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3385 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003386 * and contains an integer array of uids of all of the components
3387 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003388 */
3389 public static final String EXTRA_CHANGED_UID_LIST =
3390 "android.intent.extra.changed_uid_list";
3391
3392 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003393 * @hide
3394 * Magic extra system code can use when binding, to give a label for
3395 * who it is that has bound to a service. This is an integer giving
3396 * a framework string resource that can be displayed to the user.
3397 */
3398 public static final String EXTRA_CLIENT_LABEL =
3399 "android.intent.extra.client_label";
3400
3401 /**
3402 * @hide
3403 * Magic extra system code can use when binding, to give a PendingIntent object
3404 * that can be launched for the user to disable the system's use of this
3405 * service.
3406 */
3407 public static final String EXTRA_CLIENT_INTENT =
3408 "android.intent.extra.client_intent";
3409
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003410 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003411 * Extra used to indicate that an intent should only return data that is on
3412 * the local device. This is a boolean extra; the default is false. If true,
3413 * an implementation should only allow the user to select data that is
3414 * already on the device, not requiring it be downloaded from a remote
3415 * service when opened.
3416 *
3417 * @see #ACTION_GET_CONTENT
3418 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003419 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003420 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003421 */
3422 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003423 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003424
Amith Yamasani13593602012-03-22 16:16:17 -07003425 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003426 * Extra used to indicate that an intent can allow the user to select and
3427 * return multiple items. This is a boolean extra; the default is false. If
3428 * true, an implementation is allowed to present the user with a UI where
3429 * they can pick multiple items that are all returned to the caller. When
3430 * this happens, they should be returned as the {@link #getClipData()} part
3431 * of the result Intent.
3432 *
3433 * @see #ACTION_GET_CONTENT
3434 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003435 */
3436 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003437 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003438
3439 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003440 * The integer userHandle carried with broadcast intents related to addition, removal and
3441 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3442 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3443 *
Amith Yamasani13593602012-03-22 16:16:17 -07003444 * @hide
3445 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003446 public static final String EXTRA_USER_HANDLE =
3447 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003448
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003449 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003450 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3451 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3452 */
3453 public static final String EXTRA_USER =
3454 "android.intent.extra.user";
3455
3456 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003457 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003458 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3459 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003460 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003461 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3462
3463 /**
3464 * Extra sent in the intent to the BroadcastReceiver that handles
3465 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3466 * the restrictions as key/value pairs.
3467 */
3468 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3469 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003470
Amith Yamasani86118ba2013-03-28 14:33:16 -07003471 /**
3472 * Extra used in the response from a BroadcastReceiver that handles
3473 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3474 */
3475 public static final String EXTRA_RESTRICTIONS_INTENT =
3476 "android.intent.extra.restrictions_intent";
3477
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003478 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003479 * Extra used to communicate a set of acceptable MIME types. The type of the
3480 * extra is {@code String[]}. Values may be a combination of concrete MIME
3481 * types (such as "image/png") and/or partial MIME types (such as
3482 * "audio/*").
3483 *
3484 * @see #ACTION_GET_CONTENT
3485 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003486 */
3487 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3488
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003489 /**
3490 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3491 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003492 * When this is true, hardware devices can use this information to determine that
3493 * they shouldn't do a complete shutdown of their device since this is not a
3494 * complete shutdown down to the kernel, but only user space restarting.
3495 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003496 */
3497 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3498 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3499
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003500 /**
3501 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3502 * user has set their time format preferences to the 24 hour format.
3503 *
3504 * @hide for internal use only.
3505 */
3506 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3507 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3508
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 // ---------------------------------------------------------------------
3510 // ---------------------------------------------------------------------
3511 // Intent flags (see mFlags variable).
3512
Tor Norbyed9273d62013-05-30 15:59:53 -07003513 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003514 @IntDef(flag = true, value = {
3515 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3516 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003517 @Retention(RetentionPolicy.SOURCE)
3518 public @interface GrantUriMode {}
3519
Jeff Sharkey846318a2014-04-04 12:12:41 -07003520 /** @hide */
3521 @IntDef(flag = true, value = {
3522 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3523 @Retention(RetentionPolicy.SOURCE)
3524 public @interface AccessUriMode {}
3525
3526 /**
3527 * Test if given mode flags specify an access mode, which must be at least
3528 * read and/or write.
3529 *
3530 * @hide
3531 */
3532 public static boolean isAccessUriMode(int modeFlags) {
3533 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3534 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3535 }
3536
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003537 /**
3538 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003539 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003540 * specified in its ClipData. When applying to an Intent's ClipData,
3541 * all URIs as well as recursive traversals through data or other ClipData
3542 * in Intent items will be granted; only the grant flags of the top-level
3543 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003544 */
3545 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3546 /**
3547 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003548 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003549 * specified in its ClipData. When applying to an Intent's ClipData,
3550 * all URIs as well as recursive traversals through data or other ClipData
3551 * in Intent items will be granted; only the grant flags of the top-level
3552 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 */
3554 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3555 /**
3556 * Can be set by the caller to indicate that this Intent is coming from
3557 * a background operation, not from direct user interaction.
3558 */
3559 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3560 /**
3561 * A flag you can enable for debugging: when set, log messages will be
3562 * printed during the resolution of this intent to show you what has
3563 * been found to create the final resolved list.
3564 */
3565 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003566 /**
3567 * If set, this intent will not match any components in packages that
3568 * are currently stopped. If this is not set, then the default behavior
3569 * is to include such applications in the result.
3570 */
3571 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3572 /**
3573 * If set, this intent will always match any components in packages that
3574 * are currently stopped. This is the default behavior when
3575 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3576 * flags are set, this one wins (it allows overriding of exclude for
3577 * places where the framework may automatically set the exclude flag).
3578 */
3579 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580
3581 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003582 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003583 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003584 * persisted across device reboots until explicitly revoked with
3585 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3586 * grant for possible persisting; the receiving application must call
3587 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3588 * actually persist.
3589 *
3590 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3591 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3592 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003593 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003594 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003595 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003596
3597 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003598 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3599 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3600 * applies to any URI that is a prefix match against the original granted
3601 * URI. (Without this flag, the URI must match exactly for access to be
3602 * granted.) Another URI is considered a prefix match only when scheme,
3603 * authority, and all path segments defined by the prefix are an exact
3604 * match.
3605 */
3606 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3607
3608 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003609 * If set, the new activity is not kept in the history stack. As soon as
3610 * the user navigates away from it, the activity is finished. This may also
3611 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3612 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 */
3614 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3615 /**
3616 * If set, the activity will not be launched if it is already running
3617 * at the top of the history stack.
3618 */
3619 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3620 /**
3621 * If set, this activity will become the start of a new task on this
3622 * history stack. A task (from the activity that started it to the
3623 * next task activity) defines an atomic group of activities that the
3624 * user can move to. Tasks can be moved to the foreground and background;
3625 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003626 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003627 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3628 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 *
3630 * <p>This flag is generally used by activities that want
3631 * to present a "launcher" style behavior: they give the user a list of
3632 * separate things that can be done, which otherwise run completely
3633 * independently of the activity launching them.
3634 *
3635 * <p>When using this flag, if a task is already running for the activity
3636 * you are now starting, then a new activity will not be started; instead,
3637 * the current task will simply be brought to the front of the screen with
3638 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3639 * to disable this behavior.
3640 *
3641 * <p>This flag can not be used when the caller is requesting a result from
3642 * the activity being launched.
3643 */
3644 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3645 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003646 * This flag is used to create a new task and launch an activity into it.
3647 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3648 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3649 * search through existing tasks for ones matching this Intent. Only if no such
3650 * task is found would a new task be created. When paired with
3651 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3652 * the search for a matching task and unconditionally start a new task.
3653 *
3654 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3655 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 * top-level application launcher.</strong> Used in conjunction with
3657 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3658 * behavior of bringing an existing task to the foreground. When set,
3659 * a new task is <em>always</em> started to host the Activity for the
3660 * Intent, regardless of whether there is already an existing task running
3661 * the same thing.
3662 *
3663 * <p><strong>Because the default system does not include graphical task management,
3664 * you should not use this flag unless you provide some way for a user to
3665 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003666 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003667 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3668 * creating new document tasks.
3669 *
3670 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3671 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003672 *
Scott Main7aee61f2011-02-08 11:25:01 -08003673 * <p>See
3674 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3675 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003676 *
3677 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3678 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003679 */
3680 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3681 /**
3682 * If set, and the activity being launched is already running in the
3683 * current task, then instead of launching a new instance of that activity,
3684 * all of the other activities on top of it will be closed and this Intent
3685 * will be delivered to the (now on top) old activity as a new Intent.
3686 *
3687 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3688 * If D calls startActivity() with an Intent that resolves to the component
3689 * of activity B, then C and D will be finished and B receive the given
3690 * Intent, resulting in the stack now being: A, B.
3691 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003692 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003693 * either receive the new intent you are starting here in its
3694 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003695 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003696 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3697 * the same intent, then it will be finished and re-created; for all other
3698 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3699 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003700 *
3701 * <p>This launch mode can also be used to good effect in conjunction with
3702 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3703 * of a task, it will bring any currently running instance of that task
3704 * to the foreground, and then clear it to its root state. This is
3705 * especially useful, for example, when launching an activity from the
3706 * notification manager.
3707 *
Scott Main7aee61f2011-02-08 11:25:01 -08003708 * <p>See
3709 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3710 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 */
3712 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3713 /**
3714 * If set and this intent is being used to launch a new activity from an
3715 * existing one, then the reply target of the existing activity will be
3716 * transfered to the new activity. This way the new activity can call
3717 * {@link android.app.Activity#setResult} and have that result sent back to
3718 * the reply target of the original activity.
3719 */
3720 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3721 /**
3722 * If set and this intent is being used to launch a new activity from an
3723 * existing one, the current activity will not be counted as the top
3724 * activity for deciding whether the new intent should be delivered to
3725 * the top instead of starting a new one. The previous activity will
3726 * be used as the top, with the assumption being that the current activity
3727 * will finish itself immediately.
3728 */
3729 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3730 /**
3731 * If set, the new activity is not kept in the list of recently launched
3732 * activities.
3733 */
3734 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3735 /**
3736 * This flag is not normally set by application code, but set for you by
3737 * the system as described in the
3738 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3739 * launchMode} documentation for the singleTask mode.
3740 */
3741 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3742 /**
3743 * If set, and this activity is either being started in a new task or
3744 * bringing to the top an existing task, then it will be launched as
3745 * the front door of the task. This will result in the application of
3746 * any affinities needed to have that task in the proper state (either
3747 * moving activities to or from it), or simply resetting that task to
3748 * its initial state if needed.
3749 */
3750 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3751 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003752 * This flag is not normally set by application code, but set for you by
3753 * the system if this activity is being launched from history
3754 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003755 */
3756 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003757 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003758 * @deprecated As of API 21 this performs identically to
3759 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003760 */
3761 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003762 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003763 * This flag is used to open a document into a new task rooted at the activity launched
3764 * by this Intent. Through the use of this flag, or its equivalent attribute,
3765 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3766 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003767 *
Craig Mautner026596b2014-05-21 15:35:44 -07003768 * <p>The use of the activity attribute form of this,
3769 * {@link android.R.attr#documentLaunchMode}, is
3770 * preferred over the Intent flag described here. The attribute form allows the
3771 * Activity to specify multiple document behavior for all launchers of the Activity
3772 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003773 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003774 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3775 * it is kept after the activity is finished is different than the use of
3776 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3777 * this flag is being used to create a new recents entry, then by default that entry
3778 * will be removed once the activity is finished. You can modify this behavior with
3779 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3780 *
Craig Mautner026596b2014-05-21 15:35:44 -07003781 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3782 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3783 * equivalent of the Activity manifest specifying {@link
3784 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3785 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3786 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003787 *
Craig Mautner026596b2014-05-21 15:35:44 -07003788 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003789 *
Craig Mautner026596b2014-05-21 15:35:44 -07003790 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003791 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3792 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003793 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003794 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003795 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003796 * callback from occurring on the current frontmost activity before it is
3797 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003798 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003799 * <p>Typically, an activity can rely on that callback to indicate that an
3800 * explicit user action has caused their activity to be moved out of the
3801 * foreground. The callback marks an appropriate point in the activity's
3802 * lifecycle for it to dismiss any notifications that it intends to display
3803 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003804 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003805 * <p>If an activity is ever started via any non-user-driven events such as
3806 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3807 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003808 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003809 */
3810 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003811 /**
3812 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3813 * this flag will cause the launched activity to be brought to the front of its
3814 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003815 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003816 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3817 * If D calls startActivity() with an Intent that resolves to the component
3818 * of activity B, then B will be brought to the front of the history stack,
3819 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003820 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003821 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003822 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003823 */
3824 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003826 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3827 * this flag will prevent the system from applying an activity transition
3828 * animation to go to the next activity state. This doesn't mean an
3829 * animation will never run -- if another activity change happens that doesn't
3830 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003831 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003832 * when you are going to do a series of activity operations but the
3833 * animation seen by the user shouldn't be driven by the first activity
3834 * change but rather a later one.
3835 */
3836 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3837 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003838 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3839 * this flag will cause any existing task that would be associated with the
3840 * activity to be cleared before the activity is started. That is, the activity
3841 * becomes the new root of an otherwise empty task, and any old activities
3842 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3843 */
3844 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3845 /**
3846 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3847 * this flag will cause a newly launching task to be placed on top of the current
3848 * home activity task (if there is one). That is, pressing back from the task
3849 * will always return the user to home even if that was not the last activity they
3850 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3851 */
3852 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3853 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003854 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3855 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003856 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003857 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003858 * this flag. When set and the task's activity is finished, the recents
3859 * entry will remain in the interface for the user to re-launch it, like a
3860 * recents entry for a top-level application.
3861 * <p>
3862 * The receiving activity can override this request with
3863 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3864 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003865 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003866 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003867 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003868
3869 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003870 * If set, when sending a broadcast only registered receivers will be
3871 * called -- no BroadcastReceiver components will be launched.
3872 */
3873 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003874 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003875 * If set, when sending a broadcast the new broadcast will replace
3876 * any existing pending broadcast that matches it. Matching is defined
3877 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3878 * true for the intents of the two broadcasts. When a match is found,
3879 * the new broadcast (and receivers associated with it) will replace the
3880 * existing one in the pending broadcast list, remaining at the same
3881 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003882 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003883 * <p>This flag is most typically used with sticky broadcasts, which
3884 * only care about delivering the most recent values of the broadcast
3885 * to their receivers.
3886 */
3887 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3888 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003889 * If set, when sending a broadcast the recipient is allowed to run at
3890 * foreground priority, with a shorter timeout interval. During normal
3891 * broadcasts the receivers are not automatically hoisted out of the
3892 * background priority class.
3893 */
3894 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3895 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003896 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3897 * They can still propagate results through to later receivers, but they can not prevent
3898 * later receivers from seeing the broadcast.
3899 */
3900 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3901 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003902 * If set, when sending a broadcast <i>before boot has completed</i> only
3903 * registered receivers will be called -- no BroadcastReceiver components
3904 * will be launched. Sticky intent state will be recorded properly even
3905 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3906 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003907 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003908 * <p>This flag is only for use by system sevices as a convenience to
3909 * avoid having to implement a more complex mechanism around detection
3910 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003911 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003912 * @hide
3913 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003914 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003915 /**
3916 * Set when this broadcast is for a boot upgrade, a special mode that
3917 * allows the broadcast to be sent before the system is ready and launches
3918 * the app process with no providers running in it.
3919 * @hide
3920 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003921 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003923 /**
3924 * @hide Flags that can't be changed with PendingIntent.
3925 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003926 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3927 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3928 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003929
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003930 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003931 // ---------------------------------------------------------------------
3932 // toUri() and parseUri() options.
3933
3934 /**
3935 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3936 * always has the "intent:" scheme. This syntax can be used when you want
3937 * to later disambiguate between URIs that are intended to describe an
3938 * Intent vs. all others that should be treated as raw URIs. When used
3939 * with {@link #parseUri}, any other scheme will result in a generic
3940 * VIEW action for that raw URI.
3941 */
3942 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003943
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003944 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945
3946 private String mAction;
3947 private Uri mData;
3948 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003949 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003950 private ComponentName mComponent;
3951 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003952 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003954 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003955 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003956 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003957 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958
3959 // ---------------------------------------------------------------------
3960
3961 /**
3962 * Create an empty intent.
3963 */
3964 public Intent() {
3965 }
3966
3967 /**
3968 * Copy constructor.
3969 */
3970 public Intent(Intent o) {
3971 this.mAction = o.mAction;
3972 this.mData = o.mData;
3973 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003974 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 this.mComponent = o.mComponent;
3976 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003977 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003978 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003979 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003980 }
3981 if (o.mExtras != null) {
3982 this.mExtras = new Bundle(o.mExtras);
3983 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003984 if (o.mSourceBounds != null) {
3985 this.mSourceBounds = new Rect(o.mSourceBounds);
3986 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003987 if (o.mSelector != null) {
3988 this.mSelector = new Intent(o.mSelector);
3989 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003990 if (o.mClipData != null) {
3991 this.mClipData = new ClipData(o.mClipData);
3992 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003993 }
3994
3995 @Override
3996 public Object clone() {
3997 return new Intent(this);
3998 }
3999
4000 private Intent(Intent o, boolean all) {
4001 this.mAction = o.mAction;
4002 this.mData = o.mData;
4003 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004004 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004005 this.mComponent = o.mComponent;
4006 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004007 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004008 }
4009 }
4010
4011 /**
4012 * Make a clone of only the parts of the Intent that are relevant for
4013 * filter matching: the action, data, type, component, and categories.
4014 */
4015 public Intent cloneFilter() {
4016 return new Intent(this, false);
4017 }
4018
4019 /**
4020 * Create an intent with a given action. All other fields (data, type,
4021 * class) are null. Note that the action <em>must</em> be in a
4022 * namespace because Intents are used globally in the system -- for
4023 * example the system VIEW action is android.intent.action.VIEW; an
4024 * application's custom action would be something like
4025 * com.google.app.myapp.CUSTOM_ACTION.
4026 *
4027 * @param action The Intent action, such as ACTION_VIEW.
4028 */
4029 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004030 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004031 }
4032
4033 /**
4034 * Create an intent with a given action and for a given data url. Note
4035 * that the action <em>must</em> be in a namespace because Intents are
4036 * used globally in the system -- for example the system VIEW action is
4037 * android.intent.action.VIEW; an application's custom action would be
4038 * something like com.google.app.myapp.CUSTOM_ACTION.
4039 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004040 * <p><em>Note: scheme and host name matching in the Android framework is
4041 * case-sensitive, unlike the formal RFC. As a result,
4042 * you should always ensure that you write your Uri with these elements
4043 * using lower case letters, and normalize any Uris you receive from
4044 * outside of Android to ensure the scheme and host is lower case.</em></p>
4045 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004046 * @param action The Intent action, such as ACTION_VIEW.
4047 * @param uri The Intent data URI.
4048 */
4049 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004050 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004051 mData = uri;
4052 }
4053
4054 /**
4055 * Create an intent for a specific component. All other fields (action, data,
4056 * type, class) are null, though they can be modified later with explicit
4057 * calls. This provides a convenient way to create an intent that is
4058 * intended to execute a hard-coded class name, rather than relying on the
4059 * system to find an appropriate class for you; see {@link #setComponent}
4060 * for more information on the repercussions of this.
4061 *
4062 * @param packageContext A Context of the application package implementing
4063 * this class.
4064 * @param cls The component class that is to be used for the intent.
4065 *
4066 * @see #setClass
4067 * @see #setComponent
4068 * @see #Intent(String, android.net.Uri , Context, Class)
4069 */
4070 public Intent(Context packageContext, Class<?> cls) {
4071 mComponent = new ComponentName(packageContext, cls);
4072 }
4073
4074 /**
4075 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004076 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004077 * construct the Intent and then calling {@link #setClass} to set its
4078 * class.
4079 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004080 * <p><em>Note: scheme and host name matching in the Android framework is
4081 * case-sensitive, unlike the formal RFC. As a result,
4082 * you should always ensure that you write your Uri with these elements
4083 * using lower case letters, and normalize any Uris you receive from
4084 * outside of Android to ensure the scheme and host is lower case.</em></p>
4085 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004086 * @param action The Intent action, such as ACTION_VIEW.
4087 * @param uri The Intent data URI.
4088 * @param packageContext A Context of the application package implementing
4089 * this class.
4090 * @param cls The component class that is to be used for the intent.
4091 *
4092 * @see #Intent(String, android.net.Uri)
4093 * @see #Intent(Context, Class)
4094 * @see #setClass
4095 * @see #setComponent
4096 */
4097 public Intent(String action, Uri uri,
4098 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004099 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004100 mData = uri;
4101 mComponent = new ComponentName(packageContext, cls);
4102 }
4103
4104 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004105 * Create an intent to launch the main (root) activity of a task. This
4106 * is the Intent that is started when the application's is launched from
4107 * Home. For anything else that wants to launch an application in the
4108 * same way, it is important that they use an Intent structured the same
4109 * way, and can use this function to ensure this is the case.
4110 *
4111 * <p>The returned Intent has the given Activity component as its explicit
4112 * component, {@link #ACTION_MAIN} as its action, and includes the
4113 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4114 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4115 * to do that through {@link #addFlags(int)} on the returned Intent.
4116 *
4117 * @param mainActivity The main activity component that this Intent will
4118 * launch.
4119 * @return Returns a newly created Intent that can be used to launch the
4120 * activity as a main application entry.
4121 *
4122 * @see #setClass
4123 * @see #setComponent
4124 */
4125 public static Intent makeMainActivity(ComponentName mainActivity) {
4126 Intent intent = new Intent(ACTION_MAIN);
4127 intent.setComponent(mainActivity);
4128 intent.addCategory(CATEGORY_LAUNCHER);
4129 return intent;
4130 }
4131
4132 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004133 * Make an Intent for the main activity of an application, without
4134 * specifying a specific activity to run but giving a selector to find
4135 * the activity. This results in a final Intent that is structured
4136 * the same as when the application is launched from
4137 * Home. For anything else that wants to launch an application in the
4138 * same way, it is important that they use an Intent structured the same
4139 * way, and can use this function to ensure this is the case.
4140 *
4141 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4142 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4143 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4144 * to do that through {@link #addFlags(int)} on the returned Intent.
4145 *
4146 * @param selectorAction The action name of the Intent's selector.
4147 * @param selectorCategory The name of a category to add to the Intent's
4148 * selector.
4149 * @return Returns a newly created Intent that can be used to launch the
4150 * activity as a main application entry.
4151 *
4152 * @see #setSelector(Intent)
4153 */
4154 public static Intent makeMainSelectorActivity(String selectorAction,
4155 String selectorCategory) {
4156 Intent intent = new Intent(ACTION_MAIN);
4157 intent.addCategory(CATEGORY_LAUNCHER);
4158 Intent selector = new Intent();
4159 selector.setAction(selectorAction);
4160 selector.addCategory(selectorCategory);
4161 intent.setSelector(selector);
4162 return intent;
4163 }
4164
4165 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004166 * Make an Intent that can be used to re-launch an application's task
4167 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4168 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4169 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4170 *
4171 * @param mainActivity The activity component that is the root of the
4172 * task; this is the activity that has been published in the application's
4173 * manifest as the main launcher icon.
4174 *
4175 * @return Returns a newly created Intent that can be used to relaunch the
4176 * activity's task in its root state.
4177 */
4178 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4179 Intent intent = makeMainActivity(mainActivity);
4180 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4181 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4182 return intent;
4183 }
4184
4185 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004186 * Call {@link #parseUri} with 0 flags.
4187 * @deprecated Use {@link #parseUri} instead.
4188 */
4189 @Deprecated
4190 public static Intent getIntent(String uri) throws URISyntaxException {
4191 return parseUri(uri, 0);
4192 }
Tom Taylord4a47292009-12-21 13:59:18 -08004193
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004194 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004195 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004196 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004197 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004198 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004199 *
4200 * <p>The URI given here must not be relative -- that is, it must include
4201 * the scheme and full path.
4202 *
4203 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004204 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004205 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206 *
4207 * @return Intent The newly created Intent object.
4208 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004209 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4210 * it bad (as parsed by the Uri class) or the Intent data within the
4211 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004212 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004213 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004214 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004215 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004216 int i = 0;
4217 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004218 // Validate intent scheme for if requested.
4219 if ((flags&URI_INTENT_SCHEME) != 0) {
4220 if (!uri.startsWith("intent:")) {
4221 Intent intent = new Intent(ACTION_VIEW);
4222 try {
4223 intent.setData(Uri.parse(uri));
4224 } catch (IllegalArgumentException e) {
4225 throw new URISyntaxException(uri, e.getMessage());
4226 }
4227 return intent;
4228 }
4229 }
Tom Taylord4a47292009-12-21 13:59:18 -08004230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231 // simple case
4232 i = uri.lastIndexOf("#");
4233 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4234
4235 // old format Intent URI
4236 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004238 // new format
4239 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004240 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004241
4242 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004243 String data = i >= 0 ? uri.substring(0, i) : null;
4244 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004245 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004246
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004247 // loop over contents of Intent, all name=value;
4248 while (!uri.startsWith("end", i)) {
4249 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004250 if (eq < 0) eq = i-1;
4251 int semi = uri.indexOf(';', i);
4252 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004253
4254 // action
4255 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004256 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004257 }
4258
4259 // categories
4260 else if (uri.startsWith("category=", i)) {
4261 intent.addCategory(value);
4262 }
4263
4264 // type
4265 else if (uri.startsWith("type=", i)) {
4266 intent.mType = value;
4267 }
4268
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004269 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004270 else if (uri.startsWith("launchFlags=", i)) {
4271 intent.mFlags = Integer.decode(value).intValue();
4272 }
4273
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004274 // package
4275 else if (uri.startsWith("package=", i)) {
4276 intent.mPackage = value;
4277 }
4278
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004279 // component
4280 else if (uri.startsWith("component=", i)) {
4281 intent.mComponent = ComponentName.unflattenFromString(value);
4282 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004283
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004284 // scheme
4285 else if (uri.startsWith("scheme=", i)) {
4286 scheme = value;
4287 }
4288
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004289 // source bounds
4290 else if (uri.startsWith("sourceBounds=", i)) {
4291 intent.mSourceBounds = Rect.unflattenFromString(value);
4292 }
4293
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004294 // selector
4295 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4296 intent = new Intent();
4297 }
4298
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004299 // extra
4300 else {
4301 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004302 // create Bundle if it doesn't already exist
4303 if (intent.mExtras == null) intent.mExtras = new Bundle();
4304 Bundle b = intent.mExtras;
4305 // add EXTRA
4306 if (uri.startsWith("S.", i)) b.putString(key, value);
4307 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4308 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4309 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4310 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4311 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4312 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4313 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4314 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4315 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4316 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004317
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004318 // move to the next item
4319 i = semi + 1;
4320 }
4321
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004322 if (intent != baseIntent) {
4323 // The Intent had a selector; fix it up.
4324 baseIntent.setSelector(intent);
4325 intent = baseIntent;
4326 }
4327
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004328 if (data != null) {
4329 if (data.startsWith("intent:")) {
4330 data = data.substring(7);
4331 if (scheme != null) {
4332 data = scheme + ':' + data;
4333 }
4334 }
Tom Taylord4a47292009-12-21 13:59:18 -08004335
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004336 if (data.length() > 0) {
4337 try {
4338 intent.mData = Uri.parse(data);
4339 } catch (IllegalArgumentException e) {
4340 throw new URISyntaxException(uri, e.getMessage());
4341 }
4342 }
4343 }
Tom Taylord4a47292009-12-21 13:59:18 -08004344
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004345 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004346
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004347 } catch (IndexOutOfBoundsException e) {
4348 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4349 }
4350 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004351
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004352 public static Intent getIntentOld(String uri) throws URISyntaxException {
4353 Intent intent;
4354
4355 int i = uri.lastIndexOf('#');
4356 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004357 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004358 final int intentFragmentStart = i;
4359 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004360
4361 i++;
4362
4363 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004364 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004365 i += 7;
4366 int j = uri.indexOf(')', i);
4367 action = uri.substring(i, j);
4368 i = j + 1;
4369 }
4370
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004371 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004372
4373 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004374 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004375 i += 11;
4376 int j = uri.indexOf(')', i);
4377 while (i < j) {
4378 int sep = uri.indexOf('!', i);
4379 if (sep < 0) sep = j;
4380 if (i < sep) {
4381 intent.addCategory(uri.substring(i, sep));
4382 }
4383 i = sep + 1;
4384 }
4385 i = j + 1;
4386 }
4387
4388 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004389 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004390 i += 5;
4391 int j = uri.indexOf(')', i);
4392 intent.mType = uri.substring(i, j);
4393 i = j + 1;
4394 }
4395
4396 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004397 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004398 i += 12;
4399 int j = uri.indexOf(')', i);
4400 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4401 i = j + 1;
4402 }
4403
4404 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004405 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004406 i += 10;
4407 int j = uri.indexOf(')', i);
4408 int sep = uri.indexOf('!', i);
4409 if (sep >= 0 && sep < j) {
4410 String pkg = uri.substring(i, sep);
4411 String cls = uri.substring(sep + 1, j);
4412 intent.mComponent = new ComponentName(pkg, cls);
4413 }
4414 i = j + 1;
4415 }
4416
4417 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004418 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004419 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004420
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004421 final int closeParen = uri.indexOf(')', i);
4422 if (closeParen == -1) throw new URISyntaxException(uri,
4423 "EXTRA missing trailing ')'", i);
4424
4425 while (i < closeParen) {
4426 // fetch the key value
4427 int j = uri.indexOf('=', i);
4428 if (j <= i + 1 || i >= closeParen) {
4429 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4430 }
4431 char type = uri.charAt(i);
4432 i++;
4433 String key = uri.substring(i, j);
4434 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004435
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004436 // get type-value
4437 j = uri.indexOf('!', i);
4438 if (j == -1 || j >= closeParen) j = closeParen;
4439 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4440 String value = uri.substring(i, j);
4441 i = j;
4442
4443 // create Bundle if it doesn't already exist
4444 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004445
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004446 // add item to bundle
4447 try {
4448 switch (type) {
4449 case 'S':
4450 intent.mExtras.putString(key, Uri.decode(value));
4451 break;
4452 case 'B':
4453 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4454 break;
4455 case 'b':
4456 intent.mExtras.putByte(key, Byte.parseByte(value));
4457 break;
4458 case 'c':
4459 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4460 break;
4461 case 'd':
4462 intent.mExtras.putDouble(key, Double.parseDouble(value));
4463 break;
4464 case 'f':
4465 intent.mExtras.putFloat(key, Float.parseFloat(value));
4466 break;
4467 case 'i':
4468 intent.mExtras.putInt(key, Integer.parseInt(value));
4469 break;
4470 case 'l':
4471 intent.mExtras.putLong(key, Long.parseLong(value));
4472 break;
4473 case 's':
4474 intent.mExtras.putShort(key, Short.parseShort(value));
4475 break;
4476 default:
4477 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4478 }
4479 } catch (NumberFormatException e) {
4480 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4481 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004482
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004483 char ch = uri.charAt(i);
4484 if (ch == ')') break;
4485 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4486 i++;
4487 }
4488 }
4489
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004490 if (isIntentFragment) {
4491 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4492 } else {
4493 intent.mData = Uri.parse(uri);
4494 }
Tom Taylord4a47292009-12-21 13:59:18 -08004495
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004496 if (intent.mAction == null) {
4497 // By default, if no action is specified, then use VIEW.
4498 intent.mAction = ACTION_VIEW;
4499 }
4500
4501 } else {
4502 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4503 }
4504
4505 return intent;
4506 }
4507
4508 /**
4509 * Retrieve the general action to be performed, such as
4510 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4511 * the information in the intent should be interpreted -- most importantly,
4512 * what to do with the data returned by {@link #getData}.
4513 *
4514 * @return The action of this intent or null if none is specified.
4515 *
4516 * @see #setAction
4517 */
4518 public String getAction() {
4519 return mAction;
4520 }
4521
4522 /**
4523 * Retrieve data this intent is operating on. This URI specifies the name
4524 * of the data; often it uses the content: scheme, specifying data in a
4525 * content provider. Other schemes may be handled by specific activities,
4526 * such as http: by the web browser.
4527 *
4528 * @return The URI of the data this intent is targeting or null.
4529 *
4530 * @see #getScheme
4531 * @see #setData
4532 */
4533 public Uri getData() {
4534 return mData;
4535 }
4536
4537 /**
4538 * The same as {@link #getData()}, but returns the URI as an encoded
4539 * String.
4540 */
4541 public String getDataString() {
4542 return mData != null ? mData.toString() : null;
4543 }
4544
4545 /**
4546 * Return the scheme portion of the intent's data. If the data is null or
4547 * does not include a scheme, null is returned. Otherwise, the scheme
4548 * prefix without the final ':' is returned, i.e. "http".
4549 *
4550 * <p>This is the same as calling getData().getScheme() (and checking for
4551 * null data).
4552 *
4553 * @return The scheme of this intent.
4554 *
4555 * @see #getData
4556 */
4557 public String getScheme() {
4558 return mData != null ? mData.getScheme() : null;
4559 }
4560
4561 /**
4562 * Retrieve any explicit MIME type included in the intent. This is usually
4563 * null, as the type is determined by the intent data.
4564 *
4565 * @return If a type was manually set, it is returned; else null is
4566 * returned.
4567 *
4568 * @see #resolveType(ContentResolver)
4569 * @see #setType
4570 */
4571 public String getType() {
4572 return mType;
4573 }
4574
4575 /**
4576 * Return the MIME data type of this intent. If the type field is
4577 * explicitly set, that is simply returned. Otherwise, if the data is set,
4578 * the type of that data is returned. If neither fields are set, a null is
4579 * returned.
4580 *
4581 * @return The MIME type of this intent.
4582 *
4583 * @see #getType
4584 * @see #resolveType(ContentResolver)
4585 */
4586 public String resolveType(Context context) {
4587 return resolveType(context.getContentResolver());
4588 }
4589
4590 /**
4591 * Return the MIME data type of this intent. If the type field is
4592 * explicitly set, that is simply returned. Otherwise, if the data is set,
4593 * the type of that data is returned. If neither fields are set, a null is
4594 * returned.
4595 *
4596 * @param resolver A ContentResolver that can be used to determine the MIME
4597 * type of the intent's data.
4598 *
4599 * @return The MIME type of this intent.
4600 *
4601 * @see #getType
4602 * @see #resolveType(Context)
4603 */
4604 public String resolveType(ContentResolver resolver) {
4605 if (mType != null) {
4606 return mType;
4607 }
4608 if (mData != null) {
4609 if ("content".equals(mData.getScheme())) {
4610 return resolver.getType(mData);
4611 }
4612 }
4613 return null;
4614 }
4615
4616 /**
4617 * Return the MIME data type of this intent, only if it will be needed for
4618 * intent resolution. This is not generally useful for application code;
4619 * it is used by the frameworks for communicating with back-end system
4620 * services.
4621 *
4622 * @param resolver A ContentResolver that can be used to determine the MIME
4623 * type of the intent's data.
4624 *
4625 * @return The MIME type of this intent, or null if it is unknown or not
4626 * needed.
4627 */
4628 public String resolveTypeIfNeeded(ContentResolver resolver) {
4629 if (mComponent != null) {
4630 return mType;
4631 }
4632 return resolveType(resolver);
4633 }
4634
4635 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004636 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004637 *
4638 * @param category The category to check.
4639 *
4640 * @return boolean True if the intent contains the category, else false.
4641 *
4642 * @see #getCategories
4643 * @see #addCategory
4644 */
4645 public boolean hasCategory(String category) {
4646 return mCategories != null && mCategories.contains(category);
4647 }
4648
4649 /**
4650 * Return the set of all categories in the intent. If there are no categories,
4651 * returns NULL.
4652 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004653 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004654 *
4655 * @see #hasCategory
4656 * @see #addCategory
4657 */
4658 public Set<String> getCategories() {
4659 return mCategories;
4660 }
4661
4662 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004663 * Return the specific selector associated with this Intent. If there is
4664 * none, returns null. See {@link #setSelector} for more information.
4665 *
4666 * @see #setSelector
4667 */
4668 public Intent getSelector() {
4669 return mSelector;
4670 }
4671
4672 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004673 * Return the {@link ClipData} associated with this Intent. If there is
4674 * none, returns null. See {@link #setClipData} for more information.
4675 *
John Spurlock125d1332013-11-25 11:58:37 -05004676 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004677 */
4678 public ClipData getClipData() {
4679 return mClipData;
4680 }
4681
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004682 /** @hide */
4683 public int getContentUserHint() {
4684 return mContentUserHint;
4685 }
4686
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004687 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004688 * Sets the ClassLoader that will be used when unmarshalling
4689 * any Parcelable values from the extras of this Intent.
4690 *
4691 * @param loader a ClassLoader, or null to use the default loader
4692 * at the time of unmarshalling.
4693 */
4694 public void setExtrasClassLoader(ClassLoader loader) {
4695 if (mExtras != null) {
4696 mExtras.setClassLoader(loader);
4697 }
4698 }
4699
4700 /**
4701 * Returns true if an extra value is associated with the given name.
4702 * @param name the extra's name
4703 * @return true if the given extra is present.
4704 */
4705 public boolean hasExtra(String name) {
4706 return mExtras != null && mExtras.containsKey(name);
4707 }
4708
4709 /**
4710 * Returns true if the Intent's extras contain a parcelled file descriptor.
4711 * @return true if the Intent contains a parcelled file descriptor.
4712 */
4713 public boolean hasFileDescriptors() {
4714 return mExtras != null && mExtras.hasFileDescriptors();
4715 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004716
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004717 /** @hide */
4718 public void setAllowFds(boolean allowFds) {
4719 if (mExtras != null) {
4720 mExtras.setAllowFds(allowFds);
4721 }
4722 }
4723
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004724 /**
4725 * Retrieve extended data from the intent.
4726 *
4727 * @param name The name of the desired item.
4728 *
4729 * @return the value of an item that previously added with putExtra()
4730 * or null if none was found.
4731 *
4732 * @deprecated
4733 * @hide
4734 */
4735 @Deprecated
4736 public Object getExtra(String name) {
4737 return getExtra(name, null);
4738 }
4739
4740 /**
4741 * Retrieve extended data from the intent.
4742 *
4743 * @param name The name of the desired item.
4744 * @param defaultValue the value to be returned if no value of the desired
4745 * type is stored with the given name.
4746 *
4747 * @return the value of an item that previously added with putExtra()
4748 * or the default value if none was found.
4749 *
4750 * @see #putExtra(String, boolean)
4751 */
4752 public boolean getBooleanExtra(String name, boolean defaultValue) {
4753 return mExtras == null ? defaultValue :
4754 mExtras.getBoolean(name, defaultValue);
4755 }
4756
4757 /**
4758 * Retrieve extended data from the intent.
4759 *
4760 * @param name The name of the desired item.
4761 * @param defaultValue the value to be returned if no value of the desired
4762 * type is stored with the given name.
4763 *
4764 * @return the value of an item that previously added with putExtra()
4765 * or the default value if none was found.
4766 *
4767 * @see #putExtra(String, byte)
4768 */
4769 public byte getByteExtra(String name, byte defaultValue) {
4770 return mExtras == null ? defaultValue :
4771 mExtras.getByte(name, defaultValue);
4772 }
4773
4774 /**
4775 * Retrieve extended data from the intent.
4776 *
4777 * @param name The name of the desired item.
4778 * @param defaultValue the value to be returned if no value of the desired
4779 * type is stored with the given name.
4780 *
4781 * @return the value of an item that previously added with putExtra()
4782 * or the default value if none was found.
4783 *
4784 * @see #putExtra(String, short)
4785 */
4786 public short getShortExtra(String name, short defaultValue) {
4787 return mExtras == null ? defaultValue :
4788 mExtras.getShort(name, defaultValue);
4789 }
4790
4791 /**
4792 * Retrieve extended data from the intent.
4793 *
4794 * @param name The name of the desired item.
4795 * @param defaultValue the value to be returned if no value of the desired
4796 * type is stored with the given name.
4797 *
4798 * @return the value of an item that previously added with putExtra()
4799 * or the default value if none was found.
4800 *
4801 * @see #putExtra(String, char)
4802 */
4803 public char getCharExtra(String name, char defaultValue) {
4804 return mExtras == null ? defaultValue :
4805 mExtras.getChar(name, defaultValue);
4806 }
4807
4808 /**
4809 * Retrieve extended data from the intent.
4810 *
4811 * @param name The name of the desired item.
4812 * @param defaultValue the value to be returned if no value of the desired
4813 * type is stored with the given name.
4814 *
4815 * @return the value of an item that previously added with putExtra()
4816 * or the default value if none was found.
4817 *
4818 * @see #putExtra(String, int)
4819 */
4820 public int getIntExtra(String name, int defaultValue) {
4821 return mExtras == null ? defaultValue :
4822 mExtras.getInt(name, defaultValue);
4823 }
4824
4825 /**
4826 * Retrieve extended data from the intent.
4827 *
4828 * @param name The name of the desired item.
4829 * @param defaultValue the value to be returned if no value of the desired
4830 * type is stored with the given name.
4831 *
4832 * @return the value of an item that previously added with putExtra()
4833 * or the default value if none was found.
4834 *
4835 * @see #putExtra(String, long)
4836 */
4837 public long getLongExtra(String name, long defaultValue) {
4838 return mExtras == null ? defaultValue :
4839 mExtras.getLong(name, defaultValue);
4840 }
4841
4842 /**
4843 * Retrieve extended data from the intent.
4844 *
4845 * @param name The name of the desired item.
4846 * @param defaultValue the value to be returned if no value of the desired
4847 * type is stored with the given name.
4848 *
4849 * @return the value of an item that previously added with putExtra(),
4850 * or the default value if no such item is present
4851 *
4852 * @see #putExtra(String, float)
4853 */
4854 public float getFloatExtra(String name, float defaultValue) {
4855 return mExtras == null ? defaultValue :
4856 mExtras.getFloat(name, defaultValue);
4857 }
4858
4859 /**
4860 * Retrieve extended data from the intent.
4861 *
4862 * @param name The name of the desired item.
4863 * @param defaultValue the value to be returned if no value of the desired
4864 * type is stored with the given name.
4865 *
4866 * @return the value of an item that previously added with putExtra()
4867 * or the default value if none was found.
4868 *
4869 * @see #putExtra(String, double)
4870 */
4871 public double getDoubleExtra(String name, double defaultValue) {
4872 return mExtras == null ? defaultValue :
4873 mExtras.getDouble(name, defaultValue);
4874 }
4875
4876 /**
4877 * Retrieve extended data from the intent.
4878 *
4879 * @param name The name of the desired item.
4880 *
4881 * @return the value of an item that previously added with putExtra()
4882 * or null if no String value was found.
4883 *
4884 * @see #putExtra(String, String)
4885 */
4886 public String getStringExtra(String name) {
4887 return mExtras == null ? null : mExtras.getString(name);
4888 }
4889
4890 /**
4891 * Retrieve extended data from the intent.
4892 *
4893 * @param name The name of the desired item.
4894 *
4895 * @return the value of an item that previously added with putExtra()
4896 * or null if no CharSequence value was found.
4897 *
4898 * @see #putExtra(String, CharSequence)
4899 */
4900 public CharSequence getCharSequenceExtra(String name) {
4901 return mExtras == null ? null : mExtras.getCharSequence(name);
4902 }
4903
4904 /**
4905 * Retrieve extended data from the intent.
4906 *
4907 * @param name The name of the desired item.
4908 *
4909 * @return the value of an item that previously added with putExtra()
4910 * or null if no Parcelable value was found.
4911 *
4912 * @see #putExtra(String, Parcelable)
4913 */
4914 public <T extends Parcelable> T getParcelableExtra(String name) {
4915 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4916 }
4917
4918 /**
4919 * Retrieve extended data from the intent.
4920 *
4921 * @param name The name of the desired item.
4922 *
4923 * @return the value of an item that previously added with putExtra()
4924 * or null if no Parcelable[] value was found.
4925 *
4926 * @see #putExtra(String, Parcelable[])
4927 */
4928 public Parcelable[] getParcelableArrayExtra(String name) {
4929 return mExtras == null ? null : mExtras.getParcelableArray(name);
4930 }
4931
4932 /**
4933 * Retrieve extended data from the intent.
4934 *
4935 * @param name The name of the desired item.
4936 *
4937 * @return the value of an item that previously added with putExtra()
4938 * or null if no ArrayList<Parcelable> value was found.
4939 *
4940 * @see #putParcelableArrayListExtra(String, ArrayList)
4941 */
4942 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4943 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4944 }
4945
4946 /**
4947 * Retrieve extended data from the intent.
4948 *
4949 * @param name The name of the desired item.
4950 *
4951 * @return the value of an item that previously added with putExtra()
4952 * or null if no Serializable value was found.
4953 *
4954 * @see #putExtra(String, Serializable)
4955 */
4956 public Serializable getSerializableExtra(String name) {
4957 return mExtras == null ? null : mExtras.getSerializable(name);
4958 }
4959
4960 /**
4961 * Retrieve extended data from the intent.
4962 *
4963 * @param name The name of the desired item.
4964 *
4965 * @return the value of an item that previously added with putExtra()
4966 * or null if no ArrayList<Integer> value was found.
4967 *
4968 * @see #putIntegerArrayListExtra(String, ArrayList)
4969 */
4970 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4971 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4972 }
4973
4974 /**
4975 * Retrieve extended data from the intent.
4976 *
4977 * @param name The name of the desired item.
4978 *
4979 * @return the value of an item that previously added with putExtra()
4980 * or null if no ArrayList<String> value was found.
4981 *
4982 * @see #putStringArrayListExtra(String, ArrayList)
4983 */
4984 public ArrayList<String> getStringArrayListExtra(String name) {
4985 return mExtras == null ? null : mExtras.getStringArrayList(name);
4986 }
4987
4988 /**
4989 * Retrieve extended data from the intent.
4990 *
4991 * @param name The name of the desired item.
4992 *
4993 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004994 * or null if no ArrayList<CharSequence> value was found.
4995 *
4996 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4997 */
4998 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4999 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5000 }
5001
5002 /**
5003 * Retrieve extended data from the intent.
5004 *
5005 * @param name The name of the desired item.
5006 *
5007 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005008 * or null if no boolean array value was found.
5009 *
5010 * @see #putExtra(String, boolean[])
5011 */
5012 public boolean[] getBooleanArrayExtra(String name) {
5013 return mExtras == null ? null : mExtras.getBooleanArray(name);
5014 }
5015
5016 /**
5017 * Retrieve extended data from the intent.
5018 *
5019 * @param name The name of the desired item.
5020 *
5021 * @return the value of an item that previously added with putExtra()
5022 * or null if no byte array value was found.
5023 *
5024 * @see #putExtra(String, byte[])
5025 */
5026 public byte[] getByteArrayExtra(String name) {
5027 return mExtras == null ? null : mExtras.getByteArray(name);
5028 }
5029
5030 /**
5031 * Retrieve extended data from the intent.
5032 *
5033 * @param name The name of the desired item.
5034 *
5035 * @return the value of an item that previously added with putExtra()
5036 * or null if no short array value was found.
5037 *
5038 * @see #putExtra(String, short[])
5039 */
5040 public short[] getShortArrayExtra(String name) {
5041 return mExtras == null ? null : mExtras.getShortArray(name);
5042 }
5043
5044 /**
5045 * Retrieve extended data from the intent.
5046 *
5047 * @param name The name of the desired item.
5048 *
5049 * @return the value of an item that previously added with putExtra()
5050 * or null if no char array value was found.
5051 *
5052 * @see #putExtra(String, char[])
5053 */
5054 public char[] getCharArrayExtra(String name) {
5055 return mExtras == null ? null : mExtras.getCharArray(name);
5056 }
5057
5058 /**
5059 * Retrieve extended data from the intent.
5060 *
5061 * @param name The name of the desired item.
5062 *
5063 * @return the value of an item that previously added with putExtra()
5064 * or null if no int array value was found.
5065 *
5066 * @see #putExtra(String, int[])
5067 */
5068 public int[] getIntArrayExtra(String name) {
5069 return mExtras == null ? null : mExtras.getIntArray(name);
5070 }
5071
5072 /**
5073 * Retrieve extended data from the intent.
5074 *
5075 * @param name The name of the desired item.
5076 *
5077 * @return the value of an item that previously added with putExtra()
5078 * or null if no long array value was found.
5079 *
5080 * @see #putExtra(String, long[])
5081 */
5082 public long[] getLongArrayExtra(String name) {
5083 return mExtras == null ? null : mExtras.getLongArray(name);
5084 }
5085
5086 /**
5087 * Retrieve extended data from the intent.
5088 *
5089 * @param name The name of the desired item.
5090 *
5091 * @return the value of an item that previously added with putExtra()
5092 * or null if no float array value was found.
5093 *
5094 * @see #putExtra(String, float[])
5095 */
5096 public float[] getFloatArrayExtra(String name) {
5097 return mExtras == null ? null : mExtras.getFloatArray(name);
5098 }
5099
5100 /**
5101 * Retrieve extended data from the intent.
5102 *
5103 * @param name The name of the desired item.
5104 *
5105 * @return the value of an item that previously added with putExtra()
5106 * or null if no double array value was found.
5107 *
5108 * @see #putExtra(String, double[])
5109 */
5110 public double[] getDoubleArrayExtra(String name) {
5111 return mExtras == null ? null : mExtras.getDoubleArray(name);
5112 }
5113
5114 /**
5115 * Retrieve extended data from the intent.
5116 *
5117 * @param name The name of the desired item.
5118 *
5119 * @return the value of an item that previously added with putExtra()
5120 * or null if no String array value was found.
5121 *
5122 * @see #putExtra(String, String[])
5123 */
5124 public String[] getStringArrayExtra(String name) {
5125 return mExtras == null ? null : mExtras.getStringArray(name);
5126 }
5127
5128 /**
5129 * Retrieve extended data from the intent.
5130 *
5131 * @param name The name of the desired item.
5132 *
5133 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005134 * or null if no CharSequence array value was found.
5135 *
5136 * @see #putExtra(String, CharSequence[])
5137 */
5138 public CharSequence[] getCharSequenceArrayExtra(String name) {
5139 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5140 }
5141
5142 /**
5143 * Retrieve extended data from the intent.
5144 *
5145 * @param name The name of the desired item.
5146 *
5147 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005148 * or null if no Bundle value was found.
5149 *
5150 * @see #putExtra(String, Bundle)
5151 */
5152 public Bundle getBundleExtra(String name) {
5153 return mExtras == null ? null : mExtras.getBundle(name);
5154 }
5155
5156 /**
5157 * Retrieve extended data from the intent.
5158 *
5159 * @param name The name of the desired item.
5160 *
5161 * @return the value of an item that previously added with putExtra()
5162 * or null if no IBinder value was found.
5163 *
5164 * @see #putExtra(String, IBinder)
5165 *
5166 * @deprecated
5167 * @hide
5168 */
5169 @Deprecated
5170 public IBinder getIBinderExtra(String name) {
5171 return mExtras == null ? null : mExtras.getIBinder(name);
5172 }
5173
5174 /**
5175 * Retrieve extended data from the intent.
5176 *
5177 * @param name The name of the desired item.
5178 * @param defaultValue The default value to return in case no item is
5179 * associated with the key 'name'
5180 *
5181 * @return the value of an item that previously added with putExtra()
5182 * or defaultValue if none was found.
5183 *
5184 * @see #putExtra
5185 *
5186 * @deprecated
5187 * @hide
5188 */
5189 @Deprecated
5190 public Object getExtra(String name, Object defaultValue) {
5191 Object result = defaultValue;
5192 if (mExtras != null) {
5193 Object result2 = mExtras.get(name);
5194 if (result2 != null) {
5195 result = result2;
5196 }
5197 }
5198
5199 return result;
5200 }
5201
5202 /**
5203 * Retrieves a map of extended data from the intent.
5204 *
5205 * @return the map of all extras previously added with putExtra(),
5206 * or null if none have been added.
5207 */
5208 public Bundle getExtras() {
5209 return (mExtras != null)
5210 ? new Bundle(mExtras)
5211 : null;
5212 }
5213
5214 /**
5215 * Retrieve any special flags associated with this intent. You will
5216 * normally just set them with {@link #setFlags} and let the system
5217 * take the appropriate action with them.
5218 *
5219 * @return int The currently set flags.
5220 *
5221 * @see #setFlags
5222 */
5223 public int getFlags() {
5224 return mFlags;
5225 }
5226
Dianne Hackborne7f97212011-02-24 14:40:20 -08005227 /** @hide */
5228 public boolean isExcludingStopped() {
5229 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5230 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5231 }
5232
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005233 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005234 * Retrieve the application package name this Intent is limited to. When
5235 * resolving an Intent, if non-null this limits the resolution to only
5236 * components in the given application package.
5237 *
5238 * @return The name of the application package for the Intent.
5239 *
5240 * @see #resolveActivity
5241 * @see #setPackage
5242 */
5243 public String getPackage() {
5244 return mPackage;
5245 }
5246
5247 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005248 * Retrieve the concrete component associated with the intent. When receiving
5249 * an intent, this is the component that was found to best handle it (that is,
5250 * yourself) and will always be non-null; in all other cases it will be
5251 * null unless explicitly set.
5252 *
5253 * @return The name of the application component to handle the intent.
5254 *
5255 * @see #resolveActivity
5256 * @see #setComponent
5257 */
5258 public ComponentName getComponent() {
5259 return mComponent;
5260 }
5261
5262 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005263 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5264 * used as a hint to the receiver for animations and the like. Null means that there
5265 * is no source bounds.
5266 */
5267 public Rect getSourceBounds() {
5268 return mSourceBounds;
5269 }
5270
5271 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 * Return the Activity component that should be used to handle this intent.
5273 * The appropriate component is determined based on the information in the
5274 * intent, evaluated as follows:
5275 *
5276 * <p>If {@link #getComponent} returns an explicit class, that is returned
5277 * without any further consideration.
5278 *
5279 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5280 * category to be considered.
5281 *
5282 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5283 * action.
5284 *
5285 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5286 * this type.
5287 *
5288 * <p>If {@link #addCategory} has added any categories, the activity must
5289 * handle ALL of the categories specified.
5290 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005291 * <p>If {@link #getPackage} is non-NULL, only activity components in
5292 * that application package will be considered.
5293 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005294 * <p>If there are no activities that satisfy all of these conditions, a
5295 * null string is returned.
5296 *
5297 * <p>If multiple activities are found to satisfy the intent, the one with
5298 * the highest priority will be used. If there are multiple activities
5299 * with the same priority, the system will either pick the best activity
5300 * based on user preference, or resolve to a system class that will allow
5301 * the user to pick an activity and forward from there.
5302 *
5303 * <p>This method is implemented simply by calling
5304 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5305 * true.</p>
5306 * <p> This API is called for you as part of starting an activity from an
5307 * intent. You do not normally need to call it yourself.</p>
5308 *
5309 * @param pm The package manager with which to resolve the Intent.
5310 *
5311 * @return Name of the component implementing an activity that can
5312 * display the intent.
5313 *
5314 * @see #setComponent
5315 * @see #getComponent
5316 * @see #resolveActivityInfo
5317 */
5318 public ComponentName resolveActivity(PackageManager pm) {
5319 if (mComponent != null) {
5320 return mComponent;
5321 }
5322
5323 ResolveInfo info = pm.resolveActivity(
5324 this, PackageManager.MATCH_DEFAULT_ONLY);
5325 if (info != null) {
5326 return new ComponentName(
5327 info.activityInfo.applicationInfo.packageName,
5328 info.activityInfo.name);
5329 }
5330
5331 return null;
5332 }
5333
5334 /**
5335 * Resolve the Intent into an {@link ActivityInfo}
5336 * describing the activity that should execute the intent. Resolution
5337 * follows the same rules as described for {@link #resolveActivity}, but
5338 * you get back the completely information about the resolved activity
5339 * instead of just its class name.
5340 *
5341 * @param pm The package manager with which to resolve the Intent.
5342 * @param flags Addition information to retrieve as per
5343 * {@link PackageManager#getActivityInfo(ComponentName, int)
5344 * PackageManager.getActivityInfo()}.
5345 *
5346 * @return PackageManager.ActivityInfo
5347 *
5348 * @see #resolveActivity
5349 */
5350 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5351 ActivityInfo ai = null;
5352 if (mComponent != null) {
5353 try {
5354 ai = pm.getActivityInfo(mComponent, flags);
5355 } catch (PackageManager.NameNotFoundException e) {
5356 // ignore
5357 }
5358 } else {
5359 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005360 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005361 if (info != null) {
5362 ai = info.activityInfo;
5363 }
5364 }
5365
5366 return ai;
5367 }
5368
5369 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005370 * Special function for use by the system to resolve service
5371 * intents to system apps. Throws an exception if there are
5372 * multiple potential matches to the Intent. Returns null if
5373 * there are no matches.
5374 * @hide
5375 */
5376 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5377 if (mComponent != null) {
5378 return mComponent;
5379 }
5380
5381 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5382 if (results == null) {
5383 return null;
5384 }
5385 ComponentName comp = null;
5386 for (int i=0; i<results.size(); i++) {
5387 ResolveInfo ri = results.get(i);
5388 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5389 continue;
5390 }
5391 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5392 ri.serviceInfo.name);
5393 if (comp != null) {
5394 throw new IllegalStateException("Multiple system services handle " + this
5395 + ": " + comp + ", " + foundComp);
5396 }
5397 comp = foundComp;
5398 }
5399 return comp;
5400 }
5401
5402 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005403 * Set the general action to be performed.
5404 *
5405 * @param action An action name, such as ACTION_VIEW. Application-specific
5406 * actions should be prefixed with the vendor's package name.
5407 *
5408 * @return Returns the same Intent object, for chaining multiple calls
5409 * into a single statement.
5410 *
5411 * @see #getAction
5412 */
5413 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005414 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005415 return this;
5416 }
5417
5418 /**
5419 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005420 * clears any type that was previously set by {@link #setType} or
5421 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005422 *
Nick Pellyccae4122012-01-09 14:12:58 -08005423 * <p><em>Note: scheme matching in the Android framework is
5424 * case-sensitive, unlike the formal RFC. As a result,
5425 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005426 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005427 * {@link #setDataAndNormalize}
5428 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005429 *
Nick Pellyccae4122012-01-09 14:12:58 -08005430 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005431 *
5432 * @return Returns the same Intent object, for chaining multiple calls
5433 * into a single statement.
5434 *
5435 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005436 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005437 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005438 */
5439 public Intent setData(Uri data) {
5440 mData = data;
5441 mType = null;
5442 return this;
5443 }
5444
5445 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005446 * Normalize and set the data this intent is operating on.
5447 *
5448 * <p>This method automatically clears any type that was
5449 * previously set (for example, by {@link #setType}).
5450 *
5451 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005452 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005453 * so really this is just a convenience method for
5454 * <pre>
5455 * setData(data.normalize())
5456 * </pre>
5457 *
5458 * @param data The Uri of the data this intent is now targeting.
5459 *
5460 * @return Returns the same Intent object, for chaining multiple calls
5461 * into a single statement.
5462 *
5463 * @see #getData
5464 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005465 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005466 */
5467 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005468 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005469 }
5470
5471 /**
5472 * Set an explicit MIME data type.
5473 *
5474 * <p>This is used to create intents that only specify a type and not data,
5475 * for example to indicate the type of data to return.
5476 *
5477 * <p>This method automatically clears any data that was
5478 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005479 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005480 * <p><em>Note: MIME type matching in the Android framework is
5481 * case-sensitive, unlike formal RFC MIME types. As a result,
5482 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005483 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5484 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005485 *
5486 * @param type The MIME type of the data being handled by this intent.
5487 *
5488 * @return Returns the same Intent object, for chaining multiple calls
5489 * into a single statement.
5490 *
5491 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005492 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005493 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005494 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005495 */
5496 public Intent setType(String type) {
5497 mData = null;
5498 mType = type;
5499 return this;
5500 }
5501
5502 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005503 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005504 *
Nick Pellyccae4122012-01-09 14:12:58 -08005505 * <p>This is used to create intents that only specify a type and not data,
5506 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005507 *
Nick Pellyccae4122012-01-09 14:12:58 -08005508 * <p>This method automatically clears any data that was
5509 * previously set (for example by {@link #setData}).
5510 *
5511 * <p>The MIME type is normalized using
5512 * {@link #normalizeMimeType} before it is set,
5513 * so really this is just a convenience method for
5514 * <pre>
5515 * setType(Intent.normalizeMimeType(type))
5516 * </pre>
5517 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005518 * @param type The MIME type of the data being handled by this intent.
5519 *
5520 * @return Returns the same Intent object, for chaining multiple calls
5521 * into a single statement.
5522 *
Nick Pellyccae4122012-01-09 14:12:58 -08005523 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005524 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005525 * @see #normalizeMimeType
5526 */
5527 public Intent setTypeAndNormalize(String type) {
5528 return setType(normalizeMimeType(type));
5529 }
5530
5531 /**
5532 * (Usually optional) Set the data for the intent along with an explicit
5533 * MIME data type. This method should very rarely be used -- it allows you
5534 * to override the MIME type that would ordinarily be inferred from the
5535 * data with your own type given here.
5536 *
5537 * <p><em>Note: MIME type and Uri scheme matching in the
5538 * Android framework is case-sensitive, unlike the formal RFC definitions.
5539 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005540 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005541 * {@link #setDataAndTypeAndNormalize}
5542 * to ensure that they are converted to lower case.</em>
5543 *
5544 * @param data The Uri of the data this intent is now targeting.
5545 * @param type The MIME type of the data being handled by this intent.
5546 *
5547 * @return Returns the same Intent object, for chaining multiple calls
5548 * into a single statement.
5549 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005550 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005551 * @see #setData
5552 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005553 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005554 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005555 */
5556 public Intent setDataAndType(Uri data, String type) {
5557 mData = data;
5558 mType = type;
5559 return this;
5560 }
5561
5562 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005563 * (Usually optional) Normalize and set both the data Uri and an explicit
5564 * MIME data type. This method should very rarely be used -- it allows you
5565 * to override the MIME type that would ordinarily be inferred from the
5566 * data with your own type given here.
5567 *
5568 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005569 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005570 * before they are set, so really this is just a convenience method for
5571 * <pre>
5572 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5573 * </pre>
5574 *
5575 * @param data The Uri of the data this intent is now targeting.
5576 * @param type The MIME type of the data being handled by this intent.
5577 *
5578 * @return Returns the same Intent object, for chaining multiple calls
5579 * into a single statement.
5580 *
5581 * @see #setType
5582 * @see #setData
5583 * @see #setDataAndType
5584 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005585 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005586 */
5587 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005588 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005589 }
5590
5591 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005592 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005593 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005594 * activities that provide <em>all</em> of the requested categories will be
5595 * used.
5596 *
5597 * @param category The desired category. This can be either one of the
5598 * predefined Intent categories, or a custom category in your own
5599 * namespace.
5600 *
5601 * @return Returns the same Intent object, for chaining multiple calls
5602 * into a single statement.
5603 *
5604 * @see #hasCategory
5605 * @see #removeCategory
5606 */
5607 public Intent addCategory(String category) {
5608 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005609 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005610 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005611 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005612 return this;
5613 }
5614
5615 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005616 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005617 *
5618 * @param category The category to remove.
5619 *
5620 * @see #addCategory
5621 */
5622 public void removeCategory(String category) {
5623 if (mCategories != null) {
5624 mCategories.remove(category);
5625 if (mCategories.size() == 0) {
5626 mCategories = null;
5627 }
5628 }
5629 }
5630
5631 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005632 * Set a selector for this Intent. This is a modification to the kinds of
5633 * things the Intent will match. If the selector is set, it will be used
5634 * when trying to find entities that can handle the Intent, instead of the
5635 * main contents of the Intent. This allows you build an Intent containing
5636 * a generic protocol while targeting it more specifically.
5637 *
5638 * <p>An example of where this may be used is with things like
5639 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5640 * Intent that will launch the Browser application. However, the correct
5641 * main entry point of an application is actually {@link #ACTION_MAIN}
5642 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5643 * used to specify the actual Activity to launch. If you launch the browser
5644 * with something different, undesired behavior may happen if the user has
5645 * previously or later launches it the normal way, since they do not match.
5646 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5647 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5648 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5649 *
5650 * <p>Setting a selector does not impact the behavior of
5651 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5652 * desired behavior of a selector -- it does not impact the base meaning
5653 * of the Intent, just what kinds of things will be matched against it
5654 * when determining who can handle it.</p>
5655 *
5656 * <p>You can not use both a selector and {@link #setPackage(String)} on
5657 * the same base Intent.</p>
5658 *
5659 * @param selector The desired selector Intent; set to null to not use
5660 * a special selector.
5661 */
5662 public void setSelector(Intent selector) {
5663 if (selector == this) {
5664 throw new IllegalArgumentException(
5665 "Intent being set as a selector of itself");
5666 }
5667 if (selector != null && mPackage != null) {
5668 throw new IllegalArgumentException(
5669 "Can't set selector when package name is already set");
5670 }
5671 mSelector = selector;
5672 }
5673
5674 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005675 * Set a {@link ClipData} associated with this Intent. This replaces any
5676 * previously set ClipData.
5677 *
5678 * <p>The ClipData in an intent is not used for Intent matching or other
5679 * such operations. Semantically it is like extras, used to transmit
5680 * additional data with the Intent. The main feature of using this over
5681 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5682 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5683 * items included in the clip data. This is useful, in particular, if
5684 * you want to transmit an Intent containing multiple <code>content:</code>
5685 * URIs for which the recipient may not have global permission to access the
5686 * content provider.
5687 *
5688 * <p>If the ClipData contains items that are themselves Intents, any
5689 * grant flags in those Intents will be ignored. Only the top-level flags
5690 * of the main Intent are respected, and will be applied to all Uri or
5691 * Intent items in the clip (or sub-items of the clip).
5692 *
5693 * <p>The MIME type, label, and icon in the ClipData object are not
5694 * directly used by Intent. Applications should generally rely on the
5695 * MIME type of the Intent itself, not what it may find in the ClipData.
5696 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005697 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005698 *
5699 * @param clip The new clip to set. May be null to clear the current clip.
5700 */
5701 public void setClipData(ClipData clip) {
5702 mClipData = clip;
5703 }
5704
5705 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005706 * This is NOT a secure mechanism to identify the user who sent the intent.
5707 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5708 * who sent the intent.
5709 * @hide
5710 */
5711 public void setContentUserHint(int contentUserHint) {
5712 mContentUserHint = contentUserHint;
5713 }
5714
5715 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005716 * 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 boolean 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 #getBooleanExtra(String, boolean)
5729 */
5730 public Intent putExtra(String name, boolean value) {
5731 if (mExtras == null) {
5732 mExtras = new Bundle();
5733 }
5734 mExtras.putBoolean(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 byte 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 #getByteExtra(String, byte)
5752 */
5753 public Intent putExtra(String name, byte value) {
5754 if (mExtras == null) {
5755 mExtras = new Bundle();
5756 }
5757 mExtras.putByte(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 char 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 #getCharExtra(String, char)
5775 */
5776 public Intent putExtra(String name, char value) {
5777 if (mExtras == null) {
5778 mExtras = new Bundle();
5779 }
5780 mExtras.putChar(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 short 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 #getShortExtra(String, short)
5798 */
5799 public Intent putExtra(String name, short value) {
5800 if (mExtras == null) {
5801 mExtras = new Bundle();
5802 }
5803 mExtras.putShort(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 integer 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 #getIntExtra(String, int)
5821 */
5822 public Intent putExtra(String name, int value) {
5823 if (mExtras == null) {
5824 mExtras = new Bundle();
5825 }
5826 mExtras.putInt(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 long 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 #getLongExtra(String, long)
5844 */
5845 public Intent putExtra(String name, long value) {
5846 if (mExtras == null) {
5847 mExtras = new Bundle();
5848 }
5849 mExtras.putLong(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 float 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 #getFloatExtra(String, float)
5867 */
5868 public Intent putExtra(String name, float value) {
5869 if (mExtras == null) {
5870 mExtras = new Bundle();
5871 }
5872 mExtras.putFloat(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 double 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 #getDoubleExtra(String, double)
5890 */
5891 public Intent putExtra(String name, double value) {
5892 if (mExtras == null) {
5893 mExtras = new Bundle();
5894 }
5895 mExtras.putDouble(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 String 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 #getStringExtra(String)
5913 */
5914 public Intent putExtra(String name, String value) {
5915 if (mExtras == null) {
5916 mExtras = new Bundle();
5917 }
5918 mExtras.putString(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 CharSequence 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 #getCharSequenceExtra(String)
5936 */
5937 public Intent putExtra(String name, CharSequence value) {
5938 if (mExtras == null) {
5939 mExtras = new Bundle();
5940 }
5941 mExtras.putCharSequence(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 #getParcelableExtra(String)
5959 */
5960 public Intent putExtra(String name, Parcelable value) {
5961 if (mExtras == null) {
5962 mExtras = new Bundle();
5963 }
5964 mExtras.putParcelable(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 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 #getParcelableArrayExtra(String)
5982 */
5983 public Intent putExtra(String name, Parcelable[] value) {
5984 if (mExtras == null) {
5985 mExtras = new Bundle();
5986 }
5987 mExtras.putParcelableArray(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<Parcelable> 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 #getParcelableArrayListExtra(String)
6005 */
6006 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6007 if (mExtras == null) {
6008 mExtras = new Bundle();
6009 }
6010 mExtras.putParcelableArrayList(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<Integer> 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 #getIntegerArrayListExtra(String)
6028 */
6029 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6030 if (mExtras == null) {
6031 mExtras = new Bundle();
6032 }
6033 mExtras.putIntegerArrayList(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.
6043 * @param value The ArrayList<String> 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 #getStringArrayListExtra(String)
6051 */
6052 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6053 if (mExtras == null) {
6054 mExtras = new Bundle();
6055 }
6056 mExtras.putStringArrayList(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006066 * @param value The ArrayList<CharSequence> 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 #getCharSequenceArrayListExtra(String)
6074 */
6075 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6076 if (mExtras == null) {
6077 mExtras = new Bundle();
6078 }
6079 mExtras.putCharSequenceArrayList(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006089 * @param value The Serializable 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 #getSerializableExtra(String)
6097 */
6098 public Intent putExtra(String name, Serializable value) {
6099 if (mExtras == null) {
6100 mExtras = new Bundle();
6101 }
6102 mExtras.putSerializable(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 boolean 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 #getBooleanArrayExtra(String)
6120 */
6121 public Intent putExtra(String name, boolean[] value) {
6122 if (mExtras == null) {
6123 mExtras = new Bundle();
6124 }
6125 mExtras.putBooleanArray(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 byte 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 #getByteArrayExtra(String)
6143 */
6144 public Intent putExtra(String name, byte[] value) {
6145 if (mExtras == null) {
6146 mExtras = new Bundle();
6147 }
6148 mExtras.putByteArray(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 short 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 #getShortArrayExtra(String)
6166 */
6167 public Intent putExtra(String name, short[] value) {
6168 if (mExtras == null) {
6169 mExtras = new Bundle();
6170 }
6171 mExtras.putShortArray(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 char 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 #getCharArrayExtra(String)
6189 */
6190 public Intent putExtra(String name, char[] value) {
6191 if (mExtras == null) {
6192 mExtras = new Bundle();
6193 }
6194 mExtras.putCharArray(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 int 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 #getIntArrayExtra(String)
6212 */
6213 public Intent putExtra(String name, int[] value) {
6214 if (mExtras == null) {
6215 mExtras = new Bundle();
6216 }
6217 mExtras.putIntArray(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 byte 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 #getLongArrayExtra(String)
6235 */
6236 public Intent putExtra(String name, long[] value) {
6237 if (mExtras == null) {
6238 mExtras = new Bundle();
6239 }
6240 mExtras.putLongArray(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 float 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 #getFloatArrayExtra(String)
6258 */
6259 public Intent putExtra(String name, float[] value) {
6260 if (mExtras == null) {
6261 mExtras = new Bundle();
6262 }
6263 mExtras.putFloatArray(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 double 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 #getDoubleArrayExtra(String)
6281 */
6282 public Intent putExtra(String name, double[] value) {
6283 if (mExtras == null) {
6284 mExtras = new Bundle();
6285 }
6286 mExtras.putDoubleArray(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.
6296 * @param value The String 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 #getStringArrayExtra(String)
6304 */
6305 public Intent putExtra(String name, String[] value) {
6306 if (mExtras == null) {
6307 mExtras = new Bundle();
6308 }
6309 mExtras.putStringArray(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006319 * @param value The CharSequence array 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 #getCharSequenceArrayExtra(String)
6327 */
6328 public Intent putExtra(String name, CharSequence[] value) {
6329 if (mExtras == null) {
6330 mExtras = new Bundle();
6331 }
6332 mExtras.putCharSequenceArray(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 * @param value The Bundle 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 #getBundleExtra(String)
6350 */
6351 public Intent putExtra(String name, Bundle value) {
6352 if (mExtras == null) {
6353 mExtras = new Bundle();
6354 }
6355 mExtras.putBundle(name, value);
6356 return this;
6357 }
6358
6359 /**
6360 * Add extended data to the intent. The name must include a package
6361 * prefix, for example the app com.android.contacts would use names
6362 * like "com.android.contacts.ShowAll".
6363 *
6364 * @param name The name of the extra data, with package prefix.
6365 * @param value The IBinder data value.
6366 *
6367 * @return Returns the same Intent object, for chaining multiple calls
6368 * into a single statement.
6369 *
6370 * @see #putExtras
6371 * @see #removeExtra
6372 * @see #getIBinderExtra(String)
6373 *
6374 * @deprecated
6375 * @hide
6376 */
6377 @Deprecated
6378 public Intent putExtra(String name, IBinder value) {
6379 if (mExtras == null) {
6380 mExtras = new Bundle();
6381 }
6382 mExtras.putIBinder(name, value);
6383 return this;
6384 }
6385
6386 /**
6387 * Copy all extras in 'src' in to this intent.
6388 *
6389 * @param src Contains the extras to copy.
6390 *
6391 * @see #putExtra
6392 */
6393 public Intent putExtras(Intent src) {
6394 if (src.mExtras != null) {
6395 if (mExtras == null) {
6396 mExtras = new Bundle(src.mExtras);
6397 } else {
6398 mExtras.putAll(src.mExtras);
6399 }
6400 }
6401 return this;
6402 }
6403
6404 /**
6405 * Add a set of extended data to the intent. The keys must include a package
6406 * prefix, for example the app com.android.contacts would use names
6407 * like "com.android.contacts.ShowAll".
6408 *
6409 * @param extras The Bundle of extras to add to this intent.
6410 *
6411 * @see #putExtra
6412 * @see #removeExtra
6413 */
6414 public Intent putExtras(Bundle extras) {
6415 if (mExtras == null) {
6416 mExtras = new Bundle();
6417 }
6418 mExtras.putAll(extras);
6419 return this;
6420 }
6421
6422 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006423 * Completely replace the extras in the Intent with the extras in the
6424 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006425 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006426 * @param src The exact extras contained in this Intent are copied
6427 * into the target intent, replacing any that were previously there.
6428 */
6429 public Intent replaceExtras(Intent src) {
6430 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6431 return this;
6432 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006433
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006434 /**
6435 * Completely replace the extras in the Intent with the given Bundle of
6436 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006437 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006438 * @param extras The new set of extras in the Intent, or null to erase
6439 * all extras.
6440 */
6441 public Intent replaceExtras(Bundle extras) {
6442 mExtras = extras != null ? new Bundle(extras) : null;
6443 return this;
6444 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006445
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006446 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006447 * Remove extended data from the intent.
6448 *
6449 * @see #putExtra
6450 */
6451 public void removeExtra(String name) {
6452 if (mExtras != null) {
6453 mExtras.remove(name);
6454 if (mExtras.size() == 0) {
6455 mExtras = null;
6456 }
6457 }
6458 }
6459
6460 /**
6461 * Set special flags controlling how this intent is handled. Most values
6462 * here depend on the type of component being executed by the Intent,
6463 * specifically the FLAG_ACTIVITY_* flags are all for use with
6464 * {@link Context#startActivity Context.startActivity()} and the
6465 * FLAG_RECEIVER_* flags are all for use with
6466 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6467 *
Scott Main7aee61f2011-02-08 11:25:01 -08006468 * <p>See the
6469 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6470 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006471 * the behavior of your application.
6472 *
6473 * @param flags The desired flags.
6474 *
6475 * @return Returns the same Intent object, for chaining multiple calls
6476 * into a single statement.
6477 *
6478 * @see #getFlags
6479 * @see #addFlags
6480 *
6481 * @see #FLAG_GRANT_READ_URI_PERMISSION
6482 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006483 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6484 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006485 * @see #FLAG_DEBUG_LOG_RESOLUTION
6486 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006487 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006488 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006489 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006490 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006491 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6492 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006493 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006494 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006495 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006496 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006497 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006498 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006499 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006500 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6501 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006502 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006503 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006504 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006505 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6506 */
6507 public Intent setFlags(int flags) {
6508 mFlags = flags;
6509 return this;
6510 }
6511
6512 /**
6513 * Add additional flags to the intent (or with existing flags
6514 * value).
6515 *
6516 * @param flags The new flags to set.
6517 *
6518 * @return Returns the same Intent object, for chaining multiple calls
6519 * into a single statement.
6520 *
6521 * @see #setFlags
6522 */
6523 public Intent addFlags(int flags) {
6524 mFlags |= flags;
6525 return this;
6526 }
6527
6528 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006529 * (Usually optional) Set an explicit application package name that limits
6530 * the components this Intent will resolve to. If left to the default
6531 * value of null, all components in all applications will considered.
6532 * If non-null, the Intent can only match the components in the given
6533 * application package.
6534 *
6535 * @param packageName The name of the application package to handle the
6536 * intent, or null to allow any application package.
6537 *
6538 * @return Returns the same Intent object, for chaining multiple calls
6539 * into a single statement.
6540 *
6541 * @see #getPackage
6542 * @see #resolveActivity
6543 */
6544 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006545 if (packageName != null && mSelector != null) {
6546 throw new IllegalArgumentException(
6547 "Can't set package name when selector is already set");
6548 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006549 mPackage = packageName;
6550 return this;
6551 }
6552
6553 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006554 * (Usually optional) Explicitly set the component to handle the intent.
6555 * If left with the default value of null, the system will determine the
6556 * appropriate class to use based on the other fields (action, data,
6557 * type, categories) in the Intent. If this class is defined, the
6558 * specified class will always be used regardless of the other fields. You
6559 * should only set this value when you know you absolutely want a specific
6560 * class to be used; otherwise it is better to let the system find the
6561 * appropriate class so that you will respect the installed applications
6562 * and user preferences.
6563 *
6564 * @param component The name of the application component to handle the
6565 * intent, or null to let the system find one for you.
6566 *
6567 * @return Returns the same Intent object, for chaining multiple calls
6568 * into a single statement.
6569 *
6570 * @see #setClass
6571 * @see #setClassName(Context, String)
6572 * @see #setClassName(String, String)
6573 * @see #getComponent
6574 * @see #resolveActivity
6575 */
6576 public Intent setComponent(ComponentName component) {
6577 mComponent = component;
6578 return this;
6579 }
6580
6581 /**
6582 * Convenience for calling {@link #setComponent} with an
6583 * explicit class name.
6584 *
6585 * @param packageContext A Context of the application package implementing
6586 * this class.
6587 * @param className The name of a class inside of the application package
6588 * that will be used as the component for this Intent.
6589 *
6590 * @return Returns the same Intent object, for chaining multiple calls
6591 * into a single statement.
6592 *
6593 * @see #setComponent
6594 * @see #setClass
6595 */
6596 public Intent setClassName(Context packageContext, String className) {
6597 mComponent = new ComponentName(packageContext, className);
6598 return this;
6599 }
6600
6601 /**
6602 * Convenience for calling {@link #setComponent} with an
6603 * explicit application package name and class name.
6604 *
6605 * @param packageName The name of the package implementing the desired
6606 * component.
6607 * @param className The name of a class inside of the application package
6608 * that will be used as the component for this Intent.
6609 *
6610 * @return Returns the same Intent object, for chaining multiple calls
6611 * into a single statement.
6612 *
6613 * @see #setComponent
6614 * @see #setClass
6615 */
6616 public Intent setClassName(String packageName, String className) {
6617 mComponent = new ComponentName(packageName, className);
6618 return this;
6619 }
6620
6621 /**
6622 * Convenience for calling {@link #setComponent(ComponentName)} with the
6623 * name returned by a {@link Class} object.
6624 *
6625 * @param packageContext A Context of the application package implementing
6626 * this class.
6627 * @param cls The class name to set, equivalent to
6628 * <code>setClassName(context, cls.getName())</code>.
6629 *
6630 * @return Returns the same Intent object, for chaining multiple calls
6631 * into a single statement.
6632 *
6633 * @see #setComponent
6634 */
6635 public Intent setClass(Context packageContext, Class<?> cls) {
6636 mComponent = new ComponentName(packageContext, cls);
6637 return this;
6638 }
6639
6640 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006641 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6642 * used as a hint to the receiver for animations and the like. Null means that there
6643 * is no source bounds.
6644 */
6645 public void setSourceBounds(Rect r) {
6646 if (r != null) {
6647 mSourceBounds = new Rect(r);
6648 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006649 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006650 }
6651 }
6652
Tor Norbyed9273d62013-05-30 15:59:53 -07006653 /** @hide */
6654 @IntDef(flag = true,
6655 value = {
6656 FILL_IN_ACTION,
6657 FILL_IN_DATA,
6658 FILL_IN_CATEGORIES,
6659 FILL_IN_COMPONENT,
6660 FILL_IN_PACKAGE,
6661 FILL_IN_SOURCE_BOUNDS,
6662 FILL_IN_SELECTOR,
6663 FILL_IN_CLIP_DATA
6664 })
6665 @Retention(RetentionPolicy.SOURCE)
6666 public @interface FillInFlags {}
6667
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006668 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006669 * Use with {@link #fillIn} to allow the current action value to be
6670 * overwritten, even if it is already set.
6671 */
6672 public static final int FILL_IN_ACTION = 1<<0;
6673
6674 /**
6675 * Use with {@link #fillIn} to allow the current data or type value
6676 * overwritten, even if it is already set.
6677 */
6678 public static final int FILL_IN_DATA = 1<<1;
6679
6680 /**
6681 * Use with {@link #fillIn} to allow the current categories to be
6682 * overwritten, even if they are already set.
6683 */
6684 public static final int FILL_IN_CATEGORIES = 1<<2;
6685
6686 /**
6687 * Use with {@link #fillIn} to allow the current component value to be
6688 * overwritten, even if it is already set.
6689 */
6690 public static final int FILL_IN_COMPONENT = 1<<3;
6691
6692 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006693 * Use with {@link #fillIn} to allow the current package value to be
6694 * overwritten, even if it is already set.
6695 */
6696 public static final int FILL_IN_PACKAGE = 1<<4;
6697
6698 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006699 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006700 * overwritten, even if it is already set.
6701 */
6702 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6703
6704 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006705 * Use with {@link #fillIn} to allow the current selector to be
6706 * overwritten, even if it is already set.
6707 */
6708 public static final int FILL_IN_SELECTOR = 1<<6;
6709
6710 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006711 * Use with {@link #fillIn} to allow the current ClipData to be
6712 * overwritten, even if it is already set.
6713 */
6714 public static final int FILL_IN_CLIP_DATA = 1<<7;
6715
6716 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006717 * Copy the contents of <var>other</var> in to this object, but only
6718 * where fields are not defined by this object. For purposes of a field
6719 * being defined, the following pieces of data in the Intent are
6720 * considered to be separate fields:
6721 *
6722 * <ul>
6723 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006724 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006725 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6726 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006727 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006728 * <li> component, as set by {@link #setComponent(ComponentName)} or
6729 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006730 * <li> source bounds, as set by {@link #setSourceBounds}.
6731 * <li> selector, as set by {@link #setSelector(Intent)}.
6732 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006733 * <li> each top-level name in the associated extras.
6734 * </ul>
6735 *
6736 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006737 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006738 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6739 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6740 * the restriction where the corresponding field will not be replaced if
6741 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006743 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6744 * is explicitly specified. The selector will only be copied if
6745 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006746 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006747 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6748 * and Intent B with {action="gotit", data-type="some/thing",
6749 * categories="one","two"}.
6750 *
6751 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6752 * containing: {action="gotit", data-type="some/thing",
6753 * categories="bar"}.
6754 *
6755 * @param other Another Intent whose values are to be used to fill in
6756 * the current one.
6757 * @param flags Options to control which fields can be filled in.
6758 *
6759 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006760 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006761 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6762 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6763 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006765 @FillInFlags
6766 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006767 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006768 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006769 if (other.mAction != null
6770 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006771 mAction = other.mAction;
6772 changes |= FILL_IN_ACTION;
6773 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006774 if ((other.mData != null || other.mType != null)
6775 && ((mData == null && mType == null)
6776 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006777 mData = other.mData;
6778 mType = other.mType;
6779 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006780 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006781 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006782 if (other.mCategories != null
6783 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006784 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006785 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006786 }
6787 changes |= FILL_IN_CATEGORIES;
6788 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006789 if (other.mPackage != null
6790 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006791 // Only do this if mSelector is not set.
6792 if (mSelector == null) {
6793 mPackage = other.mPackage;
6794 changes |= FILL_IN_PACKAGE;
6795 }
6796 }
6797 // Selector is special: it can only be set if explicitly allowed,
6798 // for the same reason as the component name.
6799 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6800 if (mPackage == null) {
6801 mSelector = new Intent(other.mSelector);
6802 mPackage = null;
6803 changes |= FILL_IN_SELECTOR;
6804 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006805 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006806 if (other.mClipData != null
6807 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6808 mClipData = other.mClipData;
6809 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006810 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006811 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006812 // Component is special: it can -only- be set if explicitly allowed,
6813 // since otherwise the sender could force the intent somewhere the
6814 // originator didn't intend.
6815 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006816 mComponent = other.mComponent;
6817 changes |= FILL_IN_COMPONENT;
6818 }
6819 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006820 if (other.mSourceBounds != null
6821 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6822 mSourceBounds = new Rect(other.mSourceBounds);
6823 changes |= FILL_IN_SOURCE_BOUNDS;
6824 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006825 if (mExtras == null) {
6826 if (other.mExtras != null) {
6827 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006828 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006829 }
6830 } else if (other.mExtras != null) {
6831 try {
6832 Bundle newb = new Bundle(other.mExtras);
6833 newb.putAll(mExtras);
6834 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006835 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006836 } catch (RuntimeException e) {
6837 // Modifying the extras can cause us to unparcel the contents
6838 // of the bundle, and if we do this in the system process that
6839 // may fail. We really should handle this (i.e., the Bundle
6840 // impl shouldn't be on top of a plain map), but for now just
6841 // ignore it and keep the original contents. :(
6842 Log.w("Intent", "Failure filling in extras", e);
6843 }
6844 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006845 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
6846 && other.mContentUserHint != UserHandle.USER_CURRENT) {
6847 mContentUserHint = other.mContentUserHint;
6848 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849 return changes;
6850 }
6851
6852 /**
6853 * Wrapper class holding an Intent and implementing comparisons on it for
6854 * the purpose of filtering. The class implements its
6855 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6856 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6857 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6858 * on the wrapped Intent.
6859 */
6860 public static final class FilterComparison {
6861 private final Intent mIntent;
6862 private final int mHashCode;
6863
6864 public FilterComparison(Intent intent) {
6865 mIntent = intent;
6866 mHashCode = intent.filterHashCode();
6867 }
6868
6869 /**
6870 * Return the Intent that this FilterComparison represents.
6871 * @return Returns the Intent held by the FilterComparison. Do
6872 * not modify!
6873 */
6874 public Intent getIntent() {
6875 return mIntent;
6876 }
6877
6878 @Override
6879 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006880 if (obj instanceof FilterComparison) {
6881 Intent other = ((FilterComparison)obj).mIntent;
6882 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006884 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006885 }
6886
6887 @Override
6888 public int hashCode() {
6889 return mHashCode;
6890 }
6891 }
6892
6893 /**
6894 * Determine if two intents are the same for the purposes of intent
6895 * resolution (filtering). That is, if their action, data, type,
6896 * class, and categories are the same. This does <em>not</em> compare
6897 * any extra data included in the intents.
6898 *
6899 * @param other The other Intent to compare against.
6900 *
6901 * @return Returns true if action, data, type, class, and categories
6902 * are the same.
6903 */
6904 public boolean filterEquals(Intent other) {
6905 if (other == null) {
6906 return false;
6907 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006908 if (!Objects.equals(this.mAction, other.mAction)) return false;
6909 if (!Objects.equals(this.mData, other.mData)) return false;
6910 if (!Objects.equals(this.mType, other.mType)) return false;
6911 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6912 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6913 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006914
6915 return true;
6916 }
6917
6918 /**
6919 * Generate hash code that matches semantics of filterEquals().
6920 *
6921 * @return Returns the hash value of the action, data, type, class, and
6922 * categories.
6923 *
6924 * @see #filterEquals
6925 */
6926 public int filterHashCode() {
6927 int code = 0;
6928 if (mAction != null) {
6929 code += mAction.hashCode();
6930 }
6931 if (mData != null) {
6932 code += mData.hashCode();
6933 }
6934 if (mType != null) {
6935 code += mType.hashCode();
6936 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006937 if (mPackage != null) {
6938 code += mPackage.hashCode();
6939 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006940 if (mComponent != null) {
6941 code += mComponent.hashCode();
6942 }
6943 if (mCategories != null) {
6944 code += mCategories.hashCode();
6945 }
6946 return code;
6947 }
6948
6949 @Override
6950 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006951 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006952
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006953 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006954 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006955 b.append(" }");
6956
6957 return b.toString();
6958 }
6959
6960 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006961 public String toInsecureString() {
6962 StringBuilder b = new StringBuilder(128);
6963
6964 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006965 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006966 b.append(" }");
6967
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006968 return b.toString();
6969 }
Romain Guy4969af72009-06-17 10:53:19 -07006970
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006971 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006972 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006973 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006974
6975 b.append("Intent { ");
6976 toShortString(b, false, true, true, true);
6977 b.append(" }");
6978
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006979 return b.toString();
6980 }
6981
6982 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006983 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6984 StringBuilder b = new StringBuilder(128);
6985 toShortString(b, secure, comp, extras, clip);
6986 return b.toString();
6987 }
6988
6989 /** @hide */
6990 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6991 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006992 boolean first = true;
6993 if (mAction != null) {
6994 b.append("act=").append(mAction);
6995 first = false;
6996 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006997 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006998 if (!first) {
6999 b.append(' ');
7000 }
7001 first = false;
7002 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007003 for (int i=0; i<mCategories.size(); i++) {
7004 if (i > 0) b.append(',');
7005 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007006 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007007 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007008 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007009 if (mData != null) {
7010 if (!first) {
7011 b.append(' ');
7012 }
7013 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007014 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007015 if (secure) {
7016 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007017 } else {
7018 b.append(mData);
7019 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007020 }
7021 if (mType != null) {
7022 if (!first) {
7023 b.append(' ');
7024 }
7025 first = false;
7026 b.append("typ=").append(mType);
7027 }
7028 if (mFlags != 0) {
7029 if (!first) {
7030 b.append(' ');
7031 }
7032 first = false;
7033 b.append("flg=0x").append(Integer.toHexString(mFlags));
7034 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007035 if (mPackage != null) {
7036 if (!first) {
7037 b.append(' ');
7038 }
7039 first = false;
7040 b.append("pkg=").append(mPackage);
7041 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007042 if (comp && mComponent != null) {
7043 if (!first) {
7044 b.append(' ');
7045 }
7046 first = false;
7047 b.append("cmp=").append(mComponent.flattenToShortString());
7048 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007049 if (mSourceBounds != null) {
7050 if (!first) {
7051 b.append(' ');
7052 }
7053 first = false;
7054 b.append("bnds=").append(mSourceBounds.toShortString());
7055 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007056 if (mClipData != null) {
7057 if (!first) {
7058 b.append(' ');
7059 }
7060 first = false;
7061 if (clip) {
7062 b.append("clip={");
7063 mClipData.toShortString(b);
7064 b.append('}');
7065 } else {
7066 b.append("(has clip)");
7067 }
7068 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007069 if (extras && mExtras != null) {
7070 if (!first) {
7071 b.append(' ');
7072 }
7073 first = false;
7074 b.append("(has extras)");
7075 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007076 if (mContentUserHint != UserHandle.USER_CURRENT) {
7077 if (!first) {
7078 b.append(' ');
7079 }
7080 first = false;
7081 b.append("u=").append(mContentUserHint);
7082 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007083 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007084 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007085 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007086 b.append("}");
7087 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007088 }
7089
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007090 /**
7091 * Call {@link #toUri} with 0 flags.
7092 * @deprecated Use {@link #toUri} instead.
7093 */
7094 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007095 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007096 return toUri(0);
7097 }
7098
7099 /**
7100 * Convert this Intent into a String holding a URI representation of it.
7101 * The returned URI string has been properly URI encoded, so it can be
7102 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7103 * Intent's data as the base URI, with an additional fragment describing
7104 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007105 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007106 * <p>You can convert the returned string back to an Intent with
7107 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007108 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007109 * @param flags Additional operating flags. Either 0 or
7110 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007111 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007112 * @return Returns a URI encoding URI string describing the entire contents
7113 * of the Intent.
7114 */
7115 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007116 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007117 String scheme = null;
7118 if (mData != null) {
7119 String data = mData.toString();
7120 if ((flags&URI_INTENT_SCHEME) != 0) {
7121 final int N = data.length();
7122 for (int i=0; i<N; i++) {
7123 char c = data.charAt(i);
7124 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7125 || c == '.' || c == '-') {
7126 continue;
7127 }
7128 if (c == ':' && i > 0) {
7129 // Valid scheme.
7130 scheme = data.substring(0, i);
7131 uri.append("intent:");
7132 data = data.substring(i+1);
7133 break;
7134 }
Tom Taylord4a47292009-12-21 13:59:18 -08007135
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007136 // No scheme.
7137 break;
7138 }
7139 }
7140 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007141
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007142 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7143 uri.append("intent:");
7144 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007145
7146 uri.append("#Intent;");
7147
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007148 toUriInner(uri, scheme, flags);
7149 if (mSelector != null) {
7150 uri.append("SEL;");
7151 // Note that for now we are not going to try to handle the
7152 // data part; not clear how to represent this as a URI, and
7153 // not much utility in it.
7154 mSelector.toUriInner(uri, null, flags);
7155 }
7156
7157 uri.append("end");
7158
7159 return uri.toString();
7160 }
7161
7162 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007163 if (scheme != null) {
7164 uri.append("scheme=").append(scheme).append(';');
7165 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007166 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007167 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007168 }
7169 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007170 for (int i=0; i<mCategories.size(); i++) {
7171 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007172 }
7173 }
7174 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007175 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007176 }
7177 if (mFlags != 0) {
7178 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7179 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007180 if (mPackage != null) {
7181 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7182 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007183 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007184 uri.append("component=").append(Uri.encode(
7185 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007186 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007187 if (mSourceBounds != null) {
7188 uri.append("sourceBounds=")
7189 .append(Uri.encode(mSourceBounds.flattenToString()))
7190 .append(';');
7191 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007192 if (mExtras != null) {
7193 for (String key : mExtras.keySet()) {
7194 final Object value = mExtras.get(key);
7195 char entryType =
7196 value instanceof String ? 'S' :
7197 value instanceof Boolean ? 'B' :
7198 value instanceof Byte ? 'b' :
7199 value instanceof Character ? 'c' :
7200 value instanceof Double ? 'd' :
7201 value instanceof Float ? 'f' :
7202 value instanceof Integer ? 'i' :
7203 value instanceof Long ? 'l' :
7204 value instanceof Short ? 's' :
7205 '\0';
7206
7207 if (entryType != '\0') {
7208 uri.append(entryType);
7209 uri.append('.');
7210 uri.append(Uri.encode(key));
7211 uri.append('=');
7212 uri.append(Uri.encode(value.toString()));
7213 uri.append(';');
7214 }
7215 }
7216 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007217 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007218
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007219 public int describeContents() {
7220 return (mExtras != null) ? mExtras.describeContents() : 0;
7221 }
7222
7223 public void writeToParcel(Parcel out, int flags) {
7224 out.writeString(mAction);
7225 Uri.writeToParcel(out, mData);
7226 out.writeString(mType);
7227 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007228 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007229 ComponentName.writeToParcel(mComponent, out);
7230
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007231 if (mSourceBounds != null) {
7232 out.writeInt(1);
7233 mSourceBounds.writeToParcel(out, flags);
7234 } else {
7235 out.writeInt(0);
7236 }
7237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007238 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007239 final int N = mCategories.size();
7240 out.writeInt(N);
7241 for (int i=0; i<N; i++) {
7242 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007243 }
7244 } else {
7245 out.writeInt(0);
7246 }
7247
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007248 if (mSelector != null) {
7249 out.writeInt(1);
7250 mSelector.writeToParcel(out, flags);
7251 } else {
7252 out.writeInt(0);
7253 }
7254
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007255 if (mClipData != null) {
7256 out.writeInt(1);
7257 mClipData.writeToParcel(out, flags);
7258 } else {
7259 out.writeInt(0);
7260 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007261 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007262 out.writeBundle(mExtras);
7263 }
7264
7265 public static final Parcelable.Creator<Intent> CREATOR
7266 = new Parcelable.Creator<Intent>() {
7267 public Intent createFromParcel(Parcel in) {
7268 return new Intent(in);
7269 }
7270 public Intent[] newArray(int size) {
7271 return new Intent[size];
7272 }
7273 };
7274
Dianne Hackborneb034652009-09-07 00:49:58 -07007275 /** @hide */
7276 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007277 readFromParcel(in);
7278 }
7279
7280 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007281 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007282 mData = Uri.CREATOR.createFromParcel(in);
7283 mType = in.readString();
7284 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007285 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007286 mComponent = ComponentName.readFromParcel(in);
7287
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007288 if (in.readInt() != 0) {
7289 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7290 }
7291
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007292 int N = in.readInt();
7293 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007294 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007295 int i;
7296 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007297 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007298 }
7299 } else {
7300 mCategories = null;
7301 }
7302
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007303 if (in.readInt() != 0) {
7304 mSelector = new Intent(in);
7305 }
7306
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007307 if (in.readInt() != 0) {
7308 mClipData = new ClipData(in);
7309 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007310 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007311 mExtras = in.readBundle();
7312 }
7313
7314 /**
7315 * Parses the "intent" element (and its children) from XML and instantiates
7316 * an Intent object. The given XML parser should be located at the tag
7317 * where parsing should start (often named "intent"), from which the
7318 * basic action, data, type, and package and class name will be
7319 * retrieved. The function will then parse in to any child elements,
7320 * looking for <category android:name="xxx"> tags to add categories and
7321 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7322 * to the intent.
7323 *
7324 * @param resources The Resources to use when inflating resources.
7325 * @param parser The XML parser pointing at an "intent" tag.
7326 * @param attrs The AttributeSet interface for retrieving extended
7327 * attribute data at the current <var>parser</var> location.
7328 * @return An Intent object matching the XML data.
7329 * @throws XmlPullParserException If there was an XML parsing error.
7330 * @throws IOException If there was an I/O error.
7331 */
7332 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7333 throws XmlPullParserException, IOException {
7334 Intent intent = new Intent();
7335
7336 TypedArray sa = resources.obtainAttributes(attrs,
7337 com.android.internal.R.styleable.Intent);
7338
7339 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7340
7341 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7342 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7343 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7344
7345 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7346 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7347 if (packageName != null && className != null) {
7348 intent.setComponent(new ComponentName(packageName, className));
7349 }
7350
7351 sa.recycle();
7352
7353 int outerDepth = parser.getDepth();
7354 int type;
7355 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7356 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7357 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7358 continue;
7359 }
7360
7361 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007362 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007363 sa = resources.obtainAttributes(attrs,
7364 com.android.internal.R.styleable.IntentCategory);
7365 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7366 sa.recycle();
7367
7368 if (cat != null) {
7369 intent.addCategory(cat);
7370 }
7371 XmlUtils.skipCurrentTag(parser);
7372
Craig Mautner21d24a22014-04-23 11:45:37 -07007373 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007374 if (intent.mExtras == null) {
7375 intent.mExtras = new Bundle();
7376 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007377 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007378 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007379
7380 } else {
7381 XmlUtils.skipCurrentTag(parser);
7382 }
7383 }
7384
7385 return intent;
7386 }
Nick Pellyccae4122012-01-09 14:12:58 -08007387
Craig Mautner21d24a22014-04-23 11:45:37 -07007388 /** @hide */
7389 public void saveToXml(XmlSerializer out) throws IOException {
7390 if (mAction != null) {
7391 out.attribute(null, ATTR_ACTION, mAction);
7392 }
7393 if (mData != null) {
7394 out.attribute(null, ATTR_DATA, mData.toString());
7395 }
7396 if (mType != null) {
7397 out.attribute(null, ATTR_TYPE, mType);
7398 }
7399 if (mComponent != null) {
7400 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7401 }
7402 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7403
7404 if (mCategories != null) {
7405 out.startTag(null, TAG_CATEGORIES);
7406 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7407 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7408 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007409 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007410 }
7411 }
7412
7413 /** @hide */
7414 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7415 XmlPullParserException {
7416 Intent intent = new Intent();
7417 final int outerDepth = in.getDepth();
7418
7419 int attrCount = in.getAttributeCount();
7420 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7421 final String attrName = in.getAttributeName(attrNdx);
7422 final String attrValue = in.getAttributeValue(attrNdx);
7423 if (ATTR_ACTION.equals(attrName)) {
7424 intent.setAction(attrValue);
7425 } else if (ATTR_DATA.equals(attrName)) {
7426 intent.setData(Uri.parse(attrValue));
7427 } else if (ATTR_TYPE.equals(attrName)) {
7428 intent.setType(attrValue);
7429 } else if (ATTR_COMPONENT.equals(attrName)) {
7430 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7431 } else if (ATTR_FLAGS.equals(attrName)) {
7432 intent.setFlags(Integer.valueOf(attrValue, 16));
7433 } else {
7434 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7435 }
7436 }
7437
7438 int event;
7439 String name;
7440 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7441 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7442 if (event == XmlPullParser.START_TAG) {
7443 name = in.getName();
7444 if (TAG_CATEGORIES.equals(name)) {
7445 attrCount = in.getAttributeCount();
7446 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7447 intent.addCategory(in.getAttributeValue(attrNdx));
7448 }
7449 } else {
7450 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7451 XmlUtils.skipCurrentTag(in);
7452 }
7453 }
7454 }
7455
7456 return intent;
7457 }
7458
Nick Pellyccae4122012-01-09 14:12:58 -08007459 /**
7460 * Normalize a MIME data type.
7461 *
7462 * <p>A normalized MIME type has white-space trimmed,
7463 * content-type parameters removed, and is lower-case.
7464 * This aligns the type with Android best practices for
7465 * intent filtering.
7466 *
7467 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7468 * "text/x-vCard" becomes "text/x-vcard".
7469 *
7470 * <p>All MIME types received from outside Android (such as user input,
7471 * or external sources like Bluetooth, NFC, or the Internet) should
7472 * be normalized before they are used to create an Intent.
7473 *
7474 * @param type MIME data type to normalize
7475 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007476 * @see #setType
7477 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007478 */
7479 public static String normalizeMimeType(String type) {
7480 if (type == null) {
7481 return null;
7482 }
7483
Elliott Hughescb64d432013-08-02 10:00:44 -07007484 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007485
7486 final int semicolonIndex = type.indexOf(';');
7487 if (semicolonIndex != -1) {
7488 type = type.substring(0, semicolonIndex);
7489 }
7490 return type;
7491 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007492
7493 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007494 * Prepare this {@link Intent} to leave an app process.
7495 *
7496 * @hide
7497 */
7498 public void prepareToLeaveProcess() {
7499 setAllowFds(false);
7500
7501 if (mSelector != null) {
7502 mSelector.prepareToLeaveProcess();
7503 }
7504 if (mClipData != null) {
7505 mClipData.prepareToLeaveProcess();
7506 }
7507
7508 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7509 // There are several ACTION_MEDIA_* broadcasts that send file://
7510 // Uris, so only check common actions.
7511 if (ACTION_VIEW.equals(mAction) ||
7512 ACTION_EDIT.equals(mAction) ||
7513 ACTION_ATTACH_DATA.equals(mAction)) {
7514 mData.checkFileUriExposed("Intent.getData()");
7515 }
7516 }
7517 }
7518
7519 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007520 * @hide
7521 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007522 public void prepareToEnterProcess() {
7523 if (mContentUserHint != UserHandle.USER_CURRENT) {
7524 fixUris(mContentUserHint);
7525 mContentUserHint = UserHandle.USER_CURRENT;
7526 }
7527 }
7528
7529 /**
7530 * @hide
7531 */
7532 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007533 Uri data = getData();
7534 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007535 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007536 }
7537 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007538 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007539 }
7540 String action = getAction();
7541 if (ACTION_SEND.equals(action)) {
7542 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7543 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007544 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007545 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007546 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007547 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7548 if (streams != null) {
7549 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7550 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007551 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007552 }
7553 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7554 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007555 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7556 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7557 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7558 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7559 if (output != null) {
7560 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7561 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007562 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007563 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007564
7565 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007566 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007567 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7568 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007569 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007570 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007571 * @hide
7572 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007573 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007574 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007575 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007576
7577 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007578 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007579
7580 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007581 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007582 try {
7583 // Inspect target intent to see if we need to migrate
7584 final Intent target = getParcelableExtra(EXTRA_INTENT);
7585 if (target != null && target.migrateExtraStreamToClipData()) {
7586 // Since we migrated in child, we need to promote ClipData
7587 // and flags to ourselves to grant.
7588 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007589 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7590 | FLAG_GRANT_WRITE_URI_PERMISSION
7591 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7592 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007593 return true;
7594 } else {
7595 return false;
7596 }
7597 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007598 }
7599
7600 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007601 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007602 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7603 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7604 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7605 if (stream != null || text != null || htmlText != null) {
7606 final ClipData clipData = new ClipData(
7607 null, new String[] { getType() },
7608 new ClipData.Item(text, htmlText, null, stream));
7609 setClipData(clipData);
7610 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007611 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007612 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007613 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007614 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007615
7616 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007617 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007618 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7619 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7620 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7621 int num = -1;
7622 if (streams != null) {
7623 num = streams.size();
7624 }
7625 if (texts != null) {
7626 if (num >= 0 && num != texts.size()) {
7627 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007628 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007629 }
7630 num = texts.size();
7631 }
7632 if (htmlTexts != null) {
7633 if (num >= 0 && num != htmlTexts.size()) {
7634 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007635 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007636 }
7637 num = htmlTexts.size();
7638 }
7639 if (num > 0) {
7640 final ClipData clipData = new ClipData(
7641 null, new String[] { getType() },
7642 makeClipItem(streams, texts, htmlTexts, 0));
7643
7644 for (int i = 1; i < num; i++) {
7645 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7646 }
7647
7648 setClipData(clipData);
7649 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007650 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007651 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007652 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007653 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007654 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7655 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7656 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7657 final Uri output;
7658 try {
7659 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7660 } catch (ClassCastException e) {
7661 return false;
7662 }
7663 if (output != null) {
7664 setClipData(ClipData.newRawUri("", output));
7665 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7666 return true;
7667 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007668 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007669
7670 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007671 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007672
7673 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7674 ArrayList<String> htmlTexts, int which) {
7675 Uri uri = streams != null ? streams.get(which) : null;
7676 CharSequence text = texts != null ? texts.get(which) : null;
7677 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7678 return new ClipData.Item(text, htmlText, null, uri);
7679 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007680
7681 /** @hide */
7682 public boolean isDocument() {
7683 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7684 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007685}