blob: f70215b46a5e65c98ab3c5235de90c80550944d7 [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
Makoto Onuki7d1911f2017-06-09 12:30:09 -070019import static android.content.ContentProvider.maybeAddUserId;
20
Tor Norbye7b9c9122013-05-30 16:48:33 -070021import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070022import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.NonNull;
25import android.annotation.Nullable;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050030import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060031import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.content.pm.PackageManager;
33import android.content.pm.ResolveInfo;
34import android.content.res.Resources;
35import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080036import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060038import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.os.Bundle;
40import android.os.IBinder;
41import android.os.Parcel;
42import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000043import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050044import android.os.ResultReceiver;
45import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070046import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010047import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070048import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050053import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import android.util.AttributeSet;
55import android.util.Log;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070056
Dianne Hackborn2269d1572010-02-24 19:54:22 -080057import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070058
Jason Monk2f68e8a2016-02-23 17:57:28 -050059import org.xmlpull.v1.XmlPullParser;
60import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070061import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070062
63import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080064import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070066import java.lang.annotation.Retention;
67import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.net.URISyntaxException;
69import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080070import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070071import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080072import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070073import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074import java.util.Set;
75
76/**
77 * An intent is an abstract description of an operation to be performed. It
78 * can be used with {@link Context#startActivity(Intent) startActivity} to
79 * launch an {@link android.app.Activity},
80 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
81 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
82 * and {@link android.content.Context#startService} or
83 * {@link android.content.Context#bindService} to communicate with a
84 * background {@link android.app.Service}.
85 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070086 * <p>An Intent provides a facility for performing late runtime binding between the code in
87 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070088 * can be thought of as the glue between activities. It is basically a passive data structure
89 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070090 *
91 * <div class="special reference">
92 * <h3>Developer Guides</h3>
93 * <p>For information about how to create and resolve intents, read the
94 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
95 * developer guide.</p>
96 * </div>
97 *
98 * <a name="IntentStructure"></a>
99 * <h3>Intent Structure</h3>
100 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700101 *
102 * <ul>
103 * <li> <p><b>action</b> -- The general action to be performed, such as
104 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
105 * etc.</p>
106 * </li>
107 * <li> <p><b>data</b> -- The data to operate on, such as a person record
108 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
109 * </li>
110 * </ul>
111 *
112 *
113 * <p>Some examples of action/data pairs are:</p>
114 *
115 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700116 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700117 * information about the person whose identifier is "1".</p>
118 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700119 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700120 * the phone dialer with the person filled in.</p>
121 * </li>
122 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
123 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700124 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * a particular URI.</p>
126 * </li>
127 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
128 * the phone dialer with the given number filled in.</p>
129 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700130 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700131 * information about the person whose identifier is "1".</p>
132 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700133 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700134 * a list of people, which the user can browse through. This example is a
135 * typical top-level entry into the Contacts application, showing you the
136 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700137 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700138 * being used to start an activity to display that person.</p>
139 * </li>
140 * </ul>
141 *
142 * <p>In addition to these primary attributes, there are a number of secondary
143 * attributes that you can also include with an intent:</p>
144 *
145 * <ul>
146 * <li> <p><b>category</b> -- Gives additional information about the action
147 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
148 * appear in the Launcher as a top-level application, while
149 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
150 * of alternative actions the user can perform on a piece of data.</p>
151 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
152 * intent data. Normally the type is inferred from the data itself.
153 * By setting this attribute, you disable that evaluation and force
154 * an explicit type.</p>
155 * <li> <p><b>component</b> -- Specifies an explicit name of a component
156 * class to use for the intent. Normally this is determined by looking
157 * at the other information in the intent (the action, data/type, and
158 * categories) and matching that with a component that can handle it.
159 * If this attribute is set then none of the evaluation is performed,
160 * and this component is used exactly as is. By specifying this attribute,
161 * all of the other Intent attributes become optional.</p>
162 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
163 * This can be used to provide extended information to the component.
164 * For example, if we have a action to send an e-mail message, we could
165 * also include extra pieces of data here to supply a subject, body,
166 * etc.</p>
167 * </ul>
168 *
169 * <p>Here are some examples of other operations you can specify as intents
170 * using these additional parameters:</p>
171 *
172 * <ul>
173 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
174 * Launch the home screen.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
178 * vnd.android.cursor.item/phone}</i></b>
179 * -- Display the list of people's phone numbers, allowing the user to
180 * browse through them and pick one and return it to the parent activity.</p>
181 * </li>
182 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
183 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
184 * -- Display all pickers for data that can be opened with
185 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
186 * allowing the user to pick one of them and then some data inside of it
187 * and returning the resulting URI to the caller. This can be used,
188 * for example, in an e-mail application to allow the user to pick some
189 * data to include as an attachment.</p>
190 * </li>
191 * </ul>
192 *
193 * <p>There are a variety of standard Intent action and category constants
194 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700195 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700196 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700197 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700198 *
199 * <p>Put together, the set of actions, data types, categories, and extra data
200 * defines a language for the system allowing for the expression of phrases
201 * such as "call john smith's cell". As applications are added to the system,
202 * they can extend this language by adding new actions, types, and categories, or
203 * they can modify the behavior of existing phrases by supplying their own
204 * activities that handle them.</p>
205 *
206 * <a name="IntentResolution"></a>
207 * <h3>Intent Resolution</h3>
208 *
209 * <p>There are two primary forms of intents you will use.
210 *
211 * <ul>
212 * <li> <p><b>Explicit Intents</b> have specified a component (via
213 * {@link #setComponent} or {@link #setClass}), which provides the exact
214 * class to be run. Often these will not include any other information,
215 * simply being a way for an application to launch various internal
216 * activities it has as the user interacts with the application.
217 *
218 * <li> <p><b>Implicit Intents</b> have not specified a component;
219 * instead, they must include enough information for the system to
220 * determine which of the available components is best to run for that
221 * intent.
222 * </ul>
223 *
224 * <p>When using implicit intents, given such an arbitrary intent we need to
225 * know what to do with it. This is handled by the process of <em>Intent
226 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
227 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
228 * more activities/receivers) that can handle it.</p>
229 *
230 * <p>The intent resolution mechanism basically revolves around matching an
231 * Intent against all of the &lt;intent-filter&gt; descriptions in the
232 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
233 * objects explicitly registered with {@link Context#registerReceiver}.) More
234 * details on this can be found in the documentation on the {@link
235 * IntentFilter} class.</p>
236 *
237 * <p>There are three pieces of information in the Intent that are used for
238 * resolution: the action, type, and category. Using this information, a query
239 * is done on the {@link PackageManager} for a component that can handle the
240 * intent. The appropriate component is determined based on the intent
241 * information supplied in the <code>AndroidManifest.xml</code> file as
242 * follows:</p>
243 *
244 * <ul>
245 * <li> <p>The <b>action</b>, if given, must be listed by the component as
246 * one it handles.</p>
247 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
248 * already supplied in the Intent. Like the action, if a type is
249 * included in the intent (either explicitly or implicitly in its
250 * data), then this must be listed by the component as one it handles.</p>
251 * <li> For data that is not a <code>content:</code> URI and where no explicit
252 * type is included in the Intent, instead the <b>scheme</b> of the
253 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
254 * considered. Again like the action, if we are matching a scheme it
255 * must be listed by the component as one it can handle.
256 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
257 * by the activity as categories it handles. That is, if you include
258 * the categories {@link #CATEGORY_LAUNCHER} and
259 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
260 * with an intent that lists <em>both</em> of those categories.
261 * Activities will very often need to support the
262 * {@link #CATEGORY_DEFAULT} so that they can be found by
263 * {@link Context#startActivity Context.startActivity()}.</p>
264 * </ul>
265 *
266 * <p>For example, consider the Note Pad sample application that
267 * allows user to browse through a list of notes data and view details about
268 * individual items. Text in italics indicate places were you would replace a
269 * name with one specific to your own package.</p>
270 *
271 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
272 * package="<i>com.android.notepad</i>"&gt;
273 * &lt;application android:icon="@drawable/app_notes"
274 * android:label="@string/app_name"&gt;
275 *
276 * &lt;provider class=".NotePadProvider"
277 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
278 *
279 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
280 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.MAIN" /&gt;
282 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700285 * &lt;action android:name="android.intent.action.VIEW" /&gt;
286 * &lt;action android:name="android.intent.action.EDIT" /&gt;
287 * &lt;action android:name="android.intent.action.PICK" /&gt;
288 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
289 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700290 * &lt;/intent-filter&gt;
291 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700292 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
299 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700300 * &lt;action android:name="android.intent.action.VIEW" /&gt;
301 * &lt;action android:name="android.intent.action.EDIT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700307 * &lt;action android:name="android.intent.action.INSERT" /&gt;
308 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
309 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;
311 *
312 * &lt;/activity&gt;
313 *
314 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
315 * android:theme="@android:style/Theme.Dialog"&gt;
316 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
318 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
319 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
320 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
321 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;
323 * &lt;/activity&gt;
324 *
325 * &lt;/application&gt;
326 * &lt;/manifest&gt;</pre>
327 *
328 * <p>The first activity,
329 * <code>com.android.notepad.NotesList</code>, serves as our main
330 * entry into the app. It can do three things as described by its three intent
331 * templates:
332 * <ol>
333 * <li><pre>
334 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700335 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
336 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700337 * &lt;/intent-filter&gt;</pre>
338 * <p>This provides a top-level entry into the NotePad application: the standard
339 * MAIN action is a main entry point (not requiring any other information in
340 * the Intent), and the LAUNCHER category says that this entry point should be
341 * listed in the application launcher.</p>
342 * <li><pre>
343 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700344 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
345 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
346 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
347 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700348 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700349 * &lt;/intent-filter&gt;</pre>
350 * <p>This declares the things that the activity can do on a directory of
351 * notes. The type being supported is given with the &lt;type&gt; tag, where
352 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
353 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
354 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
355 * The activity allows the user to view or edit the directory of data (via
356 * the VIEW and EDIT actions), or to pick a particular note and return it
357 * to the caller (via the PICK action). Note also the DEFAULT category
358 * supplied here: this is <em>required</em> for the
359 * {@link Context#startActivity Context.startActivity} method to resolve your
360 * activity when its component name is not explicitly specified.</p>
361 * <li><pre>
362 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700363 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
364 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
365 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700366 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700367 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700368 * the user without needing to know where it came from. The data type
369 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
370 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
371 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
372 * The GET_CONTENT action is similar to the PICK action, where the activity
373 * will return to its caller a piece of data selected by the user. Here,
374 * however, the caller specifies the type of data they desire instead of
375 * the type of data the user will be picking from.</p>
376 * </ol>
377 *
378 * <p>Given these capabilities, the following intents will resolve to the
379 * NotesList activity:</p>
380 *
381 * <ul>
382 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
383 * activities that can be used as top-level entry points into an
384 * application.</p>
385 * <li> <p><b>{ action=android.app.action.MAIN,
386 * category=android.app.category.LAUNCHER }</b> is the actual intent
387 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700388 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * data=content://com.google.provider.NotePad/notes }</b>
390 * displays a list of all the notes under
391 * "content://com.google.provider.NotePad/notes", which
392 * the user can browse through and see the details on.</p>
393 * <li> <p><b>{ action=android.app.action.PICK
394 * data=content://com.google.provider.NotePad/notes }</b>
395 * provides a list of the notes under
396 * "content://com.google.provider.NotePad/notes", from which
397 * the user can pick a note whose data URL is returned back to the caller.</p>
398 * <li> <p><b>{ action=android.app.action.GET_CONTENT
399 * type=vnd.android.cursor.item/vnd.google.note }</b>
400 * is similar to the pick action, but allows the caller to specify the
401 * kind of data they want back so that the system can find the appropriate
402 * activity to pick something of that data type.</p>
403 * </ul>
404 *
405 * <p>The second activity,
406 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
407 * note entry and allows them to edit it. It can do two things as described
408 * by its two intent templates:
409 * <ol>
410 * <li><pre>
411 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700412 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
413 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
414 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
415 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700416 * &lt;/intent-filter&gt;</pre>
417 * <p>The first, primary, purpose of this activity is to let the user interact
418 * with a single note, as decribed by the MIME type
419 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
420 * either VIEW a note or allow the user to EDIT it. Again we support the
421 * DEFAULT category to allow the activity to be launched without explicitly
422 * specifying its component.</p>
423 * <li><pre>
424 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700425 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
426 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700428 * &lt;/intent-filter&gt;</pre>
429 * <p>The secondary use of this activity is to insert a new note entry into
430 * an existing directory of notes. This is used when the user creates a new
431 * note: the INSERT action is executed on the directory of notes, causing
432 * this activity to run and have the user create the new note data which
433 * it then adds to the content provider.</p>
434 * </ol>
435 *
436 * <p>Given these capabilities, the following intents will resolve to the
437 * NoteEditor activity:</p>
438 *
439 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700440 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
442 * shows the user the content of note <var>{ID}</var>.</p>
443 * <li> <p><b>{ action=android.app.action.EDIT
444 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
445 * allows the user to edit the content of note <var>{ID}</var>.</p>
446 * <li> <p><b>{ action=android.app.action.INSERT
447 * data=content://com.google.provider.NotePad/notes }</b>
448 * creates a new, empty note in the notes list at
449 * "content://com.google.provider.NotePad/notes"
450 * and allows the user to edit it. If they keep their changes, the URI
451 * of the newly created note is returned to the caller.</p>
452 * </ul>
453 *
454 * <p>The last activity,
455 * <code>com.android.notepad.TitleEditor</code>, allows the user to
456 * edit the title of a note. This could be implemented as a class that the
457 * application directly invokes (by explicitly setting its component in
458 * the Intent), but here we show a way you can publish alternative
459 * operations on existing data:</p>
460 *
461 * <pre>
462 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700463 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
464 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
465 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
466 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
467 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700468 * &lt;/intent-filter&gt;</pre>
469 *
470 * <p>In the single intent template here, we
471 * have created our own private action called
472 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
473 * edit the title of a note. It must be invoked on a specific note
474 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
475 * view and edit actions, but here displays and edits the title contained
476 * in the note data.
477 *
478 * <p>In addition to supporting the default category as usual, our title editor
479 * also supports two other standard categories: ALTERNATIVE and
480 * SELECTED_ALTERNATIVE. Implementing
481 * these categories allows others to find the special action it provides
482 * without directly knowing about it, through the
483 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
484 * more often to build dynamic menu items with
485 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
486 * template here was also supply an explicit name for the template
487 * (via <code>android:label="@string/resolve_title"</code>) to better control
488 * what the user sees when presented with this activity as an alternative
489 * action to the data they are viewing.
490 *
491 * <p>Given these capabilities, the following intent will resolve to the
492 * TitleEditor activity:</p>
493 *
494 * <ul>
495 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
496 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
497 * displays and allows the user to edit the title associated
498 * with note <var>{ID}</var>.</p>
499 * </ul>
500 *
501 * <h3>Standard Activity Actions</h3>
502 *
503 * <p>These are the current standard actions that Intent defines for launching
504 * activities (usually through {@link Context#startActivity}. The most
505 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
506 * {@link #ACTION_EDIT}.
507 *
508 * <ul>
509 * <li> {@link #ACTION_MAIN}
510 * <li> {@link #ACTION_VIEW}
511 * <li> {@link #ACTION_ATTACH_DATA}
512 * <li> {@link #ACTION_EDIT}
513 * <li> {@link #ACTION_PICK}
514 * <li> {@link #ACTION_CHOOSER}
515 * <li> {@link #ACTION_GET_CONTENT}
516 * <li> {@link #ACTION_DIAL}
517 * <li> {@link #ACTION_CALL}
518 * <li> {@link #ACTION_SEND}
519 * <li> {@link #ACTION_SENDTO}
520 * <li> {@link #ACTION_ANSWER}
521 * <li> {@link #ACTION_INSERT}
522 * <li> {@link #ACTION_DELETE}
523 * <li> {@link #ACTION_RUN}
524 * <li> {@link #ACTION_SYNC}
525 * <li> {@link #ACTION_PICK_ACTIVITY}
526 * <li> {@link #ACTION_SEARCH}
527 * <li> {@link #ACTION_WEB_SEARCH}
528 * <li> {@link #ACTION_FACTORY_TEST}
529 * </ul>
530 *
531 * <h3>Standard Broadcast Actions</h3>
532 *
533 * <p>These are the current standard actions that Intent defines for receiving
534 * broadcasts (usually through {@link Context#registerReceiver} or a
535 * &lt;receiver&gt; tag in a manifest).
536 *
537 * <ul>
538 * <li> {@link #ACTION_TIME_TICK}
539 * <li> {@link #ACTION_TIME_CHANGED}
540 * <li> {@link #ACTION_TIMEZONE_CHANGED}
541 * <li> {@link #ACTION_BOOT_COMPLETED}
542 * <li> {@link #ACTION_PACKAGE_ADDED}
543 * <li> {@link #ACTION_PACKAGE_CHANGED}
544 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800545 * <li> {@link #ACTION_PACKAGE_RESTARTED}
546 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000547 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
548 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * <li> {@link #ACTION_UID_REMOVED}
550 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700551 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700552 * <li> {@link #ACTION_POWER_DISCONNECTED}
553 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700554 * </ul>
555 *
556 * <h3>Standard Categories</h3>
557 *
558 * <p>These are the current standard categories that can be used to further
559 * clarify an Intent via {@link #addCategory}.
560 *
561 * <ul>
562 * <li> {@link #CATEGORY_DEFAULT}
563 * <li> {@link #CATEGORY_BROWSABLE}
564 * <li> {@link #CATEGORY_TAB}
565 * <li> {@link #CATEGORY_ALTERNATIVE}
566 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
567 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800568 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * <li> {@link #CATEGORY_HOME}
570 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400572 * <li> {@link #CATEGORY_CAR_DOCK}
573 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500574 * <li> {@link #CATEGORY_LE_DESK_DOCK}
575 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200576 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700577 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800578 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * </ul>
580 *
581 * <h3>Standard Extra Data</h3>
582 *
583 * <p>These are the current standard fields that can be used as extra data via
584 * {@link #putExtra}.
585 *
586 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_ALARM_COUNT}
588 * <li> {@link #EXTRA_BCC}
589 * <li> {@link #EXTRA_CC}
590 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
591 * <li> {@link #EXTRA_DATA_REMOVED}
592 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500593 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
594 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_DOCK_STATE_CAR}
596 * <li> {@link #EXTRA_DOCK_STATE_DESK}
597 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
598 * <li> {@link #EXTRA_DONT_KILL_APP}
599 * <li> {@link #EXTRA_EMAIL}
600 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700601 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800602 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700603 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700605 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
607 * <li> {@link #EXTRA_REPLACING}
608 * <li> {@link #EXTRA_SHORTCUT_ICON}
609 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
610 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800612 * <li> {@link #EXTRA_SHORTCUT_NAME}
613 * <li> {@link #EXTRA_SUBJECT}
614 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800616 * <li> {@link #EXTRA_TITLE}
617 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 * </ul>
619 *
620 * <h3>Flags</h3>
621 *
622 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
624 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800626public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700627 private static final String ATTR_ACTION = "action";
628 private static final String TAG_CATEGORIES = "categories";
629 private static final String ATTR_CATEGORY = "category";
630 private static final String TAG_EXTRA = "extra";
631 private static final String ATTR_TYPE = "type";
632 private static final String ATTR_COMPONENT = "component";
633 private static final String ATTR_DATA = "data";
634 private static final String ATTR_FLAGS = "flags";
635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700636 // ---------------------------------------------------------------------
637 // ---------------------------------------------------------------------
638 // Standard intent activity actions (see action variable).
639
640 /**
641 * Activity Action: Start as a main entry point, does not expect to
642 * receive data.
643 * <p>Input: nothing
644 * <p>Output: nothing
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Display the data to the user. This is the most common
651 * action performed on data -- it is the generic action you can use on
652 * a piece of data to get the most reasonable thing to occur. For example,
653 * when used on a contacts entry it will view the entry; when used on a
654 * mailto: URI it will bring up a compose window filled with the information
655 * supplied by the URI; when used with a tel: URI it will invoke the
656 * dialer.
657 * <p>Input: {@link #getData} is URI from which to retrieve data.
658 * <p>Output: nothing.
659 */
660 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
661 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700664 * Extra that can be included on activity intents coming from the storage UI
665 * when it launches sub-activities to manage various types of storage. For example,
666 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
667 * the images on the device, and in that case also include this extra to tell the
668 * app it is coming from the storage UI so should help the user manage storage of
669 * this type.
670 */
671 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
672
673 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700674 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
675 * performed on a piece of data.
676 */
677 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800678
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900680 * Activity Action: Quick view the data. Launches a quick viewer for
681 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900682 * <p>Activities handling this intent action should handle the vast majority of
683 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700684 * <p>Quick viewers must render the quick view image locally, and must not send
685 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900686 * <p>Input: {@link #getData} is a mandatory content URI of the item to
687 * preview. {@link #getClipData} contains an optional list of content URIs
688 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
689 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700690 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
691 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700692 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900693 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700694 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700695 */
696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
697 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
698
699 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700700 * Used to indicate that some piece of data should be attached to some other
701 * place. For example, image data could be attached to a contact. It is up
702 * to the recipient to decide where the data should be attached; the intent
703 * does not specify the ultimate destination.
704 * <p>Input: {@link #getData} is URI of data to be attached.
705 * <p>Output: nothing.
706 */
707 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
708 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700710 /**
711 * Activity Action: Provide explicit editable access to the given data.
712 * <p>Input: {@link #getData} is URI of data to be edited.
713 * <p>Output: nothing.
714 */
715 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
716 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 /**
719 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
720 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
721 * The extras can contain type specific data to pass through to the editing/creating
722 * activity.
723 * <p>Output: The URI of the item that was picked. This must be a content:
724 * URI so that any receiver can access it.
725 */
726 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
727 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800728
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700729 /**
730 * Activity Action: Pick an item from the data, returning what was selected.
731 * <p>Input: {@link #getData} is URI containing a directory of data
732 * (vnd.android.cursor.dir/*) from which to pick an item.
733 * <p>Output: The URI of the item that was picked.
734 */
735 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
736 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700738 /**
739 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800740 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800741 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
742 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700743 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
744 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800745 * (value: ShortcutIconResource).</p>
746 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800747 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 * @see #EXTRA_SHORTCUT_INTENT
749 * @see #EXTRA_SHORTCUT_NAME
750 * @see #EXTRA_SHORTCUT_ICON
751 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
752 * @see android.content.Intent.ShortcutIconResource
753 */
754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
755 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
756
757 /**
758 * The name of the extra used to define the Intent of a shortcut.
759 *
760 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800761 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700762 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
765 /**
766 * The name of the extra used to define the name of a shortcut.
767 *
768 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800769 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700770 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800771 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700772 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
773 /**
774 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
775 *
776 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800777 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700778 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800779 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700780 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
781 /**
782 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
783 *
784 * @see #ACTION_CREATE_SHORTCUT
785 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800786 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800788 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700789 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
790 "android.intent.extra.shortcut.ICON_RESOURCE";
791
792 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500793 * An activity that provides a user interface for adjusting application preferences.
794 * Optional but recommended settings for all applications which have settings.
795 */
796 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
797 public static final String ACTION_APPLICATION_PREFERENCES
798 = "android.intent.action.APPLICATION_PREFERENCES";
799
800 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700801 * Activity Action: Launch an activity showing the app information.
802 * For applications which install other applications (such as app stores), it is recommended
803 * to handle this action for providing the app information to the user.
804 *
805 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
806 * to be displayed.
807 * <p>Output: Nothing.
808 */
809 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
810 public static final String ACTION_SHOW_APP_INFO
811 = "android.intent.action.SHOW_APP_INFO";
812
813 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800814 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700815 *
816 * @see Intent#ACTION_CREATE_SHORTCUT
817 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800818 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
819 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 */
821 public static class ShortcutIconResource implements Parcelable {
822 /**
823 * The package name of the application containing the icon.
824 */
825 public String packageName;
826
827 /**
828 * The resource name of the icon, including package, name and type.
829 */
830 public String resourceName;
831
832 /**
833 * Creates a new ShortcutIconResource for the specified context and resource
834 * identifier.
835 *
836 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700837 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700838 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700839 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700841 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700842 ShortcutIconResource icon = new ShortcutIconResource();
843 icon.packageName = context.getPackageName();
844 icon.resourceName = context.getResources().getResourceName(resourceId);
845 return icon;
846 }
847
848 /**
849 * Used to read a ShortcutIconResource from a Parcel.
850 */
851 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
852 new Parcelable.Creator<ShortcutIconResource>() {
853
854 public ShortcutIconResource createFromParcel(Parcel source) {
855 ShortcutIconResource icon = new ShortcutIconResource();
856 icon.packageName = source.readString();
857 icon.resourceName = source.readString();
858 return icon;
859 }
860
861 public ShortcutIconResource[] newArray(int size) {
862 return new ShortcutIconResource[size];
863 }
864 };
865
866 /**
867 * No special parcel contents.
868 */
869 public int describeContents() {
870 return 0;
871 }
872
873 public void writeToParcel(Parcel dest, int flags) {
874 dest.writeString(packageName);
875 dest.writeString(resourceName);
876 }
877
878 @Override
879 public String toString() {
880 return resourceName;
881 }
882 }
883
884 /**
885 * Activity Action: Display an activity chooser, allowing the user to pick
886 * what they want to before proceeding. This can be used as an alternative
887 * to the standard activity picker that is displayed by the system when
888 * you try to start an activity with multiple possible matches, with these
889 * differences in behavior:
890 * <ul>
891 * <li>You can specify the title that will appear in the activity chooser.
892 * <li>The user does not have the option to make one of the matching
893 * activities a preferred activity, and all possible activities will
894 * always be shown even if one of them is currently marked as the
895 * preferred activity.
896 * </ul>
897 * <p>
898 * This action should be used when the user will naturally expect to
899 * select an activity in order to proceed. An example if when not to use
900 * it is when the user clicks on a "mailto:" link. They would naturally
901 * expect to go directly to their mail app, so startActivity() should be
902 * called directly: it will
903 * either launch the current preferred app, or put up a dialog allowing the
904 * user to pick an app to use and optionally marking that as preferred.
905 * <p>
906 * In contrast, if the user is selecting a menu item to send a picture
907 * they are viewing to someone else, there are many different things they
908 * may want to do at this point: send it through e-mail, upload it to a
909 * web service, etc. In this case the CHOOSER action should be used, to
910 * always present to the user a list of the things they can do, with a
911 * nice title given by the caller such as "Send this photo with:".
912 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700913 * If you need to grant URI permissions through a chooser, you must specify
914 * the permissions to be granted on the ACTION_CHOOSER Intent
915 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
916 * {@link #setClipData} to specify the URIs to be granted as well as
917 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
918 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * As a convenience, an Intent of this form can be created with the
921 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700922 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700923 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700924 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
925 * and can optionally have a {@link #EXTRA_TITLE} field containing the
926 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927 * <p>
928 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
932
933 /**
934 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
935 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700936 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
937 * target intent, also optionally supplying a title. If the target
938 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
939 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
940 * set in the returned chooser intent, with its ClipData set appropriately:
941 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500942 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700943 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700944 * @param target The Intent that the user will be selecting an activity
945 * to perform.
946 * @param title Optional title that will be displayed in the chooser.
947 * @return Return a new Intent object that you can hand to
948 * {@link Context#startActivity(Intent) Context.startActivity()} and
949 * related methods.
950 */
951 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700952 return createChooser(target, title, null);
953 }
954
955 /**
956 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
957 *
958 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
959 * target intent, also optionally supplying a title. If the target
960 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
961 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
962 * set in the returned chooser intent, with its ClipData set appropriately:
963 * either a direct reflection of {@link #getClipData()} if that is non-null,
964 * or a new ClipData built from {@link #getData()}.</p>
965 *
966 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
967 * when the user makes a choice. This can be useful if the calling application wants
968 * to remember the last chosen target and surface it as a more prominent or one-touch
969 * affordance elsewhere in the UI for next time.</p>
970 *
971 * @param target The Intent that the user will be selecting an activity
972 * to perform.
973 * @param title Optional title that will be displayed in the chooser.
974 * @param sender Optional IntentSender to be called when a choice is made.
975 * @return Return a new Intent object that you can hand to
976 * {@link Context#startActivity(Intent) Context.startActivity()} and
977 * related methods.
978 */
979 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700980 Intent intent = new Intent(ACTION_CHOOSER);
981 intent.putExtra(EXTRA_INTENT, target);
982 if (title != null) {
983 intent.putExtra(EXTRA_TITLE, title);
984 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700985
Adam Powell0b3c1122014-10-09 12:50:14 -0700986 if (sender != null) {
987 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
988 }
989
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700990 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700991 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
992 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
993 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700994 if (permFlags != 0) {
995 ClipData targetClipData = target.getClipData();
996 if (targetClipData == null && target.getData() != null) {
997 ClipData.Item item = new ClipData.Item(target.getData());
998 String[] mimeTypes;
999 if (target.getType() != null) {
1000 mimeTypes = new String[] { target.getType() };
1001 } else {
1002 mimeTypes = new String[] { };
1003 }
1004 targetClipData = new ClipData(null, mimeTypes, item);
1005 }
1006 if (targetClipData != null) {
1007 intent.setClipData(targetClipData);
1008 intent.addFlags(permFlags);
1009 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001010 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001011
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001012 return intent;
1013 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001014
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001015 /**
1016 * Activity Action: Allow the user to select a particular kind of data and
1017 * return it. This is different than {@link #ACTION_PICK} in that here we
1018 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001019 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001021 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001022 * etc.
1023 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001024 * 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 -07001025 * of data, such as a person contact, you set the MIME type to the kind of
1026 * data you want and launch it with {@link Context#startActivity(Intent)}.
1027 * The system will then launch the best application to select that kind
1028 * of data for you.
1029 * <p>
1030 * You may also be interested in any of a set of types of content the user
1031 * can pick. For example, an e-mail application that wants to allow the
1032 * user to add an attachment to an e-mail message can use this action to
1033 * bring up a list of all of the types of content the user can attach.
1034 * <p>
1035 * In this case, you should wrap the GET_CONTENT intent with a chooser
1036 * (through {@link #createChooser}), which will give the proper interface
1037 * for the user to pick how to send your data and allow you to specify
1038 * a prompt indicating what they are doing. You will usually specify a
1039 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1040 * broad range of content types the user can select from.
1041 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001042 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001043 * only pick from data that can be represented as a stream. This is
1044 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1045 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001046 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001047 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001048 * is locally available on the device. For example, if this extra is set
1049 * to true then an image picker should not show any pictures that are available
1050 * from a remote server but not already on the local device (thus requiring
1051 * they be downloaded when opened).
1052 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001053 * If the caller can handle multiple returned items (the user performing
1054 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1055 * to indicate this.
1056 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001057 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1058 * that no URI is supplied in the intent, as there are no constraints on
1059 * where the returned data originally comes from. You may also include the
1060 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001061 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001062 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1063 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001064 * <p>
1065 * Output: The URI of the item that was picked. This must be a content:
1066 * URI so that any receiver can access it.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1070 /**
1071 * Activity Action: Dial a number as specified by the data. This shows a
1072 * UI with the number being dialed, allowing the user to explicitly
1073 * initiate the call.
1074 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1075 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1076 * number.
1077 * <p>Output: nothing.
1078 */
1079 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1080 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1081 /**
1082 * Activity Action: Perform a call to someone specified by the data.
1083 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1084 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1085 * number.
1086 * <p>Output: nothing.
1087 *
1088 * <p>Note: there will be restrictions on which applications can initiate a
1089 * call; most applications should use the {@link #ACTION_DIAL}.
1090 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1091 * numbers. Applications can <strong>dial</strong> emergency numbers using
1092 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001093 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001094 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001095 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001096 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001097 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_CALL = "android.intent.action.CALL";
1101 /**
1102 * Activity Action: Perform a call to an emergency number specified by the
1103 * data.
1104 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1105 * tel: URI of an explicit phone number.
1106 * <p>Output: nothing.
1107 * @hide
1108 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001109 @SystemApi
1110 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001111 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1112 /**
1113 * Activity action: Perform a call to any number (emergency or not)
1114 * specified by the data.
1115 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1116 * tel: URI of an explicit phone number.
1117 * <p>Output: nothing.
1118 * @hide
1119 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001120 @SystemApi
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001122 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001123
Santos Cordon15a13782015-03-31 18:32:31 -07001124 /**
fionaxuadfe7002017-02-17 17:20:46 -08001125 * Activity Action: Main entry point for carrier setup apps.
1126 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1127 * carrier service and typically require
1128 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1129 * fulfill their duties.
1130 */
1131 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1132 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1133 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001134 * Activity Action: Send a message to someone specified by the data.
1135 * <p>Input: {@link #getData} is URI describing the target.
1136 * <p>Output: nothing.
1137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1140 /**
1141 * Activity Action: Deliver some data to someone else. Who the data is
1142 * being delivered to is not specified; it is up to the receiver of this
1143 * action to ask the user where the data should be sent.
1144 * <p>
1145 * When launching a SEND intent, you should usually wrap it in a chooser
1146 * (through {@link #createChooser}), which will give the proper interface
1147 * for the user to pick how to send your data and allow you to specify
1148 * a prompt indicating what they are doing.
1149 * <p>
1150 * Input: {@link #getType} is the MIME type of the data being sent.
1151 * get*Extra can have either a {@link #EXTRA_TEXT}
1152 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1153 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1154 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1155 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001156 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1157 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1158 * your text with HTML formatting.
1159 * <p>
1160 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1161 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1162 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1163 * content: URIs and other advanced features of {@link ClipData}. If
1164 * using this approach, you still must supply the same data through the
1165 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1166 * for compatibility with old applications. If you don't set a ClipData,
1167 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001168 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001169 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1170 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1171 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1172 * be openable only as asset typed files using
1173 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1174 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001175 * Optional standard extras, which may be interpreted by some recipients as
1176 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1177 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1178 * <p>
1179 * Output: nothing.
1180 */
1181 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1182 public static final String ACTION_SEND = "android.intent.action.SEND";
1183 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001184 * Activity Action: Deliver multiple data to someone else.
1185 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001186 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001187 * <p>
1188 * Input: {@link #getType} is the MIME type of the data being sent.
1189 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001190 * #EXTRA_STREAM} field, containing the data to be sent. If using
1191 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1192 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001193 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001194 * Multiple types are supported, and receivers should handle mixed types
1195 * whenever possible. The right way for the receiver to check them is to
1196 * use the content resolver on each URI. The intent sender should try to
1197 * put the most concrete mime type in the intent type, but it can fall
1198 * back to {@literal <type>/*} or {@literal *}/* as needed.
1199 * <p>
1200 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1201 * be image/jpg, but if you are sending image/jpg and image/png, then the
1202 * intent's type should be image/*.
1203 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001204 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1205 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1206 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1207 * content: URIs and other advanced features of {@link ClipData}. If
1208 * using this approach, you still must supply the same data through the
1209 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1210 * for compatibility with old applications. If you don't set a ClipData,
1211 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1212 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001213 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1214 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1215 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1216 * be openable only as asset typed files using
1217 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1218 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001219 * Optional standard extras, which may be interpreted by some recipients as
1220 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1221 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1222 * <p>
1223 * Output: nothing.
1224 */
1225 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1226 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1227 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001228 * Activity Action: Handle an incoming phone call.
1229 * <p>Input: nothing.
1230 * <p>Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1234 /**
1235 * Activity Action: Insert an empty item into the given container.
1236 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1237 * in which to place the data.
1238 * <p>Output: URI of the new data that was created.
1239 */
1240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1241 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1242 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001243 * Activity Action: Create a new item in the given container, initializing it
1244 * from the current contents of the clipboard.
1245 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1246 * in which to place the data.
1247 * <p>Output: URI of the new data that was created.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1251 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001252 * Activity Action: Delete the given data from its container.
1253 * <p>Input: {@link #getData} is URI of data to be deleted.
1254 * <p>Output: nothing.
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1258 /**
1259 * Activity Action: Run the data, whatever that means.
1260 * <p>Input: ? (Note: this is currently specific to the test harness.)
1261 * <p>Output: nothing.
1262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_RUN = "android.intent.action.RUN";
1265 /**
1266 * Activity Action: Perform a data synchronization.
1267 * <p>Input: ?
1268 * <p>Output: ?
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1272 /**
1273 * Activity Action: Pick an activity given an intent, returning the class
1274 * selected.
1275 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1276 * used with {@link PackageManager#queryIntentActivities} to determine the
1277 * set of activities from which to pick.
1278 * <p>Output: Class name of the activity that was selected.
1279 */
1280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1281 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1282 /**
1283 * Activity Action: Perform a search.
1284 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1285 * is the text to search for. If empty, simply
1286 * enter your search results Activity with the search UI activated.
1287 * <p>Output: nothing.
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1291 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001292 * Activity Action: Start the platform-defined tutorial
1293 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1294 * is the text to search for. If empty, simply
1295 * enter your search results Activity with the search UI activated.
1296 * <p>Output: nothing.
1297 */
1298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1299 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1300 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001301 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001302 * <p>
1303 * Input: {@link android.app.SearchManager#QUERY
1304 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1305 * a url starts with http or https, the site will be opened. If it is plain
1306 * text, Google search will be applied.
1307 * <p>
1308 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001313 /**
Jim Miller07994402012-05-02 14:22:27 -07001314 * Activity Action: Perform assist action.
1315 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001316 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1317 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001318 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1319 * information.
Jim Miller07994402012-05-02 14:22:27 -07001320 * Output: nothing.
1321 */
1322 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1323 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001324
1325 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001326 * Activity Action: Perform voice assist action.
1327 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001328 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1329 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001330 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001331 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001332 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001333 */
Amith Yamasani16452032017-03-03 10:15:57 -08001334 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001335 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1336 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1337
1338 /**
Adam Skory7140a252013-09-11 12:04:58 +01001339 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1340 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001341 */
1342 public static final String EXTRA_ASSIST_PACKAGE
1343 = "android.intent.extra.ASSIST_PACKAGE";
1344
1345 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001346 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1347 * application package at the time the assist was invoked.
1348 */
1349 public static final String EXTRA_ASSIST_UID
1350 = "android.intent.extra.ASSIST_UID";
1351
1352 /**
Adam Skory7140a252013-09-11 12:04:58 +01001353 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1354 * information supplied by the current foreground app at the time of the assist request.
1355 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001356 */
1357 public static final String EXTRA_ASSIST_CONTEXT
1358 = "android.intent.extra.ASSIST_CONTEXT";
1359
Jim Miller07994402012-05-02 14:22:27 -07001360 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001361 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1362 * keyboard as the primary input device for assistance.
1363 */
1364 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1365 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1366
1367 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001368 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1369 * that was used to invoke the assist.
1370 */
1371 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1372 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1373
1374 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001375 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001376 * <p>Input: Nothing.
1377 * <p>Output: nothing.
1378 */
1379 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1380 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1381 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001382 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001383 * <p>Input: Nothing.
1384 * <p>Output: Nothing.
1385 */
1386 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1387 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1388
1389 /**
1390 * Activity Action: Show activity for reporting a bug.
1391 * <p>Input: Nothing.
1392 * <p>Output: Nothing.
1393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1396
1397 /**
1398 * Activity Action: Main entry point for factory tests. Only used when
1399 * the device is booting in factory test node. The implementing package
1400 * must be installed in the system image.
1401 * <p>Input: nothing
1402 * <p>Output: nothing
1403 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001404 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001405 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1406
1407 /**
1408 * Activity Action: The user pressed the "call" button to go to the dialer
1409 * or other appropriate UI for placing a call.
1410 * <p>Input: Nothing.
1411 * <p>Output: Nothing.
1412 */
1413 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1414 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1415
1416 /**
1417 * Activity Action: Start Voice Command.
1418 * <p>Input: Nothing.
1419 * <p>Output: Nothing.
1420 */
1421 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1422 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001423
1424 /**
1425 * Activity Action: Start action associated with long pressing on the
1426 * search key.
1427 * <p>Input: Nothing.
1428 * <p>Output: Nothing.
1429 */
1430 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1431 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001432
Jacek Surazski86b6c532009-05-13 14:38:28 +02001433 /**
1434 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1435 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001436 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001437 * <p>Input: No data is specified. The bug report is passed in using
1438 * an {@link #EXTRA_BUG_REPORT} field.
1439 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001440 *
1441 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001442 */
1443 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1444 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001445
1446 /**
1447 * Activity Action: Show power usage information to the user.
1448 * <p>Input: Nothing.
1449 * <p>Output: Nothing.
1450 */
1451 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1452 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001453
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001454 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001455 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1456 * to run.
1457 * <p>Input: Nothing.
1458 * <p>Output: Nothing.
1459 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1460 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1461 * @hide
1462 */
1463 @Deprecated
1464 @SystemApi
1465 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1466 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1467
1468 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001469 * Activity Action: Setup wizard to launch after a platform update. This
1470 * activity should have a string meta-data field associated with it,
1471 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1472 * the platform for setup. The activity will be launched only if
1473 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1474 * same value.
1475 * <p>Input: Nothing.
1476 * <p>Output: Nothing.
1477 * @hide
1478 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001479 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001480 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1481 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001482
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001483 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001484 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1485 * <p>Input: Nothing.
1486 * <p>Output: Nothing.
1487 * @hide
1488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001491 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001492
1493 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001494 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1495 * <p>Input: Nothing.
1496 * <p>Output: Nothing.
1497 * @hide
1498 */
1499 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1500 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001501 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001502
1503 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001504 * Activity Action: Show settings for managing network data usage of a
1505 * specific application. Applications should define an activity that offers
1506 * options to control data usage.
1507 */
1508 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1509 public static final String ACTION_MANAGE_NETWORK_USAGE =
1510 "android.intent.action.MANAGE_NETWORK_USAGE";
1511
1512 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001513 * Activity Action: Launch application installer.
1514 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001515 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001516 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1517 * you can also use "package:<package-name>" to install an application for the
1518 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001519 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1520 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1521 * <p>
1522 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1523 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001524 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001525 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001526 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1527 * in order to launch the application installer.
1528 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001529 *
1530 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1531 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1532 * @see #EXTRA_RETURN_RESULT
1533 */
1534 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1535 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1536
1537 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001538 * @hide
1539 * @deprecated Do not use. This will go away.
1540 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1541 */
1542 @SystemApi
1543 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1544 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1545 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1546 /**
1547 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001548 * <p class="note">
1549 * This is a protected intent that can only be sent by the system.
1550 * </p>
1551 *
1552 * @hide
1553 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001554 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001555 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001556 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1557 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001558
1559 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001560 * @hide
1561 * @deprecated Do not use. This will go away.
1562 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1563 */
1564 @SystemApi
1565 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1566 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1567 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1568 /**
1569 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001570 * <p>
1571 * The system will have a persistent connection to this service.
1572 * This is a protected intent that can only be sent by the system.
1573 * </p>
1574 *
1575 * @hide
1576 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001577 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001578 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001579 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1580 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001581
1582 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001583 * @hide
1584 * @deprecated Do not use. This will go away.
1585 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1586 */
1587 @SystemApi
1588 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1589 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1590 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1591 /**
1592 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001593 *
1594 * <p class="note">
1595 * This is a protected intent that can only be sent by the system.
1596 * </p>
1597 *
1598 * @hide
1599 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001600 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001601 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001602 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1603 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001604
1605 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001606 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1607 * package. Specifies the installer package name; this package will receive the
1608 * {@link #ACTION_APP_ERROR} intent.
1609 */
1610 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1611 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1612
1613 /**
1614 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1615 * package. Specifies that the application being installed should not be
1616 * treated as coming from an unknown source, but as coming from the app
1617 * invoking the Intent. For this to work you must start the installer with
1618 * startActivityForResult().
1619 */
1620 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1621 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1622
1623 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001624 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1625 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001626 * data field originated from.
1627 */
rich cannings706e8ba2012-08-20 13:20:14 -07001628 public static final String EXTRA_ORIGINATING_URI
1629 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001630
1631 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001632 * This extra can be used with any Intent used to launch an activity, supplying information
1633 * about who is launching that activity. This field contains a {@link android.net.Uri}
1634 * object, typically an http: or https: URI of the web site that the referral came from;
1635 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1636 * a native application that it came from.
1637 *
1638 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1639 * instead of directly retrieving the extra. It is also valid for applications to
1640 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1641 * a string, not a Uri; the field here, if supplied, will always take precedence,
1642 * however.</p>
1643 *
1644 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001645 */
1646 public static final String EXTRA_REFERRER
1647 = "android.intent.extra.REFERRER";
1648
1649 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001650 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1651 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1652 * not be created, in particular when Intent extras are supplied through the
1653 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1654 * schemes.
1655 *
1656 * @see #EXTRA_REFERRER
1657 */
1658 public static final String EXTRA_REFERRER_NAME
1659 = "android.intent.extra.REFERRER_NAME";
1660
1661 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001662 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001663 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001664 * Currently only a system app that hosts the provider authority "downloads" or holds the
1665 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001666 * @hide
1667 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001668 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001669 public static final String EXTRA_ORIGINATING_UID
1670 = "android.intent.extra.ORIGINATING_UID";
1671
1672 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001673 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1674 * package. Tells the installer UI to skip the confirmation with the user
1675 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001676 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1677 * will no longer show an interstitial message about updating existing
1678 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001679 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001680 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001681 public static final String EXTRA_ALLOW_REPLACE
1682 = "android.intent.extra.ALLOW_REPLACE";
1683
1684 /**
1685 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1686 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1687 * return to the application the result code of the install/uninstall. The returned result
1688 * code will be {@link android.app.Activity#RESULT_OK} on success or
1689 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1690 */
1691 public static final String EXTRA_RETURN_RESULT
1692 = "android.intent.extra.RETURN_RESULT";
1693
1694 /**
1695 * Package manager install result code. @hide because result codes are not
1696 * yet ready to be exposed.
1697 */
1698 public static final String EXTRA_INSTALL_RESULT
1699 = "android.intent.extra.INSTALL_RESULT";
1700
1701 /**
1702 * Activity Action: Launch application uninstaller.
1703 * <p>
1704 * Input: The data must be a package: URI whose scheme specific part is
1705 * the package name of the current installed package to be uninstalled.
1706 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1707 * <p>
1708 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1709 * succeeded.
1710 */
1711 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1712 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1713
1714 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001715 * Specify whether the package should be uninstalled for all users.
1716 * @hide because these should not be part of normal application flow.
1717 */
1718 public static final String EXTRA_UNINSTALL_ALL_USERS
1719 = "android.intent.extra.UNINSTALL_ALL_USERS";
1720
1721 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001722 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1723 * describing the last run version of the platform that was setup.
1724 * @hide
1725 */
1726 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1727
Svet Ganov3695b8a2015-03-24 16:30:25 -07001728 /**
1729 * Activity action: Launch UI to manage the permissions of an app.
1730 * <p>
1731 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1732 * will be managed by the launched UI.
1733 * </p>
1734 * <p>
1735 * Output: Nothing.
1736 * </p>
1737 *
1738 * @see #EXTRA_PACKAGE_NAME
1739 *
1740 * @hide
1741 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001742 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001743 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1744 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1745 "android.intent.action.MANAGE_APP_PERMISSIONS";
1746
1747 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001748 * Activity action: Launch UI to manage permissions.
1749 * <p>
1750 * Input: Nothing.
1751 * </p>
1752 * <p>
1753 * Output: Nothing.
1754 * </p>
1755 *
1756 * @hide
1757 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001758 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001759 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1760 public static final String ACTION_MANAGE_PERMISSIONS =
1761 "android.intent.action.MANAGE_PERMISSIONS";
1762
1763 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001764 * Activity action: Launch UI to review permissions for an app.
1765 * The system uses this intent if permission review for apps not
1766 * supporting the new runtime permissions model is enabled. In
1767 * this mode a permission review is required before any of the
1768 * app components can run.
1769 * <p>
1770 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1771 * permissions will be reviewed (mandatory).
1772 * </p>
1773 * <p>
1774 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1775 * be fired after the permission review (optional).
1776 * </p>
1777 * <p>
1778 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1779 * be invoked after the permission review (optional).
1780 * </p>
1781 * <p>
1782 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1783 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1784 * </p>
1785 * <p>
1786 * Output: Nothing.
1787 * </p>
1788 *
1789 * @see #EXTRA_PACKAGE_NAME
1790 * @see #EXTRA_INTENT
1791 * @see #EXTRA_REMOTE_CALLBACK
1792 * @see #EXTRA_RESULT_NEEDED
1793 *
1794 * @hide
1795 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001796 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001797 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1798 public static final String ACTION_REVIEW_PERMISSIONS =
1799 "android.intent.action.REVIEW_PERMISSIONS";
1800
1801 /**
1802 * Intent extra: A callback for reporting remote result as a bundle.
1803 * <p>
1804 * Type: IRemoteCallback
1805 * </p>
1806 *
1807 * @hide
1808 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001809 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001810 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1811
1812 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001813 * Intent extra: An app package name.
1814 * <p>
1815 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001816 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001817 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001818 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001819 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1820
1821 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001822 * Intent extra: An app split name.
1823 * <p>
1824 * Type: String
1825 * </p>
1826 * @hide
1827 */
1828 @SystemApi
1829 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1830
1831 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001832 * Intent extra: A {@link ComponentName} value.
1833 * <p>
1834 * Type: String
1835 * </p>
1836 */
1837 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1838
1839 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001840 * Intent extra: An extra for specifying whether a result is needed.
1841 * <p>
1842 * Type: boolean
1843 * </p>
1844 *
1845 * @hide
1846 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001847 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001848 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1849
1850 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001851 * Activity action: Launch UI to manage which apps have a given permission.
1852 * <p>
1853 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1854 * to which will be managed by the launched UI.
1855 * </p>
1856 * <p>
1857 * Output: Nothing.
1858 * </p>
1859 *
1860 * @see #EXTRA_PERMISSION_NAME
1861 *
1862 * @hide
1863 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001864 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001865 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1866 public static final String ACTION_MANAGE_PERMISSION_APPS =
1867 "android.intent.action.MANAGE_PERMISSION_APPS";
1868
1869 /**
1870 * Intent extra: The name of a permission.
1871 * <p>
1872 * Type: String
1873 * </p>
1874 *
1875 * @hide
1876 */
1877 @SystemApi
1878 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001880 // ---------------------------------------------------------------------
1881 // ---------------------------------------------------------------------
1882 // Standard intent broadcast actions (see action variable).
1883
1884 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001885 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1886 * <p>
1887 * For historical reasons, the name of this broadcast action refers to the power
1888 * state of the screen but it is actually sent in response to changes in the
1889 * overall interactive state of the device.
1890 * </p><p>
1891 * This broadcast is sent when the device becomes non-interactive which may have
1892 * nothing to do with the screen turning off. To determine the
1893 * actual state of the screen, use {@link android.view.Display#getState}.
1894 * </p><p>
1895 * See {@link android.os.PowerManager#isInteractive} for details.
1896 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001897 * You <em>cannot</em> receive this through components declared in
1898 * manifests, only by explicitly registering for it with
1899 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1900 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001901 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001902 * <p class="note">This is a protected intent that can only be sent
1903 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001908 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001909 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1910 * <p>
1911 * For historical reasons, the name of this broadcast action refers to the power
1912 * state of the screen but it is actually sent in response to changes in the
1913 * overall interactive state of the device.
1914 * </p><p>
1915 * This broadcast is sent when the device becomes interactive which may have
1916 * nothing to do with the screen turning on. To determine the
1917 * actual state of the screen, use {@link android.view.Display#getState}.
1918 * </p><p>
1919 * See {@link android.os.PowerManager#isInteractive} for details.
1920 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001921 * You <em>cannot</em> receive this through components declared in
1922 * manifests, only by explicitly registering for it with
1923 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1924 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001925 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001926 * <p class="note">This is a protected intent that can only be sent
1927 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001931
1932 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001933 * Broadcast Action: Sent after the system stops dreaming.
1934 *
1935 * <p class="note">This is a protected intent that can only be sent by the system.
1936 * It is only sent to registered receivers.</p>
1937 */
1938 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1939 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1940
1941 /**
1942 * Broadcast Action: Sent after the system starts dreaming.
1943 *
1944 * <p class="note">This is a protected intent that can only be sent by the system.
1945 * It is only sent to registered receivers.</p>
1946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1949
1950 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001951 * 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 -07001952 * keyguard is gone).
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 Projectb2a3dd82009-03-09 11:52:12 -07001956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001958 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 /**
1961 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001962 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001963 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1965 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001966 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001967 * <p class="note">This is a protected intent that can only be sent
1968 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001969 */
1970 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1971 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1972 /**
1973 * Broadcast Action: The time was set.
1974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1977 /**
1978 * Broadcast Action: The date has changed.
1979 */
1980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1981 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1982 /**
1983 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1984 * <ul>
1985 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1986 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001987 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001988 * <p class="note">This is a protected intent that can only be sent
1989 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001990 */
1991 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1992 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1993 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001994 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1995 * DNS entries should be tossed.
1996 * @hide
1997 */
1998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1999 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2000 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002001 * Alarm Changed Action: This is broadcast when the AlarmClock
2002 * application's alarm is set or unset. It is used by the
2003 * AlarmClock application and the StatusBar service.
2004 * @hide
2005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002008
2009 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002010 * Broadcast Action: This is broadcast once, after the user has finished
2011 * booting, but while still in the "locked" state. It can be used to perform
2012 * application-specific initialization, such as installing alarms. You must
2013 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2014 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002015 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002016 * This broadcast is sent immediately at boot by all devices (regardless of
2017 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2018 * higher. Upon receipt of this broadcast, the user is still locked and only
2019 * device-protected storage can be accessed safely. If you want to access
2020 * credential-protected storage, you need to wait for the user to be
2021 * unlocked (typically by entering their lock pattern or PIN for the first
2022 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2023 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2024 * <p>
2025 * To receive this broadcast, your receiver component must be marked as
2026 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002027 * <p class="note">
2028 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002029 *
2030 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002031 */
2032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2033 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2034
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002036 * Broadcast Action: This is broadcast once, after the user has finished
2037 * booting. It can be used to perform application-specific initialization,
2038 * such as installing alarms. You must hold the
2039 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2040 * order to receive this broadcast.
2041 * <p>
2042 * This broadcast is sent at boot by all devices (both with and without
2043 * direct boot support). Upon receipt of this broadcast, the user is
2044 * unlocked and both device-protected and credential-protected storage can
2045 * accessed safely.
2046 * <p>
2047 * If you need to run while the user is still locked (before they've entered
2048 * their lock pattern or PIN for the first time), you can listen for the
2049 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2050 * <p class="note">
2051 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002054 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002055 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002056
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002057 /**
2058 * Broadcast Action: This is broadcast when a user action should request a
2059 * temporary system dialog to dismiss. Some examples of temporary system
2060 * dialogs are the notification window-shade and the recent tasks dialog.
2061 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002062 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002063 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2064 /**
2065 * Broadcast Action: Trigger the download and eventual installation
2066 * of a package.
2067 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002068 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002069 * <p class="note">This is a protected intent that can only be sent
2070 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002071 *
2072 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002074 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2077 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002078 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002079 * device. The data contains the name of the package. Note that the
2080 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002081 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002082 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002083 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2084 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2086 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002087 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002088 * <p class="note">This is a protected intent that can only be sent
2089 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2093 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002094 * Broadcast Action: A new version of an application package has been
2095 * installed, replacing an existing version that was previously installed.
2096 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002097 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002098 * <ul>
2099 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2100 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002101 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002102 * <p class="note">This is a protected intent that can only be sent
2103 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002104 */
2105 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2106 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2107 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002108 * Broadcast Action: A new version of your application has been installed
2109 * over an existing one. This is only sent to the application that was
2110 * replaced. It does not contain any additional data; to receive it, just
2111 * use an intent filter for this action.
2112 *
2113 * <p class="note">This is a protected intent that can only be sent
2114 * by the system.
2115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2118 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002119 * Broadcast Action: An existing application package has been removed from
2120 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002121 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002122 * <ul>
2123 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2124 * to the package.
2125 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2126 * application -- data and code -- is being removed.
2127 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2128 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2129 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002130 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2136 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002137 * Broadcast Action: An existing application package has been completely
2138 * removed from the device. The data contains the name of the package.
2139 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2140 * {@link #EXTRA_DATA_REMOVED} is true and
2141 * {@link #EXTRA_REPLACING} is false of that broadcast.
2142 *
2143 * <ul>
2144 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2145 * to the package.
2146 * </ul>
2147 *
2148 * <p class="note">This is a protected intent that can only be sent
2149 * by the system.
2150 */
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2152 public static final String ACTION_PACKAGE_FULLY_REMOVED
2153 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2154 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002155 * Broadcast Action: An existing application package has been changed (for
2156 * example, a component has been enabled or disabled). The data contains
2157 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002158 * <ul>
2159 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002160 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002161 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002162 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2163 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002164 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002165 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002166 * <p class="note">This is a protected intent that can only be sent
2167 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2171 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002172 * @hide
2173 * Broadcast Action: Ask system services if there is any reason to
2174 * restart the given package. The data contains the name of the
2175 * package.
2176 * <ul>
2177 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2178 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2179 * </ul>
2180 *
2181 * <p class="note">This is a protected intent that can only be sent
2182 * by the system.
2183 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002184 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002185 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2186 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2187 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002188 * Broadcast Action: The user has restarted a package, and all of its
2189 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002190 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002191 * be removed. Note that the restarted package does <em>not</em>
2192 * receive this broadcast.
2193 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002194 * <ul>
2195 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2196 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002197 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002198 * <p class="note">This is a protected intent that can only be sent
2199 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002200 */
2201 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2203 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002204 * Broadcast Action: The user has cleared the data of a package. This should
2205 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002206 * its persistent data is erased and this broadcast sent.
2207 * Note that the cleared package does <em>not</em>
2208 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002209 * <ul>
2210 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2211 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002212 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002213 * <p class="note">This is a protected intent that can only be sent
2214 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002215 */
2216 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2217 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2218 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002219 * Broadcast Action: Packages have been suspended.
2220 * <p>Includes the following extras:
2221 * <ul>
2222 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2223 * </ul>
2224 *
2225 * <p class="note">This is a protected intent that can only be sent
2226 * by the system. It is only sent to registered receivers.
2227 */
2228 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2229 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2230 /**
2231 * Broadcast Action: Packages have been unsuspended.
2232 * <p>Includes the following extras:
2233 * <ul>
2234 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2235 * </ul>
2236 *
2237 * <p class="note">This is a protected intent that can only be sent
2238 * by the system. It is only sent to registered receivers.
2239 */
2240 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2241 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2242 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002243 * Broadcast Action: A user ID has been removed from the system. The user
2244 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002245 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002246 * <p class="note">This is a protected intent that can only be sent
2247 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002248 */
2249 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2250 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002251
2252 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002253 * Broadcast Action: Sent to the installer package of an application when
2254 * that application is first launched (that is the first time it is moved
2255 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002256 *
2257 * <p class="note">This is a protected intent that can only be sent
2258 * by the system.
2259 */
2260 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2261 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2262
2263 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002264 * Broadcast Action: Sent to the system package verifier when a package
2265 * needs to be verified. The data contains the package URI.
2266 * <p class="note">
2267 * This is a protected intent that can only be sent by the system.
2268 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002269 */
2270 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2271 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2272
2273 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002274 * Broadcast Action: Sent to the system package verifier when a package is
2275 * verified. The data contains the package URI.
2276 * <p class="note">
2277 * This is a protected intent that can only be sent by the system.
2278 */
2279 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2280 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2281
2282 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002283 * Broadcast Action: Sent to the system intent filter verifier when an
2284 * intent filter needs to be verified. The data contains the filter data
2285 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002286 * <p class="note">
2287 * This is a protected intent that can only be sent by the system.
2288 * </p>
2289 *
2290 * @hide
2291 */
2292 @SystemApi
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2295
2296 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002297 * Broadcast Action: Resources for a set of packages (which were
2298 * previously unavailable) are currently
2299 * available since the media on which they exist is available.
2300 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2301 * list of packages whose availability changed.
2302 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2303 * list of uids of packages whose availability changed.
2304 * Note that the
2305 * packages in this list do <em>not</em> receive this broadcast.
2306 * The specified set of packages are now available on the system.
2307 * <p>Includes the following extras:
2308 * <ul>
2309 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2310 * whose resources(were previously unavailable) are currently available.
2311 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2312 * packages whose resources(were previously unavailable)
2313 * are currently available.
2314 * </ul>
2315 *
2316 * <p class="note">This is a protected intent that can only be sent
2317 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002318 */
2319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002320 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2321 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002322
2323 /**
2324 * Broadcast Action: Resources for a set of packages are currently
2325 * unavailable since the media on which they exist is unavailable.
2326 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2327 * list of packages whose availability changed.
2328 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2329 * list of uids of packages whose availability changed.
2330 * The specified set of packages can no longer be
2331 * launched and are practically unavailable on the system.
2332 * <p>Inclues the following extras:
2333 * <ul>
2334 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2335 * whose resources are no longer available.
2336 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2337 * whose resources are no longer available.
2338 * </ul>
2339 *
2340 * <p class="note">This is a protected intent that can only be sent
2341 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002342 */
2343 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002344 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002345 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002346
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002347 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002348 * Broadcast Action: preferred activities have changed *explicitly*.
2349 *
2350 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2351 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2352 * be sent.
2353 *
2354 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2355 *
2356 * @hide
2357 */
2358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2359 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2360 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2361
2362
2363 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002365 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002366 * This should <em>only</em> be used to determine when the wallpaper
2367 * has changed to show the new wallpaper to the user. You should certainly
2368 * never, in response to this, change the wallpaper or other attributes of
2369 * it such as the suggested size. That would be crazy, right? You'd cause
2370 * all kinds of loops, especially if other apps are doing similar things,
2371 * right? Of course. So please don't do this.
2372 *
2373 * @deprecated Modern applications should use
2374 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2375 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2376 * shown behind their UI, rather than watching for this broadcast and
2377 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002378 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002379 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002380 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2381 /**
2382 * Broadcast Action: The current device {@link android.content.res.Configuration}
2383 * (orientation, locale, etc) has changed. When such a change happens, the
2384 * UIs (view hierarchy) will need to be rebuilt based on this new
2385 * information; for the most part, applications don't need to worry about
2386 * this, because the system will take care of stopping and restarting the
2387 * application to make sure it sees the new changes. Some system code that
2388 * can not be restarted will need to watch for this action and handle it
2389 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002390 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002391 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002392 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002393 * in manifests, only by explicitly registering for it with
2394 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2395 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002396 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002397 * <p class="note">This is a protected intent that can only be sent
2398 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002399 *
2400 * @see android.content.res.Configuration
2401 */
2402 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2403 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2404 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002405 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002406 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002407 * <p class="note">This is a protected intent that can only be sent
2408 * by the system.
2409 */
2410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2411 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2412 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002413 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2414 * charging state, level, and other information about the battery.
2415 * See {@link android.os.BatteryManager} for documentation on the
2416 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002417 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002418 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002419 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002420 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002421 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002422 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2423 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2424 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2425 * broadcasts that are sent and can be received through manifest
2426 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002427 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002428 * <p class="note">This is a protected intent that can only be sent
2429 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002430 */
2431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2432 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2433 /**
2434 * Broadcast Action: Indicates low battery condition on the device.
2435 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002436 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002437 * <p class="note">This is a protected intent that can only be sent
2438 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002439 */
2440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2441 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2442 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002443 * Broadcast Action: Indicates the battery is now okay after being low.
2444 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2445 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002446 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002447 * <p class="note">This is a protected intent that can only be sent
2448 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002449 */
2450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2451 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2452 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002453 * Broadcast Action: External power has been connected to the device.
2454 * This is intended for applications that wish to register specifically to this notification.
2455 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2456 * stay active to receive this notification. This action can be used to implement actions
2457 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002458 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002459 * <p class="note">This is a protected intent that can only be sent
2460 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002461 */
2462 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002463 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002464 /**
2465 * Broadcast Action: External power has been removed from the device.
2466 * This is intended for applications that wish to register specifically to this notification.
2467 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2468 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002469 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002470 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002471 * <p class="note">This is a protected intent that can only be sent
2472 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002473 */
2474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002475 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002476 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002477 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002478 * Broadcast Action: Device is shutting down.
2479 * This is broadcast when the device is being shut down (completely turned
2480 * off, not sleeping). Once the broadcast is complete, the final shutdown
2481 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002482 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002483 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002484 * <p class="note">This is a protected intent that can only be sent
2485 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002486 * <p>May include the following extras:
2487 * <ul>
2488 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2489 * shutdown is only for userspace processes. If not set, assumed to be false.
2490 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002491 */
2492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002493 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002494 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002495 * Activity Action: Start this activity to request system shutdown.
2496 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002497 * to request confirmation from the user before shutting down. The optional boolean
2498 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2499 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002500 *
2501 * <p class="note">This is a protected intent that can only be sent
2502 * by the system.
2503 *
2504 * {@hide}
2505 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002506 public static final String ACTION_REQUEST_SHUTDOWN
2507 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002508 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002509 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002510 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002511 * <p class="note">
2512 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002513 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002514 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2515 * or above, this broadcast will no longer be delivered to any
2516 * {@link BroadcastReceiver} defined in your manifest. Instead,
2517 * apps are strongly encouraged to use the improved
2518 * {@link Context#getCacheDir()} behavior so the system can
2519 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002520 */
2521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002522 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002523 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2524 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002525 * Broadcast Action: Indicates low storage space condition on the device no
2526 * longer exists
2527 * <p class="note">
2528 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002529 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002530 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2531 * or above, this broadcast will no longer be delivered to any
2532 * {@link BroadcastReceiver} defined in your manifest. Instead,
2533 * apps are strongly encouraged to use the improved
2534 * {@link Context#getCacheDir()} behavior so the system can
2535 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002536 */
2537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002538 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002539 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2540 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002541 * Broadcast Action: A sticky broadcast that indicates a storage space full
2542 * condition on the device. This is intended for activities that want to be
2543 * able to fill the data partition completely, leaving only enough free
2544 * space to prevent system-wide SQLite failures.
2545 * <p class="note">
2546 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002547 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002548 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2549 * or above, this broadcast will no longer be delivered to any
2550 * {@link BroadcastReceiver} defined in your manifest. Instead,
2551 * apps are strongly encouraged to use the improved
2552 * {@link Context#getCacheDir()} behavior so the system can
2553 * automatically free up storage when needed.
2554 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002555 */
2556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002557 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002558 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2559 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002560 * Broadcast Action: Indicates storage space full condition on the device no
2561 * longer exists.
2562 * <p class="note">
2563 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002564 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002565 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2566 * or above, this broadcast will no longer be delivered to any
2567 * {@link BroadcastReceiver} defined in your manifest. Instead,
2568 * apps are strongly encouraged to use the improved
2569 * {@link Context#getCacheDir()} behavior so the system can
2570 * automatically free up storage when needed.
2571 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002574 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002575 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2576 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002577 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2578 * and package management should be started.
2579 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2580 * notification.
2581 */
2582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2583 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2584 /**
2585 * Broadcast Action: The device has entered USB Mass Storage mode.
2586 * This is used mainly for the USB Settings panel.
2587 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2588 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002589 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002590 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002591 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2594
2595 /**
2596 * Broadcast Action: The device has exited USB Mass Storage mode.
2597 * This is used mainly for the USB Settings panel.
2598 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2599 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002600 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002601 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002602 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002603 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002604 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2605
2606 /**
2607 * Broadcast Action: External media has been removed.
2608 * The path to the mount point for the removed media is contained in the Intent.mData field.
2609 */
2610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2611 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2612
2613 /**
2614 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002615 * 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 -07002616 */
2617 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2618 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2619
2620 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002621 * Broadcast Action: External media is present, and being disk-checked
2622 * 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 -08002623 */
2624 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2625 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2626
2627 /**
2628 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2629 * 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 -08002630 */
2631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2632 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2633
2634 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002635 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002636 * 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 -07002637 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2638 * media was mounted read only.
2639 */
2640 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2641 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2642
2643 /**
2644 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002645 * 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 -07002646 */
2647 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2648 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2649
2650 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002651 * Broadcast Action: External media is no longer being shared via USB mass storage.
2652 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2653 *
2654 * @hide
2655 */
2656 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2657
2658 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002659 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2660 * The path to the mount point for the removed media is contained in the Intent.mData field.
2661 */
2662 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2663 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2664
2665 /**
2666 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002667 * 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 -07002668 */
2669 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2670 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2671
2672 /**
2673 * Broadcast Action: User has expressed the desire to remove the external storage media.
2674 * Applications should close all files they have open within the mount point when they receive this intent.
2675 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2676 */
2677 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2678 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2679
2680 /**
2681 * Broadcast Action: The media scanner has started scanning a directory.
2682 * The path to the directory being scanned is contained in the Intent.mData field.
2683 */
2684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2685 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2686
2687 /**
2688 * Broadcast Action: The media scanner has finished scanning a directory.
2689 * The path to the scanned directory is contained in the Intent.mData field.
2690 */
2691 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2692 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2693
2694 /**
2695 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2696 * The path to the file is contained in the Intent.mData field.
2697 */
2698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2699 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2700
2701 /**
2702 * Broadcast Action: The "Media Button" was pressed. Includes a single
2703 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2704 * caused the broadcast.
2705 */
2706 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2707 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2708
2709 /**
2710 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2711 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2712 * caused the broadcast.
2713 */
2714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2715 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2716
2717 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2718 // location; they are not general-purpose actions.
2719
2720 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002721 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 */
2723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2724 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2725 "android.intent.action.GTALK_CONNECTED";
2726
2727 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002728 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002729 */
2730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2731 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2732 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002733
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002734 /**
2735 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002736 */
2737 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2738 public static final String ACTION_INPUT_METHOD_CHANGED =
2739 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002740
2741 /**
2742 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2743 * more radios have been turned off or on. The intent will have the following extra value:</p>
2744 * <ul>
2745 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2746 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2747 * turned off</li>
2748 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002749 *
Peng Xua35b5532016-01-20 00:05:45 -08002750 * <p class="note">This is a protected intent that can only be sent by the system.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 */
2752 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2753 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2754
2755 /**
2756 * Broadcast Action: Some content providers have parts of their namespace
2757 * where they publish new events or items that the user may be especially
2758 * interested in. For these things, they may broadcast this action when the
2759 * set of interesting items change.
2760 *
2761 * For example, GmailProvider sends this notification when the set of unread
2762 * mail in the inbox changes.
2763 *
2764 * <p>The data of the intent identifies which part of which provider
2765 * changed. When queried through the content resolver, the data URI will
2766 * return the data set in question.
2767 *
2768 * <p>The intent will have the following extra values:
2769 * <ul>
2770 * <li><em>count</em> - The number of items in the data set. This is the
2771 * same as the number of items in the cursor returned by querying the
2772 * data URI. </li>
2773 * </ul>
2774 *
2775 * This intent will be sent at boot (if the count is non-zero) and when the
2776 * data set changes. It is possible for the data set to change without the
2777 * count changing (for example, if a new unread message arrives in the same
2778 * sync operation in which a message is archived). The phone should still
2779 * ring/vibrate/etc as normal in this case.
2780 */
2781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2782 public static final String ACTION_PROVIDER_CHANGED =
2783 "android.intent.action.PROVIDER_CHANGED";
2784
2785 /**
2786 * Broadcast Action: Wired Headset plugged in or unplugged.
2787 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002788 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2789 * and documentation.
2790 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002791 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002792 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002793 */
2794 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002795 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002796
2797 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002798 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2799 * <ul>
2800 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2801 * </ul>
2802 *
2803 * <p class="note">This is a protected intent that can only be sent
2804 * by the system.
2805 *
2806 * @hide
2807 */
2808 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2809 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2810 = "android.intent.action.ADVANCED_SETTINGS";
2811
2812 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002813 * Broadcast Action: Sent after application restrictions are changed.
2814 *
2815 * <p class="note">This is a protected intent that can only be sent
2816 * by the system.</p>
2817 */
2818 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2819 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2820 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2821
2822 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002823 * Broadcast Action: An outgoing call is about to be placed.
2824 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002825 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002826 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002827 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002828 * the phone number originally intended to be dialed.</li>
2829 * </ul>
2830 * <p>Once the broadcast is finished, the resultData is used as the actual
2831 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002832 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002833 * outgoing call in turn: for example, a parental control application
2834 * might verify that the user is authorized to place the call at that
2835 * time, then a number-rewriting application might add an area code if
2836 * one was not specified.</p>
2837 * <p>For consistency, any receiver whose purpose is to prohibit phone
2838 * calls should have a priority of 0, to ensure it will see the final
2839 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002840 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002841 * should have a positive priority.
2842 * Negative priorities are reserved for the system for this broadcast;
2843 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002844 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2845 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * <p>Emergency calls cannot be intercepted using this mechanism, and
2847 * other calls cannot be modified to call emergency numbers using this
2848 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002849 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2850 * call to use their own service instead. Those apps should first prevent
2851 * the call from being placed by setting resultData to <code>null</code>
2852 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002853 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002854 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2855 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002856 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002857 * <p class="note">This is a protected intent that can only be sent
2858 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 */
2860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2861 public static final String ACTION_NEW_OUTGOING_CALL =
2862 "android.intent.action.NEW_OUTGOING_CALL";
2863
2864 /**
2865 * Broadcast Action: Have the device reboot. This is only for use by
2866 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002867 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002868 * <p class="note">This is a protected intent that can only be sent
2869 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 */
2871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2872 public static final String ACTION_REBOOT =
2873 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002874
Wei Huang97ecc9c2009-05-11 17:44:20 -07002875 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002876 * Broadcast Action: A sticky broadcast for changes in the physical
2877 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002878 *
2879 * <p>The intent will have the following extra values:
2880 * <ul>
2881 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002882 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002883 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002884 * <p>This is intended for monitoring the current physical dock state.
2885 * See {@link android.app.UiModeManager} for the normal API dealing with
2886 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002887 */
2888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2889 public static final String ACTION_DOCK_EVENT =
2890 "android.intent.action.DOCK_EVENT";
2891
2892 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002893 * Broadcast Action: A broadcast when idle maintenance can be started.
2894 * This means that the user is not interacting with the device and is
2895 * not expected to do so soon. Typical use of the idle maintenance is
2896 * to perform somehow expensive tasks that can be postponed at a moment
2897 * when they will not degrade user experience.
2898 * <p>
2899 * <p class="note">In order to keep the device responsive in case of an
2900 * unexpected user interaction, implementations of a maintenance task
2901 * should be interruptible. In such a scenario a broadcast with action
2902 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2903 * should not do the maintenance work in
2904 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2905 * maintenance service by {@link Context#startService(Intent)}. Also
2906 * you should hold a wake lock while your maintenance service is running
2907 * to prevent the device going to sleep.
2908 * </p>
2909 * <p>
2910 * <p class="note">This is a protected intent that can only be sent by
2911 * the system.
2912 * </p>
2913 *
2914 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002915 *
2916 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002917 */
2918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2919 public static final String ACTION_IDLE_MAINTENANCE_START =
2920 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2921
2922 /**
2923 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2924 * This means that the user was not interacting with the device as a result
2925 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2926 * was sent and now the user started interacting with the device. Typical
2927 * use of the idle maintenance is to perform somehow expensive tasks that
2928 * can be postponed at a moment when they will not degrade user experience.
2929 * <p>
2930 * <p class="note">In order to keep the device responsive in case of an
2931 * unexpected user interaction, implementations of a maintenance task
2932 * should be interruptible. Hence, on receiving a broadcast with this
2933 * action, the maintenance task should be interrupted as soon as possible.
2934 * In other words, you should not do the maintenance work in
2935 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2936 * maintenance service that was started on receiving of
2937 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2938 * lock you acquired when your maintenance service started.
2939 * </p>
2940 * <p class="note">This is a protected intent that can only be sent
2941 * by the system.
2942 *
2943 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002944 *
2945 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002946 */
2947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2948 public static final String ACTION_IDLE_MAINTENANCE_END =
2949 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2950
2951 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002952 * Broadcast Action: a remote intent is to be broadcasted.
2953 *
2954 * A remote intent is used for remote RPC between devices. The remote intent
2955 * is serialized and sent from one device to another device. The receiving
2956 * device parses the remote intent and broadcasts it. Note that anyone can
2957 * broadcast a remote intent. However, if the intent receiver of the remote intent
2958 * does not trust intent broadcasts from arbitrary intent senders, it should require
2959 * the sender to hold certain permissions so only trusted sender's broadcast will be
2960 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002961 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002962 */
2963 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002964 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002965
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002966 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002967 * Broadcast Action: This is broadcast once when the user is booting after a
2968 * system update. It can be used to perform cleanup or upgrades after a
2969 * system update.
2970 * <p>
2971 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2972 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2973 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2974 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002975 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002976 * @hide
2977 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002978 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002979 public static final String ACTION_PRE_BOOT_COMPLETED =
2980 "android.intent.action.PRE_BOOT_COMPLETED";
2981
Amith Yamasani13593602012-03-22 16:16:17 -07002982 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002983 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002984 * on restricted users. The broadcast intent contains an extra
2985 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2986 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2987 * String[] depending on the restriction type.<p/>
2988 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002989 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2990 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2991 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002992 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2993 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002994 * @see RestrictionEntry
2995 */
2996 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2997 "android.intent.action.GET_RESTRICTION_ENTRIES";
2998
2999 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003000 * Sent the first time a user is starting, to allow system apps to
3001 * perform one time initialization. (This will not be seen by third
3002 * party applications because a newly initialized user does not have any
3003 * third party applications installed for it.) This is sent early in
3004 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003005 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3006 * broadcast, since it is part of a visible user interaction; be as quick
3007 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003008 */
3009 public static final String ACTION_USER_INITIALIZE =
3010 "android.intent.action.USER_INITIALIZE";
3011
3012 /**
3013 * Sent when a user switch is happening, causing the process's user to be
3014 * brought to the foreground. This is only sent to receivers registered
3015 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3016 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003017 * foreground. This is sent as a foreground
3018 * broadcast, since it is part of a visible user interaction; be as quick
3019 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003020 */
3021 public static final String ACTION_USER_FOREGROUND =
3022 "android.intent.action.USER_FOREGROUND";
3023
3024 /**
3025 * Sent when a user switch is happening, causing the process's user to be
3026 * sent to the background. This is only sent to receivers registered
3027 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3028 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003029 * background. This is sent as a foreground
3030 * broadcast, since it is part of a visible user interaction; be as quick
3031 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003032 */
3033 public static final String ACTION_USER_BACKGROUND =
3034 "android.intent.action.USER_BACKGROUND";
3035
3036 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003037 * Broadcast sent to the system when a user is added. Carries an extra
3038 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3039 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003040 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003041 * @hide
3042 */
3043 public static final String ACTION_USER_ADDED =
3044 "android.intent.action.USER_ADDED";
3045
3046 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003047 * Broadcast sent by the system when a user is started. Carries an extra
3048 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003049 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003050 * that has been started. This is sent as a foreground
3051 * broadcast, since it is part of a visible user interaction; be as quick
3052 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003053 * @hide
3054 */
3055 public static final String ACTION_USER_STARTED =
3056 "android.intent.action.USER_STARTED";
3057
3058 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003059 * Broadcast sent when a user is in the process of starting. Carries an extra
3060 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3061 * sent to registered receivers, not manifest receivers. It is sent to all
3062 * users (including the one that is being started). You must hold
3063 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3064 * this broadcast. This is sent as a background broadcast, since
3065 * its result is not part of the primary UX flow; to safely keep track of
3066 * started/stopped state of a user you can use this in conjunction with
3067 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3068 * other user state broadcasts since those are foreground broadcasts so can
3069 * execute in a different order.
3070 * @hide
3071 */
3072 public static final String ACTION_USER_STARTING =
3073 "android.intent.action.USER_STARTING";
3074
3075 /**
3076 * Broadcast sent when a user is going to be stopped. Carries an extra
3077 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3078 * sent to registered receivers, not manifest receivers. It is sent to all
3079 * users (including the one that is being stopped). You must hold
3080 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3081 * this broadcast. The user will not stop until all receivers have
3082 * handled the broadcast. This is sent as a background broadcast, since
3083 * its result is not part of the primary UX flow; to safely keep track of
3084 * started/stopped state of a user you can use this in conjunction with
3085 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3086 * other user state broadcasts since those are foreground broadcasts so can
3087 * execute in a different order.
3088 * @hide
3089 */
3090 public static final String ACTION_USER_STOPPING =
3091 "android.intent.action.USER_STOPPING";
3092
3093 /**
3094 * Broadcast sent to the system when a user is stopped. Carries an extra
3095 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3096 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3097 * specific package. This is only sent to registered receivers, not manifest
3098 * receivers. It is sent to all running users <em>except</em> the one that
3099 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003100 * @hide
3101 */
3102 public static final String ACTION_USER_STOPPED =
3103 "android.intent.action.USER_STOPPED";
3104
3105 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003106 * 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 -07003107 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003108 * one that has been removed. The user will not be completely removed until all receivers have
3109 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003110 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003111 * @hide
3112 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003113 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003114 public static final String ACTION_USER_REMOVED =
3115 "android.intent.action.USER_REMOVED";
3116
3117 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003118 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003119 * the userHandle of the user to become the current one. This is only sent to
3120 * registered receivers, not manifest receivers. It is sent to all running users.
3121 * You must hold
3122 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003123 * @hide
3124 */
3125 public static final String ACTION_USER_SWITCHED =
3126 "android.intent.action.USER_SWITCHED";
3127
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003128 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003129 * Broadcast Action: Sent when the credential-encrypted private storage has
3130 * become unlocked for the target user. This is only sent to registered
3131 * receivers, not manifest receivers.
3132 */
3133 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3134 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3135
3136 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003137 * Broadcast sent to the system when a user's information changes. Carries an extra
3138 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003139 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003140 * @hide
3141 */
3142 public static final String ACTION_USER_INFO_CHANGED =
3143 "android.intent.action.USER_INFO_CHANGED";
3144
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003145 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003146 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3147 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003148 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3149 * that need to display merged content across both primary and managed profiles need to
3150 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003151 * not manifest receivers.
3152 */
3153 public static final String ACTION_MANAGED_PROFILE_ADDED =
3154 "android.intent.action.MANAGED_PROFILE_ADDED";
3155
3156 /**
3157 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003158 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3159 * Only applications (for example Launchers) that need to display merged content across both
3160 * primary and managed profiles need to worry about this broadcast. This is only sent to
3161 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003162 */
3163 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3164 "android.intent.action.MANAGED_PROFILE_REMOVED";
3165
3166 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003167 * Broadcast sent to the primary user when the credential-encrypted private storage for
3168 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3169 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3170 * Launchers) that need to display merged content across both primary and managed profiles
3171 * need to worry about this broadcast. This is only sent to registered receivers,
3172 * not manifest receivers.
3173 */
3174 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3175 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3176
3177 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003178 * Broadcast sent to the primary user when an associated managed profile has become available.
3179 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003180 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3181 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3182 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003183 */
Rubin Xue95057a2016-04-01 16:49:25 +01003184 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3185 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3186
3187 /**
3188 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3189 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3190 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3191 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3192 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3193 */
3194 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3195 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003196
3197 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003198 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3199 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3200 * the device was locked or unlocked.
3201 *
3202 * This is only sent to registered receivers.
3203 *
3204 * @hide
3205 */
3206 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3207 "android.intent.action.DEVICE_LOCKED_CHANGED";
3208
3209 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003210 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3211 */
3212 public static final String ACTION_QUICK_CLOCK =
3213 "android.intent.action.QUICK_CLOCK";
3214
Michael Wright0087a142013-02-05 16:29:39 -08003215 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003216 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003217 * @hide
3218 */
3219 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003220 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003221
Justin Kohd378ad72013-04-01 12:18:26 -07003222 /**
3223 * Broadcast Action: A global button was pressed. Includes a single
3224 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3225 * caused the broadcast.
3226 * @hide
3227 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003228 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003229 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3230
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003231 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003232 * Broadcast Action: Sent when media resource is granted.
3233 * <p>
3234 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3235 * granted.
3236 * </p>
3237 * <p class="note">
3238 * This is a protected intent that can only be sent by the system.
3239 * </p>
3240 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003241 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003242 * </p>
3243 *
3244 * @hide
3245 */
3246 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3247 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3248
3249 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003250 * Broadcast Action: An overlay package has changed. The data contains the
3251 * name of the overlay package which has changed. This is broadcast on all
3252 * changes to the OverlayInfo returned by {@link
3253 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3254 * most common change is a state change that will change whether the
3255 * overlay is enabled or not.
3256 * @hide
3257 */
3258 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3259
3260 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003261 * Activity Action: Allow the user to select and return one or more existing
3262 * documents. When invoked, the system will display the various
3263 * {@link DocumentsProvider} instances installed on the device, letting the
3264 * user interactively navigate through them. These documents include local
3265 * media, such as photos and video, and documents provided by installed
3266 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003267 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003268 * Each document is represented as a {@code content://} URI backed by a
3269 * {@link DocumentsProvider}, which can be opened as a stream with
3270 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3271 * {@link android.provider.DocumentsContract.Document} metadata.
3272 * <p>
3273 * All selected documents are returned to the calling application with
3274 * persistable read and write permission grants. If you want to maintain
3275 * access to the documents across device reboots, you need to explicitly
3276 * take the persistable permissions using
3277 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3278 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003279 * Callers must indicate the acceptable document MIME types through
3280 * {@link #setType(String)}. For example, to select photos, use
3281 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3282 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3283 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003284 * <p>
3285 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003286 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3287 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003288 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003289 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3290 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003291 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003292 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003293 * Callers can set a document URI through
3294 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3295 * location of documents navigator. System will do its best to launch the
3296 * navigator in the specified document if it's a folder, or the folder that
3297 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003298 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003299 * Output: The URI of the item that was picked, returned in
3300 * {@link #getData()}. This must be a {@code content://} URI so that any
3301 * receiver can access it. If multiple documents were selected, they are
3302 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003303 *
3304 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003305 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003306 * @see #ACTION_CREATE_DOCUMENT
3307 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003308 */
3309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3310 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3311
3312 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003313 * Activity Action: Allow the user to create a new document. When invoked,
3314 * the system will display the various {@link DocumentsProvider} instances
3315 * installed on the device, letting the user navigate through them. The
3316 * returned document may be a newly created document with no content, or it
3317 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003318 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003319 * Each document is represented as a {@code content://} URI backed by a
3320 * {@link DocumentsProvider}, which can be opened as a stream with
3321 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3322 * {@link android.provider.DocumentsContract.Document} metadata.
3323 * <p>
3324 * Callers must indicate the concrete MIME type of the document being
3325 * created by setting {@link #setType(String)}. This MIME type cannot be
3326 * changed after the document is created.
3327 * <p>
3328 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3329 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003330 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003331 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3332 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003333 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003334 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003335 * Callers can set a document URI through
3336 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3337 * location of documents navigator. System will do its best to launch the
3338 * navigator in the specified document if it's a folder, or the folder that
3339 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003340 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003341 * Output: The URI of the item that was created. This must be a
3342 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003343 *
3344 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003345 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003346 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003347 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003348 */
3349 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3350 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3351
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003352 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003353 * Activity Action: Allow the user to pick a directory subtree. When
3354 * invoked, the system will display the various {@link DocumentsProvider}
3355 * instances installed on the device, letting the user navigate through
3356 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003357 * <p>
3358 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003359 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3360 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3361 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003362 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003363 * Callers can set a document URI through
3364 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3365 * location of documents navigator. System will do its best to launch the
3366 * navigator in the specified document if it's a folder, or the folder that
3367 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003368 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003369 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003370 *
3371 * @see DocumentsContract
3372 */
3373 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003374 public static final String
3375 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003376
Felipe Lemec7b1f892016-01-15 15:02:31 -08003377 /**
Peng Xua35b5532016-01-20 00:05:45 -08003378 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3379 * exisiting sensor being disconnected.
3380 *
3381 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3382 *
3383 * {@hide}
3384 */
3385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3386 public static final String
3387 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3388
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003389 /**
Sam Line707f832017-04-13 17:00:55 -07003390 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003391 * @hide
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003392 */
3393 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003394 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003395 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3396
Christopher Tate6597e342015-02-17 12:15:25 -08003397 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003398 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3399 * is about to be performed.
3400 * @hide
3401 */
3402 @SystemApi
3403 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3404 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3405 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3406
3407 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003408 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3409 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3410 *
3411 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3412 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003413 * @hide
3414 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003415 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003416 public static final String EXTRA_FORCE_MASTER_CLEAR =
3417 "android.intent.extra.FORCE_MASTER_CLEAR";
3418
3419 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003420 * A broadcast action to trigger a factory reset.
3421 *
3422 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3423 *
3424 * <p>Not for use by third-party applications.
3425 *
3426 * @see #EXTRA_FORCE_MASTER_CLEAR
3427 *
3428 * {@hide}
3429 */
3430 @SystemApi
3431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3432 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3433
3434 /**
3435 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3436 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3437 *
3438 * <p>Not for use by third-party applications.
3439 *
3440 * @hide
3441 */
3442 @SystemApi
3443 public static final String EXTRA_FORCE_FACTORY_RESET =
3444 "android.intent.extra.FORCE_FACTORY_RESET";
3445
3446 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003447 * Broadcast action: report that a settings element is being restored from backup. The intent
3448 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3449 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3450 * is the value of that settings entry prior to the restore operation. All of these values are
3451 * represented as strings.
3452 *
3453 * <p>This broadcast is sent only for settings provider entries known to require special handling
3454 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3455 * the provider's backup agent implementation.
3456 *
3457 * @see #EXTRA_SETTING_NAME
3458 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3459 * @see #EXTRA_SETTING_NEW_VALUE
3460 * {@hide}
3461 */
3462 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3463
3464 /** {@hide} */
3465 public static final String EXTRA_SETTING_NAME = "setting_name";
3466 /** {@hide} */
3467 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3468 /** {@hide} */
3469 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3470
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003471 /**
3472 * Activity Action: Process a piece of text.
3473 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3474 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3475 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3476 */
3477 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3478 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003479
3480 /**
3481 * Broadcast Action: The sim card state has changed.
3482 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3483 * because TelephonyIntents is an internal class.
3484 * @hide
3485 */
3486 @SystemApi
3487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3488 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3489
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003490 /**
fionaxu90fee272017-03-31 12:45:12 -07003491 * Broadcast Action: indicate that the phone service state has changed.
3492 * The intent will have the following extra values:</p>
3493 * <p>
3494 * @see #EXTRA_VOICE_REG_STATE
3495 * @see #EXTRA_DATA_REG_STATE
3496 * @see #EXTRA_VOICE_ROAMING_TYPE
3497 * @see #EXTRA_DATA_ROAMING_TYPE
3498 * @see #EXTRA_OPERATOR_ALPHA_LONG
3499 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3500 * @see #EXTRA_OPERATOR_NUMERIC
3501 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3502 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3503 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3504 * @see #EXTRA_MANUAL
3505 * @see #EXTRA_VOICE_RADIO_TECH
3506 * @see #EXTRA_DATA_RADIO_TECH
3507 * @see #EXTRA_CSS_INDICATOR
3508 * @see #EXTRA_NETWORK_ID
3509 * @see #EXTRA_SYSTEM_ID
3510 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3511 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3512 * @see #EXTRA_EMERGENCY_ONLY
3513 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3514 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3515 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3516 *
3517 * <p class="note">
3518 * Requires the READ_PHONE_STATE permission.
3519 *
3520 * <p class="note">This is a protected intent that can only be sent by the system.
3521 * @hide
3522 */
3523 @Deprecated
3524 @SystemApi
3525 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3526 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3527
3528 /**
3529 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3530 * state.
3531 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3532 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3533 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3534 * @see android.telephony.ServiceState#STATE_POWER_OFF
3535 * @hide
3536 */
3537 @Deprecated
3538 @SystemApi
3539 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3540
3541 /**
3542 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3543 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3544 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3545 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3546 * @see android.telephony.ServiceState#STATE_POWER_OFF
3547 * @hide
3548 */
3549 @Deprecated
3550 @SystemApi
3551 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3552
3553 /**
3554 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3555 * type.
3556 * @hide
3557 */
3558 @Deprecated
3559 @SystemApi
3560 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3561
3562 /**
3563 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3564 * type.
3565 * @hide
3566 */
3567 @Deprecated
3568 @SystemApi
3569 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3570
3571 /**
3572 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3573 * registered voice operator name in long alphanumeric format.
3574 * {@code null} if the operator name is not known or unregistered.
3575 * @hide
3576 */
3577 @Deprecated
3578 @SystemApi
3579 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3580
3581 /**
3582 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3583 * registered voice operator name in short alphanumeric format.
3584 * {@code null} if the operator name is not known or unregistered.
3585 * @hide
3586 */
3587 @Deprecated
3588 @SystemApi
3589 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3590
3591 /**
3592 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3593 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3594 * network.
3595 * @hide
3596 */
3597 @Deprecated
3598 @SystemApi
3599 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3600
3601 /**
3602 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3603 * registered data operator name in long alphanumeric format.
3604 * {@code null} if the operator name is not known or unregistered.
3605 * @hide
3606 */
3607 @Deprecated
3608 @SystemApi
3609 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3610
3611 /**
3612 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3613 * registered data operator name in short alphanumeric format.
3614 * {@code null} if the operator name is not known or unregistered.
3615 * @hide
3616 */
3617 @Deprecated
3618 @SystemApi
3619 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3620
3621 /**
3622 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3623 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3624 * data operator.
3625 * @hide
3626 */
3627 @Deprecated
3628 @SystemApi
3629 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3630
3631 /**
3632 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3633 * network selection mode is manual.
3634 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3635 * @hide
3636 */
3637 @Deprecated
3638 @SystemApi
3639 public static final String EXTRA_MANUAL = "manual";
3640
3641 /**
3642 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3643 * radio technology.
3644 * @hide
3645 */
3646 @Deprecated
3647 @SystemApi
3648 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3649
3650 /**
3651 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3652 * radio technology.
3653 * @hide
3654 */
3655 @Deprecated
3656 @SystemApi
3657 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3658
3659 /**
3660 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3661 * support on CDMA network.
3662 * Will be {@code true} if support, {@code false} otherwise.
3663 * @hide
3664 */
3665 @Deprecated
3666 @SystemApi
3667 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3668
3669 /**
3670 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3671 * id. {@code Integer.MAX_VALUE} if unknown.
3672 * @hide
3673 */
3674 @Deprecated
3675 @SystemApi
3676 public static final String EXTRA_NETWORK_ID = "networkId";
3677
3678 /**
3679 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3680 * {@code Integer.MAX_VALUE} if unknown.
3681 * @hide
3682 */
3683 @Deprecated
3684 @SystemApi
3685 public static final String EXTRA_SYSTEM_ID = "systemId";
3686
3687 /**
3688 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3689 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3690 * @hide
3691 */
3692 @Deprecated
3693 @SystemApi
3694 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3695
3696 /**
3697 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3698 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3699 * @hide
3700 */
3701 @Deprecated
3702 @SystemApi
3703 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3704
3705 /**
3706 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3707 * only mode.
3708 * {@code true} if in emergency only mode, {@code false} otherwise.
3709 * @hide
3710 */
3711 @Deprecated
3712 @SystemApi
3713 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3714
3715 /**
3716 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3717 * registration state is roaming.
3718 * {@code true} if registration indicates roaming, {@code false} otherwise
3719 * @hide
3720 */
3721 @Deprecated
3722 @SystemApi
3723 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3724 "isDataRoamingFromRegistration";
3725
3726 /**
3727 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3728 * aggregation is in use.
3729 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3730 * @hide
3731 */
3732 @Deprecated
3733 @SystemApi
3734 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3735
3736 /**
3737 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3738 * is reduced from the rsrp threshold while calculating signal strength level.
3739 * @hide
3740 */
3741 @Deprecated
3742 @SystemApi
3743 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3744
3745 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003746 * The name of the extra used to define the text to be processed, as a
3747 * CharSequence. Note that this may be a styled CharSequence, so you must use
3748 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003749 */
3750 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3751 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003752 * 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 +00003753 */
3754 public static final String EXTRA_PROCESS_TEXT_READONLY =
3755 "android.intent.extra.PROCESS_TEXT_READONLY";
3756
Bryce Leebc58f592015-09-25 16:43:01 -07003757 /**
3758 * Broadcast action: reports when a new thermal event has been reached. When the device
3759 * is reaching its maximum temperatue, the thermal level reported
3760 * {@hide}
3761 */
3762 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3763 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3764
3765 /** {@hide} */
3766 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3767
3768 /**
3769 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003770 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003771 * {@hide}
3772 */
3773 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3774
3775 /**
3776 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003777 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003778 * {@hide}
3779 */
3780 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3781
3782 /**
3783 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003784 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003785 * {@hide}
3786 */
3787 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3788
3789
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003790 // ---------------------------------------------------------------------
3791 // ---------------------------------------------------------------------
3792 // Standard intent categories (see addCategory()).
3793
3794 /**
3795 * Set if the activity should be an option for the default action
3796 * (center press) to perform on a piece of data. Setting this will
3797 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003798 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003799 * Intent when initiating an action -- it is for use in intent filters
3800 * specified in packages.
3801 */
3802 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3803 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3804 /**
3805 * Activities that can be safely invoked from a browser must support this
3806 * category. For example, if the user is viewing a web page or an e-mail
3807 * and clicks on a link in the text, the Intent generated execute that
3808 * link will require the BROWSABLE category, so that only activities
3809 * supporting this category will be considered as possible actions. By
3810 * supporting this category, you are promising that there is nothing
3811 * damaging (without user intervention) that can happen by invoking any
3812 * matching Intent.
3813 */
3814 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3815 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3816 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003817 * Categories for activities that can participate in voice interaction.
3818 * An activity that supports this category must be prepared to run with
3819 * no UI shown at all (though in some case it may have a UI shown), and
3820 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3821 */
3822 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3823 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 * Set if the activity should be considered as an alternative action to
3826 * the data the user is currently viewing. See also
3827 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3828 * applies to the selection in a list of items.
3829 *
3830 * <p>Supporting this category means that you would like your activity to be
3831 * displayed in the set of alternative things the user can do, usually as
3832 * part of the current activity's options menu. You will usually want to
3833 * include a specific label in the &lt;intent-filter&gt; of this action
3834 * describing to the user what it does.
3835 *
3836 * <p>The action of IntentFilter with this category is important in that it
3837 * describes the specific action the target will perform. This generally
3838 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3839 * a specific name such as "com.android.camera.action.CROP. Only one
3840 * alternative of any particular action will be shown to the user, so using
3841 * a specific action like this makes sure that your alternative will be
3842 * displayed while also allowing other applications to provide their own
3843 * overrides of that particular action.
3844 */
3845 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3846 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3847 /**
3848 * Set if the activity should be considered as an alternative selection
3849 * action to the data the user has currently selected. This is like
3850 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3851 * of items from which the user can select, giving them alternatives to the
3852 * default action that will be performed on it.
3853 */
3854 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3855 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3856 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003857 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003858 */
3859 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3860 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3861 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003862 * Should be displayed in the top-level launcher.
3863 */
3864 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3865 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3866 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003867 * Indicates an activity optimized for Leanback mode, and that should
3868 * be displayed in the Leanback launcher.
3869 */
3870 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3871 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3872 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003873 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3874 * @hide
3875 */
3876 @SystemApi
3877 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3878 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003879 * Provides information about the package it is in; typically used if
3880 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3881 * a front-door to the user without having to be shown in the all apps list.
3882 */
3883 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3884 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3885 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 * This is the home activity, that is the first activity that is displayed
3887 * when the device boots.
3888 */
3889 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3890 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3891 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003892 * This is the home activity that is displayed when the device is finished setting up and ready
3893 * for use.
3894 * @hide
3895 */
3896 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3897 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3898 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003899 * This is the setup wizard activity, that is the first activity that is displayed
3900 * when the user sets up the device for the first time.
3901 * @hide
3902 */
3903 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3904 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3905 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003906 * This activity is a preference panel.
3907 */
3908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3909 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3910 /**
3911 * This activity is a development preference panel.
3912 */
3913 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3914 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3915 /**
3916 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003917 */
3918 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3919 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3920 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003921 * This activity allows the user to browse and download new applications.
3922 */
3923 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3924 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003926 * This activity may be exercised by the monkey or other automated test tools.
3927 */
3928 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3929 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3930 /**
3931 * To be used as a test (not part of the normal user experience).
3932 */
3933 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3934 /**
3935 * To be used as a unit test (run through the Test Harness).
3936 */
3937 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3938 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003939 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 * experience).
3941 */
3942 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003943
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003944 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003945 * Used to indicate that an intent only wants URIs that can be opened with
3946 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3947 * must support at least the columns defined in {@link OpenableColumns} when
3948 * queried.
3949 *
3950 * @see #ACTION_GET_CONTENT
3951 * @see #ACTION_OPEN_DOCUMENT
3952 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 */
3954 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3955 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3956
3957 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003958 * Used to indicate that an intent filter can accept files which are not necessarily
3959 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3960 * at least streamable via
3961 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3962 * using one of the stream types exposed via
3963 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3964 *
3965 * @see #ACTION_SEND
3966 * @see #ACTION_SEND_MULTIPLE
3967 */
3968 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3969 public static final String CATEGORY_TYPED_OPENABLE =
3970 "android.intent.category.TYPED_OPENABLE";
3971
3972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003973 * To be used as code under test for framework instrumentation tests.
3974 */
3975 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3976 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003977 /**
3978 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003979 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3980 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003981 */
3982 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3983 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3984 /**
3985 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003986 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3987 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003988 */
3989 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3990 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003991 /**
3992 * An activity to run when device is inserted into a analog (low end) dock.
3993 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3994 * information, see {@link android.app.UiModeManager}.
3995 */
3996 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3997 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3998
3999 /**
4000 * An activity to run when device is inserted into a digital (high end) dock.
4001 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4002 * information, see {@link android.app.UiModeManager}.
4003 */
4004 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4005 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004006
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004007 /**
4008 * Used to indicate that the activity can be used in a car environment.
4009 */
4010 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4011 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4012
Zak Cohendb6ca492017-01-26 14:09:00 -08004013 /**
4014 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4015 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4016 * information, see {@link android.app.UiModeManager}.
4017 */
4018 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4019 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004020 // ---------------------------------------------------------------------
4021 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004022 // Application launch intent categories (see addCategory()).
4023
4024 /**
4025 * Used with {@link #ACTION_MAIN} to launch the browser application.
4026 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004027 * <p>NOTE: This should not be used as the primary key of an Intent,
4028 * since it will not result in the app launching with the correct
4029 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004030 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004031 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004032 */
4033 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4034 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4035
4036 /**
4037 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4038 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004039 * <p>NOTE: This should not be used as the primary key of an Intent,
4040 * since it will not result in the app launching with the correct
4041 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004042 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004043 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004044 */
4045 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4046 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4047
4048 /**
4049 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4050 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004051 * <p>NOTE: This should not be used as the primary key of an Intent,
4052 * since it will not result in the app launching with the correct
4053 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004054 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004055 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004056 */
4057 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4058 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4059
4060 /**
4061 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4062 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004063 * <p>NOTE: This should not be used as the primary key of an Intent,
4064 * since it will not result in the app launching with the correct
4065 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004066 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004067 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004068 */
4069 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4070 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4071
4072 /**
4073 * Used with {@link #ACTION_MAIN} to launch the email application.
4074 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004075 * <p>NOTE: This should not be used as the primary key of an Intent,
4076 * since it will not result in the app launching with the correct
4077 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004078 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004079 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004080 */
4081 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4082 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4083
4084 /**
4085 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4086 * The activity should be able to view and manipulate image and video files
4087 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004088 * <p>NOTE: This should not be used as the primary key of an Intent,
4089 * since it will not result in the app launching with the correct
4090 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004091 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004092 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004093 */
4094 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4095 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4096
4097 /**
4098 * Used with {@link #ACTION_MAIN} to launch the maps application.
4099 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004100 * <p>NOTE: This should not be used as the primary key of an Intent,
4101 * since it will not result in the app launching with the correct
4102 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004103 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004104 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004105 */
4106 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4107 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4108
4109 /**
4110 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4111 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004112 * <p>NOTE: This should not be used as the primary key of an Intent,
4113 * since it will not result in the app launching with the correct
4114 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004115 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004116 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004117 */
4118 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4119 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4120
4121 /**
4122 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004123 * The activity should be able to play, browse, or manipulate music files
4124 * stored on the device.
4125 * <p>NOTE: This should not be used as the primary key of an Intent,
4126 * since it will not result in the app launching with the correct
4127 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004128 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004129 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004130 */
4131 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4132 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4133
4134 // ---------------------------------------------------------------------
4135 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004136 // Standard extra data keys.
4137
4138 /**
4139 * The initial data to place in a newly created record. Use with
4140 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4141 * fields as would be given to the underlying ContentProvider.insert()
4142 * call.
4143 */
4144 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4145
4146 /**
4147 * A constant CharSequence that is associated with the Intent, used with
4148 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4149 * this may be a styled CharSequence, so you must use
4150 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4151 * retrieve it.
4152 */
4153 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4154
4155 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004156 * A constant String that is associated with the Intent, used with
4157 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4158 * as HTML formatted text. Note that you <em>must</em> also supply
4159 * {@link #EXTRA_TEXT}.
4160 */
4161 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4162
4163 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004164 * A content: URI holding a stream of data associated with the Intent,
4165 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004166 */
4167 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4168
4169 /**
4170 * A String[] holding e-mail addresses that should be delivered to.
4171 */
4172 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4173
4174 /**
4175 * A String[] holding e-mail addresses that should be carbon copied.
4176 */
4177 public static final String EXTRA_CC = "android.intent.extra.CC";
4178
4179 /**
4180 * A String[] holding e-mail addresses that should be blind carbon copied.
4181 */
4182 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4183
4184 /**
4185 * A constant string holding the desired subject line of a message.
4186 */
4187 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4188
4189 /**
4190 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004191 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004192 */
4193 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4194
4195 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004196 * An int representing the user id to be used.
4197 *
4198 * @hide
4199 */
4200 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4201
4202 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004203 * An int representing the task id to be retrieved. This is used when a launch from recents is
4204 * intercepted by another action such as credentials confirmation to remember which task should
4205 * be resumed when complete.
4206 *
4207 * @hide
4208 */
4209 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4210
4211 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004212 * An Intent[] describing additional, alternate choices you would like shown with
4213 * {@link #ACTION_CHOOSER}.
4214 *
4215 * <p>An app may be capable of providing several different payload types to complete a
4216 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4217 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4218 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4219 * photo data or a hosted link where the photos can be viewed.</p>
4220 *
4221 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4222 * first/primary/preferred intent in the set. Additional intents specified in
4223 * this extra are ordered; by default intents that appear earlier in the array will be
4224 * preferred over intents that appear later in the array as matches for the same
4225 * target component. To alter this preference, a calling app may also supply
4226 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4227 */
4228 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4229
4230 /**
Adam Powell52c39212016-04-07 15:14:18 -07004231 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4232 * and omitted from a list of components presented to the user.
4233 *
4234 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4235 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4236 * from your own package or other apps from your organization if the idea of sending to those
4237 * targets would be redundant with other app functionality. Filtered components will not
4238 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4239 */
4240 public static final String EXTRA_EXCLUDE_COMPONENTS
4241 = "android.intent.extra.EXCLUDE_COMPONENTS";
4242
4243 /**
4244 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4245 * describing additional high-priority deep-link targets for the chooser to present to the user.
4246 *
4247 * <p>Targets provided in this way will be presented inline with all other targets provided
4248 * by services from other apps. They will be prioritized before other service targets, but
4249 * after those targets provided by sources that the user has manually pinned to the front.</p>
4250 *
4251 * @see #ACTION_CHOOSER
4252 */
4253 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4254
4255 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004256 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4257 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4258 *
4259 * <p>An app preparing an action for another app to complete may wish to allow the user to
4260 * disambiguate between several options for completing the action based on the chosen target
4261 * or otherwise refine the action before it is invoked.
4262 * </p>
4263 *
4264 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4265 * <ul>
4266 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4267 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4268 * chosen target beyond the first</li>
4269 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4270 * should fill in and send once the disambiguation is complete</li>
4271 * </ul>
4272 */
4273 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4274 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4275
4276 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004277 * An {@code ArrayList} of {@code String} annotations describing content for
4278 * {@link #ACTION_CHOOSER}.
4279 *
4280 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4281 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4282 *
4283 * <p>Annotations should describe the major components or topics of the content. It is up to
4284 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4285 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004286 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4287 * character. Performance on customized annotations can suffer, if they are rarely used for
4288 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4289 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004290 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004291 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004292 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004293 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004294 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004295 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004296 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004297 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004298 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004299 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4300 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4301 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4302 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4303 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004304 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004305 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4306 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004307 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004308 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004309 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004310 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004311 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004312 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004313 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004314 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004315 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004316 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004317 * Christmas and Thanksgiving.</li>
4318 * </ul>
4319 */
4320 public static final String EXTRA_CONTENT_ANNOTATIONS
4321 = "android.intent.extra.CONTENT_ANNOTATIONS";
4322
4323 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004324 * A {@link ResultReceiver} used to return data back to the sender.
4325 *
4326 * <p>Used to complete an app-specific
4327 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4328 *
4329 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4330 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4331 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4332 * when the user selects a target component from the chooser. It is up to the recipient
4333 * to send a result to this ResultReceiver to signal that disambiguation is complete
4334 * and that the chooser should invoke the user's choice.</p>
4335 *
4336 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4337 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4338 * to match and fill in the final Intent or ChooserTarget before starting it.
4339 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4340 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4341 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4342 *
4343 * <p>The result code passed to the ResultReceiver should be
4344 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4345 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4346 * the chooser should finish without starting a target.</p>
4347 */
4348 public static final String EXTRA_RESULT_RECEIVER
4349 = "android.intent.extra.RESULT_RECEIVER";
4350
4351 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004352 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004353 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004354 */
4355 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4356
4357 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004358 * A Parcelable[] of {@link Intent} or
4359 * {@link android.content.pm.LabeledIntent} objects as set with
4360 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4361 * a the front of the list of choices, when shown to the user with a
4362 * {@link #ACTION_CHOOSER}.
4363 */
4364 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4365
4366 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004367 * A {@link IntentSender} to start after ephemeral installation success.
4368 * @hide
4369 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004370 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4371
4372 /**
4373 * A {@link IntentSender} to start after ephemeral installation failure.
4374 * @hide
4375 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004376 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4377
4378 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004379 * The host name that triggered an ephemeral resolution.
4380 * @hide
4381 */
4382 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4383
4384 /**
4385 * An opaque token to track ephemeral resolution.
4386 * @hide
4387 */
4388 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4389
4390 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004391 * The version code of the app to install components from.
4392 * @hide
4393 */
4394 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4395
4396 /**
Chad Brubaker06068612017-04-06 09:43:47 -07004397 * The app that triggered the ephemeral installation.
4398 * @hide
4399 */
4400 public static final String EXTRA_CALLING_PACKAGE
4401 = "android.intent.extra.CALLING_PACKAGE";
4402
4403 /**
4404 * Optional calling app provided bundle containing additional launch information the
4405 * installer may use.
4406 * @hide
4407 */
4408 public static final String EXTRA_VERIFICATION_BUNDLE
4409 = "android.intent.extra.VERIFICATION_BUNDLE";
4410
4411 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004412 * A Bundle forming a mapping of potential target package names to different extras Bundles
4413 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4414 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4415 * be currently installed on the device.
4416 *
4417 * <p>An application may choose to provide alternate extras for the case where a user
4418 * selects an activity from a predetermined set of target packages. If the activity
4419 * the user selects from the chooser belongs to a package with its package name as
4420 * a key in this bundle, the corresponding extras for that package will be merged with
4421 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4422 * extra has the same key as an extra already present in the intent it will overwrite
4423 * the extra from the intent.</p>
4424 *
4425 * <p><em>Examples:</em>
4426 * <ul>
4427 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4428 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4429 * parameters for that target.</li>
4430 * <li>An application may offer additional metadata for known targets of a given intent
4431 * to pass along information only relevant to that target such as account or content
4432 * identifiers already known to that application.</li>
4433 * </ul></p>
4434 */
4435 public static final String EXTRA_REPLACEMENT_EXTRAS =
4436 "android.intent.extra.REPLACEMENT_EXTRAS";
4437
4438 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004439 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4440 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4441 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4442 * {@link ComponentName} of the chosen component.
4443 *
4444 * <p>In some situations this callback may never come, for example if the user abandons
4445 * the chooser, switches to another task or any number of other reasons. Apps should not
4446 * be written assuming that this callback will always occur.</p>
4447 */
4448 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4449 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4450
4451 /**
4452 * The {@link ComponentName} chosen by the user to complete an action.
4453 *
4454 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4455 */
4456 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4457
4458 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004459 * A {@link android.view.KeyEvent} object containing the event that
4460 * triggered the creation of the Intent it is in.
4461 */
4462 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4463
4464 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004465 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4466 * before shutting down.
4467 *
4468 * {@hide}
4469 */
4470 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4471
4472 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004473 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4474 * requested by the user.
4475 *
4476 * {@hide}
4477 */
4478 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4479 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4480
4481 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004482 * 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 -07004483 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4484 * of restarting the application.
4485 */
4486 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4487
4488 /**
4489 * A String holding the phone number originally entered in
4490 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4491 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4492 */
4493 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004494
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004495 /**
4496 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4497 * intents to supply the uid the package had been assigned. Also an optional
4498 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4499 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4500 * purpose.
4501 */
4502 public static final String EXTRA_UID = "android.intent.extra.UID";
4503
4504 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004505 * @hide String array of package names.
4506 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004507 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004508 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4509
4510 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004511 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4512 * intents to indicate whether this represents a full uninstall (removing
4513 * both the code and its data) or a partial uninstall (leaving its data,
4514 * implying that this is an update).
4515 */
4516 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004517
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004518 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004519 * @hide
4520 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4521 * intents to indicate that at this point the package has been removed for
4522 * all users on the device.
4523 */
4524 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4525 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4526
4527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004528 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4529 * intents to indicate that this is a replacement of the package, so this
4530 * broadcast will immediately be followed by an add broadcast for a
4531 * different version of the same package.
4532 */
4533 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004534
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004535 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004536 * Used as an int extra field in {@link android.app.AlarmManager} intents
4537 * to tell the application being invoked how many pending alarms are being
4538 * delievered with the intent. For one-shot alarms this will always be 1.
4539 * For recurring alarms, this might be greater than 1 if the device was
4540 * asleep or powered off at the time an earlier alarm would have been
4541 * delivered.
4542 */
4543 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004544
Jacek Surazski86b6c532009-05-13 14:38:28 +02004545 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004546 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4547 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004548 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4549 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004550 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4551 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4552 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004553 */
4554 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4555
4556 /**
4557 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4558 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004559 */
4560 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4561
4562 /**
4563 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4564 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004565 */
4566 public static final int EXTRA_DOCK_STATE_DESK = 1;
4567
4568 /**
4569 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4570 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004571 */
4572 public static final int EXTRA_DOCK_STATE_CAR = 2;
4573
4574 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004575 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4576 * to represent that the phone is in a analog (low end) dock.
4577 */
4578 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4579
4580 /**
4581 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4582 * to represent that the phone is in a digital (high end) dock.
4583 */
4584 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4585
4586 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004587 * Boolean that can be supplied as meta-data with a dock activity, to
4588 * indicate that the dock should take over the home key when it is active.
4589 */
4590 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004591
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004592 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004593 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4594 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004595 */
4596 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4597
4598 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004599 * Used in the extra field in the remote intent. It's astring token passed with the
4600 * remote intent.
4601 */
4602 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4603 "android.intent.extra.remote_intent_token";
4604
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004605 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004606 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004607 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004608 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004609 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004610 "android.intent.extra.changed_component_name";
4611
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004612 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004613 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004614 * and contains a string array of all of the components that have changed. If
4615 * the state of the overall package has changed, then it will contain an entry
4616 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004617 */
4618 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4619 "android.intent.extra.changed_component_name_list";
4620
4621 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004622 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004623 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004624 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4625 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4626 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004627 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004628 */
4629 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4630 "android.intent.extra.changed_package_list";
4631
4632 /**
4633 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004634 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4635 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004636 * and contains an integer array of uids of all of the components
4637 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004638 */
4639 public static final String EXTRA_CHANGED_UID_LIST =
4640 "android.intent.extra.changed_uid_list";
4641
4642 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004643 * @hide
4644 * Magic extra system code can use when binding, to give a label for
4645 * who it is that has bound to a service. This is an integer giving
4646 * a framework string resource that can be displayed to the user.
4647 */
4648 public static final String EXTRA_CLIENT_LABEL =
4649 "android.intent.extra.client_label";
4650
4651 /**
4652 * @hide
4653 * Magic extra system code can use when binding, to give a PendingIntent object
4654 * that can be launched for the user to disable the system's use of this
4655 * service.
4656 */
4657 public static final String EXTRA_CLIENT_INTENT =
4658 "android.intent.extra.client_intent";
4659
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004660 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004661 * Extra used to indicate that an intent should only return data that is on
4662 * the local device. This is a boolean extra; the default is false. If true,
4663 * an implementation should only allow the user to select data that is
4664 * already on the device, not requiring it be downloaded from a remote
4665 * service when opened.
4666 *
4667 * @see #ACTION_GET_CONTENT
4668 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004669 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004670 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004671 */
4672 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004673 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004674
Amith Yamasani13593602012-03-22 16:16:17 -07004675 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004676 * Extra used to indicate that an intent can allow the user to select and
4677 * return multiple items. This is a boolean extra; the default is false. If
4678 * true, an implementation is allowed to present the user with a UI where
4679 * they can pick multiple items that are all returned to the caller. When
4680 * this happens, they should be returned as the {@link #getClipData()} part
4681 * of the result Intent.
4682 *
4683 * @see #ACTION_GET_CONTENT
4684 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004685 */
4686 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004687 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004688
4689 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004690 * The integer userHandle carried with broadcast intents related to addition, removal and
4691 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4692 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4693 *
Amith Yamasani13593602012-03-22 16:16:17 -07004694 * @hide
4695 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004696 public static final String EXTRA_USER_HANDLE =
4697 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004698
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004699 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004700 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4701 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4702 */
4703 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004704 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004705
4706 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004707 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004708 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4709 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004710 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004711 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4712
4713 /**
4714 * Extra sent in the intent to the BroadcastReceiver that handles
4715 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4716 * the restrictions as key/value pairs.
4717 */
4718 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4719 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004720
Amith Yamasani86118ba2013-03-28 14:33:16 -07004721 /**
4722 * Extra used in the response from a BroadcastReceiver that handles
4723 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4724 */
4725 public static final String EXTRA_RESTRICTIONS_INTENT =
4726 "android.intent.extra.restrictions_intent";
4727
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004728 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004729 * Extra used to communicate a set of acceptable MIME types. The type of the
4730 * extra is {@code String[]}. Values may be a combination of concrete MIME
4731 * types (such as "image/png") and/or partial MIME types (such as
4732 * "audio/*").
4733 *
4734 * @see #ACTION_GET_CONTENT
4735 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004736 */
4737 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4738
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004739 /**
4740 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4741 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004742 * When this is true, hardware devices can use this information to determine that
4743 * they shouldn't do a complete shutdown of their device since this is not a
4744 * complete shutdown down to the kernel, but only user space restarting.
4745 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004746 */
4747 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4748 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4749
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004750 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004751 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4752 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4753 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4754 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004755 *
4756 * @hide for internal use only.
4757 */
4758 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4759 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004760 /** @hide */
4761 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4762 /** @hide */
4763 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4764 /** @hide */
4765 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004766
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004767 /** {@hide} */
4768 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4769
qingxi240c2bb2017-04-12 17:31:18 -07004770 /**
4771 * {@hide}
4772 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4773 */
Rubin Xue8490f12015-06-25 12:17:48 +01004774 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4775
Santos Cordon15a13782015-03-31 18:32:31 -07004776 /**
qingxi240c2bb2017-04-12 17:31:18 -07004777 * {@hide}
4778 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4779 * reset for the device with eSIM. This extra will be sent together with
4780 * {@link #ACTION_FACTORY_RESET}
4781 */
4782 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4783
4784 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004785 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4786 * activation request.
4787 * TODO: Add information about the structure and response data used with the pending intent.
4788 * @hide
4789 */
4790 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4791 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4792
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004793 /**
4794 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004795 *
4796 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004797 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004798 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004799 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4800
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004801 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004802 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4803 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4804 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004805 *
4806 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004807 * @see #ACTION_QUICK_VIEW
4808 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004809 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004810 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004811 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4812 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004813
4814 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004815 * An optional extra of {@code String[]} indicating which quick view features should be made
4816 * available to the user in the quick view UI while handing a
4817 * {@link Intent#ACTION_QUICK_VIEW} intent.
4818 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4819 * Quick viewer can implement features not listed below.
4820 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
4821 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD},
4822 * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}.
4823 * <p>
4824 * Requirements:
4825 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4826 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4827 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4828 * internal policies.
4829 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4830 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4831 * disable or hide features.
4832 *
4833 * @see #ACTION_QUICK_VIEW
4834 */
4835 public static final String EXTRA_QUICK_VIEW_FEATURES =
4836 "android.intent.extra.QUICK_VIEW_FEATURES";
4837
4838 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004839 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004840 * When a profile goes into quiet mode, all apps in the profile are killed and the
4841 * profile user is stopped. Widgets originating from the profile are masked, and app
4842 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004843 */
4844 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004845
4846 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004847 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004848 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004849 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4850 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004851 *
4852 * @hide
4853 */
4854 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4855 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4856
4857 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004858 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4859 * whether to show the chooser or not when there is only one application available
4860 * to choose from.
4861 *
4862 * @hide
4863 */
4864 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4865 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4866
4867 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004868 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004869 * to represent that a video codec is allowed to use.
4870 *
4871 * @hide
4872 */
4873 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4874
4875 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004876 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004877 * to represent that a audio codec is allowed to use.
4878 *
4879 * @hide
4880 */
4881 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004883 // ---------------------------------------------------------------------
4884 // ---------------------------------------------------------------------
4885 // Intent flags (see mFlags variable).
4886
Tor Norbyed9273d62013-05-30 15:59:53 -07004887 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004888 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004889 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4890 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004891 @Retention(RetentionPolicy.SOURCE)
4892 public @interface GrantUriMode {}
4893
Jeff Sharkey846318a2014-04-04 12:12:41 -07004894 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004895 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07004896 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4897 @Retention(RetentionPolicy.SOURCE)
4898 public @interface AccessUriMode {}
4899
4900 /**
4901 * Test if given mode flags specify an access mode, which must be at least
4902 * read and/or write.
4903 *
4904 * @hide
4905 */
4906 public static boolean isAccessUriMode(int modeFlags) {
4907 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4908 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4909 }
4910
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004911 /** @hide */
4912 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4913 FLAG_GRANT_READ_URI_PERMISSION,
4914 FLAG_GRANT_WRITE_URI_PERMISSION,
4915 FLAG_FROM_BACKGROUND,
4916 FLAG_DEBUG_LOG_RESOLUTION,
4917 FLAG_EXCLUDE_STOPPED_PACKAGES,
4918 FLAG_INCLUDE_STOPPED_PACKAGES,
4919 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
4920 FLAG_GRANT_PREFIX_URI_PERMISSION,
4921 FLAG_DEBUG_TRIAGED_MISSING,
4922 FLAG_IGNORE_EPHEMERAL,
4923 FLAG_ACTIVITY_NO_HISTORY,
4924 FLAG_ACTIVITY_SINGLE_TOP,
4925 FLAG_ACTIVITY_NEW_TASK,
4926 FLAG_ACTIVITY_MULTIPLE_TASK,
4927 FLAG_ACTIVITY_CLEAR_TOP,
4928 FLAG_ACTIVITY_FORWARD_RESULT,
4929 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
4930 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
4931 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
4932 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
4933 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
4934 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4935 FLAG_ACTIVITY_NEW_DOCUMENT,
4936 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4937 FLAG_ACTIVITY_NO_USER_ACTION,
4938 FLAG_ACTIVITY_REORDER_TO_FRONT,
4939 FLAG_ACTIVITY_NO_ANIMATION,
4940 FLAG_ACTIVITY_CLEAR_TASK,
4941 FLAG_ACTIVITY_TASK_ON_HOME,
4942 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
4943 FLAG_ACTIVITY_LAUNCH_ADJACENT,
4944 FLAG_RECEIVER_REGISTERED_ONLY,
4945 FLAG_RECEIVER_REPLACE_PENDING,
4946 FLAG_RECEIVER_FOREGROUND,
4947 FLAG_RECEIVER_NO_ABORT,
4948 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
4949 FLAG_RECEIVER_BOOT_UPGRADE,
4950 FLAG_RECEIVER_INCLUDE_BACKGROUND,
4951 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
4952 FLAG_RECEIVER_FROM_SHELL,
4953 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
4954 })
4955 @Retention(RetentionPolicy.SOURCE)
4956 public @interface Flags {}
4957
4958 /** @hide */
4959 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
4960 FLAG_FROM_BACKGROUND,
4961 FLAG_DEBUG_LOG_RESOLUTION,
4962 FLAG_EXCLUDE_STOPPED_PACKAGES,
4963 FLAG_INCLUDE_STOPPED_PACKAGES,
4964 FLAG_DEBUG_TRIAGED_MISSING,
4965 FLAG_IGNORE_EPHEMERAL,
4966 FLAG_ACTIVITY_NO_HISTORY,
4967 FLAG_ACTIVITY_SINGLE_TOP,
4968 FLAG_ACTIVITY_NEW_TASK,
4969 FLAG_ACTIVITY_MULTIPLE_TASK,
4970 FLAG_ACTIVITY_CLEAR_TOP,
4971 FLAG_ACTIVITY_FORWARD_RESULT,
4972 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
4973 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
4974 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
4975 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
4976 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
4977 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4978 FLAG_ACTIVITY_NEW_DOCUMENT,
4979 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
4980 FLAG_ACTIVITY_NO_USER_ACTION,
4981 FLAG_ACTIVITY_REORDER_TO_FRONT,
4982 FLAG_ACTIVITY_NO_ANIMATION,
4983 FLAG_ACTIVITY_CLEAR_TASK,
4984 FLAG_ACTIVITY_TASK_ON_HOME,
4985 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
4986 FLAG_ACTIVITY_LAUNCH_ADJACENT,
4987 FLAG_RECEIVER_REGISTERED_ONLY,
4988 FLAG_RECEIVER_REPLACE_PENDING,
4989 FLAG_RECEIVER_FOREGROUND,
4990 FLAG_RECEIVER_NO_ABORT,
4991 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
4992 FLAG_RECEIVER_BOOT_UPGRADE,
4993 FLAG_RECEIVER_INCLUDE_BACKGROUND,
4994 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
4995 FLAG_RECEIVER_FROM_SHELL,
4996 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
4997 })
4998 @Retention(RetentionPolicy.SOURCE)
4999 public @interface MutableFlags {}
5000
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005001 /**
5002 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005003 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005004 * specified in its ClipData. When applying to an Intent's ClipData,
5005 * all URIs as well as recursive traversals through data or other ClipData
5006 * in Intent items will be granted; only the grant flags of the top-level
5007 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005008 */
5009 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5010 /**
5011 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005012 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005013 * specified in its ClipData. When applying to an Intent's ClipData,
5014 * all URIs as well as recursive traversals through data or other ClipData
5015 * in Intent items will be granted; only the grant flags of the top-level
5016 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 */
5018 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5019 /**
5020 * Can be set by the caller to indicate that this Intent is coming from
5021 * a background operation, not from direct user interaction.
5022 */
5023 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5024 /**
5025 * A flag you can enable for debugging: when set, log messages will be
5026 * printed during the resolution of this intent to show you what has
5027 * been found to create the final resolved list.
5028 */
5029 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005030 /**
5031 * If set, this intent will not match any components in packages that
5032 * are currently stopped. If this is not set, then the default behavior
5033 * is to include such applications in the result.
5034 */
5035 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5036 /**
5037 * If set, this intent will always match any components in packages that
5038 * are currently stopped. This is the default behavior when
5039 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5040 * flags are set, this one wins (it allows overriding of exclude for
5041 * places where the framework may automatically set the exclude flag).
5042 */
5043 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005044
5045 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005046 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005047 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005048 * persisted across device reboots until explicitly revoked with
5049 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5050 * grant for possible persisting; the receiving application must call
5051 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5052 * actually persist.
5053 *
5054 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5055 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5056 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005057 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005058 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005059 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005060
5061 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005062 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5063 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5064 * applies to any URI that is a prefix match against the original granted
5065 * URI. (Without this flag, the URI must match exactly for access to be
5066 * granted.) Another URI is considered a prefix match only when scheme,
5067 * authority, and all path segments defined by the prefix are an exact
5068 * match.
5069 */
5070 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5071
5072 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005073 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005074 * homework and verified that they correctly handle packages and components
5075 * that come and go over time. In particular:
5076 * <ul>
5077 * <li>Apps installed on external storage, which will appear to be
5078 * uninstalled while the the device is ejected.
5079 * <li>Apps with encryption unaware components, which will appear to not
5080 * exist while the device is locked.
5081 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005082 *
5083 * @hide
5084 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005085 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005086
5087 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005088 * Internal flag used to indicate ephemeral applications should not be
5089 * considered when resolving the intent.
5090 *
5091 * @hide
5092 */
5093 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5094
5095 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005096 * If set, the new activity is not kept in the history stack. As soon as
5097 * the user navigates away from it, the activity is finished. This may also
5098 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5099 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005100 *
5101 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5102 * is never invoked when the current activity starts a new activity which
5103 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005104 */
5105 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5106 /**
5107 * If set, the activity will not be launched if it is already running
5108 * at the top of the history stack.
5109 */
5110 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5111 /**
5112 * If set, this activity will become the start of a new task on this
5113 * history stack. A task (from the activity that started it to the
5114 * next task activity) defines an atomic group of activities that the
5115 * user can move to. Tasks can be moved to the foreground and background;
5116 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005117 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005118 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5119 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005120 *
5121 * <p>This flag is generally used by activities that want
5122 * to present a "launcher" style behavior: they give the user a list of
5123 * separate things that can be done, which otherwise run completely
5124 * independently of the activity launching them.
5125 *
5126 * <p>When using this flag, if a task is already running for the activity
5127 * you are now starting, then a new activity will not be started; instead,
5128 * the current task will simply be brought to the front of the screen with
5129 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5130 * to disable this behavior.
5131 *
5132 * <p>This flag can not be used when the caller is requesting a result from
5133 * the activity being launched.
5134 */
5135 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5136 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005137 * This flag is used to create a new task and launch an activity into it.
5138 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5139 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5140 * search through existing tasks for ones matching this Intent. Only if no such
5141 * task is found would a new task be created. When paired with
5142 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5143 * the search for a matching task and unconditionally start a new task.
5144 *
5145 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5146 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005147 * top-level application launcher.</strong> Used in conjunction with
5148 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5149 * behavior of bringing an existing task to the foreground. When set,
5150 * a new task is <em>always</em> started to host the Activity for the
5151 * Intent, regardless of whether there is already an existing task running
5152 * the same thing.
5153 *
5154 * <p><strong>Because the default system does not include graphical task management,
5155 * you should not use this flag unless you provide some way for a user to
5156 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005157 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005158 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5159 * creating new document tasks.
5160 *
5161 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005162 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005163 *
Scott Main7aee61f2011-02-08 11:25:01 -08005164 * <p>See
5165 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5166 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005167 *
5168 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5169 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005170 */
5171 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5172 /**
5173 * If set, and the activity being launched is already running in the
5174 * current task, then instead of launching a new instance of that activity,
5175 * all of the other activities on top of it will be closed and this Intent
5176 * will be delivered to the (now on top) old activity as a new Intent.
5177 *
5178 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5179 * If D calls startActivity() with an Intent that resolves to the component
5180 * of activity B, then C and D will be finished and B receive the given
5181 * Intent, resulting in the stack now being: A, B.
5182 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005183 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005184 * either receive the new intent you are starting here in its
5185 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005186 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005187 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5188 * the same intent, then it will be finished and re-created; for all other
5189 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5190 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005191 *
5192 * <p>This launch mode can also be used to good effect in conjunction with
5193 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5194 * of a task, it will bring any currently running instance of that task
5195 * to the foreground, and then clear it to its root state. This is
5196 * especially useful, for example, when launching an activity from the
5197 * notification manager.
5198 *
Scott Main7aee61f2011-02-08 11:25:01 -08005199 * <p>See
5200 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5201 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005202 */
5203 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5204 /**
5205 * If set and this intent is being used to launch a new activity from an
5206 * existing one, then the reply target of the existing activity will be
5207 * transfered to the new activity. This way the new activity can call
5208 * {@link android.app.Activity#setResult} and have that result sent back to
5209 * the reply target of the original activity.
5210 */
5211 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5212 /**
5213 * If set and this intent is being used to launch a new activity from an
5214 * existing one, the current activity will not be counted as the top
5215 * activity for deciding whether the new intent should be delivered to
5216 * the top instead of starting a new one. The previous activity will
5217 * be used as the top, with the assumption being that the current activity
5218 * will finish itself immediately.
5219 */
5220 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5221 /**
5222 * If set, the new activity is not kept in the list of recently launched
5223 * activities.
5224 */
5225 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5226 /**
5227 * This flag is not normally set by application code, but set for you by
5228 * the system as described in the
5229 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5230 * launchMode} documentation for the singleTask mode.
5231 */
5232 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5233 /**
5234 * If set, and this activity is either being started in a new task or
5235 * bringing to the top an existing task, then it will be launched as
5236 * the front door of the task. This will result in the application of
5237 * any affinities needed to have that task in the proper state (either
5238 * moving activities to or from it), or simply resetting that task to
5239 * its initial state if needed.
5240 */
5241 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5242 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005243 * This flag is not normally set by application code, but set for you by
5244 * the system if this activity is being launched from history
5245 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005246 */
5247 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005248 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005249 * @deprecated As of API 21 this performs identically to
5250 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005251 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005252 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005253 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005254 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005255 * This flag is used to open a document into a new task rooted at the activity launched
5256 * by this Intent. Through the use of this flag, or its equivalent attribute,
5257 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005258 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005259 *
Craig Mautner026596b2014-05-21 15:35:44 -07005260 * <p>The use of the activity attribute form of this,
5261 * {@link android.R.attr#documentLaunchMode}, is
5262 * preferred over the Intent flag described here. The attribute form allows the
5263 * Activity to specify multiple document behavior for all launchers of the Activity
5264 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005265 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005266 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5267 * it is kept after the activity is finished is different than the use of
5268 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5269 * this flag is being used to create a new recents entry, then by default that entry
5270 * will be removed once the activity is finished. You can modify this behavior with
5271 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5272 *
Craig Mautner026596b2014-05-21 15:35:44 -07005273 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5274 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5275 * equivalent of the Activity manifest specifying {@link
5276 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5277 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5278 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005279 *
Craig Mautner026596b2014-05-21 15:35:44 -07005280 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005281 *
Craig Mautner026596b2014-05-21 15:35:44 -07005282 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005283 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5284 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005285 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005286 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005287 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005288 * callback from occurring on the current frontmost activity before it is
5289 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005290 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005291 * <p>Typically, an activity can rely on that callback to indicate that an
5292 * explicit user action has caused their activity to be moved out of the
5293 * foreground. The callback marks an appropriate point in the activity's
5294 * lifecycle for it to dismiss any notifications that it intends to display
5295 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005296 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005297 * <p>If an activity is ever started via any non-user-driven events such as
5298 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5299 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005300 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005301 */
5302 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005303 /**
5304 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5305 * this flag will cause the launched activity to be brought to the front of its
5306 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005307 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005308 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5309 * If D calls startActivity() with an Intent that resolves to the component
5310 * of activity B, then B will be brought to the front of the history stack,
5311 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005312 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005313 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005314 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005315 */
5316 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005317 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005318 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5319 * this flag will prevent the system from applying an activity transition
5320 * animation to go to the next activity state. This doesn't mean an
5321 * animation will never run -- if another activity change happens that doesn't
5322 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005323 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005324 * when you are going to do a series of activity operations but the
5325 * animation seen by the user shouldn't be driven by the first activity
5326 * change but rather a later one.
5327 */
5328 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5329 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005330 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5331 * this flag will cause any existing task that would be associated with the
5332 * activity to be cleared before the activity is started. That is, the activity
5333 * becomes the new root of an otherwise empty task, and any old activities
5334 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5335 */
5336 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5337 /**
5338 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5339 * this flag will cause a newly launching task to be placed on top of the current
5340 * home activity task (if there is one). That is, pressing back from the task
5341 * will always return the user to home even if that was not the last activity they
5342 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5343 */
5344 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5345 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005346 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5347 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005348 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005349 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005350 * this flag. When set and the task's activity is finished, the recents
5351 * entry will remain in the interface for the user to re-launch it, like a
5352 * recents entry for a top-level application.
5353 * <p>
5354 * The receiving activity can override this request with
5355 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5356 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005357 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005358 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005359 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005360
5361 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005362 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5363 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005364 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5365 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005366 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005367 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005368
5369 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005370 * If set, when sending a broadcast only registered receivers will be
5371 * called -- no BroadcastReceiver components will be launched.
5372 */
5373 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005374 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005375 * If set, when sending a broadcast the new broadcast will replace
5376 * any existing pending broadcast that matches it. Matching is defined
5377 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5378 * true for the intents of the two broadcasts. When a match is found,
5379 * the new broadcast (and receivers associated with it) will replace the
5380 * existing one in the pending broadcast list, remaining at the same
5381 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005382 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005383 * <p>This flag is most typically used with sticky broadcasts, which
5384 * only care about delivering the most recent values of the broadcast
5385 * to their receivers.
5386 */
5387 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5388 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005389 * If set, when sending a broadcast the recipient is allowed to run at
5390 * foreground priority, with a shorter timeout interval. During normal
5391 * broadcasts the receivers are not automatically hoisted out of the
5392 * background priority class.
5393 */
5394 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5395 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005396 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5397 * They can still propagate results through to later receivers, but they can not prevent
5398 * later receivers from seeing the broadcast.
5399 */
5400 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5401 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005402 * If set, when sending a broadcast <i>before boot has completed</i> only
5403 * registered receivers will be called -- no BroadcastReceiver components
5404 * will be launched. Sticky intent state will be recorded properly even
5405 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5406 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005407 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005408 * <p>This flag is only for use by system sevices as a convenience to
5409 * avoid having to implement a more complex mechanism around detection
5410 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005411 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005412 * @hide
5413 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005414 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005415 /**
5416 * Set when this broadcast is for a boot upgrade, a special mode that
5417 * allows the broadcast to be sent before the system is ready and launches
5418 * the app process with no providers running in it.
5419 * @hide
5420 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005421 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005422 /**
5423 * If set, the broadcast will always go to manifest receivers in background (cached
5424 * or not running) apps, regardless of whether that would be done by default. By
5425 * default they will only receive broadcasts if the broadcast has specified an
5426 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005427 *
5428 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5429 * the broadcast code there must also be changed to match.
5430 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005431 * @hide
5432 */
5433 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5434 /**
5435 * If set, the broadcast will never go to manifest receivers in background (cached
5436 * or not running) apps, regardless of whether that would be done by default. By
5437 * default they will receive broadcasts if the broadcast has specified an
5438 * explicit component or package name.
5439 * @hide
5440 */
5441 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005442 /**
5443 * If set, this broadcast is being sent from the shell.
5444 * @hide
5445 */
5446 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005447
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005448 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005449 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5450 * will not receive broadcasts.
5451 *
5452 * <em>This flag has no effect when used by an Instant App.</em>
5453 */
5454 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5455
5456 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005457 * @hide Flags that can't be changed with PendingIntent.
5458 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005459 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5460 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5461 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005462
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005463 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005464 // ---------------------------------------------------------------------
5465 // toUri() and parseUri() options.
5466
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005467 /** @hide */
5468 @IntDef(flag = true, prefix = { "URI_" }, value = {
5469 URI_ALLOW_UNSAFE,
5470 URI_ANDROID_APP_SCHEME,
5471 URI_INTENT_SCHEME,
5472 })
5473 @Retention(RetentionPolicy.SOURCE)
5474 public @interface UriFlags {}
5475
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005476 /**
5477 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5478 * always has the "intent:" scheme. This syntax can be used when you want
5479 * to later disambiguate between URIs that are intended to describe an
5480 * Intent vs. all others that should be treated as raw URIs. When used
5481 * with {@link #parseUri}, any other scheme will result in a generic
5482 * VIEW action for that raw URI.
5483 */
5484 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005485
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005486 /**
5487 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5488 * always has the "android-app:" scheme. This is a variation of
5489 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5490 * http/https URI being delivered to a specific package name. The format
5491 * is:
5492 *
5493 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005494 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005495 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005496 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5497 * you must also include a scheme; including a path also requires both a host and a scheme.
5498 * The final #Intent; fragment can be used without a scheme, host, or path.
5499 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005500 * used with intents that have a {@link #setSelector}, since the base intent
5501 * will always have an explicit package name.</p>
5502 *
5503 * <p>Some examples of how this scheme maps to Intent objects:</p>
5504 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5505 * <colgroup align="left" />
5506 * <colgroup align="left" />
5507 * <thead>
5508 * <tr><th>URI</th> <th>Intent</th></tr>
5509 * </thead>
5510 *
5511 * <tbody>
5512 * <tr><td><code>android-app://com.example.app</code></td>
5513 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5514 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5515 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5516 * </table></td>
5517 * </tr>
5518 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5519 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5520 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5521 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5522 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5523 * </table></td>
5524 * </tr>
5525 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5526 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5527 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5528 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5529 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5530 * </table></td>
5531 * </tr>
5532 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5533 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5534 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5535 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5536 * </table></td>
5537 * </tr>
5538 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5539 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5540 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5541 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5542 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5543 * </table></td>
5544 * </tr>
5545 * <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>
5546 * <td><table border="" style="margin:0" >
5547 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5548 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5549 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5550 * </table></td>
5551 * </tr>
5552 * </tbody>
5553 * </table>
5554 */
5555 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5556
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005557 /**
5558 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5559 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5560 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5561 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5562 * generated Intent can not cause unexpected data access to happen.
5563 *
5564 * <p>If you do not trust the source of the URI being parsed, you should still do further
5565 * processing to protect yourself from it. In particular, when using it to start an
5566 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5567 * that can handle it.</p>
5568 */
5569 public static final int URI_ALLOW_UNSAFE = 1<<2;
5570
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005571 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005572
5573 private String mAction;
5574 private Uri mData;
5575 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005576 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005577 private ComponentName mComponent;
5578 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005579 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005580 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005581 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005582 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005583 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005584 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005585 /** Token to track instant app launches. Local only; do not copy cross-process. */
5586 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587
5588 // ---------------------------------------------------------------------
5589
5590 /**
5591 * Create an empty intent.
5592 */
5593 public Intent() {
5594 }
5595
5596 /**
5597 * Copy constructor.
5598 */
5599 public Intent(Intent o) {
5600 this.mAction = o.mAction;
5601 this.mData = o.mData;
5602 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005603 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005604 this.mComponent = o.mComponent;
5605 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005606 this.mContentUserHint = o.mContentUserHint;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005607 this.mLaunchToken = o.mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005608 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005609 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005610 }
5611 if (o.mExtras != null) {
5612 this.mExtras = new Bundle(o.mExtras);
5613 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005614 if (o.mSourceBounds != null) {
5615 this.mSourceBounds = new Rect(o.mSourceBounds);
5616 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005617 if (o.mSelector != null) {
5618 this.mSelector = new Intent(o.mSelector);
5619 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005620 if (o.mClipData != null) {
5621 this.mClipData = new ClipData(o.mClipData);
5622 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005623 }
5624
5625 @Override
5626 public Object clone() {
5627 return new Intent(this);
5628 }
5629
5630 private Intent(Intent o, boolean all) {
5631 this.mAction = o.mAction;
5632 this.mData = o.mData;
5633 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005634 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005635 this.mComponent = o.mComponent;
5636 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005637 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005638 }
5639 }
5640
5641 /**
5642 * Make a clone of only the parts of the Intent that are relevant for
5643 * filter matching: the action, data, type, component, and categories.
5644 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005645 public @NonNull Intent cloneFilter() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005646 return new Intent(this, false);
5647 }
5648
5649 /**
5650 * Create an intent with a given action. All other fields (data, type,
5651 * class) are null. Note that the action <em>must</em> be in a
5652 * namespace because Intents are used globally in the system -- for
5653 * example the system VIEW action is android.intent.action.VIEW; an
5654 * application's custom action would be something like
5655 * com.google.app.myapp.CUSTOM_ACTION.
5656 *
5657 * @param action The Intent action, such as ACTION_VIEW.
5658 */
5659 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005660 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005661 }
5662
5663 /**
5664 * Create an intent with a given action and for a given data url. Note
5665 * that the action <em>must</em> be in a namespace because Intents are
5666 * used globally in the system -- for example the system VIEW action is
5667 * android.intent.action.VIEW; an application's custom action would be
5668 * something like com.google.app.myapp.CUSTOM_ACTION.
5669 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005670 * <p><em>Note: scheme and host name matching in the Android framework is
5671 * case-sensitive, unlike the formal RFC. As a result,
5672 * you should always ensure that you write your Uri with these elements
5673 * using lower case letters, and normalize any Uris you receive from
5674 * outside of Android to ensure the scheme and host is lower case.</em></p>
5675 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005676 * @param action The Intent action, such as ACTION_VIEW.
5677 * @param uri The Intent data URI.
5678 */
5679 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005680 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005681 mData = uri;
5682 }
5683
5684 /**
5685 * Create an intent for a specific component. All other fields (action, data,
5686 * type, class) are null, though they can be modified later with explicit
5687 * calls. This provides a convenient way to create an intent that is
5688 * intended to execute a hard-coded class name, rather than relying on the
5689 * system to find an appropriate class for you; see {@link #setComponent}
5690 * for more information on the repercussions of this.
5691 *
5692 * @param packageContext A Context of the application package implementing
5693 * this class.
5694 * @param cls The component class that is to be used for the intent.
5695 *
5696 * @see #setClass
5697 * @see #setComponent
5698 * @see #Intent(String, android.net.Uri , Context, Class)
5699 */
5700 public Intent(Context packageContext, Class<?> cls) {
5701 mComponent = new ComponentName(packageContext, cls);
5702 }
5703
5704 /**
5705 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005706 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005707 * construct the Intent and then calling {@link #setClass} to set its
5708 * class.
5709 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005710 * <p><em>Note: scheme and host name matching in the Android framework is
5711 * case-sensitive, unlike the formal RFC. As a result,
5712 * you should always ensure that you write your Uri with these elements
5713 * using lower case letters, and normalize any Uris you receive from
5714 * outside of Android to ensure the scheme and host is lower case.</em></p>
5715 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005716 * @param action The Intent action, such as ACTION_VIEW.
5717 * @param uri The Intent data URI.
5718 * @param packageContext A Context of the application package implementing
5719 * this class.
5720 * @param cls The component class that is to be used for the intent.
5721 *
5722 * @see #Intent(String, android.net.Uri)
5723 * @see #Intent(Context, Class)
5724 * @see #setClass
5725 * @see #setComponent
5726 */
5727 public Intent(String action, Uri uri,
5728 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005729 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005730 mData = uri;
5731 mComponent = new ComponentName(packageContext, cls);
5732 }
5733
5734 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005735 * Create an intent to launch the main (root) activity of a task. This
5736 * is the Intent that is started when the application's is launched from
5737 * Home. For anything else that wants to launch an application in the
5738 * same way, it is important that they use an Intent structured the same
5739 * way, and can use this function to ensure this is the case.
5740 *
5741 * <p>The returned Intent has the given Activity component as its explicit
5742 * component, {@link #ACTION_MAIN} as its action, and includes the
5743 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5744 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5745 * to do that through {@link #addFlags(int)} on the returned Intent.
5746 *
5747 * @param mainActivity The main activity component that this Intent will
5748 * launch.
5749 * @return Returns a newly created Intent that can be used to launch the
5750 * activity as a main application entry.
5751 *
5752 * @see #setClass
5753 * @see #setComponent
5754 */
5755 public static Intent makeMainActivity(ComponentName mainActivity) {
5756 Intent intent = new Intent(ACTION_MAIN);
5757 intent.setComponent(mainActivity);
5758 intent.addCategory(CATEGORY_LAUNCHER);
5759 return intent;
5760 }
5761
5762 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005763 * Make an Intent for the main activity of an application, without
5764 * specifying a specific activity to run but giving a selector to find
5765 * the activity. This results in a final Intent that is structured
5766 * the same as when the application is launched from
5767 * Home. For anything else that wants to launch an application in the
5768 * same way, it is important that they use an Intent structured the same
5769 * way, and can use this function to ensure this is the case.
5770 *
5771 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5772 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5773 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5774 * to do that through {@link #addFlags(int)} on the returned Intent.
5775 *
5776 * @param selectorAction The action name of the Intent's selector.
5777 * @param selectorCategory The name of a category to add to the Intent's
5778 * selector.
5779 * @return Returns a newly created Intent that can be used to launch the
5780 * activity as a main application entry.
5781 *
5782 * @see #setSelector(Intent)
5783 */
5784 public static Intent makeMainSelectorActivity(String selectorAction,
5785 String selectorCategory) {
5786 Intent intent = new Intent(ACTION_MAIN);
5787 intent.addCategory(CATEGORY_LAUNCHER);
5788 Intent selector = new Intent();
5789 selector.setAction(selectorAction);
5790 selector.addCategory(selectorCategory);
5791 intent.setSelector(selector);
5792 return intent;
5793 }
5794
5795 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005796 * Make an Intent that can be used to re-launch an application's task
5797 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5798 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5799 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5800 *
5801 * @param mainActivity The activity component that is the root of the
5802 * task; this is the activity that has been published in the application's
5803 * manifest as the main launcher icon.
5804 *
5805 * @return Returns a newly created Intent that can be used to relaunch the
5806 * activity's task in its root state.
5807 */
5808 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5809 Intent intent = makeMainActivity(mainActivity);
5810 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5811 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5812 return intent;
5813 }
5814
5815 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005816 * Call {@link #parseUri} with 0 flags.
5817 * @deprecated Use {@link #parseUri} instead.
5818 */
5819 @Deprecated
5820 public static Intent getIntent(String uri) throws URISyntaxException {
5821 return parseUri(uri, 0);
5822 }
Tom Taylord4a47292009-12-21 13:59:18 -08005823
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005825 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005826 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005827 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005828 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005829 *
5830 * <p>The URI given here must not be relative -- that is, it must include
5831 * the scheme and full path.
5832 *
5833 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005834 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005835 *
5836 * @return Intent The newly created Intent object.
5837 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005838 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5839 * it bad (as parsed by the Uri class) or the Intent data within the
5840 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005841 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005842 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005843 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005844 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005845 int i = 0;
5846 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005847 final boolean androidApp = uri.startsWith("android-app:");
5848
5849 // Validate intent scheme if requested.
5850 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5851 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005852 Intent intent = new Intent(ACTION_VIEW);
5853 try {
5854 intent.setData(Uri.parse(uri));
5855 } catch (IllegalArgumentException e) {
5856 throw new URISyntaxException(uri, e.getMessage());
5857 }
5858 return intent;
5859 }
5860 }
Tom Taylord4a47292009-12-21 13:59:18 -08005861
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005862 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005863 // simple case
5864 if (i == -1) {
5865 if (!androidApp) {
5866 return new Intent(ACTION_VIEW, Uri.parse(uri));
5867 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005868
5869 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005870 } else if (!uri.startsWith("#Intent;", i)) {
5871 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005872 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005873 } else {
5874 i = -1;
5875 }
5876 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005877
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005878 // new format
5879 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005880 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005881 boolean explicitAction = false;
5882 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005883
5884 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005885 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005886 String data;
5887 if (i >= 0) {
5888 data = uri.substring(0, i);
5889 i += 8; // length of "#Intent;"
5890 } else {
5891 data = uri;
5892 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005893
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005894 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005895 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005896 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005897 if (eq < 0) eq = i-1;
5898 int semi = uri.indexOf(';', i);
5899 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005900
5901 // action
5902 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005903 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005904 if (!inSelector) {
5905 explicitAction = true;
5906 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907 }
5908
5909 // categories
5910 else if (uri.startsWith("category=", i)) {
5911 intent.addCategory(value);
5912 }
5913
5914 // type
5915 else if (uri.startsWith("type=", i)) {
5916 intent.mType = value;
5917 }
5918
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005919 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005920 else if (uri.startsWith("launchFlags=", i)) {
5921 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005922 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5923 intent.mFlags &= ~IMMUTABLE_FLAGS;
5924 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005925 }
5926
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005927 // package
5928 else if (uri.startsWith("package=", i)) {
5929 intent.mPackage = value;
5930 }
5931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005932 // component
5933 else if (uri.startsWith("component=", i)) {
5934 intent.mComponent = ComponentName.unflattenFromString(value);
5935 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005936
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005937 // scheme
5938 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005939 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005940 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005941 } else {
5942 scheme = value;
5943 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005944 }
5945
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005946 // source bounds
5947 else if (uri.startsWith("sourceBounds=", i)) {
5948 intent.mSourceBounds = Rect.unflattenFromString(value);
5949 }
5950
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005951 // selector
5952 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5953 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005954 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005955 }
5956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005957 // extra
5958 else {
5959 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005960 // create Bundle if it doesn't already exist
5961 if (intent.mExtras == null) intent.mExtras = new Bundle();
5962 Bundle b = intent.mExtras;
5963 // add EXTRA
5964 if (uri.startsWith("S.", i)) b.putString(key, value);
5965 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5966 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5967 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5968 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5969 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5970 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5971 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5972 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5973 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5974 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005976 // move to the next item
5977 i = semi + 1;
5978 }
5979
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005980 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005981 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005982 if (baseIntent.mPackage == null) {
5983 baseIntent.setSelector(intent);
5984 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005985 intent = baseIntent;
5986 }
5987
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005988 if (data != null) {
5989 if (data.startsWith("intent:")) {
5990 data = data.substring(7);
5991 if (scheme != null) {
5992 data = scheme + ':' + data;
5993 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005994 } else if (data.startsWith("android-app:")) {
5995 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5996 // Correctly formed android-app, first part is package name.
5997 int end = data.indexOf('/', 14);
5998 if (end < 0) {
5999 // All we have is a package name.
6000 intent.mPackage = data.substring(14);
6001 if (!explicitAction) {
6002 intent.setAction(ACTION_MAIN);
6003 }
6004 data = "";
6005 } else {
6006 // Target the Intent at the given package name always.
6007 String authority = null;
6008 intent.mPackage = data.substring(14, end);
6009 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006010 if ((end+1) < data.length()) {
6011 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6012 // Found a scheme, remember it.
6013 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006014 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006015 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6016 // Found a authority, remember it.
6017 authority = data.substring(end+1, newEnd);
6018 end = newEnd;
6019 }
6020 } else {
6021 // All we have is a scheme.
6022 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006023 }
6024 }
6025 if (scheme == null) {
6026 // If there was no scheme, then this just targets the package.
6027 if (!explicitAction) {
6028 intent.setAction(ACTION_MAIN);
6029 }
6030 data = "";
6031 } else if (authority == null) {
6032 data = scheme + ":";
6033 } else {
6034 data = scheme + "://" + authority + data.substring(end);
6035 }
6036 }
6037 } else {
6038 data = "";
6039 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006040 }
Tom Taylord4a47292009-12-21 13:59:18 -08006041
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006042 if (data.length() > 0) {
6043 try {
6044 intent.mData = Uri.parse(data);
6045 } catch (IllegalArgumentException e) {
6046 throw new URISyntaxException(uri, e.getMessage());
6047 }
6048 }
6049 }
Tom Taylord4a47292009-12-21 13:59:18 -08006050
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006051 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006053 } catch (IndexOutOfBoundsException e) {
6054 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6055 }
6056 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006058 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006059 return getIntentOld(uri, 0);
6060 }
6061
6062 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 Intent intent;
6064
6065 int i = uri.lastIndexOf('#');
6066 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006067 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006068 final int intentFragmentStart = i;
6069 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006070
6071 i++;
6072
6073 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006074 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006075 i += 7;
6076 int j = uri.indexOf(')', i);
6077 action = uri.substring(i, j);
6078 i = j + 1;
6079 }
6080
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006081 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006082
6083 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006084 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006085 i += 11;
6086 int j = uri.indexOf(')', i);
6087 while (i < j) {
6088 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006089 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006090 if (i < sep) {
6091 intent.addCategory(uri.substring(i, sep));
6092 }
6093 i = sep + 1;
6094 }
6095 i = j + 1;
6096 }
6097
6098 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006099 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006100 i += 5;
6101 int j = uri.indexOf(')', i);
6102 intent.mType = uri.substring(i, j);
6103 i = j + 1;
6104 }
6105
6106 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006107 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006108 i += 12;
6109 int j = uri.indexOf(')', i);
6110 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006111 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6112 intent.mFlags &= ~IMMUTABLE_FLAGS;
6113 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006114 i = j + 1;
6115 }
6116
6117 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006118 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006119 i += 10;
6120 int j = uri.indexOf(')', i);
6121 int sep = uri.indexOf('!', i);
6122 if (sep >= 0 && sep < j) {
6123 String pkg = uri.substring(i, sep);
6124 String cls = uri.substring(sep + 1, j);
6125 intent.mComponent = new ComponentName(pkg, cls);
6126 }
6127 i = j + 1;
6128 }
6129
6130 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006131 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006132 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006133
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134 final int closeParen = uri.indexOf(')', i);
6135 if (closeParen == -1) throw new URISyntaxException(uri,
6136 "EXTRA missing trailing ')'", i);
6137
6138 while (i < closeParen) {
6139 // fetch the key value
6140 int j = uri.indexOf('=', i);
6141 if (j <= i + 1 || i >= closeParen) {
6142 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6143 }
6144 char type = uri.charAt(i);
6145 i++;
6146 String key = uri.substring(i, j);
6147 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006148
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006149 // get type-value
6150 j = uri.indexOf('!', i);
6151 if (j == -1 || j >= closeParen) j = closeParen;
6152 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6153 String value = uri.substring(i, j);
6154 i = j;
6155
6156 // create Bundle if it doesn't already exist
6157 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006158
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006159 // add item to bundle
6160 try {
6161 switch (type) {
6162 case 'S':
6163 intent.mExtras.putString(key, Uri.decode(value));
6164 break;
6165 case 'B':
6166 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6167 break;
6168 case 'b':
6169 intent.mExtras.putByte(key, Byte.parseByte(value));
6170 break;
6171 case 'c':
6172 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6173 break;
6174 case 'd':
6175 intent.mExtras.putDouble(key, Double.parseDouble(value));
6176 break;
6177 case 'f':
6178 intent.mExtras.putFloat(key, Float.parseFloat(value));
6179 break;
6180 case 'i':
6181 intent.mExtras.putInt(key, Integer.parseInt(value));
6182 break;
6183 case 'l':
6184 intent.mExtras.putLong(key, Long.parseLong(value));
6185 break;
6186 case 's':
6187 intent.mExtras.putShort(key, Short.parseShort(value));
6188 break;
6189 default:
6190 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6191 }
6192 } catch (NumberFormatException e) {
6193 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6194 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006195
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006196 char ch = uri.charAt(i);
6197 if (ch == ')') break;
6198 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6199 i++;
6200 }
6201 }
6202
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006203 if (isIntentFragment) {
6204 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6205 } else {
6206 intent.mData = Uri.parse(uri);
6207 }
Tom Taylord4a47292009-12-21 13:59:18 -08006208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006209 if (intent.mAction == null) {
6210 // By default, if no action is specified, then use VIEW.
6211 intent.mAction = ACTION_VIEW;
6212 }
6213
6214 } else {
6215 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6216 }
6217
6218 return intent;
6219 }
6220
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006221 /** @hide */
6222 public interface CommandOptionHandler {
6223 boolean handleOption(String opt, ShellCommand cmd);
6224 }
6225
6226 /** @hide */
6227 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6228 throws URISyntaxException {
6229 Intent intent = new Intent();
6230 Intent baseIntent = intent;
6231 boolean hasIntentInfo = false;
6232
6233 Uri data = null;
6234 String type = null;
6235
6236 String opt;
6237 while ((opt=cmd.getNextOption()) != null) {
6238 switch (opt) {
6239 case "-a":
6240 intent.setAction(cmd.getNextArgRequired());
6241 if (intent == baseIntent) {
6242 hasIntentInfo = true;
6243 }
6244 break;
6245 case "-d":
6246 data = Uri.parse(cmd.getNextArgRequired());
6247 if (intent == baseIntent) {
6248 hasIntentInfo = true;
6249 }
6250 break;
6251 case "-t":
6252 type = cmd.getNextArgRequired();
6253 if (intent == baseIntent) {
6254 hasIntentInfo = true;
6255 }
6256 break;
6257 case "-c":
6258 intent.addCategory(cmd.getNextArgRequired());
6259 if (intent == baseIntent) {
6260 hasIntentInfo = true;
6261 }
6262 break;
6263 case "-e":
6264 case "--es": {
6265 String key = cmd.getNextArgRequired();
6266 String value = cmd.getNextArgRequired();
6267 intent.putExtra(key, value);
6268 }
6269 break;
6270 case "--esn": {
6271 String key = cmd.getNextArgRequired();
6272 intent.putExtra(key, (String) null);
6273 }
6274 break;
6275 case "--ei": {
6276 String key = cmd.getNextArgRequired();
6277 String value = cmd.getNextArgRequired();
6278 intent.putExtra(key, Integer.decode(value));
6279 }
6280 break;
6281 case "--eu": {
6282 String key = cmd.getNextArgRequired();
6283 String value = cmd.getNextArgRequired();
6284 intent.putExtra(key, Uri.parse(value));
6285 }
6286 break;
6287 case "--ecn": {
6288 String key = cmd.getNextArgRequired();
6289 String value = cmd.getNextArgRequired();
6290 ComponentName cn = ComponentName.unflattenFromString(value);
6291 if (cn == null)
6292 throw new IllegalArgumentException("Bad component name: " + value);
6293 intent.putExtra(key, cn);
6294 }
6295 break;
6296 case "--eia": {
6297 String key = cmd.getNextArgRequired();
6298 String value = cmd.getNextArgRequired();
6299 String[] strings = value.split(",");
6300 int[] list = new int[strings.length];
6301 for (int i = 0; i < strings.length; i++) {
6302 list[i] = Integer.decode(strings[i]);
6303 }
6304 intent.putExtra(key, list);
6305 }
6306 break;
6307 case "--eial": {
6308 String key = cmd.getNextArgRequired();
6309 String value = cmd.getNextArgRequired();
6310 String[] strings = value.split(",");
6311 ArrayList<Integer> list = new ArrayList<>(strings.length);
6312 for (int i = 0; i < strings.length; i++) {
6313 list.add(Integer.decode(strings[i]));
6314 }
6315 intent.putExtra(key, list);
6316 }
6317 break;
6318 case "--el": {
6319 String key = cmd.getNextArgRequired();
6320 String value = cmd.getNextArgRequired();
6321 intent.putExtra(key, Long.valueOf(value));
6322 }
6323 break;
6324 case "--ela": {
6325 String key = cmd.getNextArgRequired();
6326 String value = cmd.getNextArgRequired();
6327 String[] strings = value.split(",");
6328 long[] list = new long[strings.length];
6329 for (int i = 0; i < strings.length; i++) {
6330 list[i] = Long.valueOf(strings[i]);
6331 }
6332 intent.putExtra(key, list);
6333 hasIntentInfo = true;
6334 }
6335 break;
6336 case "--elal": {
6337 String key = cmd.getNextArgRequired();
6338 String value = cmd.getNextArgRequired();
6339 String[] strings = value.split(",");
6340 ArrayList<Long> list = new ArrayList<>(strings.length);
6341 for (int i = 0; i < strings.length; i++) {
6342 list.add(Long.valueOf(strings[i]));
6343 }
6344 intent.putExtra(key, list);
6345 hasIntentInfo = true;
6346 }
6347 break;
6348 case "--ef": {
6349 String key = cmd.getNextArgRequired();
6350 String value = cmd.getNextArgRequired();
6351 intent.putExtra(key, Float.valueOf(value));
6352 hasIntentInfo = true;
6353 }
6354 break;
6355 case "--efa": {
6356 String key = cmd.getNextArgRequired();
6357 String value = cmd.getNextArgRequired();
6358 String[] strings = value.split(",");
6359 float[] list = new float[strings.length];
6360 for (int i = 0; i < strings.length; i++) {
6361 list[i] = Float.valueOf(strings[i]);
6362 }
6363 intent.putExtra(key, list);
6364 hasIntentInfo = true;
6365 }
6366 break;
6367 case "--efal": {
6368 String key = cmd.getNextArgRequired();
6369 String value = cmd.getNextArgRequired();
6370 String[] strings = value.split(",");
6371 ArrayList<Float> list = new ArrayList<>(strings.length);
6372 for (int i = 0; i < strings.length; i++) {
6373 list.add(Float.valueOf(strings[i]));
6374 }
6375 intent.putExtra(key, list);
6376 hasIntentInfo = true;
6377 }
6378 break;
6379 case "--esa": {
6380 String key = cmd.getNextArgRequired();
6381 String value = cmd.getNextArgRequired();
6382 // Split on commas unless they are preceeded by an escape.
6383 // The escape character must be escaped for the string and
6384 // again for the regex, thus four escape characters become one.
6385 String[] strings = value.split("(?<!\\\\),");
6386 intent.putExtra(key, strings);
6387 hasIntentInfo = true;
6388 }
6389 break;
6390 case "--esal": {
6391 String key = cmd.getNextArgRequired();
6392 String value = cmd.getNextArgRequired();
6393 // Split on commas unless they are preceeded by an escape.
6394 // The escape character must be escaped for the string and
6395 // again for the regex, thus four escape characters become one.
6396 String[] strings = value.split("(?<!\\\\),");
6397 ArrayList<String> list = new ArrayList<>(strings.length);
6398 for (int i = 0; i < strings.length; i++) {
6399 list.add(strings[i]);
6400 }
6401 intent.putExtra(key, list);
6402 hasIntentInfo = true;
6403 }
6404 break;
6405 case "--ez": {
6406 String key = cmd.getNextArgRequired();
6407 String value = cmd.getNextArgRequired().toLowerCase();
6408 // Boolean.valueOf() results in false for anything that is not "true", which is
6409 // error-prone in shell commands
6410 boolean arg;
6411 if ("true".equals(value) || "t".equals(value)) {
6412 arg = true;
6413 } else if ("false".equals(value) || "f".equals(value)) {
6414 arg = false;
6415 } else {
6416 try {
6417 arg = Integer.decode(value) != 0;
6418 } catch (NumberFormatException ex) {
6419 throw new IllegalArgumentException("Invalid boolean value: " + value);
6420 }
6421 }
6422
6423 intent.putExtra(key, arg);
6424 }
6425 break;
6426 case "-n": {
6427 String str = cmd.getNextArgRequired();
6428 ComponentName cn = ComponentName.unflattenFromString(str);
6429 if (cn == null)
6430 throw new IllegalArgumentException("Bad component name: " + str);
6431 intent.setComponent(cn);
6432 if (intent == baseIntent) {
6433 hasIntentInfo = true;
6434 }
6435 }
6436 break;
6437 case "-p": {
6438 String str = cmd.getNextArgRequired();
6439 intent.setPackage(str);
6440 if (intent == baseIntent) {
6441 hasIntentInfo = true;
6442 }
6443 }
6444 break;
6445 case "-f":
6446 String str = cmd.getNextArgRequired();
6447 intent.setFlags(Integer.decode(str).intValue());
6448 break;
6449 case "--grant-read-uri-permission":
6450 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6451 break;
6452 case "--grant-write-uri-permission":
6453 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6454 break;
6455 case "--grant-persistable-uri-permission":
6456 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6457 break;
6458 case "--grant-prefix-uri-permission":
6459 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6460 break;
6461 case "--exclude-stopped-packages":
6462 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6463 break;
6464 case "--include-stopped-packages":
6465 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6466 break;
6467 case "--debug-log-resolution":
6468 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6469 break;
6470 case "--activity-brought-to-front":
6471 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6472 break;
6473 case "--activity-clear-top":
6474 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6475 break;
6476 case "--activity-clear-when-task-reset":
6477 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6478 break;
6479 case "--activity-exclude-from-recents":
6480 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6481 break;
6482 case "--activity-launched-from-history":
6483 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6484 break;
6485 case "--activity-multiple-task":
6486 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6487 break;
6488 case "--activity-no-animation":
6489 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6490 break;
6491 case "--activity-no-history":
6492 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6493 break;
6494 case "--activity-no-user-action":
6495 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6496 break;
6497 case "--activity-previous-is-top":
6498 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6499 break;
6500 case "--activity-reorder-to-front":
6501 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6502 break;
6503 case "--activity-reset-task-if-needed":
6504 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6505 break;
6506 case "--activity-single-top":
6507 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6508 break;
6509 case "--activity-clear-task":
6510 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6511 break;
6512 case "--activity-task-on-home":
6513 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6514 break;
6515 case "--receiver-registered-only":
6516 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6517 break;
6518 case "--receiver-replace-pending":
6519 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6520 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006521 case "--receiver-foreground":
6522 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6523 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006524 case "--receiver-no-abort":
6525 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6526 break;
6527 case "--receiver-include-background":
6528 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6529 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006530 case "--selector":
6531 intent.setDataAndType(data, type);
6532 intent = new Intent();
6533 break;
6534 default:
6535 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6536 // Okay, caller handled this option.
6537 } else {
6538 throw new IllegalArgumentException("Unknown option: " + opt);
6539 }
6540 break;
6541 }
6542 }
6543 intent.setDataAndType(data, type);
6544
6545 final boolean hasSelector = intent != baseIntent;
6546 if (hasSelector) {
6547 // A selector was specified; fix up.
6548 baseIntent.setSelector(intent);
6549 intent = baseIntent;
6550 }
6551
6552 String arg = cmd.getNextArg();
6553 baseIntent = null;
6554 if (arg == null) {
6555 if (hasSelector) {
6556 // If a selector has been specified, and no arguments
6557 // have been supplied for the main Intent, then we can
6558 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6559 // need to have a component name specified yet, the
6560 // selector will take care of that.
6561 baseIntent = new Intent(Intent.ACTION_MAIN);
6562 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6563 }
6564 } else if (arg.indexOf(':') >= 0) {
6565 // The argument is a URI. Fully parse it, and use that result
6566 // to fill in any data not specified so far.
6567 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6568 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6569 } else if (arg.indexOf('/') >= 0) {
6570 // The argument is a component name. Build an Intent to launch
6571 // it.
6572 baseIntent = new Intent(Intent.ACTION_MAIN);
6573 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6574 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6575 } else {
6576 // Assume the argument is a package name.
6577 baseIntent = new Intent(Intent.ACTION_MAIN);
6578 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6579 baseIntent.setPackage(arg);
6580 }
6581 if (baseIntent != null) {
6582 Bundle extras = intent.getExtras();
6583 intent.replaceExtras((Bundle)null);
6584 Bundle uriExtras = baseIntent.getExtras();
6585 baseIntent.replaceExtras((Bundle)null);
6586 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6587 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6588 for (String c : cats) {
6589 baseIntent.removeCategory(c);
6590 }
6591 }
6592 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6593 if (extras == null) {
6594 extras = uriExtras;
6595 } else if (uriExtras != null) {
6596 uriExtras.putAll(extras);
6597 extras = uriExtras;
6598 }
6599 intent.replaceExtras(extras);
6600 hasIntentInfo = true;
6601 }
6602
6603 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6604 return intent;
6605 }
6606
6607 /** @hide */
6608 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6609 final String[] lines = new String[] {
6610 "<INTENT> specifications include these flags and arguments:",
6611 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6612 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6613 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6614 " [--esn <EXTRA_KEY> ...]",
6615 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6616 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6617 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6618 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6619 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6620 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6621 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6622 " (mutiple extras passed as Integer[])",
6623 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6624 " (mutiple extras passed as List<Integer>)",
6625 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6626 " (mutiple extras passed as Long[])",
6627 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6628 " (mutiple extras passed as List<Long>)",
6629 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6630 " (mutiple extras passed as Float[])",
6631 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6632 " (mutiple extras passed as List<Float>)",
6633 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6634 " (mutiple extras passed as String[]; to embed a comma into a string,",
6635 " escape it using \"\\,\")",
6636 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6637 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6638 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006639 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006640 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6641 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6642 " [--debug-log-resolution] [--exclude-stopped-packages]",
6643 " [--include-stopped-packages]",
6644 " [--activity-brought-to-front] [--activity-clear-top]",
6645 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6646 " [--activity-launched-from-history] [--activity-multiple-task]",
6647 " [--activity-no-animation] [--activity-no-history]",
6648 " [--activity-no-user-action] [--activity-previous-is-top]",
6649 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6650 " [--activity-single-top] [--activity-clear-task]",
6651 " [--activity-task-on-home]",
6652 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006653 " [--receiver-foreground] [--receiver-no-abort]",
6654 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006655 " [--selector]",
6656 " [<URI> | <PACKAGE> | <COMPONENT>]"
6657 };
6658 for (String line : lines) {
6659 pw.print(prefix);
6660 pw.println(line);
6661 }
6662 }
6663
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006664 /**
6665 * Retrieve the general action to be performed, such as
6666 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6667 * the information in the intent should be interpreted -- most importantly,
6668 * what to do with the data returned by {@link #getData}.
6669 *
6670 * @return The action of this intent or null if none is specified.
6671 *
6672 * @see #setAction
6673 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006674 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006675 return mAction;
6676 }
6677
6678 /**
6679 * Retrieve data this intent is operating on. This URI specifies the name
6680 * of the data; often it uses the content: scheme, specifying data in a
6681 * content provider. Other schemes may be handled by specific activities,
6682 * such as http: by the web browser.
6683 *
6684 * @return The URI of the data this intent is targeting or null.
6685 *
6686 * @see #getScheme
6687 * @see #setData
6688 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006689 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006690 return mData;
6691 }
6692
6693 /**
6694 * The same as {@link #getData()}, but returns the URI as an encoded
6695 * String.
6696 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006697 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006698 return mData != null ? mData.toString() : null;
6699 }
6700
6701 /**
6702 * Return the scheme portion of the intent's data. If the data is null or
6703 * does not include a scheme, null is returned. Otherwise, the scheme
6704 * prefix without the final ':' is returned, i.e. "http".
6705 *
6706 * <p>This is the same as calling getData().getScheme() (and checking for
6707 * null data).
6708 *
6709 * @return The scheme of this intent.
6710 *
6711 * @see #getData
6712 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006713 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006714 return mData != null ? mData.getScheme() : null;
6715 }
6716
6717 /**
6718 * Retrieve any explicit MIME type included in the intent. This is usually
6719 * null, as the type is determined by the intent data.
6720 *
6721 * @return If a type was manually set, it is returned; else null is
6722 * returned.
6723 *
6724 * @see #resolveType(ContentResolver)
6725 * @see #setType
6726 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006727 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006728 return mType;
6729 }
6730
6731 /**
6732 * Return the MIME data type of this intent. If the type field is
6733 * explicitly set, that is simply returned. Otherwise, if the data is set,
6734 * the type of that data is returned. If neither fields are set, a null is
6735 * returned.
6736 *
6737 * @return The MIME type of this intent.
6738 *
6739 * @see #getType
6740 * @see #resolveType(ContentResolver)
6741 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006742 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006743 return resolveType(context.getContentResolver());
6744 }
6745
6746 /**
6747 * Return the MIME data type of this intent. If the type field is
6748 * explicitly set, that is simply returned. Otherwise, if the data is set,
6749 * the type of that data is returned. If neither fields are set, a null is
6750 * returned.
6751 *
6752 * @param resolver A ContentResolver that can be used to determine the MIME
6753 * type of the intent's data.
6754 *
6755 * @return The MIME type of this intent.
6756 *
6757 * @see #getType
6758 * @see #resolveType(Context)
6759 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006760 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006761 if (mType != null) {
6762 return mType;
6763 }
6764 if (mData != null) {
6765 if ("content".equals(mData.getScheme())) {
6766 return resolver.getType(mData);
6767 }
6768 }
6769 return null;
6770 }
6771
6772 /**
6773 * Return the MIME data type of this intent, only if it will be needed for
6774 * intent resolution. This is not generally useful for application code;
6775 * it is used by the frameworks for communicating with back-end system
6776 * services.
6777 *
6778 * @param resolver A ContentResolver that can be used to determine the MIME
6779 * type of the intent's data.
6780 *
6781 * @return The MIME type of this intent, or null if it is unknown or not
6782 * needed.
6783 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006784 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006785 if (mComponent != null) {
6786 return mType;
6787 }
6788 return resolveType(resolver);
6789 }
6790
6791 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006792 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006793 *
6794 * @param category The category to check.
6795 *
6796 * @return boolean True if the intent contains the category, else false.
6797 *
6798 * @see #getCategories
6799 * @see #addCategory
6800 */
6801 public boolean hasCategory(String category) {
6802 return mCategories != null && mCategories.contains(category);
6803 }
6804
6805 /**
6806 * Return the set of all categories in the intent. If there are no categories,
6807 * returns NULL.
6808 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006809 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006810 *
6811 * @see #hasCategory
6812 * @see #addCategory
6813 */
6814 public Set<String> getCategories() {
6815 return mCategories;
6816 }
6817
6818 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006819 * Return the specific selector associated with this Intent. If there is
6820 * none, returns null. See {@link #setSelector} for more information.
6821 *
6822 * @see #setSelector
6823 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006824 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006825 return mSelector;
6826 }
6827
6828 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006829 * Return the {@link ClipData} associated with this Intent. If there is
6830 * none, returns null. See {@link #setClipData} for more information.
6831 *
John Spurlock125d1332013-11-25 11:58:37 -05006832 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006833 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006834 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006835 return mClipData;
6836 }
6837
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006838 /** @hide */
6839 public int getContentUserHint() {
6840 return mContentUserHint;
6841 }
6842
Todd Kennedyb3b431302017-03-20 16:05:48 -07006843 /** @hide */
6844 public String getLaunchToken() {
6845 return mLaunchToken;
6846 }
6847
6848 /** @hide */
6849 public void setLaunchToken(String launchToken) {
6850 mLaunchToken = launchToken;
6851 }
6852
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006853 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006854 * Sets the ClassLoader that will be used when unmarshalling
6855 * any Parcelable values from the extras of this Intent.
6856 *
6857 * @param loader a ClassLoader, or null to use the default loader
6858 * at the time of unmarshalling.
6859 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006860 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006861 if (mExtras != null) {
6862 mExtras.setClassLoader(loader);
6863 }
6864 }
6865
6866 /**
6867 * Returns true if an extra value is associated with the given name.
6868 * @param name the extra's name
6869 * @return true if the given extra is present.
6870 */
6871 public boolean hasExtra(String name) {
6872 return mExtras != null && mExtras.containsKey(name);
6873 }
6874
6875 /**
6876 * Returns true if the Intent's extras contain a parcelled file descriptor.
6877 * @return true if the Intent contains a parcelled file descriptor.
6878 */
6879 public boolean hasFileDescriptors() {
6880 return mExtras != null && mExtras.hasFileDescriptors();
6881 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006882
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006883 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006884 public void setAllowFds(boolean allowFds) {
6885 if (mExtras != null) {
6886 mExtras.setAllowFds(allowFds);
6887 }
6888 }
6889
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006890 /** {@hide} */
6891 public void setDefusable(boolean defusable) {
6892 if (mExtras != null) {
6893 mExtras.setDefusable(defusable);
6894 }
6895 }
6896
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006897 /**
6898 * Retrieve extended data from the intent.
6899 *
6900 * @param name The name of the desired item.
6901 *
6902 * @return the value of an item that previously added with putExtra()
6903 * or null if none was found.
6904 *
6905 * @deprecated
6906 * @hide
6907 */
6908 @Deprecated
6909 public Object getExtra(String name) {
6910 return getExtra(name, null);
6911 }
6912
6913 /**
6914 * Retrieve extended data from the intent.
6915 *
6916 * @param name The name of the desired item.
6917 * @param defaultValue the value to be returned if no value of the desired
6918 * type is stored with the given name.
6919 *
6920 * @return the value of an item that previously added with putExtra()
6921 * or the default value if none was found.
6922 *
6923 * @see #putExtra(String, boolean)
6924 */
6925 public boolean getBooleanExtra(String name, boolean defaultValue) {
6926 return mExtras == null ? defaultValue :
6927 mExtras.getBoolean(name, defaultValue);
6928 }
6929
6930 /**
6931 * Retrieve extended data from the intent.
6932 *
6933 * @param name The name of the desired item.
6934 * @param defaultValue the value to be returned if no value of the desired
6935 * type is stored with the given name.
6936 *
6937 * @return the value of an item that previously added with putExtra()
6938 * or the default value if none was found.
6939 *
6940 * @see #putExtra(String, byte)
6941 */
6942 public byte getByteExtra(String name, byte defaultValue) {
6943 return mExtras == null ? defaultValue :
6944 mExtras.getByte(name, defaultValue);
6945 }
6946
6947 /**
6948 * Retrieve extended data from the intent.
6949 *
6950 * @param name The name of the desired item.
6951 * @param defaultValue the value to be returned if no value of the desired
6952 * type is stored with the given name.
6953 *
6954 * @return the value of an item that previously added with putExtra()
6955 * or the default value if none was found.
6956 *
6957 * @see #putExtra(String, short)
6958 */
6959 public short getShortExtra(String name, short defaultValue) {
6960 return mExtras == null ? defaultValue :
6961 mExtras.getShort(name, defaultValue);
6962 }
6963
6964 /**
6965 * Retrieve extended data from the intent.
6966 *
6967 * @param name The name of the desired item.
6968 * @param defaultValue the value to be returned if no value of the desired
6969 * type is stored with the given name.
6970 *
6971 * @return the value of an item that previously added with putExtra()
6972 * or the default value if none was found.
6973 *
6974 * @see #putExtra(String, char)
6975 */
6976 public char getCharExtra(String name, char defaultValue) {
6977 return mExtras == null ? defaultValue :
6978 mExtras.getChar(name, defaultValue);
6979 }
6980
6981 /**
6982 * Retrieve extended data from the intent.
6983 *
6984 * @param name The name of the desired item.
6985 * @param defaultValue the value to be returned if no value of the desired
6986 * type is stored with the given name.
6987 *
6988 * @return the value of an item that previously added with putExtra()
6989 * or the default value if none was found.
6990 *
6991 * @see #putExtra(String, int)
6992 */
6993 public int getIntExtra(String name, int defaultValue) {
6994 return mExtras == null ? defaultValue :
6995 mExtras.getInt(name, defaultValue);
6996 }
6997
6998 /**
6999 * Retrieve extended data from the intent.
7000 *
7001 * @param name The name of the desired item.
7002 * @param defaultValue the value to be returned if no value of the desired
7003 * type is stored with the given name.
7004 *
7005 * @return the value of an item that previously added with putExtra()
7006 * or the default value if none was found.
7007 *
7008 * @see #putExtra(String, long)
7009 */
7010 public long getLongExtra(String name, long defaultValue) {
7011 return mExtras == null ? defaultValue :
7012 mExtras.getLong(name, defaultValue);
7013 }
7014
7015 /**
7016 * Retrieve extended data from the intent.
7017 *
7018 * @param name The name of the desired item.
7019 * @param defaultValue the value to be returned if no value of the desired
7020 * type is stored with the given name.
7021 *
7022 * @return the value of an item that previously added with putExtra(),
7023 * or the default value if no such item is present
7024 *
7025 * @see #putExtra(String, float)
7026 */
7027 public float getFloatExtra(String name, float defaultValue) {
7028 return mExtras == null ? defaultValue :
7029 mExtras.getFloat(name, defaultValue);
7030 }
7031
7032 /**
7033 * Retrieve extended data from the intent.
7034 *
7035 * @param name The name of the desired item.
7036 * @param defaultValue the value to be returned if no value of the desired
7037 * type is stored with the given name.
7038 *
7039 * @return the value of an item that previously added with putExtra()
7040 * or the default value if none was found.
7041 *
7042 * @see #putExtra(String, double)
7043 */
7044 public double getDoubleExtra(String name, double defaultValue) {
7045 return mExtras == null ? defaultValue :
7046 mExtras.getDouble(name, defaultValue);
7047 }
7048
7049 /**
7050 * Retrieve extended data from the intent.
7051 *
7052 * @param name The name of the desired item.
7053 *
7054 * @return the value of an item that previously added with putExtra()
7055 * or null if no String value was found.
7056 *
7057 * @see #putExtra(String, String)
7058 */
7059 public String getStringExtra(String name) {
7060 return mExtras == null ? null : mExtras.getString(name);
7061 }
7062
7063 /**
7064 * Retrieve extended data from the intent.
7065 *
7066 * @param name The name of the desired item.
7067 *
7068 * @return the value of an item that previously added with putExtra()
7069 * or null if no CharSequence value was found.
7070 *
7071 * @see #putExtra(String, CharSequence)
7072 */
7073 public CharSequence getCharSequenceExtra(String name) {
7074 return mExtras == null ? null : mExtras.getCharSequence(name);
7075 }
7076
7077 /**
7078 * Retrieve extended data from the intent.
7079 *
7080 * @param name The name of the desired item.
7081 *
7082 * @return the value of an item that previously added with putExtra()
7083 * or null if no Parcelable value was found.
7084 *
7085 * @see #putExtra(String, Parcelable)
7086 */
7087 public <T extends Parcelable> T getParcelableExtra(String name) {
7088 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7089 }
7090
7091 /**
7092 * Retrieve extended data from the intent.
7093 *
7094 * @param name The name of the desired item.
7095 *
7096 * @return the value of an item that previously added with putExtra()
7097 * or null if no Parcelable[] value was found.
7098 *
7099 * @see #putExtra(String, Parcelable[])
7100 */
7101 public Parcelable[] getParcelableArrayExtra(String name) {
7102 return mExtras == null ? null : mExtras.getParcelableArray(name);
7103 }
7104
7105 /**
7106 * Retrieve extended data from the intent.
7107 *
7108 * @param name The name of the desired item.
7109 *
7110 * @return the value of an item that previously added with putExtra()
7111 * or null if no ArrayList<Parcelable> value was found.
7112 *
7113 * @see #putParcelableArrayListExtra(String, ArrayList)
7114 */
7115 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7116 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7117 }
7118
7119 /**
7120 * Retrieve extended data from the intent.
7121 *
7122 * @param name The name of the desired item.
7123 *
7124 * @return the value of an item that previously added with putExtra()
7125 * or null if no Serializable value was found.
7126 *
7127 * @see #putExtra(String, Serializable)
7128 */
7129 public Serializable getSerializableExtra(String name) {
7130 return mExtras == null ? null : mExtras.getSerializable(name);
7131 }
7132
7133 /**
7134 * Retrieve extended data from the intent.
7135 *
7136 * @param name The name of the desired item.
7137 *
7138 * @return the value of an item that previously added with putExtra()
7139 * or null if no ArrayList<Integer> value was found.
7140 *
7141 * @see #putIntegerArrayListExtra(String, ArrayList)
7142 */
7143 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7144 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7145 }
7146
7147 /**
7148 * Retrieve extended data from the intent.
7149 *
7150 * @param name The name of the desired item.
7151 *
7152 * @return the value of an item that previously added with putExtra()
7153 * or null if no ArrayList<String> value was found.
7154 *
7155 * @see #putStringArrayListExtra(String, ArrayList)
7156 */
7157 public ArrayList<String> getStringArrayListExtra(String name) {
7158 return mExtras == null ? null : mExtras.getStringArrayList(name);
7159 }
7160
7161 /**
7162 * Retrieve extended data from the intent.
7163 *
7164 * @param name The name of the desired item.
7165 *
7166 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007167 * or null if no ArrayList<CharSequence> value was found.
7168 *
7169 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7170 */
7171 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7172 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7173 }
7174
7175 /**
7176 * Retrieve extended data from the intent.
7177 *
7178 * @param name The name of the desired item.
7179 *
7180 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007181 * or null if no boolean array value was found.
7182 *
7183 * @see #putExtra(String, boolean[])
7184 */
7185 public boolean[] getBooleanArrayExtra(String name) {
7186 return mExtras == null ? null : mExtras.getBooleanArray(name);
7187 }
7188
7189 /**
7190 * Retrieve extended data from the intent.
7191 *
7192 * @param name The name of the desired item.
7193 *
7194 * @return the value of an item that previously added with putExtra()
7195 * or null if no byte array value was found.
7196 *
7197 * @see #putExtra(String, byte[])
7198 */
7199 public byte[] getByteArrayExtra(String name) {
7200 return mExtras == null ? null : mExtras.getByteArray(name);
7201 }
7202
7203 /**
7204 * Retrieve extended data from the intent.
7205 *
7206 * @param name The name of the desired item.
7207 *
7208 * @return the value of an item that previously added with putExtra()
7209 * or null if no short array value was found.
7210 *
7211 * @see #putExtra(String, short[])
7212 */
7213 public short[] getShortArrayExtra(String name) {
7214 return mExtras == null ? null : mExtras.getShortArray(name);
7215 }
7216
7217 /**
7218 * Retrieve extended data from the intent.
7219 *
7220 * @param name The name of the desired item.
7221 *
7222 * @return the value of an item that previously added with putExtra()
7223 * or null if no char array value was found.
7224 *
7225 * @see #putExtra(String, char[])
7226 */
7227 public char[] getCharArrayExtra(String name) {
7228 return mExtras == null ? null : mExtras.getCharArray(name);
7229 }
7230
7231 /**
7232 * Retrieve extended data from the intent.
7233 *
7234 * @param name The name of the desired item.
7235 *
7236 * @return the value of an item that previously added with putExtra()
7237 * or null if no int array value was found.
7238 *
7239 * @see #putExtra(String, int[])
7240 */
7241 public int[] getIntArrayExtra(String name) {
7242 return mExtras == null ? null : mExtras.getIntArray(name);
7243 }
7244
7245 /**
7246 * Retrieve extended data from the intent.
7247 *
7248 * @param name The name of the desired item.
7249 *
7250 * @return the value of an item that previously added with putExtra()
7251 * or null if no long array value was found.
7252 *
7253 * @see #putExtra(String, long[])
7254 */
7255 public long[] getLongArrayExtra(String name) {
7256 return mExtras == null ? null : mExtras.getLongArray(name);
7257 }
7258
7259 /**
7260 * Retrieve extended data from the intent.
7261 *
7262 * @param name The name of the desired item.
7263 *
7264 * @return the value of an item that previously added with putExtra()
7265 * or null if no float array value was found.
7266 *
7267 * @see #putExtra(String, float[])
7268 */
7269 public float[] getFloatArrayExtra(String name) {
7270 return mExtras == null ? null : mExtras.getFloatArray(name);
7271 }
7272
7273 /**
7274 * Retrieve extended data from the intent.
7275 *
7276 * @param name The name of the desired item.
7277 *
7278 * @return the value of an item that previously added with putExtra()
7279 * or null if no double array value was found.
7280 *
7281 * @see #putExtra(String, double[])
7282 */
7283 public double[] getDoubleArrayExtra(String name) {
7284 return mExtras == null ? null : mExtras.getDoubleArray(name);
7285 }
7286
7287 /**
7288 * Retrieve extended data from the intent.
7289 *
7290 * @param name The name of the desired item.
7291 *
7292 * @return the value of an item that previously added with putExtra()
7293 * or null if no String array value was found.
7294 *
7295 * @see #putExtra(String, String[])
7296 */
7297 public String[] getStringArrayExtra(String name) {
7298 return mExtras == null ? null : mExtras.getStringArray(name);
7299 }
7300
7301 /**
7302 * Retrieve extended data from the intent.
7303 *
7304 * @param name The name of the desired item.
7305 *
7306 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007307 * or null if no CharSequence array value was found.
7308 *
7309 * @see #putExtra(String, CharSequence[])
7310 */
7311 public CharSequence[] getCharSequenceArrayExtra(String name) {
7312 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7313 }
7314
7315 /**
7316 * Retrieve extended data from the intent.
7317 *
7318 * @param name The name of the desired item.
7319 *
7320 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007321 * or null if no Bundle value was found.
7322 *
7323 * @see #putExtra(String, Bundle)
7324 */
7325 public Bundle getBundleExtra(String name) {
7326 return mExtras == null ? null : mExtras.getBundle(name);
7327 }
7328
7329 /**
7330 * Retrieve extended data from the intent.
7331 *
7332 * @param name The name of the desired item.
7333 *
7334 * @return the value of an item that previously added with putExtra()
7335 * or null if no IBinder value was found.
7336 *
7337 * @see #putExtra(String, IBinder)
7338 *
7339 * @deprecated
7340 * @hide
7341 */
7342 @Deprecated
7343 public IBinder getIBinderExtra(String name) {
7344 return mExtras == null ? null : mExtras.getIBinder(name);
7345 }
7346
7347 /**
7348 * Retrieve extended data from the intent.
7349 *
7350 * @param name The name of the desired item.
7351 * @param defaultValue The default value to return in case no item is
7352 * associated with the key 'name'
7353 *
7354 * @return the value of an item that previously added with putExtra()
7355 * or defaultValue if none was found.
7356 *
7357 * @see #putExtra
7358 *
7359 * @deprecated
7360 * @hide
7361 */
7362 @Deprecated
7363 public Object getExtra(String name, Object defaultValue) {
7364 Object result = defaultValue;
7365 if (mExtras != null) {
7366 Object result2 = mExtras.get(name);
7367 if (result2 != null) {
7368 result = result2;
7369 }
7370 }
7371
7372 return result;
7373 }
7374
7375 /**
7376 * Retrieves a map of extended data from the intent.
7377 *
7378 * @return the map of all extras previously added with putExtra(),
7379 * or null if none have been added.
7380 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007381 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007382 return (mExtras != null)
7383 ? new Bundle(mExtras)
7384 : null;
7385 }
7386
7387 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007388 * Filter extras to only basic types.
7389 * @hide
7390 */
7391 public void removeUnsafeExtras() {
7392 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007393 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007394 }
7395 }
7396
7397 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007398 * Retrieve any special flags associated with this intent. You will
7399 * normally just set them with {@link #setFlags} and let the system
7400 * take the appropriate action with them.
7401 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007402 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007403 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007404 * @see #addFlags
7405 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007406 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007407 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007408 return mFlags;
7409 }
7410
Dianne Hackborne7f97212011-02-24 14:40:20 -08007411 /** @hide */
7412 public boolean isExcludingStopped() {
7413 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7414 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7415 }
7416
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007417 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007418 * Retrieve the application package name this Intent is limited to. When
7419 * resolving an Intent, if non-null this limits the resolution to only
7420 * components in the given application package.
7421 *
7422 * @return The name of the application package for the Intent.
7423 *
7424 * @see #resolveActivity
7425 * @see #setPackage
7426 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007427 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007428 return mPackage;
7429 }
7430
7431 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007432 * Retrieve the concrete component associated with the intent. When receiving
7433 * an intent, this is the component that was found to best handle it (that is,
7434 * yourself) and will always be non-null; in all other cases it will be
7435 * null unless explicitly set.
7436 *
7437 * @return The name of the application component to handle the intent.
7438 *
7439 * @see #resolveActivity
7440 * @see #setComponent
7441 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007442 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007443 return mComponent;
7444 }
7445
7446 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007447 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7448 * used as a hint to the receiver for animations and the like. Null means that there
7449 * is no source bounds.
7450 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007451 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007452 return mSourceBounds;
7453 }
7454
7455 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007456 * Return the Activity component that should be used to handle this intent.
7457 * The appropriate component is determined based on the information in the
7458 * intent, evaluated as follows:
7459 *
7460 * <p>If {@link #getComponent} returns an explicit class, that is returned
7461 * without any further consideration.
7462 *
7463 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7464 * category to be considered.
7465 *
7466 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7467 * action.
7468 *
7469 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7470 * this type.
7471 *
7472 * <p>If {@link #addCategory} has added any categories, the activity must
7473 * handle ALL of the categories specified.
7474 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007475 * <p>If {@link #getPackage} is non-NULL, only activity components in
7476 * that application package will be considered.
7477 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007478 * <p>If there are no activities that satisfy all of these conditions, a
7479 * null string is returned.
7480 *
7481 * <p>If multiple activities are found to satisfy the intent, the one with
7482 * the highest priority will be used. If there are multiple activities
7483 * with the same priority, the system will either pick the best activity
7484 * based on user preference, or resolve to a system class that will allow
7485 * the user to pick an activity and forward from there.
7486 *
7487 * <p>This method is implemented simply by calling
7488 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7489 * true.</p>
7490 * <p> This API is called for you as part of starting an activity from an
7491 * intent. You do not normally need to call it yourself.</p>
7492 *
7493 * @param pm The package manager with which to resolve the Intent.
7494 *
7495 * @return Name of the component implementing an activity that can
7496 * display the intent.
7497 *
7498 * @see #setComponent
7499 * @see #getComponent
7500 * @see #resolveActivityInfo
7501 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007502 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007503 if (mComponent != null) {
7504 return mComponent;
7505 }
7506
7507 ResolveInfo info = pm.resolveActivity(
7508 this, PackageManager.MATCH_DEFAULT_ONLY);
7509 if (info != null) {
7510 return new ComponentName(
7511 info.activityInfo.applicationInfo.packageName,
7512 info.activityInfo.name);
7513 }
7514
7515 return null;
7516 }
7517
7518 /**
7519 * Resolve the Intent into an {@link ActivityInfo}
7520 * describing the activity that should execute the intent. Resolution
7521 * follows the same rules as described for {@link #resolveActivity}, but
7522 * you get back the completely information about the resolved activity
7523 * instead of just its class name.
7524 *
7525 * @param pm The package manager with which to resolve the Intent.
7526 * @param flags Addition information to retrieve as per
7527 * {@link PackageManager#getActivityInfo(ComponentName, int)
7528 * PackageManager.getActivityInfo()}.
7529 *
7530 * @return PackageManager.ActivityInfo
7531 *
7532 * @see #resolveActivity
7533 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007534 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7535 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007536 ActivityInfo ai = null;
7537 if (mComponent != null) {
7538 try {
7539 ai = pm.getActivityInfo(mComponent, flags);
7540 } catch (PackageManager.NameNotFoundException e) {
7541 // ignore
7542 }
7543 } else {
7544 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007545 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007546 if (info != null) {
7547 ai = info.activityInfo;
7548 }
7549 }
7550
7551 return ai;
7552 }
7553
7554 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007555 * Special function for use by the system to resolve service
7556 * intents to system apps. Throws an exception if there are
7557 * multiple potential matches to the Intent. Returns null if
7558 * there are no matches.
7559 * @hide
7560 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007561 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7562 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007563 if (mComponent != null) {
7564 return mComponent;
7565 }
7566
7567 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7568 if (results == null) {
7569 return null;
7570 }
7571 ComponentName comp = null;
7572 for (int i=0; i<results.size(); i++) {
7573 ResolveInfo ri = results.get(i);
7574 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7575 continue;
7576 }
7577 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7578 ri.serviceInfo.name);
7579 if (comp != null) {
7580 throw new IllegalStateException("Multiple system services handle " + this
7581 + ": " + comp + ", " + foundComp);
7582 }
7583 comp = foundComp;
7584 }
7585 return comp;
7586 }
7587
7588 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007589 * Set the general action to be performed.
7590 *
7591 * @param action An action name, such as ACTION_VIEW. Application-specific
7592 * actions should be prefixed with the vendor's package name.
7593 *
7594 * @return Returns the same Intent object, for chaining multiple calls
7595 * into a single statement.
7596 *
7597 * @see #getAction
7598 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007599 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007600 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007601 return this;
7602 }
7603
7604 /**
7605 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007606 * clears any type that was previously set by {@link #setType} or
7607 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007608 *
Nick Pellyccae4122012-01-09 14:12:58 -08007609 * <p><em>Note: scheme matching in the Android framework is
7610 * case-sensitive, unlike the formal RFC. As a result,
7611 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007612 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007613 * {@link #setDataAndNormalize}
7614 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007615 *
Nick Pellyccae4122012-01-09 14:12:58 -08007616 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007617 *
7618 * @return Returns the same Intent object, for chaining multiple calls
7619 * into a single statement.
7620 *
7621 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007622 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007623 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007624 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007625 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007626 mData = data;
7627 mType = null;
7628 return this;
7629 }
7630
7631 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007632 * Normalize and set the data this intent is operating on.
7633 *
7634 * <p>This method automatically clears any type that was
7635 * previously set (for example, by {@link #setType}).
7636 *
7637 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007638 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007639 * so really this is just a convenience method for
7640 * <pre>
7641 * setData(data.normalize())
7642 * </pre>
7643 *
7644 * @param data The Uri of the data this intent is now targeting.
7645 *
7646 * @return Returns the same Intent object, for chaining multiple calls
7647 * into a single statement.
7648 *
7649 * @see #getData
7650 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007651 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007652 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007653 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007654 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007655 }
7656
7657 /**
7658 * Set an explicit MIME data type.
7659 *
7660 * <p>This is used to create intents that only specify a type and not data,
7661 * for example to indicate the type of data to return.
7662 *
7663 * <p>This method automatically clears any data that was
7664 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007665 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007666 * <p><em>Note: MIME type matching in the Android framework is
7667 * case-sensitive, unlike formal RFC MIME types. As a result,
7668 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007669 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7670 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007671 *
7672 * @param type The MIME type of the data being handled by this intent.
7673 *
7674 * @return Returns the same Intent object, for chaining multiple calls
7675 * into a single statement.
7676 *
7677 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007678 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007679 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007680 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007681 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007682 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007683 mData = null;
7684 mType = type;
7685 return this;
7686 }
7687
7688 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007689 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007690 *
Nick Pellyccae4122012-01-09 14:12:58 -08007691 * <p>This is used to create intents that only specify a type and not data,
7692 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007693 *
Nick Pellyccae4122012-01-09 14:12:58 -08007694 * <p>This method automatically clears any data that was
7695 * previously set (for example by {@link #setData}).
7696 *
7697 * <p>The MIME type is normalized using
7698 * {@link #normalizeMimeType} before it is set,
7699 * so really this is just a convenience method for
7700 * <pre>
7701 * setType(Intent.normalizeMimeType(type))
7702 * </pre>
7703 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007704 * @param type The MIME type of the data being handled by this intent.
7705 *
7706 * @return Returns the same Intent object, for chaining multiple calls
7707 * into a single statement.
7708 *
Nick Pellyccae4122012-01-09 14:12:58 -08007709 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007710 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007711 * @see #normalizeMimeType
7712 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007713 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007714 return setType(normalizeMimeType(type));
7715 }
7716
7717 /**
7718 * (Usually optional) Set the data for the intent along with an explicit
7719 * MIME data type. This method should very rarely be used -- it allows you
7720 * to override the MIME type that would ordinarily be inferred from the
7721 * data with your own type given here.
7722 *
7723 * <p><em>Note: MIME type and Uri scheme matching in the
7724 * Android framework is case-sensitive, unlike the formal RFC definitions.
7725 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007726 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007727 * {@link #setDataAndTypeAndNormalize}
7728 * to ensure that they are converted to lower case.</em>
7729 *
7730 * @param data The Uri of the data this intent is now targeting.
7731 * @param type The MIME type of the data being handled by this intent.
7732 *
7733 * @return Returns the same Intent object, for chaining multiple calls
7734 * into a single statement.
7735 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007736 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007737 * @see #setData
7738 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007739 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007740 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007741 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007742 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007743 mData = data;
7744 mType = type;
7745 return this;
7746 }
7747
7748 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007749 * (Usually optional) Normalize and set both the data Uri and an explicit
7750 * MIME data type. This method should very rarely be used -- it allows you
7751 * to override the MIME type that would ordinarily be inferred from the
7752 * data with your own type given here.
7753 *
7754 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007755 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007756 * before they are set, so really this is just a convenience method for
7757 * <pre>
7758 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7759 * </pre>
7760 *
7761 * @param data The Uri of the data this intent is now targeting.
7762 * @param type The MIME type of the data being handled by this intent.
7763 *
7764 * @return Returns the same Intent object, for chaining multiple calls
7765 * into a single statement.
7766 *
7767 * @see #setType
7768 * @see #setData
7769 * @see #setDataAndType
7770 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007771 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007772 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007773 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007774 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007775 }
7776
7777 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007778 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007779 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007780 * activities that provide <em>all</em> of the requested categories will be
7781 * used.
7782 *
7783 * @param category The desired category. This can be either one of the
7784 * predefined Intent categories, or a custom category in your own
7785 * namespace.
7786 *
7787 * @return Returns the same Intent object, for chaining multiple calls
7788 * into a single statement.
7789 *
7790 * @see #hasCategory
7791 * @see #removeCategory
7792 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007793 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007794 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007795 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007796 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007797 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007798 return this;
7799 }
7800
7801 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007802 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007803 *
7804 * @param category The category to remove.
7805 *
7806 * @see #addCategory
7807 */
7808 public void removeCategory(String category) {
7809 if (mCategories != null) {
7810 mCategories.remove(category);
7811 if (mCategories.size() == 0) {
7812 mCategories = null;
7813 }
7814 }
7815 }
7816
7817 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007818 * Set a selector for this Intent. This is a modification to the kinds of
7819 * things the Intent will match. If the selector is set, it will be used
7820 * when trying to find entities that can handle the Intent, instead of the
7821 * main contents of the Intent. This allows you build an Intent containing
7822 * a generic protocol while targeting it more specifically.
7823 *
7824 * <p>An example of where this may be used is with things like
7825 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7826 * Intent that will launch the Browser application. However, the correct
7827 * main entry point of an application is actually {@link #ACTION_MAIN}
7828 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7829 * used to specify the actual Activity to launch. If you launch the browser
7830 * with something different, undesired behavior may happen if the user has
7831 * previously or later launches it the normal way, since they do not match.
7832 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7833 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7834 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7835 *
7836 * <p>Setting a selector does not impact the behavior of
7837 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7838 * desired behavior of a selector -- it does not impact the base meaning
7839 * of the Intent, just what kinds of things will be matched against it
7840 * when determining who can handle it.</p>
7841 *
7842 * <p>You can not use both a selector and {@link #setPackage(String)} on
7843 * the same base Intent.</p>
7844 *
7845 * @param selector The desired selector Intent; set to null to not use
7846 * a special selector.
7847 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007848 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007849 if (selector == this) {
7850 throw new IllegalArgumentException(
7851 "Intent being set as a selector of itself");
7852 }
7853 if (selector != null && mPackage != null) {
7854 throw new IllegalArgumentException(
7855 "Can't set selector when package name is already set");
7856 }
7857 mSelector = selector;
7858 }
7859
7860 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007861 * Set a {@link ClipData} associated with this Intent. This replaces any
7862 * previously set ClipData.
7863 *
7864 * <p>The ClipData in an intent is not used for Intent matching or other
7865 * such operations. Semantically it is like extras, used to transmit
7866 * additional data with the Intent. The main feature of using this over
7867 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7868 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7869 * items included in the clip data. This is useful, in particular, if
7870 * you want to transmit an Intent containing multiple <code>content:</code>
7871 * URIs for which the recipient may not have global permission to access the
7872 * content provider.
7873 *
7874 * <p>If the ClipData contains items that are themselves Intents, any
7875 * grant flags in those Intents will be ignored. Only the top-level flags
7876 * of the main Intent are respected, and will be applied to all Uri or
7877 * Intent items in the clip (or sub-items of the clip).
7878 *
7879 * <p>The MIME type, label, and icon in the ClipData object are not
7880 * directly used by Intent. Applications should generally rely on the
7881 * MIME type of the Intent itself, not what it may find in the ClipData.
7882 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007883 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007884 *
7885 * @param clip The new clip to set. May be null to clear the current clip.
7886 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007887 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007888 mClipData = clip;
7889 }
7890
7891 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007892 * This is NOT a secure mechanism to identify the user who sent the intent.
7893 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7894 * who sent the intent.
7895 * @hide
7896 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007897 public void prepareToLeaveUser(int userId) {
7898 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7899 // We want mContentUserHint to refer to the original user, so don't do anything.
7900 if (mContentUserHint == UserHandle.USER_CURRENT) {
7901 mContentUserHint = userId;
7902 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007903 }
7904
7905 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007906 * Add extended data to the intent. The name must include a package
7907 * prefix, for example the app com.android.contacts would use names
7908 * like "com.android.contacts.ShowAll".
7909 *
7910 * @param name The name of the extra data, with package prefix.
7911 * @param value The boolean data value.
7912 *
7913 * @return Returns the same Intent object, for chaining multiple calls
7914 * into a single statement.
7915 *
7916 * @see #putExtras
7917 * @see #removeExtra
7918 * @see #getBooleanExtra(String, boolean)
7919 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007920 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007921 if (mExtras == null) {
7922 mExtras = new Bundle();
7923 }
7924 mExtras.putBoolean(name, value);
7925 return this;
7926 }
7927
7928 /**
7929 * Add extended data to the intent. The name must include a package
7930 * prefix, for example the app com.android.contacts would use names
7931 * like "com.android.contacts.ShowAll".
7932 *
7933 * @param name The name of the extra data, with package prefix.
7934 * @param value The byte data value.
7935 *
7936 * @return Returns the same Intent object, for chaining multiple calls
7937 * into a single statement.
7938 *
7939 * @see #putExtras
7940 * @see #removeExtra
7941 * @see #getByteExtra(String, byte)
7942 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007943 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007944 if (mExtras == null) {
7945 mExtras = new Bundle();
7946 }
7947 mExtras.putByte(name, value);
7948 return this;
7949 }
7950
7951 /**
7952 * Add extended data to the intent. The name must include a package
7953 * prefix, for example the app com.android.contacts would use names
7954 * like "com.android.contacts.ShowAll".
7955 *
7956 * @param name The name of the extra data, with package prefix.
7957 * @param value The char data value.
7958 *
7959 * @return Returns the same Intent object, for chaining multiple calls
7960 * into a single statement.
7961 *
7962 * @see #putExtras
7963 * @see #removeExtra
7964 * @see #getCharExtra(String, char)
7965 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007966 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007967 if (mExtras == null) {
7968 mExtras = new Bundle();
7969 }
7970 mExtras.putChar(name, value);
7971 return this;
7972 }
7973
7974 /**
7975 * Add extended data to the intent. The name must include a package
7976 * prefix, for example the app com.android.contacts would use names
7977 * like "com.android.contacts.ShowAll".
7978 *
7979 * @param name The name of the extra data, with package prefix.
7980 * @param value The short data value.
7981 *
7982 * @return Returns the same Intent object, for chaining multiple calls
7983 * into a single statement.
7984 *
7985 * @see #putExtras
7986 * @see #removeExtra
7987 * @see #getShortExtra(String, short)
7988 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007989 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007990 if (mExtras == null) {
7991 mExtras = new Bundle();
7992 }
7993 mExtras.putShort(name, value);
7994 return this;
7995 }
7996
7997 /**
7998 * Add extended data to the intent. The name must include a package
7999 * prefix, for example the app com.android.contacts would use names
8000 * like "com.android.contacts.ShowAll".
8001 *
8002 * @param name The name of the extra data, with package prefix.
8003 * @param value The integer data value.
8004 *
8005 * @return Returns the same Intent object, for chaining multiple calls
8006 * into a single statement.
8007 *
8008 * @see #putExtras
8009 * @see #removeExtra
8010 * @see #getIntExtra(String, int)
8011 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008012 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008013 if (mExtras == null) {
8014 mExtras = new Bundle();
8015 }
8016 mExtras.putInt(name, value);
8017 return this;
8018 }
8019
8020 /**
8021 * Add extended data to the intent. The name must include a package
8022 * prefix, for example the app com.android.contacts would use names
8023 * like "com.android.contacts.ShowAll".
8024 *
8025 * @param name The name of the extra data, with package prefix.
8026 * @param value The long data value.
8027 *
8028 * @return Returns the same Intent object, for chaining multiple calls
8029 * into a single statement.
8030 *
8031 * @see #putExtras
8032 * @see #removeExtra
8033 * @see #getLongExtra(String, long)
8034 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008035 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008036 if (mExtras == null) {
8037 mExtras = new Bundle();
8038 }
8039 mExtras.putLong(name, value);
8040 return this;
8041 }
8042
8043 /**
8044 * Add extended data to the intent. The name must include a package
8045 * prefix, for example the app com.android.contacts would use names
8046 * like "com.android.contacts.ShowAll".
8047 *
8048 * @param name The name of the extra data, with package prefix.
8049 * @param value The float data value.
8050 *
8051 * @return Returns the same Intent object, for chaining multiple calls
8052 * into a single statement.
8053 *
8054 * @see #putExtras
8055 * @see #removeExtra
8056 * @see #getFloatExtra(String, float)
8057 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008058 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008059 if (mExtras == null) {
8060 mExtras = new Bundle();
8061 }
8062 mExtras.putFloat(name, value);
8063 return this;
8064 }
8065
8066 /**
8067 * Add extended data to the intent. The name must include a package
8068 * prefix, for example the app com.android.contacts would use names
8069 * like "com.android.contacts.ShowAll".
8070 *
8071 * @param name The name of the extra data, with package prefix.
8072 * @param value The double data value.
8073 *
8074 * @return Returns the same Intent object, for chaining multiple calls
8075 * into a single statement.
8076 *
8077 * @see #putExtras
8078 * @see #removeExtra
8079 * @see #getDoubleExtra(String, double)
8080 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008081 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008082 if (mExtras == null) {
8083 mExtras = new Bundle();
8084 }
8085 mExtras.putDouble(name, value);
8086 return this;
8087 }
8088
8089 /**
8090 * Add extended data to the intent. The name must include a package
8091 * prefix, for example the app com.android.contacts would use names
8092 * like "com.android.contacts.ShowAll".
8093 *
8094 * @param name The name of the extra data, with package prefix.
8095 * @param value The String data value.
8096 *
8097 * @return Returns the same Intent object, for chaining multiple calls
8098 * into a single statement.
8099 *
8100 * @see #putExtras
8101 * @see #removeExtra
8102 * @see #getStringExtra(String)
8103 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008104 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008105 if (mExtras == null) {
8106 mExtras = new Bundle();
8107 }
8108 mExtras.putString(name, value);
8109 return this;
8110 }
8111
8112 /**
8113 * Add extended data to the intent. The name must include a package
8114 * prefix, for example the app com.android.contacts would use names
8115 * like "com.android.contacts.ShowAll".
8116 *
8117 * @param name The name of the extra data, with package prefix.
8118 * @param value The CharSequence data value.
8119 *
8120 * @return Returns the same Intent object, for chaining multiple calls
8121 * into a single statement.
8122 *
8123 * @see #putExtras
8124 * @see #removeExtra
8125 * @see #getCharSequenceExtra(String)
8126 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008127 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008128 if (mExtras == null) {
8129 mExtras = new Bundle();
8130 }
8131 mExtras.putCharSequence(name, value);
8132 return this;
8133 }
8134
8135 /**
8136 * Add extended data to the intent. The name must include a package
8137 * prefix, for example the app com.android.contacts would use names
8138 * like "com.android.contacts.ShowAll".
8139 *
8140 * @param name The name of the extra data, with package prefix.
8141 * @param value The Parcelable data value.
8142 *
8143 * @return Returns the same Intent object, for chaining multiple calls
8144 * into a single statement.
8145 *
8146 * @see #putExtras
8147 * @see #removeExtra
8148 * @see #getParcelableExtra(String)
8149 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008150 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008151 if (mExtras == null) {
8152 mExtras = new Bundle();
8153 }
8154 mExtras.putParcelable(name, value);
8155 return this;
8156 }
8157
8158 /**
8159 * Add extended data to the intent. The name must include a package
8160 * prefix, for example the app com.android.contacts would use names
8161 * like "com.android.contacts.ShowAll".
8162 *
8163 * @param name The name of the extra data, with package prefix.
8164 * @param value The Parcelable[] data value.
8165 *
8166 * @return Returns the same Intent object, for chaining multiple calls
8167 * into a single statement.
8168 *
8169 * @see #putExtras
8170 * @see #removeExtra
8171 * @see #getParcelableArrayExtra(String)
8172 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008173 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008174 if (mExtras == null) {
8175 mExtras = new Bundle();
8176 }
8177 mExtras.putParcelableArray(name, value);
8178 return this;
8179 }
8180
8181 /**
8182 * Add extended data to the intent. The name must include a package
8183 * prefix, for example the app com.android.contacts would use names
8184 * like "com.android.contacts.ShowAll".
8185 *
8186 * @param name The name of the extra data, with package prefix.
8187 * @param value The ArrayList<Parcelable> data value.
8188 *
8189 * @return Returns the same Intent object, for chaining multiple calls
8190 * into a single statement.
8191 *
8192 * @see #putExtras
8193 * @see #removeExtra
8194 * @see #getParcelableArrayListExtra(String)
8195 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008196 public @NonNull Intent putParcelableArrayListExtra(String name,
8197 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 if (mExtras == null) {
8199 mExtras = new Bundle();
8200 }
8201 mExtras.putParcelableArrayList(name, value);
8202 return this;
8203 }
8204
8205 /**
8206 * Add extended data to the intent. The name must include a package
8207 * prefix, for example the app com.android.contacts would use names
8208 * like "com.android.contacts.ShowAll".
8209 *
8210 * @param name The name of the extra data, with package prefix.
8211 * @param value The ArrayList<Integer> data value.
8212 *
8213 * @return Returns the same Intent object, for chaining multiple calls
8214 * into a single statement.
8215 *
8216 * @see #putExtras
8217 * @see #removeExtra
8218 * @see #getIntegerArrayListExtra(String)
8219 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008220 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008221 if (mExtras == null) {
8222 mExtras = new Bundle();
8223 }
8224 mExtras.putIntegerArrayList(name, value);
8225 return this;
8226 }
8227
8228 /**
8229 * Add extended data to the intent. The name must include a package
8230 * prefix, for example the app com.android.contacts would use names
8231 * like "com.android.contacts.ShowAll".
8232 *
8233 * @param name The name of the extra data, with package prefix.
8234 * @param value The ArrayList<String> data value.
8235 *
8236 * @return Returns the same Intent object, for chaining multiple calls
8237 * into a single statement.
8238 *
8239 * @see #putExtras
8240 * @see #removeExtra
8241 * @see #getStringArrayListExtra(String)
8242 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008243 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008244 if (mExtras == null) {
8245 mExtras = new Bundle();
8246 }
8247 mExtras.putStringArrayList(name, value);
8248 return this;
8249 }
8250
8251 /**
8252 * Add extended data to the intent. The name must include a package
8253 * prefix, for example the app com.android.contacts would use names
8254 * like "com.android.contacts.ShowAll".
8255 *
8256 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008257 * @param value The ArrayList<CharSequence> data value.
8258 *
8259 * @return Returns the same Intent object, for chaining multiple calls
8260 * into a single statement.
8261 *
8262 * @see #putExtras
8263 * @see #removeExtra
8264 * @see #getCharSequenceArrayListExtra(String)
8265 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008266 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8267 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008268 if (mExtras == null) {
8269 mExtras = new Bundle();
8270 }
8271 mExtras.putCharSequenceArrayList(name, value);
8272 return this;
8273 }
8274
8275 /**
8276 * Add extended data to the intent. The name must include a package
8277 * prefix, for example the app com.android.contacts would use names
8278 * like "com.android.contacts.ShowAll".
8279 *
8280 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008281 * @param value The Serializable data value.
8282 *
8283 * @return Returns the same Intent object, for chaining multiple calls
8284 * into a single statement.
8285 *
8286 * @see #putExtras
8287 * @see #removeExtra
8288 * @see #getSerializableExtra(String)
8289 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008290 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008291 if (mExtras == null) {
8292 mExtras = new Bundle();
8293 }
8294 mExtras.putSerializable(name, value);
8295 return this;
8296 }
8297
8298 /**
8299 * Add extended data to the intent. The name must include a package
8300 * prefix, for example the app com.android.contacts would use names
8301 * like "com.android.contacts.ShowAll".
8302 *
8303 * @param name The name of the extra data, with package prefix.
8304 * @param value The boolean array data value.
8305 *
8306 * @return Returns the same Intent object, for chaining multiple calls
8307 * into a single statement.
8308 *
8309 * @see #putExtras
8310 * @see #removeExtra
8311 * @see #getBooleanArrayExtra(String)
8312 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008313 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008314 if (mExtras == null) {
8315 mExtras = new Bundle();
8316 }
8317 mExtras.putBooleanArray(name, value);
8318 return this;
8319 }
8320
8321 /**
8322 * Add extended data to the intent. The name must include a package
8323 * prefix, for example the app com.android.contacts would use names
8324 * like "com.android.contacts.ShowAll".
8325 *
8326 * @param name The name of the extra data, with package prefix.
8327 * @param value The byte array data value.
8328 *
8329 * @return Returns the same Intent object, for chaining multiple calls
8330 * into a single statement.
8331 *
8332 * @see #putExtras
8333 * @see #removeExtra
8334 * @see #getByteArrayExtra(String)
8335 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008336 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008337 if (mExtras == null) {
8338 mExtras = new Bundle();
8339 }
8340 mExtras.putByteArray(name, value);
8341 return this;
8342 }
8343
8344 /**
8345 * Add extended data to the intent. The name must include a package
8346 * prefix, for example the app com.android.contacts would use names
8347 * like "com.android.contacts.ShowAll".
8348 *
8349 * @param name The name of the extra data, with package prefix.
8350 * @param value The short array data value.
8351 *
8352 * @return Returns the same Intent object, for chaining multiple calls
8353 * into a single statement.
8354 *
8355 * @see #putExtras
8356 * @see #removeExtra
8357 * @see #getShortArrayExtra(String)
8358 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008359 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008360 if (mExtras == null) {
8361 mExtras = new Bundle();
8362 }
8363 mExtras.putShortArray(name, value);
8364 return this;
8365 }
8366
8367 /**
8368 * Add extended data to the intent. The name must include a package
8369 * prefix, for example the app com.android.contacts would use names
8370 * like "com.android.contacts.ShowAll".
8371 *
8372 * @param name The name of the extra data, with package prefix.
8373 * @param value The char array data value.
8374 *
8375 * @return Returns the same Intent object, for chaining multiple calls
8376 * into a single statement.
8377 *
8378 * @see #putExtras
8379 * @see #removeExtra
8380 * @see #getCharArrayExtra(String)
8381 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008382 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008383 if (mExtras == null) {
8384 mExtras = new Bundle();
8385 }
8386 mExtras.putCharArray(name, value);
8387 return this;
8388 }
8389
8390 /**
8391 * Add extended data to the intent. The name must include a package
8392 * prefix, for example the app com.android.contacts would use names
8393 * like "com.android.contacts.ShowAll".
8394 *
8395 * @param name The name of the extra data, with package prefix.
8396 * @param value The int array data value.
8397 *
8398 * @return Returns the same Intent object, for chaining multiple calls
8399 * into a single statement.
8400 *
8401 * @see #putExtras
8402 * @see #removeExtra
8403 * @see #getIntArrayExtra(String)
8404 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008405 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008406 if (mExtras == null) {
8407 mExtras = new Bundle();
8408 }
8409 mExtras.putIntArray(name, value);
8410 return this;
8411 }
8412
8413 /**
8414 * Add extended data to the intent. The name must include a package
8415 * prefix, for example the app com.android.contacts would use names
8416 * like "com.android.contacts.ShowAll".
8417 *
8418 * @param name The name of the extra data, with package prefix.
8419 * @param value The byte array data value.
8420 *
8421 * @return Returns the same Intent object, for chaining multiple calls
8422 * into a single statement.
8423 *
8424 * @see #putExtras
8425 * @see #removeExtra
8426 * @see #getLongArrayExtra(String)
8427 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008428 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008429 if (mExtras == null) {
8430 mExtras = new Bundle();
8431 }
8432 mExtras.putLongArray(name, value);
8433 return this;
8434 }
8435
8436 /**
8437 * Add extended data to the intent. The name must include a package
8438 * prefix, for example the app com.android.contacts would use names
8439 * like "com.android.contacts.ShowAll".
8440 *
8441 * @param name The name of the extra data, with package prefix.
8442 * @param value The float array data value.
8443 *
8444 * @return Returns the same Intent object, for chaining multiple calls
8445 * into a single statement.
8446 *
8447 * @see #putExtras
8448 * @see #removeExtra
8449 * @see #getFloatArrayExtra(String)
8450 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008451 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008452 if (mExtras == null) {
8453 mExtras = new Bundle();
8454 }
8455 mExtras.putFloatArray(name, value);
8456 return this;
8457 }
8458
8459 /**
8460 * Add extended data to the intent. The name must include a package
8461 * prefix, for example the app com.android.contacts would use names
8462 * like "com.android.contacts.ShowAll".
8463 *
8464 * @param name The name of the extra data, with package prefix.
8465 * @param value The double array data value.
8466 *
8467 * @return Returns the same Intent object, for chaining multiple calls
8468 * into a single statement.
8469 *
8470 * @see #putExtras
8471 * @see #removeExtra
8472 * @see #getDoubleArrayExtra(String)
8473 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008474 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008475 if (mExtras == null) {
8476 mExtras = new Bundle();
8477 }
8478 mExtras.putDoubleArray(name, value);
8479 return this;
8480 }
8481
8482 /**
8483 * Add extended data to the intent. The name must include a package
8484 * prefix, for example the app com.android.contacts would use names
8485 * like "com.android.contacts.ShowAll".
8486 *
8487 * @param name The name of the extra data, with package prefix.
8488 * @param value The String array data value.
8489 *
8490 * @return Returns the same Intent object, for chaining multiple calls
8491 * into a single statement.
8492 *
8493 * @see #putExtras
8494 * @see #removeExtra
8495 * @see #getStringArrayExtra(String)
8496 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008497 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008498 if (mExtras == null) {
8499 mExtras = new Bundle();
8500 }
8501 mExtras.putStringArray(name, value);
8502 return this;
8503 }
8504
8505 /**
8506 * Add extended data to the intent. The name must include a package
8507 * prefix, for example the app com.android.contacts would use names
8508 * like "com.android.contacts.ShowAll".
8509 *
8510 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008511 * @param value The CharSequence array data value.
8512 *
8513 * @return Returns the same Intent object, for chaining multiple calls
8514 * into a single statement.
8515 *
8516 * @see #putExtras
8517 * @see #removeExtra
8518 * @see #getCharSequenceArrayExtra(String)
8519 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008520 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008521 if (mExtras == null) {
8522 mExtras = new Bundle();
8523 }
8524 mExtras.putCharSequenceArray(name, value);
8525 return this;
8526 }
8527
8528 /**
8529 * Add extended data to the intent. The name must include a package
8530 * prefix, for example the app com.android.contacts would use names
8531 * like "com.android.contacts.ShowAll".
8532 *
8533 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008534 * @param value The Bundle data value.
8535 *
8536 * @return Returns the same Intent object, for chaining multiple calls
8537 * into a single statement.
8538 *
8539 * @see #putExtras
8540 * @see #removeExtra
8541 * @see #getBundleExtra(String)
8542 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008543 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008544 if (mExtras == null) {
8545 mExtras = new Bundle();
8546 }
8547 mExtras.putBundle(name, value);
8548 return this;
8549 }
8550
8551 /**
8552 * Add extended data to the intent. The name must include a package
8553 * prefix, for example the app com.android.contacts would use names
8554 * like "com.android.contacts.ShowAll".
8555 *
8556 * @param name The name of the extra data, with package prefix.
8557 * @param value The IBinder data value.
8558 *
8559 * @return Returns the same Intent object, for chaining multiple calls
8560 * into a single statement.
8561 *
8562 * @see #putExtras
8563 * @see #removeExtra
8564 * @see #getIBinderExtra(String)
8565 *
8566 * @deprecated
8567 * @hide
8568 */
8569 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008570 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008571 if (mExtras == null) {
8572 mExtras = new Bundle();
8573 }
8574 mExtras.putIBinder(name, value);
8575 return this;
8576 }
8577
8578 /**
8579 * Copy all extras in 'src' in to this intent.
8580 *
8581 * @param src Contains the extras to copy.
8582 *
8583 * @see #putExtra
8584 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008585 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008586 if (src.mExtras != null) {
8587 if (mExtras == null) {
8588 mExtras = new Bundle(src.mExtras);
8589 } else {
8590 mExtras.putAll(src.mExtras);
8591 }
8592 }
8593 return this;
8594 }
8595
8596 /**
8597 * Add a set of extended data to the intent. The keys must include a package
8598 * prefix, for example the app com.android.contacts would use names
8599 * like "com.android.contacts.ShowAll".
8600 *
8601 * @param extras The Bundle of extras to add to this intent.
8602 *
8603 * @see #putExtra
8604 * @see #removeExtra
8605 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008606 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008607 if (mExtras == null) {
8608 mExtras = new Bundle();
8609 }
8610 mExtras.putAll(extras);
8611 return this;
8612 }
8613
8614 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008615 * Completely replace the extras in the Intent with the extras in the
8616 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008617 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008618 * @param src The exact extras contained in this Intent are copied
8619 * into the target intent, replacing any that were previously there.
8620 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008621 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008622 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8623 return this;
8624 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008625
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008626 /**
8627 * Completely replace the extras in the Intent with the given Bundle of
8628 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008629 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008630 * @param extras The new set of extras in the Intent, or null to erase
8631 * all extras.
8632 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008633 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008634 mExtras = extras != null ? new Bundle(extras) : null;
8635 return this;
8636 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008637
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008638 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008639 * Remove extended data from the intent.
8640 *
8641 * @see #putExtra
8642 */
8643 public void removeExtra(String name) {
8644 if (mExtras != null) {
8645 mExtras.remove(name);
8646 if (mExtras.size() == 0) {
8647 mExtras = null;
8648 }
8649 }
8650 }
8651
8652 /**
8653 * Set special flags controlling how this intent is handled. Most values
8654 * here depend on the type of component being executed by the Intent,
8655 * specifically the FLAG_ACTIVITY_* flags are all for use with
8656 * {@link Context#startActivity Context.startActivity()} and the
8657 * FLAG_RECEIVER_* flags are all for use with
8658 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8659 *
Scott Main7aee61f2011-02-08 11:25:01 -08008660 * <p>See the
8661 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8662 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008663 * the behavior of your application.
8664 *
8665 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008666 * @return Returns the same Intent object, for chaining multiple calls
8667 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008668 * @see #getFlags
8669 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008670 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008671 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008672 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008673 mFlags = flags;
8674 return this;
8675 }
8676
8677 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008678 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 *
8680 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008681 * @return Returns the same Intent object, for chaining multiple calls into
8682 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008683 * @see #setFlags
8684 * @see #getFlags
8685 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008687 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008688 mFlags |= flags;
8689 return this;
8690 }
8691
8692 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008693 * Remove these flags from the intent.
8694 *
8695 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008696 * @see #setFlags
8697 * @see #getFlags
8698 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008699 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008700 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008701 mFlags &= ~flags;
8702 }
8703
8704 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008705 * (Usually optional) Set an explicit application package name that limits
8706 * the components this Intent will resolve to. If left to the default
8707 * value of null, all components in all applications will considered.
8708 * If non-null, the Intent can only match the components in the given
8709 * application package.
8710 *
8711 * @param packageName The name of the application package to handle the
8712 * intent, or null to allow any application package.
8713 *
8714 * @return Returns the same Intent object, for chaining multiple calls
8715 * into a single statement.
8716 *
8717 * @see #getPackage
8718 * @see #resolveActivity
8719 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008720 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008721 if (packageName != null && mSelector != null) {
8722 throw new IllegalArgumentException(
8723 "Can't set package name when selector is already set");
8724 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008725 mPackage = packageName;
8726 return this;
8727 }
8728
8729 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008730 * (Usually optional) Explicitly set the component to handle the intent.
8731 * If left with the default value of null, the system will determine the
8732 * appropriate class to use based on the other fields (action, data,
8733 * type, categories) in the Intent. If this class is defined, the
8734 * specified class will always be used regardless of the other fields. You
8735 * should only set this value when you know you absolutely want a specific
8736 * class to be used; otherwise it is better to let the system find the
8737 * appropriate class so that you will respect the installed applications
8738 * and user preferences.
8739 *
8740 * @param component The name of the application component to handle the
8741 * intent, or null to let the system find one for you.
8742 *
8743 * @return Returns the same Intent object, for chaining multiple calls
8744 * into a single statement.
8745 *
8746 * @see #setClass
8747 * @see #setClassName(Context, String)
8748 * @see #setClassName(String, String)
8749 * @see #getComponent
8750 * @see #resolveActivity
8751 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008752 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008753 mComponent = component;
8754 return this;
8755 }
8756
8757 /**
8758 * Convenience for calling {@link #setComponent} with an
8759 * explicit class name.
8760 *
8761 * @param packageContext A Context of the application package implementing
8762 * this class.
8763 * @param className The name of a class inside of the application package
8764 * that will be used as the component for this Intent.
8765 *
8766 * @return Returns the same Intent object, for chaining multiple calls
8767 * into a single statement.
8768 *
8769 * @see #setComponent
8770 * @see #setClass
8771 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008772 public @NonNull Intent setClassName(@NonNull Context packageContext,
8773 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008774 mComponent = new ComponentName(packageContext, className);
8775 return this;
8776 }
8777
8778 /**
8779 * Convenience for calling {@link #setComponent} with an
8780 * explicit application package name and class name.
8781 *
8782 * @param packageName The name of the package implementing the desired
8783 * component.
8784 * @param className The name of a class inside of the application package
8785 * that will be used as the component for this Intent.
8786 *
8787 * @return Returns the same Intent object, for chaining multiple calls
8788 * into a single statement.
8789 *
8790 * @see #setComponent
8791 * @see #setClass
8792 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008793 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008794 mComponent = new ComponentName(packageName, className);
8795 return this;
8796 }
8797
8798 /**
8799 * Convenience for calling {@link #setComponent(ComponentName)} with the
8800 * name returned by a {@link Class} object.
8801 *
8802 * @param packageContext A Context of the application package implementing
8803 * this class.
8804 * @param cls The class name to set, equivalent to
8805 * <code>setClassName(context, cls.getName())</code>.
8806 *
8807 * @return Returns the same Intent object, for chaining multiple calls
8808 * into a single statement.
8809 *
8810 * @see #setComponent
8811 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008812 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008813 mComponent = new ComponentName(packageContext, cls);
8814 return this;
8815 }
8816
8817 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008818 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8819 * used as a hint to the receiver for animations and the like. Null means that there
8820 * is no source bounds.
8821 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008822 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008823 if (r != null) {
8824 mSourceBounds = new Rect(r);
8825 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008826 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008827 }
8828 }
8829
Tor Norbyed9273d62013-05-30 15:59:53 -07008830 /** @hide */
8831 @IntDef(flag = true,
8832 value = {
8833 FILL_IN_ACTION,
8834 FILL_IN_DATA,
8835 FILL_IN_CATEGORIES,
8836 FILL_IN_COMPONENT,
8837 FILL_IN_PACKAGE,
8838 FILL_IN_SOURCE_BOUNDS,
8839 FILL_IN_SELECTOR,
8840 FILL_IN_CLIP_DATA
8841 })
8842 @Retention(RetentionPolicy.SOURCE)
8843 public @interface FillInFlags {}
8844
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008845 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008846 * Use with {@link #fillIn} to allow the current action value to be
8847 * overwritten, even if it is already set.
8848 */
8849 public static final int FILL_IN_ACTION = 1<<0;
8850
8851 /**
8852 * Use with {@link #fillIn} to allow the current data or type value
8853 * overwritten, even if it is already set.
8854 */
8855 public static final int FILL_IN_DATA = 1<<1;
8856
8857 /**
8858 * Use with {@link #fillIn} to allow the current categories to be
8859 * overwritten, even if they are already set.
8860 */
8861 public static final int FILL_IN_CATEGORIES = 1<<2;
8862
8863 /**
8864 * Use with {@link #fillIn} to allow the current component value to be
8865 * overwritten, even if it is already set.
8866 */
8867 public static final int FILL_IN_COMPONENT = 1<<3;
8868
8869 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008870 * Use with {@link #fillIn} to allow the current package value to be
8871 * overwritten, even if it is already set.
8872 */
8873 public static final int FILL_IN_PACKAGE = 1<<4;
8874
8875 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008876 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008877 * overwritten, even if it is already set.
8878 */
8879 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8880
8881 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008882 * Use with {@link #fillIn} to allow the current selector to be
8883 * overwritten, even if it is already set.
8884 */
8885 public static final int FILL_IN_SELECTOR = 1<<6;
8886
8887 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008888 * Use with {@link #fillIn} to allow the current ClipData to be
8889 * overwritten, even if it is already set.
8890 */
8891 public static final int FILL_IN_CLIP_DATA = 1<<7;
8892
8893 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008894 * Copy the contents of <var>other</var> in to this object, but only
8895 * where fields are not defined by this object. For purposes of a field
8896 * being defined, the following pieces of data in the Intent are
8897 * considered to be separate fields:
8898 *
8899 * <ul>
8900 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008901 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008902 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8903 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008904 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008905 * <li> component, as set by {@link #setComponent(ComponentName)} or
8906 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008907 * <li> source bounds, as set by {@link #setSourceBounds}.
8908 * <li> selector, as set by {@link #setSelector(Intent)}.
8909 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008910 * <li> each top-level name in the associated extras.
8911 * </ul>
8912 *
8913 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008914 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008915 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8916 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8917 * the restriction where the corresponding field will not be replaced if
8918 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008919 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008920 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8921 * is explicitly specified. The selector will only be copied if
8922 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008923 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008924 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8925 * and Intent B with {action="gotit", data-type="some/thing",
8926 * categories="one","two"}.
8927 *
8928 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8929 * containing: {action="gotit", data-type="some/thing",
8930 * categories="bar"}.
8931 *
8932 * @param other Another Intent whose values are to be used to fill in
8933 * the current one.
8934 * @param flags Options to control which fields can be filled in.
8935 *
8936 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008937 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008938 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008939 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008940 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008941 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008942 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008943 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008944 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008945 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008946 if (other.mAction != null
8947 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008948 mAction = other.mAction;
8949 changes |= FILL_IN_ACTION;
8950 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008951 if ((other.mData != null || other.mType != null)
8952 && ((mData == null && mType == null)
8953 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008954 mData = other.mData;
8955 mType = other.mType;
8956 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008957 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008958 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008959 if (other.mCategories != null
8960 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008961 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008962 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008963 }
8964 changes |= FILL_IN_CATEGORIES;
8965 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008966 if (other.mPackage != null
8967 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008968 // Only do this if mSelector is not set.
8969 if (mSelector == null) {
8970 mPackage = other.mPackage;
8971 changes |= FILL_IN_PACKAGE;
8972 }
8973 }
8974 // Selector is special: it can only be set if explicitly allowed,
8975 // for the same reason as the component name.
8976 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8977 if (mPackage == null) {
8978 mSelector = new Intent(other.mSelector);
8979 mPackage = null;
8980 changes |= FILL_IN_SELECTOR;
8981 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008982 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008983 if (other.mClipData != null
8984 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8985 mClipData = other.mClipData;
8986 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008987 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008988 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008989 // Component is special: it can -only- be set if explicitly allowed,
8990 // since otherwise the sender could force the intent somewhere the
8991 // originator didn't intend.
8992 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008993 mComponent = other.mComponent;
8994 changes |= FILL_IN_COMPONENT;
8995 }
8996 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008997 if (other.mSourceBounds != null
8998 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8999 mSourceBounds = new Rect(other.mSourceBounds);
9000 changes |= FILL_IN_SOURCE_BOUNDS;
9001 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009002 if (mExtras == null) {
9003 if (other.mExtras != null) {
9004 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009005 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009006 }
9007 } else if (other.mExtras != null) {
9008 try {
9009 Bundle newb = new Bundle(other.mExtras);
9010 newb.putAll(mExtras);
9011 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009012 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009013 } catch (RuntimeException e) {
9014 // Modifying the extras can cause us to unparcel the contents
9015 // of the bundle, and if we do this in the system process that
9016 // may fail. We really should handle this (i.e., the Bundle
9017 // impl shouldn't be on top of a plain map), but for now just
9018 // ignore it and keep the original contents. :(
9019 Log.w("Intent", "Failure filling in extras", e);
9020 }
9021 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009022 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9023 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9024 mContentUserHint = other.mContentUserHint;
9025 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009026 return changes;
9027 }
9028
9029 /**
9030 * Wrapper class holding an Intent and implementing comparisons on it for
9031 * the purpose of filtering. The class implements its
9032 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9033 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9034 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9035 * on the wrapped Intent.
9036 */
9037 public static final class FilterComparison {
9038 private final Intent mIntent;
9039 private final int mHashCode;
9040
9041 public FilterComparison(Intent intent) {
9042 mIntent = intent;
9043 mHashCode = intent.filterHashCode();
9044 }
9045
9046 /**
9047 * Return the Intent that this FilterComparison represents.
9048 * @return Returns the Intent held by the FilterComparison. Do
9049 * not modify!
9050 */
9051 public Intent getIntent() {
9052 return mIntent;
9053 }
9054
9055 @Override
9056 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009057 if (obj instanceof FilterComparison) {
9058 Intent other = ((FilterComparison)obj).mIntent;
9059 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009060 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009061 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009062 }
9063
9064 @Override
9065 public int hashCode() {
9066 return mHashCode;
9067 }
9068 }
9069
9070 /**
9071 * Determine if two intents are the same for the purposes of intent
9072 * resolution (filtering). That is, if their action, data, type,
9073 * class, and categories are the same. This does <em>not</em> compare
9074 * any extra data included in the intents.
9075 *
9076 * @param other The other Intent to compare against.
9077 *
9078 * @return Returns true if action, data, type, class, and categories
9079 * are the same.
9080 */
9081 public boolean filterEquals(Intent other) {
9082 if (other == null) {
9083 return false;
9084 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009085 if (!Objects.equals(this.mAction, other.mAction)) return false;
9086 if (!Objects.equals(this.mData, other.mData)) return false;
9087 if (!Objects.equals(this.mType, other.mType)) return false;
9088 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9089 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9090 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009091
9092 return true;
9093 }
9094
9095 /**
9096 * Generate hash code that matches semantics of filterEquals().
9097 *
9098 * @return Returns the hash value of the action, data, type, class, and
9099 * categories.
9100 *
9101 * @see #filterEquals
9102 */
9103 public int filterHashCode() {
9104 int code = 0;
9105 if (mAction != null) {
9106 code += mAction.hashCode();
9107 }
9108 if (mData != null) {
9109 code += mData.hashCode();
9110 }
9111 if (mType != null) {
9112 code += mType.hashCode();
9113 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009114 if (mPackage != null) {
9115 code += mPackage.hashCode();
9116 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009117 if (mComponent != null) {
9118 code += mComponent.hashCode();
9119 }
9120 if (mCategories != null) {
9121 code += mCategories.hashCode();
9122 }
9123 return code;
9124 }
9125
9126 @Override
9127 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009128 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009129
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009130 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009131 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009132 b.append(" }");
9133
9134 return b.toString();
9135 }
9136
9137 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009138 public String toInsecureString() {
9139 StringBuilder b = new StringBuilder(128);
9140
9141 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009142 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009143 b.append(" }");
9144
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009145 return b.toString();
9146 }
Romain Guy4969af72009-06-17 10:53:19 -07009147
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009148 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009149 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009150 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009151
9152 b.append("Intent { ");
9153 toShortString(b, false, true, true, true);
9154 b.append(" }");
9155
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009156 return b.toString();
9157 }
9158
9159 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009160 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9161 StringBuilder b = new StringBuilder(128);
9162 toShortString(b, secure, comp, extras, clip);
9163 return b.toString();
9164 }
9165
9166 /** @hide */
9167 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9168 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009169 boolean first = true;
9170 if (mAction != null) {
9171 b.append("act=").append(mAction);
9172 first = false;
9173 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009174 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009175 if (!first) {
9176 b.append(' ');
9177 }
9178 first = false;
9179 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009180 for (int i=0; i<mCategories.size(); i++) {
9181 if (i > 0) b.append(',');
9182 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009183 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009184 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009185 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009186 if (mData != null) {
9187 if (!first) {
9188 b.append(' ');
9189 }
9190 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009191 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009192 if (secure) {
9193 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009194 } else {
9195 b.append(mData);
9196 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009197 }
9198 if (mType != null) {
9199 if (!first) {
9200 b.append(' ');
9201 }
9202 first = false;
9203 b.append("typ=").append(mType);
9204 }
9205 if (mFlags != 0) {
9206 if (!first) {
9207 b.append(' ');
9208 }
9209 first = false;
9210 b.append("flg=0x").append(Integer.toHexString(mFlags));
9211 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009212 if (mPackage != null) {
9213 if (!first) {
9214 b.append(' ');
9215 }
9216 first = false;
9217 b.append("pkg=").append(mPackage);
9218 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009219 if (comp && mComponent != null) {
9220 if (!first) {
9221 b.append(' ');
9222 }
9223 first = false;
9224 b.append("cmp=").append(mComponent.flattenToShortString());
9225 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009226 if (mSourceBounds != null) {
9227 if (!first) {
9228 b.append(' ');
9229 }
9230 first = false;
9231 b.append("bnds=").append(mSourceBounds.toShortString());
9232 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009233 if (mClipData != null) {
9234 if (!first) {
9235 b.append(' ');
9236 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009237 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009238 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009239 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009240 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009241 if (mClipData.getDescription() != null) {
9242 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9243 } else {
9244 first = true;
9245 }
9246 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009247 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009248 first = false;
9249 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009250 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009251 if (extras && mExtras != null) {
9252 if (!first) {
9253 b.append(' ');
9254 }
9255 first = false;
9256 b.append("(has extras)");
9257 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009258 if (mContentUserHint != UserHandle.USER_CURRENT) {
9259 if (!first) {
9260 b.append(' ');
9261 }
9262 first = false;
9263 b.append("u=").append(mContentUserHint);
9264 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009265 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009266 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009267 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009268 b.append("}");
9269 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009270 }
9271
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009272 /**
9273 * Call {@link #toUri} with 0 flags.
9274 * @deprecated Use {@link #toUri} instead.
9275 */
9276 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009277 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009278 return toUri(0);
9279 }
9280
9281 /**
9282 * Convert this Intent into a String holding a URI representation of it.
9283 * The returned URI string has been properly URI encoded, so it can be
9284 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9285 * Intent's data as the base URI, with an additional fragment describing
9286 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009287 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009288 * <p>You can convert the returned string back to an Intent with
9289 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009290 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009291 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009292 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009293 * @return Returns a URI encoding URI string describing the entire contents
9294 * of the Intent.
9295 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009296 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009297 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009298 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9299 if (mPackage == null) {
9300 throw new IllegalArgumentException(
9301 "Intent must include an explicit package name to build an android-app: "
9302 + this);
9303 }
9304 uri.append("android-app://");
9305 uri.append(mPackage);
9306 String scheme = null;
9307 if (mData != null) {
9308 scheme = mData.getScheme();
9309 if (scheme != null) {
9310 uri.append('/');
9311 uri.append(scheme);
9312 String authority = mData.getEncodedAuthority();
9313 if (authority != null) {
9314 uri.append('/');
9315 uri.append(authority);
9316 String path = mData.getEncodedPath();
9317 if (path != null) {
9318 uri.append(path);
9319 }
9320 String queryParams = mData.getEncodedQuery();
9321 if (queryParams != null) {
9322 uri.append('?');
9323 uri.append(queryParams);
9324 }
9325 String fragment = mData.getEncodedFragment();
9326 if (fragment != null) {
9327 uri.append('#');
9328 uri.append(fragment);
9329 }
9330 }
9331 }
9332 }
9333 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9334 mPackage, flags);
9335 return uri.toString();
9336 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009337 String scheme = null;
9338 if (mData != null) {
9339 String data = mData.toString();
9340 if ((flags&URI_INTENT_SCHEME) != 0) {
9341 final int N = data.length();
9342 for (int i=0; i<N; i++) {
9343 char c = data.charAt(i);
9344 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
9345 || c == '.' || c == '-') {
9346 continue;
9347 }
9348 if (c == ':' && i > 0) {
9349 // Valid scheme.
9350 scheme = data.substring(0, i);
9351 uri.append("intent:");
9352 data = data.substring(i+1);
9353 break;
9354 }
Tom Taylord4a47292009-12-21 13:59:18 -08009355
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009356 // No scheme.
9357 break;
9358 }
9359 }
9360 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009361
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009362 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9363 uri.append("intent:");
9364 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009365
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009366 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009367
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009368 return uri.toString();
9369 }
9370
9371 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9372 String defPackage, int flags) {
9373 StringBuilder frag = new StringBuilder(128);
9374
9375 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009376 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009377 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009378 // Note that for now we are not going to try to handle the
9379 // data part; not clear how to represent this as a URI, and
9380 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009381 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9382 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009383 }
9384
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009385 if (frag.length() > 0) {
9386 uri.append("#Intent;");
9387 uri.append(frag);
9388 uri.append("end");
9389 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009390 }
9391
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009392 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9393 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009394 if (scheme != null) {
9395 uri.append("scheme=").append(scheme).append(';');
9396 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009397 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009398 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009399 }
9400 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009401 for (int i=0; i<mCategories.size(); i++) {
9402 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009403 }
9404 }
9405 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009406 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009407 }
9408 if (mFlags != 0) {
9409 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9410 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009411 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009412 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9413 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009414 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009415 uri.append("component=").append(Uri.encode(
9416 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009417 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009418 if (mSourceBounds != null) {
9419 uri.append("sourceBounds=")
9420 .append(Uri.encode(mSourceBounds.flattenToString()))
9421 .append(';');
9422 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009423 if (mExtras != null) {
9424 for (String key : mExtras.keySet()) {
9425 final Object value = mExtras.get(key);
9426 char entryType =
9427 value instanceof String ? 'S' :
9428 value instanceof Boolean ? 'B' :
9429 value instanceof Byte ? 'b' :
9430 value instanceof Character ? 'c' :
9431 value instanceof Double ? 'd' :
9432 value instanceof Float ? 'f' :
9433 value instanceof Integer ? 'i' :
9434 value instanceof Long ? 'l' :
9435 value instanceof Short ? 's' :
9436 '\0';
9437
9438 if (entryType != '\0') {
9439 uri.append(entryType);
9440 uri.append('.');
9441 uri.append(Uri.encode(key));
9442 uri.append('=');
9443 uri.append(Uri.encode(value.toString()));
9444 uri.append(';');
9445 }
9446 }
9447 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009448 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009449
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009450 public int describeContents() {
9451 return (mExtras != null) ? mExtras.describeContents() : 0;
9452 }
9453
9454 public void writeToParcel(Parcel out, int flags) {
9455 out.writeString(mAction);
9456 Uri.writeToParcel(out, mData);
9457 out.writeString(mType);
9458 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009459 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009460 ComponentName.writeToParcel(mComponent, out);
9461
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009462 if (mSourceBounds != null) {
9463 out.writeInt(1);
9464 mSourceBounds.writeToParcel(out, flags);
9465 } else {
9466 out.writeInt(0);
9467 }
9468
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009469 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009470 final int N = mCategories.size();
9471 out.writeInt(N);
9472 for (int i=0; i<N; i++) {
9473 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009474 }
9475 } else {
9476 out.writeInt(0);
9477 }
9478
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009479 if (mSelector != null) {
9480 out.writeInt(1);
9481 mSelector.writeToParcel(out, flags);
9482 } else {
9483 out.writeInt(0);
9484 }
9485
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009486 if (mClipData != null) {
9487 out.writeInt(1);
9488 mClipData.writeToParcel(out, flags);
9489 } else {
9490 out.writeInt(0);
9491 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009492 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009493 out.writeBundle(mExtras);
9494 }
9495
9496 public static final Parcelable.Creator<Intent> CREATOR
9497 = new Parcelable.Creator<Intent>() {
9498 public Intent createFromParcel(Parcel in) {
9499 return new Intent(in);
9500 }
9501 public Intent[] newArray(int size) {
9502 return new Intent[size];
9503 }
9504 };
9505
Dianne Hackborneb034652009-09-07 00:49:58 -07009506 /** @hide */
9507 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009508 readFromParcel(in);
9509 }
9510
9511 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009512 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009513 mData = Uri.CREATOR.createFromParcel(in);
9514 mType = in.readString();
9515 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009516 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009517 mComponent = ComponentName.readFromParcel(in);
9518
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009519 if (in.readInt() != 0) {
9520 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9521 }
9522
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009523 int N = in.readInt();
9524 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009525 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009526 int i;
9527 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009528 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009529 }
9530 } else {
9531 mCategories = null;
9532 }
9533
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009534 if (in.readInt() != 0) {
9535 mSelector = new Intent(in);
9536 }
9537
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009538 if (in.readInt() != 0) {
9539 mClipData = new ClipData(in);
9540 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009541 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009542 mExtras = in.readBundle();
9543 }
9544
9545 /**
9546 * Parses the "intent" element (and its children) from XML and instantiates
9547 * an Intent object. The given XML parser should be located at the tag
9548 * where parsing should start (often named "intent"), from which the
9549 * basic action, data, type, and package and class name will be
9550 * retrieved. The function will then parse in to any child elements,
9551 * looking for <category android:name="xxx"> tags to add categories and
9552 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9553 * to the intent.
9554 *
9555 * @param resources The Resources to use when inflating resources.
9556 * @param parser The XML parser pointing at an "intent" tag.
9557 * @param attrs The AttributeSet interface for retrieving extended
9558 * attribute data at the current <var>parser</var> location.
9559 * @return An Intent object matching the XML data.
9560 * @throws XmlPullParserException If there was an XML parsing error.
9561 * @throws IOException If there was an I/O error.
9562 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009563 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9564 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009565 throws XmlPullParserException, IOException {
9566 Intent intent = new Intent();
9567
9568 TypedArray sa = resources.obtainAttributes(attrs,
9569 com.android.internal.R.styleable.Intent);
9570
9571 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9572
9573 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9574 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9575 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9576
9577 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9578 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9579 if (packageName != null && className != null) {
9580 intent.setComponent(new ComponentName(packageName, className));
9581 }
9582
9583 sa.recycle();
9584
9585 int outerDepth = parser.getDepth();
9586 int type;
9587 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9588 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9589 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9590 continue;
9591 }
9592
9593 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009594 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009595 sa = resources.obtainAttributes(attrs,
9596 com.android.internal.R.styleable.IntentCategory);
9597 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9598 sa.recycle();
9599
9600 if (cat != null) {
9601 intent.addCategory(cat);
9602 }
9603 XmlUtils.skipCurrentTag(parser);
9604
Craig Mautner21d24a22014-04-23 11:45:37 -07009605 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009606 if (intent.mExtras == null) {
9607 intent.mExtras = new Bundle();
9608 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009609 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009610 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009611
9612 } else {
9613 XmlUtils.skipCurrentTag(parser);
9614 }
9615 }
9616
9617 return intent;
9618 }
Nick Pellyccae4122012-01-09 14:12:58 -08009619
Craig Mautner21d24a22014-04-23 11:45:37 -07009620 /** @hide */
9621 public void saveToXml(XmlSerializer out) throws IOException {
9622 if (mAction != null) {
9623 out.attribute(null, ATTR_ACTION, mAction);
9624 }
9625 if (mData != null) {
9626 out.attribute(null, ATTR_DATA, mData.toString());
9627 }
9628 if (mType != null) {
9629 out.attribute(null, ATTR_TYPE, mType);
9630 }
9631 if (mComponent != null) {
9632 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9633 }
9634 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9635
9636 if (mCategories != null) {
9637 out.startTag(null, TAG_CATEGORIES);
9638 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9639 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9640 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009641 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009642 }
9643 }
9644
9645 /** @hide */
9646 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9647 XmlPullParserException {
9648 Intent intent = new Intent();
9649 final int outerDepth = in.getDepth();
9650
9651 int attrCount = in.getAttributeCount();
9652 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9653 final String attrName = in.getAttributeName(attrNdx);
9654 final String attrValue = in.getAttributeValue(attrNdx);
9655 if (ATTR_ACTION.equals(attrName)) {
9656 intent.setAction(attrValue);
9657 } else if (ATTR_DATA.equals(attrName)) {
9658 intent.setData(Uri.parse(attrValue));
9659 } else if (ATTR_TYPE.equals(attrName)) {
9660 intent.setType(attrValue);
9661 } else if (ATTR_COMPONENT.equals(attrName)) {
9662 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9663 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009664 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009665 } else {
9666 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9667 }
9668 }
9669
9670 int event;
9671 String name;
9672 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9673 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9674 if (event == XmlPullParser.START_TAG) {
9675 name = in.getName();
9676 if (TAG_CATEGORIES.equals(name)) {
9677 attrCount = in.getAttributeCount();
9678 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9679 intent.addCategory(in.getAttributeValue(attrNdx));
9680 }
9681 } else {
9682 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9683 XmlUtils.skipCurrentTag(in);
9684 }
9685 }
9686 }
9687
9688 return intent;
9689 }
9690
Nick Pellyccae4122012-01-09 14:12:58 -08009691 /**
9692 * Normalize a MIME data type.
9693 *
9694 * <p>A normalized MIME type has white-space trimmed,
9695 * content-type parameters removed, and is lower-case.
9696 * This aligns the type with Android best practices for
9697 * intent filtering.
9698 *
9699 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9700 * "text/x-vCard" becomes "text/x-vcard".
9701 *
9702 * <p>All MIME types received from outside Android (such as user input,
9703 * or external sources like Bluetooth, NFC, or the Internet) should
9704 * be normalized before they are used to create an Intent.
9705 *
9706 * @param type MIME data type to normalize
9707 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009708 * @see #setType
9709 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009710 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009711 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009712 if (type == null) {
9713 return null;
9714 }
9715
Elliott Hughescb64d432013-08-02 10:00:44 -07009716 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009717
9718 final int semicolonIndex = type.indexOf(';');
9719 if (semicolonIndex != -1) {
9720 type = type.substring(0, semicolonIndex);
9721 }
9722 return type;
9723 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009724
9725 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009726 * Prepare this {@link Intent} to leave an app process.
9727 *
9728 * @hide
9729 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009730 public void prepareToLeaveProcess(Context context) {
9731 final boolean leavingPackage = (mComponent == null)
9732 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9733 prepareToLeaveProcess(leavingPackage);
9734 }
9735
9736 /**
9737 * Prepare this {@link Intent} to leave an app process.
9738 *
9739 * @hide
9740 */
9741 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009742 setAllowFds(false);
9743
9744 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009745 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009746 }
9747 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009748 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009749 }
9750
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009751 if (mExtras != null && !mExtras.isParcelled()) {
9752 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9753 if (intent instanceof Intent) {
9754 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9755 }
9756 }
9757
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009758 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9759 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009760 switch (mAction) {
9761 case ACTION_MEDIA_REMOVED:
9762 case ACTION_MEDIA_UNMOUNTED:
9763 case ACTION_MEDIA_CHECKING:
9764 case ACTION_MEDIA_NOFS:
9765 case ACTION_MEDIA_MOUNTED:
9766 case ACTION_MEDIA_SHARED:
9767 case ACTION_MEDIA_UNSHARED:
9768 case ACTION_MEDIA_BAD_REMOVAL:
9769 case ACTION_MEDIA_UNMOUNTABLE:
9770 case ACTION_MEDIA_EJECT:
9771 case ACTION_MEDIA_SCANNER_STARTED:
9772 case ACTION_MEDIA_SCANNER_FINISHED:
9773 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009774 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9775 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009776 // Ignore legacy actions
9777 break;
9778 default:
9779 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009780 }
9781 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009782
9783 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9784 && leavingPackage) {
9785 switch (mAction) {
9786 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -07009787 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009788 // Ignore actions that don't need to grant
9789 break;
9790 default:
9791 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9792 }
9793 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009794 }
9795
9796 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009797 * @hide
9798 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009799 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009800 // We just entered destination process, so we should be able to read all
9801 // parcelables inside.
9802 setDefusable(true);
9803
9804 if (mSelector != null) {
9805 mSelector.prepareToEnterProcess();
9806 }
9807 if (mClipData != null) {
9808 mClipData.prepareToEnterProcess();
9809 }
9810
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009811 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009812 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9813 fixUris(mContentUserHint);
9814 mContentUserHint = UserHandle.USER_CURRENT;
9815 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009816 }
9817 }
9818
9819 /**
9820 * @hide
9821 */
9822 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009823 Uri data = getData();
9824 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009825 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009826 }
9827 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009828 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009829 }
9830 String action = getAction();
9831 if (ACTION_SEND.equals(action)) {
9832 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9833 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009834 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009835 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009836 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009837 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9838 if (streams != null) {
9839 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9840 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009841 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009842 }
9843 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9844 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009845 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9846 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9847 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9848 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9849 if (output != null) {
9850 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9851 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009852 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009853 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009854
9855 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009856 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009857 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9858 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009859 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009860 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009861 * @hide
9862 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009863 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009864 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009865 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009866
9867 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009868 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009869
9870 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009871 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009872 // Inspect contained intents to see if we need to migrate extras. We
9873 // don't promote ClipData to the parent, since ChooserActivity will
9874 // already start the picked item as the caller, and we can't combine
9875 // the flags in a safe way.
9876
9877 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009878 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009879 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9880 if (intent != null) {
9881 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009882 }
9883 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009884 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009885 try {
9886 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9887 if (intents != null) {
9888 for (int i = 0; i < intents.length; i++) {
9889 final Intent intent = (Intent) intents[i];
9890 if (intent != null) {
9891 migrated |= intent.migrateExtraStreamToClipData();
9892 }
9893 }
9894 }
9895 } catch (ClassCastException e) {
9896 }
9897 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009898
9899 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009900 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009901 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9902 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9903 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9904 if (stream != null || text != null || htmlText != null) {
9905 final ClipData clipData = new ClipData(
9906 null, new String[] { getType() },
9907 new ClipData.Item(text, htmlText, null, stream));
9908 setClipData(clipData);
9909 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009910 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009911 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009912 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009913 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009914
9915 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009916 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009917 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9918 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9919 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9920 int num = -1;
9921 if (streams != null) {
9922 num = streams.size();
9923 }
9924 if (texts != null) {
9925 if (num >= 0 && num != texts.size()) {
9926 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009927 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009928 }
9929 num = texts.size();
9930 }
9931 if (htmlTexts != null) {
9932 if (num >= 0 && num != htmlTexts.size()) {
9933 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009934 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009935 }
9936 num = htmlTexts.size();
9937 }
9938 if (num > 0) {
9939 final ClipData clipData = new ClipData(
9940 null, new String[] { getType() },
9941 makeClipItem(streams, texts, htmlTexts, 0));
9942
9943 for (int i = 1; i < num; i++) {
9944 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9945 }
9946
9947 setClipData(clipData);
9948 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009949 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009950 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009951 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009952 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009953 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9954 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9955 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9956 final Uri output;
9957 try {
9958 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9959 } catch (ClassCastException e) {
9960 return false;
9961 }
9962 if (output != null) {
9963 setClipData(ClipData.newRawUri("", output));
9964 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9965 return true;
9966 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009967 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009968
9969 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009970 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009971
9972 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9973 ArrayList<String> htmlTexts, int which) {
9974 Uri uri = streams != null ? streams.get(which) : null;
9975 CharSequence text = texts != null ? texts.get(which) : null;
9976 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9977 return new ClipData.Item(text, htmlText, null, uri);
9978 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009979
9980 /** @hide */
9981 public boolean isDocument() {
9982 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9983 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009984}