blob: 9973fafefb3c9ccd64e74e08b1a7a0a1fc90fdbe [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;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080021import android.os.ShellCommand;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010022import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070023import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070024
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import org.xmlpull.v1.XmlPullParser;
26import org.xmlpull.v1.XmlPullParserException;
27
Tor Norbye7b9c9122013-05-30 16:48:33 -070028import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070029import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070031import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.annotation.SdkConstant.SdkConstantType;
33import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070034
Nicolas Prevotd85fc722014-04-16 19:52:08 +010035import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070036
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.content.pm.PackageManager;
38import android.content.pm.ResolveInfo;
39import android.content.res.Resources;
40import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080041import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042import android.net.Uri;
43import android.os.Bundle;
44import android.os.IBinder;
45import android.os.Parcel;
46import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000047import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070048import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010049import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070050import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070051import android.provider.DocumentsProvider;
52import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070053import android.util.AttributeSet;
54import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080055
56import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070057
Craig Mautner21d24a22014-04-23 11:45:37 -070058import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070059
60import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080061import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070062import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070063import java.lang.annotation.Retention;
64import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065import java.net.URISyntaxException;
66import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080067import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070068import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080069import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070070import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070071import java.util.Set;
72
73/**
74 * An intent is an abstract description of an operation to be performed. It
75 * can be used with {@link Context#startActivity(Intent) startActivity} to
76 * launch an {@link android.app.Activity},
77 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
78 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
79 * and {@link android.content.Context#startService} or
80 * {@link android.content.Context#bindService} to communicate with a
81 * background {@link android.app.Service}.
82 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070083 * <p>An Intent provides a facility for performing late runtime binding between the code in
84 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070085 * can be thought of as the glue between activities. It is basically a passive data structure
86 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070087 *
88 * <div class="special reference">
89 * <h3>Developer Guides</h3>
90 * <p>For information about how to create and resolve intents, read the
91 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
92 * developer guide.</p>
93 * </div>
94 *
95 * <a name="IntentStructure"></a>
96 * <h3>Intent Structure</h3>
97 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 *
99 * <ul>
100 * <li> <p><b>action</b> -- The general action to be performed, such as
101 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
102 * etc.</p>
103 * </li>
104 * <li> <p><b>data</b> -- The data to operate on, such as a person record
105 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
106 * </li>
107 * </ul>
108 *
109 *
110 * <p>Some examples of action/data pairs are:</p>
111 *
112 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * information about the person whose identifier is "1".</p>
115 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700116 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700117 * the phone dialer with the person filled in.</p>
118 * </li>
119 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
120 * the phone dialer with the given number filled in. Note how the
121 * VIEW action does what what is considered the most reasonable thing for
122 * a particular URI.</p>
123 * </li>
124 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
125 * the phone dialer with the given number filled in.</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * information about the person whose identifier is "1".</p>
129 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700130 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700131 * a list of people, which the user can browse through. This example is a
132 * typical top-level entry into the Contacts application, showing you the
133 * list of people. Selecting a particular person to view would result in a
134 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
135 * being used to start an activity to display that person.</p>
136 * </li>
137 * </ul>
138 *
139 * <p>In addition to these primary attributes, there are a number of secondary
140 * attributes that you can also include with an intent:</p>
141 *
142 * <ul>
143 * <li> <p><b>category</b> -- Gives additional information about the action
144 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
145 * appear in the Launcher as a top-level application, while
146 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
147 * of alternative actions the user can perform on a piece of data.</p>
148 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
149 * intent data. Normally the type is inferred from the data itself.
150 * By setting this attribute, you disable that evaluation and force
151 * an explicit type.</p>
152 * <li> <p><b>component</b> -- Specifies an explicit name of a component
153 * class to use for the intent. Normally this is determined by looking
154 * at the other information in the intent (the action, data/type, and
155 * categories) and matching that with a component that can handle it.
156 * If this attribute is set then none of the evaluation is performed,
157 * and this component is used exactly as is. By specifying this attribute,
158 * all of the other Intent attributes become optional.</p>
159 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
160 * This can be used to provide extended information to the component.
161 * For example, if we have a action to send an e-mail message, we could
162 * also include extra pieces of data here to supply a subject, body,
163 * etc.</p>
164 * </ul>
165 *
166 * <p>Here are some examples of other operations you can specify as intents
167 * using these additional parameters:</p>
168 *
169 * <ul>
170 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
171 * Launch the home screen.</p>
172 * </li>
173 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
174 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
175 * vnd.android.cursor.item/phone}</i></b>
176 * -- Display the list of people's phone numbers, allowing the user to
177 * browse through them and pick one and return it to the parent activity.</p>
178 * </li>
179 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
180 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
181 * -- Display all pickers for data that can be opened with
182 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
183 * allowing the user to pick one of them and then some data inside of it
184 * and returning the resulting URI to the caller. This can be used,
185 * for example, in an e-mail application to allow the user to pick some
186 * data to include as an attachment.</p>
187 * </li>
188 * </ul>
189 *
190 * <p>There are a variety of standard Intent action and category constants
191 * defined in the Intent class, but applications can also define their own.
192 * These strings use java style scoping, to ensure they are unique -- for
193 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700194 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700195 *
196 * <p>Put together, the set of actions, data types, categories, and extra data
197 * defines a language for the system allowing for the expression of phrases
198 * such as "call john smith's cell". As applications are added to the system,
199 * they can extend this language by adding new actions, types, and categories, or
200 * they can modify the behavior of existing phrases by supplying their own
201 * activities that handle them.</p>
202 *
203 * <a name="IntentResolution"></a>
204 * <h3>Intent Resolution</h3>
205 *
206 * <p>There are two primary forms of intents you will use.
207 *
208 * <ul>
209 * <li> <p><b>Explicit Intents</b> have specified a component (via
210 * {@link #setComponent} or {@link #setClass}), which provides the exact
211 * class to be run. Often these will not include any other information,
212 * simply being a way for an application to launch various internal
213 * activities it has as the user interacts with the application.
214 *
215 * <li> <p><b>Implicit Intents</b> have not specified a component;
216 * instead, they must include enough information for the system to
217 * determine which of the available components is best to run for that
218 * intent.
219 * </ul>
220 *
221 * <p>When using implicit intents, given such an arbitrary intent we need to
222 * know what to do with it. This is handled by the process of <em>Intent
223 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
224 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
225 * more activities/receivers) that can handle it.</p>
226 *
227 * <p>The intent resolution mechanism basically revolves around matching an
228 * Intent against all of the &lt;intent-filter&gt; descriptions in the
229 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
230 * objects explicitly registered with {@link Context#registerReceiver}.) More
231 * details on this can be found in the documentation on the {@link
232 * IntentFilter} class.</p>
233 *
234 * <p>There are three pieces of information in the Intent that are used for
235 * resolution: the action, type, and category. Using this information, a query
236 * is done on the {@link PackageManager} for a component that can handle the
237 * intent. The appropriate component is determined based on the intent
238 * information supplied in the <code>AndroidManifest.xml</code> file as
239 * follows:</p>
240 *
241 * <ul>
242 * <li> <p>The <b>action</b>, if given, must be listed by the component as
243 * one it handles.</p>
244 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
245 * already supplied in the Intent. Like the action, if a type is
246 * included in the intent (either explicitly or implicitly in its
247 * data), then this must be listed by the component as one it handles.</p>
248 * <li> For data that is not a <code>content:</code> URI and where no explicit
249 * type is included in the Intent, instead the <b>scheme</b> of the
250 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
251 * considered. Again like the action, if we are matching a scheme it
252 * must be listed by the component as one it can handle.
253 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
254 * by the activity as categories it handles. That is, if you include
255 * the categories {@link #CATEGORY_LAUNCHER} and
256 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
257 * with an intent that lists <em>both</em> of those categories.
258 * Activities will very often need to support the
259 * {@link #CATEGORY_DEFAULT} so that they can be found by
260 * {@link Context#startActivity Context.startActivity()}.</p>
261 * </ul>
262 *
263 * <p>For example, consider the Note Pad sample application that
264 * allows user to browse through a list of notes data and view details about
265 * individual items. Text in italics indicate places were you would replace a
266 * name with one specific to your own package.</p>
267 *
268 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
269 * package="<i>com.android.notepad</i>"&gt;
270 * &lt;application android:icon="@drawable/app_notes"
271 * android:label="@string/app_name"&gt;
272 *
273 * &lt;provider class=".NotePadProvider"
274 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
275 *
276 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
277 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700278 * &lt;action android:name="android.intent.action.MAIN" /&gt;
279 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700280 * &lt;/intent-filter&gt;
281 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700282 * &lt;action android:name="android.intent.action.VIEW" /&gt;
283 * &lt;action android:name="android.intent.action.EDIT" /&gt;
284 * &lt;action android:name="android.intent.action.PICK" /&gt;
285 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
286 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700287 * &lt;/intent-filter&gt;
288 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700289 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
290 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
291 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700292 * &lt;/intent-filter&gt;
293 * &lt;/activity&gt;
294 *
295 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
296 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="android.intent.action.VIEW" /&gt;
298 * &lt;action android:name="android.intent.action.EDIT" /&gt;
299 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
300 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;
302 *
303 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700304 * &lt;action android:name="android.intent.action.INSERT" /&gt;
305 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
306 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700307 * &lt;/intent-filter&gt;
308 *
309 * &lt;/activity&gt;
310 *
311 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
312 * android:theme="@android:style/Theme.Dialog"&gt;
313 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700314 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
315 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
316 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
317 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
318 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700319 * &lt;/intent-filter&gt;
320 * &lt;/activity&gt;
321 *
322 * &lt;/application&gt;
323 * &lt;/manifest&gt;</pre>
324 *
325 * <p>The first activity,
326 * <code>com.android.notepad.NotesList</code>, serves as our main
327 * entry into the app. It can do three things as described by its three intent
328 * templates:
329 * <ol>
330 * <li><pre>
331 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700332 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
333 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700334 * &lt;/intent-filter&gt;</pre>
335 * <p>This provides a top-level entry into the NotePad application: the standard
336 * MAIN action is a main entry point (not requiring any other information in
337 * the Intent), and the LAUNCHER category says that this entry point should be
338 * listed in the application launcher.</p>
339 * <li><pre>
340 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700341 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
342 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
343 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
344 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
345 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700346 * &lt;/intent-filter&gt;</pre>
347 * <p>This declares the things that the activity can do on a directory of
348 * notes. The type being supported is given with the &lt;type&gt; tag, where
349 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
350 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
351 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
352 * The activity allows the user to view or edit the directory of data (via
353 * the VIEW and EDIT actions), or to pick a particular note and return it
354 * to the caller (via the PICK action). Note also the DEFAULT category
355 * supplied here: this is <em>required</em> for the
356 * {@link Context#startActivity Context.startActivity} method to resolve your
357 * activity when its component name is not explicitly specified.</p>
358 * <li><pre>
359 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700360 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
361 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
362 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700363 * &lt;/intent-filter&gt;</pre>
364 * <p>This filter describes the ability return to the caller a note selected by
365 * the user without needing to know where it came from. The data type
366 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
367 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
368 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
369 * The GET_CONTENT action is similar to the PICK action, where the activity
370 * will return to its caller a piece of data selected by the user. Here,
371 * however, the caller specifies the type of data they desire instead of
372 * the type of data the user will be picking from.</p>
373 * </ol>
374 *
375 * <p>Given these capabilities, the following intents will resolve to the
376 * NotesList activity:</p>
377 *
378 * <ul>
379 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
380 * activities that can be used as top-level entry points into an
381 * application.</p>
382 * <li> <p><b>{ action=android.app.action.MAIN,
383 * category=android.app.category.LAUNCHER }</b> is the actual intent
384 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700385 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700386 * data=content://com.google.provider.NotePad/notes }</b>
387 * displays a list of all the notes under
388 * "content://com.google.provider.NotePad/notes", which
389 * the user can browse through and see the details on.</p>
390 * <li> <p><b>{ action=android.app.action.PICK
391 * data=content://com.google.provider.NotePad/notes }</b>
392 * provides a list of the notes under
393 * "content://com.google.provider.NotePad/notes", from which
394 * the user can pick a note whose data URL is returned back to the caller.</p>
395 * <li> <p><b>{ action=android.app.action.GET_CONTENT
396 * type=vnd.android.cursor.item/vnd.google.note }</b>
397 * is similar to the pick action, but allows the caller to specify the
398 * kind of data they want back so that the system can find the appropriate
399 * activity to pick something of that data type.</p>
400 * </ul>
401 *
402 * <p>The second activity,
403 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
404 * note entry and allows them to edit it. It can do two things as described
405 * by its two intent templates:
406 * <ol>
407 * <li><pre>
408 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700409 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
410 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
411 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
412 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700413 * &lt;/intent-filter&gt;</pre>
414 * <p>The first, primary, purpose of this activity is to let the user interact
415 * with a single note, as decribed by the MIME type
416 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
417 * either VIEW a note or allow the user to EDIT it. Again we support the
418 * DEFAULT category to allow the activity to be launched without explicitly
419 * specifying its component.</p>
420 * <li><pre>
421 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700422 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
423 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
424 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700425 * &lt;/intent-filter&gt;</pre>
426 * <p>The secondary use of this activity is to insert a new note entry into
427 * an existing directory of notes. This is used when the user creates a new
428 * note: the INSERT action is executed on the directory of notes, causing
429 * this activity to run and have the user create the new note data which
430 * it then adds to the content provider.</p>
431 * </ol>
432 *
433 * <p>Given these capabilities, the following intents will resolve to the
434 * NoteEditor activity:</p>
435 *
436 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700437 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * shows the user the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.EDIT
441 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
442 * allows the user to edit the content of note <var>{ID}</var>.</p>
443 * <li> <p><b>{ action=android.app.action.INSERT
444 * data=content://com.google.provider.NotePad/notes }</b>
445 * creates a new, empty note in the notes list at
446 * "content://com.google.provider.NotePad/notes"
447 * and allows the user to edit it. If they keep their changes, the URI
448 * of the newly created note is returned to the caller.</p>
449 * </ul>
450 *
451 * <p>The last activity,
452 * <code>com.android.notepad.TitleEditor</code>, allows the user to
453 * edit the title of a note. This could be implemented as a class that the
454 * application directly invokes (by explicitly setting its component in
455 * the Intent), but here we show a way you can publish alternative
456 * operations on existing data:</p>
457 *
458 * <pre>
459 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700460 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
461 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
463 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
464 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700465 * &lt;/intent-filter&gt;</pre>
466 *
467 * <p>In the single intent template here, we
468 * have created our own private action called
469 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
470 * edit the title of a note. It must be invoked on a specific note
471 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
472 * view and edit actions, but here displays and edits the title contained
473 * in the note data.
474 *
475 * <p>In addition to supporting the default category as usual, our title editor
476 * also supports two other standard categories: ALTERNATIVE and
477 * SELECTED_ALTERNATIVE. Implementing
478 * these categories allows others to find the special action it provides
479 * without directly knowing about it, through the
480 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
481 * more often to build dynamic menu items with
482 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
483 * template here was also supply an explicit name for the template
484 * (via <code>android:label="@string/resolve_title"</code>) to better control
485 * what the user sees when presented with this activity as an alternative
486 * action to the data they are viewing.
487 *
488 * <p>Given these capabilities, the following intent will resolve to the
489 * TitleEditor activity:</p>
490 *
491 * <ul>
492 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
493 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
494 * displays and allows the user to edit the title associated
495 * with note <var>{ID}</var>.</p>
496 * </ul>
497 *
498 * <h3>Standard Activity Actions</h3>
499 *
500 * <p>These are the current standard actions that Intent defines for launching
501 * activities (usually through {@link Context#startActivity}. The most
502 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
503 * {@link #ACTION_EDIT}.
504 *
505 * <ul>
506 * <li> {@link #ACTION_MAIN}
507 * <li> {@link #ACTION_VIEW}
508 * <li> {@link #ACTION_ATTACH_DATA}
509 * <li> {@link #ACTION_EDIT}
510 * <li> {@link #ACTION_PICK}
511 * <li> {@link #ACTION_CHOOSER}
512 * <li> {@link #ACTION_GET_CONTENT}
513 * <li> {@link #ACTION_DIAL}
514 * <li> {@link #ACTION_CALL}
515 * <li> {@link #ACTION_SEND}
516 * <li> {@link #ACTION_SENDTO}
517 * <li> {@link #ACTION_ANSWER}
518 * <li> {@link #ACTION_INSERT}
519 * <li> {@link #ACTION_DELETE}
520 * <li> {@link #ACTION_RUN}
521 * <li> {@link #ACTION_SYNC}
522 * <li> {@link #ACTION_PICK_ACTIVITY}
523 * <li> {@link #ACTION_SEARCH}
524 * <li> {@link #ACTION_WEB_SEARCH}
525 * <li> {@link #ACTION_FACTORY_TEST}
526 * </ul>
527 *
528 * <h3>Standard Broadcast Actions</h3>
529 *
530 * <p>These are the current standard actions that Intent defines for receiving
531 * broadcasts (usually through {@link Context#registerReceiver} or a
532 * &lt;receiver&gt; tag in a manifest).
533 *
534 * <ul>
535 * <li> {@link #ACTION_TIME_TICK}
536 * <li> {@link #ACTION_TIME_CHANGED}
537 * <li> {@link #ACTION_TIMEZONE_CHANGED}
538 * <li> {@link #ACTION_BOOT_COMPLETED}
539 * <li> {@link #ACTION_PACKAGE_ADDED}
540 * <li> {@link #ACTION_PACKAGE_CHANGED}
541 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800542 * <li> {@link #ACTION_PACKAGE_RESTARTED}
543 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700544 * <li> {@link #ACTION_UID_REMOVED}
545 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700546 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700547 * <li> {@link #ACTION_POWER_DISCONNECTED}
548 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Categories</h3>
552 *
553 * <p>These are the current standard categories that can be used to further
554 * clarify an Intent via {@link #addCategory}.
555 *
556 * <ul>
557 * <li> {@link #CATEGORY_DEFAULT}
558 * <li> {@link #CATEGORY_BROWSABLE}
559 * <li> {@link #CATEGORY_TAB}
560 * <li> {@link #CATEGORY_ALTERNATIVE}
561 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
562 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800563 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700564 * <li> {@link #CATEGORY_HOME}
565 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700566 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400567 * <li> {@link #CATEGORY_CAR_DOCK}
568 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500569 * <li> {@link #CATEGORY_LE_DESK_DOCK}
570 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200571 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700572 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * </ul>
574 *
575 * <h3>Standard Extra Data</h3>
576 *
577 * <p>These are the current standard fields that can be used as extra data via
578 * {@link #putExtra}.
579 *
580 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800581 * <li> {@link #EXTRA_ALARM_COUNT}
582 * <li> {@link #EXTRA_BCC}
583 * <li> {@link #EXTRA_CC}
584 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
585 * <li> {@link #EXTRA_DATA_REMOVED}
586 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500587 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_DOCK_STATE_CAR}
590 * <li> {@link #EXTRA_DOCK_STATE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
592 * <li> {@link #EXTRA_DONT_KILL_APP}
593 * <li> {@link #EXTRA_EMAIL}
594 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700597 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700599 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
601 * <li> {@link #EXTRA_REPLACING}
602 * <li> {@link #EXTRA_SHORTCUT_ICON}
603 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
604 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_SHORTCUT_NAME}
607 * <li> {@link #EXTRA_SUBJECT}
608 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800610 * <li> {@link #EXTRA_TITLE}
611 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * </ul>
613 *
614 * <h3>Flags</h3>
615 *
616 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
618 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800620public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700621 private static final String ATTR_ACTION = "action";
622 private static final String TAG_CATEGORIES = "categories";
623 private static final String ATTR_CATEGORY = "category";
624 private static final String TAG_EXTRA = "extra";
625 private static final String ATTR_TYPE = "type";
626 private static final String ATTR_COMPONENT = "component";
627 private static final String ATTR_DATA = "data";
628 private static final String ATTR_FLAGS = "flags";
629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 // ---------------------------------------------------------------------
631 // ---------------------------------------------------------------------
632 // Standard intent activity actions (see action variable).
633
634 /**
635 * Activity Action: Start as a main entry point, does not expect to
636 * receive data.
637 * <p>Input: nothing
638 * <p>Output: nothing
639 */
640 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
641 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700643 /**
644 * Activity Action: Display the data to the user. This is the most common
645 * action performed on data -- it is the generic action you can use on
646 * a piece of data to get the most reasonable thing to occur. For example,
647 * when used on a contacts entry it will view the entry; when used on a
648 * mailto: URI it will bring up a compose window filled with the information
649 * supplied by the URI; when used with a tel: URI it will invoke the
650 * dialer.
651 * <p>Input: {@link #getData} is URI from which to retrieve data.
652 * <p>Output: nothing.
653 */
654 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
655 public static final String ACTION_VIEW = "android.intent.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 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
659 * performed on a piece of data.
660 */
661 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
Steve McKayc78bcb82015-07-31 14:35:22 -0700664 * Activity Action: Quick view the data.
665 * <p>Input: {@link #getData} is URI from which to retrieve data.
666 * <p>Output: nothing.
667 * @hide
668 */
669 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
670 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
671
672 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 * Used to indicate that some piece of data should be attached to some other
674 * place. For example, image data could be attached to a contact. It is up
675 * to the recipient to decide where the data should be attached; the intent
676 * does not specify the ultimate destination.
677 * <p>Input: {@link #getData} is URI of data to be attached.
678 * <p>Output: nothing.
679 */
680 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
681 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800682
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700683 /**
684 * Activity Action: Provide explicit editable access to the given data.
685 * <p>Input: {@link #getData} is URI of data to be edited.
686 * <p>Output: nothing.
687 */
688 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
689 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700691 /**
692 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
693 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
694 * The extras can contain type specific data to pass through to the editing/creating
695 * activity.
696 * <p>Output: The URI of the item that was picked. This must be a content:
697 * URI so that any receiver can access it.
698 */
699 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
700 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800701
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 /**
703 * Activity Action: Pick an item from the data, returning what was selected.
704 * <p>Input: {@link #getData} is URI containing a directory of data
705 * (vnd.android.cursor.dir/*) from which to pick an item.
706 * <p>Output: The URI of the item that was picked.
707 */
708 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
709 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700711 /**
712 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800713 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700714 * <p>Output: An Intent representing the shortcut. The intent must contain three
715 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
716 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * (value: ShortcutIconResource).</p>
718 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700719 * @see #EXTRA_SHORTCUT_INTENT
720 * @see #EXTRA_SHORTCUT_NAME
721 * @see #EXTRA_SHORTCUT_ICON
722 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
723 * @see android.content.Intent.ShortcutIconResource
724 */
725 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
726 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
727
728 /**
729 * The name of the extra used to define the Intent of a shortcut.
730 *
731 * @see #ACTION_CREATE_SHORTCUT
732 */
733 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
734 /**
735 * The name of the extra used to define the name of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
738 */
739 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
740 /**
741 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
742 *
743 * @see #ACTION_CREATE_SHORTCUT
744 */
745 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
746 /**
747 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
748 *
749 * @see #ACTION_CREATE_SHORTCUT
750 * @see android.content.Intent.ShortcutIconResource
751 */
752 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
753 "android.intent.extra.shortcut.ICON_RESOURCE";
754
755 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800756 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700757 *
758 * @see Intent#ACTION_CREATE_SHORTCUT
759 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800760 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
761 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700762 */
763 public static class ShortcutIconResource implements Parcelable {
764 /**
765 * The package name of the application containing the icon.
766 */
767 public String packageName;
768
769 /**
770 * The resource name of the icon, including package, name and type.
771 */
772 public String resourceName;
773
774 /**
775 * Creates a new ShortcutIconResource for the specified context and resource
776 * identifier.
777 *
778 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700779 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700780 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700781 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700783 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700784 ShortcutIconResource icon = new ShortcutIconResource();
785 icon.packageName = context.getPackageName();
786 icon.resourceName = context.getResources().getResourceName(resourceId);
787 return icon;
788 }
789
790 /**
791 * Used to read a ShortcutIconResource from a Parcel.
792 */
793 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
794 new Parcelable.Creator<ShortcutIconResource>() {
795
796 public ShortcutIconResource createFromParcel(Parcel source) {
797 ShortcutIconResource icon = new ShortcutIconResource();
798 icon.packageName = source.readString();
799 icon.resourceName = source.readString();
800 return icon;
801 }
802
803 public ShortcutIconResource[] newArray(int size) {
804 return new ShortcutIconResource[size];
805 }
806 };
807
808 /**
809 * No special parcel contents.
810 */
811 public int describeContents() {
812 return 0;
813 }
814
815 public void writeToParcel(Parcel dest, int flags) {
816 dest.writeString(packageName);
817 dest.writeString(resourceName);
818 }
819
820 @Override
821 public String toString() {
822 return resourceName;
823 }
824 }
825
826 /**
827 * Activity Action: Display an activity chooser, allowing the user to pick
828 * what they want to before proceeding. This can be used as an alternative
829 * to the standard activity picker that is displayed by the system when
830 * you try to start an activity with multiple possible matches, with these
831 * differences in behavior:
832 * <ul>
833 * <li>You can specify the title that will appear in the activity chooser.
834 * <li>The user does not have the option to make one of the matching
835 * activities a preferred activity, and all possible activities will
836 * always be shown even if one of them is currently marked as the
837 * preferred activity.
838 * </ul>
839 * <p>
840 * This action should be used when the user will naturally expect to
841 * select an activity in order to proceed. An example if when not to use
842 * it is when the user clicks on a "mailto:" link. They would naturally
843 * expect to go directly to their mail app, so startActivity() should be
844 * called directly: it will
845 * either launch the current preferred app, or put up a dialog allowing the
846 * user to pick an app to use and optionally marking that as preferred.
847 * <p>
848 * In contrast, if the user is selecting a menu item to send a picture
849 * they are viewing to someone else, there are many different things they
850 * may want to do at this point: send it through e-mail, upload it to a
851 * web service, etc. In this case the CHOOSER action should be used, to
852 * always present to the user a list of the things they can do, with a
853 * nice title given by the caller such as "Send this photo with:".
854 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700855 * If you need to grant URI permissions through a chooser, you must specify
856 * the permissions to be granted on the ACTION_CHOOSER Intent
857 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
858 * {@link #setClipData} to specify the URIs to be granted as well as
859 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
860 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
861 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700862 * As a convenience, an Intent of this form can be created with the
863 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700864 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700865 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700866 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
867 * and can optionally have a {@link #EXTRA_TITLE} field containing the
868 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700869 * <p>
870 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700871 */
872 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
873 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
874
875 /**
876 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
877 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700878 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
879 * target intent, also optionally supplying a title. If the target
880 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
881 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
882 * set in the returned chooser intent, with its ClipData set appropriately:
883 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500884 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700885 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700886 * @param target The Intent that the user will be selecting an activity
887 * to perform.
888 * @param title Optional title that will be displayed in the chooser.
889 * @return Return a new Intent object that you can hand to
890 * {@link Context#startActivity(Intent) Context.startActivity()} and
891 * related methods.
892 */
893 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700894 return createChooser(target, title, null);
895 }
896
897 /**
898 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
899 *
900 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
901 * target intent, also optionally supplying a title. If the target
902 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
903 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
904 * set in the returned chooser intent, with its ClipData set appropriately:
905 * either a direct reflection of {@link #getClipData()} if that is non-null,
906 * or a new ClipData built from {@link #getData()}.</p>
907 *
908 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
909 * when the user makes a choice. This can be useful if the calling application wants
910 * to remember the last chosen target and surface it as a more prominent or one-touch
911 * affordance elsewhere in the UI for next time.</p>
912 *
913 * @param target The Intent that the user will be selecting an activity
914 * to perform.
915 * @param title Optional title that will be displayed in the chooser.
916 * @param sender Optional IntentSender to be called when a choice is made.
917 * @return Return a new Intent object that you can hand to
918 * {@link Context#startActivity(Intent) Context.startActivity()} and
919 * related methods.
920 */
921 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700922 Intent intent = new Intent(ACTION_CHOOSER);
923 intent.putExtra(EXTRA_INTENT, target);
924 if (title != null) {
925 intent.putExtra(EXTRA_TITLE, title);
926 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927
Adam Powell0b3c1122014-10-09 12:50:14 -0700928 if (sender != null) {
929 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
930 }
931
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700932 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700933 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
934 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
935 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700936 if (permFlags != 0) {
937 ClipData targetClipData = target.getClipData();
938 if (targetClipData == null && target.getData() != null) {
939 ClipData.Item item = new ClipData.Item(target.getData());
940 String[] mimeTypes;
941 if (target.getType() != null) {
942 mimeTypes = new String[] { target.getType() };
943 } else {
944 mimeTypes = new String[] { };
945 }
946 targetClipData = new ClipData(null, mimeTypes, item);
947 }
948 if (targetClipData != null) {
949 intent.setClipData(targetClipData);
950 intent.addFlags(permFlags);
951 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700952 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700953
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700954 return intent;
955 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700957 /**
958 * Activity Action: Allow the user to select a particular kind of data and
959 * return it. This is different than {@link #ACTION_PICK} in that here we
960 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800961 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700962 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900963 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700964 * etc.
965 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900966 * 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 -0700967 * of data, such as a person contact, you set the MIME type to the kind of
968 * data you want and launch it with {@link Context#startActivity(Intent)}.
969 * The system will then launch the best application to select that kind
970 * of data for you.
971 * <p>
972 * You may also be interested in any of a set of types of content the user
973 * can pick. For example, an e-mail application that wants to allow the
974 * user to add an attachment to an e-mail message can use this action to
975 * bring up a list of all of the types of content the user can attach.
976 * <p>
977 * In this case, you should wrap the GET_CONTENT intent with a chooser
978 * (through {@link #createChooser}), which will give the proper interface
979 * for the user to pick how to send your data and allow you to specify
980 * a prompt indicating what they are doing. You will usually specify a
981 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
982 * broad range of content types the user can select from.
983 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900984 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700985 * only pick from data that can be represented as a stream. This is
986 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
987 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800988 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900989 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800990 * is locally available on the device. For example, if this extra is set
991 * to true then an image picker should not show any pictures that are available
992 * from a remote server but not already on the local device (thus requiring
993 * they be downloaded when opened).
994 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800995 * If the caller can handle multiple returned items (the user performing
996 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
997 * to indicate this.
998 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700999 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1000 * that no URI is supplied in the intent, as there are no constraints on
1001 * where the returned data originally comes from. You may also include the
1002 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001003 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001004 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1005 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001006 * <p>
1007 * Output: The URI of the item that was picked. This must be a content:
1008 * URI so that any receiver can access it.
1009 */
1010 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1011 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1012 /**
1013 * Activity Action: Dial a number as specified by the data. This shows a
1014 * UI with the number being dialed, allowing the user to explicitly
1015 * initiate the call.
1016 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1017 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1018 * number.
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1023 /**
1024 * Activity Action: Perform a call to someone specified by the data.
1025 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1026 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1027 * number.
1028 * <p>Output: nothing.
1029 *
1030 * <p>Note: there will be restrictions on which applications can initiate a
1031 * call; most applications should use the {@link #ACTION_DIAL}.
1032 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1033 * numbers. Applications can <strong>dial</strong> emergency numbers using
1034 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001035 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001036 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001037 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001038 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001039 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001040 */
1041 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1042 public static final String ACTION_CALL = "android.intent.action.CALL";
1043 /**
1044 * Activity Action: Perform a call to an emergency number specified by the
1045 * data.
1046 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1047 * tel: URI of an explicit phone number.
1048 * <p>Output: nothing.
1049 * @hide
1050 */
1051 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1052 /**
1053 * Activity action: Perform a call to any number (emergency or not)
1054 * specified by the data.
1055 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1056 * tel: URI of an explicit phone number.
1057 * <p>Output: nothing.
1058 * @hide
1059 */
1060 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1061 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001062 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1063 * sending this intent is a no-op.
1064 * <p>Input: No data should be specified. get*Extra may have an optional
1065 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1066 * send the activation result.
1067 * <p>Output: nothing.
1068 * @hide
1069 */
1070 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1071 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1072 "android.intent.action.SIM_ACTIVATION_REQUEST";
1073 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001074 * Activity Action: Send a message to someone specified by the data.
1075 * <p>Input: {@link #getData} is URI describing the target.
1076 * <p>Output: nothing.
1077 */
1078 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1079 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1080 /**
1081 * Activity Action: Deliver some data to someone else. Who the data is
1082 * being delivered to is not specified; it is up to the receiver of this
1083 * action to ask the user where the data should be sent.
1084 * <p>
1085 * When launching a SEND intent, you should usually wrap it in a chooser
1086 * (through {@link #createChooser}), which will give the proper interface
1087 * for the user to pick how to send your data and allow you to specify
1088 * a prompt indicating what they are doing.
1089 * <p>
1090 * Input: {@link #getType} is the MIME type of the data being sent.
1091 * get*Extra can have either a {@link #EXTRA_TEXT}
1092 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1093 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1094 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1095 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001096 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1097 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1098 * your text with HTML formatting.
1099 * <p>
1100 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1101 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1102 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1103 * content: URIs and other advanced features of {@link ClipData}. If
1104 * using this approach, you still must supply the same data through the
1105 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1106 * for compatibility with old applications. If you don't set a ClipData,
1107 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001108 * <p>
1109 * Optional standard extras, which may be interpreted by some recipients as
1110 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1111 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1112 * <p>
1113 * Output: nothing.
1114 */
1115 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1116 public static final String ACTION_SEND = "android.intent.action.SEND";
1117 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001118 * Activity Action: Deliver multiple data to someone else.
1119 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001120 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001121 * <p>
1122 * Input: {@link #getType} is the MIME type of the data being sent.
1123 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001124 * #EXTRA_STREAM} field, containing the data to be sent. If using
1125 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1126 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001127 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001128 * Multiple types are supported, and receivers should handle mixed types
1129 * whenever possible. The right way for the receiver to check them is to
1130 * use the content resolver on each URI. The intent sender should try to
1131 * put the most concrete mime type in the intent type, but it can fall
1132 * back to {@literal <type>/*} or {@literal *}/* as needed.
1133 * <p>
1134 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1135 * be image/jpg, but if you are sending image/jpg and image/png, then the
1136 * intent's type should be image/*.
1137 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001138 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1139 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1140 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1141 * content: URIs and other advanced features of {@link ClipData}. If
1142 * using this approach, you still must supply the same data through the
1143 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1144 * for compatibility with old applications. If you don't set a ClipData,
1145 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1146 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001147 * Optional standard extras, which may be interpreted by some recipients as
1148 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1149 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1150 * <p>
1151 * Output: nothing.
1152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1155 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001156 * Activity Action: Handle an incoming phone call.
1157 * <p>Input: nothing.
1158 * <p>Output: nothing.
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1162 /**
1163 * Activity Action: Insert an empty item into the given container.
1164 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1165 * in which to place the data.
1166 * <p>Output: URI of the new data that was created.
1167 */
1168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1170 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001171 * Activity Action: Create a new item in the given container, initializing it
1172 * from the current contents of the clipboard.
1173 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1174 * in which to place the data.
1175 * <p>Output: URI of the new data that was created.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1179 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001180 * Activity Action: Delete the given data from its container.
1181 * <p>Input: {@link #getData} is URI of data to be deleted.
1182 * <p>Output: nothing.
1183 */
1184 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1185 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1186 /**
1187 * Activity Action: Run the data, whatever that means.
1188 * <p>Input: ? (Note: this is currently specific to the test harness.)
1189 * <p>Output: nothing.
1190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_RUN = "android.intent.action.RUN";
1193 /**
1194 * Activity Action: Perform a data synchronization.
1195 * <p>Input: ?
1196 * <p>Output: ?
1197 */
1198 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1199 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1200 /**
1201 * Activity Action: Pick an activity given an intent, returning the class
1202 * selected.
1203 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1204 * used with {@link PackageManager#queryIntentActivities} to determine the
1205 * set of activities from which to pick.
1206 * <p>Output: Class name of the activity that was selected.
1207 */
1208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1209 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1210 /**
1211 * Activity Action: Perform a search.
1212 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1213 * is the text to search for. If empty, simply
1214 * enter your search results Activity with the search UI activated.
1215 * <p>Output: nothing.
1216 */
1217 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1218 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1219 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001220 * Activity Action: Start the platform-defined tutorial
1221 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1222 * is the text to search for. If empty, simply
1223 * enter your search results Activity with the search UI activated.
1224 * <p>Output: nothing.
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1228 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001229 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001230 * <p>
1231 * Input: {@link android.app.SearchManager#QUERY
1232 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1233 * a url starts with http or https, the site will be opened. If it is plain
1234 * text, Google search will be applied.
1235 * <p>
1236 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001240
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001241 /**
Jim Miller07994402012-05-02 14:22:27 -07001242 * Activity Action: Perform assist action.
1243 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001244 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1245 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001246 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1247 * information.
Jim Miller07994402012-05-02 14:22:27 -07001248 * Output: nothing.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001252
1253 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001254 * Activity Action: Perform voice assist action.
1255 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001256 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1257 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001258 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001259 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001260 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1264
1265 /**
Adam Skory7140a252013-09-11 12:04:58 +01001266 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1267 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001268 */
1269 public static final String EXTRA_ASSIST_PACKAGE
1270 = "android.intent.extra.ASSIST_PACKAGE";
1271
1272 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001273 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1274 * application package at the time the assist was invoked.
1275 */
1276 public static final String EXTRA_ASSIST_UID
1277 = "android.intent.extra.ASSIST_UID";
1278
1279 /**
Adam Skory7140a252013-09-11 12:04:58 +01001280 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1281 * information supplied by the current foreground app at the time of the assist request.
1282 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001283 */
1284 public static final String EXTRA_ASSIST_CONTEXT
1285 = "android.intent.extra.ASSIST_CONTEXT";
1286
Jim Miller07994402012-05-02 14:22:27 -07001287 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001288 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1289 * keyboard as the primary input device for assistance.
1290 */
1291 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1292 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1293
1294 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001295 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1296 * that was used to invoke the assist.
1297 */
1298 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1299 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1300
1301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 * Activity Action: List all available applications
1303 * <p>Input: Nothing.
1304 * <p>Output: nothing.
1305 */
1306 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1307 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1308 /**
1309 * Activity Action: Show settings for choosing wallpaper
1310 * <p>Input: Nothing.
1311 * <p>Output: Nothing.
1312 */
1313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1314 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1315
1316 /**
1317 * Activity Action: Show activity for reporting a bug.
1318 * <p>Input: Nothing.
1319 * <p>Output: Nothing.
1320 */
1321 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1322 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1323
1324 /**
1325 * Activity Action: Main entry point for factory tests. Only used when
1326 * the device is booting in factory test node. The implementing package
1327 * must be installed in the system image.
1328 * <p>Input: nothing
1329 * <p>Output: nothing
1330 */
1331 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1332
1333 /**
1334 * Activity Action: The user pressed the "call" button to go to the dialer
1335 * or other appropriate UI for placing a call.
1336 * <p>Input: Nothing.
1337 * <p>Output: Nothing.
1338 */
1339 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1340 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1341
1342 /**
1343 * Activity Action: Start Voice Command.
1344 * <p>Input: Nothing.
1345 * <p>Output: Nothing.
1346 */
1347 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1348 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001349
1350 /**
1351 * Activity Action: Start action associated with long pressing on the
1352 * search key.
1353 * <p>Input: Nothing.
1354 * <p>Output: Nothing.
1355 */
1356 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1357 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001358
Jacek Surazski86b6c532009-05-13 14:38:28 +02001359 /**
1360 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1361 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001362 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001363 * <p>Input: No data is specified. The bug report is passed in using
1364 * an {@link #EXTRA_BUG_REPORT} field.
1365 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001366 *
1367 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001368 */
1369 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1370 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001371
1372 /**
1373 * Activity Action: Show power usage information to the user.
1374 * <p>Input: Nothing.
1375 * <p>Output: Nothing.
1376 */
1377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1378 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001379
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001380 /**
1381 * Activity Action: Setup wizard to launch after a platform update. This
1382 * activity should have a string meta-data field associated with it,
1383 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1384 * the platform for setup. The activity will be launched only if
1385 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1386 * same value.
1387 * <p>Input: Nothing.
1388 * <p>Output: Nothing.
1389 * @hide
1390 */
1391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1392 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001393
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001394 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001395 * Activity Action: Show settings for managing network data usage of a
1396 * specific application. Applications should define an activity that offers
1397 * options to control data usage.
1398 */
1399 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1400 public static final String ACTION_MANAGE_NETWORK_USAGE =
1401 "android.intent.action.MANAGE_NETWORK_USAGE";
1402
1403 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001404 * Activity Action: Launch application installer.
1405 * <p>
1406 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001407 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1408 * you can also use "package:<package-name>" to install an application for the
1409 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001410 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1411 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1412 * <p>
1413 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1414 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001415 * <p>
1416 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1417 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1418 * in order to launch the application installer.
1419 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001420 *
1421 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1422 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1423 * @see #EXTRA_RETURN_RESULT
1424 */
1425 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1426 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1427
1428 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001429 * Activity Action: Launch ephemeral installer.
1430 * <p>
1431 * Input: The data must be a http: URI that the ephemeral application is registered
1432 * to handle.
1433 * <p class="note">
1434 * This is a protected intent that can only be sent by the system.
1435 * </p>
1436 *
1437 * @hide
1438 */
1439 @SystemApi
1440 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1441 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1442 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1443
1444 /**
1445 * Service Action: Resolve ephemeral application.
1446 * <p>
1447 * The system will have a persistent connection to this service.
1448 * This is a protected intent that can only be sent by the system.
1449 * </p>
1450 *
1451 * @hide
1452 */
1453 @SystemApi
1454 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1455 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1456 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1457
1458 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001459 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1460 * package. Specifies the installer package name; this package will receive the
1461 * {@link #ACTION_APP_ERROR} intent.
1462 */
1463 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1464 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1465
1466 /**
1467 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1468 * package. Specifies that the application being installed should not be
1469 * treated as coming from an unknown source, but as coming from the app
1470 * invoking the Intent. For this to work you must start the installer with
1471 * startActivityForResult().
1472 */
1473 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1474 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1475
1476 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001477 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1478 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001479 * data field originated from.
1480 */
rich cannings706e8ba2012-08-20 13:20:14 -07001481 public static final String EXTRA_ORIGINATING_URI
1482 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001483
1484 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001485 * This extra can be used with any Intent used to launch an activity, supplying information
1486 * about who is launching that activity. This field contains a {@link android.net.Uri}
1487 * object, typically an http: or https: URI of the web site that the referral came from;
1488 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1489 * a native application that it came from.
1490 *
1491 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1492 * instead of directly retrieving the extra. It is also valid for applications to
1493 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1494 * a string, not a Uri; the field here, if supplied, will always take precedence,
1495 * however.</p>
1496 *
1497 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001498 */
1499 public static final String EXTRA_REFERRER
1500 = "android.intent.extra.REFERRER";
1501
1502 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001503 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1504 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1505 * not be created, in particular when Intent extras are supplied through the
1506 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1507 * schemes.
1508 *
1509 * @see #EXTRA_REFERRER
1510 */
1511 public static final String EXTRA_REFERRER_NAME
1512 = "android.intent.extra.REFERRER_NAME";
1513
1514 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001515 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1516 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1517 * @hide
1518 */
1519 public static final String EXTRA_ORIGINATING_UID
1520 = "android.intent.extra.ORIGINATING_UID";
1521
1522 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001523 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1524 * package. Tells the installer UI to skip the confirmation with the user
1525 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001526 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1527 * will no longer show an interstitial message about updating existing
1528 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001529 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001530 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001531 public static final String EXTRA_ALLOW_REPLACE
1532 = "android.intent.extra.ALLOW_REPLACE";
1533
1534 /**
1535 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1536 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1537 * return to the application the result code of the install/uninstall. The returned result
1538 * code will be {@link android.app.Activity#RESULT_OK} on success or
1539 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1540 */
1541 public static final String EXTRA_RETURN_RESULT
1542 = "android.intent.extra.RETURN_RESULT";
1543
1544 /**
1545 * Package manager install result code. @hide because result codes are not
1546 * yet ready to be exposed.
1547 */
1548 public static final String EXTRA_INSTALL_RESULT
1549 = "android.intent.extra.INSTALL_RESULT";
1550
1551 /**
1552 * Activity Action: Launch application uninstaller.
1553 * <p>
1554 * Input: The data must be a package: URI whose scheme specific part is
1555 * the package name of the current installed package to be uninstalled.
1556 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1557 * <p>
1558 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1559 * succeeded.
1560 */
1561 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1562 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1563
1564 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001565 * Specify whether the package should be uninstalled for all users.
1566 * @hide because these should not be part of normal application flow.
1567 */
1568 public static final String EXTRA_UNINSTALL_ALL_USERS
1569 = "android.intent.extra.UNINSTALL_ALL_USERS";
1570
1571 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001572 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1573 * describing the last run version of the platform that was setup.
1574 * @hide
1575 */
1576 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1577
Svet Ganov3695b8a2015-03-24 16:30:25 -07001578 /**
1579 * Activity action: Launch UI to manage the permissions of an app.
1580 * <p>
1581 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1582 * will be managed by the launched UI.
1583 * </p>
1584 * <p>
1585 * Output: Nothing.
1586 * </p>
1587 *
1588 * @see #EXTRA_PACKAGE_NAME
1589 *
1590 * @hide
1591 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001592 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1593 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1594 "android.intent.action.MANAGE_APP_PERMISSIONS";
1595
1596 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001597 * Activity action: Launch UI to manage permissions.
1598 * <p>
1599 * Input: Nothing.
1600 * </p>
1601 * <p>
1602 * Output: Nothing.
1603 * </p>
1604 *
1605 * @hide
1606 */
Svet Ganov321f0152015-05-16 22:51:50 -07001607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1608 public static final String ACTION_MANAGE_PERMISSIONS =
1609 "android.intent.action.MANAGE_PERMISSIONS";
1610
1611 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001612 * Activity action: Launch UI to review permissions for an app.
1613 * The system uses this intent if permission review for apps not
1614 * supporting the new runtime permissions model is enabled. In
1615 * this mode a permission review is required before any of the
1616 * app components can run.
1617 * <p>
1618 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1619 * permissions will be reviewed (mandatory).
1620 * </p>
1621 * <p>
1622 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1623 * be fired after the permission review (optional).
1624 * </p>
1625 * <p>
1626 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1627 * be invoked after the permission review (optional).
1628 * </p>
1629 * <p>
1630 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1631 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1632 * </p>
1633 * <p>
1634 * Output: Nothing.
1635 * </p>
1636 *
1637 * @see #EXTRA_PACKAGE_NAME
1638 * @see #EXTRA_INTENT
1639 * @see #EXTRA_REMOTE_CALLBACK
1640 * @see #EXTRA_RESULT_NEEDED
1641 *
1642 * @hide
1643 */
1644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1645 public static final String ACTION_REVIEW_PERMISSIONS =
1646 "android.intent.action.REVIEW_PERMISSIONS";
1647
1648 /**
1649 * Intent extra: A callback for reporting remote result as a bundle.
1650 * <p>
1651 * Type: IRemoteCallback
1652 * </p>
1653 *
1654 * @hide
1655 */
1656 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1657
1658 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001659 * Intent extra: An app package name.
1660 * <p>
1661 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001662 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001663 *
1664 * @hide
1665 */
1666 @SystemApi
1667 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1668
1669 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001670 * Intent extra: An extra for specifying whether a result is needed.
1671 * <p>
1672 * Type: boolean
1673 * </p>
1674 *
1675 * @hide
1676 */
1677 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1678
1679 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001680 * Broadcast action that requests current permission granted information. It will respond
1681 * to the request by sending a broadcast with action defined by
1682 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001683 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1684 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1685 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001686 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001687 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1688 * number of permissions requested and the number of granted additional permissions
1689 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001690 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001691 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1692 * of localized permission group names that are granted in
1693 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001694 *
1695 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1696 * permissions and the total number of apps requesting runtime permissions will be the first
1697 * and second elements respectively of an int[] in the response as
1698 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1699 *
1700 * @hide
1701 */
1702 public static final String ACTION_GET_PERMISSIONS_COUNT
1703 = "android.intent.action.GET_PERMISSIONS_COUNT";
1704
1705 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001706 * Broadcast action that requests list of all apps that have runtime permissions. It will
1707 * respond to the request by sending a broadcast with action defined by
1708 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1709 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1710 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1711 * a null upon failure.
1712 *
1713 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1714 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1715 * will contain the list of app labels corresponding ot the apps in the first list.
1716 *
1717 * @hide
1718 */
1719 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1720 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1721
1722 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001723 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1724 * @hide
1725 */
1726 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1727 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1728
1729 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001730 * List of CharSequence of localized permission group labels.
1731 * @hide
1732 */
1733 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1734 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1735
1736 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001737 * String list of apps that have one or more runtime permissions.
1738 * @hide
1739 */
1740 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1741 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1742
1743 /**
1744 * String list of app labels for apps that have one or more runtime permissions.
1745 * @hide
1746 */
1747 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1748 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1749
1750 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001751 * Boolean list describing if the app is a system app for apps that have one or more runtime
1752 * permissions.
1753 * @hide
1754 */
1755 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1756 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1757
1758 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001759 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001760 * @hide
1761 */
1762 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1763 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1764
1765 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001766 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1767 * @hide
1768 */
1769 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1770 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1771
1772 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001773 * Activity action: Launch UI to manage which apps have a given permission.
1774 * <p>
1775 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1776 * to which will be managed by the launched UI.
1777 * </p>
1778 * <p>
1779 * Output: Nothing.
1780 * </p>
1781 *
1782 * @see #EXTRA_PERMISSION_NAME
1783 *
1784 * @hide
1785 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001786 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1787 public static final String ACTION_MANAGE_PERMISSION_APPS =
1788 "android.intent.action.MANAGE_PERMISSION_APPS";
1789
1790 /**
1791 * Intent extra: The name of a permission.
1792 * <p>
1793 * Type: String
1794 * </p>
1795 *
1796 * @hide
1797 */
1798 @SystemApi
1799 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001801 // ---------------------------------------------------------------------
1802 // ---------------------------------------------------------------------
1803 // Standard intent broadcast actions (see action variable).
1804
1805 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001806 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1807 * <p>
1808 * For historical reasons, the name of this broadcast action refers to the power
1809 * state of the screen but it is actually sent in response to changes in the
1810 * overall interactive state of the device.
1811 * </p><p>
1812 * This broadcast is sent when the device becomes non-interactive which may have
1813 * nothing to do with the screen turning off. To determine the
1814 * actual state of the screen, use {@link android.view.Display#getState}.
1815 * </p><p>
1816 * See {@link android.os.PowerManager#isInteractive} for details.
1817 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001818 * You <em>cannot</em> receive this through components declared in
1819 * manifests, only by explicitly registering for it with
1820 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1821 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001822 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001823 * <p class="note">This is a protected intent that can only be sent
1824 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 */
1826 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1827 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001829 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001830 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1831 * <p>
1832 * For historical reasons, the name of this broadcast action refers to the power
1833 * state of the screen but it is actually sent in response to changes in the
1834 * overall interactive state of the device.
1835 * </p><p>
1836 * This broadcast is sent when the device becomes interactive which may have
1837 * nothing to do with the screen turning on. To determine the
1838 * actual state of the screen, use {@link android.view.Display#getState}.
1839 * </p><p>
1840 * See {@link android.os.PowerManager#isInteractive} for details.
1841 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001842 * You <em>cannot</em> receive this through components declared in
1843 * manifests, only by explicitly registering for it with
1844 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1845 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001847 * <p class="note">This is a protected intent that can only be sent
1848 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 */
1850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001852
1853 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001854 * Broadcast Action: Sent after the system stops dreaming.
1855 *
1856 * <p class="note">This is a protected intent that can only be sent by the system.
1857 * It is only sent to registered receivers.</p>
1858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1861
1862 /**
1863 * Broadcast Action: Sent after the system starts dreaming.
1864 *
1865 * <p class="note">This is a protected intent that can only be sent by the system.
1866 * It is only sent to registered receivers.</p>
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1870
1871 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001872 * 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 -07001873 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001874 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001875 * <p class="note">This is a protected intent that can only be sent
1876 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001879 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001880
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 /**
1882 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001883 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001884 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001885 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1886 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001887 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001888 * <p class="note">This is a protected intent that can only be sent
1889 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1893 /**
1894 * Broadcast Action: The time was set.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1898 /**
1899 * Broadcast Action: The date has changed.
1900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1903 /**
1904 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1905 * <ul>
1906 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1907 * </ul>
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1914 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001915 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1916 * DNS entries should be tossed.
1917 * @hide
1918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1921 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001922 * Alarm Changed Action: This is broadcast when the AlarmClock
1923 * application's alarm is set or unset. It is used by the
1924 * AlarmClock application and the StatusBar service.
1925 * @hide
1926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001929
1930 /**
1931 * Broadcast Action: This is broadcast once, after the system has finished
1932 * booting and the user is in a "locked" state. A user is locked when their
1933 * credential-encrypted private app data storage is unavailable. Once the
1934 * user has entered their credentials (such as a lock pattern or PIN) for
1935 * the first time, the {@link #ACTION_BOOT_COMPLETED} broadcast will be
1936 * sent.
1937 * <p>
1938 * You must hold the
1939 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1940 * order to receive this broadcast.
1941 * <p class="note">
1942 * This is a protected intent that can only be sent by the system.
1943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1946
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001948 * Broadcast Action: This is broadcast once, after the system has finished
1949 * booting. It can be used to perform application-specific initialization,
1950 * such as installing alarms. You must hold the
1951 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1952 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001953 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1958 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 /**
1961 * Broadcast Action: This is broadcast when a user action should request a
1962 * temporary system dialog to dismiss. Some examples of temporary system
1963 * dialogs are the notification window-shade and the recent tasks dialog.
1964 */
1965 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1966 /**
1967 * Broadcast Action: Trigger the download and eventual installation
1968 * of a package.
1969 * <p>Input: {@link #getData} is the URI of the package file to download.
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.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001973 *
1974 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001976 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1978 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1979 /**
1980 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001981 * device. The data contains the name of the package. Note that the
1982 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001983 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 * <ul>
1985 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1986 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1987 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1988 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001989 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001990 * <p class="note">This is a protected intent that can only be sent
1991 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1995 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001996 * Broadcast Action: A new version of an application package has been
1997 * installed, replacing an existing version that was previously installed.
1998 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001999 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002000 * <ul>
2001 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2002 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002003 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002004 * <p class="note">This is a protected intent that can only be sent
2005 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2009 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002010 * Broadcast Action: A new version of your application has been installed
2011 * over an existing one. This is only sent to the application that was
2012 * replaced. It does not contain any additional data; to receive it, just
2013 * use an intent filter for this action.
2014 *
2015 * <p class="note">This is a protected intent that can only be sent
2016 * by the system.
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2020 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002021 * Broadcast Action: An existing application package has been removed from
2022 * the device. The data contains the name of the package. The package
2023 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002024 * <ul>
2025 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2026 * to the package.
2027 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2028 * application -- data and code -- is being removed.
2029 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2030 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2031 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002032 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002033 * <p class="note">This is a protected intent that can only be sent
2034 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2038 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002039 * Broadcast Action: An existing application package has been completely
2040 * removed from the device. The data contains the name of the package.
2041 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2042 * {@link #EXTRA_DATA_REMOVED} is true and
2043 * {@link #EXTRA_REPLACING} is false of that broadcast.
2044 *
2045 * <ul>
2046 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2047 * to the package.
2048 * </ul>
2049 *
2050 * <p class="note">This is a protected intent that can only be sent
2051 * by the system.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_PACKAGE_FULLY_REMOVED
2055 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2056 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002057 * Broadcast Action: An existing application package has been changed (e.g.
2058 * a component has been enabled or disabled). The data contains the name of
2059 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002060 * <ul>
2061 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002062 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002063 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002064 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2065 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002067 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002068 * <p class="note">This is a protected intent that can only be sent
2069 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2073 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002074 * @hide
2075 * Broadcast Action: Ask system services if there is any reason to
2076 * restart the given package. The data contains the name of the
2077 * package.
2078 * <ul>
2079 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2080 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2081 * </ul>
2082 *
2083 * <p class="note">This is a protected intent that can only be sent
2084 * by the system.
2085 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002086 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2088 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2089 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002090 * Broadcast Action: The user has restarted a package, and all of its
2091 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002092 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002093 * be removed. Note that the restarted package does <em>not</em>
2094 * receive this broadcast.
2095 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002096 * <ul>
2097 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2098 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002099 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002100 * <p class="note">This is a protected intent that can only be sent
2101 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002102 */
2103 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2104 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2105 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002106 * Broadcast Action: The user has cleared the data of a package. This should
2107 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002108 * its persistent data is erased and this broadcast sent.
2109 * Note that the cleared package does <em>not</em>
2110 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002111 * <ul>
2112 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2113 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002114 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002115 * <p class="note">This is a protected intent that can only be sent
2116 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117 */
2118 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2119 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2120 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002121 * Broadcast Action: A user ID has been removed from the system. The user
2122 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002123 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002124 * <p class="note">This is a protected intent that can only be sent
2125 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002126 */
2127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002129
2130 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002131 * Broadcast Action: Sent to the installer package of an application
2132 * when that application is first launched (that is the first time it
2133 * is moved out of the stopped state). The data contains the name of the package.
2134 *
2135 * <p class="note">This is a protected intent that can only be sent
2136 * by the system.
2137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2140
2141 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002142 * Broadcast Action: Sent to the system package verifier when a package
2143 * needs to be verified. The data contains the package URI.
2144 * <p class="note">
2145 * This is a protected intent that can only be sent by the system.
2146 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002147 */
2148 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2149 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2150
2151 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002152 * Broadcast Action: Sent to the system package verifier when a package is
2153 * verified. The data contains the package URI.
2154 * <p class="note">
2155 * This is a protected intent that can only be sent by the system.
2156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2159
2160 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002161 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2162 * needs to be verified. The data contains the filter data hosts to be verified against.
2163 * <p class="note">
2164 * This is a protected intent that can only be sent by the system.
2165 * </p>
2166 *
2167 * @hide
2168 */
2169 @SystemApi
2170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2171 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2172
2173 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002174 * Broadcast Action: Resources for a set of packages (which were
2175 * previously unavailable) are currently
2176 * available since the media on which they exist is available.
2177 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2178 * list of packages whose availability changed.
2179 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2180 * list of uids of packages whose availability changed.
2181 * Note that the
2182 * packages in this list do <em>not</em> receive this broadcast.
2183 * The specified set of packages are now available on the system.
2184 * <p>Includes the following extras:
2185 * <ul>
2186 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2187 * whose resources(were previously unavailable) are currently available.
2188 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2189 * packages whose resources(were previously unavailable)
2190 * are currently available.
2191 * </ul>
2192 *
2193 * <p class="note">This is a protected intent that can only be sent
2194 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002195 */
2196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002197 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2198 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002199
2200 /**
2201 * Broadcast Action: Resources for a set of packages are currently
2202 * unavailable since the media on which they exist is unavailable.
2203 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2204 * list of packages whose availability changed.
2205 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2206 * list of uids of packages whose availability changed.
2207 * The specified set of packages can no longer be
2208 * launched and are practically unavailable on the system.
2209 * <p>Inclues the following extras:
2210 * <ul>
2211 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2212 * whose resources are no longer available.
2213 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2214 * whose resources are no longer available.
2215 * </ul>
2216 *
2217 * <p class="note">This is a protected intent that can only be sent
2218 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002219 */
2220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002221 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002222 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002223
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 /**
2225 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002226 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002227 * This should <em>only</em> be used to determine when the wallpaper
2228 * has changed to show the new wallpaper to the user. You should certainly
2229 * never, in response to this, change the wallpaper or other attributes of
2230 * it such as the suggested size. That would be crazy, right? You'd cause
2231 * all kinds of loops, especially if other apps are doing similar things,
2232 * right? Of course. So please don't do this.
2233 *
2234 * @deprecated Modern applications should use
2235 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2236 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2237 * shown behind their UI, rather than watching for this broadcast and
2238 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002239 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002240 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002241 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2242 /**
2243 * Broadcast Action: The current device {@link android.content.res.Configuration}
2244 * (orientation, locale, etc) has changed. When such a change happens, the
2245 * UIs (view hierarchy) will need to be rebuilt based on this new
2246 * information; for the most part, applications don't need to worry about
2247 * this, because the system will take care of stopping and restarting the
2248 * application to make sure it sees the new changes. Some system code that
2249 * can not be restarted will need to watch for this action and handle it
2250 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002251 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002252 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002253 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002254 * in manifests, only by explicitly registering for it with
2255 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2256 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002257 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002258 * <p class="note">This is a protected intent that can only be sent
2259 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002260 *
2261 * @see android.content.res.Configuration
2262 */
2263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2264 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2265 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002266 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002267 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002268 * <p class="note">This is a protected intent that can only be sent
2269 * by the system.
2270 */
2271 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2272 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2273 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002274 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2275 * charging state, level, and other information about the battery.
2276 * See {@link android.os.BatteryManager} for documentation on the
2277 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002278 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002280 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002281 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002282 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002283 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2284 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2285 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2286 * broadcasts that are sent and can be received through manifest
2287 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002288 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002289 * <p class="note">This is a protected intent that can only be sent
2290 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002291 */
2292 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2293 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2294 /**
2295 * Broadcast Action: Indicates low battery condition on the device.
2296 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002297 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2303 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002304 * Broadcast Action: Indicates the battery is now okay after being low.
2305 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2306 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002307 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002308 * <p class="note">This is a protected intent that can only be sent
2309 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002310 */
2311 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2312 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2313 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002314 * Broadcast Action: External power has been connected to the device.
2315 * This is intended for applications that wish to register specifically to this notification.
2316 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2317 * stay active to receive this notification. This action can be used to implement actions
2318 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002319 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002320 * <p class="note">This is a protected intent that can only be sent
2321 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002322 */
2323 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002324 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002325 /**
2326 * Broadcast Action: External power has been removed from the device.
2327 * This is intended for applications that wish to register specifically to this notification.
2328 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2329 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002330 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002331 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002332 * <p class="note">This is a protected intent that can only be sent
2333 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002336 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002337 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002338 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002339 * Broadcast Action: Device is shutting down.
2340 * This is broadcast when the device is being shut down (completely turned
2341 * off, not sleeping). Once the broadcast is complete, the final shutdown
2342 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002343 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002344 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002345 * <p class="note">This is a protected intent that can only be sent
2346 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002347 * <p>May include the following extras:
2348 * <ul>
2349 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2350 * shutdown is only for userspace processes. If not set, assumed to be false.
2351 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002354 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002355 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002356 * Activity Action: Start this activity to request system shutdown.
2357 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002358 * to request confirmation from the user before shutting down. The optional boolean
2359 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2360 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002361 *
2362 * <p class="note">This is a protected intent that can only be sent
2363 * by the system.
2364 *
2365 * {@hide}
2366 */
2367 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2368 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002369 * Broadcast Action: A sticky broadcast that indicates low memory
2370 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002371 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002372 * <p class="note">This is a protected intent that can only be sent
2373 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002374 */
2375 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2376 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2377 /**
2378 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002379 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002380 * <p class="note">This is a protected intent that can only be sent
2381 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002382 */
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2384 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2385 /**
Jake Hambybb371632010-08-23 18:16:48 -07002386 * Broadcast Action: A sticky broadcast that indicates a memory full
2387 * condition on the device. This is intended for activities that want
2388 * to be able to fill the data partition completely, leaving only
2389 * enough free space to prevent system-wide SQLite failures.
2390 *
2391 * <p class="note">This is a protected intent that can only be sent
2392 * by the system.
2393 *
2394 * {@hide}
2395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2398 /**
2399 * Broadcast Action: Indicates memory full condition on the device
2400 * no longer exists.
2401 *
2402 * <p class="note">This is a protected intent that can only be sent
2403 * by the system.
2404 *
2405 * {@hide}
2406 */
2407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2408 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2409 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002410 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2411 * and package management should be started.
2412 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2413 * notification.
2414 */
2415 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2416 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2417 /**
2418 * Broadcast Action: The device has entered USB Mass Storage mode.
2419 * This is used mainly for the USB Settings panel.
2420 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2421 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002422 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002423 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002424 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002425 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2426
2427 /**
2428 * Broadcast Action: The device has exited USB Mass Storage mode.
2429 * This is used mainly for the USB Settings panel.
2430 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2431 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002432 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002434 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2436
2437 /**
2438 * Broadcast Action: External media has been removed.
2439 * The path to the mount point for the removed media is contained in the Intent.mData field.
2440 */
2441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2442 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2443
2444 /**
2445 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002446 * 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 -07002447 */
2448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2449 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2450
2451 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002452 * Broadcast Action: External media is present, and being disk-checked
2453 * 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 -08002454 */
2455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2456 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2457
2458 /**
2459 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2460 * 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 -08002461 */
2462 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2463 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2464
2465 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002466 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002467 * 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 -07002468 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2469 * media was mounted read only.
2470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2473
2474 /**
2475 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002476 * 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 -07002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2480
2481 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002482 * Broadcast Action: External media is no longer being shared via USB mass storage.
2483 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2484 *
2485 * @hide
2486 */
2487 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2488
2489 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002490 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2491 * The path to the mount point for the removed media is contained in the Intent.mData field.
2492 */
2493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2494 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2495
2496 /**
2497 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002498 * 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 -07002499 */
2500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2501 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2502
2503 /**
2504 * Broadcast Action: User has expressed the desire to remove the external storage media.
2505 * Applications should close all files they have open within the mount point when they receive this intent.
2506 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2507 */
2508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2509 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2510
2511 /**
2512 * Broadcast Action: The media scanner has started scanning a directory.
2513 * The path to the directory being scanned is contained in the Intent.mData field.
2514 */
2515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2516 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2517
2518 /**
2519 * Broadcast Action: The media scanner has finished scanning a directory.
2520 * The path to the scanned directory is contained in the Intent.mData field.
2521 */
2522 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2523 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2524
2525 /**
2526 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2527 * The path to the file is contained in the Intent.mData field.
2528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2531
2532 /**
2533 * Broadcast Action: The "Media Button" was pressed. Includes a single
2534 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2535 * caused the broadcast.
2536 */
2537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2538 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2539
2540 /**
2541 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2542 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2543 * caused the broadcast.
2544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2547
2548 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2549 // location; they are not general-purpose actions.
2550
2551 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002552 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2555 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2556 "android.intent.action.GTALK_CONNECTED";
2557
2558 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002559 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002560 */
2561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2562 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2563 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002564
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002565 /**
2566 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002567 */
2568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2569 public static final String ACTION_INPUT_METHOD_CHANGED =
2570 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002571
2572 /**
2573 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2574 * more radios have been turned off or on. The intent will have the following extra value:</p>
2575 * <ul>
2576 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2577 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2578 * turned off</li>
2579 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002580 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002581 * <p class="note">This is a protected intent that can only be sent
2582 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2585 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2586
2587 /**
2588 * Broadcast Action: Some content providers have parts of their namespace
2589 * where they publish new events or items that the user may be especially
2590 * interested in. For these things, they may broadcast this action when the
2591 * set of interesting items change.
2592 *
2593 * For example, GmailProvider sends this notification when the set of unread
2594 * mail in the inbox changes.
2595 *
2596 * <p>The data of the intent identifies which part of which provider
2597 * changed. When queried through the content resolver, the data URI will
2598 * return the data set in question.
2599 *
2600 * <p>The intent will have the following extra values:
2601 * <ul>
2602 * <li><em>count</em> - The number of items in the data set. This is the
2603 * same as the number of items in the cursor returned by querying the
2604 * data URI. </li>
2605 * </ul>
2606 *
2607 * This intent will be sent at boot (if the count is non-zero) and when the
2608 * data set changes. It is possible for the data set to change without the
2609 * count changing (for example, if a new unread message arrives in the same
2610 * sync operation in which a message is archived). The phone should still
2611 * ring/vibrate/etc as normal in this case.
2612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_PROVIDER_CHANGED =
2615 "android.intent.action.PROVIDER_CHANGED";
2616
2617 /**
2618 * Broadcast Action: Wired Headset plugged in or unplugged.
2619 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002620 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2621 * and documentation.
2622 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002623 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002624 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 */
2626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002627 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002628
2629 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002630 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2631 * <ul>
2632 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2633 * </ul>
2634 *
2635 * <p class="note">This is a protected intent that can only be sent
2636 * by the system.
2637 *
2638 * @hide
2639 */
2640 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2641 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2642 = "android.intent.action.ADVANCED_SETTINGS";
2643
2644 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002645 * Broadcast Action: Sent after application restrictions are changed.
2646 *
2647 * <p class="note">This is a protected intent that can only be sent
2648 * by the system.</p>
2649 */
2650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2651 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2652 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2653
2654 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002655 * Broadcast Action: An outgoing call is about to be placed.
2656 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002657 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002658 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002659 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002660 * the phone number originally intended to be dialed.</li>
2661 * </ul>
2662 * <p>Once the broadcast is finished, the resultData is used as the actual
2663 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002664 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 * outgoing call in turn: for example, a parental control application
2666 * might verify that the user is authorized to place the call at that
2667 * time, then a number-rewriting application might add an area code if
2668 * one was not specified.</p>
2669 * <p>For consistency, any receiver whose purpose is to prohibit phone
2670 * calls should have a priority of 0, to ensure it will see the final
2671 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002672 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002673 * should have a positive priority.
2674 * Negative priorities are reserved for the system for this broadcast;
2675 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002676 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2677 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002678 * <p>Emergency calls cannot be intercepted using this mechanism, and
2679 * other calls cannot be modified to call emergency numbers using this
2680 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002681 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2682 * call to use their own service instead. Those apps should first prevent
2683 * the call from being placed by setting resultData to <code>null</code>
2684 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002685 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002686 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2687 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002689 * <p class="note">This is a protected intent that can only be sent
2690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 */
2692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2693 public static final String ACTION_NEW_OUTGOING_CALL =
2694 "android.intent.action.NEW_OUTGOING_CALL";
2695
2696 /**
2697 * Broadcast Action: Have the device reboot. This is only for use by
2698 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002699 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002700 * <p class="note">This is a protected intent that can only be sent
2701 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 */
2703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2704 public static final String ACTION_REBOOT =
2705 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002706
Wei Huang97ecc9c2009-05-11 17:44:20 -07002707 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002708 * Broadcast Action: A sticky broadcast for changes in the physical
2709 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002710 *
2711 * <p>The intent will have the following extra values:
2712 * <ul>
2713 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002714 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002715 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002716 * <p>This is intended for monitoring the current physical dock state.
2717 * See {@link android.app.UiModeManager} for the normal API dealing with
2718 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002719 */
2720 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2721 public static final String ACTION_DOCK_EVENT =
2722 "android.intent.action.DOCK_EVENT";
2723
2724 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002725 * Broadcast Action: A broadcast when idle maintenance can be started.
2726 * This means that the user is not interacting with the device and is
2727 * not expected to do so soon. Typical use of the idle maintenance is
2728 * to perform somehow expensive tasks that can be postponed at a moment
2729 * when they will not degrade user experience.
2730 * <p>
2731 * <p class="note">In order to keep the device responsive in case of an
2732 * unexpected user interaction, implementations of a maintenance task
2733 * should be interruptible. In such a scenario a broadcast with action
2734 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2735 * should not do the maintenance work in
2736 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2737 * maintenance service by {@link Context#startService(Intent)}. Also
2738 * you should hold a wake lock while your maintenance service is running
2739 * to prevent the device going to sleep.
2740 * </p>
2741 * <p>
2742 * <p class="note">This is a protected intent that can only be sent by
2743 * the system.
2744 * </p>
2745 *
2746 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002747 *
2748 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002749 */
2750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2751 public static final String ACTION_IDLE_MAINTENANCE_START =
2752 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2753
2754 /**
2755 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2756 * This means that the user was not interacting with the device as a result
2757 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2758 * was sent and now the user started interacting with the device. Typical
2759 * use of the idle maintenance is to perform somehow expensive tasks that
2760 * can be postponed at a moment when they will not degrade user experience.
2761 * <p>
2762 * <p class="note">In order to keep the device responsive in case of an
2763 * unexpected user interaction, implementations of a maintenance task
2764 * should be interruptible. Hence, on receiving a broadcast with this
2765 * action, the maintenance task should be interrupted as soon as possible.
2766 * In other words, you should not do the maintenance work in
2767 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2768 * maintenance service that was started on receiving of
2769 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2770 * lock you acquired when your maintenance service started.
2771 * </p>
2772 * <p class="note">This is a protected intent that can only be sent
2773 * by the system.
2774 *
2775 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002776 *
2777 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002778 */
2779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2780 public static final String ACTION_IDLE_MAINTENANCE_END =
2781 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2782
2783 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002784 * Broadcast Action: a remote intent is to be broadcasted.
2785 *
2786 * A remote intent is used for remote RPC between devices. The remote intent
2787 * is serialized and sent from one device to another device. The receiving
2788 * device parses the remote intent and broadcasts it. Note that anyone can
2789 * broadcast a remote intent. However, if the intent receiver of the remote intent
2790 * does not trust intent broadcasts from arbitrary intent senders, it should require
2791 * the sender to hold certain permissions so only trusted sender's broadcast will be
2792 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002793 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002794 */
2795 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002796 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002797
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002798 /**
2799 * Broadcast Action: hook for permforming cleanup after a system update.
2800 *
2801 * The broadcast is sent when the system is booting, before the
2802 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2803 * image. A receiver for this should do its work and then disable itself
2804 * so that it does not get run again at the next boot.
2805 * @hide
2806 */
2807 public static final String ACTION_PRE_BOOT_COMPLETED =
2808 "android.intent.action.PRE_BOOT_COMPLETED";
2809
Amith Yamasani13593602012-03-22 16:16:17 -07002810 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002811 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002812 * on restricted users. The broadcast intent contains an extra
2813 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2814 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2815 * String[] depending on the restriction type.<p/>
2816 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002817 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2818 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2819 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002820 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2821 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002822 * @see RestrictionEntry
2823 */
2824 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2825 "android.intent.action.GET_RESTRICTION_ENTRIES";
2826
2827 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002828 * Sent the first time a user is starting, to allow system apps to
2829 * perform one time initialization. (This will not be seen by third
2830 * party applications because a newly initialized user does not have any
2831 * third party applications installed for it.) This is sent early in
2832 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002833 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2834 * broadcast, since it is part of a visible user interaction; be as quick
2835 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002836 */
2837 public static final String ACTION_USER_INITIALIZE =
2838 "android.intent.action.USER_INITIALIZE";
2839
2840 /**
2841 * Sent when a user switch is happening, causing the process's user to be
2842 * brought to the foreground. This is only sent to receivers registered
2843 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2844 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002845 * foreground. This is sent as a foreground
2846 * broadcast, since it is part of a visible user interaction; be as quick
2847 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002848 */
2849 public static final String ACTION_USER_FOREGROUND =
2850 "android.intent.action.USER_FOREGROUND";
2851
2852 /**
2853 * Sent when a user switch is happening, causing the process's user to be
2854 * sent to the background. This is only sent to receivers registered
2855 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2856 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002857 * background. This is sent as a foreground
2858 * broadcast, since it is part of a visible user interaction; be as quick
2859 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002860 */
2861 public static final String ACTION_USER_BACKGROUND =
2862 "android.intent.action.USER_BACKGROUND";
2863
2864 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002865 * Broadcast sent to the system when a user is added. Carries an extra
2866 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2867 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002868 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002869 * @hide
2870 */
2871 public static final String ACTION_USER_ADDED =
2872 "android.intent.action.USER_ADDED";
2873
2874 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002875 * Broadcast sent by the system when a user is started. Carries an extra
2876 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002877 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002878 * that has been started. This is sent as a foreground
2879 * broadcast, since it is part of a visible user interaction; be as quick
2880 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002881 * @hide
2882 */
2883 public static final String ACTION_USER_STARTED =
2884 "android.intent.action.USER_STARTED";
2885
2886 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002887 * Broadcast sent when a user is in the process of starting. Carries an extra
2888 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2889 * sent to registered receivers, not manifest receivers. It is sent to all
2890 * users (including the one that is being started). You must hold
2891 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2892 * this broadcast. This is sent as a background broadcast, since
2893 * its result is not part of the primary UX flow; to safely keep track of
2894 * started/stopped state of a user you can use this in conjunction with
2895 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2896 * other user state broadcasts since those are foreground broadcasts so can
2897 * execute in a different order.
2898 * @hide
2899 */
2900 public static final String ACTION_USER_STARTING =
2901 "android.intent.action.USER_STARTING";
2902
2903 /**
2904 * Broadcast sent when a user is going to be stopped. Carries an extra
2905 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2906 * sent to registered receivers, not manifest receivers. It is sent to all
2907 * users (including the one that is being stopped). You must hold
2908 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2909 * this broadcast. The user will not stop until all receivers have
2910 * handled the broadcast. This is sent as a background broadcast, since
2911 * its result is not part of the primary UX flow; to safely keep track of
2912 * started/stopped state of a user you can use this in conjunction with
2913 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2914 * other user state broadcasts since those are foreground broadcasts so can
2915 * execute in a different order.
2916 * @hide
2917 */
2918 public static final String ACTION_USER_STOPPING =
2919 "android.intent.action.USER_STOPPING";
2920
2921 /**
2922 * Broadcast sent to the system when a user is stopped. Carries an extra
2923 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2924 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2925 * specific package. This is only sent to registered receivers, not manifest
2926 * receivers. It is sent to all running users <em>except</em> the one that
2927 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002928 * @hide
2929 */
2930 public static final String ACTION_USER_STOPPED =
2931 "android.intent.action.USER_STOPPED";
2932
2933 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002934 * 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 -07002935 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002936 * one that has been removed. The user will not be completely removed until all receivers have
2937 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002938 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002939 * @hide
2940 */
2941 public static final String ACTION_USER_REMOVED =
2942 "android.intent.action.USER_REMOVED";
2943
2944 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002945 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002946 * the userHandle of the user to become the current one. This is only sent to
2947 * registered receivers, not manifest receivers. It is sent to all running users.
2948 * You must hold
2949 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002950 * @hide
2951 */
2952 public static final String ACTION_USER_SWITCHED =
2953 "android.intent.action.USER_SWITCHED";
2954
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002955 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002956 * Broadcast Action: Sent when the credential-encrypted private storage has
2957 * become unlocked for the target user. This is only sent to registered
2958 * receivers, not manifest receivers.
2959 */
2960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2961 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2962
2963 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002964 * Broadcast sent to the system when a user's information changes. Carries an extra
2965 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002966 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002967 * @hide
2968 */
2969 public static final String ACTION_USER_INFO_CHANGED =
2970 "android.intent.action.USER_INFO_CHANGED";
2971
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002972 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002973 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2974 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002975 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2976 * that need to display merged content across both primary and managed profiles need to
2977 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002978 * not manifest receivers.
2979 */
2980 public static final String ACTION_MANAGED_PROFILE_ADDED =
2981 "android.intent.action.MANAGED_PROFILE_ADDED";
2982
2983 /**
2984 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002985 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2986 * Only applications (for example Launchers) that need to display merged content across both
2987 * primary and managed profiles need to worry about this broadcast. This is only sent to
2988 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002989 */
2990 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2991 "android.intent.action.MANAGED_PROFILE_REMOVED";
2992
2993 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00002994 * Broadcast sent to the primary user when an associated managed profile's availability has
2995 * changed. This includes when the user toggles the profile's quiet mode, or when the profile
2996 * owner suspends the profile. Carries an extra {@link #EXTRA_USER} that specifies the
2997 * UserHandle of the profile. When quiet mode is changed, this broadcast will carry a boolean
2998 * extra {@link #EXTRA_QUIET_MODE} indicating the new state of quiet mode. This is only sent to
2999 * registered receivers, not manifest receivers.
3000 */
3001 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3002 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3003
3004 /**
3005 * Broadcast sent to the managed profile when its availability has changed. This includes when
3006 * the user toggles the profile's quiet mode, or when the profile owner suspends the profile.
3007 * When quiet mode is changed, this broadcast will carry a boolean extra
3008 * {@link #EXTRA_QUIET_MODE} indicating the new state of quiet mode. This is only sent to
3009 * registered receivers, not manifest receivers. See also
3010 * {@link #ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED}
3011 */
3012 public static final String ACTION_AVAILABILITY_CHANGED =
3013 "android.intent.action.AVAILABILITY_CHANGED";
3014
3015 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003016 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3017 */
3018 public static final String ACTION_QUICK_CLOCK =
3019 "android.intent.action.QUICK_CLOCK";
3020
Michael Wright0087a142013-02-05 16:29:39 -08003021 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003022 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003023 * @hide
3024 */
3025 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3026 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3027
Justin Kohd378ad72013-04-01 12:18:26 -07003028 /**
3029 * Broadcast Action: A global button was pressed. Includes a single
3030 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3031 * caused the broadcast.
3032 * @hide
3033 */
3034 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3035
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003036 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003037 * Activity Action: Allow the user to select and return one or more existing
3038 * documents. When invoked, the system will display the various
3039 * {@link DocumentsProvider} instances installed on the device, letting the
3040 * user interactively navigate through them. These documents include local
3041 * media, such as photos and video, and documents provided by installed
3042 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003043 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003044 * Each document is represented as a {@code content://} URI backed by a
3045 * {@link DocumentsProvider}, which can be opened as a stream with
3046 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3047 * {@link android.provider.DocumentsContract.Document} metadata.
3048 * <p>
3049 * All selected documents are returned to the calling application with
3050 * persistable read and write permission grants. If you want to maintain
3051 * access to the documents across device reboots, you need to explicitly
3052 * take the persistable permissions using
3053 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3054 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003055 * Callers must indicate the acceptable document MIME types through
3056 * {@link #setType(String)}. For example, to select photos, use
3057 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3058 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3059 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003060 * <p>
3061 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003062 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3063 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003064 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003065 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3066 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003067 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003068 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003069 * Output: The URI of the item that was picked, returned in
3070 * {@link #getData()}. This must be a {@code content://} URI so that any
3071 * receiver can access it. If multiple documents were selected, they are
3072 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003073 *
3074 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003075 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003076 * @see #ACTION_CREATE_DOCUMENT
3077 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003078 */
3079 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3080 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3081
3082 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003083 * Activity Action: Allow the user to create a new document. When invoked,
3084 * the system will display the various {@link DocumentsProvider} instances
3085 * installed on the device, letting the user navigate through them. The
3086 * returned document may be a newly created document with no content, or it
3087 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003088 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003089 * Each document is represented as a {@code content://} URI backed by a
3090 * {@link DocumentsProvider}, which can be opened as a stream with
3091 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3092 * {@link android.provider.DocumentsContract.Document} metadata.
3093 * <p>
3094 * Callers must indicate the concrete MIME type of the document being
3095 * created by setting {@link #setType(String)}. This MIME type cannot be
3096 * changed after the document is created.
3097 * <p>
3098 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3099 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003100 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003101 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3102 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003103 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003104 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003105 * Output: The URI of the item that was created. This must be a
3106 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003107 *
3108 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003109 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003110 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003111 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003112 */
3113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3114 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3115
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003116 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003117 * Activity Action: Allow the user to pick a directory subtree. When
3118 * invoked, the system will display the various {@link DocumentsProvider}
3119 * instances installed on the device, letting the user navigate through
3120 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003121 * <p>
3122 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003123 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3124 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3125 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003126 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003127 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003128 *
3129 * @see DocumentsContract
3130 */
3131 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003132 public static final String
3133 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003134
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003135 /** {@hide} */
3136 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3137
Christopher Tate6597e342015-02-17 12:15:25 -08003138 /**
3139 * Broadcast action: report that a settings element is being restored from backup. The intent
3140 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3141 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3142 * is the value of that settings entry prior to the restore operation. All of these values are
3143 * represented as strings.
3144 *
3145 * <p>This broadcast is sent only for settings provider entries known to require special handling
3146 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3147 * the provider's backup agent implementation.
3148 *
3149 * @see #EXTRA_SETTING_NAME
3150 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3151 * @see #EXTRA_SETTING_NEW_VALUE
3152 * {@hide}
3153 */
3154 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3155
3156 /** {@hide} */
3157 public static final String EXTRA_SETTING_NAME = "setting_name";
3158 /** {@hide} */
3159 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3160 /** {@hide} */
3161 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3162
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003163 /**
3164 * Activity Action: Process a piece of text.
3165 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3166 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3167 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3168 */
3169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3170 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3171 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003172 * The name of the extra used to define the text to be processed, as a
3173 * CharSequence. Note that this may be a styled CharSequence, so you must use
3174 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003175 */
3176 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3177 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003178 * The name of the boolean extra used to define if the processed text will be used as read-only.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003179 */
3180 public static final String EXTRA_PROCESS_TEXT_READONLY =
3181 "android.intent.extra.PROCESS_TEXT_READONLY";
3182
Bryce Leebc58f592015-09-25 16:43:01 -07003183 /**
3184 * Broadcast action: reports when a new thermal event has been reached. When the device
3185 * is reaching its maximum temperatue, the thermal level reported
3186 * {@hide}
3187 */
3188 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3189 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3190
3191 /** {@hide} */
3192 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3193
3194 /**
3195 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003196 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003197 * {@hide}
3198 */
3199 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3200
3201 /**
3202 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003203 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003204 * {@hide}
3205 */
3206 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3207
3208 /**
3209 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003210 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003211 * {@hide}
3212 */
3213 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3214
3215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003216 // ---------------------------------------------------------------------
3217 // ---------------------------------------------------------------------
3218 // Standard intent categories (see addCategory()).
3219
3220 /**
3221 * Set if the activity should be an option for the default action
3222 * (center press) to perform on a piece of data. Setting this will
3223 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003224 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003225 * Intent when initiating an action -- it is for use in intent filters
3226 * specified in packages.
3227 */
3228 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3229 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3230 /**
3231 * Activities that can be safely invoked from a browser must support this
3232 * category. For example, if the user is viewing a web page or an e-mail
3233 * and clicks on a link in the text, the Intent generated execute that
3234 * link will require the BROWSABLE category, so that only activities
3235 * supporting this category will be considered as possible actions. By
3236 * supporting this category, you are promising that there is nothing
3237 * damaging (without user intervention) that can happen by invoking any
3238 * matching Intent.
3239 */
3240 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3241 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3242 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003243 * Categories for activities that can participate in voice interaction.
3244 * An activity that supports this category must be prepared to run with
3245 * no UI shown at all (though in some case it may have a UI shown), and
3246 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3247 */
3248 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3249 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3250 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003251 * Set if the activity should be considered as an alternative action to
3252 * the data the user is currently viewing. See also
3253 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3254 * applies to the selection in a list of items.
3255 *
3256 * <p>Supporting this category means that you would like your activity to be
3257 * displayed in the set of alternative things the user can do, usually as
3258 * part of the current activity's options menu. You will usually want to
3259 * include a specific label in the &lt;intent-filter&gt; of this action
3260 * describing to the user what it does.
3261 *
3262 * <p>The action of IntentFilter with this category is important in that it
3263 * describes the specific action the target will perform. This generally
3264 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3265 * a specific name such as "com.android.camera.action.CROP. Only one
3266 * alternative of any particular action will be shown to the user, so using
3267 * a specific action like this makes sure that your alternative will be
3268 * displayed while also allowing other applications to provide their own
3269 * overrides of that particular action.
3270 */
3271 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3272 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3273 /**
3274 * Set if the activity should be considered as an alternative selection
3275 * action to the data the user has currently selected. This is like
3276 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3277 * of items from which the user can select, giving them alternatives to the
3278 * default action that will be performed on it.
3279 */
3280 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3281 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3282 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003283 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003284 */
3285 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3286 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3287 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 * Should be displayed in the top-level launcher.
3289 */
3290 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3291 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3292 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003293 * Indicates an activity optimized for Leanback mode, and that should
3294 * be displayed in the Leanback launcher.
3295 */
3296 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3297 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3298 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003299 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3300 * @hide
3301 */
3302 @SystemApi
3303 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3304 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003305 * Provides information about the package it is in; typically used if
3306 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3307 * a front-door to the user without having to be shown in the all apps list.
3308 */
3309 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3310 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3311 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003312 * This is the home activity, that is the first activity that is displayed
3313 * when the device boots.
3314 */
3315 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3316 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3317 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003318 * This is the home activity that is displayed when the device is finished setting up and ready
3319 * for use.
3320 * @hide
3321 */
3322 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3323 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3324 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003325 * This is the setup wizard activity, that is the first activity that is displayed
3326 * when the user sets up the device for the first time.
3327 * @hide
3328 */
3329 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3330 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3331 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003332 * This activity is a preference panel.
3333 */
3334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3335 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3336 /**
3337 * This activity is a development preference panel.
3338 */
3339 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3340 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3341 /**
3342 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343 */
3344 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3345 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3346 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003347 * This activity allows the user to browse and download new applications.
3348 */
3349 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3350 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3351 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003352 * This activity may be exercised by the monkey or other automated test tools.
3353 */
3354 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3355 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3356 /**
3357 * To be used as a test (not part of the normal user experience).
3358 */
3359 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3360 /**
3361 * To be used as a unit test (run through the Test Harness).
3362 */
3363 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3364 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003365 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003366 * experience).
3367 */
3368 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003369
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003371 * Used to indicate that an intent only wants URIs that can be opened with
3372 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3373 * must support at least the columns defined in {@link OpenableColumns} when
3374 * queried.
3375 *
3376 * @see #ACTION_GET_CONTENT
3377 * @see #ACTION_OPEN_DOCUMENT
3378 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003379 */
3380 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3381 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3382
3383 /**
3384 * To be used as code under test for framework instrumentation tests.
3385 */
3386 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3387 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003388 /**
3389 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003390 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3391 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003392 */
3393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3394 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3395 /**
3396 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003397 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3398 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003399 */
3400 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3401 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003402 /**
3403 * An activity to run when device is inserted into a analog (low end) dock.
3404 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3405 * information, see {@link android.app.UiModeManager}.
3406 */
3407 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3408 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3409
3410 /**
3411 * An activity to run when device is inserted into a digital (high end) dock.
3412 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3413 * information, see {@link android.app.UiModeManager}.
3414 */
3415 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3416 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003417
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003418 /**
3419 * Used to indicate that the activity can be used in a car environment.
3420 */
3421 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3422 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3423
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 // ---------------------------------------------------------------------
3425 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003426 // Application launch intent categories (see addCategory()).
3427
3428 /**
3429 * Used with {@link #ACTION_MAIN} to launch the browser application.
3430 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003431 * <p>NOTE: This should not be used as the primary key of an Intent,
3432 * since it will not result in the app launching with the correct
3433 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003434 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003435 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003436 */
3437 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3438 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3439
3440 /**
3441 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3442 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003443 * <p>NOTE: This should not be used as the primary key of an Intent,
3444 * since it will not result in the app launching with the correct
3445 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003446 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003447 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003448 */
3449 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3450 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3451
3452 /**
3453 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3454 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003455 * <p>NOTE: This should not be used as the primary key of an Intent,
3456 * since it will not result in the app launching with the correct
3457 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003458 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003459 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003460 */
3461 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3462 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3463
3464 /**
3465 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3466 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003467 * <p>NOTE: This should not be used as the primary key of an Intent,
3468 * since it will not result in the app launching with the correct
3469 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003470 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003471 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003472 */
3473 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3474 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3475
3476 /**
3477 * Used with {@link #ACTION_MAIN} to launch the email application.
3478 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003479 * <p>NOTE: This should not be used as the primary key of an Intent,
3480 * since it will not result in the app launching with the correct
3481 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003482 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003483 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003484 */
3485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3486 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3487
3488 /**
3489 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3490 * The activity should be able to view and manipulate image and video files
3491 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003492 * <p>NOTE: This should not be used as the primary key of an Intent,
3493 * since it will not result in the app launching with the correct
3494 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003495 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003496 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003497 */
3498 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3499 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3500
3501 /**
3502 * Used with {@link #ACTION_MAIN} to launch the maps application.
3503 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003504 * <p>NOTE: This should not be used as the primary key of an Intent,
3505 * since it will not result in the app launching with the correct
3506 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003507 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003508 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3512
3513 /**
3514 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3515 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003516 * <p>NOTE: This should not be used as the primary key of an Intent,
3517 * since it will not result in the app launching with the correct
3518 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003519 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003520 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003521 */
3522 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3523 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3524
3525 /**
3526 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003527 * The activity should be able to play, browse, or manipulate music files
3528 * stored on the device.
3529 * <p>NOTE: This should not be used as the primary key of an Intent,
3530 * since it will not result in the app launching with the correct
3531 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003532 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003533 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003534 */
3535 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3536 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3537
3538 // ---------------------------------------------------------------------
3539 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 // Standard extra data keys.
3541
3542 /**
3543 * The initial data to place in a newly created record. Use with
3544 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3545 * fields as would be given to the underlying ContentProvider.insert()
3546 * call.
3547 */
3548 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3549
3550 /**
3551 * A constant CharSequence that is associated with the Intent, used with
3552 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3553 * this may be a styled CharSequence, so you must use
3554 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3555 * retrieve it.
3556 */
3557 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3558
3559 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003560 * A constant String that is associated with the Intent, used with
3561 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3562 * as HTML formatted text. Note that you <em>must</em> also supply
3563 * {@link #EXTRA_TEXT}.
3564 */
3565 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3566
3567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003568 * A content: URI holding a stream of data associated with the Intent,
3569 * used with {@link #ACTION_SEND} to supply the data being sent.
3570 */
3571 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3572
3573 /**
3574 * A String[] holding e-mail addresses that should be delivered to.
3575 */
3576 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3577
3578 /**
3579 * A String[] holding e-mail addresses that should be carbon copied.
3580 */
3581 public static final String EXTRA_CC = "android.intent.extra.CC";
3582
3583 /**
3584 * A String[] holding e-mail addresses that should be blind carbon copied.
3585 */
3586 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3587
3588 /**
3589 * A constant string holding the desired subject line of a message.
3590 */
3591 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3592
3593 /**
3594 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003595 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003596 */
3597 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3598
3599 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003600 * An int representing the user id to be used.
3601 *
3602 * @hide
3603 */
3604 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3605
3606 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003607 * An Intent[] describing additional, alternate choices you would like shown with
3608 * {@link #ACTION_CHOOSER}.
3609 *
3610 * <p>An app may be capable of providing several different payload types to complete a
3611 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3612 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3613 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3614 * photo data or a hosted link where the photos can be viewed.</p>
3615 *
3616 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3617 * first/primary/preferred intent in the set. Additional intents specified in
3618 * this extra are ordered; by default intents that appear earlier in the array will be
3619 * preferred over intents that appear later in the array as matches for the same
3620 * target component. To alter this preference, a calling app may also supply
3621 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3622 */
3623 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3624
3625 /**
3626 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3627 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3628 *
3629 * <p>An app preparing an action for another app to complete may wish to allow the user to
3630 * disambiguate between several options for completing the action based on the chosen target
3631 * or otherwise refine the action before it is invoked.
3632 * </p>
3633 *
3634 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3635 * <ul>
3636 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3637 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3638 * chosen target beyond the first</li>
3639 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3640 * should fill in and send once the disambiguation is complete</li>
3641 * </ul>
3642 */
3643 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3644 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3645
3646 /**
3647 * A {@link ResultReceiver} used to return data back to the sender.
3648 *
3649 * <p>Used to complete an app-specific
3650 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3651 *
3652 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3653 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3654 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3655 * when the user selects a target component from the chooser. It is up to the recipient
3656 * to send a result to this ResultReceiver to signal that disambiguation is complete
3657 * and that the chooser should invoke the user's choice.</p>
3658 *
3659 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3660 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3661 * to match and fill in the final Intent or ChooserTarget before starting it.
3662 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3663 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3664 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3665 *
3666 * <p>The result code passed to the ResultReceiver should be
3667 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3668 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3669 * the chooser should finish without starting a target.</p>
3670 */
3671 public static final String EXTRA_RESULT_RECEIVER
3672 = "android.intent.extra.RESULT_RECEIVER";
3673
3674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003676 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 */
3678 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3679
3680 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003681 * A Parcelable[] of {@link Intent} or
3682 * {@link android.content.pm.LabeledIntent} objects as set with
3683 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3684 * a the front of the list of choices, when shown to the user with a
3685 * {@link #ACTION_CHOOSER}.
3686 */
3687 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3688
3689 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003690 * A {@link IntentSender} to start after ephemeral installation success.
3691 * @hide
3692 */
3693 @SystemApi
3694 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3695
3696 /**
3697 * A {@link IntentSender} to start after ephemeral installation failure.
3698 * @hide
3699 */
3700 @SystemApi
3701 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3702
3703 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003704 * A Bundle forming a mapping of potential target package names to different extras Bundles
3705 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3706 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3707 * be currently installed on the device.
3708 *
3709 * <p>An application may choose to provide alternate extras for the case where a user
3710 * selects an activity from a predetermined set of target packages. If the activity
3711 * the user selects from the chooser belongs to a package with its package name as
3712 * a key in this bundle, the corresponding extras for that package will be merged with
3713 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3714 * extra has the same key as an extra already present in the intent it will overwrite
3715 * the extra from the intent.</p>
3716 *
3717 * <p><em>Examples:</em>
3718 * <ul>
3719 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3720 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3721 * parameters for that target.</li>
3722 * <li>An application may offer additional metadata for known targets of a given intent
3723 * to pass along information only relevant to that target such as account or content
3724 * identifiers already known to that application.</li>
3725 * </ul></p>
3726 */
3727 public static final String EXTRA_REPLACEMENT_EXTRAS =
3728 "android.intent.extra.REPLACEMENT_EXTRAS";
3729
3730 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003731 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3732 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3733 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3734 * {@link ComponentName} of the chosen component.
3735 *
3736 * <p>In some situations this callback may never come, for example if the user abandons
3737 * the chooser, switches to another task or any number of other reasons. Apps should not
3738 * be written assuming that this callback will always occur.</p>
3739 */
3740 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3741 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3742
3743 /**
3744 * The {@link ComponentName} chosen by the user to complete an action.
3745 *
3746 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3747 */
3748 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3749
3750 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003751 * A {@link android.view.KeyEvent} object containing the event that
3752 * triggered the creation of the Intent it is in.
3753 */
3754 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3755
3756 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003757 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3758 * before shutting down.
3759 *
3760 * {@hide}
3761 */
3762 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3763
3764 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003765 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3766 * requested by the user.
3767 *
3768 * {@hide}
3769 */
3770 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3771 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3772
3773 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003774 * 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 -07003775 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3776 * of restarting the application.
3777 */
3778 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3779
3780 /**
3781 * A String holding the phone number originally entered in
3782 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3783 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3784 */
3785 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003786
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003787 /**
3788 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3789 * intents to supply the uid the package had been assigned. Also an optional
3790 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3791 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3792 * purpose.
3793 */
3794 public static final String EXTRA_UID = "android.intent.extra.UID";
3795
3796 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003797 * @hide String array of package names.
3798 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003799 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003800 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3801
3802 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003803 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3804 * intents to indicate whether this represents a full uninstall (removing
3805 * both the code and its data) or a partial uninstall (leaving its data,
3806 * implying that this is an update).
3807 */
3808 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003809
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003810 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003811 * @hide
3812 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3813 * intents to indicate that at this point the package has been removed for
3814 * all users on the device.
3815 */
3816 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3817 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3818
3819 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003820 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3821 * intents to indicate that this is a replacement of the package, so this
3822 * broadcast will immediately be followed by an add broadcast for a
3823 * different version of the same package.
3824 */
3825 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003826
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003827 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003828 * Used as an int extra field in {@link android.app.AlarmManager} intents
3829 * to tell the application being invoked how many pending alarms are being
3830 * delievered with the intent. For one-shot alarms this will always be 1.
3831 * For recurring alarms, this might be greater than 1 if the device was
3832 * asleep or powered off at the time an earlier alarm would have been
3833 * delivered.
3834 */
3835 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003836
Jacek Surazski86b6c532009-05-13 14:38:28 +02003837 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003838 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3839 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003840 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3841 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003842 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3843 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3844 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003845 */
3846 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3847
3848 /**
3849 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3850 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003851 */
3852 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3853
3854 /**
3855 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3856 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003857 */
3858 public static final int EXTRA_DOCK_STATE_DESK = 1;
3859
3860 /**
3861 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3862 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003863 */
3864 public static final int EXTRA_DOCK_STATE_CAR = 2;
3865
3866 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003867 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3868 * to represent that the phone is in a analog (low end) dock.
3869 */
3870 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3871
3872 /**
3873 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3874 * to represent that the phone is in a digital (high end) dock.
3875 */
3876 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3877
3878 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003879 * Boolean that can be supplied as meta-data with a dock activity, to
3880 * indicate that the dock should take over the home key when it is active.
3881 */
3882 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003883
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003884 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003885 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3886 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003887 */
3888 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3889
3890 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003891 * Used in the extra field in the remote intent. It's astring token passed with the
3892 * remote intent.
3893 */
3894 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3895 "android.intent.extra.remote_intent_token";
3896
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003897 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003898 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003899 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003900 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003901 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003902 "android.intent.extra.changed_component_name";
3903
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003904 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003905 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003906 * and contains a string array of all of the components that have changed. If
3907 * the state of the overall package has changed, then it will contain an entry
3908 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003909 */
3910 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3911 "android.intent.extra.changed_component_name_list";
3912
3913 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003914 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003915 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3916 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003917 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003918 */
3919 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3920 "android.intent.extra.changed_package_list";
3921
3922 /**
3923 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003924 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3925 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003926 * and contains an integer array of uids of all of the components
3927 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003928 */
3929 public static final String EXTRA_CHANGED_UID_LIST =
3930 "android.intent.extra.changed_uid_list";
3931
3932 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003933 * @hide
3934 * Magic extra system code can use when binding, to give a label for
3935 * who it is that has bound to a service. This is an integer giving
3936 * a framework string resource that can be displayed to the user.
3937 */
3938 public static final String EXTRA_CLIENT_LABEL =
3939 "android.intent.extra.client_label";
3940
3941 /**
3942 * @hide
3943 * Magic extra system code can use when binding, to give a PendingIntent object
3944 * that can be launched for the user to disable the system's use of this
3945 * service.
3946 */
3947 public static final String EXTRA_CLIENT_INTENT =
3948 "android.intent.extra.client_intent";
3949
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003950 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003951 * Extra used to indicate that an intent should only return data that is on
3952 * the local device. This is a boolean extra; the default is false. If true,
3953 * an implementation should only allow the user to select data that is
3954 * already on the device, not requiring it be downloaded from a remote
3955 * service when opened.
3956 *
3957 * @see #ACTION_GET_CONTENT
3958 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003959 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003960 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003961 */
3962 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003963 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003964
Amith Yamasani13593602012-03-22 16:16:17 -07003965 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003966 * Extra used to indicate that an intent can allow the user to select and
3967 * return multiple items. This is a boolean extra; the default is false. If
3968 * true, an implementation is allowed to present the user with a UI where
3969 * they can pick multiple items that are all returned to the caller. When
3970 * this happens, they should be returned as the {@link #getClipData()} part
3971 * of the result Intent.
3972 *
3973 * @see #ACTION_GET_CONTENT
3974 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003975 */
3976 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003977 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003978
3979 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003980 * The integer userHandle carried with broadcast intents related to addition, removal and
3981 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3982 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3983 *
Amith Yamasani13593602012-03-22 16:16:17 -07003984 * @hide
3985 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003986 public static final String EXTRA_USER_HANDLE =
3987 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003988
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003989 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003990 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3991 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3992 */
3993 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003994 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003995
3996 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003997 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003998 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3999 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004000 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004001 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4002
4003 /**
4004 * Extra sent in the intent to the BroadcastReceiver that handles
4005 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4006 * the restrictions as key/value pairs.
4007 */
4008 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4009 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004010
Amith Yamasani86118ba2013-03-28 14:33:16 -07004011 /**
4012 * Extra used in the response from a BroadcastReceiver that handles
4013 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4014 */
4015 public static final String EXTRA_RESTRICTIONS_INTENT =
4016 "android.intent.extra.restrictions_intent";
4017
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004018 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004019 * Extra used to communicate a set of acceptable MIME types. The type of the
4020 * extra is {@code String[]}. Values may be a combination of concrete MIME
4021 * types (such as "image/png") and/or partial MIME types (such as
4022 * "audio/*").
4023 *
4024 * @see #ACTION_GET_CONTENT
4025 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004026 */
4027 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4028
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004029 /**
4030 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4031 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004032 * When this is true, hardware devices can use this information to determine that
4033 * they shouldn't do a complete shutdown of their device since this is not a
4034 * complete shutdown down to the kernel, but only user space restarting.
4035 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004036 */
4037 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4038 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4039
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004040 /**
4041 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4042 * user has set their time format preferences to the 24 hour format.
4043 *
4044 * @hide for internal use only.
4045 */
4046 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4047 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4048
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004049 /** {@hide} */
4050 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4051
Rubin Xue8490f12015-06-25 12:17:48 +01004052 /** {@hide} */
4053 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4054
Santos Cordon15a13782015-03-31 18:32:31 -07004055 /**
4056 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4057 * activation request.
4058 * TODO: Add information about the structure and response data used with the pending intent.
4059 * @hide
4060 */
4061 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4062 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4063
Steve McKay6eaf38632015-08-04 10:11:01 -07004064 /** {@hide} */
4065 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4066
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004067 /**
4068 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4069 */
4070 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004071 // ---------------------------------------------------------------------
4072 // ---------------------------------------------------------------------
4073 // Intent flags (see mFlags variable).
4074
Tor Norbyed9273d62013-05-30 15:59:53 -07004075 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004076 @IntDef(flag = true, value = {
4077 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4078 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004079 @Retention(RetentionPolicy.SOURCE)
4080 public @interface GrantUriMode {}
4081
Jeff Sharkey846318a2014-04-04 12:12:41 -07004082 /** @hide */
4083 @IntDef(flag = true, value = {
4084 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4085 @Retention(RetentionPolicy.SOURCE)
4086 public @interface AccessUriMode {}
4087
4088 /**
4089 * Test if given mode flags specify an access mode, which must be at least
4090 * read and/or write.
4091 *
4092 * @hide
4093 */
4094 public static boolean isAccessUriMode(int modeFlags) {
4095 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4096 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4097 }
4098
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004099 /**
4100 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004101 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004102 * specified in its ClipData. When applying to an Intent's ClipData,
4103 * all URIs as well as recursive traversals through data or other ClipData
4104 * in Intent items will be granted; only the grant flags of the top-level
4105 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004106 */
4107 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4108 /**
4109 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004110 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004111 * specified in its ClipData. When applying to an Intent's ClipData,
4112 * all URIs as well as recursive traversals through data or other ClipData
4113 * in Intent items will be granted; only the grant flags of the top-level
4114 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004115 */
4116 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4117 /**
4118 * Can be set by the caller to indicate that this Intent is coming from
4119 * a background operation, not from direct user interaction.
4120 */
4121 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4122 /**
4123 * A flag you can enable for debugging: when set, log messages will be
4124 * printed during the resolution of this intent to show you what has
4125 * been found to create the final resolved list.
4126 */
4127 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004128 /**
4129 * If set, this intent will not match any components in packages that
4130 * are currently stopped. If this is not set, then the default behavior
4131 * is to include such applications in the result.
4132 */
4133 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4134 /**
4135 * If set, this intent will always match any components in packages that
4136 * are currently stopped. This is the default behavior when
4137 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4138 * flags are set, this one wins (it allows overriding of exclude for
4139 * places where the framework may automatically set the exclude flag).
4140 */
4141 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004142
4143 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004144 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004145 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004146 * persisted across device reboots until explicitly revoked with
4147 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4148 * grant for possible persisting; the receiving application must call
4149 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4150 * actually persist.
4151 *
4152 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4153 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4154 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004155 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004156 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004157 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004158
4159 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004160 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4161 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4162 * applies to any URI that is a prefix match against the original granted
4163 * URI. (Without this flag, the URI must match exactly for access to be
4164 * granted.) Another URI is considered a prefix match only when scheme,
4165 * authority, and all path segments defined by the prefix are an exact
4166 * match.
4167 */
4168 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4169
4170 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004171 * If set, the new activity is not kept in the history stack. As soon as
4172 * the user navigates away from it, the activity is finished. This may also
4173 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4174 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004175 *
4176 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4177 * is never invoked when the current activity starts a new activity which
4178 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004179 */
4180 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4181 /**
4182 * If set, the activity will not be launched if it is already running
4183 * at the top of the history stack.
4184 */
4185 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4186 /**
4187 * If set, this activity will become the start of a new task on this
4188 * history stack. A task (from the activity that started it to the
4189 * next task activity) defines an atomic group of activities that the
4190 * user can move to. Tasks can be moved to the foreground and background;
4191 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004192 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004193 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4194 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004195 *
4196 * <p>This flag is generally used by activities that want
4197 * to present a "launcher" style behavior: they give the user a list of
4198 * separate things that can be done, which otherwise run completely
4199 * independently of the activity launching them.
4200 *
4201 * <p>When using this flag, if a task is already running for the activity
4202 * you are now starting, then a new activity will not be started; instead,
4203 * the current task will simply be brought to the front of the screen with
4204 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4205 * to disable this behavior.
4206 *
4207 * <p>This flag can not be used when the caller is requesting a result from
4208 * the activity being launched.
4209 */
4210 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4211 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004212 * This flag is used to create a new task and launch an activity into it.
4213 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4214 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4215 * search through existing tasks for ones matching this Intent. Only if no such
4216 * task is found would a new task be created. When paired with
4217 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4218 * the search for a matching task and unconditionally start a new task.
4219 *
4220 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4221 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004222 * top-level application launcher.</strong> Used in conjunction with
4223 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4224 * behavior of bringing an existing task to the foreground. When set,
4225 * a new task is <em>always</em> started to host the Activity for the
4226 * Intent, regardless of whether there is already an existing task running
4227 * the same thing.
4228 *
4229 * <p><strong>Because the default system does not include graphical task management,
4230 * you should not use this flag unless you provide some way for a user to
4231 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004232 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004233 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4234 * creating new document tasks.
4235 *
4236 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004237 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004238 *
Scott Main7aee61f2011-02-08 11:25:01 -08004239 * <p>See
4240 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4241 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004242 *
4243 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4244 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004245 */
4246 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4247 /**
4248 * If set, and the activity being launched is already running in the
4249 * current task, then instead of launching a new instance of that activity,
4250 * all of the other activities on top of it will be closed and this Intent
4251 * will be delivered to the (now on top) old activity as a new Intent.
4252 *
4253 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4254 * If D calls startActivity() with an Intent that resolves to the component
4255 * of activity B, then C and D will be finished and B receive the given
4256 * Intent, resulting in the stack now being: A, B.
4257 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004258 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004259 * either receive the new intent you are starting here in its
4260 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004261 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004262 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4263 * the same intent, then it will be finished and re-created; for all other
4264 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4265 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004266 *
4267 * <p>This launch mode can also be used to good effect in conjunction with
4268 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4269 * of a task, it will bring any currently running instance of that task
4270 * to the foreground, and then clear it to its root state. This is
4271 * especially useful, for example, when launching an activity from the
4272 * notification manager.
4273 *
Scott Main7aee61f2011-02-08 11:25:01 -08004274 * <p>See
4275 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4276 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 */
4278 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4279 /**
4280 * If set and this intent is being used to launch a new activity from an
4281 * existing one, then the reply target of the existing activity will be
4282 * transfered to the new activity. This way the new activity can call
4283 * {@link android.app.Activity#setResult} and have that result sent back to
4284 * the reply target of the original activity.
4285 */
4286 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4287 /**
4288 * If set and this intent is being used to launch a new activity from an
4289 * existing one, the current activity will not be counted as the top
4290 * activity for deciding whether the new intent should be delivered to
4291 * the top instead of starting a new one. The previous activity will
4292 * be used as the top, with the assumption being that the current activity
4293 * will finish itself immediately.
4294 */
4295 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4296 /**
4297 * If set, the new activity is not kept in the list of recently launched
4298 * activities.
4299 */
4300 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4301 /**
4302 * This flag is not normally set by application code, but set for you by
4303 * the system as described in the
4304 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4305 * launchMode} documentation for the singleTask mode.
4306 */
4307 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4308 /**
4309 * If set, and this activity is either being started in a new task or
4310 * bringing to the top an existing task, then it will be launched as
4311 * the front door of the task. This will result in the application of
4312 * any affinities needed to have that task in the proper state (either
4313 * moving activities to or from it), or simply resetting that task to
4314 * its initial state if needed.
4315 */
4316 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4317 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004318 * This flag is not normally set by application code, but set for you by
4319 * the system if this activity is being launched from history
4320 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004321 */
4322 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004323 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004324 * @deprecated As of API 21 this performs identically to
4325 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004326 */
4327 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004328 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004329 * This flag is used to open a document into a new task rooted at the activity launched
4330 * by this Intent. Through the use of this flag, or its equivalent attribute,
4331 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004332 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004333 *
Craig Mautner026596b2014-05-21 15:35:44 -07004334 * <p>The use of the activity attribute form of this,
4335 * {@link android.R.attr#documentLaunchMode}, is
4336 * preferred over the Intent flag described here. The attribute form allows the
4337 * Activity to specify multiple document behavior for all launchers of the Activity
4338 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004339 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004340 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4341 * it is kept after the activity is finished is different than the use of
4342 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4343 * this flag is being used to create a new recents entry, then by default that entry
4344 * will be removed once the activity is finished. You can modify this behavior with
4345 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4346 *
Craig Mautner026596b2014-05-21 15:35:44 -07004347 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4348 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4349 * equivalent of the Activity manifest specifying {@link
4350 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4351 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4352 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004353 *
Craig Mautner026596b2014-05-21 15:35:44 -07004354 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004355 *
Craig Mautner026596b2014-05-21 15:35:44 -07004356 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004357 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4358 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004359 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004360 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004361 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004362 * callback from occurring on the current frontmost activity before it is
4363 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004364 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004365 * <p>Typically, an activity can rely on that callback to indicate that an
4366 * explicit user action has caused their activity to be moved out of the
4367 * foreground. The callback marks an appropriate point in the activity's
4368 * lifecycle for it to dismiss any notifications that it intends to display
4369 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004370 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004371 * <p>If an activity is ever started via any non-user-driven events such as
4372 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4373 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004374 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004375 */
4376 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004377 /**
4378 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4379 * this flag will cause the launched activity to be brought to the front of its
4380 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004381 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004382 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4383 * If D calls startActivity() with an Intent that resolves to the component
4384 * of activity B, then B will be brought to the front of the history stack,
4385 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004386 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004387 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004388 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004389 */
4390 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004392 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4393 * this flag will prevent the system from applying an activity transition
4394 * animation to go to the next activity state. This doesn't mean an
4395 * animation will never run -- if another activity change happens that doesn't
4396 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004397 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004398 * when you are going to do a series of activity operations but the
4399 * animation seen by the user shouldn't be driven by the first activity
4400 * change but rather a later one.
4401 */
4402 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4403 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004404 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4405 * this flag will cause any existing task that would be associated with the
4406 * activity to be cleared before the activity is started. That is, the activity
4407 * becomes the new root of an otherwise empty task, and any old activities
4408 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4409 */
4410 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4411 /**
4412 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4413 * this flag will cause a newly launching task to be placed on top of the current
4414 * home activity task (if there is one). That is, pressing back from the task
4415 * will always return the user to home even if that was not the last activity they
4416 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4417 */
4418 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4419 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004420 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4421 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004422 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004423 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004424 * this flag. When set and the task's activity is finished, the recents
4425 * entry will remain in the interface for the user to re-launch it, like a
4426 * recents entry for a top-level application.
4427 * <p>
4428 * The receiving activity can override this request with
4429 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4430 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004431 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004432 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004433 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004434
4435 /**
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004436 * This flag is only used in the multi-window mode. The new activity will be displayed on
4437 * the other side than the one that is launching it. This can only be used in conjunction with
4438 * {@link #FLAG_ACTIVITY_NEW_TASK}.
4439 */
4440 public static final int FLAG_ACTIVITY_LAUNCH_TO_SIDE = 0x00001000;
4441
4442 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004443 * If set, when sending a broadcast only registered receivers will be
4444 * called -- no BroadcastReceiver components will be launched.
4445 */
4446 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004447 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004448 * If set, when sending a broadcast the new broadcast will replace
4449 * any existing pending broadcast that matches it. Matching is defined
4450 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4451 * true for the intents of the two broadcasts. When a match is found,
4452 * the new broadcast (and receivers associated with it) will replace the
4453 * existing one in the pending broadcast list, remaining at the same
4454 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004455 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004456 * <p>This flag is most typically used with sticky broadcasts, which
4457 * only care about delivering the most recent values of the broadcast
4458 * to their receivers.
4459 */
4460 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4461 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004462 * If set, when sending a broadcast the recipient is allowed to run at
4463 * foreground priority, with a shorter timeout interval. During normal
4464 * broadcasts the receivers are not automatically hoisted out of the
4465 * background priority class.
4466 */
4467 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4468 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004469 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4470 * They can still propagate results through to later receivers, but they can not prevent
4471 * later receivers from seeing the broadcast.
4472 */
4473 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4474 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004475 * If set, when sending a broadcast <i>before boot has completed</i> only
4476 * registered receivers will be called -- no BroadcastReceiver components
4477 * will be launched. Sticky intent state will be recorded properly even
4478 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4479 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004480 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004481 * <p>This flag is only for use by system sevices as a convenience to
4482 * avoid having to implement a more complex mechanism around detection
4483 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004484 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004485 * @hide
4486 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004487 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004488 /**
4489 * Set when this broadcast is for a boot upgrade, a special mode that
4490 * allows the broadcast to be sent before the system is ready and launches
4491 * the app process with no providers running in it.
4492 * @hide
4493 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004494 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004495 /**
4496 * If set, the broadcast will always go to manifest receivers in background (cached
4497 * or not running) apps, regardless of whether that would be done by default. By
4498 * default they will only receive broadcasts if the broadcast has specified an
4499 * explicit component or package name.
4500 * @hide
4501 */
4502 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4503 /**
4504 * If set, the broadcast will never go to manifest receivers in background (cached
4505 * or not running) apps, regardless of whether that would be done by default. By
4506 * default they will receive broadcasts if the broadcast has specified an
4507 * explicit component or package name.
4508 * @hide
4509 */
4510 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004511
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004512 /**
4513 * @hide Flags that can't be changed with PendingIntent.
4514 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004515 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4516 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4517 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004518
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004519 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004520 // ---------------------------------------------------------------------
4521 // toUri() and parseUri() options.
4522
4523 /**
4524 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4525 * always has the "intent:" scheme. This syntax can be used when you want
4526 * to later disambiguate between URIs that are intended to describe an
4527 * Intent vs. all others that should be treated as raw URIs. When used
4528 * with {@link #parseUri}, any other scheme will result in a generic
4529 * VIEW action for that raw URI.
4530 */
4531 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004532
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004533 /**
4534 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4535 * always has the "android-app:" scheme. This is a variation of
4536 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4537 * http/https URI being delivered to a specific package name. The format
4538 * is:
4539 *
4540 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004541 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004542 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004543 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4544 * you must also include a scheme; including a path also requires both a host and a scheme.
4545 * The final #Intent; fragment can be used without a scheme, host, or path.
4546 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004547 * used with intents that have a {@link #setSelector}, since the base intent
4548 * will always have an explicit package name.</p>
4549 *
4550 * <p>Some examples of how this scheme maps to Intent objects:</p>
4551 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4552 * <colgroup align="left" />
4553 * <colgroup align="left" />
4554 * <thead>
4555 * <tr><th>URI</th> <th>Intent</th></tr>
4556 * </thead>
4557 *
4558 * <tbody>
4559 * <tr><td><code>android-app://com.example.app</code></td>
4560 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4561 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4562 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4563 * </table></td>
4564 * </tr>
4565 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4566 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4567 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4568 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4569 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4570 * </table></td>
4571 * </tr>
4572 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4573 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4574 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4575 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4576 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4577 * </table></td>
4578 * </tr>
4579 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4580 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4581 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4582 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4583 * </table></td>
4584 * </tr>
4585 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4586 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4587 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4588 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4589 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4590 * </table></td>
4591 * </tr>
4592 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;<br />i.some_int=100;S.some_str=hello;end</code></td>
4593 * <td><table border="" style="margin:0" >
4594 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4595 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4596 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4597 * </table></td>
4598 * </tr>
4599 * </tbody>
4600 * </table>
4601 */
4602 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4603
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004604 /**
4605 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4606 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4607 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4608 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4609 * generated Intent can not cause unexpected data access to happen.
4610 *
4611 * <p>If you do not trust the source of the URI being parsed, you should still do further
4612 * processing to protect yourself from it. In particular, when using it to start an
4613 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4614 * that can handle it.</p>
4615 */
4616 public static final int URI_ALLOW_UNSAFE = 1<<2;
4617
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004618 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004619
4620 private String mAction;
4621 private Uri mData;
4622 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004623 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004624 private ComponentName mComponent;
4625 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004626 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004627 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004628 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004629 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004630 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004631 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004632
4633 // ---------------------------------------------------------------------
4634
4635 /**
4636 * Create an empty intent.
4637 */
4638 public Intent() {
4639 }
4640
4641 /**
4642 * Copy constructor.
4643 */
4644 public Intent(Intent o) {
4645 this.mAction = o.mAction;
4646 this.mData = o.mData;
4647 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004648 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004649 this.mComponent = o.mComponent;
4650 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004651 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004652 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004653 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004654 }
4655 if (o.mExtras != null) {
4656 this.mExtras = new Bundle(o.mExtras);
4657 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004658 if (o.mSourceBounds != null) {
4659 this.mSourceBounds = new Rect(o.mSourceBounds);
4660 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004661 if (o.mSelector != null) {
4662 this.mSelector = new Intent(o.mSelector);
4663 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004664 if (o.mClipData != null) {
4665 this.mClipData = new ClipData(o.mClipData);
4666 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004667 }
4668
4669 @Override
4670 public Object clone() {
4671 return new Intent(this);
4672 }
4673
4674 private Intent(Intent o, boolean all) {
4675 this.mAction = o.mAction;
4676 this.mData = o.mData;
4677 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004678 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004679 this.mComponent = o.mComponent;
4680 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004681 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004682 }
4683 }
4684
4685 /**
4686 * Make a clone of only the parts of the Intent that are relevant for
4687 * filter matching: the action, data, type, component, and categories.
4688 */
4689 public Intent cloneFilter() {
4690 return new Intent(this, false);
4691 }
4692
4693 /**
4694 * Create an intent with a given action. All other fields (data, type,
4695 * class) are null. Note that the action <em>must</em> be in a
4696 * namespace because Intents are used globally in the system -- for
4697 * example the system VIEW action is android.intent.action.VIEW; an
4698 * application's custom action would be something like
4699 * com.google.app.myapp.CUSTOM_ACTION.
4700 *
4701 * @param action The Intent action, such as ACTION_VIEW.
4702 */
4703 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004704 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004705 }
4706
4707 /**
4708 * Create an intent with a given action and for a given data url. Note
4709 * that the action <em>must</em> be in a namespace because Intents are
4710 * used globally in the system -- for example the system VIEW action is
4711 * android.intent.action.VIEW; an application's custom action would be
4712 * something like com.google.app.myapp.CUSTOM_ACTION.
4713 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004714 * <p><em>Note: scheme and host name matching in the Android framework is
4715 * case-sensitive, unlike the formal RFC. As a result,
4716 * you should always ensure that you write your Uri with these elements
4717 * using lower case letters, and normalize any Uris you receive from
4718 * outside of Android to ensure the scheme and host is lower case.</em></p>
4719 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 * @param action The Intent action, such as ACTION_VIEW.
4721 * @param uri The Intent data URI.
4722 */
4723 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004724 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004725 mData = uri;
4726 }
4727
4728 /**
4729 * Create an intent for a specific component. All other fields (action, data,
4730 * type, class) are null, though they can be modified later with explicit
4731 * calls. This provides a convenient way to create an intent that is
4732 * intended to execute a hard-coded class name, rather than relying on the
4733 * system to find an appropriate class for you; see {@link #setComponent}
4734 * for more information on the repercussions of this.
4735 *
4736 * @param packageContext A Context of the application package implementing
4737 * this class.
4738 * @param cls The component class that is to be used for the intent.
4739 *
4740 * @see #setClass
4741 * @see #setComponent
4742 * @see #Intent(String, android.net.Uri , Context, Class)
4743 */
4744 public Intent(Context packageContext, Class<?> cls) {
4745 mComponent = new ComponentName(packageContext, cls);
4746 }
4747
4748 /**
4749 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004750 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004751 * construct the Intent and then calling {@link #setClass} to set its
4752 * class.
4753 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004754 * <p><em>Note: scheme and host name matching in the Android framework is
4755 * case-sensitive, unlike the formal RFC. As a result,
4756 * you should always ensure that you write your Uri with these elements
4757 * using lower case letters, and normalize any Uris you receive from
4758 * outside of Android to ensure the scheme and host is lower case.</em></p>
4759 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004760 * @param action The Intent action, such as ACTION_VIEW.
4761 * @param uri The Intent data URI.
4762 * @param packageContext A Context of the application package implementing
4763 * this class.
4764 * @param cls The component class that is to be used for the intent.
4765 *
4766 * @see #Intent(String, android.net.Uri)
4767 * @see #Intent(Context, Class)
4768 * @see #setClass
4769 * @see #setComponent
4770 */
4771 public Intent(String action, Uri uri,
4772 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004773 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004774 mData = uri;
4775 mComponent = new ComponentName(packageContext, cls);
4776 }
4777
4778 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004779 * Create an intent to launch the main (root) activity of a task. This
4780 * is the Intent that is started when the application's is launched from
4781 * Home. For anything else that wants to launch an application in the
4782 * same way, it is important that they use an Intent structured the same
4783 * way, and can use this function to ensure this is the case.
4784 *
4785 * <p>The returned Intent has the given Activity component as its explicit
4786 * component, {@link #ACTION_MAIN} as its action, and includes the
4787 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4788 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4789 * to do that through {@link #addFlags(int)} on the returned Intent.
4790 *
4791 * @param mainActivity The main activity component that this Intent will
4792 * launch.
4793 * @return Returns a newly created Intent that can be used to launch the
4794 * activity as a main application entry.
4795 *
4796 * @see #setClass
4797 * @see #setComponent
4798 */
4799 public static Intent makeMainActivity(ComponentName mainActivity) {
4800 Intent intent = new Intent(ACTION_MAIN);
4801 intent.setComponent(mainActivity);
4802 intent.addCategory(CATEGORY_LAUNCHER);
4803 return intent;
4804 }
4805
4806 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004807 * Make an Intent for the main activity of an application, without
4808 * specifying a specific activity to run but giving a selector to find
4809 * the activity. This results in a final Intent that is structured
4810 * the same as when the application is launched from
4811 * Home. For anything else that wants to launch an application in the
4812 * same way, it is important that they use an Intent structured the same
4813 * way, and can use this function to ensure this is the case.
4814 *
4815 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4816 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4817 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4818 * to do that through {@link #addFlags(int)} on the returned Intent.
4819 *
4820 * @param selectorAction The action name of the Intent's selector.
4821 * @param selectorCategory The name of a category to add to the Intent's
4822 * selector.
4823 * @return Returns a newly created Intent that can be used to launch the
4824 * activity as a main application entry.
4825 *
4826 * @see #setSelector(Intent)
4827 */
4828 public static Intent makeMainSelectorActivity(String selectorAction,
4829 String selectorCategory) {
4830 Intent intent = new Intent(ACTION_MAIN);
4831 intent.addCategory(CATEGORY_LAUNCHER);
4832 Intent selector = new Intent();
4833 selector.setAction(selectorAction);
4834 selector.addCategory(selectorCategory);
4835 intent.setSelector(selector);
4836 return intent;
4837 }
4838
4839 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004840 * Make an Intent that can be used to re-launch an application's task
4841 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4842 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4843 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4844 *
4845 * @param mainActivity The activity component that is the root of the
4846 * task; this is the activity that has been published in the application's
4847 * manifest as the main launcher icon.
4848 *
4849 * @return Returns a newly created Intent that can be used to relaunch the
4850 * activity's task in its root state.
4851 */
4852 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4853 Intent intent = makeMainActivity(mainActivity);
4854 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4855 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4856 return intent;
4857 }
4858
4859 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004860 * Call {@link #parseUri} with 0 flags.
4861 * @deprecated Use {@link #parseUri} instead.
4862 */
4863 @Deprecated
4864 public static Intent getIntent(String uri) throws URISyntaxException {
4865 return parseUri(uri, 0);
4866 }
Tom Taylord4a47292009-12-21 13:59:18 -08004867
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004868 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004869 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004870 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004871 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004872 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 *
4874 * <p>The URI given here must not be relative -- that is, it must include
4875 * the scheme and full path.
4876 *
4877 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004878 * @param flags Additional processing flags. Either 0,
4879 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004880 *
4881 * @return Intent The newly created Intent object.
4882 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004883 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4884 * it bad (as parsed by the Uri class) or the Intent data within the
4885 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004886 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004887 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004888 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004889 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004890 int i = 0;
4891 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004892 final boolean androidApp = uri.startsWith("android-app:");
4893
4894 // Validate intent scheme if requested.
4895 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4896 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004897 Intent intent = new Intent(ACTION_VIEW);
4898 try {
4899 intent.setData(Uri.parse(uri));
4900 } catch (IllegalArgumentException e) {
4901 throw new URISyntaxException(uri, e.getMessage());
4902 }
4903 return intent;
4904 }
4905 }
Tom Taylord4a47292009-12-21 13:59:18 -08004906
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004907 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004908 // simple case
4909 if (i == -1) {
4910 if (!androidApp) {
4911 return new Intent(ACTION_VIEW, Uri.parse(uri));
4912 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004913
4914 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004915 } else if (!uri.startsWith("#Intent;", i)) {
4916 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004917 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004918 } else {
4919 i = -1;
4920 }
4921 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004922
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004923 // new format
4924 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004925 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004926 boolean explicitAction = false;
4927 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004928
4929 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004930 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004931 String data;
4932 if (i >= 0) {
4933 data = uri.substring(0, i);
4934 i += 8; // length of "#Intent;"
4935 } else {
4936 data = uri;
4937 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004939 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004940 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004941 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004942 if (eq < 0) eq = i-1;
4943 int semi = uri.indexOf(';', i);
4944 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004945
4946 // action
4947 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004948 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004949 if (!inSelector) {
4950 explicitAction = true;
4951 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004952 }
4953
4954 // categories
4955 else if (uri.startsWith("category=", i)) {
4956 intent.addCategory(value);
4957 }
4958
4959 // type
4960 else if (uri.startsWith("type=", i)) {
4961 intent.mType = value;
4962 }
4963
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004964 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004965 else if (uri.startsWith("launchFlags=", i)) {
4966 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004967 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4968 intent.mFlags &= ~IMMUTABLE_FLAGS;
4969 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004970 }
4971
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004972 // package
4973 else if (uri.startsWith("package=", i)) {
4974 intent.mPackage = value;
4975 }
4976
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004977 // component
4978 else if (uri.startsWith("component=", i)) {
4979 intent.mComponent = ComponentName.unflattenFromString(value);
4980 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004981
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004982 // scheme
4983 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004984 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004985 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004986 } else {
4987 scheme = value;
4988 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004989 }
4990
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004991 // source bounds
4992 else if (uri.startsWith("sourceBounds=", i)) {
4993 intent.mSourceBounds = Rect.unflattenFromString(value);
4994 }
4995
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004996 // selector
4997 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4998 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004999 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005000 }
5001
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005002 // extra
5003 else {
5004 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005005 // create Bundle if it doesn't already exist
5006 if (intent.mExtras == null) intent.mExtras = new Bundle();
5007 Bundle b = intent.mExtras;
5008 // add EXTRA
5009 if (uri.startsWith("S.", i)) b.putString(key, value);
5010 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5011 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5012 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5013 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5014 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5015 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5016 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5017 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5018 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5019 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005020
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 // move to the next item
5022 i = semi + 1;
5023 }
5024
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005025 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005026 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005027 if (baseIntent.mPackage == null) {
5028 baseIntent.setSelector(intent);
5029 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005030 intent = baseIntent;
5031 }
5032
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005033 if (data != null) {
5034 if (data.startsWith("intent:")) {
5035 data = data.substring(7);
5036 if (scheme != null) {
5037 data = scheme + ':' + data;
5038 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005039 } else if (data.startsWith("android-app:")) {
5040 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5041 // Correctly formed android-app, first part is package name.
5042 int end = data.indexOf('/', 14);
5043 if (end < 0) {
5044 // All we have is a package name.
5045 intent.mPackage = data.substring(14);
5046 if (!explicitAction) {
5047 intent.setAction(ACTION_MAIN);
5048 }
5049 data = "";
5050 } else {
5051 // Target the Intent at the given package name always.
5052 String authority = null;
5053 intent.mPackage = data.substring(14, end);
5054 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005055 if ((end+1) < data.length()) {
5056 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5057 // Found a scheme, remember it.
5058 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005059 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005060 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5061 // Found a authority, remember it.
5062 authority = data.substring(end+1, newEnd);
5063 end = newEnd;
5064 }
5065 } else {
5066 // All we have is a scheme.
5067 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005068 }
5069 }
5070 if (scheme == null) {
5071 // If there was no scheme, then this just targets the package.
5072 if (!explicitAction) {
5073 intent.setAction(ACTION_MAIN);
5074 }
5075 data = "";
5076 } else if (authority == null) {
5077 data = scheme + ":";
5078 } else {
5079 data = scheme + "://" + authority + data.substring(end);
5080 }
5081 }
5082 } else {
5083 data = "";
5084 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005085 }
Tom Taylord4a47292009-12-21 13:59:18 -08005086
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005087 if (data.length() > 0) {
5088 try {
5089 intent.mData = Uri.parse(data);
5090 } catch (IllegalArgumentException e) {
5091 throw new URISyntaxException(uri, e.getMessage());
5092 }
5093 }
5094 }
Tom Taylord4a47292009-12-21 13:59:18 -08005095
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005096 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005097
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098 } catch (IndexOutOfBoundsException e) {
5099 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5100 }
5101 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005102
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005104 return getIntentOld(uri, 0);
5105 }
5106
5107 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005108 Intent intent;
5109
5110 int i = uri.lastIndexOf('#');
5111 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005113 final int intentFragmentStart = i;
5114 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005115
5116 i++;
5117
5118 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005119 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005120 i += 7;
5121 int j = uri.indexOf(')', i);
5122 action = uri.substring(i, j);
5123 i = j + 1;
5124 }
5125
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005126 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005127
5128 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005129 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005130 i += 11;
5131 int j = uri.indexOf(')', i);
5132 while (i < j) {
5133 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005134 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005135 if (i < sep) {
5136 intent.addCategory(uri.substring(i, sep));
5137 }
5138 i = sep + 1;
5139 }
5140 i = j + 1;
5141 }
5142
5143 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005144 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005145 i += 5;
5146 int j = uri.indexOf(')', i);
5147 intent.mType = uri.substring(i, j);
5148 i = j + 1;
5149 }
5150
5151 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005152 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005153 i += 12;
5154 int j = uri.indexOf(')', i);
5155 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005156 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5157 intent.mFlags &= ~IMMUTABLE_FLAGS;
5158 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005159 i = j + 1;
5160 }
5161
5162 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005163 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005164 i += 10;
5165 int j = uri.indexOf(')', i);
5166 int sep = uri.indexOf('!', i);
5167 if (sep >= 0 && sep < j) {
5168 String pkg = uri.substring(i, sep);
5169 String cls = uri.substring(sep + 1, j);
5170 intent.mComponent = new ComponentName(pkg, cls);
5171 }
5172 i = j + 1;
5173 }
5174
5175 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005176 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005177 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005178
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005179 final int closeParen = uri.indexOf(')', i);
5180 if (closeParen == -1) throw new URISyntaxException(uri,
5181 "EXTRA missing trailing ')'", i);
5182
5183 while (i < closeParen) {
5184 // fetch the key value
5185 int j = uri.indexOf('=', i);
5186 if (j <= i + 1 || i >= closeParen) {
5187 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5188 }
5189 char type = uri.charAt(i);
5190 i++;
5191 String key = uri.substring(i, j);
5192 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005193
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005194 // get type-value
5195 j = uri.indexOf('!', i);
5196 if (j == -1 || j >= closeParen) j = closeParen;
5197 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5198 String value = uri.substring(i, j);
5199 i = j;
5200
5201 // create Bundle if it doesn't already exist
5202 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005204 // add item to bundle
5205 try {
5206 switch (type) {
5207 case 'S':
5208 intent.mExtras.putString(key, Uri.decode(value));
5209 break;
5210 case 'B':
5211 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5212 break;
5213 case 'b':
5214 intent.mExtras.putByte(key, Byte.parseByte(value));
5215 break;
5216 case 'c':
5217 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5218 break;
5219 case 'd':
5220 intent.mExtras.putDouble(key, Double.parseDouble(value));
5221 break;
5222 case 'f':
5223 intent.mExtras.putFloat(key, Float.parseFloat(value));
5224 break;
5225 case 'i':
5226 intent.mExtras.putInt(key, Integer.parseInt(value));
5227 break;
5228 case 'l':
5229 intent.mExtras.putLong(key, Long.parseLong(value));
5230 break;
5231 case 's':
5232 intent.mExtras.putShort(key, Short.parseShort(value));
5233 break;
5234 default:
5235 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5236 }
5237 } catch (NumberFormatException e) {
5238 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5239 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005240
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005241 char ch = uri.charAt(i);
5242 if (ch == ')') break;
5243 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5244 i++;
5245 }
5246 }
5247
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005248 if (isIntentFragment) {
5249 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5250 } else {
5251 intent.mData = Uri.parse(uri);
5252 }
Tom Taylord4a47292009-12-21 13:59:18 -08005253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005254 if (intent.mAction == null) {
5255 // By default, if no action is specified, then use VIEW.
5256 intent.mAction = ACTION_VIEW;
5257 }
5258
5259 } else {
5260 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5261 }
5262
5263 return intent;
5264 }
5265
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005266 /** @hide */
5267 public interface CommandOptionHandler {
5268 boolean handleOption(String opt, ShellCommand cmd);
5269 }
5270
5271 /** @hide */
5272 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5273 throws URISyntaxException {
5274 Intent intent = new Intent();
5275 Intent baseIntent = intent;
5276 boolean hasIntentInfo = false;
5277
5278 Uri data = null;
5279 String type = null;
5280
5281 String opt;
5282 while ((opt=cmd.getNextOption()) != null) {
5283 switch (opt) {
5284 case "-a":
5285 intent.setAction(cmd.getNextArgRequired());
5286 if (intent == baseIntent) {
5287 hasIntentInfo = true;
5288 }
5289 break;
5290 case "-d":
5291 data = Uri.parse(cmd.getNextArgRequired());
5292 if (intent == baseIntent) {
5293 hasIntentInfo = true;
5294 }
5295 break;
5296 case "-t":
5297 type = cmd.getNextArgRequired();
5298 if (intent == baseIntent) {
5299 hasIntentInfo = true;
5300 }
5301 break;
5302 case "-c":
5303 intent.addCategory(cmd.getNextArgRequired());
5304 if (intent == baseIntent) {
5305 hasIntentInfo = true;
5306 }
5307 break;
5308 case "-e":
5309 case "--es": {
5310 String key = cmd.getNextArgRequired();
5311 String value = cmd.getNextArgRequired();
5312 intent.putExtra(key, value);
5313 }
5314 break;
5315 case "--esn": {
5316 String key = cmd.getNextArgRequired();
5317 intent.putExtra(key, (String) null);
5318 }
5319 break;
5320 case "--ei": {
5321 String key = cmd.getNextArgRequired();
5322 String value = cmd.getNextArgRequired();
5323 intent.putExtra(key, Integer.decode(value));
5324 }
5325 break;
5326 case "--eu": {
5327 String key = cmd.getNextArgRequired();
5328 String value = cmd.getNextArgRequired();
5329 intent.putExtra(key, Uri.parse(value));
5330 }
5331 break;
5332 case "--ecn": {
5333 String key = cmd.getNextArgRequired();
5334 String value = cmd.getNextArgRequired();
5335 ComponentName cn = ComponentName.unflattenFromString(value);
5336 if (cn == null)
5337 throw new IllegalArgumentException("Bad component name: " + value);
5338 intent.putExtra(key, cn);
5339 }
5340 break;
5341 case "--eia": {
5342 String key = cmd.getNextArgRequired();
5343 String value = cmd.getNextArgRequired();
5344 String[] strings = value.split(",");
5345 int[] list = new int[strings.length];
5346 for (int i = 0; i < strings.length; i++) {
5347 list[i] = Integer.decode(strings[i]);
5348 }
5349 intent.putExtra(key, list);
5350 }
5351 break;
5352 case "--eial": {
5353 String key = cmd.getNextArgRequired();
5354 String value = cmd.getNextArgRequired();
5355 String[] strings = value.split(",");
5356 ArrayList<Integer> list = new ArrayList<>(strings.length);
5357 for (int i = 0; i < strings.length; i++) {
5358 list.add(Integer.decode(strings[i]));
5359 }
5360 intent.putExtra(key, list);
5361 }
5362 break;
5363 case "--el": {
5364 String key = cmd.getNextArgRequired();
5365 String value = cmd.getNextArgRequired();
5366 intent.putExtra(key, Long.valueOf(value));
5367 }
5368 break;
5369 case "--ela": {
5370 String key = cmd.getNextArgRequired();
5371 String value = cmd.getNextArgRequired();
5372 String[] strings = value.split(",");
5373 long[] list = new long[strings.length];
5374 for (int i = 0; i < strings.length; i++) {
5375 list[i] = Long.valueOf(strings[i]);
5376 }
5377 intent.putExtra(key, list);
5378 hasIntentInfo = true;
5379 }
5380 break;
5381 case "--elal": {
5382 String key = cmd.getNextArgRequired();
5383 String value = cmd.getNextArgRequired();
5384 String[] strings = value.split(",");
5385 ArrayList<Long> list = new ArrayList<>(strings.length);
5386 for (int i = 0; i < strings.length; i++) {
5387 list.add(Long.valueOf(strings[i]));
5388 }
5389 intent.putExtra(key, list);
5390 hasIntentInfo = true;
5391 }
5392 break;
5393 case "--ef": {
5394 String key = cmd.getNextArgRequired();
5395 String value = cmd.getNextArgRequired();
5396 intent.putExtra(key, Float.valueOf(value));
5397 hasIntentInfo = true;
5398 }
5399 break;
5400 case "--efa": {
5401 String key = cmd.getNextArgRequired();
5402 String value = cmd.getNextArgRequired();
5403 String[] strings = value.split(",");
5404 float[] list = new float[strings.length];
5405 for (int i = 0; i < strings.length; i++) {
5406 list[i] = Float.valueOf(strings[i]);
5407 }
5408 intent.putExtra(key, list);
5409 hasIntentInfo = true;
5410 }
5411 break;
5412 case "--efal": {
5413 String key = cmd.getNextArgRequired();
5414 String value = cmd.getNextArgRequired();
5415 String[] strings = value.split(",");
5416 ArrayList<Float> list = new ArrayList<>(strings.length);
5417 for (int i = 0; i < strings.length; i++) {
5418 list.add(Float.valueOf(strings[i]));
5419 }
5420 intent.putExtra(key, list);
5421 hasIntentInfo = true;
5422 }
5423 break;
5424 case "--esa": {
5425 String key = cmd.getNextArgRequired();
5426 String value = cmd.getNextArgRequired();
5427 // Split on commas unless they are preceeded by an escape.
5428 // The escape character must be escaped for the string and
5429 // again for the regex, thus four escape characters become one.
5430 String[] strings = value.split("(?<!\\\\),");
5431 intent.putExtra(key, strings);
5432 hasIntentInfo = true;
5433 }
5434 break;
5435 case "--esal": {
5436 String key = cmd.getNextArgRequired();
5437 String value = cmd.getNextArgRequired();
5438 // Split on commas unless they are preceeded by an escape.
5439 // The escape character must be escaped for the string and
5440 // again for the regex, thus four escape characters become one.
5441 String[] strings = value.split("(?<!\\\\),");
5442 ArrayList<String> list = new ArrayList<>(strings.length);
5443 for (int i = 0; i < strings.length; i++) {
5444 list.add(strings[i]);
5445 }
5446 intent.putExtra(key, list);
5447 hasIntentInfo = true;
5448 }
5449 break;
5450 case "--ez": {
5451 String key = cmd.getNextArgRequired();
5452 String value = cmd.getNextArgRequired().toLowerCase();
5453 // Boolean.valueOf() results in false for anything that is not "true", which is
5454 // error-prone in shell commands
5455 boolean arg;
5456 if ("true".equals(value) || "t".equals(value)) {
5457 arg = true;
5458 } else if ("false".equals(value) || "f".equals(value)) {
5459 arg = false;
5460 } else {
5461 try {
5462 arg = Integer.decode(value) != 0;
5463 } catch (NumberFormatException ex) {
5464 throw new IllegalArgumentException("Invalid boolean value: " + value);
5465 }
5466 }
5467
5468 intent.putExtra(key, arg);
5469 }
5470 break;
5471 case "-n": {
5472 String str = cmd.getNextArgRequired();
5473 ComponentName cn = ComponentName.unflattenFromString(str);
5474 if (cn == null)
5475 throw new IllegalArgumentException("Bad component name: " + str);
5476 intent.setComponent(cn);
5477 if (intent == baseIntent) {
5478 hasIntentInfo = true;
5479 }
5480 }
5481 break;
5482 case "-p": {
5483 String str = cmd.getNextArgRequired();
5484 intent.setPackage(str);
5485 if (intent == baseIntent) {
5486 hasIntentInfo = true;
5487 }
5488 }
5489 break;
5490 case "-f":
5491 String str = cmd.getNextArgRequired();
5492 intent.setFlags(Integer.decode(str).intValue());
5493 break;
5494 case "--grant-read-uri-permission":
5495 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5496 break;
5497 case "--grant-write-uri-permission":
5498 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5499 break;
5500 case "--grant-persistable-uri-permission":
5501 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5502 break;
5503 case "--grant-prefix-uri-permission":
5504 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5505 break;
5506 case "--exclude-stopped-packages":
5507 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5508 break;
5509 case "--include-stopped-packages":
5510 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5511 break;
5512 case "--debug-log-resolution":
5513 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5514 break;
5515 case "--activity-brought-to-front":
5516 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5517 break;
5518 case "--activity-clear-top":
5519 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5520 break;
5521 case "--activity-clear-when-task-reset":
5522 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5523 break;
5524 case "--activity-exclude-from-recents":
5525 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5526 break;
5527 case "--activity-launched-from-history":
5528 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5529 break;
5530 case "--activity-multiple-task":
5531 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5532 break;
5533 case "--activity-no-animation":
5534 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5535 break;
5536 case "--activity-no-history":
5537 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5538 break;
5539 case "--activity-no-user-action":
5540 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5541 break;
5542 case "--activity-previous-is-top":
5543 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5544 break;
5545 case "--activity-reorder-to-front":
5546 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5547 break;
5548 case "--activity-reset-task-if-needed":
5549 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5550 break;
5551 case "--activity-single-top":
5552 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5553 break;
5554 case "--activity-clear-task":
5555 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5556 break;
5557 case "--activity-task-on-home":
5558 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5559 break;
5560 case "--receiver-registered-only":
5561 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5562 break;
5563 case "--receiver-replace-pending":
5564 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5565 break;
5566 case "--selector":
5567 intent.setDataAndType(data, type);
5568 intent = new Intent();
5569 break;
5570 default:
5571 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5572 // Okay, caller handled this option.
5573 } else {
5574 throw new IllegalArgumentException("Unknown option: " + opt);
5575 }
5576 break;
5577 }
5578 }
5579 intent.setDataAndType(data, type);
5580
5581 final boolean hasSelector = intent != baseIntent;
5582 if (hasSelector) {
5583 // A selector was specified; fix up.
5584 baseIntent.setSelector(intent);
5585 intent = baseIntent;
5586 }
5587
5588 String arg = cmd.getNextArg();
5589 baseIntent = null;
5590 if (arg == null) {
5591 if (hasSelector) {
5592 // If a selector has been specified, and no arguments
5593 // have been supplied for the main Intent, then we can
5594 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5595 // need to have a component name specified yet, the
5596 // selector will take care of that.
5597 baseIntent = new Intent(Intent.ACTION_MAIN);
5598 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5599 }
5600 } else if (arg.indexOf(':') >= 0) {
5601 // The argument is a URI. Fully parse it, and use that result
5602 // to fill in any data not specified so far.
5603 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5604 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5605 } else if (arg.indexOf('/') >= 0) {
5606 // The argument is a component name. Build an Intent to launch
5607 // it.
5608 baseIntent = new Intent(Intent.ACTION_MAIN);
5609 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5610 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5611 } else {
5612 // Assume the argument is a package name.
5613 baseIntent = new Intent(Intent.ACTION_MAIN);
5614 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5615 baseIntent.setPackage(arg);
5616 }
5617 if (baseIntent != null) {
5618 Bundle extras = intent.getExtras();
5619 intent.replaceExtras((Bundle)null);
5620 Bundle uriExtras = baseIntent.getExtras();
5621 baseIntent.replaceExtras((Bundle)null);
5622 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5623 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5624 for (String c : cats) {
5625 baseIntent.removeCategory(c);
5626 }
5627 }
5628 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5629 if (extras == null) {
5630 extras = uriExtras;
5631 } else if (uriExtras != null) {
5632 uriExtras.putAll(extras);
5633 extras = uriExtras;
5634 }
5635 intent.replaceExtras(extras);
5636 hasIntentInfo = true;
5637 }
5638
5639 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5640 return intent;
5641 }
5642
5643 /** @hide */
5644 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5645 final String[] lines = new String[] {
5646 "<INTENT> specifications include these flags and arguments:",
5647 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5648 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5649 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5650 " [--esn <EXTRA_KEY> ...]",
5651 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5652 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5653 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5654 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5655 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5656 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5657 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5658 " (mutiple extras passed as Integer[])",
5659 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5660 " (mutiple extras passed as List<Integer>)",
5661 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5662 " (mutiple extras passed as Long[])",
5663 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5664 " (mutiple extras passed as List<Long>)",
5665 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5666 " (mutiple extras passed as Float[])",
5667 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5668 " (mutiple extras passed as List<Float>)",
5669 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5670 " (mutiple extras passed as String[]; to embed a comma into a string,",
5671 " escape it using \"\\,\")",
5672 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5673 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5674 " escape it using \"\\,\")",
5675 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5676 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5677 " [--debug-log-resolution] [--exclude-stopped-packages]",
5678 " [--include-stopped-packages]",
5679 " [--activity-brought-to-front] [--activity-clear-top]",
5680 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5681 " [--activity-launched-from-history] [--activity-multiple-task]",
5682 " [--activity-no-animation] [--activity-no-history]",
5683 " [--activity-no-user-action] [--activity-previous-is-top]",
5684 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5685 " [--activity-single-top] [--activity-clear-task]",
5686 " [--activity-task-on-home]",
5687 " [--receiver-registered-only] [--receiver-replace-pending]",
5688 " [--selector]",
5689 " [<URI> | <PACKAGE> | <COMPONENT>]"
5690 };
5691 for (String line : lines) {
5692 pw.print(prefix);
5693 pw.println(line);
5694 }
5695 }
5696
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005697 /**
5698 * Retrieve the general action to be performed, such as
5699 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5700 * the information in the intent should be interpreted -- most importantly,
5701 * what to do with the data returned by {@link #getData}.
5702 *
5703 * @return The action of this intent or null if none is specified.
5704 *
5705 * @see #setAction
5706 */
5707 public String getAction() {
5708 return mAction;
5709 }
5710
5711 /**
5712 * Retrieve data this intent is operating on. This URI specifies the name
5713 * of the data; often it uses the content: scheme, specifying data in a
5714 * content provider. Other schemes may be handled by specific activities,
5715 * such as http: by the web browser.
5716 *
5717 * @return The URI of the data this intent is targeting or null.
5718 *
5719 * @see #getScheme
5720 * @see #setData
5721 */
5722 public Uri getData() {
5723 return mData;
5724 }
5725
5726 /**
5727 * The same as {@link #getData()}, but returns the URI as an encoded
5728 * String.
5729 */
5730 public String getDataString() {
5731 return mData != null ? mData.toString() : null;
5732 }
5733
5734 /**
5735 * Return the scheme portion of the intent's data. If the data is null or
5736 * does not include a scheme, null is returned. Otherwise, the scheme
5737 * prefix without the final ':' is returned, i.e. "http".
5738 *
5739 * <p>This is the same as calling getData().getScheme() (and checking for
5740 * null data).
5741 *
5742 * @return The scheme of this intent.
5743 *
5744 * @see #getData
5745 */
5746 public String getScheme() {
5747 return mData != null ? mData.getScheme() : null;
5748 }
5749
5750 /**
5751 * Retrieve any explicit MIME type included in the intent. This is usually
5752 * null, as the type is determined by the intent data.
5753 *
5754 * @return If a type was manually set, it is returned; else null is
5755 * returned.
5756 *
5757 * @see #resolveType(ContentResolver)
5758 * @see #setType
5759 */
5760 public String getType() {
5761 return mType;
5762 }
5763
5764 /**
5765 * Return the MIME data type of this intent. If the type field is
5766 * explicitly set, that is simply returned. Otherwise, if the data is set,
5767 * the type of that data is returned. If neither fields are set, a null is
5768 * returned.
5769 *
5770 * @return The MIME type of this intent.
5771 *
5772 * @see #getType
5773 * @see #resolveType(ContentResolver)
5774 */
5775 public String resolveType(Context context) {
5776 return resolveType(context.getContentResolver());
5777 }
5778
5779 /**
5780 * Return the MIME data type of this intent. If the type field is
5781 * explicitly set, that is simply returned. Otherwise, if the data is set,
5782 * the type of that data is returned. If neither fields are set, a null is
5783 * returned.
5784 *
5785 * @param resolver A ContentResolver that can be used to determine the MIME
5786 * type of the intent's data.
5787 *
5788 * @return The MIME type of this intent.
5789 *
5790 * @see #getType
5791 * @see #resolveType(Context)
5792 */
5793 public String resolveType(ContentResolver resolver) {
5794 if (mType != null) {
5795 return mType;
5796 }
5797 if (mData != null) {
5798 if ("content".equals(mData.getScheme())) {
5799 return resolver.getType(mData);
5800 }
5801 }
5802 return null;
5803 }
5804
5805 /**
5806 * Return the MIME data type of this intent, only if it will be needed for
5807 * intent resolution. This is not generally useful for application code;
5808 * it is used by the frameworks for communicating with back-end system
5809 * services.
5810 *
5811 * @param resolver A ContentResolver that can be used to determine the MIME
5812 * type of the intent's data.
5813 *
5814 * @return The MIME type of this intent, or null if it is unknown or not
5815 * needed.
5816 */
5817 public String resolveTypeIfNeeded(ContentResolver resolver) {
5818 if (mComponent != null) {
5819 return mType;
5820 }
5821 return resolveType(resolver);
5822 }
5823
5824 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005825 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005826 *
5827 * @param category The category to check.
5828 *
5829 * @return boolean True if the intent contains the category, else false.
5830 *
5831 * @see #getCategories
5832 * @see #addCategory
5833 */
5834 public boolean hasCategory(String category) {
5835 return mCategories != null && mCategories.contains(category);
5836 }
5837
5838 /**
5839 * Return the set of all categories in the intent. If there are no categories,
5840 * returns NULL.
5841 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005842 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005843 *
5844 * @see #hasCategory
5845 * @see #addCategory
5846 */
5847 public Set<String> getCategories() {
5848 return mCategories;
5849 }
5850
5851 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005852 * Return the specific selector associated with this Intent. If there is
5853 * none, returns null. See {@link #setSelector} for more information.
5854 *
5855 * @see #setSelector
5856 */
5857 public Intent getSelector() {
5858 return mSelector;
5859 }
5860
5861 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005862 * Return the {@link ClipData} associated with this Intent. If there is
5863 * none, returns null. See {@link #setClipData} for more information.
5864 *
John Spurlock125d1332013-11-25 11:58:37 -05005865 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005866 */
5867 public ClipData getClipData() {
5868 return mClipData;
5869 }
5870
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005871 /** @hide */
5872 public int getContentUserHint() {
5873 return mContentUserHint;
5874 }
5875
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005876 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005877 * Sets the ClassLoader that will be used when unmarshalling
5878 * any Parcelable values from the extras of this Intent.
5879 *
5880 * @param loader a ClassLoader, or null to use the default loader
5881 * at the time of unmarshalling.
5882 */
5883 public void setExtrasClassLoader(ClassLoader loader) {
5884 if (mExtras != null) {
5885 mExtras.setClassLoader(loader);
5886 }
5887 }
5888
5889 /**
5890 * Returns true if an extra value is associated with the given name.
5891 * @param name the extra's name
5892 * @return true if the given extra is present.
5893 */
5894 public boolean hasExtra(String name) {
5895 return mExtras != null && mExtras.containsKey(name);
5896 }
5897
5898 /**
5899 * Returns true if the Intent's extras contain a parcelled file descriptor.
5900 * @return true if the Intent contains a parcelled file descriptor.
5901 */
5902 public boolean hasFileDescriptors() {
5903 return mExtras != null && mExtras.hasFileDescriptors();
5904 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005905
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005906 /** @hide */
5907 public void setAllowFds(boolean allowFds) {
5908 if (mExtras != null) {
5909 mExtras.setAllowFds(allowFds);
5910 }
5911 }
5912
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005913 /**
5914 * Retrieve extended data from the intent.
5915 *
5916 * @param name The name of the desired item.
5917 *
5918 * @return the value of an item that previously added with putExtra()
5919 * or null if none was found.
5920 *
5921 * @deprecated
5922 * @hide
5923 */
5924 @Deprecated
5925 public Object getExtra(String name) {
5926 return getExtra(name, null);
5927 }
5928
5929 /**
5930 * Retrieve extended data from the intent.
5931 *
5932 * @param name The name of the desired item.
5933 * @param defaultValue the value to be returned if no value of the desired
5934 * type is stored with the given name.
5935 *
5936 * @return the value of an item that previously added with putExtra()
5937 * or the default value if none was found.
5938 *
5939 * @see #putExtra(String, boolean)
5940 */
5941 public boolean getBooleanExtra(String name, boolean defaultValue) {
5942 return mExtras == null ? defaultValue :
5943 mExtras.getBoolean(name, defaultValue);
5944 }
5945
5946 /**
5947 * Retrieve extended data from the intent.
5948 *
5949 * @param name The name of the desired item.
5950 * @param defaultValue the value to be returned if no value of the desired
5951 * type is stored with the given name.
5952 *
5953 * @return the value of an item that previously added with putExtra()
5954 * or the default value if none was found.
5955 *
5956 * @see #putExtra(String, byte)
5957 */
5958 public byte getByteExtra(String name, byte defaultValue) {
5959 return mExtras == null ? defaultValue :
5960 mExtras.getByte(name, defaultValue);
5961 }
5962
5963 /**
5964 * Retrieve extended data from the intent.
5965 *
5966 * @param name The name of the desired item.
5967 * @param defaultValue the value to be returned if no value of the desired
5968 * type is stored with the given name.
5969 *
5970 * @return the value of an item that previously added with putExtra()
5971 * or the default value if none was found.
5972 *
5973 * @see #putExtra(String, short)
5974 */
5975 public short getShortExtra(String name, short defaultValue) {
5976 return mExtras == null ? defaultValue :
5977 mExtras.getShort(name, defaultValue);
5978 }
5979
5980 /**
5981 * Retrieve extended data from the intent.
5982 *
5983 * @param name The name of the desired item.
5984 * @param defaultValue the value to be returned if no value of the desired
5985 * type is stored with the given name.
5986 *
5987 * @return the value of an item that previously added with putExtra()
5988 * or the default value if none was found.
5989 *
5990 * @see #putExtra(String, char)
5991 */
5992 public char getCharExtra(String name, char defaultValue) {
5993 return mExtras == null ? defaultValue :
5994 mExtras.getChar(name, defaultValue);
5995 }
5996
5997 /**
5998 * Retrieve extended data from the intent.
5999 *
6000 * @param name The name of the desired item.
6001 * @param defaultValue the value to be returned if no value of the desired
6002 * type is stored with the given name.
6003 *
6004 * @return the value of an item that previously added with putExtra()
6005 * or the default value if none was found.
6006 *
6007 * @see #putExtra(String, int)
6008 */
6009 public int getIntExtra(String name, int defaultValue) {
6010 return mExtras == null ? defaultValue :
6011 mExtras.getInt(name, defaultValue);
6012 }
6013
6014 /**
6015 * Retrieve extended data from the intent.
6016 *
6017 * @param name The name of the desired item.
6018 * @param defaultValue the value to be returned if no value of the desired
6019 * type is stored with the given name.
6020 *
6021 * @return the value of an item that previously added with putExtra()
6022 * or the default value if none was found.
6023 *
6024 * @see #putExtra(String, long)
6025 */
6026 public long getLongExtra(String name, long defaultValue) {
6027 return mExtras == null ? defaultValue :
6028 mExtras.getLong(name, defaultValue);
6029 }
6030
6031 /**
6032 * Retrieve extended data from the intent.
6033 *
6034 * @param name The name of the desired item.
6035 * @param defaultValue the value to be returned if no value of the desired
6036 * type is stored with the given name.
6037 *
6038 * @return the value of an item that previously added with putExtra(),
6039 * or the default value if no such item is present
6040 *
6041 * @see #putExtra(String, float)
6042 */
6043 public float getFloatExtra(String name, float defaultValue) {
6044 return mExtras == null ? defaultValue :
6045 mExtras.getFloat(name, defaultValue);
6046 }
6047
6048 /**
6049 * Retrieve extended data from the intent.
6050 *
6051 * @param name The name of the desired item.
6052 * @param defaultValue the value to be returned if no value of the desired
6053 * type is stored with the given name.
6054 *
6055 * @return the value of an item that previously added with putExtra()
6056 * or the default value if none was found.
6057 *
6058 * @see #putExtra(String, double)
6059 */
6060 public double getDoubleExtra(String name, double defaultValue) {
6061 return mExtras == null ? defaultValue :
6062 mExtras.getDouble(name, defaultValue);
6063 }
6064
6065 /**
6066 * Retrieve extended data from the intent.
6067 *
6068 * @param name The name of the desired item.
6069 *
6070 * @return the value of an item that previously added with putExtra()
6071 * or null if no String value was found.
6072 *
6073 * @see #putExtra(String, String)
6074 */
6075 public String getStringExtra(String name) {
6076 return mExtras == null ? null : mExtras.getString(name);
6077 }
6078
6079 /**
6080 * Retrieve extended data from the intent.
6081 *
6082 * @param name The name of the desired item.
6083 *
6084 * @return the value of an item that previously added with putExtra()
6085 * or null if no CharSequence value was found.
6086 *
6087 * @see #putExtra(String, CharSequence)
6088 */
6089 public CharSequence getCharSequenceExtra(String name) {
6090 return mExtras == null ? null : mExtras.getCharSequence(name);
6091 }
6092
6093 /**
6094 * Retrieve extended data from the intent.
6095 *
6096 * @param name The name of the desired item.
6097 *
6098 * @return the value of an item that previously added with putExtra()
6099 * or null if no Parcelable value was found.
6100 *
6101 * @see #putExtra(String, Parcelable)
6102 */
6103 public <T extends Parcelable> T getParcelableExtra(String name) {
6104 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6105 }
6106
6107 /**
6108 * Retrieve extended data from the intent.
6109 *
6110 * @param name The name of the desired item.
6111 *
6112 * @return the value of an item that previously added with putExtra()
6113 * or null if no Parcelable[] value was found.
6114 *
6115 * @see #putExtra(String, Parcelable[])
6116 */
6117 public Parcelable[] getParcelableArrayExtra(String name) {
6118 return mExtras == null ? null : mExtras.getParcelableArray(name);
6119 }
6120
6121 /**
6122 * Retrieve extended data from the intent.
6123 *
6124 * @param name The name of the desired item.
6125 *
6126 * @return the value of an item that previously added with putExtra()
6127 * or null if no ArrayList<Parcelable> value was found.
6128 *
6129 * @see #putParcelableArrayListExtra(String, ArrayList)
6130 */
6131 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6132 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6133 }
6134
6135 /**
6136 * Retrieve extended data from the intent.
6137 *
6138 * @param name The name of the desired item.
6139 *
6140 * @return the value of an item that previously added with putExtra()
6141 * or null if no Serializable value was found.
6142 *
6143 * @see #putExtra(String, Serializable)
6144 */
6145 public Serializable getSerializableExtra(String name) {
6146 return mExtras == null ? null : mExtras.getSerializable(name);
6147 }
6148
6149 /**
6150 * Retrieve extended data from the intent.
6151 *
6152 * @param name The name of the desired item.
6153 *
6154 * @return the value of an item that previously added with putExtra()
6155 * or null if no ArrayList<Integer> value was found.
6156 *
6157 * @see #putIntegerArrayListExtra(String, ArrayList)
6158 */
6159 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6160 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6161 }
6162
6163 /**
6164 * Retrieve extended data from the intent.
6165 *
6166 * @param name The name of the desired item.
6167 *
6168 * @return the value of an item that previously added with putExtra()
6169 * or null if no ArrayList<String> value was found.
6170 *
6171 * @see #putStringArrayListExtra(String, ArrayList)
6172 */
6173 public ArrayList<String> getStringArrayListExtra(String name) {
6174 return mExtras == null ? null : mExtras.getStringArrayList(name);
6175 }
6176
6177 /**
6178 * Retrieve extended data from the intent.
6179 *
6180 * @param name The name of the desired item.
6181 *
6182 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006183 * or null if no ArrayList<CharSequence> value was found.
6184 *
6185 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6186 */
6187 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6188 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6189 }
6190
6191 /**
6192 * Retrieve extended data from the intent.
6193 *
6194 * @param name The name of the desired item.
6195 *
6196 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006197 * or null if no boolean array value was found.
6198 *
6199 * @see #putExtra(String, boolean[])
6200 */
6201 public boolean[] getBooleanArrayExtra(String name) {
6202 return mExtras == null ? null : mExtras.getBooleanArray(name);
6203 }
6204
6205 /**
6206 * Retrieve extended data from the intent.
6207 *
6208 * @param name The name of the desired item.
6209 *
6210 * @return the value of an item that previously added with putExtra()
6211 * or null if no byte array value was found.
6212 *
6213 * @see #putExtra(String, byte[])
6214 */
6215 public byte[] getByteArrayExtra(String name) {
6216 return mExtras == null ? null : mExtras.getByteArray(name);
6217 }
6218
6219 /**
6220 * Retrieve extended data from the intent.
6221 *
6222 * @param name The name of the desired item.
6223 *
6224 * @return the value of an item that previously added with putExtra()
6225 * or null if no short array value was found.
6226 *
6227 * @see #putExtra(String, short[])
6228 */
6229 public short[] getShortArrayExtra(String name) {
6230 return mExtras == null ? null : mExtras.getShortArray(name);
6231 }
6232
6233 /**
6234 * Retrieve extended data from the intent.
6235 *
6236 * @param name The name of the desired item.
6237 *
6238 * @return the value of an item that previously added with putExtra()
6239 * or null if no char array value was found.
6240 *
6241 * @see #putExtra(String, char[])
6242 */
6243 public char[] getCharArrayExtra(String name) {
6244 return mExtras == null ? null : mExtras.getCharArray(name);
6245 }
6246
6247 /**
6248 * Retrieve extended data from the intent.
6249 *
6250 * @param name The name of the desired item.
6251 *
6252 * @return the value of an item that previously added with putExtra()
6253 * or null if no int array value was found.
6254 *
6255 * @see #putExtra(String, int[])
6256 */
6257 public int[] getIntArrayExtra(String name) {
6258 return mExtras == null ? null : mExtras.getIntArray(name);
6259 }
6260
6261 /**
6262 * Retrieve extended data from the intent.
6263 *
6264 * @param name The name of the desired item.
6265 *
6266 * @return the value of an item that previously added with putExtra()
6267 * or null if no long array value was found.
6268 *
6269 * @see #putExtra(String, long[])
6270 */
6271 public long[] getLongArrayExtra(String name) {
6272 return mExtras == null ? null : mExtras.getLongArray(name);
6273 }
6274
6275 /**
6276 * Retrieve extended data from the intent.
6277 *
6278 * @param name The name of the desired item.
6279 *
6280 * @return the value of an item that previously added with putExtra()
6281 * or null if no float array value was found.
6282 *
6283 * @see #putExtra(String, float[])
6284 */
6285 public float[] getFloatArrayExtra(String name) {
6286 return mExtras == null ? null : mExtras.getFloatArray(name);
6287 }
6288
6289 /**
6290 * Retrieve extended data from the intent.
6291 *
6292 * @param name The name of the desired item.
6293 *
6294 * @return the value of an item that previously added with putExtra()
6295 * or null if no double array value was found.
6296 *
6297 * @see #putExtra(String, double[])
6298 */
6299 public double[] getDoubleArrayExtra(String name) {
6300 return mExtras == null ? null : mExtras.getDoubleArray(name);
6301 }
6302
6303 /**
6304 * Retrieve extended data from the intent.
6305 *
6306 * @param name The name of the desired item.
6307 *
6308 * @return the value of an item that previously added with putExtra()
6309 * or null if no String array value was found.
6310 *
6311 * @see #putExtra(String, String[])
6312 */
6313 public String[] getStringArrayExtra(String name) {
6314 return mExtras == null ? null : mExtras.getStringArray(name);
6315 }
6316
6317 /**
6318 * Retrieve extended data from the intent.
6319 *
6320 * @param name The name of the desired item.
6321 *
6322 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006323 * or null if no CharSequence array value was found.
6324 *
6325 * @see #putExtra(String, CharSequence[])
6326 */
6327 public CharSequence[] getCharSequenceArrayExtra(String name) {
6328 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6329 }
6330
6331 /**
6332 * Retrieve extended data from the intent.
6333 *
6334 * @param name The name of the desired item.
6335 *
6336 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006337 * or null if no Bundle value was found.
6338 *
6339 * @see #putExtra(String, Bundle)
6340 */
6341 public Bundle getBundleExtra(String name) {
6342 return mExtras == null ? null : mExtras.getBundle(name);
6343 }
6344
6345 /**
6346 * Retrieve extended data from the intent.
6347 *
6348 * @param name The name of the desired item.
6349 *
6350 * @return the value of an item that previously added with putExtra()
6351 * or null if no IBinder value was found.
6352 *
6353 * @see #putExtra(String, IBinder)
6354 *
6355 * @deprecated
6356 * @hide
6357 */
6358 @Deprecated
6359 public IBinder getIBinderExtra(String name) {
6360 return mExtras == null ? null : mExtras.getIBinder(name);
6361 }
6362
6363 /**
6364 * Retrieve extended data from the intent.
6365 *
6366 * @param name The name of the desired item.
6367 * @param defaultValue The default value to return in case no item is
6368 * associated with the key 'name'
6369 *
6370 * @return the value of an item that previously added with putExtra()
6371 * or defaultValue if none was found.
6372 *
6373 * @see #putExtra
6374 *
6375 * @deprecated
6376 * @hide
6377 */
6378 @Deprecated
6379 public Object getExtra(String name, Object defaultValue) {
6380 Object result = defaultValue;
6381 if (mExtras != null) {
6382 Object result2 = mExtras.get(name);
6383 if (result2 != null) {
6384 result = result2;
6385 }
6386 }
6387
6388 return result;
6389 }
6390
6391 /**
6392 * Retrieves a map of extended data from the intent.
6393 *
6394 * @return the map of all extras previously added with putExtra(),
6395 * or null if none have been added.
6396 */
6397 public Bundle getExtras() {
6398 return (mExtras != null)
6399 ? new Bundle(mExtras)
6400 : null;
6401 }
6402
6403 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006404 * Filter extras to only basic types.
6405 * @hide
6406 */
6407 public void removeUnsafeExtras() {
6408 if (mExtras != null) {
6409 mExtras.filterValues();
6410 }
6411 }
6412
6413 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006414 * Retrieve any special flags associated with this intent. You will
6415 * normally just set them with {@link #setFlags} and let the system
6416 * take the appropriate action with them.
6417 *
6418 * @return int The currently set flags.
6419 *
6420 * @see #setFlags
6421 */
6422 public int getFlags() {
6423 return mFlags;
6424 }
6425
Dianne Hackborne7f97212011-02-24 14:40:20 -08006426 /** @hide */
6427 public boolean isExcludingStopped() {
6428 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6429 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6430 }
6431
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006432 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006433 * Retrieve the application package name this Intent is limited to. When
6434 * resolving an Intent, if non-null this limits the resolution to only
6435 * components in the given application package.
6436 *
6437 * @return The name of the application package for the Intent.
6438 *
6439 * @see #resolveActivity
6440 * @see #setPackage
6441 */
6442 public String getPackage() {
6443 return mPackage;
6444 }
6445
6446 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006447 * Retrieve the concrete component associated with the intent. When receiving
6448 * an intent, this is the component that was found to best handle it (that is,
6449 * yourself) and will always be non-null; in all other cases it will be
6450 * null unless explicitly set.
6451 *
6452 * @return The name of the application component to handle the intent.
6453 *
6454 * @see #resolveActivity
6455 * @see #setComponent
6456 */
6457 public ComponentName getComponent() {
6458 return mComponent;
6459 }
6460
6461 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006462 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6463 * used as a hint to the receiver for animations and the like. Null means that there
6464 * is no source bounds.
6465 */
6466 public Rect getSourceBounds() {
6467 return mSourceBounds;
6468 }
6469
6470 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006471 * Return the Activity component that should be used to handle this intent.
6472 * The appropriate component is determined based on the information in the
6473 * intent, evaluated as follows:
6474 *
6475 * <p>If {@link #getComponent} returns an explicit class, that is returned
6476 * without any further consideration.
6477 *
6478 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6479 * category to be considered.
6480 *
6481 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6482 * action.
6483 *
6484 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6485 * this type.
6486 *
6487 * <p>If {@link #addCategory} has added any categories, the activity must
6488 * handle ALL of the categories specified.
6489 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006490 * <p>If {@link #getPackage} is non-NULL, only activity components in
6491 * that application package will be considered.
6492 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006493 * <p>If there are no activities that satisfy all of these conditions, a
6494 * null string is returned.
6495 *
6496 * <p>If multiple activities are found to satisfy the intent, the one with
6497 * the highest priority will be used. If there are multiple activities
6498 * with the same priority, the system will either pick the best activity
6499 * based on user preference, or resolve to a system class that will allow
6500 * the user to pick an activity and forward from there.
6501 *
6502 * <p>This method is implemented simply by calling
6503 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6504 * true.</p>
6505 * <p> This API is called for you as part of starting an activity from an
6506 * intent. You do not normally need to call it yourself.</p>
6507 *
6508 * @param pm The package manager with which to resolve the Intent.
6509 *
6510 * @return Name of the component implementing an activity that can
6511 * display the intent.
6512 *
6513 * @see #setComponent
6514 * @see #getComponent
6515 * @see #resolveActivityInfo
6516 */
6517 public ComponentName resolveActivity(PackageManager pm) {
6518 if (mComponent != null) {
6519 return mComponent;
6520 }
6521
6522 ResolveInfo info = pm.resolveActivity(
6523 this, PackageManager.MATCH_DEFAULT_ONLY);
6524 if (info != null) {
6525 return new ComponentName(
6526 info.activityInfo.applicationInfo.packageName,
6527 info.activityInfo.name);
6528 }
6529
6530 return null;
6531 }
6532
6533 /**
6534 * Resolve the Intent into an {@link ActivityInfo}
6535 * describing the activity that should execute the intent. Resolution
6536 * follows the same rules as described for {@link #resolveActivity}, but
6537 * you get back the completely information about the resolved activity
6538 * instead of just its class name.
6539 *
6540 * @param pm The package manager with which to resolve the Intent.
6541 * @param flags Addition information to retrieve as per
6542 * {@link PackageManager#getActivityInfo(ComponentName, int)
6543 * PackageManager.getActivityInfo()}.
6544 *
6545 * @return PackageManager.ActivityInfo
6546 *
6547 * @see #resolveActivity
6548 */
6549 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6550 ActivityInfo ai = null;
6551 if (mComponent != null) {
6552 try {
6553 ai = pm.getActivityInfo(mComponent, flags);
6554 } catch (PackageManager.NameNotFoundException e) {
6555 // ignore
6556 }
6557 } else {
6558 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006559 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006560 if (info != null) {
6561 ai = info.activityInfo;
6562 }
6563 }
6564
6565 return ai;
6566 }
6567
6568 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006569 * Special function for use by the system to resolve service
6570 * intents to system apps. Throws an exception if there are
6571 * multiple potential matches to the Intent. Returns null if
6572 * there are no matches.
6573 * @hide
6574 */
6575 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6576 if (mComponent != null) {
6577 return mComponent;
6578 }
6579
6580 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6581 if (results == null) {
6582 return null;
6583 }
6584 ComponentName comp = null;
6585 for (int i=0; i<results.size(); i++) {
6586 ResolveInfo ri = results.get(i);
6587 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6588 continue;
6589 }
6590 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6591 ri.serviceInfo.name);
6592 if (comp != null) {
6593 throw new IllegalStateException("Multiple system services handle " + this
6594 + ": " + comp + ", " + foundComp);
6595 }
6596 comp = foundComp;
6597 }
6598 return comp;
6599 }
6600
6601 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006602 * Set the general action to be performed.
6603 *
6604 * @param action An action name, such as ACTION_VIEW. Application-specific
6605 * actions should be prefixed with the vendor's package name.
6606 *
6607 * @return Returns the same Intent object, for chaining multiple calls
6608 * into a single statement.
6609 *
6610 * @see #getAction
6611 */
6612 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006613 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006614 return this;
6615 }
6616
6617 /**
6618 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006619 * clears any type that was previously set by {@link #setType} or
6620 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006621 *
Nick Pellyccae4122012-01-09 14:12:58 -08006622 * <p><em>Note: scheme matching in the Android framework is
6623 * case-sensitive, unlike the formal RFC. As a result,
6624 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006625 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006626 * {@link #setDataAndNormalize}
6627 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006628 *
Nick Pellyccae4122012-01-09 14:12:58 -08006629 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006630 *
6631 * @return Returns the same Intent object, for chaining multiple calls
6632 * into a single statement.
6633 *
6634 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006635 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006636 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006637 */
6638 public Intent setData(Uri data) {
6639 mData = data;
6640 mType = null;
6641 return this;
6642 }
6643
6644 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006645 * Normalize and set the data this intent is operating on.
6646 *
6647 * <p>This method automatically clears any type that was
6648 * previously set (for example, by {@link #setType}).
6649 *
6650 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006651 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006652 * so really this is just a convenience method for
6653 * <pre>
6654 * setData(data.normalize())
6655 * </pre>
6656 *
6657 * @param data The Uri of the data this intent is now targeting.
6658 *
6659 * @return Returns the same Intent object, for chaining multiple calls
6660 * into a single statement.
6661 *
6662 * @see #getData
6663 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006664 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006665 */
6666 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006667 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006668 }
6669
6670 /**
6671 * Set an explicit MIME data type.
6672 *
6673 * <p>This is used to create intents that only specify a type and not data,
6674 * for example to indicate the type of data to return.
6675 *
6676 * <p>This method automatically clears any data that was
6677 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006678 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006679 * <p><em>Note: MIME type matching in the Android framework is
6680 * case-sensitive, unlike formal RFC MIME types. As a result,
6681 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006682 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6683 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006684 *
6685 * @param type The MIME type of the data being handled by this intent.
6686 *
6687 * @return Returns the same Intent object, for chaining multiple calls
6688 * into a single statement.
6689 *
6690 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006691 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006692 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006693 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006694 */
6695 public Intent setType(String type) {
6696 mData = null;
6697 mType = type;
6698 return this;
6699 }
6700
6701 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006702 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703 *
Nick Pellyccae4122012-01-09 14:12:58 -08006704 * <p>This is used to create intents that only specify a type and not data,
6705 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006706 *
Nick Pellyccae4122012-01-09 14:12:58 -08006707 * <p>This method automatically clears any data that was
6708 * previously set (for example by {@link #setData}).
6709 *
6710 * <p>The MIME type is normalized using
6711 * {@link #normalizeMimeType} before it is set,
6712 * so really this is just a convenience method for
6713 * <pre>
6714 * setType(Intent.normalizeMimeType(type))
6715 * </pre>
6716 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006717 * @param type The MIME type of the data being handled by this intent.
6718 *
6719 * @return Returns the same Intent object, for chaining multiple calls
6720 * into a single statement.
6721 *
Nick Pellyccae4122012-01-09 14:12:58 -08006722 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006723 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006724 * @see #normalizeMimeType
6725 */
6726 public Intent setTypeAndNormalize(String type) {
6727 return setType(normalizeMimeType(type));
6728 }
6729
6730 /**
6731 * (Usually optional) Set the data for the intent along with an explicit
6732 * MIME data type. This method should very rarely be used -- it allows you
6733 * to override the MIME type that would ordinarily be inferred from the
6734 * data with your own type given here.
6735 *
6736 * <p><em>Note: MIME type and Uri scheme matching in the
6737 * Android framework is case-sensitive, unlike the formal RFC definitions.
6738 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006739 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006740 * {@link #setDataAndTypeAndNormalize}
6741 * to ensure that they are converted to lower case.</em>
6742 *
6743 * @param data The Uri of the data this intent is now targeting.
6744 * @param type The MIME type of the data being handled by this intent.
6745 *
6746 * @return Returns the same Intent object, for chaining multiple calls
6747 * into a single statement.
6748 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006749 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006750 * @see #setData
6751 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006752 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006753 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 */
6755 public Intent setDataAndType(Uri data, String type) {
6756 mData = data;
6757 mType = type;
6758 return this;
6759 }
6760
6761 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006762 * (Usually optional) Normalize and set both the data Uri and an explicit
6763 * MIME data type. This method should very rarely be used -- it allows you
6764 * to override the MIME type that would ordinarily be inferred from the
6765 * data with your own type given here.
6766 *
6767 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006768 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006769 * before they are set, so really this is just a convenience method for
6770 * <pre>
6771 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6772 * </pre>
6773 *
6774 * @param data The Uri of the data this intent is now targeting.
6775 * @param type The MIME type of the data being handled by this intent.
6776 *
6777 * @return Returns the same Intent object, for chaining multiple calls
6778 * into a single statement.
6779 *
6780 * @see #setType
6781 * @see #setData
6782 * @see #setDataAndType
6783 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006784 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006785 */
6786 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006787 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006788 }
6789
6790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006791 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006792 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006793 * activities that provide <em>all</em> of the requested categories will be
6794 * used.
6795 *
6796 * @param category The desired category. This can be either one of the
6797 * predefined Intent categories, or a custom category in your own
6798 * namespace.
6799 *
6800 * @return Returns the same Intent object, for chaining multiple calls
6801 * into a single statement.
6802 *
6803 * @see #hasCategory
6804 * @see #removeCategory
6805 */
6806 public Intent addCategory(String category) {
6807 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006808 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006809 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006810 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006811 return this;
6812 }
6813
6814 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006815 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006816 *
6817 * @param category The category to remove.
6818 *
6819 * @see #addCategory
6820 */
6821 public void removeCategory(String category) {
6822 if (mCategories != null) {
6823 mCategories.remove(category);
6824 if (mCategories.size() == 0) {
6825 mCategories = null;
6826 }
6827 }
6828 }
6829
6830 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006831 * Set a selector for this Intent. This is a modification to the kinds of
6832 * things the Intent will match. If the selector is set, it will be used
6833 * when trying to find entities that can handle the Intent, instead of the
6834 * main contents of the Intent. This allows you build an Intent containing
6835 * a generic protocol while targeting it more specifically.
6836 *
6837 * <p>An example of where this may be used is with things like
6838 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6839 * Intent that will launch the Browser application. However, the correct
6840 * main entry point of an application is actually {@link #ACTION_MAIN}
6841 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6842 * used to specify the actual Activity to launch. If you launch the browser
6843 * with something different, undesired behavior may happen if the user has
6844 * previously or later launches it the normal way, since they do not match.
6845 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6846 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6847 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6848 *
6849 * <p>Setting a selector does not impact the behavior of
6850 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6851 * desired behavior of a selector -- it does not impact the base meaning
6852 * of the Intent, just what kinds of things will be matched against it
6853 * when determining who can handle it.</p>
6854 *
6855 * <p>You can not use both a selector and {@link #setPackage(String)} on
6856 * the same base Intent.</p>
6857 *
6858 * @param selector The desired selector Intent; set to null to not use
6859 * a special selector.
6860 */
6861 public void setSelector(Intent selector) {
6862 if (selector == this) {
6863 throw new IllegalArgumentException(
6864 "Intent being set as a selector of itself");
6865 }
6866 if (selector != null && mPackage != null) {
6867 throw new IllegalArgumentException(
6868 "Can't set selector when package name is already set");
6869 }
6870 mSelector = selector;
6871 }
6872
6873 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006874 * Set a {@link ClipData} associated with this Intent. This replaces any
6875 * previously set ClipData.
6876 *
6877 * <p>The ClipData in an intent is not used for Intent matching or other
6878 * such operations. Semantically it is like extras, used to transmit
6879 * additional data with the Intent. The main feature of using this over
6880 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6881 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6882 * items included in the clip data. This is useful, in particular, if
6883 * you want to transmit an Intent containing multiple <code>content:</code>
6884 * URIs for which the recipient may not have global permission to access the
6885 * content provider.
6886 *
6887 * <p>If the ClipData contains items that are themselves Intents, any
6888 * grant flags in those Intents will be ignored. Only the top-level flags
6889 * of the main Intent are respected, and will be applied to all Uri or
6890 * Intent items in the clip (or sub-items of the clip).
6891 *
6892 * <p>The MIME type, label, and icon in the ClipData object are not
6893 * directly used by Intent. Applications should generally rely on the
6894 * MIME type of the Intent itself, not what it may find in the ClipData.
6895 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006896 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006897 *
6898 * @param clip The new clip to set. May be null to clear the current clip.
6899 */
6900 public void setClipData(ClipData clip) {
6901 mClipData = clip;
6902 }
6903
6904 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006905 * This is NOT a secure mechanism to identify the user who sent the intent.
6906 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6907 * who sent the intent.
6908 * @hide
6909 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01006910 public void prepareToLeaveUser(int userId) {
6911 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
6912 // We want mContentUserHint to refer to the original user, so don't do anything.
6913 if (mContentUserHint == UserHandle.USER_CURRENT) {
6914 mContentUserHint = userId;
6915 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006916 }
6917
6918 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006919 * Add extended data to the intent. The name must include a package
6920 * prefix, for example the app com.android.contacts would use names
6921 * like "com.android.contacts.ShowAll".
6922 *
6923 * @param name The name of the extra data, with package prefix.
6924 * @param value The boolean data value.
6925 *
6926 * @return Returns the same Intent object, for chaining multiple calls
6927 * into a single statement.
6928 *
6929 * @see #putExtras
6930 * @see #removeExtra
6931 * @see #getBooleanExtra(String, boolean)
6932 */
6933 public Intent putExtra(String name, boolean value) {
6934 if (mExtras == null) {
6935 mExtras = new Bundle();
6936 }
6937 mExtras.putBoolean(name, value);
6938 return this;
6939 }
6940
6941 /**
6942 * Add extended data to the intent. The name must include a package
6943 * prefix, for example the app com.android.contacts would use names
6944 * like "com.android.contacts.ShowAll".
6945 *
6946 * @param name The name of the extra data, with package prefix.
6947 * @param value The byte data value.
6948 *
6949 * @return Returns the same Intent object, for chaining multiple calls
6950 * into a single statement.
6951 *
6952 * @see #putExtras
6953 * @see #removeExtra
6954 * @see #getByteExtra(String, byte)
6955 */
6956 public Intent putExtra(String name, byte value) {
6957 if (mExtras == null) {
6958 mExtras = new Bundle();
6959 }
6960 mExtras.putByte(name, value);
6961 return this;
6962 }
6963
6964 /**
6965 * Add extended data to the intent. The name must include a package
6966 * prefix, for example the app com.android.contacts would use names
6967 * like "com.android.contacts.ShowAll".
6968 *
6969 * @param name The name of the extra data, with package prefix.
6970 * @param value The char data value.
6971 *
6972 * @return Returns the same Intent object, for chaining multiple calls
6973 * into a single statement.
6974 *
6975 * @see #putExtras
6976 * @see #removeExtra
6977 * @see #getCharExtra(String, char)
6978 */
6979 public Intent putExtra(String name, char value) {
6980 if (mExtras == null) {
6981 mExtras = new Bundle();
6982 }
6983 mExtras.putChar(name, value);
6984 return this;
6985 }
6986
6987 /**
6988 * Add extended data to the intent. The name must include a package
6989 * prefix, for example the app com.android.contacts would use names
6990 * like "com.android.contacts.ShowAll".
6991 *
6992 * @param name The name of the extra data, with package prefix.
6993 * @param value The short data value.
6994 *
6995 * @return Returns the same Intent object, for chaining multiple calls
6996 * into a single statement.
6997 *
6998 * @see #putExtras
6999 * @see #removeExtra
7000 * @see #getShortExtra(String, short)
7001 */
7002 public Intent putExtra(String name, short value) {
7003 if (mExtras == null) {
7004 mExtras = new Bundle();
7005 }
7006 mExtras.putShort(name, value);
7007 return this;
7008 }
7009
7010 /**
7011 * Add extended data to the intent. The name must include a package
7012 * prefix, for example the app com.android.contacts would use names
7013 * like "com.android.contacts.ShowAll".
7014 *
7015 * @param name The name of the extra data, with package prefix.
7016 * @param value The integer data value.
7017 *
7018 * @return Returns the same Intent object, for chaining multiple calls
7019 * into a single statement.
7020 *
7021 * @see #putExtras
7022 * @see #removeExtra
7023 * @see #getIntExtra(String, int)
7024 */
7025 public Intent putExtra(String name, int value) {
7026 if (mExtras == null) {
7027 mExtras = new Bundle();
7028 }
7029 mExtras.putInt(name, value);
7030 return this;
7031 }
7032
7033 /**
7034 * Add extended data to the intent. The name must include a package
7035 * prefix, for example the app com.android.contacts would use names
7036 * like "com.android.contacts.ShowAll".
7037 *
7038 * @param name The name of the extra data, with package prefix.
7039 * @param value The long data value.
7040 *
7041 * @return Returns the same Intent object, for chaining multiple calls
7042 * into a single statement.
7043 *
7044 * @see #putExtras
7045 * @see #removeExtra
7046 * @see #getLongExtra(String, long)
7047 */
7048 public Intent putExtra(String name, long value) {
7049 if (mExtras == null) {
7050 mExtras = new Bundle();
7051 }
7052 mExtras.putLong(name, value);
7053 return this;
7054 }
7055
7056 /**
7057 * Add extended data to the intent. The name must include a package
7058 * prefix, for example the app com.android.contacts would use names
7059 * like "com.android.contacts.ShowAll".
7060 *
7061 * @param name The name of the extra data, with package prefix.
7062 * @param value The float data value.
7063 *
7064 * @return Returns the same Intent object, for chaining multiple calls
7065 * into a single statement.
7066 *
7067 * @see #putExtras
7068 * @see #removeExtra
7069 * @see #getFloatExtra(String, float)
7070 */
7071 public Intent putExtra(String name, float value) {
7072 if (mExtras == null) {
7073 mExtras = new Bundle();
7074 }
7075 mExtras.putFloat(name, value);
7076 return this;
7077 }
7078
7079 /**
7080 * Add extended data to the intent. The name must include a package
7081 * prefix, for example the app com.android.contacts would use names
7082 * like "com.android.contacts.ShowAll".
7083 *
7084 * @param name The name of the extra data, with package prefix.
7085 * @param value The double data value.
7086 *
7087 * @return Returns the same Intent object, for chaining multiple calls
7088 * into a single statement.
7089 *
7090 * @see #putExtras
7091 * @see #removeExtra
7092 * @see #getDoubleExtra(String, double)
7093 */
7094 public Intent putExtra(String name, double value) {
7095 if (mExtras == null) {
7096 mExtras = new Bundle();
7097 }
7098 mExtras.putDouble(name, value);
7099 return this;
7100 }
7101
7102 /**
7103 * Add extended data to the intent. The name must include a package
7104 * prefix, for example the app com.android.contacts would use names
7105 * like "com.android.contacts.ShowAll".
7106 *
7107 * @param name The name of the extra data, with package prefix.
7108 * @param value The String data value.
7109 *
7110 * @return Returns the same Intent object, for chaining multiple calls
7111 * into a single statement.
7112 *
7113 * @see #putExtras
7114 * @see #removeExtra
7115 * @see #getStringExtra(String)
7116 */
7117 public Intent putExtra(String name, String value) {
7118 if (mExtras == null) {
7119 mExtras = new Bundle();
7120 }
7121 mExtras.putString(name, value);
7122 return this;
7123 }
7124
7125 /**
7126 * Add extended data to the intent. The name must include a package
7127 * prefix, for example the app com.android.contacts would use names
7128 * like "com.android.contacts.ShowAll".
7129 *
7130 * @param name The name of the extra data, with package prefix.
7131 * @param value The CharSequence data value.
7132 *
7133 * @return Returns the same Intent object, for chaining multiple calls
7134 * into a single statement.
7135 *
7136 * @see #putExtras
7137 * @see #removeExtra
7138 * @see #getCharSequenceExtra(String)
7139 */
7140 public Intent putExtra(String name, CharSequence value) {
7141 if (mExtras == null) {
7142 mExtras = new Bundle();
7143 }
7144 mExtras.putCharSequence(name, value);
7145 return this;
7146 }
7147
7148 /**
7149 * Add extended data to the intent. The name must include a package
7150 * prefix, for example the app com.android.contacts would use names
7151 * like "com.android.contacts.ShowAll".
7152 *
7153 * @param name The name of the extra data, with package prefix.
7154 * @param value The Parcelable data value.
7155 *
7156 * @return Returns the same Intent object, for chaining multiple calls
7157 * into a single statement.
7158 *
7159 * @see #putExtras
7160 * @see #removeExtra
7161 * @see #getParcelableExtra(String)
7162 */
7163 public Intent putExtra(String name, Parcelable value) {
7164 if (mExtras == null) {
7165 mExtras = new Bundle();
7166 }
7167 mExtras.putParcelable(name, value);
7168 return this;
7169 }
7170
7171 /**
7172 * Add extended data to the intent. The name must include a package
7173 * prefix, for example the app com.android.contacts would use names
7174 * like "com.android.contacts.ShowAll".
7175 *
7176 * @param name The name of the extra data, with package prefix.
7177 * @param value The Parcelable[] data value.
7178 *
7179 * @return Returns the same Intent object, for chaining multiple calls
7180 * into a single statement.
7181 *
7182 * @see #putExtras
7183 * @see #removeExtra
7184 * @see #getParcelableArrayExtra(String)
7185 */
7186 public Intent putExtra(String name, Parcelable[] value) {
7187 if (mExtras == null) {
7188 mExtras = new Bundle();
7189 }
7190 mExtras.putParcelableArray(name, value);
7191 return this;
7192 }
7193
7194 /**
7195 * Add extended data to the intent. The name must include a package
7196 * prefix, for example the app com.android.contacts would use names
7197 * like "com.android.contacts.ShowAll".
7198 *
7199 * @param name The name of the extra data, with package prefix.
7200 * @param value The ArrayList<Parcelable> data value.
7201 *
7202 * @return Returns the same Intent object, for chaining multiple calls
7203 * into a single statement.
7204 *
7205 * @see #putExtras
7206 * @see #removeExtra
7207 * @see #getParcelableArrayListExtra(String)
7208 */
7209 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7210 if (mExtras == null) {
7211 mExtras = new Bundle();
7212 }
7213 mExtras.putParcelableArrayList(name, value);
7214 return this;
7215 }
7216
7217 /**
7218 * Add extended data to the intent. The name must include a package
7219 * prefix, for example the app com.android.contacts would use names
7220 * like "com.android.contacts.ShowAll".
7221 *
7222 * @param name The name of the extra data, with package prefix.
7223 * @param value The ArrayList<Integer> data value.
7224 *
7225 * @return Returns the same Intent object, for chaining multiple calls
7226 * into a single statement.
7227 *
7228 * @see #putExtras
7229 * @see #removeExtra
7230 * @see #getIntegerArrayListExtra(String)
7231 */
7232 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7233 if (mExtras == null) {
7234 mExtras = new Bundle();
7235 }
7236 mExtras.putIntegerArrayList(name, value);
7237 return this;
7238 }
7239
7240 /**
7241 * Add extended data to the intent. The name must include a package
7242 * prefix, for example the app com.android.contacts would use names
7243 * like "com.android.contacts.ShowAll".
7244 *
7245 * @param name The name of the extra data, with package prefix.
7246 * @param value The ArrayList<String> data value.
7247 *
7248 * @return Returns the same Intent object, for chaining multiple calls
7249 * into a single statement.
7250 *
7251 * @see #putExtras
7252 * @see #removeExtra
7253 * @see #getStringArrayListExtra(String)
7254 */
7255 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7256 if (mExtras == null) {
7257 mExtras = new Bundle();
7258 }
7259 mExtras.putStringArrayList(name, value);
7260 return this;
7261 }
7262
7263 /**
7264 * Add extended data to the intent. The name must include a package
7265 * prefix, for example the app com.android.contacts would use names
7266 * like "com.android.contacts.ShowAll".
7267 *
7268 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007269 * @param value The ArrayList<CharSequence> data value.
7270 *
7271 * @return Returns the same Intent object, for chaining multiple calls
7272 * into a single statement.
7273 *
7274 * @see #putExtras
7275 * @see #removeExtra
7276 * @see #getCharSequenceArrayListExtra(String)
7277 */
7278 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7279 if (mExtras == null) {
7280 mExtras = new Bundle();
7281 }
7282 mExtras.putCharSequenceArrayList(name, value);
7283 return this;
7284 }
7285
7286 /**
7287 * Add extended data to the intent. The name must include a package
7288 * prefix, for example the app com.android.contacts would use names
7289 * like "com.android.contacts.ShowAll".
7290 *
7291 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007292 * @param value The Serializable data value.
7293 *
7294 * @return Returns the same Intent object, for chaining multiple calls
7295 * into a single statement.
7296 *
7297 * @see #putExtras
7298 * @see #removeExtra
7299 * @see #getSerializableExtra(String)
7300 */
7301 public Intent putExtra(String name, Serializable value) {
7302 if (mExtras == null) {
7303 mExtras = new Bundle();
7304 }
7305 mExtras.putSerializable(name, value);
7306 return this;
7307 }
7308
7309 /**
7310 * Add extended data to the intent. The name must include a package
7311 * prefix, for example the app com.android.contacts would use names
7312 * like "com.android.contacts.ShowAll".
7313 *
7314 * @param name The name of the extra data, with package prefix.
7315 * @param value The boolean array data value.
7316 *
7317 * @return Returns the same Intent object, for chaining multiple calls
7318 * into a single statement.
7319 *
7320 * @see #putExtras
7321 * @see #removeExtra
7322 * @see #getBooleanArrayExtra(String)
7323 */
7324 public Intent putExtra(String name, boolean[] value) {
7325 if (mExtras == null) {
7326 mExtras = new Bundle();
7327 }
7328 mExtras.putBooleanArray(name, value);
7329 return this;
7330 }
7331
7332 /**
7333 * Add extended data to the intent. The name must include a package
7334 * prefix, for example the app com.android.contacts would use names
7335 * like "com.android.contacts.ShowAll".
7336 *
7337 * @param name The name of the extra data, with package prefix.
7338 * @param value The byte array data value.
7339 *
7340 * @return Returns the same Intent object, for chaining multiple calls
7341 * into a single statement.
7342 *
7343 * @see #putExtras
7344 * @see #removeExtra
7345 * @see #getByteArrayExtra(String)
7346 */
7347 public Intent putExtra(String name, byte[] value) {
7348 if (mExtras == null) {
7349 mExtras = new Bundle();
7350 }
7351 mExtras.putByteArray(name, value);
7352 return this;
7353 }
7354
7355 /**
7356 * Add extended data to the intent. The name must include a package
7357 * prefix, for example the app com.android.contacts would use names
7358 * like "com.android.contacts.ShowAll".
7359 *
7360 * @param name The name of the extra data, with package prefix.
7361 * @param value The short array data value.
7362 *
7363 * @return Returns the same Intent object, for chaining multiple calls
7364 * into a single statement.
7365 *
7366 * @see #putExtras
7367 * @see #removeExtra
7368 * @see #getShortArrayExtra(String)
7369 */
7370 public Intent putExtra(String name, short[] value) {
7371 if (mExtras == null) {
7372 mExtras = new Bundle();
7373 }
7374 mExtras.putShortArray(name, value);
7375 return this;
7376 }
7377
7378 /**
7379 * Add extended data to the intent. The name must include a package
7380 * prefix, for example the app com.android.contacts would use names
7381 * like "com.android.contacts.ShowAll".
7382 *
7383 * @param name The name of the extra data, with package prefix.
7384 * @param value The char array data value.
7385 *
7386 * @return Returns the same Intent object, for chaining multiple calls
7387 * into a single statement.
7388 *
7389 * @see #putExtras
7390 * @see #removeExtra
7391 * @see #getCharArrayExtra(String)
7392 */
7393 public Intent putExtra(String name, char[] value) {
7394 if (mExtras == null) {
7395 mExtras = new Bundle();
7396 }
7397 mExtras.putCharArray(name, value);
7398 return this;
7399 }
7400
7401 /**
7402 * Add extended data to the intent. The name must include a package
7403 * prefix, for example the app com.android.contacts would use names
7404 * like "com.android.contacts.ShowAll".
7405 *
7406 * @param name The name of the extra data, with package prefix.
7407 * @param value The int array data value.
7408 *
7409 * @return Returns the same Intent object, for chaining multiple calls
7410 * into a single statement.
7411 *
7412 * @see #putExtras
7413 * @see #removeExtra
7414 * @see #getIntArrayExtra(String)
7415 */
7416 public Intent putExtra(String name, int[] value) {
7417 if (mExtras == null) {
7418 mExtras = new Bundle();
7419 }
7420 mExtras.putIntArray(name, value);
7421 return this;
7422 }
7423
7424 /**
7425 * Add extended data to the intent. The name must include a package
7426 * prefix, for example the app com.android.contacts would use names
7427 * like "com.android.contacts.ShowAll".
7428 *
7429 * @param name The name of the extra data, with package prefix.
7430 * @param value The byte array data value.
7431 *
7432 * @return Returns the same Intent object, for chaining multiple calls
7433 * into a single statement.
7434 *
7435 * @see #putExtras
7436 * @see #removeExtra
7437 * @see #getLongArrayExtra(String)
7438 */
7439 public Intent putExtra(String name, long[] value) {
7440 if (mExtras == null) {
7441 mExtras = new Bundle();
7442 }
7443 mExtras.putLongArray(name, value);
7444 return this;
7445 }
7446
7447 /**
7448 * Add extended data to the intent. The name must include a package
7449 * prefix, for example the app com.android.contacts would use names
7450 * like "com.android.contacts.ShowAll".
7451 *
7452 * @param name The name of the extra data, with package prefix.
7453 * @param value The float array data value.
7454 *
7455 * @return Returns the same Intent object, for chaining multiple calls
7456 * into a single statement.
7457 *
7458 * @see #putExtras
7459 * @see #removeExtra
7460 * @see #getFloatArrayExtra(String)
7461 */
7462 public Intent putExtra(String name, float[] value) {
7463 if (mExtras == null) {
7464 mExtras = new Bundle();
7465 }
7466 mExtras.putFloatArray(name, value);
7467 return this;
7468 }
7469
7470 /**
7471 * Add extended data to the intent. The name must include a package
7472 * prefix, for example the app com.android.contacts would use names
7473 * like "com.android.contacts.ShowAll".
7474 *
7475 * @param name The name of the extra data, with package prefix.
7476 * @param value The double array data value.
7477 *
7478 * @return Returns the same Intent object, for chaining multiple calls
7479 * into a single statement.
7480 *
7481 * @see #putExtras
7482 * @see #removeExtra
7483 * @see #getDoubleArrayExtra(String)
7484 */
7485 public Intent putExtra(String name, double[] value) {
7486 if (mExtras == null) {
7487 mExtras = new Bundle();
7488 }
7489 mExtras.putDoubleArray(name, value);
7490 return this;
7491 }
7492
7493 /**
7494 * Add extended data to the intent. The name must include a package
7495 * prefix, for example the app com.android.contacts would use names
7496 * like "com.android.contacts.ShowAll".
7497 *
7498 * @param name The name of the extra data, with package prefix.
7499 * @param value The String array data value.
7500 *
7501 * @return Returns the same Intent object, for chaining multiple calls
7502 * into a single statement.
7503 *
7504 * @see #putExtras
7505 * @see #removeExtra
7506 * @see #getStringArrayExtra(String)
7507 */
7508 public Intent putExtra(String name, String[] value) {
7509 if (mExtras == null) {
7510 mExtras = new Bundle();
7511 }
7512 mExtras.putStringArray(name, value);
7513 return this;
7514 }
7515
7516 /**
7517 * Add extended data to the intent. The name must include a package
7518 * prefix, for example the app com.android.contacts would use names
7519 * like "com.android.contacts.ShowAll".
7520 *
7521 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007522 * @param value The CharSequence array data value.
7523 *
7524 * @return Returns the same Intent object, for chaining multiple calls
7525 * into a single statement.
7526 *
7527 * @see #putExtras
7528 * @see #removeExtra
7529 * @see #getCharSequenceArrayExtra(String)
7530 */
7531 public Intent putExtra(String name, CharSequence[] value) {
7532 if (mExtras == null) {
7533 mExtras = new Bundle();
7534 }
7535 mExtras.putCharSequenceArray(name, value);
7536 return this;
7537 }
7538
7539 /**
7540 * Add extended data to the intent. The name must include a package
7541 * prefix, for example the app com.android.contacts would use names
7542 * like "com.android.contacts.ShowAll".
7543 *
7544 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007545 * @param value The Bundle data value.
7546 *
7547 * @return Returns the same Intent object, for chaining multiple calls
7548 * into a single statement.
7549 *
7550 * @see #putExtras
7551 * @see #removeExtra
7552 * @see #getBundleExtra(String)
7553 */
7554 public Intent putExtra(String name, Bundle value) {
7555 if (mExtras == null) {
7556 mExtras = new Bundle();
7557 }
7558 mExtras.putBundle(name, value);
7559 return this;
7560 }
7561
7562 /**
7563 * Add extended data to the intent. The name must include a package
7564 * prefix, for example the app com.android.contacts would use names
7565 * like "com.android.contacts.ShowAll".
7566 *
7567 * @param name The name of the extra data, with package prefix.
7568 * @param value The IBinder data value.
7569 *
7570 * @return Returns the same Intent object, for chaining multiple calls
7571 * into a single statement.
7572 *
7573 * @see #putExtras
7574 * @see #removeExtra
7575 * @see #getIBinderExtra(String)
7576 *
7577 * @deprecated
7578 * @hide
7579 */
7580 @Deprecated
7581 public Intent putExtra(String name, IBinder value) {
7582 if (mExtras == null) {
7583 mExtras = new Bundle();
7584 }
7585 mExtras.putIBinder(name, value);
7586 return this;
7587 }
7588
7589 /**
7590 * Copy all extras in 'src' in to this intent.
7591 *
7592 * @param src Contains the extras to copy.
7593 *
7594 * @see #putExtra
7595 */
7596 public Intent putExtras(Intent src) {
7597 if (src.mExtras != null) {
7598 if (mExtras == null) {
7599 mExtras = new Bundle(src.mExtras);
7600 } else {
7601 mExtras.putAll(src.mExtras);
7602 }
7603 }
7604 return this;
7605 }
7606
7607 /**
7608 * Add a set of extended data to the intent. The keys must include a package
7609 * prefix, for example the app com.android.contacts would use names
7610 * like "com.android.contacts.ShowAll".
7611 *
7612 * @param extras The Bundle of extras to add to this intent.
7613 *
7614 * @see #putExtra
7615 * @see #removeExtra
7616 */
7617 public Intent putExtras(Bundle extras) {
7618 if (mExtras == null) {
7619 mExtras = new Bundle();
7620 }
7621 mExtras.putAll(extras);
7622 return this;
7623 }
7624
7625 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007626 * Completely replace the extras in the Intent with the extras in the
7627 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007628 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007629 * @param src The exact extras contained in this Intent are copied
7630 * into the target intent, replacing any that were previously there.
7631 */
7632 public Intent replaceExtras(Intent src) {
7633 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7634 return this;
7635 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007636
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007637 /**
7638 * Completely replace the extras in the Intent with the given Bundle of
7639 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007640 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007641 * @param extras The new set of extras in the Intent, or null to erase
7642 * all extras.
7643 */
7644 public Intent replaceExtras(Bundle extras) {
7645 mExtras = extras != null ? new Bundle(extras) : null;
7646 return this;
7647 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007648
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007649 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007650 * Remove extended data from the intent.
7651 *
7652 * @see #putExtra
7653 */
7654 public void removeExtra(String name) {
7655 if (mExtras != null) {
7656 mExtras.remove(name);
7657 if (mExtras.size() == 0) {
7658 mExtras = null;
7659 }
7660 }
7661 }
7662
7663 /**
7664 * Set special flags controlling how this intent is handled. Most values
7665 * here depend on the type of component being executed by the Intent,
7666 * specifically the FLAG_ACTIVITY_* flags are all for use with
7667 * {@link Context#startActivity Context.startActivity()} and the
7668 * FLAG_RECEIVER_* flags are all for use with
7669 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7670 *
Scott Main7aee61f2011-02-08 11:25:01 -08007671 * <p>See the
7672 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7673 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007674 * the behavior of your application.
7675 *
7676 * @param flags The desired flags.
7677 *
7678 * @return Returns the same Intent object, for chaining multiple calls
7679 * into a single statement.
7680 *
7681 * @see #getFlags
7682 * @see #addFlags
7683 *
7684 * @see #FLAG_GRANT_READ_URI_PERMISSION
7685 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007686 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7687 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007688 * @see #FLAG_DEBUG_LOG_RESOLUTION
7689 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007690 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007691 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007692 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007693 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007694 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7695 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007696 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007697 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007698 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007699 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007700 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007701 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007702 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007703 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7704 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007705 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007706 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007707 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007708 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7709 */
7710 public Intent setFlags(int flags) {
7711 mFlags = flags;
7712 return this;
7713 }
7714
7715 /**
7716 * Add additional flags to the intent (or with existing flags
7717 * value).
7718 *
7719 * @param flags The new flags to set.
7720 *
7721 * @return Returns the same Intent object, for chaining multiple calls
7722 * into a single statement.
7723 *
7724 * @see #setFlags
7725 */
7726 public Intent addFlags(int flags) {
7727 mFlags |= flags;
7728 return this;
7729 }
7730
7731 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007732 * (Usually optional) Set an explicit application package name that limits
7733 * the components this Intent will resolve to. If left to the default
7734 * value of null, all components in all applications will considered.
7735 * If non-null, the Intent can only match the components in the given
7736 * application package.
7737 *
7738 * @param packageName The name of the application package to handle the
7739 * intent, or null to allow any application package.
7740 *
7741 * @return Returns the same Intent object, for chaining multiple calls
7742 * into a single statement.
7743 *
7744 * @see #getPackage
7745 * @see #resolveActivity
7746 */
7747 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007748 if (packageName != null && mSelector != null) {
7749 throw new IllegalArgumentException(
7750 "Can't set package name when selector is already set");
7751 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007752 mPackage = packageName;
7753 return this;
7754 }
7755
7756 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007757 * (Usually optional) Explicitly set the component to handle the intent.
7758 * If left with the default value of null, the system will determine the
7759 * appropriate class to use based on the other fields (action, data,
7760 * type, categories) in the Intent. If this class is defined, the
7761 * specified class will always be used regardless of the other fields. You
7762 * should only set this value when you know you absolutely want a specific
7763 * class to be used; otherwise it is better to let the system find the
7764 * appropriate class so that you will respect the installed applications
7765 * and user preferences.
7766 *
7767 * @param component The name of the application component to handle the
7768 * intent, or null to let the system find one for you.
7769 *
7770 * @return Returns the same Intent object, for chaining multiple calls
7771 * into a single statement.
7772 *
7773 * @see #setClass
7774 * @see #setClassName(Context, String)
7775 * @see #setClassName(String, String)
7776 * @see #getComponent
7777 * @see #resolveActivity
7778 */
7779 public Intent setComponent(ComponentName component) {
7780 mComponent = component;
7781 return this;
7782 }
7783
7784 /**
7785 * Convenience for calling {@link #setComponent} with an
7786 * explicit class name.
7787 *
7788 * @param packageContext A Context of the application package implementing
7789 * this class.
7790 * @param className The name of a class inside of the application package
7791 * that will be used as the component for this Intent.
7792 *
7793 * @return Returns the same Intent object, for chaining multiple calls
7794 * into a single statement.
7795 *
7796 * @see #setComponent
7797 * @see #setClass
7798 */
7799 public Intent setClassName(Context packageContext, String className) {
7800 mComponent = new ComponentName(packageContext, className);
7801 return this;
7802 }
7803
7804 /**
7805 * Convenience for calling {@link #setComponent} with an
7806 * explicit application package name and class name.
7807 *
7808 * @param packageName The name of the package implementing the desired
7809 * component.
7810 * @param className The name of a class inside of the application package
7811 * that will be used as the component for this Intent.
7812 *
7813 * @return Returns the same Intent object, for chaining multiple calls
7814 * into a single statement.
7815 *
7816 * @see #setComponent
7817 * @see #setClass
7818 */
7819 public Intent setClassName(String packageName, String className) {
7820 mComponent = new ComponentName(packageName, className);
7821 return this;
7822 }
7823
7824 /**
7825 * Convenience for calling {@link #setComponent(ComponentName)} with the
7826 * name returned by a {@link Class} object.
7827 *
7828 * @param packageContext A Context of the application package implementing
7829 * this class.
7830 * @param cls The class name to set, equivalent to
7831 * <code>setClassName(context, cls.getName())</code>.
7832 *
7833 * @return Returns the same Intent object, for chaining multiple calls
7834 * into a single statement.
7835 *
7836 * @see #setComponent
7837 */
7838 public Intent setClass(Context packageContext, Class<?> cls) {
7839 mComponent = new ComponentName(packageContext, cls);
7840 return this;
7841 }
7842
7843 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007844 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7845 * used as a hint to the receiver for animations and the like. Null means that there
7846 * is no source bounds.
7847 */
7848 public void setSourceBounds(Rect r) {
7849 if (r != null) {
7850 mSourceBounds = new Rect(r);
7851 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007852 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007853 }
7854 }
7855
Tor Norbyed9273d62013-05-30 15:59:53 -07007856 /** @hide */
7857 @IntDef(flag = true,
7858 value = {
7859 FILL_IN_ACTION,
7860 FILL_IN_DATA,
7861 FILL_IN_CATEGORIES,
7862 FILL_IN_COMPONENT,
7863 FILL_IN_PACKAGE,
7864 FILL_IN_SOURCE_BOUNDS,
7865 FILL_IN_SELECTOR,
7866 FILL_IN_CLIP_DATA
7867 })
7868 @Retention(RetentionPolicy.SOURCE)
7869 public @interface FillInFlags {}
7870
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007871 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007872 * Use with {@link #fillIn} to allow the current action value to be
7873 * overwritten, even if it is already set.
7874 */
7875 public static final int FILL_IN_ACTION = 1<<0;
7876
7877 /**
7878 * Use with {@link #fillIn} to allow the current data or type value
7879 * overwritten, even if it is already set.
7880 */
7881 public static final int FILL_IN_DATA = 1<<1;
7882
7883 /**
7884 * Use with {@link #fillIn} to allow the current categories to be
7885 * overwritten, even if they are already set.
7886 */
7887 public static final int FILL_IN_CATEGORIES = 1<<2;
7888
7889 /**
7890 * Use with {@link #fillIn} to allow the current component value to be
7891 * overwritten, even if it is already set.
7892 */
7893 public static final int FILL_IN_COMPONENT = 1<<3;
7894
7895 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007896 * Use with {@link #fillIn} to allow the current package value to be
7897 * overwritten, even if it is already set.
7898 */
7899 public static final int FILL_IN_PACKAGE = 1<<4;
7900
7901 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007902 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007903 * overwritten, even if it is already set.
7904 */
7905 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7906
7907 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007908 * Use with {@link #fillIn} to allow the current selector to be
7909 * overwritten, even if it is already set.
7910 */
7911 public static final int FILL_IN_SELECTOR = 1<<6;
7912
7913 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007914 * Use with {@link #fillIn} to allow the current ClipData to be
7915 * overwritten, even if it is already set.
7916 */
7917 public static final int FILL_IN_CLIP_DATA = 1<<7;
7918
7919 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007920 * Copy the contents of <var>other</var> in to this object, but only
7921 * where fields are not defined by this object. For purposes of a field
7922 * being defined, the following pieces of data in the Intent are
7923 * considered to be separate fields:
7924 *
7925 * <ul>
7926 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007927 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007928 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7929 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007930 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007931 * <li> component, as set by {@link #setComponent(ComponentName)} or
7932 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007933 * <li> source bounds, as set by {@link #setSourceBounds}.
7934 * <li> selector, as set by {@link #setSelector(Intent)}.
7935 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007936 * <li> each top-level name in the associated extras.
7937 * </ul>
7938 *
7939 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007940 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007941 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7942 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7943 * the restriction where the corresponding field will not be replaced if
7944 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007945 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007946 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7947 * is explicitly specified. The selector will only be copied if
7948 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007949 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007950 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7951 * and Intent B with {action="gotit", data-type="some/thing",
7952 * categories="one","two"}.
7953 *
7954 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7955 * containing: {action="gotit", data-type="some/thing",
7956 * categories="bar"}.
7957 *
7958 * @param other Another Intent whose values are to be used to fill in
7959 * the current one.
7960 * @param flags Options to control which fields can be filled in.
7961 *
7962 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007963 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007964 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7965 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7966 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007967 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007968 @FillInFlags
7969 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007970 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007971 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007972 if (other.mAction != null
7973 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007974 mAction = other.mAction;
7975 changes |= FILL_IN_ACTION;
7976 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007977 if ((other.mData != null || other.mType != null)
7978 && ((mData == null && mType == null)
7979 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007980 mData = other.mData;
7981 mType = other.mType;
7982 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007983 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007984 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007985 if (other.mCategories != null
7986 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007987 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007988 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007989 }
7990 changes |= FILL_IN_CATEGORIES;
7991 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007992 if (other.mPackage != null
7993 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007994 // Only do this if mSelector is not set.
7995 if (mSelector == null) {
7996 mPackage = other.mPackage;
7997 changes |= FILL_IN_PACKAGE;
7998 }
7999 }
8000 // Selector is special: it can only be set if explicitly allowed,
8001 // for the same reason as the component name.
8002 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8003 if (mPackage == null) {
8004 mSelector = new Intent(other.mSelector);
8005 mPackage = null;
8006 changes |= FILL_IN_SELECTOR;
8007 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008008 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008009 if (other.mClipData != null
8010 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8011 mClipData = other.mClipData;
8012 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008013 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008014 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008015 // Component is special: it can -only- be set if explicitly allowed,
8016 // since otherwise the sender could force the intent somewhere the
8017 // originator didn't intend.
8018 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008019 mComponent = other.mComponent;
8020 changes |= FILL_IN_COMPONENT;
8021 }
8022 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008023 if (other.mSourceBounds != null
8024 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8025 mSourceBounds = new Rect(other.mSourceBounds);
8026 changes |= FILL_IN_SOURCE_BOUNDS;
8027 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008028 if (mExtras == null) {
8029 if (other.mExtras != null) {
8030 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008031 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008032 }
8033 } else if (other.mExtras != null) {
8034 try {
8035 Bundle newb = new Bundle(other.mExtras);
8036 newb.putAll(mExtras);
8037 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008038 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008039 } catch (RuntimeException e) {
8040 // Modifying the extras can cause us to unparcel the contents
8041 // of the bundle, and if we do this in the system process that
8042 // may fail. We really should handle this (i.e., the Bundle
8043 // impl shouldn't be on top of a plain map), but for now just
8044 // ignore it and keep the original contents. :(
8045 Log.w("Intent", "Failure filling in extras", e);
8046 }
8047 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008048 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8049 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8050 mContentUserHint = other.mContentUserHint;
8051 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008052 return changes;
8053 }
8054
8055 /**
8056 * Wrapper class holding an Intent and implementing comparisons on it for
8057 * the purpose of filtering. The class implements its
8058 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8059 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8060 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8061 * on the wrapped Intent.
8062 */
8063 public static final class FilterComparison {
8064 private final Intent mIntent;
8065 private final int mHashCode;
8066
8067 public FilterComparison(Intent intent) {
8068 mIntent = intent;
8069 mHashCode = intent.filterHashCode();
8070 }
8071
8072 /**
8073 * Return the Intent that this FilterComparison represents.
8074 * @return Returns the Intent held by the FilterComparison. Do
8075 * not modify!
8076 */
8077 public Intent getIntent() {
8078 return mIntent;
8079 }
8080
8081 @Override
8082 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008083 if (obj instanceof FilterComparison) {
8084 Intent other = ((FilterComparison)obj).mIntent;
8085 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008086 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008087 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008088 }
8089
8090 @Override
8091 public int hashCode() {
8092 return mHashCode;
8093 }
8094 }
8095
8096 /**
8097 * Determine if two intents are the same for the purposes of intent
8098 * resolution (filtering). That is, if their action, data, type,
8099 * class, and categories are the same. This does <em>not</em> compare
8100 * any extra data included in the intents.
8101 *
8102 * @param other The other Intent to compare against.
8103 *
8104 * @return Returns true if action, data, type, class, and categories
8105 * are the same.
8106 */
8107 public boolean filterEquals(Intent other) {
8108 if (other == null) {
8109 return false;
8110 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008111 if (!Objects.equals(this.mAction, other.mAction)) return false;
8112 if (!Objects.equals(this.mData, other.mData)) return false;
8113 if (!Objects.equals(this.mType, other.mType)) return false;
8114 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8115 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8116 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008117
8118 return true;
8119 }
8120
8121 /**
8122 * Generate hash code that matches semantics of filterEquals().
8123 *
8124 * @return Returns the hash value of the action, data, type, class, and
8125 * categories.
8126 *
8127 * @see #filterEquals
8128 */
8129 public int filterHashCode() {
8130 int code = 0;
8131 if (mAction != null) {
8132 code += mAction.hashCode();
8133 }
8134 if (mData != null) {
8135 code += mData.hashCode();
8136 }
8137 if (mType != null) {
8138 code += mType.hashCode();
8139 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008140 if (mPackage != null) {
8141 code += mPackage.hashCode();
8142 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008143 if (mComponent != null) {
8144 code += mComponent.hashCode();
8145 }
8146 if (mCategories != null) {
8147 code += mCategories.hashCode();
8148 }
8149 return code;
8150 }
8151
8152 @Override
8153 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008154 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008155
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008156 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008157 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008158 b.append(" }");
8159
8160 return b.toString();
8161 }
8162
8163 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008164 public String toInsecureString() {
8165 StringBuilder b = new StringBuilder(128);
8166
8167 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008168 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008169 b.append(" }");
8170
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008171 return b.toString();
8172 }
Romain Guy4969af72009-06-17 10:53:19 -07008173
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008174 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008175 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008176 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008177
8178 b.append("Intent { ");
8179 toShortString(b, false, true, true, true);
8180 b.append(" }");
8181
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008182 return b.toString();
8183 }
8184
8185 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008186 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8187 StringBuilder b = new StringBuilder(128);
8188 toShortString(b, secure, comp, extras, clip);
8189 return b.toString();
8190 }
8191
8192 /** @hide */
8193 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8194 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008195 boolean first = true;
8196 if (mAction != null) {
8197 b.append("act=").append(mAction);
8198 first = false;
8199 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008200 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008201 if (!first) {
8202 b.append(' ');
8203 }
8204 first = false;
8205 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008206 for (int i=0; i<mCategories.size(); i++) {
8207 if (i > 0) b.append(',');
8208 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008209 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008210 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008211 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008212 if (mData != null) {
8213 if (!first) {
8214 b.append(' ');
8215 }
8216 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008217 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008218 if (secure) {
8219 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008220 } else {
8221 b.append(mData);
8222 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008223 }
8224 if (mType != null) {
8225 if (!first) {
8226 b.append(' ');
8227 }
8228 first = false;
8229 b.append("typ=").append(mType);
8230 }
8231 if (mFlags != 0) {
8232 if (!first) {
8233 b.append(' ');
8234 }
8235 first = false;
8236 b.append("flg=0x").append(Integer.toHexString(mFlags));
8237 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008238 if (mPackage != null) {
8239 if (!first) {
8240 b.append(' ');
8241 }
8242 first = false;
8243 b.append("pkg=").append(mPackage);
8244 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008245 if (comp && mComponent != null) {
8246 if (!first) {
8247 b.append(' ');
8248 }
8249 first = false;
8250 b.append("cmp=").append(mComponent.flattenToShortString());
8251 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008252 if (mSourceBounds != null) {
8253 if (!first) {
8254 b.append(' ');
8255 }
8256 first = false;
8257 b.append("bnds=").append(mSourceBounds.toShortString());
8258 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008259 if (mClipData != null) {
8260 if (!first) {
8261 b.append(' ');
8262 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008263 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008264 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008265 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008266 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008267 if (mClipData.getDescription() != null) {
8268 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8269 } else {
8270 first = true;
8271 }
8272 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008273 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008274 first = false;
8275 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008276 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008277 if (extras && mExtras != null) {
8278 if (!first) {
8279 b.append(' ');
8280 }
8281 first = false;
8282 b.append("(has extras)");
8283 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008284 if (mContentUserHint != UserHandle.USER_CURRENT) {
8285 if (!first) {
8286 b.append(' ');
8287 }
8288 first = false;
8289 b.append("u=").append(mContentUserHint);
8290 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008291 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008292 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008293 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008294 b.append("}");
8295 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008296 }
8297
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008298 /**
8299 * Call {@link #toUri} with 0 flags.
8300 * @deprecated Use {@link #toUri} instead.
8301 */
8302 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008303 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008304 return toUri(0);
8305 }
8306
8307 /**
8308 * Convert this Intent into a String holding a URI representation of it.
8309 * The returned URI string has been properly URI encoded, so it can be
8310 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8311 * Intent's data as the base URI, with an additional fragment describing
8312 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008313 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008314 * <p>You can convert the returned string back to an Intent with
8315 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008316 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008317 * @param flags Additional operating flags. Either 0,
8318 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008319 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008320 * @return Returns a URI encoding URI string describing the entire contents
8321 * of the Intent.
8322 */
8323 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008324 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008325 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8326 if (mPackage == null) {
8327 throw new IllegalArgumentException(
8328 "Intent must include an explicit package name to build an android-app: "
8329 + this);
8330 }
8331 uri.append("android-app://");
8332 uri.append(mPackage);
8333 String scheme = null;
8334 if (mData != null) {
8335 scheme = mData.getScheme();
8336 if (scheme != null) {
8337 uri.append('/');
8338 uri.append(scheme);
8339 String authority = mData.getEncodedAuthority();
8340 if (authority != null) {
8341 uri.append('/');
8342 uri.append(authority);
8343 String path = mData.getEncodedPath();
8344 if (path != null) {
8345 uri.append(path);
8346 }
8347 String queryParams = mData.getEncodedQuery();
8348 if (queryParams != null) {
8349 uri.append('?');
8350 uri.append(queryParams);
8351 }
8352 String fragment = mData.getEncodedFragment();
8353 if (fragment != null) {
8354 uri.append('#');
8355 uri.append(fragment);
8356 }
8357 }
8358 }
8359 }
8360 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8361 mPackage, flags);
8362 return uri.toString();
8363 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008364 String scheme = null;
8365 if (mData != null) {
8366 String data = mData.toString();
8367 if ((flags&URI_INTENT_SCHEME) != 0) {
8368 final int N = data.length();
8369 for (int i=0; i<N; i++) {
8370 char c = data.charAt(i);
8371 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8372 || c == '.' || c == '-') {
8373 continue;
8374 }
8375 if (c == ':' && i > 0) {
8376 // Valid scheme.
8377 scheme = data.substring(0, i);
8378 uri.append("intent:");
8379 data = data.substring(i+1);
8380 break;
8381 }
Tom Taylord4a47292009-12-21 13:59:18 -08008382
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008383 // No scheme.
8384 break;
8385 }
8386 }
8387 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008388
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008389 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8390 uri.append("intent:");
8391 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008392
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008393 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008394
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008395 return uri.toString();
8396 }
8397
8398 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8399 String defPackage, int flags) {
8400 StringBuilder frag = new StringBuilder(128);
8401
8402 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008403 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008404 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008405 // Note that for now we are not going to try to handle the
8406 // data part; not clear how to represent this as a URI, and
8407 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008408 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8409 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008410 }
8411
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008412 if (frag.length() > 0) {
8413 uri.append("#Intent;");
8414 uri.append(frag);
8415 uri.append("end");
8416 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008417 }
8418
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008419 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8420 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008421 if (scheme != null) {
8422 uri.append("scheme=").append(scheme).append(';');
8423 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008424 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008425 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008426 }
8427 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008428 for (int i=0; i<mCategories.size(); i++) {
8429 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008430 }
8431 }
8432 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008433 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008434 }
8435 if (mFlags != 0) {
8436 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8437 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008438 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008439 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8440 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008441 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008442 uri.append("component=").append(Uri.encode(
8443 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008444 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008445 if (mSourceBounds != null) {
8446 uri.append("sourceBounds=")
8447 .append(Uri.encode(mSourceBounds.flattenToString()))
8448 .append(';');
8449 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008450 if (mExtras != null) {
8451 for (String key : mExtras.keySet()) {
8452 final Object value = mExtras.get(key);
8453 char entryType =
8454 value instanceof String ? 'S' :
8455 value instanceof Boolean ? 'B' :
8456 value instanceof Byte ? 'b' :
8457 value instanceof Character ? 'c' :
8458 value instanceof Double ? 'd' :
8459 value instanceof Float ? 'f' :
8460 value instanceof Integer ? 'i' :
8461 value instanceof Long ? 'l' :
8462 value instanceof Short ? 's' :
8463 '\0';
8464
8465 if (entryType != '\0') {
8466 uri.append(entryType);
8467 uri.append('.');
8468 uri.append(Uri.encode(key));
8469 uri.append('=');
8470 uri.append(Uri.encode(value.toString()));
8471 uri.append(';');
8472 }
8473 }
8474 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008475 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008476
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008477 public int describeContents() {
8478 return (mExtras != null) ? mExtras.describeContents() : 0;
8479 }
8480
8481 public void writeToParcel(Parcel out, int flags) {
8482 out.writeString(mAction);
8483 Uri.writeToParcel(out, mData);
8484 out.writeString(mType);
8485 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008486 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008487 ComponentName.writeToParcel(mComponent, out);
8488
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008489 if (mSourceBounds != null) {
8490 out.writeInt(1);
8491 mSourceBounds.writeToParcel(out, flags);
8492 } else {
8493 out.writeInt(0);
8494 }
8495
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008496 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008497 final int N = mCategories.size();
8498 out.writeInt(N);
8499 for (int i=0; i<N; i++) {
8500 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008501 }
8502 } else {
8503 out.writeInt(0);
8504 }
8505
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008506 if (mSelector != null) {
8507 out.writeInt(1);
8508 mSelector.writeToParcel(out, flags);
8509 } else {
8510 out.writeInt(0);
8511 }
8512
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008513 if (mClipData != null) {
8514 out.writeInt(1);
8515 mClipData.writeToParcel(out, flags);
8516 } else {
8517 out.writeInt(0);
8518 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008519 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008520 out.writeBundle(mExtras);
8521 }
8522
8523 public static final Parcelable.Creator<Intent> CREATOR
8524 = new Parcelable.Creator<Intent>() {
8525 public Intent createFromParcel(Parcel in) {
8526 return new Intent(in);
8527 }
8528 public Intent[] newArray(int size) {
8529 return new Intent[size];
8530 }
8531 };
8532
Dianne Hackborneb034652009-09-07 00:49:58 -07008533 /** @hide */
8534 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008535 readFromParcel(in);
8536 }
8537
8538 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008539 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008540 mData = Uri.CREATOR.createFromParcel(in);
8541 mType = in.readString();
8542 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008543 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008544 mComponent = ComponentName.readFromParcel(in);
8545
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008546 if (in.readInt() != 0) {
8547 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8548 }
8549
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008550 int N = in.readInt();
8551 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008552 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008553 int i;
8554 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008555 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008556 }
8557 } else {
8558 mCategories = null;
8559 }
8560
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008561 if (in.readInt() != 0) {
8562 mSelector = new Intent(in);
8563 }
8564
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008565 if (in.readInt() != 0) {
8566 mClipData = new ClipData(in);
8567 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008568 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008569 mExtras = in.readBundle();
8570 }
8571
8572 /**
8573 * Parses the "intent" element (and its children) from XML and instantiates
8574 * an Intent object. The given XML parser should be located at the tag
8575 * where parsing should start (often named "intent"), from which the
8576 * basic action, data, type, and package and class name will be
8577 * retrieved. The function will then parse in to any child elements,
8578 * looking for <category android:name="xxx"> tags to add categories and
8579 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8580 * to the intent.
8581 *
8582 * @param resources The Resources to use when inflating resources.
8583 * @param parser The XML parser pointing at an "intent" tag.
8584 * @param attrs The AttributeSet interface for retrieving extended
8585 * attribute data at the current <var>parser</var> location.
8586 * @return An Intent object matching the XML data.
8587 * @throws XmlPullParserException If there was an XML parsing error.
8588 * @throws IOException If there was an I/O error.
8589 */
8590 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8591 throws XmlPullParserException, IOException {
8592 Intent intent = new Intent();
8593
8594 TypedArray sa = resources.obtainAttributes(attrs,
8595 com.android.internal.R.styleable.Intent);
8596
8597 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8598
8599 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8600 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8601 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8602
8603 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8604 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8605 if (packageName != null && className != null) {
8606 intent.setComponent(new ComponentName(packageName, className));
8607 }
8608
8609 sa.recycle();
8610
8611 int outerDepth = parser.getDepth();
8612 int type;
8613 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8614 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8615 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8616 continue;
8617 }
8618
8619 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008620 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008621 sa = resources.obtainAttributes(attrs,
8622 com.android.internal.R.styleable.IntentCategory);
8623 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8624 sa.recycle();
8625
8626 if (cat != null) {
8627 intent.addCategory(cat);
8628 }
8629 XmlUtils.skipCurrentTag(parser);
8630
Craig Mautner21d24a22014-04-23 11:45:37 -07008631 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008632 if (intent.mExtras == null) {
8633 intent.mExtras = new Bundle();
8634 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008635 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008636 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008637
8638 } else {
8639 XmlUtils.skipCurrentTag(parser);
8640 }
8641 }
8642
8643 return intent;
8644 }
Nick Pellyccae4122012-01-09 14:12:58 -08008645
Craig Mautner21d24a22014-04-23 11:45:37 -07008646 /** @hide */
8647 public void saveToXml(XmlSerializer out) throws IOException {
8648 if (mAction != null) {
8649 out.attribute(null, ATTR_ACTION, mAction);
8650 }
8651 if (mData != null) {
8652 out.attribute(null, ATTR_DATA, mData.toString());
8653 }
8654 if (mType != null) {
8655 out.attribute(null, ATTR_TYPE, mType);
8656 }
8657 if (mComponent != null) {
8658 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8659 }
8660 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8661
8662 if (mCategories != null) {
8663 out.startTag(null, TAG_CATEGORIES);
8664 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8665 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8666 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008667 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008668 }
8669 }
8670
8671 /** @hide */
8672 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8673 XmlPullParserException {
8674 Intent intent = new Intent();
8675 final int outerDepth = in.getDepth();
8676
8677 int attrCount = in.getAttributeCount();
8678 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8679 final String attrName = in.getAttributeName(attrNdx);
8680 final String attrValue = in.getAttributeValue(attrNdx);
8681 if (ATTR_ACTION.equals(attrName)) {
8682 intent.setAction(attrValue);
8683 } else if (ATTR_DATA.equals(attrName)) {
8684 intent.setData(Uri.parse(attrValue));
8685 } else if (ATTR_TYPE.equals(attrName)) {
8686 intent.setType(attrValue);
8687 } else if (ATTR_COMPONENT.equals(attrName)) {
8688 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8689 } else if (ATTR_FLAGS.equals(attrName)) {
8690 intent.setFlags(Integer.valueOf(attrValue, 16));
8691 } else {
8692 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8693 }
8694 }
8695
8696 int event;
8697 String name;
8698 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8699 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8700 if (event == XmlPullParser.START_TAG) {
8701 name = in.getName();
8702 if (TAG_CATEGORIES.equals(name)) {
8703 attrCount = in.getAttributeCount();
8704 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8705 intent.addCategory(in.getAttributeValue(attrNdx));
8706 }
8707 } else {
8708 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8709 XmlUtils.skipCurrentTag(in);
8710 }
8711 }
8712 }
8713
8714 return intent;
8715 }
8716
Nick Pellyccae4122012-01-09 14:12:58 -08008717 /**
8718 * Normalize a MIME data type.
8719 *
8720 * <p>A normalized MIME type has white-space trimmed,
8721 * content-type parameters removed, and is lower-case.
8722 * This aligns the type with Android best practices for
8723 * intent filtering.
8724 *
8725 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8726 * "text/x-vCard" becomes "text/x-vcard".
8727 *
8728 * <p>All MIME types received from outside Android (such as user input,
8729 * or external sources like Bluetooth, NFC, or the Internet) should
8730 * be normalized before they are used to create an Intent.
8731 *
8732 * @param type MIME data type to normalize
8733 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008734 * @see #setType
8735 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008736 */
8737 public static String normalizeMimeType(String type) {
8738 if (type == null) {
8739 return null;
8740 }
8741
Elliott Hughescb64d432013-08-02 10:00:44 -07008742 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008743
8744 final int semicolonIndex = type.indexOf(';');
8745 if (semicolonIndex != -1) {
8746 type = type.substring(0, semicolonIndex);
8747 }
8748 return type;
8749 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008750
8751 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008752 * Prepare this {@link Intent} to leave an app process.
8753 *
8754 * @hide
8755 */
8756 public void prepareToLeaveProcess() {
8757 setAllowFds(false);
8758
8759 if (mSelector != null) {
8760 mSelector.prepareToLeaveProcess();
8761 }
8762 if (mClipData != null) {
8763 mClipData.prepareToLeaveProcess();
8764 }
8765
8766 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8767 // There are several ACTION_MEDIA_* broadcasts that send file://
8768 // Uris, so only check common actions.
8769 if (ACTION_VIEW.equals(mAction) ||
8770 ACTION_EDIT.equals(mAction) ||
8771 ACTION_ATTACH_DATA.equals(mAction)) {
8772 mData.checkFileUriExposed("Intent.getData()");
8773 }
8774 }
8775 }
8776
8777 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008778 * @hide
8779 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008780 public void prepareToEnterProcess() {
8781 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008782 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8783 fixUris(mContentUserHint);
8784 mContentUserHint = UserHandle.USER_CURRENT;
8785 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008786 }
8787 }
8788
8789 /**
8790 * @hide
8791 */
8792 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008793 Uri data = getData();
8794 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008795 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008796 }
8797 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008798 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008799 }
8800 String action = getAction();
8801 if (ACTION_SEND.equals(action)) {
8802 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8803 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008804 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008805 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008806 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008807 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8808 if (streams != null) {
8809 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8810 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008811 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008812 }
8813 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8814 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008815 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8816 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8817 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8818 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8819 if (output != null) {
8820 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8821 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008822 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008823 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008824
8825 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008826 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008827 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8828 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008829 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008830 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008831 * @hide
8832 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008833 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008834 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008835 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008836
8837 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008838 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008839
8840 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008841 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008842 // Inspect contained intents to see if we need to migrate extras. We
8843 // don't promote ClipData to the parent, since ChooserActivity will
8844 // already start the picked item as the caller, and we can't combine
8845 // the flags in a safe way.
8846
8847 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008848 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008849 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8850 if (intent != null) {
8851 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008852 }
8853 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008854 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008855 try {
8856 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8857 if (intents != null) {
8858 for (int i = 0; i < intents.length; i++) {
8859 final Intent intent = (Intent) intents[i];
8860 if (intent != null) {
8861 migrated |= intent.migrateExtraStreamToClipData();
8862 }
8863 }
8864 }
8865 } catch (ClassCastException e) {
8866 }
8867 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008868
8869 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008870 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008871 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8872 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8873 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8874 if (stream != null || text != null || htmlText != null) {
8875 final ClipData clipData = new ClipData(
8876 null, new String[] { getType() },
8877 new ClipData.Item(text, htmlText, null, stream));
8878 setClipData(clipData);
8879 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008880 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008881 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008882 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008883 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008884
8885 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008886 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008887 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8888 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8889 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8890 int num = -1;
8891 if (streams != null) {
8892 num = streams.size();
8893 }
8894 if (texts != null) {
8895 if (num >= 0 && num != texts.size()) {
8896 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008897 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008898 }
8899 num = texts.size();
8900 }
8901 if (htmlTexts != null) {
8902 if (num >= 0 && num != htmlTexts.size()) {
8903 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008904 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008905 }
8906 num = htmlTexts.size();
8907 }
8908 if (num > 0) {
8909 final ClipData clipData = new ClipData(
8910 null, new String[] { getType() },
8911 makeClipItem(streams, texts, htmlTexts, 0));
8912
8913 for (int i = 1; i < num; i++) {
8914 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8915 }
8916
8917 setClipData(clipData);
8918 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008919 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008920 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008921 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008922 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008923 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8924 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8925 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8926 final Uri output;
8927 try {
8928 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8929 } catch (ClassCastException e) {
8930 return false;
8931 }
8932 if (output != null) {
8933 setClipData(ClipData.newRawUri("", output));
8934 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8935 return true;
8936 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008937 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008938
8939 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008940 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008941
8942 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8943 ArrayList<String> htmlTexts, int which) {
8944 Uri uri = streams != null ? streams.get(which) : null;
8945 CharSequence text = texts != null ? texts.get(which) : null;
8946 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8947 return new ClipData.Item(text, htmlText, null, uri);
8948 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008949
8950 /** @hide */
8951 public boolean isDocument() {
8952 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8953 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008954}