blob: 8c2b76f5dc34b12b158e494b312856e78c4630e4 [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;
Mathew Inwood5c0d3542018-08-14 13:54:31 +010029import android.annotation.UnsupportedAppUsage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050031import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060032import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070033import android.content.pm.PackageManager;
34import android.content.pm.ResolveInfo;
35import android.content.res.Resources;
36import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080037import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070038import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060039import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070040import android.os.Bundle;
41import android.os.IBinder;
42import android.os.Parcel;
43import android.os.Parcelable;
Suprabh Shukla96212bc2018-04-10 15:04:51 -070044import android.os.PersistableBundle;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000045import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050046import android.os.ResultReceiver;
47import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070048import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010049import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070050import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070051import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050053import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070054import android.provider.OpenableColumns;
Patrick Baumann577d4022018-01-31 16:55:10 +000055import android.text.TextUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050056import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import android.util.AttributeSet;
58import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070059import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070060
Dianne Hackborn2269d1572010-02-24 19:54:22 -080061import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070062
Jason Monk2f68e8a2016-02-23 17:57:28 -050063import org.xmlpull.v1.XmlPullParser;
64import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070065import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066
67import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080068import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070069import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070070import java.lang.annotation.Retention;
71import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070072import java.net.URISyntaxException;
73import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080074import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070075import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080076import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070077import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070078import java.util.Set;
79
80/**
81 * An intent is an abstract description of an operation to be performed. It
82 * can be used with {@link Context#startActivity(Intent) startActivity} to
83 * launch an {@link android.app.Activity},
84 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
85 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
86 * and {@link android.content.Context#startService} or
87 * {@link android.content.Context#bindService} to communicate with a
88 * background {@link android.app.Service}.
89 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070090 * <p>An Intent provides a facility for performing late runtime binding between the code in
91 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070092 * can be thought of as the glue between activities. It is basically a passive data structure
93 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070094 *
95 * <div class="special reference">
96 * <h3>Developer Guides</h3>
97 * <p>For information about how to create and resolve intents, read the
98 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
99 * developer guide.</p>
100 * </div>
101 *
102 * <a name="IntentStructure"></a>
103 * <h3>Intent Structure</h3>
104 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700105 *
106 * <ul>
107 * <li> <p><b>action</b> -- The general action to be performed, such as
108 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
109 * etc.</p>
110 * </li>
111 * <li> <p><b>data</b> -- The data to operate on, such as a person record
112 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
113 * </li>
114 * </ul>
115 *
116 *
117 * <p>Some examples of action/data pairs are:</p>
118 *
119 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700120 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700121 * information about the person whose identifier is "1".</p>
122 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700123 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700124 * the phone dialer with the person filled in.</p>
125 * </li>
126 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
127 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700128 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700129 * a particular URI.</p>
130 * </li>
131 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
132 * the phone dialer with the given number filled in.</p>
133 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700134 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700135 * information about the person whose identifier is "1".</p>
136 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700137 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700138 * a list of people, which the user can browse through. This example is a
139 * typical top-level entry into the Contacts application, showing you the
140 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700141 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700142 * being used to start an activity to display that person.</p>
143 * </li>
144 * </ul>
145 *
146 * <p>In addition to these primary attributes, there are a number of secondary
147 * attributes that you can also include with an intent:</p>
148 *
149 * <ul>
150 * <li> <p><b>category</b> -- Gives additional information about the action
151 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
152 * appear in the Launcher as a top-level application, while
153 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
154 * of alternative actions the user can perform on a piece of data.</p>
155 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
156 * intent data. Normally the type is inferred from the data itself.
157 * By setting this attribute, you disable that evaluation and force
158 * an explicit type.</p>
159 * <li> <p><b>component</b> -- Specifies an explicit name of a component
160 * class to use for the intent. Normally this is determined by looking
161 * at the other information in the intent (the action, data/type, and
162 * categories) and matching that with a component that can handle it.
163 * If this attribute is set then none of the evaluation is performed,
164 * and this component is used exactly as is. By specifying this attribute,
165 * all of the other Intent attributes become optional.</p>
166 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
167 * This can be used to provide extended information to the component.
168 * For example, if we have a action to send an e-mail message, we could
169 * also include extra pieces of data here to supply a subject, body,
170 * etc.</p>
171 * </ul>
172 *
173 * <p>Here are some examples of other operations you can specify as intents
174 * using these additional parameters:</p>
175 *
176 * <ul>
177 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
178 * Launch the home screen.</p>
179 * </li>
180 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
181 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
182 * vnd.android.cursor.item/phone}</i></b>
183 * -- Display the list of people's phone numbers, allowing the user to
184 * browse through them and pick one and return it to the parent activity.</p>
185 * </li>
186 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
187 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
188 * -- Display all pickers for data that can be opened with
189 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
190 * allowing the user to pick one of them and then some data inside of it
191 * and returning the resulting URI to the caller. This can be used,
192 * for example, in an e-mail application to allow the user to pick some
193 * data to include as an attachment.</p>
194 * </li>
195 * </ul>
196 *
197 * <p>There are a variety of standard Intent action and category constants
198 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700199 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700200 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700201 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700202 *
203 * <p>Put together, the set of actions, data types, categories, and extra data
204 * defines a language for the system allowing for the expression of phrases
205 * such as "call john smith's cell". As applications are added to the system,
206 * they can extend this language by adding new actions, types, and categories, or
207 * they can modify the behavior of existing phrases by supplying their own
208 * activities that handle them.</p>
209 *
210 * <a name="IntentResolution"></a>
211 * <h3>Intent Resolution</h3>
212 *
213 * <p>There are two primary forms of intents you will use.
214 *
215 * <ul>
216 * <li> <p><b>Explicit Intents</b> have specified a component (via
217 * {@link #setComponent} or {@link #setClass}), which provides the exact
218 * class to be run. Often these will not include any other information,
219 * simply being a way for an application to launch various internal
220 * activities it has as the user interacts with the application.
221 *
222 * <li> <p><b>Implicit Intents</b> have not specified a component;
223 * instead, they must include enough information for the system to
224 * determine which of the available components is best to run for that
225 * intent.
226 * </ul>
227 *
228 * <p>When using implicit intents, given such an arbitrary intent we need to
229 * know what to do with it. This is handled by the process of <em>Intent
230 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
231 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
232 * more activities/receivers) that can handle it.</p>
233 *
234 * <p>The intent resolution mechanism basically revolves around matching an
235 * Intent against all of the &lt;intent-filter&gt; descriptions in the
236 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
237 * objects explicitly registered with {@link Context#registerReceiver}.) More
238 * details on this can be found in the documentation on the {@link
239 * IntentFilter} class.</p>
240 *
241 * <p>There are three pieces of information in the Intent that are used for
242 * resolution: the action, type, and category. Using this information, a query
243 * is done on the {@link PackageManager} for a component that can handle the
244 * intent. The appropriate component is determined based on the intent
245 * information supplied in the <code>AndroidManifest.xml</code> file as
246 * follows:</p>
247 *
248 * <ul>
249 * <li> <p>The <b>action</b>, if given, must be listed by the component as
250 * one it handles.</p>
251 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
252 * already supplied in the Intent. Like the action, if a type is
253 * included in the intent (either explicitly or implicitly in its
254 * data), then this must be listed by the component as one it handles.</p>
255 * <li> For data that is not a <code>content:</code> URI and where no explicit
256 * type is included in the Intent, instead the <b>scheme</b> of the
257 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
258 * considered. Again like the action, if we are matching a scheme it
259 * must be listed by the component as one it can handle.
260 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
261 * by the activity as categories it handles. That is, if you include
262 * the categories {@link #CATEGORY_LAUNCHER} and
263 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
264 * with an intent that lists <em>both</em> of those categories.
265 * Activities will very often need to support the
266 * {@link #CATEGORY_DEFAULT} so that they can be found by
267 * {@link Context#startActivity Context.startActivity()}.</p>
268 * </ul>
269 *
270 * <p>For example, consider the Note Pad sample application that
Joshua Baxter9a841a62018-03-27 14:42:03 -0700271 * allows a user to browse through a list of notes data and view details about
272 * individual items. Text in italics indicates places where you would replace a
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700273 * name with one specific to your own package.</p>
274 *
275 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
276 * package="<i>com.android.notepad</i>"&gt;
277 * &lt;application android:icon="@drawable/app_notes"
278 * android:label="@string/app_name"&gt;
279 *
280 * &lt;provider class=".NotePadProvider"
281 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
282 *
283 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
284 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700285 * &lt;action android:name="android.intent.action.MAIN" /&gt;
286 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700287 * &lt;/intent-filter&gt;
288 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700289 * &lt;action android:name="android.intent.action.VIEW" /&gt;
290 * &lt;action android:name="android.intent.action.EDIT" /&gt;
291 * &lt;action android:name="android.intent.action.PICK" /&gt;
292 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
293 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700294 * &lt;/intent-filter&gt;
295 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700296 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
297 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
298 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700299 * &lt;/intent-filter&gt;
300 * &lt;/activity&gt;
301 *
302 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
303 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700304 * &lt;action android:name="android.intent.action.VIEW" /&gt;
305 * &lt;action android:name="android.intent.action.EDIT" /&gt;
306 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
307 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700308 * &lt;/intent-filter&gt;
309 *
310 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="android.intent.action.INSERT" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700314 * &lt;/intent-filter&gt;
315 *
316 * &lt;/activity&gt;
317 *
318 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
319 * android:theme="@android:style/Theme.Dialog"&gt;
320 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700321 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
322 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
323 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
324 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
325 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700326 * &lt;/intent-filter&gt;
327 * &lt;/activity&gt;
328 *
329 * &lt;/application&gt;
330 * &lt;/manifest&gt;</pre>
331 *
332 * <p>The first activity,
333 * <code>com.android.notepad.NotesList</code>, serves as our main
334 * entry into the app. It can do three things as described by its three intent
335 * templates:
336 * <ol>
337 * <li><pre>
338 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700339 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
340 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700341 * &lt;/intent-filter&gt;</pre>
342 * <p>This provides a top-level entry into the NotePad application: the standard
343 * MAIN action is a main entry point (not requiring any other information in
344 * the Intent), and the LAUNCHER category says that this entry point should be
345 * listed in the application launcher.</p>
346 * <li><pre>
347 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700348 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
349 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
350 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
351 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700352 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700353 * &lt;/intent-filter&gt;</pre>
354 * <p>This declares the things that the activity can do on a directory of
355 * notes. The type being supported is given with the &lt;type&gt; tag, where
356 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
357 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
358 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
359 * The activity allows the user to view or edit the directory of data (via
360 * the VIEW and EDIT actions), or to pick a particular note and return it
361 * to the caller (via the PICK action). Note also the DEFAULT category
362 * supplied here: this is <em>required</em> for the
363 * {@link Context#startActivity Context.startActivity} method to resolve your
364 * activity when its component name is not explicitly specified.</p>
365 * <li><pre>
366 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700367 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
368 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
369 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700370 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700371 * <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 -0700372 * the user without needing to know where it came from. The data type
373 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
374 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
375 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
376 * The GET_CONTENT action is similar to the PICK action, where the activity
377 * will return to its caller a piece of data selected by the user. Here,
378 * however, the caller specifies the type of data they desire instead of
379 * the type of data the user will be picking from.</p>
380 * </ol>
381 *
382 * <p>Given these capabilities, the following intents will resolve to the
383 * NotesList activity:</p>
384 *
385 * <ul>
386 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
387 * activities that can be used as top-level entry points into an
388 * application.</p>
389 * <li> <p><b>{ action=android.app.action.MAIN,
390 * category=android.app.category.LAUNCHER }</b> is the actual intent
391 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700392 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700393 * data=content://com.google.provider.NotePad/notes }</b>
394 * displays a list of all the notes under
395 * "content://com.google.provider.NotePad/notes", which
396 * the user can browse through and see the details on.</p>
397 * <li> <p><b>{ action=android.app.action.PICK
398 * data=content://com.google.provider.NotePad/notes }</b>
399 * provides a list of the notes under
400 * "content://com.google.provider.NotePad/notes", from which
401 * the user can pick a note whose data URL is returned back to the caller.</p>
402 * <li> <p><b>{ action=android.app.action.GET_CONTENT
403 * type=vnd.android.cursor.item/vnd.google.note }</b>
404 * is similar to the pick action, but allows the caller to specify the
405 * kind of data they want back so that the system can find the appropriate
406 * activity to pick something of that data type.</p>
407 * </ul>
408 *
409 * <p>The second activity,
410 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
411 * note entry and allows them to edit it. It can do two things as described
412 * by its two intent templates:
413 * <ol>
414 * <li><pre>
415 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700416 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
417 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
418 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
419 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700420 * &lt;/intent-filter&gt;</pre>
421 * <p>The first, primary, purpose of this activity is to let the user interact
422 * with a single note, as decribed by the MIME type
423 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
424 * either VIEW a note or allow the user to EDIT it. Again we support the
425 * DEFAULT category to allow the activity to be launched without explicitly
426 * specifying its component.</p>
427 * <li><pre>
428 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700429 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
430 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
431 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700432 * &lt;/intent-filter&gt;</pre>
433 * <p>The secondary use of this activity is to insert a new note entry into
434 * an existing directory of notes. This is used when the user creates a new
435 * note: the INSERT action is executed on the directory of notes, causing
436 * this activity to run and have the user create the new note data which
437 * it then adds to the content provider.</p>
438 * </ol>
439 *
440 * <p>Given these capabilities, the following intents will resolve to the
441 * NoteEditor activity:</p>
442 *
443 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700444 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700445 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
446 * shows the user the content of note <var>{ID}</var>.</p>
447 * <li> <p><b>{ action=android.app.action.EDIT
448 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
449 * allows the user to edit the content of note <var>{ID}</var>.</p>
450 * <li> <p><b>{ action=android.app.action.INSERT
451 * data=content://com.google.provider.NotePad/notes }</b>
452 * creates a new, empty note in the notes list at
453 * "content://com.google.provider.NotePad/notes"
454 * and allows the user to edit it. If they keep their changes, the URI
455 * of the newly created note is returned to the caller.</p>
456 * </ul>
457 *
458 * <p>The last activity,
459 * <code>com.android.notepad.TitleEditor</code>, allows the user to
460 * edit the title of a note. This could be implemented as a class that the
461 * application directly invokes (by explicitly setting its component in
462 * the Intent), but here we show a way you can publish alternative
463 * operations on existing data:</p>
464 *
465 * <pre>
466 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700467 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
468 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
469 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
470 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
471 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700472 * &lt;/intent-filter&gt;</pre>
473 *
474 * <p>In the single intent template here, we
475 * have created our own private action called
476 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
477 * edit the title of a note. It must be invoked on a specific note
478 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
479 * view and edit actions, but here displays and edits the title contained
480 * in the note data.
481 *
482 * <p>In addition to supporting the default category as usual, our title editor
483 * also supports two other standard categories: ALTERNATIVE and
484 * SELECTED_ALTERNATIVE. Implementing
485 * these categories allows others to find the special action it provides
486 * without directly knowing about it, through the
487 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
488 * more often to build dynamic menu items with
489 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
490 * template here was also supply an explicit name for the template
491 * (via <code>android:label="@string/resolve_title"</code>) to better control
492 * what the user sees when presented with this activity as an alternative
493 * action to the data they are viewing.
494 *
495 * <p>Given these capabilities, the following intent will resolve to the
496 * TitleEditor activity:</p>
497 *
498 * <ul>
499 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
500 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
501 * displays and allows the user to edit the title associated
502 * with note <var>{ID}</var>.</p>
503 * </ul>
504 *
505 * <h3>Standard Activity Actions</h3>
506 *
507 * <p>These are the current standard actions that Intent defines for launching
508 * activities (usually through {@link Context#startActivity}. The most
509 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
510 * {@link #ACTION_EDIT}.
511 *
512 * <ul>
513 * <li> {@link #ACTION_MAIN}
514 * <li> {@link #ACTION_VIEW}
515 * <li> {@link #ACTION_ATTACH_DATA}
516 * <li> {@link #ACTION_EDIT}
517 * <li> {@link #ACTION_PICK}
518 * <li> {@link #ACTION_CHOOSER}
519 * <li> {@link #ACTION_GET_CONTENT}
520 * <li> {@link #ACTION_DIAL}
521 * <li> {@link #ACTION_CALL}
522 * <li> {@link #ACTION_SEND}
523 * <li> {@link #ACTION_SENDTO}
524 * <li> {@link #ACTION_ANSWER}
525 * <li> {@link #ACTION_INSERT}
526 * <li> {@link #ACTION_DELETE}
527 * <li> {@link #ACTION_RUN}
528 * <li> {@link #ACTION_SYNC}
529 * <li> {@link #ACTION_PICK_ACTIVITY}
530 * <li> {@link #ACTION_SEARCH}
531 * <li> {@link #ACTION_WEB_SEARCH}
532 * <li> {@link #ACTION_FACTORY_TEST}
533 * </ul>
534 *
535 * <h3>Standard Broadcast Actions</h3>
536 *
537 * <p>These are the current standard actions that Intent defines for receiving
538 * broadcasts (usually through {@link Context#registerReceiver} or a
539 * &lt;receiver&gt; tag in a manifest).
540 *
541 * <ul>
542 * <li> {@link #ACTION_TIME_TICK}
543 * <li> {@link #ACTION_TIME_CHANGED}
544 * <li> {@link #ACTION_TIMEZONE_CHANGED}
545 * <li> {@link #ACTION_BOOT_COMPLETED}
546 * <li> {@link #ACTION_PACKAGE_ADDED}
547 * <li> {@link #ACTION_PACKAGE_CHANGED}
548 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800549 * <li> {@link #ACTION_PACKAGE_RESTARTED}
550 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000551 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
552 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700553 * <li> {@link #ACTION_UID_REMOVED}
554 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700555 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700556 * <li> {@link #ACTION_POWER_DISCONNECTED}
557 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700558 * </ul>
559 *
560 * <h3>Standard Categories</h3>
561 *
562 * <p>These are the current standard categories that can be used to further
563 * clarify an Intent via {@link #addCategory}.
564 *
565 * <ul>
566 * <li> {@link #CATEGORY_DEFAULT}
567 * <li> {@link #CATEGORY_BROWSABLE}
568 * <li> {@link #CATEGORY_TAB}
569 * <li> {@link #CATEGORY_ALTERNATIVE}
570 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
571 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800572 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * <li> {@link #CATEGORY_HOME}
574 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700575 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400576 * <li> {@link #CATEGORY_CAR_DOCK}
577 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500578 * <li> {@link #CATEGORY_LE_DESK_DOCK}
579 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200580 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700581 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800582 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700583 * </ul>
584 *
585 * <h3>Standard Extra Data</h3>
586 *
587 * <p>These are the current standard fields that can be used as extra data via
588 * {@link #putExtra}.
589 *
590 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800591 * <li> {@link #EXTRA_ALARM_COUNT}
592 * <li> {@link #EXTRA_BCC}
593 * <li> {@link #EXTRA_CC}
594 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
595 * <li> {@link #EXTRA_DATA_REMOVED}
596 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500597 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
598 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_DOCK_STATE_CAR}
600 * <li> {@link #EXTRA_DOCK_STATE_DESK}
601 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
602 * <li> {@link #EXTRA_DONT_KILL_APP}
603 * <li> {@link #EXTRA_EMAIL}
604 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700607 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800608 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700609 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800610 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
611 * <li> {@link #EXTRA_REPLACING}
612 * <li> {@link #EXTRA_SHORTCUT_ICON}
613 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
614 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800616 * <li> {@link #EXTRA_SHORTCUT_NAME}
617 * <li> {@link #EXTRA_SUBJECT}
618 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800620 * <li> {@link #EXTRA_TITLE}
621 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 * </ul>
623 *
624 * <h3>Flags</h3>
625 *
626 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
628 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800630public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700631 private static final String ATTR_ACTION = "action";
632 private static final String TAG_CATEGORIES = "categories";
633 private static final String ATTR_CATEGORY = "category";
634 private static final String TAG_EXTRA = "extra";
635 private static final String ATTR_TYPE = "type";
636 private static final String ATTR_COMPONENT = "component";
637 private static final String ATTR_DATA = "data";
638 private static final String ATTR_FLAGS = "flags";
639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700640 // ---------------------------------------------------------------------
641 // ---------------------------------------------------------------------
642 // Standard intent activity actions (see action variable).
643
644 /**
645 * Activity Action: Start as a main entry point, does not expect to
646 * receive data.
647 * <p>Input: nothing
648 * <p>Output: nothing
649 */
650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
651 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700653 /**
654 * Activity Action: Display the data to the user. This is the most common
655 * action performed on data -- it is the generic action you can use on
656 * a piece of data to get the most reasonable thing to occur. For example,
657 * when used on a contacts entry it will view the entry; when used on a
658 * mailto: URI it will bring up a compose window filled with the information
659 * supplied by the URI; when used with a tel: URI it will invoke the
660 * dialer.
661 * <p>Input: {@link #getData} is URI from which to retrieve data.
662 * <p>Output: nothing.
663 */
664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
665 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700667 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700668 * Extra that can be included on activity intents coming from the storage UI
669 * when it launches sub-activities to manage various types of storage. For example,
670 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
671 * the images on the device, and in that case also include this extra to tell the
672 * app it is coming from the storage UI so should help the user manage storage of
673 * this type.
674 */
675 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
676
677 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
679 * performed on a piece of data.
680 */
681 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800682
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700683 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900684 * Activity Action: Quick view the data. Launches a quick viewer for
685 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900686 * <p>Activities handling this intent action should handle the vast majority of
687 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700688 * <p>Quick viewers must render the quick view image locally, and must not send
689 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900690 * <p>Input: {@link #getData} is a mandatory content URI of the item to
691 * preview. {@link #getClipData} contains an optional list of content URIs
692 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
693 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700694 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
695 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700696 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900697 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700698 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700699 */
700 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
701 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
702
703 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 * Used to indicate that some piece of data should be attached to some other
705 * place. For example, image data could be attached to a contact. It is up
706 * to the recipient to decide where the data should be attached; the intent
707 * does not specify the ultimate destination.
708 * <p>Input: {@link #getData} is URI of data to be attached.
709 * <p>Output: nothing.
710 */
711 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
712 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800713
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700714 /**
715 * Activity Action: Provide explicit editable access to the given data.
716 * <p>Input: {@link #getData} is URI of data to be edited.
717 * <p>Output: nothing.
718 */
719 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
720 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700722 /**
723 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
724 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
725 * The extras can contain type specific data to pass through to the editing/creating
726 * activity.
727 * <p>Output: The URI of the item that was picked. This must be a content:
728 * URI so that any receiver can access it.
729 */
730 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
731 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800732
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700733 /**
734 * Activity Action: Pick an item from the data, returning what was selected.
735 * <p>Input: {@link #getData} is URI containing a directory of data
736 * (vnd.android.cursor.dir/*) from which to pick an item.
737 * <p>Output: The URI of the item that was picked.
738 */
739 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
740 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800741
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700742 /**
743 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800744 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800745 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
746 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700747 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
748 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800749 * (value: ShortcutIconResource).</p>
750 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800751 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700752 * @see #EXTRA_SHORTCUT_INTENT
753 * @see #EXTRA_SHORTCUT_NAME
754 * @see #EXTRA_SHORTCUT_ICON
755 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
756 * @see android.content.Intent.ShortcutIconResource
757 */
758 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
759 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
760
761 /**
762 * The name of the extra used to define the Intent of a shortcut.
763 *
764 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800765 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700766 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800767 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700768 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
769 /**
770 * The name of the extra used to define the name of a shortcut.
771 *
772 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800773 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700774 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800775 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700776 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
777 /**
778 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
779 *
780 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800781 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800783 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700784 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
785 /**
786 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
787 *
788 * @see #ACTION_CREATE_SHORTCUT
789 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800790 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700791 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800792 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700793 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
794 "android.intent.extra.shortcut.ICON_RESOURCE";
795
796 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500797 * An activity that provides a user interface for adjusting application preferences.
798 * Optional but recommended settings for all applications which have settings.
799 */
800 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
801 public static final String ACTION_APPLICATION_PREFERENCES
802 = "android.intent.action.APPLICATION_PREFERENCES";
803
804 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700805 * Activity Action: Launch an activity showing the app information.
806 * For applications which install other applications (such as app stores), it is recommended
807 * to handle this action for providing the app information to the user.
808 *
809 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
810 * to be displayed.
811 * <p>Output: Nothing.
812 */
813 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
814 public static final String ACTION_SHOW_APP_INFO
815 = "android.intent.action.SHOW_APP_INFO";
816
817 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800818 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700819 *
820 * @see Intent#ACTION_CREATE_SHORTCUT
821 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800822 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
823 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 */
825 public static class ShortcutIconResource implements Parcelable {
826 /**
827 * The package name of the application containing the icon.
828 */
829 public String packageName;
830
831 /**
832 * The resource name of the icon, including package, name and type.
833 */
834 public String resourceName;
835
836 /**
837 * Creates a new ShortcutIconResource for the specified context and resource
838 * identifier.
839 *
840 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700841 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700842 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700843 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700845 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700846 ShortcutIconResource icon = new ShortcutIconResource();
847 icon.packageName = context.getPackageName();
848 icon.resourceName = context.getResources().getResourceName(resourceId);
849 return icon;
850 }
851
852 /**
853 * Used to read a ShortcutIconResource from a Parcel.
854 */
855 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
856 new Parcelable.Creator<ShortcutIconResource>() {
857
858 public ShortcutIconResource createFromParcel(Parcel source) {
859 ShortcutIconResource icon = new ShortcutIconResource();
860 icon.packageName = source.readString();
861 icon.resourceName = source.readString();
862 return icon;
863 }
864
865 public ShortcutIconResource[] newArray(int size) {
866 return new ShortcutIconResource[size];
867 }
868 };
869
870 /**
871 * No special parcel contents.
872 */
873 public int describeContents() {
874 return 0;
875 }
876
877 public void writeToParcel(Parcel dest, int flags) {
878 dest.writeString(packageName);
879 dest.writeString(resourceName);
880 }
881
882 @Override
883 public String toString() {
884 return resourceName;
885 }
886 }
887
888 /**
889 * Activity Action: Display an activity chooser, allowing the user to pick
890 * what they want to before proceeding. This can be used as an alternative
891 * to the standard activity picker that is displayed by the system when
892 * you try to start an activity with multiple possible matches, with these
893 * differences in behavior:
894 * <ul>
895 * <li>You can specify the title that will appear in the activity chooser.
896 * <li>The user does not have the option to make one of the matching
897 * activities a preferred activity, and all possible activities will
898 * always be shown even if one of them is currently marked as the
899 * preferred activity.
900 * </ul>
901 * <p>
902 * This action should be used when the user will naturally expect to
903 * select an activity in order to proceed. An example if when not to use
904 * it is when the user clicks on a "mailto:" link. They would naturally
905 * expect to go directly to their mail app, so startActivity() should be
906 * called directly: it will
907 * either launch the current preferred app, or put up a dialog allowing the
908 * user to pick an app to use and optionally marking that as preferred.
909 * <p>
910 * In contrast, if the user is selecting a menu item to send a picture
911 * they are viewing to someone else, there are many different things they
912 * may want to do at this point: send it through e-mail, upload it to a
913 * web service, etc. In this case the CHOOSER action should be used, to
914 * always present to the user a list of the things they can do, with a
915 * nice title given by the caller such as "Send this photo with:".
916 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700917 * If you need to grant URI permissions through a chooser, you must specify
918 * the permissions to be granted on the ACTION_CHOOSER Intent
919 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
920 * {@link #setClipData} to specify the URIs to be granted as well as
921 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
922 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
923 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700924 * As a convenience, an Intent of this form can be created with the
925 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700926 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700927 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700928 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
929 * and can optionally have a {@link #EXTRA_TITLE} field containing the
930 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700931 * <p>
932 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700933 */
934 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
935 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
936
937 /**
938 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
939 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700940 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
941 * target intent, also optionally supplying a title. If the target
942 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
943 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
944 * set in the returned chooser intent, with its ClipData set appropriately:
945 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500946 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700947 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700948 * @param target The Intent that the user will be selecting an activity
949 * to perform.
950 * @param title Optional title that will be displayed in the chooser.
951 * @return Return a new Intent object that you can hand to
952 * {@link Context#startActivity(Intent) Context.startActivity()} and
953 * related methods.
954 */
955 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700956 return createChooser(target, title, null);
957 }
958
959 /**
960 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
961 *
962 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
963 * target intent, also optionally supplying a title. If the target
964 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
965 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
966 * set in the returned chooser intent, with its ClipData set appropriately:
967 * either a direct reflection of {@link #getClipData()} if that is non-null,
968 * or a new ClipData built from {@link #getData()}.</p>
969 *
970 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
971 * when the user makes a choice. This can be useful if the calling application wants
972 * to remember the last chosen target and surface it as a more prominent or one-touch
973 * affordance elsewhere in the UI for next time.</p>
974 *
975 * @param target The Intent that the user will be selecting an activity
976 * to perform.
977 * @param title Optional title that will be displayed in the chooser.
978 * @param sender Optional IntentSender to be called when a choice is made.
979 * @return Return a new Intent object that you can hand to
980 * {@link Context#startActivity(Intent) Context.startActivity()} and
981 * related methods.
982 */
983 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700984 Intent intent = new Intent(ACTION_CHOOSER);
985 intent.putExtra(EXTRA_INTENT, target);
986 if (title != null) {
987 intent.putExtra(EXTRA_TITLE, title);
988 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700989
Adam Powell0b3c1122014-10-09 12:50:14 -0700990 if (sender != null) {
991 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
992 }
993
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700994 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700995 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
996 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
997 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700998 if (permFlags != 0) {
999 ClipData targetClipData = target.getClipData();
1000 if (targetClipData == null && target.getData() != null) {
1001 ClipData.Item item = new ClipData.Item(target.getData());
1002 String[] mimeTypes;
1003 if (target.getType() != null) {
1004 mimeTypes = new String[] { target.getType() };
1005 } else {
1006 mimeTypes = new String[] { };
1007 }
1008 targetClipData = new ClipData(null, mimeTypes, item);
1009 }
1010 if (targetClipData != null) {
1011 intent.setClipData(targetClipData);
1012 intent.addFlags(permFlags);
1013 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001014 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001015
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001016 return intent;
1017 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001018
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 /**
1020 * Activity Action: Allow the user to select a particular kind of data and
1021 * return it. This is different than {@link #ACTION_PICK} in that here we
1022 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001023 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001025 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001026 * etc.
1027 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001028 * 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 -07001029 * of data, such as a person contact, you set the MIME type to the kind of
1030 * data you want and launch it with {@link Context#startActivity(Intent)}.
1031 * The system will then launch the best application to select that kind
1032 * of data for you.
1033 * <p>
1034 * You may also be interested in any of a set of types of content the user
1035 * can pick. For example, an e-mail application that wants to allow the
1036 * user to add an attachment to an e-mail message can use this action to
1037 * bring up a list of all of the types of content the user can attach.
1038 * <p>
1039 * In this case, you should wrap the GET_CONTENT intent with a chooser
1040 * (through {@link #createChooser}), which will give the proper interface
1041 * for the user to pick how to send your data and allow you to specify
1042 * a prompt indicating what they are doing. You will usually specify a
1043 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1044 * broad range of content types the user can select from.
1045 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001046 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001047 * only pick from data that can be represented as a stream. This is
1048 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1049 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001050 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001051 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001052 * is locally available on the device. For example, if this extra is set
1053 * to true then an image picker should not show any pictures that are available
1054 * from a remote server but not already on the local device (thus requiring
1055 * they be downloaded when opened).
1056 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001057 * If the caller can handle multiple returned items (the user performing
1058 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1059 * to indicate this.
1060 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001061 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1062 * that no URI is supplied in the intent, as there are no constraints on
1063 * where the returned data originally comes from. You may also include the
1064 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001065 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001066 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1067 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001068 * <p>
1069 * Output: The URI of the item that was picked. This must be a content:
1070 * URI so that any receiver can access it.
1071 */
1072 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1073 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1074 /**
1075 * Activity Action: Dial a number as specified by the data. This shows a
1076 * UI with the number being dialed, allowing the user to explicitly
1077 * initiate the call.
1078 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1079 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1080 * number.
1081 * <p>Output: nothing.
1082 */
1083 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1084 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1085 /**
1086 * Activity Action: Perform a call to someone specified by the data.
1087 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1088 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1089 * number.
1090 * <p>Output: nothing.
1091 *
1092 * <p>Note: there will be restrictions on which applications can initiate a
1093 * call; most applications should use the {@link #ACTION_DIAL}.
1094 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1095 * numbers. Applications can <strong>dial</strong> emergency numbers using
1096 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001097 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001098 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001099 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001100 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001101 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001102 */
1103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1104 public static final String ACTION_CALL = "android.intent.action.CALL";
1105 /**
1106 * Activity Action: Perform a call to an emergency number specified by the
1107 * data.
1108 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1109 * tel: URI of an explicit phone number.
1110 * <p>Output: nothing.
1111 * @hide
1112 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001113 @SystemApi
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001115 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1116 /**
1117 * Activity action: Perform a call to any number (emergency or not)
1118 * specified by the data.
1119 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1120 * tel: URI of an explicit phone number.
1121 * <p>Output: nothing.
1122 * @hide
1123 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001124 @SystemApi
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001126 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001127
Santos Cordon15a13782015-03-31 18:32:31 -07001128 /**
fionaxuadfe7002017-02-17 17:20:46 -08001129 * Activity Action: Main entry point for carrier setup apps.
1130 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1131 * carrier service and typically require
1132 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1133 * fulfill their duties.
1134 */
1135 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1136 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1137 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001138 * Activity Action: Send a message to someone specified by the data.
1139 * <p>Input: {@link #getData} is URI describing the target.
1140 * <p>Output: nothing.
1141 */
1142 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1143 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1144 /**
1145 * Activity Action: Deliver some data to someone else. Who the data is
1146 * being delivered to is not specified; it is up to the receiver of this
1147 * action to ask the user where the data should be sent.
1148 * <p>
1149 * When launching a SEND intent, you should usually wrap it in a chooser
1150 * (through {@link #createChooser}), which will give the proper interface
1151 * for the user to pick how to send your data and allow you to specify
1152 * a prompt indicating what they are doing.
1153 * <p>
1154 * Input: {@link #getType} is the MIME type of the data being sent.
1155 * get*Extra can have either a {@link #EXTRA_TEXT}
1156 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1157 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1158 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1159 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001160 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1161 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1162 * your text with HTML formatting.
1163 * <p>
1164 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1165 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1166 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1167 * content: URIs and other advanced features of {@link ClipData}. If
1168 * using this approach, you still must supply the same data through the
1169 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1170 * for compatibility with old applications. If you don't set a ClipData,
1171 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001172 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001173 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1174 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1175 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1176 * be openable only as asset typed files using
1177 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1178 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001179 * Optional standard extras, which may be interpreted by some recipients as
1180 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1181 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1182 * <p>
1183 * Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_SEND = "android.intent.action.SEND";
1187 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001188 * Activity Action: Deliver multiple data to someone else.
1189 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001190 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001191 * <p>
1192 * Input: {@link #getType} is the MIME type of the data being sent.
1193 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001194 * #EXTRA_STREAM} field, containing the data to be sent. If using
1195 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1196 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001197 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001198 * Multiple types are supported, and receivers should handle mixed types
1199 * whenever possible. The right way for the receiver to check them is to
1200 * use the content resolver on each URI. The intent sender should try to
1201 * put the most concrete mime type in the intent type, but it can fall
1202 * back to {@literal <type>/*} or {@literal *}/* as needed.
1203 * <p>
1204 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1205 * be image/jpg, but if you are sending image/jpg and image/png, then the
1206 * intent's type should be image/*.
1207 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001208 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1209 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1210 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1211 * content: URIs and other advanced features of {@link ClipData}. If
1212 * using this approach, you still must supply the same data through the
1213 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1214 * for compatibility with old applications. If you don't set a ClipData,
1215 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1216 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001217 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1218 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1219 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1220 * be openable only as asset typed files using
1221 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1222 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001223 * Optional standard extras, which may be interpreted by some recipients as
1224 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1225 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1226 * <p>
1227 * Output: nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1231 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001232 * Activity Action: Handle an incoming phone call.
1233 * <p>Input: nothing.
1234 * <p>Output: nothing.
1235 */
1236 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1237 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1238 /**
1239 * Activity Action: Insert an empty item into the given container.
1240 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1241 * in which to place the data.
1242 * <p>Output: URI of the new data that was created.
1243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1246 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001247 * Activity Action: Create a new item in the given container, initializing it
1248 * from the current contents of the clipboard.
1249 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1250 * in which to place the data.
1251 * <p>Output: URI of the new data that was created.
1252 */
1253 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1254 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1255 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001256 * Activity Action: Delete the given data from its container.
1257 * <p>Input: {@link #getData} is URI of data to be deleted.
1258 * <p>Output: nothing.
1259 */
1260 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1261 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1262 /**
1263 * Activity Action: Run the data, whatever that means.
1264 * <p>Input: ? (Note: this is currently specific to the test harness.)
1265 * <p>Output: nothing.
1266 */
1267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1268 public static final String ACTION_RUN = "android.intent.action.RUN";
1269 /**
1270 * Activity Action: Perform a data synchronization.
1271 * <p>Input: ?
1272 * <p>Output: ?
1273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1276 /**
1277 * Activity Action: Pick an activity given an intent, returning the class
1278 * selected.
1279 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1280 * used with {@link PackageManager#queryIntentActivities} to determine the
1281 * set of activities from which to pick.
1282 * <p>Output: Class name of the activity that was selected.
1283 */
1284 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1285 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1286 /**
1287 * Activity Action: Perform a search.
1288 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1289 * is the text to search for. If empty, simply
1290 * enter your search results Activity with the search UI activated.
1291 * <p>Output: nothing.
1292 */
1293 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1294 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1295 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001296 * Activity Action: Start the platform-defined tutorial
1297 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1298 * is the text to search for. If empty, simply
1299 * enter your search results Activity with the search UI activated.
1300 * <p>Output: nothing.
1301 */
1302 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1303 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1304 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001305 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001306 * <p>
1307 * Input: {@link android.app.SearchManager#QUERY
1308 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1309 * a url starts with http or https, the site will be opened. If it is plain
1310 * text, Google search will be applied.
1311 * <p>
1312 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001313 */
1314 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1315 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001316
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001317 /**
Jim Miller07994402012-05-02 14:22:27 -07001318 * Activity Action: Perform assist action.
1319 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001320 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1321 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001322 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1323 * information.
Jim Miller07994402012-05-02 14:22:27 -07001324 * Output: nothing.
1325 */
1326 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1327 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001328
1329 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001330 * Activity Action: Perform voice assist action.
1331 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001332 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1333 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001334 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001335 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001336 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001337 */
Amith Yamasani16452032017-03-03 10:15:57 -08001338 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001339 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1340 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1341
1342 /**
Adam Skory7140a252013-09-11 12:04:58 +01001343 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1344 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001345 */
1346 public static final String EXTRA_ASSIST_PACKAGE
1347 = "android.intent.extra.ASSIST_PACKAGE";
1348
1349 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001350 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1351 * application package at the time the assist was invoked.
1352 */
1353 public static final String EXTRA_ASSIST_UID
1354 = "android.intent.extra.ASSIST_UID";
1355
1356 /**
Adam Skory7140a252013-09-11 12:04:58 +01001357 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1358 * information supplied by the current foreground app at the time of the assist request.
1359 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001360 */
1361 public static final String EXTRA_ASSIST_CONTEXT
1362 = "android.intent.extra.ASSIST_CONTEXT";
1363
Jim Miller07994402012-05-02 14:22:27 -07001364 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001365 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1366 * keyboard as the primary input device for assistance.
1367 */
1368 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1369 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1370
1371 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001372 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1373 * that was used to invoke the assist.
1374 */
1375 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1376 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1377
1378 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001379 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 * <p>Input: Nothing.
1381 * <p>Output: nothing.
1382 */
1383 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1384 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1385 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001386 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001387 * <p>Input: Nothing.
1388 * <p>Output: Nothing.
1389 */
1390 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1391 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1392
1393 /**
1394 * Activity Action: Show activity for reporting a bug.
1395 * <p>Input: Nothing.
1396 * <p>Output: Nothing.
1397 */
1398 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1399 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1400
1401 /**
1402 * Activity Action: Main entry point for factory tests. Only used when
1403 * the device is booting in factory test node. The implementing package
1404 * must be installed in the system image.
1405 * <p>Input: nothing
1406 * <p>Output: nothing
1407 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001408 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001409 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1410
1411 /**
1412 * Activity Action: The user pressed the "call" button to go to the dialer
1413 * or other appropriate UI for placing a call.
1414 * <p>Input: Nothing.
1415 * <p>Output: Nothing.
1416 */
1417 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1418 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1419
1420 /**
1421 * Activity Action: Start Voice Command.
1422 * <p>Input: Nothing.
1423 * <p>Output: Nothing.
Christopher Tate72da1e62018-05-10 13:09:48 -07001424 * <p class="note">
1425 * In some cases, a matching Activity may not exist, so ensure you
1426 * safeguard against this.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 */
1428 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1429 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001430
1431 /**
1432 * Activity Action: Start action associated with long pressing on the
1433 * search key.
1434 * <p>Input: Nothing.
1435 * <p>Output: Nothing.
1436 */
1437 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1438 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001439
Jacek Surazski86b6c532009-05-13 14:38:28 +02001440 /**
1441 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1442 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001443 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001444 * <p>Input: No data is specified. The bug report is passed in using
1445 * an {@link #EXTRA_BUG_REPORT} field.
1446 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001447 *
1448 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001449 */
1450 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1451 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001452
1453 /**
1454 * Activity Action: Show power usage information to the user.
1455 * <p>Input: Nothing.
1456 * <p>Output: Nothing.
1457 */
1458 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1459 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001460
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001461 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001462 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1463 * to run.
1464 * <p>Input: Nothing.
1465 * <p>Output: Nothing.
1466 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1467 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1468 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001469 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001470 */
1471 @Deprecated
1472 @SystemApi
1473 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1474 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1475
1476 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001477 * Activity Action: Setup wizard to launch after a platform update. This
1478 * activity should have a string meta-data field associated with it,
1479 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1480 * the platform for setup. The activity will be launched only if
1481 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1482 * same value.
1483 * <p>Input: Nothing.
1484 * <p>Output: Nothing.
1485 * @hide
1486 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001487 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001488 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1489 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001490
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001491 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001492 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1493 * <p>Input: Nothing.
1494 * <p>Output: Nothing.
1495 * @hide
1496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001499 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001500
1501 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001502 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1503 * <p>Input: Nothing.
1504 * <p>Output: Nothing.
1505 * @hide
1506 */
1507 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1508 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001509 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001510
1511 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001512 * Activity Action: Show settings for managing network data usage of a
1513 * specific application. Applications should define an activity that offers
1514 * options to control data usage.
1515 */
1516 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1517 public static final String ACTION_MANAGE_NETWORK_USAGE =
1518 "android.intent.action.MANAGE_NETWORK_USAGE";
1519
1520 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001521 * Activity Action: Launch application installer.
1522 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001523 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001524 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1525 * you can also use "package:<package-name>" to install an application for the
1526 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001527 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1528 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1529 * <p>
1530 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1531 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001532 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001533 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001534 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1535 * in order to launch the application installer.
1536 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001537 *
1538 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1539 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1540 * @see #EXTRA_RETURN_RESULT
1541 */
1542 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1543 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1544
1545 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001546 * Activity Action: Activity to handle split installation failures.
1547 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1548 * but the split that contains the application isn't installed. When a split is
1549 * installed in this manner, the containing package usually doesn't know this is
1550 * happening. However, if an error occurs during installation, the containing
1551 * package can define a single activity handling this action to deal with such
1552 * failures.
1553 * <p>The activity handling this action must be in the base package.
1554 * <p>
1555 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1556 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1557 */
1558 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1559 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1560
1561 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001562 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001563 * <p class="note">
1564 * This is a protected intent that can only be sent by the system.
1565 * </p>
1566 *
1567 * @hide
1568 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001569 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001570 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001571 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1572 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001573
1574 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001575 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001576 * <p>
1577 * The system will have a persistent connection to this service.
1578 * This is a protected intent that can only be sent by the system.
1579 * </p>
1580 *
1581 * @hide
1582 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001583 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001584 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001585 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1586 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001587
1588 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001589 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001590 *
1591 * <p class="note">
1592 * This is a protected intent that can only be sent by the system.
1593 * </p>
1594 *
1595 * @hide
1596 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001597 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001598 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001599 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1600 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001601
1602 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001603 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1604 * package. Specifies the installer package name; this package will receive the
1605 * {@link #ACTION_APP_ERROR} intent.
1606 */
1607 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1608 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1609
1610 /**
1611 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1612 * package. Specifies that the application being installed should not be
1613 * treated as coming from an unknown source, but as coming from the app
1614 * invoking the Intent. For this to work you must start the installer with
1615 * startActivityForResult().
1616 */
1617 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1618 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1619
1620 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001621 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1622 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001623 * data field originated from.
1624 */
rich cannings706e8ba2012-08-20 13:20:14 -07001625 public static final String EXTRA_ORIGINATING_URI
1626 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001627
1628 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001629 * This extra can be used with any Intent used to launch an activity, supplying information
1630 * about who is launching that activity. This field contains a {@link android.net.Uri}
1631 * object, typically an http: or https: URI of the web site that the referral came from;
1632 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1633 * a native application that it came from.
1634 *
1635 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1636 * instead of directly retrieving the extra. It is also valid for applications to
1637 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1638 * a string, not a Uri; the field here, if supplied, will always take precedence,
1639 * however.</p>
1640 *
1641 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001642 */
1643 public static final String EXTRA_REFERRER
1644 = "android.intent.extra.REFERRER";
1645
1646 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001647 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1648 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1649 * not be created, in particular when Intent extras are supplied through the
1650 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1651 * schemes.
1652 *
1653 * @see #EXTRA_REFERRER
1654 */
1655 public static final String EXTRA_REFERRER_NAME
1656 = "android.intent.extra.REFERRER_NAME";
1657
1658 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001659 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001660 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001661 * Currently only a system app that hosts the provider authority "downloads" or holds the
1662 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001663 * @hide
1664 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001665 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001666 public static final String EXTRA_ORIGINATING_UID
1667 = "android.intent.extra.ORIGINATING_UID";
1668
1669 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001670 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1671 * package. Tells the installer UI to skip the confirmation with the user
1672 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001673 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1674 * will no longer show an interstitial message about updating existing
1675 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001676 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001677 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001678 public static final String EXTRA_ALLOW_REPLACE
1679 = "android.intent.extra.ALLOW_REPLACE";
1680
1681 /**
1682 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1683 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1684 * return to the application the result code of the install/uninstall. The returned result
1685 * code will be {@link android.app.Activity#RESULT_OK} on success or
1686 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1687 */
1688 public static final String EXTRA_RETURN_RESULT
1689 = "android.intent.extra.RETURN_RESULT";
1690
1691 /**
1692 * Package manager install result code. @hide because result codes are not
1693 * yet ready to be exposed.
1694 */
1695 public static final String EXTRA_INSTALL_RESULT
1696 = "android.intent.extra.INSTALL_RESULT";
1697
1698 /**
1699 * Activity Action: Launch application uninstaller.
1700 * <p>
1701 * Input: The data must be a package: URI whose scheme specific part is
1702 * the package name of the current installed package to be uninstalled.
1703 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1704 * <p>
1705 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1706 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001707 * <p>
1708 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1709 * since {@link Build.VERSION_CODES#P}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001710 */
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 /**
Suprabh Shukla96212bc2018-04-10 15:04:51 -07001822 * Intent extra: A {@link Bundle} of extras for a package being suspended. Will be sent as an
1823 * extra with {@link #ACTION_MY_PACKAGE_SUSPENDED}.
1824 *
1825 * <p>The contents of this {@link Bundle} are a contract between the suspended app and the
1826 * suspending app, i.e. any app with the permission {@code android.permission.SUSPEND_APPS}.
1827 * This is meant to enable the suspended app to better handle the state of being suspended.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07001828 *
1829 * @see #ACTION_MY_PACKAGE_SUSPENDED
1830 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
1831 * @see PackageManager#isPackageSuspended()
1832 * @see PackageManager#getSuspendedPackageAppExtras()
1833 */
1834 public static final String EXTRA_SUSPENDED_PACKAGE_EXTRAS = "android.intent.extra.SUSPENDED_PACKAGE_EXTRAS";
1835
1836 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001837 * Intent extra: An app split name.
1838 * <p>
1839 * Type: String
1840 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001841 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001842 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1843
1844 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001845 * Intent extra: A {@link ComponentName} value.
1846 * <p>
1847 * Type: String
1848 * </p>
1849 */
1850 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1851
1852 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001853 * Intent extra: An extra for specifying whether a result is needed.
1854 * <p>
1855 * Type: boolean
1856 * </p>
1857 *
1858 * @hide
1859 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001860 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001861 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1862
1863 /**
Suprabh Shukla19b41f32018-03-26 22:35:13 -07001864 * Intent extra: A {@link Bundle} of extras supplied for the launcher when any packages on
1865 * device are suspended. Will be sent with {@link #ACTION_PACKAGES_SUSPENDED}.
1866 *
1867 * @see PackageManager#isPackageSuspended()
1868 * @see #ACTION_PACKAGES_SUSPENDED
1869 *
1870 * @hide
1871 */
1872 public static final String EXTRA_LAUNCHER_EXTRAS = "android.intent.extra.LAUNCHER_EXTRAS";
1873
1874 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001875 * Activity action: Launch UI to manage which apps have a given permission.
1876 * <p>
1877 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1878 * to which will be managed by the launched UI.
1879 * </p>
1880 * <p>
1881 * Output: Nothing.
1882 * </p>
1883 *
1884 * @see #EXTRA_PERMISSION_NAME
1885 *
1886 * @hide
1887 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001888 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001889 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1890 public static final String ACTION_MANAGE_PERMISSION_APPS =
1891 "android.intent.action.MANAGE_PERMISSION_APPS";
1892
1893 /**
1894 * Intent extra: The name of a permission.
1895 * <p>
1896 * Type: String
1897 * </p>
1898 *
1899 * @hide
1900 */
1901 @SystemApi
1902 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1903
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 // ---------------------------------------------------------------------
1905 // ---------------------------------------------------------------------
1906 // Standard intent broadcast actions (see action variable).
1907
1908 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001909 * Broadcast Action: Sent when the device goes to sleep and becomes non-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 non-interactive which may have
1916 * nothing to do with the screen turning off. 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_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001933 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1934 * <p>
1935 * For historical reasons, the name of this broadcast action refers to the power
1936 * state of the screen but it is actually sent in response to changes in the
1937 * overall interactive state of the device.
1938 * </p><p>
1939 * This broadcast is sent when the device becomes interactive which may have
1940 * nothing to do with the screen turning on. To determine the
1941 * actual state of the screen, use {@link android.view.Display#getState}.
1942 * </p><p>
1943 * See {@link android.os.PowerManager#isInteractive} for details.
1944 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001945 * You <em>cannot</em> receive this through components declared in
1946 * manifests, only by explicitly registering for it with
1947 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1948 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001949 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001950 * <p class="note">This is a protected intent that can only be sent
1951 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001955
1956 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001957 * Broadcast Action: Sent after the system stops dreaming.
1958 *
1959 * <p class="note">This is a protected intent that can only be sent by the system.
1960 * It is only sent to registered receivers.</p>
1961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1964
1965 /**
1966 * Broadcast Action: Sent after the system starts dreaming.
1967 *
1968 * <p class="note">This is a protected intent that can only be sent by the system.
1969 * It is only sent to registered receivers.</p>
1970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1973
1974 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001975 * 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 -07001976 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001977 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001978 * <p class="note">This is a protected intent that can only be sent
1979 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001982 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001983
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 /**
1985 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001986 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001987 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001988 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1989 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001990 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001991 * <p class="note">This is a protected intent that can only be sent
1992 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1996 /**
1997 * Broadcast Action: The time was set.
1998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
2001 /**
2002 * Broadcast Action: The date has changed.
2003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2006 /**
2007 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2008 * <ul>
2009 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2010 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002011 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002012 * <p class="note">This is a protected intent that can only be sent
2013 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002014 */
2015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2017 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002018 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2019 * DNS entries should be tossed.
2020 * @hide
2021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2024 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 * Alarm Changed Action: This is broadcast when the AlarmClock
2026 * application's alarm is set or unset. It is used by the
2027 * AlarmClock application and the StatusBar service.
2028 * @hide
2029 */
2030 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002031 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002033
2034 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002035 * Broadcast Action: This is broadcast once, after the user has finished
2036 * booting, but while still in the "locked" state. It can be used to perform
2037 * application-specific initialization, such as installing alarms. You must
2038 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2039 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002040 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002041 * This broadcast is sent immediately at boot by all devices (regardless of
2042 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2043 * higher. Upon receipt of this broadcast, the user is still locked and only
2044 * device-protected storage can be accessed safely. If you want to access
2045 * credential-protected storage, you need to wait for the user to be
2046 * unlocked (typically by entering their lock pattern or PIN for the first
2047 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2048 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2049 * <p>
2050 * To receive this broadcast, your receiver component must be marked as
2051 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002052 * <p class="note">
2053 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002054 *
2055 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002056 */
2057 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2058 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002061 * Broadcast Action: This is broadcast once, after the user has finished
2062 * booting. It can be used to perform application-specific initialization,
2063 * such as installing alarms. You must hold the
2064 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2065 * order to receive this broadcast.
2066 * <p>
2067 * This broadcast is sent at boot by all devices (both with and without
2068 * direct boot support). Upon receipt of this broadcast, the user is
2069 * unlocked and both device-protected and credential-protected storage can
2070 * accessed safely.
2071 * <p>
2072 * If you need to run while the user is still locked (before they've entered
2073 * their lock pattern or PIN for the first time), you can listen for the
2074 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2075 * <p class="note">
2076 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002079 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002080 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002081
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002082 /**
2083 * Broadcast Action: This is broadcast when a user action should request a
2084 * temporary system dialog to dismiss. Some examples of temporary system
2085 * dialogs are the notification window-shade and the recent tasks dialog.
2086 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2089 /**
2090 * Broadcast Action: Trigger the download and eventual installation
2091 * of a package.
2092 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002093 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002094 * <p class="note">This is a protected intent that can only be sent
2095 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002096 *
2097 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002099 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2102 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002103 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002104 * device. The data contains the name of the package. Note that the
2105 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002106 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002107 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002108 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2109 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002110 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2111 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002112 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002113 * <p class="note">This is a protected intent that can only be sent
2114 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2118 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002119 * Broadcast Action: A new version of an application package has been
2120 * installed, replacing an existing version that was previously installed.
2121 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002122 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002123 * <ul>
2124 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2125 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002126 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002127 * <p class="note">This is a protected intent that can only be sent
2128 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002129 */
2130 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2131 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2132 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002133 * Broadcast Action: A new version of your application has been installed
2134 * over an existing one. This is only sent to the application that was
2135 * replaced. It does not contain any additional data; to receive it, just
2136 * use an intent filter for this action.
2137 *
2138 * <p class="note">This is a protected intent that can only be sent
2139 * by the system.
2140 */
2141 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2142 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2143 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002144 * Broadcast Action: An existing application package has been removed from
2145 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002146 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002147 * <ul>
2148 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2149 * to the package.
2150 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2151 * application -- data and code -- is being removed.
2152 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2153 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2154 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002155 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002156 * <p class="note">This is a protected intent that can only be sent
2157 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002158 */
2159 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2160 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2161 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002162 * Broadcast Action: An existing application package has been completely
2163 * removed from the device. The data contains the name of the package.
2164 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2165 * {@link #EXTRA_DATA_REMOVED} is true and
2166 * {@link #EXTRA_REPLACING} is false of that broadcast.
2167 *
2168 * <ul>
2169 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2170 * to the package.
2171 * </ul>
2172 *
2173 * <p class="note">This is a protected intent that can only be sent
2174 * by the system.
2175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_PACKAGE_FULLY_REMOVED
2178 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2179 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002180 * Broadcast Action: An existing application package has been changed (for
2181 * example, a component has been enabled or disabled). The data contains
2182 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002183 * <ul>
2184 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002185 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002186 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002187 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2188 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002189 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002190 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002191 * <p class="note">This is a protected intent that can only be sent
2192 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002193 */
2194 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2195 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2196 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002197 * @hide
2198 * Broadcast Action: Ask system services if there is any reason to
2199 * restart the given package. The data contains the name of the
2200 * package.
2201 * <ul>
2202 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2203 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2204 * </ul>
2205 *
2206 * <p class="note">This is a protected intent that can only be sent
2207 * by the system.
2208 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002209 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002210 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2211 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2212 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002213 * Broadcast Action: The user has restarted a package, and all of its
2214 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002215 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002216 * be removed. Note that the restarted package does <em>not</em>
2217 * receive this broadcast.
2218 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002219 * <ul>
2220 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2221 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002222 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002223 * <p class="note">This is a protected intent that can only be sent
2224 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2227 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2228 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002229 * Broadcast Action: The user has cleared the data of a package. This should
2230 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002231 * its persistent data is erased and this broadcast sent.
2232 * Note that the cleared package does <em>not</em>
2233 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002234 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002235 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2236 * package whose data was cleared is an uninstalled instant app, then the UID
2237 * will be -1. The platform keeps some meta-data associated with instant apps
2238 * after they are uninstalled.
2239 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2240 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002241 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002242 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002243 * <p class="note">This is a protected intent that can only be sent
2244 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002245 */
2246 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2247 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2248 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002249 * Broadcast Action: Packages have been suspended.
2250 * <p>Includes the following extras:
2251 * <ul>
2252 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002253 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been suspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002254 * </ul>
2255 *
2256 * <p class="note">This is a protected intent that can only be sent
2257 * by the system. It is only sent to registered receivers.
2258 */
2259 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2260 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2261 /**
2262 * Broadcast Action: Packages have been unsuspended.
2263 * <p>Includes the following extras:
2264 * <ul>
2265 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
Julia Reynolds4bc42b92018-08-14 11:27:35 -04002266 * <li> {@link #EXTRA_CHANGED_UID_LIST} is the set of uids which have been unsuspended
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002267 * </ul>
2268 *
2269 * <p class="note">This is a protected intent that can only be sent
2270 * by the system. It is only sent to registered receivers.
2271 */
2272 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2273 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002274
2275 /**
2276 * Broadcast Action: Sent to a package that has been suspended by the system. This is sent
Suprabh Shukla19b41f32018-03-26 22:35:13 -07002277 * whenever a package is put into a suspended state or any of its app extras change while in the
2278 * suspended state.
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002279 * <p> Optionally includes the following extras:
2280 * <ul>
2281 * <li> {@link #EXTRA_SUSPENDED_PACKAGE_EXTRAS} which is a {@link Bundle} which will contain
2282 * useful information for the app being suspended.
2283 * </ul>
2284 * <p class="note">This is a protected intent that can only be sent
2285 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2286 * the manifest.</em>
2287 *
2288 * @see #ACTION_MY_PACKAGE_UNSUSPENDED
2289 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2290 * @see PackageManager#isPackageSuspended()
2291 * @see PackageManager#getSuspendedPackageAppExtras()
2292 */
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_MY_PACKAGE_SUSPENDED = "android.intent.action.MY_PACKAGE_SUSPENDED";
2295
2296 /**
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002297 * Activity Action: Started to show more details about why an application was suspended.
2298 *
Suprabh Shukla3e03ab92018-04-11 16:03:49 -07002299 * <p>Whenever the system detects an activity launch for a suspended app, this action can
2300 * be used to show more details about the reason for suspension.
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002301 *
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002302 * <p>Apps holding {@link android.Manifest.permission#SUSPEND_APPS} must declare an activity
2303 * handling this intent and protect it with
2304 * {@link android.Manifest.permission#SEND_SHOW_SUSPENDED_APP_DETAILS}.
2305 *
2306 * <p>Includes an extra {@link #EXTRA_PACKAGE_NAME} which is the name of the suspended package.
2307 *
2308 * <p class="note">This is a protected intent that can only be sent
2309 * by the system.
2310 *
Suprabh Shukla96212bc2018-04-10 15:04:51 -07002311 * @see PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle,
2312 * PersistableBundle, String)
Suprabh Shukla3c3af142018-03-30 00:28:37 -07002313 * @see PackageManager#isPackageSuspended()
2314 * @see #ACTION_PACKAGES_SUSPENDED
2315 *
2316 * @hide
2317 */
2318 @SystemApi
2319 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2320 public static final String ACTION_SHOW_SUSPENDED_APP_DETAILS =
2321 "android.intent.action.SHOW_SUSPENDED_APP_DETAILS";
2322
2323 /**
Suprabh Shukla2fd43ba2018-03-22 16:57:49 -07002324 * Broadcast Action: Sent to a package that has been unsuspended.
2325 *
2326 * <p class="note">This is a protected intent that can only be sent
2327 * by the system. <em>This will be delivered to {@link BroadcastReceiver} components declared in
2328 * the manifest.</em>
2329 *
2330 * @see #ACTION_MY_PACKAGE_SUSPENDED
2331 * @see #EXTRA_SUSPENDED_PACKAGE_EXTRAS
2332 * @see PackageManager#isPackageSuspended()
2333 * @see PackageManager#getSuspendedPackageAppExtras()
2334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2336 public static final String ACTION_MY_PACKAGE_UNSUSPENDED = "android.intent.action.MY_PACKAGE_UNSUSPENDED";
2337
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002338 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002339 * Broadcast Action: A user ID has been removed from the system. The user
2340 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002341 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002342 * <p class="note">This is a protected intent that can only be sent
2343 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 */
2345 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2346 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002347
2348 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002349 * Broadcast Action: Sent to the installer package of an application when
2350 * that application is first launched (that is the first time it is moved
2351 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002352 *
2353 * <p class="note">This is a protected intent that can only be sent
2354 * by the system.
2355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2358
2359 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002360 * Broadcast Action: Sent to the system package verifier when a package
2361 * needs to be verified. The data contains the package URI.
2362 * <p class="note">
2363 * This is a protected intent that can only be sent by the system.
2364 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002365 */
2366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2367 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2368
2369 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002370 * Broadcast Action: Sent to the system package verifier when a package is
2371 * verified. The data contains the package URI.
2372 * <p class="note">
2373 * This is a protected intent that can only be sent by the system.
2374 */
2375 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2376 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2377
2378 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002379 * Broadcast Action: Sent to the system intent filter verifier when an
2380 * intent filter needs to be verified. The data contains the filter data
2381 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002382 * <p class="note">
2383 * This is a protected intent that can only be sent by the system.
2384 * </p>
2385 *
2386 * @hide
2387 */
2388 @SystemApi
2389 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2390 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2391
2392 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002393 * Broadcast Action: Resources for a set of packages (which were
2394 * previously unavailable) are currently
2395 * available since the media on which they exist is available.
2396 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2397 * list of packages whose availability changed.
2398 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2399 * list of uids of packages whose availability changed.
2400 * Note that the
2401 * packages in this list do <em>not</em> receive this broadcast.
2402 * The specified set of packages are now available on the system.
2403 * <p>Includes the following extras:
2404 * <ul>
2405 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2406 * whose resources(were previously unavailable) are currently available.
2407 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2408 * packages whose resources(were previously unavailable)
2409 * are currently available.
2410 * </ul>
2411 *
2412 * <p class="note">This is a protected intent that can only be sent
2413 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002414 */
2415 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002416 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2417 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002418
2419 /**
2420 * Broadcast Action: Resources for a set of packages are currently
2421 * unavailable since the media on which they exist is unavailable.
2422 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2423 * list of packages whose availability changed.
2424 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2425 * list of uids of packages whose availability changed.
2426 * The specified set of packages can no longer be
2427 * launched and are practically unavailable on the system.
2428 * <p>Inclues the following extras:
2429 * <ul>
2430 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2431 * whose resources are no longer available.
2432 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2433 * whose resources are no longer available.
2434 * </ul>
2435 *
2436 * <p class="note">This is a protected intent that can only be sent
2437 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002438 */
2439 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002440 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002441 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002442
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002443 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002444 * Broadcast Action: preferred activities have changed *explicitly*.
2445 *
2446 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2447 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2448 * be sent.
2449 *
2450 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2451 *
2452 * @hide
2453 */
2454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2455 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2456 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2457
2458
2459 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002460 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002461 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002462 * This should <em>only</em> be used to determine when the wallpaper
2463 * has changed to show the new wallpaper to the user. You should certainly
2464 * never, in response to this, change the wallpaper or other attributes of
2465 * it such as the suggested size. That would be crazy, right? You'd cause
2466 * all kinds of loops, especially if other apps are doing similar things,
2467 * right? Of course. So please don't do this.
2468 *
2469 * @deprecated Modern applications should use
2470 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2471 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2472 * shown behind their UI, rather than watching for this broadcast and
2473 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002474 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002475 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002476 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2477 /**
2478 * Broadcast Action: The current device {@link android.content.res.Configuration}
2479 * (orientation, locale, etc) has changed. When such a change happens, the
2480 * UIs (view hierarchy) will need to be rebuilt based on this new
2481 * information; for the most part, applications don't need to worry about
2482 * this, because the system will take care of stopping and restarting the
2483 * application to make sure it sees the new changes. Some system code that
2484 * can not be restarted will need to watch for this action and handle it
2485 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002486 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002487 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002488 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002489 * in manifests, only by explicitly registering for it with
2490 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2491 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002492 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002493 * <p class="note">This is a protected intent that can only be sent
2494 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002495 *
2496 * @see android.content.res.Configuration
2497 */
2498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2499 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
Adam Lesinski57fccd62018-01-25 13:03:57 -08002500
2501 /**
2502 * Broadcast Action: The current device {@link android.content.res.Configuration} has changed
2503 * such that the device may be eligible for the installation of additional configuration splits.
2504 * Configuration properties that can trigger this broadcast include locale and display density.
2505 *
2506 * <p class="note">
2507 * Unlike {@link #ACTION_CONFIGURATION_CHANGED}, you <em>can</em> receive this through
2508 * components declared in manifests. However, the receiver <em>must</em> hold the
2509 * {@link android.Manifest.permission#INSTALL_PACKAGES} permission.
2510 *
2511 * <p class="note">
2512 * This is a protected intent that can only be sent by the system.
2513 *
2514 * @hide
2515 */
2516 @SystemApi
2517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2518 public static final String ACTION_SPLIT_CONFIGURATION_CHANGED =
2519 "android.intent.action.SPLIT_CONFIGURATION_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002520 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002521 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002522 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002523 * <p class="note">This is a protected intent that can only be sent
2524 * by the system.
2525 */
2526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2527 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2528 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002529 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2530 * charging state, level, and other information about the battery.
2531 * See {@link android.os.BatteryManager} for documentation on the
2532 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002533 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002535 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002536 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002537 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002538 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2539 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2540 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2541 * broadcasts that are sent and can be received through manifest
2542 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002543 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002544 * <p class="note">This is a protected intent that can only be sent
2545 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002546 */
2547 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2548 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
Fyodor Kupolov70e75432018-03-01 18:29:06 -08002549
2550
2551 /**
2552 * Broadcast Action: Sent when the current battery level changes.
2553 *
2554 * It has {@link android.os.BatteryManager#EXTRA_EVENTS} that carries a list of {@link Bundle}
2555 * instances representing individual battery level changes with associated
2556 * extras from {@link #ACTION_BATTERY_CHANGED}.
2557 *
2558 * <p class="note">
2559 * This broadcast requires {@link android.Manifest.permission#BATTERY_STATS} permission.
2560 *
2561 * @hide
2562 */
2563 @SystemApi
2564 public static final String ACTION_BATTERY_LEVEL_CHANGED =
2565 "android.intent.action.BATTERY_LEVEL_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002566 /**
2567 * Broadcast Action: Indicates low battery condition on the device.
2568 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002570 * <p class="note">This is a protected intent that can only be sent
2571 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2574 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2575 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002576 * Broadcast Action: Indicates the battery is now okay after being low.
2577 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2578 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002579 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002580 * <p class="note">This is a protected intent that can only be sent
2581 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002582 */
2583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2584 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2585 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002586 * Broadcast Action: External power has been connected to the device.
2587 * This is intended for applications that wish to register specifically to this notification.
2588 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2589 * stay active to receive this notification. This action can be used to implement actions
2590 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002591 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002592 * <p class="note">This is a protected intent that can only be sent
2593 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002594 */
2595 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002596 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002597 /**
2598 * Broadcast Action: External power has been removed from the device.
2599 * This is intended for applications that wish to register specifically to this notification.
2600 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2601 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002602 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002603 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002604 * <p class="note">This is a protected intent that can only be sent
2605 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002606 */
2607 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002608 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002609 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002610 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002611 * Broadcast Action: Device is shutting down.
2612 * This is broadcast when the device is being shut down (completely turned
2613 * off, not sleeping). Once the broadcast is complete, the final shutdown
2614 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002615 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002616 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2617 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2618 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002619 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002620 * <p class="note">This is a protected intent that can only be sent
2621 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002622 * <p>May include the following extras:
2623 * <ul>
2624 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2625 * shutdown is only for userspace processes. If not set, assumed to be false.
2626 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002627 */
2628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002629 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002630 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002631 * Activity Action: Start this activity to request system shutdown.
2632 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002633 * to request confirmation from the user before shutting down. The optional boolean
2634 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2635 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002636 *
2637 * <p class="note">This is a protected intent that can only be sent
2638 * by the system.
2639 *
2640 * {@hide}
2641 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002642 public static final String ACTION_REQUEST_SHUTDOWN
2643 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002644 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002645 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002646 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002647 * <p class="note">
2648 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002649 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002650 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2651 * or above, this broadcast will no longer be delivered to any
2652 * {@link BroadcastReceiver} defined in your manifest. Instead,
2653 * apps are strongly encouraged to use the improved
2654 * {@link Context#getCacheDir()} behavior so the system can
2655 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002656 */
2657 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002658 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002659 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2660 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002661 * Broadcast Action: Indicates low storage space condition on the device no
2662 * longer exists
2663 * <p class="note">
2664 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002665 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002666 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2667 * or above, this broadcast will no longer be delivered to any
2668 * {@link BroadcastReceiver} defined in your manifest. Instead,
2669 * apps are strongly encouraged to use the improved
2670 * {@link Context#getCacheDir()} behavior so the system can
2671 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002674 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002675 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2676 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002677 * Broadcast Action: A sticky broadcast that indicates a storage space full
2678 * condition on the device. This is intended for activities that want to be
2679 * able to fill the data partition completely, leaving only enough free
2680 * space to prevent system-wide SQLite failures.
2681 * <p class="note">
2682 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002683 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002684 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2685 * or above, this broadcast will no longer be delivered to any
2686 * {@link BroadcastReceiver} defined in your manifest. Instead,
2687 * apps are strongly encouraged to use the improved
2688 * {@link Context#getCacheDir()} behavior so the system can
2689 * automatically free up storage when needed.
2690 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002691 */
2692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002693 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002694 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2695 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002696 * Broadcast Action: Indicates storage space full condition on the device no
2697 * longer exists.
2698 * <p class="note">
2699 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002700 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002701 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2702 * or above, this broadcast will no longer be delivered to any
2703 * {@link BroadcastReceiver} defined in your manifest. Instead,
2704 * apps are strongly encouraged to use the improved
2705 * {@link Context#getCacheDir()} behavior so the system can
2706 * automatically free up storage when needed.
2707 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002708 */
2709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002710 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002711 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2712 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2714 * and package management should be started.
2715 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2716 * notification.
2717 */
2718 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2719 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2720 /**
2721 * Broadcast Action: The device has entered USB Mass Storage mode.
2722 * This is used mainly for the USB Settings panel.
2723 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2724 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002725 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002726 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002727 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002729 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2730
2731 /**
2732 * Broadcast Action: The device has exited USB Mass Storage mode.
2733 * This is used mainly for the USB Settings panel.
2734 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2735 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002736 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002737 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002738 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002739 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002740 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2741
2742 /**
2743 * Broadcast Action: External media has been removed.
2744 * The path to the mount point for the removed media is contained in the Intent.mData field.
2745 */
2746 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2747 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2748
2749 /**
2750 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002751 * 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 -07002752 */
2753 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2754 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2755
2756 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002757 * Broadcast Action: External media is present, and being disk-checked
2758 * 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 -08002759 */
2760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2761 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2762
2763 /**
2764 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2765 * 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 -08002766 */
2767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2768 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2769
2770 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002771 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002772 * 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 -07002773 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2774 * media was mounted read only.
2775 */
2776 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2777 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2778
2779 /**
2780 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002781 * 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 -07002782 */
2783 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2784 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2785
2786 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002787 * Broadcast Action: External media is no longer being shared via USB mass storage.
2788 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2789 *
2790 * @hide
2791 */
2792 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2793
2794 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002795 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2796 * The path to the mount point for the removed media is contained in the Intent.mData field.
2797 */
2798 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2799 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2800
2801 /**
2802 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002803 * 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 -07002804 */
2805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2806 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2807
2808 /**
2809 * Broadcast Action: User has expressed the desire to remove the external storage media.
2810 * Applications should close all files they have open within the mount point when they receive this intent.
2811 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2812 */
2813 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2814 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2815
2816 /**
2817 * Broadcast Action: The media scanner has started scanning a directory.
2818 * The path to the directory being scanned is contained in the Intent.mData field.
2819 */
2820 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2821 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2822
2823 /**
2824 * Broadcast Action: The media scanner has finished scanning a directory.
2825 * The path to the scanned directory is contained in the Intent.mData field.
2826 */
2827 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2828 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2829
2830 /**
2831 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2832 * The path to the file is contained in the Intent.mData field.
2833 */
2834 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2835 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2836
2837 /**
2838 * Broadcast Action: The "Media Button" was pressed. Includes a single
2839 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2840 * caused the broadcast.
2841 */
2842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2843 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2844
2845 /**
2846 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2847 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2848 * caused the broadcast.
2849 */
2850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2851 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2852
2853 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2854 // location; they are not general-purpose actions.
2855
2856 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002857 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002858 */
2859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2860 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2861 "android.intent.action.GTALK_CONNECTED";
2862
2863 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002864 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002865 */
2866 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2867 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2868 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002869
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002870 /**
2871 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002872 */
2873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2874 public static final String ACTION_INPUT_METHOD_CHANGED =
2875 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002876
2877 /**
2878 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2879 * more radios have been turned off or on. The intent will have the following extra value:</p>
2880 * <ul>
2881 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2882 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2883 * turned off</li>
2884 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002885 *
Peng Xua35b5532016-01-20 00:05:45 -08002886 * <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 -07002887 */
2888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2889 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2890
2891 /**
2892 * Broadcast Action: Some content providers have parts of their namespace
2893 * where they publish new events or items that the user may be especially
2894 * interested in. For these things, they may broadcast this action when the
2895 * set of interesting items change.
2896 *
2897 * For example, GmailProvider sends this notification when the set of unread
2898 * mail in the inbox changes.
2899 *
2900 * <p>The data of the intent identifies which part of which provider
2901 * changed. When queried through the content resolver, the data URI will
2902 * return the data set in question.
2903 *
2904 * <p>The intent will have the following extra values:
2905 * <ul>
2906 * <li><em>count</em> - The number of items in the data set. This is the
2907 * same as the number of items in the cursor returned by querying the
2908 * data URI. </li>
2909 * </ul>
2910 *
2911 * This intent will be sent at boot (if the count is non-zero) and when the
2912 * data set changes. It is possible for the data set to change without the
2913 * count changing (for example, if a new unread message arrives in the same
2914 * sync operation in which a message is archived). The phone should still
2915 * ring/vibrate/etc as normal in this case.
2916 */
2917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2918 public static final String ACTION_PROVIDER_CHANGED =
2919 "android.intent.action.PROVIDER_CHANGED";
2920
2921 /**
2922 * Broadcast Action: Wired Headset plugged in or unplugged.
2923 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002924 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2925 * and documentation.
2926 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002927 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002928 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002929 */
2930 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002931 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002932
2933 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002934 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2935 * <ul>
2936 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2937 * </ul>
2938 *
2939 * <p class="note">This is a protected intent that can only be sent
2940 * by the system.
2941 *
2942 * @hide
2943 */
2944 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2945 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2946 = "android.intent.action.ADVANCED_SETTINGS";
2947
2948 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002949 * Broadcast Action: Sent after application restrictions are changed.
2950 *
2951 * <p class="note">This is a protected intent that can only be sent
2952 * by the system.</p>
2953 */
2954 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2955 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2956 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2957
2958 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002959 * Broadcast Action: An outgoing call is about to be placed.
2960 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002961 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002962 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002963 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002964 * the phone number originally intended to be dialed.</li>
2965 * </ul>
2966 * <p>Once the broadcast is finished, the resultData is used as the actual
2967 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002968 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002969 * outgoing call in turn: for example, a parental control application
2970 * might verify that the user is authorized to place the call at that
2971 * time, then a number-rewriting application might add an area code if
2972 * one was not specified.</p>
2973 * <p>For consistency, any receiver whose purpose is to prohibit phone
2974 * calls should have a priority of 0, to ensure it will see the final
2975 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002976 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002977 * should have a positive priority.
2978 * Negative priorities are reserved for the system for this broadcast;
2979 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002980 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2981 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 * <p>Emergency calls cannot be intercepted using this mechanism, and
2983 * other calls cannot be modified to call emergency numbers using this
2984 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002985 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2986 * call to use their own service instead. Those apps should first prevent
2987 * the call from being placed by setting resultData to <code>null</code>
2988 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002989 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002990 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2991 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002992 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002993 * <p class="note">This is a protected intent that can only be sent
2994 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002995 */
2996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2997 public static final String ACTION_NEW_OUTGOING_CALL =
2998 "android.intent.action.NEW_OUTGOING_CALL";
2999
3000 /**
3001 * Broadcast Action: Have the device reboot. This is only for use by
3002 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08003003 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07003004 * <p class="note">This is a protected intent that can only be sent
3005 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003006 */
3007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3008 public static final String ACTION_REBOOT =
3009 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003010
Wei Huang97ecc9c2009-05-11 17:44:20 -07003011 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08003012 * Broadcast Action: A sticky broadcast for changes in the physical
3013 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08003014 *
3015 * <p>The intent will have the following extra values:
3016 * <ul>
3017 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08003018 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08003019 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08003020 * <p>This is intended for monitoring the current physical dock state.
3021 * See {@link android.app.UiModeManager} for the normal API dealing with
3022 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003023 */
3024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3025 public static final String ACTION_DOCK_EVENT =
3026 "android.intent.action.DOCK_EVENT";
3027
3028 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08003029 * Broadcast Action: A broadcast when idle maintenance can be started.
3030 * This means that the user is not interacting with the device and is
3031 * not expected to do so soon. Typical use of the idle maintenance is
3032 * to perform somehow expensive tasks that can be postponed at a moment
3033 * when they will not degrade user experience.
3034 * <p>
3035 * <p class="note">In order to keep the device responsive in case of an
3036 * unexpected user interaction, implementations of a maintenance task
3037 * should be interruptible. In such a scenario a broadcast with action
3038 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
3039 * should not do the maintenance work in
3040 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
3041 * maintenance service by {@link Context#startService(Intent)}. Also
3042 * you should hold a wake lock while your maintenance service is running
3043 * to prevent the device going to sleep.
3044 * </p>
3045 * <p>
3046 * <p class="note">This is a protected intent that can only be sent by
3047 * the system.
3048 * </p>
3049 *
3050 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07003051 *
3052 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003053 */
3054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3055 public static final String ACTION_IDLE_MAINTENANCE_START =
3056 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
3057
3058 /**
3059 * Broadcast Action: A broadcast when idle maintenance should be stopped.
3060 * This means that the user was not interacting with the device as a result
3061 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
3062 * was sent and now the user started interacting with the device. Typical
3063 * use of the idle maintenance is to perform somehow expensive tasks that
3064 * can be postponed at a moment when they will not degrade user experience.
3065 * <p>
3066 * <p class="note">In order to keep the device responsive in case of an
3067 * unexpected user interaction, implementations of a maintenance task
3068 * should be interruptible. Hence, on receiving a broadcast with this
3069 * action, the maintenance task should be interrupted as soon as possible.
3070 * In other words, you should not do the maintenance work in
3071 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
3072 * maintenance service that was started on receiving of
3073 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
3074 * lock you acquired when your maintenance service started.
3075 * </p>
3076 * <p class="note">This is a protected intent that can only be sent
3077 * by the system.
3078 *
3079 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07003080 *
3081 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08003082 */
3083 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3084 public static final String ACTION_IDLE_MAINTENANCE_END =
3085 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
3086
3087 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003088 * Broadcast Action: a remote intent is to be broadcasted.
3089 *
3090 * A remote intent is used for remote RPC between devices. The remote intent
3091 * is serialized and sent from one device to another device. The receiving
3092 * device parses the remote intent and broadcasts it. Note that anyone can
3093 * broadcast a remote intent. However, if the intent receiver of the remote intent
3094 * does not trust intent broadcasts from arbitrary intent senders, it should require
3095 * the sender to hold certain permissions so only trusted sender's broadcast will be
3096 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07003097 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07003098 */
3099 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07003100 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07003101
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003102 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06003103 * Broadcast Action: This is broadcast once when the user is booting after a
3104 * system update. It can be used to perform cleanup or upgrades after a
3105 * system update.
3106 * <p>
3107 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3108 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3109 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3110 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003111 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003112 * @hide
3113 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003114 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003115 public static final String ACTION_PRE_BOOT_COMPLETED =
3116 "android.intent.action.PRE_BOOT_COMPLETED";
3117
Amith Yamasani13593602012-03-22 16:16:17 -07003118 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003119 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003120 * on restricted users. The broadcast intent contains an extra
3121 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3122 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3123 * String[] depending on the restriction type.<p/>
3124 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003125 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3126 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3127 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003128 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3129 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003130 * @see RestrictionEntry
3131 */
3132 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3133 "android.intent.action.GET_RESTRICTION_ENTRIES";
3134
3135 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003136 * Sent the first time a user is starting, to allow system apps to
3137 * perform one time initialization. (This will not be seen by third
3138 * party applications because a newly initialized user does not have any
3139 * third party applications installed for it.) This is sent early in
3140 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003141 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3142 * broadcast, since it is part of a visible user interaction; be as quick
3143 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003144 */
3145 public static final String ACTION_USER_INITIALIZE =
3146 "android.intent.action.USER_INITIALIZE";
3147
3148 /**
3149 * Sent when a user switch is happening, causing the process's user to be
3150 * brought to the foreground. This is only sent to receivers registered
3151 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3152 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003153 * foreground. This is sent as a foreground
3154 * broadcast, since it is part of a visible user interaction; be as quick
3155 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003156 */
3157 public static final String ACTION_USER_FOREGROUND =
3158 "android.intent.action.USER_FOREGROUND";
3159
3160 /**
3161 * Sent when a user switch is happening, causing the process's user to be
3162 * sent to the background. This is only sent to receivers registered
3163 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3164 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003165 * background. This is sent as a foreground
3166 * broadcast, since it is part of a visible user interaction; be as quick
3167 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003168 */
3169 public static final String ACTION_USER_BACKGROUND =
3170 "android.intent.action.USER_BACKGROUND";
3171
3172 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003173 * Broadcast sent to the system when a user is added. Carries an extra
3174 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3175 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003176 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003177 * @hide
3178 */
3179 public static final String ACTION_USER_ADDED =
3180 "android.intent.action.USER_ADDED";
3181
3182 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003183 * Broadcast sent by the system when a user is started. Carries an extra
3184 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003185 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003186 * that has been started. This is sent as a foreground
3187 * broadcast, since it is part of a visible user interaction; be as quick
3188 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003189 * @hide
3190 */
3191 public static final String ACTION_USER_STARTED =
3192 "android.intent.action.USER_STARTED";
3193
3194 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003195 * Broadcast sent when a user is in the process of starting. Carries an extra
3196 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3197 * sent to registered receivers, not manifest receivers. It is sent to all
3198 * users (including the one that is being started). You must hold
3199 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3200 * this broadcast. This is sent as a background broadcast, since
3201 * its result is not part of the primary UX flow; to safely keep track of
3202 * started/stopped state of a user you can use this in conjunction with
3203 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3204 * other user state broadcasts since those are foreground broadcasts so can
3205 * execute in a different order.
3206 * @hide
3207 */
3208 public static final String ACTION_USER_STARTING =
3209 "android.intent.action.USER_STARTING";
3210
3211 /**
3212 * Broadcast sent when a user is going to be stopped. Carries an extra
3213 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3214 * sent to registered receivers, not manifest receivers. It is sent to all
3215 * users (including the one that is being stopped). You must hold
3216 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3217 * this broadcast. The user will not stop until all receivers have
3218 * handled the broadcast. This is sent as a background broadcast, since
3219 * its result is not part of the primary UX flow; to safely keep track of
3220 * started/stopped state of a user you can use this in conjunction with
3221 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3222 * other user state broadcasts since those are foreground broadcasts so can
3223 * execute in a different order.
3224 * @hide
3225 */
3226 public static final String ACTION_USER_STOPPING =
3227 "android.intent.action.USER_STOPPING";
3228
3229 /**
3230 * Broadcast sent to the system when a user is stopped. Carries an extra
3231 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3232 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3233 * specific package. This is only sent to registered receivers, not manifest
3234 * receivers. It is sent to all running users <em>except</em> the one that
3235 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003236 * @hide
3237 */
3238 public static final String ACTION_USER_STOPPED =
3239 "android.intent.action.USER_STOPPED";
3240
3241 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003242 * 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 -07003243 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003244 * one that has been removed. The user will not be completely removed until all receivers have
3245 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003246 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003247 * @hide
3248 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003249 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003250 public static final String ACTION_USER_REMOVED =
3251 "android.intent.action.USER_REMOVED";
3252
3253 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003254 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003255 * the userHandle of the user to become the current one. This is only sent to
3256 * registered receivers, not manifest receivers. It is sent to all running users.
3257 * You must hold
3258 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003259 * @hide
3260 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003261 @UnsupportedAppUsage
Amith Yamasani13593602012-03-22 16:16:17 -07003262 public static final String ACTION_USER_SWITCHED =
3263 "android.intent.action.USER_SWITCHED";
3264
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003265 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003266 * Broadcast Action: Sent when the credential-encrypted private storage has
3267 * become unlocked for the target user. This is only sent to registered
3268 * receivers, not manifest receivers.
3269 */
3270 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3271 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3272
3273 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003274 * Broadcast sent to the system when a user's information changes. Carries an extra
3275 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003276 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003277 * @hide
3278 */
3279 public static final String ACTION_USER_INFO_CHANGED =
3280 "android.intent.action.USER_INFO_CHANGED";
3281
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003282 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003283 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3284 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003285 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3286 * that need to display merged content across both primary and managed profiles need to
3287 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003288 * not manifest receivers.
3289 */
3290 public static final String ACTION_MANAGED_PROFILE_ADDED =
3291 "android.intent.action.MANAGED_PROFILE_ADDED";
3292
3293 /**
3294 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003295 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3296 * Only applications (for example Launchers) that need to display merged content across both
3297 * primary and managed profiles need to worry about this broadcast. This is only sent to
3298 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003299 */
3300 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3301 "android.intent.action.MANAGED_PROFILE_REMOVED";
3302
3303 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003304 * Broadcast sent to the primary user when the credential-encrypted private storage for
3305 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3306 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3307 * Launchers) that need to display merged content across both primary and managed profiles
3308 * need to worry about this broadcast. This is only sent to registered receivers,
3309 * not manifest receivers.
3310 */
3311 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3312 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3313
3314 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003315 * Broadcast sent to the primary user when an associated managed profile has become available.
3316 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003317 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3318 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3319 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003320 */
Rubin Xue95057a2016-04-01 16:49:25 +01003321 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3322 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3323
3324 /**
3325 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3326 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3327 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3328 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3329 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3330 */
3331 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3332 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003333
3334 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003335 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3336 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3337 * the device was locked or unlocked.
3338 *
3339 * This is only sent to registered receivers.
3340 *
3341 * @hide
3342 */
3343 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3344 "android.intent.action.DEVICE_LOCKED_CHANGED";
3345
3346 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003347 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3348 */
3349 public static final String ACTION_QUICK_CLOCK =
3350 "android.intent.action.QUICK_CLOCK";
3351
Michael Wright0087a142013-02-05 16:29:39 -08003352 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003353 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003354 * @hide
3355 */
3356 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003357 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003358
Justin Kohd378ad72013-04-01 12:18:26 -07003359 /**
3360 * Broadcast Action: A global button was pressed. Includes a single
3361 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3362 * caused the broadcast.
3363 * @hide
3364 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003365 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003366 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3367
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003368 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003369 * Broadcast Action: Sent when media resource is granted.
3370 * <p>
3371 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3372 * granted.
3373 * </p>
3374 * <p class="note">
3375 * This is a protected intent that can only be sent by the system.
3376 * </p>
3377 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003378 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003379 * </p>
3380 *
3381 * @hide
3382 */
3383 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3384 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3385
3386 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003387 * Broadcast Action: An overlay package has changed. The data contains the
3388 * name of the overlay package which has changed. This is broadcast on all
3389 * changes to the OverlayInfo returned by {@link
3390 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3391 * most common change is a state change that will change whether the
3392 * overlay is enabled or not.
3393 * @hide
3394 */
3395 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3396
3397 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003398 * Activity Action: Allow the user to select and return one or more existing
3399 * documents. When invoked, the system will display the various
3400 * {@link DocumentsProvider} instances installed on the device, letting the
3401 * user interactively navigate through them. These documents include local
3402 * media, such as photos and video, and documents provided by installed
3403 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003404 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003405 * Each document is represented as a {@code content://} URI backed by a
3406 * {@link DocumentsProvider}, which can be opened as a stream with
3407 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3408 * {@link android.provider.DocumentsContract.Document} metadata.
3409 * <p>
3410 * All selected documents are returned to the calling application with
3411 * persistable read and write permission grants. If you want to maintain
3412 * access to the documents across device reboots, you need to explicitly
3413 * take the persistable permissions using
3414 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3415 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003416 * Callers must indicate the acceptable document MIME types through
3417 * {@link #setType(String)}. For example, to select photos, use
3418 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3419 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3420 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003421 * <p>
3422 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003423 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3424 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003425 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003426 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3427 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003428 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003429 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003430 * Callers can set a document URI through
3431 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3432 * location of documents navigator. System will do its best to launch the
3433 * navigator in the specified document if it's a folder, or the folder that
3434 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003435 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003436 * Output: The URI of the item that was picked, returned in
3437 * {@link #getData()}. This must be a {@code content://} URI so that any
3438 * receiver can access it. If multiple documents were selected, they are
3439 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003440 *
3441 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003442 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003443 * @see #ACTION_CREATE_DOCUMENT
3444 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003445 */
3446 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3447 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3448
3449 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003450 * Activity Action: Allow the user to create a new document. When invoked,
3451 * the system will display the various {@link DocumentsProvider} instances
3452 * installed on the device, letting the user navigate through them. The
3453 * returned document may be a newly created document with no content, or it
3454 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003455 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003456 * Each document is represented as a {@code content://} URI backed by a
3457 * {@link DocumentsProvider}, which can be opened as a stream with
3458 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3459 * {@link android.provider.DocumentsContract.Document} metadata.
3460 * <p>
3461 * Callers must indicate the concrete MIME type of the document being
3462 * created by setting {@link #setType(String)}. This MIME type cannot be
3463 * changed after the document is created.
3464 * <p>
3465 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3466 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003467 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003468 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3469 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003470 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003471 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003472 * Callers can set a document URI through
3473 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3474 * location of documents navigator. System will do its best to launch the
3475 * navigator in the specified document if it's a folder, or the folder that
3476 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003477 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003478 * Output: The URI of the item that was created. This must be a
3479 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003480 *
3481 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003482 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003483 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003484 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003485 */
3486 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3487 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3488
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003489 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003490 * Activity Action: Allow the user to pick a directory subtree. When
3491 * invoked, the system will display the various {@link DocumentsProvider}
3492 * instances installed on the device, letting the user navigate through
3493 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003494 * <p>
3495 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003496 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3497 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3498 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003499 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003500 * Callers can set a document URI through
3501 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3502 * location of documents navigator. System will do its best to launch the
3503 * navigator in the specified document if it's a folder, or the folder that
3504 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003505 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003506 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003507 *
3508 * @see DocumentsContract
3509 */
3510 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003511 public static final String
3512 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003513
Felipe Lemec7b1f892016-01-15 15:02:31 -08003514 /**
Peng Xua35b5532016-01-20 00:05:45 -08003515 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3516 * exisiting sensor being disconnected.
3517 *
3518 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3519 *
3520 * {@hide}
3521 */
3522 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3523 public static final String
3524 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3525
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003526 /**
Sam Line707f832017-04-13 17:00:55 -07003527 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003528 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003529 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003530 */
3531 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003532 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003533 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3534
Christopher Tate6597e342015-02-17 12:15:25 -08003535 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003536 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3537 * is about to be performed.
3538 * @hide
3539 */
3540 @SystemApi
3541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3542 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3543 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3544
3545 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003546 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3547 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3548 *
3549 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3550 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003551 * @hide
3552 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003553 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003554 public static final String EXTRA_FORCE_MASTER_CLEAR =
3555 "android.intent.extra.FORCE_MASTER_CLEAR";
3556
3557 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003558 * A broadcast action to trigger a factory reset.
3559 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003560 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3561 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003562 *
3563 * <p>Not for use by third-party applications.
3564 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003565 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003566 *
3567 * {@hide}
3568 */
3569 @SystemApi
3570 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3571 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3572
3573 /**
3574 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3575 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3576 *
3577 * <p>Not for use by third-party applications.
3578 *
3579 * @hide
3580 */
3581 @SystemApi
3582 public static final String EXTRA_FORCE_FACTORY_RESET =
3583 "android.intent.extra.FORCE_FACTORY_RESET";
3584
3585 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003586 * Broadcast action: report that a settings element is being restored from backup. The intent
3587 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3588 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3589 * is the value of that settings entry prior to the restore operation, and
3590 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3591 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3592 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003593 *
3594 * <p>This broadcast is sent only for settings provider entries known to require special handling
3595 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3596 * the provider's backup agent implementation.
3597 *
3598 * @see #EXTRA_SETTING_NAME
3599 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3600 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003601 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003602 * {@hide}
3603 */
3604 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3605
3606 /** {@hide} */
3607 public static final String EXTRA_SETTING_NAME = "setting_name";
3608 /** {@hide} */
3609 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3610 /** {@hide} */
3611 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003612 /** {@hide} */
3613 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003614
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003615 /**
3616 * Activity Action: Process a piece of text.
3617 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3618 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3619 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3620 */
3621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3622 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003623
3624 /**
3625 * Broadcast Action: The sim card state has changed.
3626 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3627 * because TelephonyIntents is an internal class.
3628 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003629 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3630 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003631 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003632 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003633 @SystemApi
3634 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3635 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3636
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003637 /**
fionaxu90fee272017-03-31 12:45:12 -07003638 * Broadcast Action: indicate that the phone service state has changed.
3639 * The intent will have the following extra values:</p>
3640 * <p>
3641 * @see #EXTRA_VOICE_REG_STATE
3642 * @see #EXTRA_DATA_REG_STATE
3643 * @see #EXTRA_VOICE_ROAMING_TYPE
3644 * @see #EXTRA_DATA_ROAMING_TYPE
3645 * @see #EXTRA_OPERATOR_ALPHA_LONG
3646 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3647 * @see #EXTRA_OPERATOR_NUMERIC
3648 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3649 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3650 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3651 * @see #EXTRA_MANUAL
3652 * @see #EXTRA_VOICE_RADIO_TECH
3653 * @see #EXTRA_DATA_RADIO_TECH
3654 * @see #EXTRA_CSS_INDICATOR
3655 * @see #EXTRA_NETWORK_ID
3656 * @see #EXTRA_SYSTEM_ID
3657 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3658 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3659 * @see #EXTRA_EMERGENCY_ONLY
3660 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3661 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3662 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3663 *
3664 * <p class="note">
3665 * Requires the READ_PHONE_STATE permission.
3666 *
3667 * <p class="note">This is a protected intent that can only be sent by the system.
3668 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003669 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003670 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable} and the helper
3671 * functions {@code ServiceStateTable.getUriForSubscriptionIdAndField} and
3672 * {@code ServiceStateTable.getUriForSubscriptionId} to subscribe to changes to the ServiceState
3673 * for a given subscription id and field with a ContentObserver or using JobScheduler.
fionaxu90fee272017-03-31 12:45:12 -07003674 */
3675 @Deprecated
3676 @SystemApi
3677 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3678 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3679
3680 /**
3681 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3682 * state.
3683 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3684 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3685 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3686 * @see android.telephony.ServiceState#STATE_POWER_OFF
3687 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003688 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003689 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003690 */
3691 @Deprecated
3692 @SystemApi
3693 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3694
3695 /**
3696 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3697 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3698 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3699 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3700 * @see android.telephony.ServiceState#STATE_POWER_OFF
3701 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003702 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003703 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_REG_STATE}.
fionaxu90fee272017-03-31 12:45:12 -07003704 */
3705 @Deprecated
3706 @SystemApi
3707 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3708
3709 /**
3710 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3711 * type.
3712 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003713 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003714 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003715 */
3716 @Deprecated
3717 @SystemApi
3718 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3719
3720 /**
3721 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3722 * type.
3723 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003724 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003725 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_ROAMING_TYPE}.
fionaxu90fee272017-03-31 12:45:12 -07003726 */
3727 @Deprecated
3728 @SystemApi
3729 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3730
3731 /**
3732 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3733 * registered voice operator name in long alphanumeric format.
3734 * {@code null} if the operator name is not known or unregistered.
3735 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003736 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003737 * @deprecated Use
3738 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003739 */
3740 @Deprecated
3741 @SystemApi
3742 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3743
3744 /**
3745 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3746 * registered voice operator name in short alphanumeric format.
3747 * {@code null} if the operator name is not known or unregistered.
3748 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003749 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003750 * @deprecated Use
3751 * {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003752 */
3753 @Deprecated
3754 @SystemApi
3755 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3756
3757 /**
3758 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3759 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3760 * network.
3761 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003762 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003763 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#VOICE_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003764 */
3765 @Deprecated
3766 @SystemApi
3767 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3768
3769 /**
3770 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3771 * registered data operator name in long alphanumeric format.
3772 * {@code null} if the operator name is not known or unregistered.
3773 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003774 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003775 * @deprecated Use
3776 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_LONG}.
fionaxu90fee272017-03-31 12:45:12 -07003777 */
3778 @Deprecated
3779 @SystemApi
3780 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3781
3782 /**
3783 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3784 * registered data operator name in short alphanumeric format.
3785 * {@code null} if the operator name is not known or unregistered.
3786 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003787 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003788 * @deprecated Use
3789 * {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_ALPHA_SHORT}.
fionaxu90fee272017-03-31 12:45:12 -07003790 */
3791 @Deprecated
3792 @SystemApi
3793 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3794
3795 /**
3796 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3797 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3798 * data operator.
3799 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003800 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003801 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#DATA_OPERATOR_NUMERIC}.
fionaxu90fee272017-03-31 12:45:12 -07003802 */
3803 @Deprecated
3804 @SystemApi
3805 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3806
3807 /**
3808 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3809 * network selection mode is manual.
3810 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3811 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003812 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003813 * @deprecated Use
3814 * {@link android.provider.Telephony.ServiceStateTable#IS_MANUAL_NETWORK_SELECTION}.
fionaxu90fee272017-03-31 12:45:12 -07003815 */
3816 @Deprecated
3817 @SystemApi
3818 public static final String EXTRA_MANUAL = "manual";
3819
3820 /**
3821 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3822 * radio technology.
3823 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003824 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003825 * @deprecated Use
3826 * {@link android.provider.Telephony.ServiceStateTable#RIL_VOICE_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003827 */
3828 @Deprecated
3829 @SystemApi
3830 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3831
3832 /**
3833 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3834 * radio technology.
3835 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003836 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003837 * @deprecated Use
3838 * {@link android.provider.Telephony.ServiceStateTable#RIL_DATA_RADIO_TECHNOLOGY}.
fionaxu90fee272017-03-31 12:45:12 -07003839 */
3840 @Deprecated
3841 @SystemApi
3842 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3843
3844 /**
3845 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3846 * support on CDMA network.
3847 * Will be {@code true} if support, {@code false} otherwise.
3848 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003849 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003850 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CSS_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003851 */
3852 @Deprecated
3853 @SystemApi
3854 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3855
3856 /**
3857 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3858 * id. {@code Integer.MAX_VALUE} if unknown.
3859 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003860 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003861 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#NETWORK_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003862 */
3863 @Deprecated
3864 @SystemApi
3865 public static final String EXTRA_NETWORK_ID = "networkId";
3866
3867 /**
3868 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3869 * {@code Integer.MAX_VALUE} if unknown.
3870 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003871 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003872 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#SYSTEM_ID}.
fionaxu90fee272017-03-31 12:45:12 -07003873 */
3874 @Deprecated
3875 @SystemApi
3876 public static final String EXTRA_SYSTEM_ID = "systemId";
3877
3878 /**
3879 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3880 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3881 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003882 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003883 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#CDMA_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003884 */
3885 @Deprecated
3886 @SystemApi
3887 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3888
3889 /**
3890 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3891 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3892 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003893 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003894 * @deprecated Use
3895 * {@link android.provider.Telephony.ServiceStateTable#CDMA_DEFAULT_ROAMING_INDICATOR}.
fionaxu90fee272017-03-31 12:45:12 -07003896 */
3897 @Deprecated
3898 @SystemApi
3899 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3900
3901 /**
3902 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3903 * only mode.
3904 * {@code true} if in emergency only mode, {@code false} otherwise.
3905 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003906 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003907 * @deprecated Use {@link android.provider.Telephony.ServiceStateTable#IS_EMERGENCY_ONLY}.
fionaxu90fee272017-03-31 12:45:12 -07003908 */
3909 @Deprecated
3910 @SystemApi
3911 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3912
3913 /**
3914 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3915 * registration state is roaming.
3916 * {@code true} if registration indicates roaming, {@code false} otherwise
3917 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003918 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003919 * @deprecated Use
3920 * {@link android.provider.Telephony.ServiceStateTable#IS_DATA_ROAMING_FROM_REGISTRATION}.
fionaxu90fee272017-03-31 12:45:12 -07003921 */
3922 @Deprecated
3923 @SystemApi
3924 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3925 "isDataRoamingFromRegistration";
3926
3927 /**
3928 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3929 * aggregation is in use.
3930 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3931 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003932 * @removed
Jordan Liu479904522018-04-17 14:43:39 -07003933 * @deprecated Use
3934 * {@link android.provider.Telephony.ServiceStateTable#IS_USING_CARRIER_AGGREGATION}.
fionaxu90fee272017-03-31 12:45:12 -07003935 */
3936 @Deprecated
3937 @SystemApi
3938 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3939
3940 /**
3941 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3942 * is reduced from the rsrp threshold while calculating signal strength level.
3943 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003944 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003945 */
3946 @Deprecated
3947 @SystemApi
3948 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3949
3950 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003951 * The name of the extra used to define the text to be processed, as a
3952 * CharSequence. Note that this may be a styled CharSequence, so you must use
3953 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003954 */
3955 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3956 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003957 * 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 +00003958 */
3959 public static final String EXTRA_PROCESS_TEXT_READONLY =
3960 "android.intent.extra.PROCESS_TEXT_READONLY";
3961
Bryce Leebc58f592015-09-25 16:43:01 -07003962 /**
3963 * Broadcast action: reports when a new thermal event has been reached. When the device
3964 * is reaching its maximum temperatue, the thermal level reported
3965 * {@hide}
3966 */
3967 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3968 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3969
3970 /** {@hide} */
3971 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3972
3973 /**
3974 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003975 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003976 * {@hide}
3977 */
3978 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3979
3980 /**
3981 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003982 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003983 * {@hide}
3984 */
3985 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3986
3987 /**
3988 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003989 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003990 * {@hide}
3991 */
3992 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3993
lpeter318abc92018-05-04 16:13:14 +08003994 /**
3995 * Broadcast Action: Indicates the dock in idle state while device is docked.
3996 *
3997 * <p class="note">This is a protected intent that can only be sent
3998 * by the system.
3999 *
4000 * @hide
4001 */
4002 public static final String ACTION_DOCK_IDLE = "android.intent.action.DOCK_IDLE";
4003
4004 /**
4005 * Broadcast Action: Indicates the dock in active state while device is docked.
4006 *
4007 * <p class="note">This is a protected intent that can only be sent
4008 * by the system.
4009 *
4010 * @hide
4011 */
4012 public static final String ACTION_DOCK_ACTIVE = "android.intent.action.DOCK_ACTIVE";
4013
Bryce Leebc58f592015-09-25 16:43:01 -07004014
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004015 // ---------------------------------------------------------------------
4016 // ---------------------------------------------------------------------
4017 // Standard intent categories (see addCategory()).
4018
4019 /**
4020 * Set if the activity should be an option for the default action
4021 * (center press) to perform on a piece of data. Setting this will
4022 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04004023 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004024 * Intent when initiating an action -- it is for use in intent filters
4025 * specified in packages.
4026 */
4027 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4028 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
4029 /**
4030 * Activities that can be safely invoked from a browser must support this
4031 * category. For example, if the user is viewing a web page or an e-mail
4032 * and clicks on a link in the text, the Intent generated execute that
4033 * link will require the BROWSABLE category, so that only activities
4034 * supporting this category will be considered as possible actions. By
4035 * supporting this category, you are promising that there is nothing
4036 * damaging (without user intervention) that can happen by invoking any
4037 * matching Intent.
4038 */
4039 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4040 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
4041 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07004042 * Categories for activities that can participate in voice interaction.
4043 * An activity that supports this category must be prepared to run with
4044 * no UI shown at all (though in some case it may have a UI shown), and
4045 * rely on {@link android.app.VoiceInteractor} to interact with the user.
4046 */
4047 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4048 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
4049 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004050 * Set if the activity should be considered as an alternative action to
4051 * the data the user is currently viewing. See also
4052 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
4053 * applies to the selection in a list of items.
4054 *
4055 * <p>Supporting this category means that you would like your activity to be
4056 * displayed in the set of alternative things the user can do, usually as
4057 * part of the current activity's options menu. You will usually want to
4058 * include a specific label in the &lt;intent-filter&gt; of this action
4059 * describing to the user what it does.
4060 *
4061 * <p>The action of IntentFilter with this category is important in that it
4062 * describes the specific action the target will perform. This generally
4063 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
4064 * a specific name such as "com.android.camera.action.CROP. Only one
4065 * alternative of any particular action will be shown to the user, so using
4066 * a specific action like this makes sure that your alternative will be
4067 * displayed while also allowing other applications to provide their own
4068 * overrides of that particular action.
4069 */
4070 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4071 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
4072 /**
4073 * Set if the activity should be considered as an alternative selection
4074 * action to the data the user has currently selected. This is like
4075 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
4076 * of items from which the user can select, giving them alternatives to the
4077 * default action that will be performed on it.
4078 */
4079 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4080 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
4081 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004082 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004083 */
4084 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4085 public static final String CATEGORY_TAB = "android.intent.category.TAB";
4086 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004087 * Should be displayed in the top-level launcher.
4088 */
4089 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4090 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
4091 /**
Jose Lima38b75b62014-03-11 10:41:39 -07004092 * Indicates an activity optimized for Leanback mode, and that should
4093 * be displayed in the Leanback launcher.
4094 */
4095 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4096 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
4097 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08004098 * Indicates the preferred entry-point activity when an application is launched from a Car
4099 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
4100 * fallback, or exclude the application entirely.
4101 * @hide
4102 */
4103 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4104 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
4105 /**
Jose Lima73915cf2014-07-29 17:16:31 -07004106 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
4107 * @hide
4108 */
4109 @SystemApi
4110 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
4111 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004112 * Provides information about the package it is in; typically used if
4113 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
4114 * a front-door to the user without having to be shown in the all apps list.
4115 */
4116 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4117 public static final String CATEGORY_INFO = "android.intent.category.INFO";
4118 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004119 * This is the home activity, that is the first activity that is displayed
4120 * when the device boots.
4121 */
4122 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4123 public static final String CATEGORY_HOME = "android.intent.category.HOME";
4124 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07004125 * This is the home activity that is displayed when the device is finished setting up and ready
4126 * for use.
4127 * @hide
4128 */
4129 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4130 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
4131 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07004132 * This is the setup wizard activity, that is the first activity that is displayed
4133 * when the user sets up the device for the first time.
4134 * @hide
4135 */
4136 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4137 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
4138 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07004139 * This is the home activity, that is the activity that serves as the launcher app
4140 * from there the user can start other apps. Often components with lower/higher
4141 * priority intent filters handle the home intent, for example SetupWizard, to
4142 * setup the device and we need to be able to distinguish the home app from these
4143 * setup helpers.
4144 * @hide
4145 */
4146 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4147 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
4148 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004149 * This activity is a preference panel.
4150 */
4151 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4152 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
4153 /**
4154 * This activity is a development preference panel.
4155 */
4156 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4157 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
4158 /**
4159 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004160 */
4161 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4162 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4163 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004164 * This activity allows the user to browse and download new applications.
4165 */
4166 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4167 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4168 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004169 * This activity may be exercised by the monkey or other automated test tools.
4170 */
4171 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4172 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4173 /**
4174 * To be used as a test (not part of the normal user experience).
4175 */
4176 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4177 /**
4178 * To be used as a unit test (run through the Test Harness).
4179 */
4180 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4181 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004182 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 * experience).
4184 */
4185 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004186
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004187 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004188 * Used to indicate that an intent only wants URIs that can be opened with
4189 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4190 * must support at least the columns defined in {@link OpenableColumns} when
4191 * queried.
4192 *
4193 * @see #ACTION_GET_CONTENT
4194 * @see #ACTION_OPEN_DOCUMENT
4195 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004196 */
4197 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4198 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4199
4200 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004201 * Used to indicate that an intent filter can accept files which are not necessarily
4202 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4203 * at least streamable via
4204 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4205 * using one of the stream types exposed via
4206 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4207 *
4208 * @see #ACTION_SEND
4209 * @see #ACTION_SEND_MULTIPLE
4210 */
4211 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4212 public static final String CATEGORY_TYPED_OPENABLE =
4213 "android.intent.category.TYPED_OPENABLE";
4214
4215 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004216 * To be used as code under test for framework instrumentation tests.
4217 */
4218 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4219 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004220 /**
4221 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004222 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4223 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004224 */
4225 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4226 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4227 /**
4228 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004229 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4230 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004231 */
4232 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4233 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004234 /**
4235 * An activity to run when device is inserted into a analog (low end) dock.
4236 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4237 * information, see {@link android.app.UiModeManager}.
4238 */
4239 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4240 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4241
4242 /**
4243 * An activity to run when device is inserted into a digital (high end) dock.
4244 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4245 * information, see {@link android.app.UiModeManager}.
4246 */
4247 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4248 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004249
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004250 /**
4251 * Used to indicate that the activity can be used in a car environment.
4252 */
4253 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4254 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4255
Zak Cohendb6ca492017-01-26 14:09:00 -08004256 /**
4257 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4258 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4259 * information, see {@link android.app.UiModeManager}.
4260 */
4261 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4262 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004263 // ---------------------------------------------------------------------
4264 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004265 // Application launch intent categories (see addCategory()).
4266
4267 /**
4268 * Used with {@link #ACTION_MAIN} to launch the browser application.
4269 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004270 * <p>NOTE: This should not be used as the primary key of an Intent,
4271 * since it will not result in the app launching with the correct
4272 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004273 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004274 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004275 */
4276 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4277 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4278
4279 /**
4280 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4281 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004282 * <p>NOTE: This should not be used as the primary key of an Intent,
4283 * since it will not result in the app launching with the correct
4284 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004285 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004286 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004287 */
4288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4289 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4290
4291 /**
4292 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4293 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004294 * <p>NOTE: This should not be used as the primary key of an Intent,
4295 * since it will not result in the app launching with the correct
4296 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004297 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004298 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004299 */
4300 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4301 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4302
4303 /**
4304 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4305 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004306 * <p>NOTE: This should not be used as the primary key of an Intent,
4307 * since it will not result in the app launching with the correct
4308 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004309 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004310 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004311 */
4312 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4313 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4314
4315 /**
4316 * Used with {@link #ACTION_MAIN} to launch the email application.
4317 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004318 * <p>NOTE: This should not be used as the primary key of an Intent,
4319 * since it will not result in the app launching with the correct
4320 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004321 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004322 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004323 */
4324 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4325 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4326
4327 /**
4328 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4329 * The activity should be able to view and manipulate image and video files
4330 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004331 * <p>NOTE: This should not be used as the primary key of an Intent,
4332 * since it will not result in the app launching with the correct
4333 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004334 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004335 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004336 */
4337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4338 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4339
4340 /**
4341 * Used with {@link #ACTION_MAIN} to launch the maps application.
4342 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004343 * <p>NOTE: This should not be used as the primary key of an Intent,
4344 * since it will not result in the app launching with the correct
4345 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004346 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004347 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004348 */
4349 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4350 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4351
4352 /**
4353 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4354 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004355 * <p>NOTE: This should not be used as the primary key of an Intent,
4356 * since it will not result in the app launching with the correct
4357 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004358 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004359 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004360 */
4361 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4362 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4363
4364 /**
4365 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004366 * The activity should be able to play, browse, or manipulate music files
4367 * stored on the device.
4368 * <p>NOTE: This should not be used as the primary key of an Intent,
4369 * since it will not result in the app launching with the correct
4370 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004371 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004372 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004373 */
4374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4375 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4376
4377 // ---------------------------------------------------------------------
4378 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004379 // Standard extra data keys.
4380
4381 /**
4382 * The initial data to place in a newly created record. Use with
4383 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4384 * fields as would be given to the underlying ContentProvider.insert()
4385 * call.
4386 */
4387 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4388
4389 /**
4390 * A constant CharSequence that is associated with the Intent, used with
4391 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4392 * this may be a styled CharSequence, so you must use
4393 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4394 * retrieve it.
4395 */
4396 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4397
4398 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004399 * A constant String that is associated with the Intent, used with
4400 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4401 * as HTML formatted text. Note that you <em>must</em> also supply
4402 * {@link #EXTRA_TEXT}.
4403 */
4404 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4405
4406 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004407 * A content: URI holding a stream of data associated with the Intent,
4408 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004409 */
4410 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4411
4412 /**
4413 * A String[] holding e-mail addresses that should be delivered to.
4414 */
4415 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4416
4417 /**
4418 * A String[] holding e-mail addresses that should be carbon copied.
4419 */
4420 public static final String EXTRA_CC = "android.intent.extra.CC";
4421
4422 /**
4423 * A String[] holding e-mail addresses that should be blind carbon copied.
4424 */
4425 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4426
4427 /**
4428 * A constant string holding the desired subject line of a message.
4429 */
4430 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4431
4432 /**
4433 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004434 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004435 */
4436 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4437
4438 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004439 * An int representing the user id to be used.
4440 *
4441 * @hide
4442 */
4443 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4444
4445 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004446 * An int representing the task id to be retrieved. This is used when a launch from recents is
4447 * intercepted by another action such as credentials confirmation to remember which task should
4448 * be resumed when complete.
4449 *
4450 * @hide
4451 */
4452 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4453
4454 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004455 * An Intent[] describing additional, alternate choices you would like shown with
4456 * {@link #ACTION_CHOOSER}.
4457 *
4458 * <p>An app may be capable of providing several different payload types to complete a
4459 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4460 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4461 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4462 * photo data or a hosted link where the photos can be viewed.</p>
4463 *
4464 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4465 * first/primary/preferred intent in the set. Additional intents specified in
4466 * this extra are ordered; by default intents that appear earlier in the array will be
4467 * preferred over intents that appear later in the array as matches for the same
4468 * target component. To alter this preference, a calling app may also supply
4469 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4470 */
4471 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4472
4473 /**
Adam Powell52c39212016-04-07 15:14:18 -07004474 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4475 * and omitted from a list of components presented to the user.
4476 *
4477 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4478 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4479 * from your own package or other apps from your organization if the idea of sending to those
4480 * targets would be redundant with other app functionality. Filtered components will not
4481 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4482 */
4483 public static final String EXTRA_EXCLUDE_COMPONENTS
4484 = "android.intent.extra.EXCLUDE_COMPONENTS";
4485
4486 /**
4487 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4488 * describing additional high-priority deep-link targets for the chooser to present to the user.
4489 *
4490 * <p>Targets provided in this way will be presented inline with all other targets provided
4491 * by services from other apps. They will be prioritized before other service targets, but
4492 * after those targets provided by sources that the user has manually pinned to the front.</p>
4493 *
4494 * @see #ACTION_CHOOSER
4495 */
4496 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4497
4498 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004499 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4500 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4501 *
4502 * <p>An app preparing an action for another app to complete may wish to allow the user to
4503 * disambiguate between several options for completing the action based on the chosen target
4504 * or otherwise refine the action before it is invoked.
4505 * </p>
4506 *
4507 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4508 * <ul>
4509 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4510 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4511 * chosen target beyond the first</li>
4512 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4513 * should fill in and send once the disambiguation is complete</li>
4514 * </ul>
4515 */
4516 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4517 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4518
4519 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004520 * An {@code ArrayList} of {@code String} annotations describing content for
4521 * {@link #ACTION_CHOOSER}.
4522 *
4523 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4524 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4525 *
4526 * <p>Annotations should describe the major components or topics of the content. It is up to
4527 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4528 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004529 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4530 * character. Performance on customized annotations can suffer, if they are rarely used for
4531 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4532 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004533 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004534 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004535 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004536 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004537 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004538 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004539 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004540 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004541 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004542 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4543 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4544 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4545 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4546 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004547 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004548 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4549 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004550 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004551 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004552 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004553 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004554 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004555 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004556 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004557 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004558 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004559 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004560 * Christmas and Thanksgiving.</li>
4561 * </ul>
4562 */
4563 public static final String EXTRA_CONTENT_ANNOTATIONS
4564 = "android.intent.extra.CONTENT_ANNOTATIONS";
4565
4566 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004567 * A {@link ResultReceiver} used to return data back to the sender.
4568 *
4569 * <p>Used to complete an app-specific
4570 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4571 *
4572 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4573 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4574 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4575 * when the user selects a target component from the chooser. It is up to the recipient
4576 * to send a result to this ResultReceiver to signal that disambiguation is complete
4577 * and that the chooser should invoke the user's choice.</p>
4578 *
4579 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4580 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4581 * to match and fill in the final Intent or ChooserTarget before starting it.
4582 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4583 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4584 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4585 *
4586 * <p>The result code passed to the ResultReceiver should be
4587 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4588 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4589 * the chooser should finish without starting a target.</p>
4590 */
4591 public static final String EXTRA_RESULT_RECEIVER
4592 = "android.intent.extra.RESULT_RECEIVER";
4593
4594 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004595 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004596 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004597 */
4598 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4599
4600 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004601 * A Parcelable[] of {@link Intent} or
4602 * {@link android.content.pm.LabeledIntent} objects as set with
4603 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4604 * a the front of the list of choices, when shown to the user with a
4605 * {@link #ACTION_CHOOSER}.
4606 */
4607 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4608
4609 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004610 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004611 * @hide
4612 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004613 @SystemApi
4614 public static final String EXTRA_INSTANT_APP_SUCCESS =
4615 "android.intent.extra.INSTANT_APP_SUCCESS";
4616
4617 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004618 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004619 * @hide
4620 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004621 @SystemApi
4622 public static final String EXTRA_INSTANT_APP_FAILURE =
4623 "android.intent.extra.INSTANT_APP_FAILURE";
4624
4625 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004626 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004627 * @hide
4628 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004629 @SystemApi
4630 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4631 "android.intent.extra.INSTANT_APP_HOSTNAME";
4632
4633 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004634 * An opaque token to track instant app resolution.
4635 * @hide
4636 */
4637 @SystemApi
4638 public static final String EXTRA_INSTANT_APP_TOKEN =
4639 "android.intent.extra.INSTANT_APP_TOKEN";
4640
4641 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004642 * The action that triggered an instant application resolution.
4643 * @hide
4644 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004645 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004646 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4647
4648 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004649 * An array of {@link Bundle}s containing details about resolved instant apps..
4650 * @hide
4651 */
4652 @SystemApi
4653 public static final String EXTRA_INSTANT_APP_BUNDLES =
4654 "android.intent.extra.INSTANT_APP_BUNDLES";
4655
4656 /**
4657 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004658 * installed. This data is populated from the response to
4659 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4660 * instant application resolver.
4661 * @hide
4662 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004663 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004664 public static final String EXTRA_INSTANT_APP_EXTRAS =
4665 "android.intent.extra.INSTANT_APP_EXTRAS";
4666
4667 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004668 * A boolean value indicating that the instant app resolver was unable to state with certainty
4669 * that it did or did not have an app for the sanitized {@link Intent} defined at
4670 * {@link #EXTRA_INTENT}.
4671 * @hide
4672 */
4673 @SystemApi
4674 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4675 "android.intent.extra.UNKNOWN_INSTANT_APP";
4676
4677 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004678 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004679 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004680 * @hide
4681 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004682 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004683 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4684
4685 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004686 * The version code of the app to install components from.
4687 * @hide
4688 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004689 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004690 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4691
4692 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004693 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004694 * @hide
4695 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004696 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004697 public static final String EXTRA_CALLING_PACKAGE
4698 = "android.intent.extra.CALLING_PACKAGE";
4699
4700 /**
4701 * Optional calling app provided bundle containing additional launch information the
4702 * installer may use.
4703 * @hide
4704 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004705 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004706 public static final String EXTRA_VERIFICATION_BUNDLE
4707 = "android.intent.extra.VERIFICATION_BUNDLE";
4708
4709 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004710 * A Bundle forming a mapping of potential target package names to different extras Bundles
4711 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4712 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4713 * be currently installed on the device.
4714 *
4715 * <p>An application may choose to provide alternate extras for the case where a user
4716 * selects an activity from a predetermined set of target packages. If the activity
4717 * the user selects from the chooser belongs to a package with its package name as
4718 * a key in this bundle, the corresponding extras for that package will be merged with
4719 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4720 * extra has the same key as an extra already present in the intent it will overwrite
4721 * the extra from the intent.</p>
4722 *
4723 * <p><em>Examples:</em>
4724 * <ul>
4725 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4726 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4727 * parameters for that target.</li>
4728 * <li>An application may offer additional metadata for known targets of a given intent
4729 * to pass along information only relevant to that target such as account or content
4730 * identifiers already known to that application.</li>
4731 * </ul></p>
4732 */
4733 public static final String EXTRA_REPLACEMENT_EXTRAS =
4734 "android.intent.extra.REPLACEMENT_EXTRAS";
4735
4736 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004737 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4738 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4739 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4740 * {@link ComponentName} of the chosen component.
4741 *
4742 * <p>In some situations this callback may never come, for example if the user abandons
4743 * the chooser, switches to another task or any number of other reasons. Apps should not
4744 * be written assuming that this callback will always occur.</p>
4745 */
4746 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4747 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4748
4749 /**
4750 * The {@link ComponentName} chosen by the user to complete an action.
4751 *
4752 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4753 */
4754 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4755
4756 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004757 * A {@link android.view.KeyEvent} object containing the event that
4758 * triggered the creation of the Intent it is in.
4759 */
4760 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4761
4762 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004763 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4764 * before shutting down.
4765 *
4766 * {@hide}
4767 */
4768 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4769
4770 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004771 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4772 * requested by the user.
4773 *
4774 * {@hide}
4775 */
4776 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4777 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4778
4779 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004780 * 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 -07004781 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4782 * of restarting the application.
4783 */
4784 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4785
4786 /**
4787 * A String holding the phone number originally entered in
4788 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4789 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4790 */
4791 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004792
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004793 /**
4794 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4795 * intents to supply the uid the package had been assigned. Also an optional
4796 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4797 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4798 * purpose.
4799 */
4800 public static final String EXTRA_UID = "android.intent.extra.UID";
4801
4802 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004803 * @hide String array of package names.
4804 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004805 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004806 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4807
4808 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004809 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4810 * intents to indicate whether this represents a full uninstall (removing
4811 * both the code and its data) or a partial uninstall (leaving its data,
4812 * implying that this is an update).
4813 */
4814 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004815
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004816 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004817 * @hide
4818 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4819 * intents to indicate that at this point the package has been removed for
4820 * all users on the device.
4821 */
4822 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4823 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4824
4825 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004826 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4827 * intents to indicate that this is a replacement of the package, so this
4828 * broadcast will immediately be followed by an add broadcast for a
4829 * different version of the same package.
4830 */
4831 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004832
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004833 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004834 * Used as an int extra field in {@link android.app.AlarmManager} intents
4835 * to tell the application being invoked how many pending alarms are being
4836 * delievered with the intent. For one-shot alarms this will always be 1.
4837 * For recurring alarms, this might be greater than 1 if the device was
4838 * asleep or powered off at the time an earlier alarm would have been
4839 * delivered.
4840 */
4841 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004842
Jacek Surazski86b6c532009-05-13 14:38:28 +02004843 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004844 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4845 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004846 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4847 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004848 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4849 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4850 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004851 */
4852 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4853
4854 /**
4855 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4856 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004857 */
4858 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4859
4860 /**
4861 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4862 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004863 */
4864 public static final int EXTRA_DOCK_STATE_DESK = 1;
4865
4866 /**
4867 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4868 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004869 */
4870 public static final int EXTRA_DOCK_STATE_CAR = 2;
4871
4872 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004873 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4874 * to represent that the phone is in a analog (low end) dock.
4875 */
4876 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4877
4878 /**
4879 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4880 * to represent that the phone is in a digital (high end) dock.
4881 */
4882 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4883
4884 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004885 * Boolean that can be supplied as meta-data with a dock activity, to
4886 * indicate that the dock should take over the home key when it is active.
4887 */
4888 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004889
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004890 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004891 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4892 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004893 */
4894 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4895
4896 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004897 * Used in the extra field in the remote intent. It's astring token passed with the
4898 * remote intent.
4899 */
4900 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4901 "android.intent.extra.remote_intent_token";
4902
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004903 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004904 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004905 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004906 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004907 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004908 "android.intent.extra.changed_component_name";
4909
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004910 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004911 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004912 * and contains a string array of all of the components that have changed. If
4913 * the state of the overall package has changed, then it will contain an entry
4914 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004915 */
4916 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4917 "android.intent.extra.changed_component_name_list";
4918
4919 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004920 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004921 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004922 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4923 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4924 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004925 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004926 */
4927 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4928 "android.intent.extra.changed_package_list";
4929
4930 /**
4931 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004932 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4933 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004934 * and contains an integer array of uids of all of the components
4935 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004936 */
4937 public static final String EXTRA_CHANGED_UID_LIST =
4938 "android.intent.extra.changed_uid_list";
4939
4940 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004941 * @hide
4942 * Magic extra system code can use when binding, to give a label for
4943 * who it is that has bound to a service. This is an integer giving
4944 * a framework string resource that can be displayed to the user.
4945 */
4946 public static final String EXTRA_CLIENT_LABEL =
4947 "android.intent.extra.client_label";
4948
4949 /**
4950 * @hide
4951 * Magic extra system code can use when binding, to give a PendingIntent object
4952 * that can be launched for the user to disable the system's use of this
4953 * service.
4954 */
4955 public static final String EXTRA_CLIENT_INTENT =
4956 "android.intent.extra.client_intent";
4957
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004958 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004959 * Extra used to indicate that an intent should only return data that is on
4960 * the local device. This is a boolean extra; the default is false. If true,
4961 * an implementation should only allow the user to select data that is
4962 * already on the device, not requiring it be downloaded from a remote
4963 * service when opened.
4964 *
4965 * @see #ACTION_GET_CONTENT
4966 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004967 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004968 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004969 */
4970 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004971 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004972
Amith Yamasani13593602012-03-22 16:16:17 -07004973 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004974 * Extra used to indicate that an intent can allow the user to select and
4975 * return multiple items. This is a boolean extra; the default is false. If
4976 * true, an implementation is allowed to present the user with a UI where
4977 * they can pick multiple items that are all returned to the caller. When
4978 * this happens, they should be returned as the {@link #getClipData()} part
4979 * of the result Intent.
4980 *
4981 * @see #ACTION_GET_CONTENT
4982 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004983 */
4984 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004985 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004986
4987 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004988 * The integer userHandle carried with broadcast intents related to addition, removal and
4989 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4990 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4991 *
Amith Yamasani13593602012-03-22 16:16:17 -07004992 * @hide
4993 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004994 public static final String EXTRA_USER_HANDLE =
4995 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004996
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004997 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004998 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4999 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
5000 */
5001 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01005002 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01005003
5004 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005005 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005006 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
5007 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005008 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07005009 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
5010
5011 /**
5012 * Extra sent in the intent to the BroadcastReceiver that handles
5013 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
5014 * the restrictions as key/value pairs.
5015 */
5016 public static final String EXTRA_RESTRICTIONS_BUNDLE =
5017 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08005018
Amith Yamasani86118ba2013-03-28 14:33:16 -07005019 /**
5020 * Extra used in the response from a BroadcastReceiver that handles
5021 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
5022 */
5023 public static final String EXTRA_RESTRICTIONS_INTENT =
5024 "android.intent.extra.restrictions_intent";
5025
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005026 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005027 * Extra used to communicate a set of acceptable MIME types. The type of the
5028 * extra is {@code String[]}. Values may be a combination of concrete MIME
5029 * types (such as "image/png") and/or partial MIME types (such as
5030 * "audio/*").
5031 *
5032 * @see #ACTION_GET_CONTENT
5033 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07005034 */
5035 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
5036
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005037 /**
5038 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
5039 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07005040 * When this is true, hardware devices can use this information to determine that
5041 * they shouldn't do a complete shutdown of their device since this is not a
5042 * complete shutdown down to the kernel, but only user space restarting.
5043 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07005044 */
5045 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
5046 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
5047
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005048 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00005049 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
5050 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
5051 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
5052 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005053 *
5054 * @hide for internal use only.
5055 */
5056 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
5057 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00005058 /** @hide */
5059 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
5060 /** @hide */
5061 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
5062 /** @hide */
5063 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00005064
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07005065 /**
5066 * Intent extra: the reason that the operation associated with this intent is being performed.
5067 *
5068 * <p>Type: String
5069 * @hide
5070 */
5071 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07005072 public static final String EXTRA_REASON = "android.intent.extra.REASON";
5073
qingxi240c2bb2017-04-12 17:31:18 -07005074 /**
5075 * {@hide}
5076 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
5077 */
Rubin Xue8490f12015-06-25 12:17:48 +01005078 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
5079
Santos Cordon15a13782015-03-31 18:32:31 -07005080 /**
qingxi240c2bb2017-04-12 17:31:18 -07005081 * {@hide}
5082 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
5083 * reset for the device with eSIM. This extra will be sent together with
5084 * {@link #ACTION_FACTORY_RESET}
5085 */
5086 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
5087
5088 /**
Santos Cordon15a13782015-03-31 18:32:31 -07005089 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
5090 * activation request.
5091 * TODO: Add information about the structure and response data used with the pending intent.
5092 * @hide
5093 */
5094 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
5095 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
5096
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005097 /**
5098 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09005099 *
5100 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07005101 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09005102 */
Steve McKay6eaf38632015-08-04 10:11:01 -07005103 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
5104
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005105 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005106 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
5107 * such as opening in other apps, sharing, opening, editing, printing, deleting,
5108 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005109 *
5110 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07005111 * @see #ACTION_QUICK_VIEW
5112 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005113 */
Garfield Tance1d0e92017-03-23 10:52:48 -07005114 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09005115 public static final String EXTRA_QUICK_VIEW_ADVANCED =
5116 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09005117
5118 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07005119 * An optional extra of {@code String[]} indicating which quick view features should be made
5120 * available to the user in the quick view UI while handing a
5121 * {@link Intent#ACTION_QUICK_VIEW} intent.
5122 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
5123 * Quick viewer can implement features not listed below.
5124 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05005125 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
5126 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
5127 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07005128 * <p>
5129 * Requirements:
5130 * <li>Quick viewer shouldn't show a feature if the feature is absent in
5131 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
5132 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
5133 * internal policies.
5134 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
5135 * requirement that the feature be shown. Quick viewer may, according to its own policies,
5136 * disable or hide features.
5137 *
5138 * @see #ACTION_QUICK_VIEW
5139 */
5140 public static final String EXTRA_QUICK_VIEW_FEATURES =
5141 "android.intent.extra.QUICK_VIEW_FEATURES";
5142
5143 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005144 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01005145 * When a profile goes into quiet mode, all apps in the profile are killed and the
5146 * profile user is stopped. Widgets originating from the profile are masked, and app
5147 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00005148 */
5149 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005150
5151 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005152 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005153 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005154 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
5155 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005156 *
5157 * @hide
5158 */
5159 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5160 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5161
5162 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005163 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5164 * whether to show the chooser or not when there is only one application available
5165 * to choose from.
5166 *
5167 * @hide
5168 */
5169 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5170 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5171
5172 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005173 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005174 * to represent that a video codec is allowed to use.
5175 *
5176 * @hide
5177 */
5178 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5179
5180 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005181 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005182 * to represent that a audio codec is allowed to use.
5183 *
5184 * @hide
5185 */
5186 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5187
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005188 // ---------------------------------------------------------------------
5189 // ---------------------------------------------------------------------
5190 // Intent flags (see mFlags variable).
5191
Tor Norbyed9273d62013-05-30 15:59:53 -07005192 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005193 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005194 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5195 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005196 @Retention(RetentionPolicy.SOURCE)
5197 public @interface GrantUriMode {}
5198
Jeff Sharkey846318a2014-04-04 12:12:41 -07005199 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005200 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005201 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5202 @Retention(RetentionPolicy.SOURCE)
5203 public @interface AccessUriMode {}
5204
5205 /**
5206 * Test if given mode flags specify an access mode, which must be at least
5207 * read and/or write.
5208 *
5209 * @hide
5210 */
5211 public static boolean isAccessUriMode(int modeFlags) {
5212 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5213 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5214 }
5215
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005216 /** @hide */
5217 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5218 FLAG_GRANT_READ_URI_PERMISSION,
5219 FLAG_GRANT_WRITE_URI_PERMISSION,
5220 FLAG_FROM_BACKGROUND,
5221 FLAG_DEBUG_LOG_RESOLUTION,
5222 FLAG_EXCLUDE_STOPPED_PACKAGES,
5223 FLAG_INCLUDE_STOPPED_PACKAGES,
5224 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5225 FLAG_GRANT_PREFIX_URI_PERMISSION,
5226 FLAG_DEBUG_TRIAGED_MISSING,
5227 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005228 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005229 FLAG_ACTIVITY_NO_HISTORY,
5230 FLAG_ACTIVITY_SINGLE_TOP,
5231 FLAG_ACTIVITY_NEW_TASK,
5232 FLAG_ACTIVITY_MULTIPLE_TASK,
5233 FLAG_ACTIVITY_CLEAR_TOP,
5234 FLAG_ACTIVITY_FORWARD_RESULT,
5235 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5236 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5237 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5238 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5239 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5240 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5241 FLAG_ACTIVITY_NEW_DOCUMENT,
5242 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5243 FLAG_ACTIVITY_NO_USER_ACTION,
5244 FLAG_ACTIVITY_REORDER_TO_FRONT,
5245 FLAG_ACTIVITY_NO_ANIMATION,
5246 FLAG_ACTIVITY_CLEAR_TASK,
5247 FLAG_ACTIVITY_TASK_ON_HOME,
5248 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5249 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5250 FLAG_RECEIVER_REGISTERED_ONLY,
5251 FLAG_RECEIVER_REPLACE_PENDING,
5252 FLAG_RECEIVER_FOREGROUND,
5253 FLAG_RECEIVER_NO_ABORT,
5254 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5255 FLAG_RECEIVER_BOOT_UPGRADE,
5256 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5257 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5258 FLAG_RECEIVER_FROM_SHELL,
5259 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5260 })
5261 @Retention(RetentionPolicy.SOURCE)
5262 public @interface Flags {}
5263
5264 /** @hide */
5265 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5266 FLAG_FROM_BACKGROUND,
5267 FLAG_DEBUG_LOG_RESOLUTION,
5268 FLAG_EXCLUDE_STOPPED_PACKAGES,
5269 FLAG_INCLUDE_STOPPED_PACKAGES,
5270 FLAG_DEBUG_TRIAGED_MISSING,
5271 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005272 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005273 FLAG_ACTIVITY_NO_HISTORY,
5274 FLAG_ACTIVITY_SINGLE_TOP,
5275 FLAG_ACTIVITY_NEW_TASK,
5276 FLAG_ACTIVITY_MULTIPLE_TASK,
5277 FLAG_ACTIVITY_CLEAR_TOP,
5278 FLAG_ACTIVITY_FORWARD_RESULT,
5279 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5280 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5281 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5282 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5283 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5284 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5285 FLAG_ACTIVITY_NEW_DOCUMENT,
5286 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5287 FLAG_ACTIVITY_NO_USER_ACTION,
5288 FLAG_ACTIVITY_REORDER_TO_FRONT,
5289 FLAG_ACTIVITY_NO_ANIMATION,
5290 FLAG_ACTIVITY_CLEAR_TASK,
5291 FLAG_ACTIVITY_TASK_ON_HOME,
5292 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5293 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5294 FLAG_RECEIVER_REGISTERED_ONLY,
5295 FLAG_RECEIVER_REPLACE_PENDING,
5296 FLAG_RECEIVER_FOREGROUND,
5297 FLAG_RECEIVER_NO_ABORT,
5298 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5299 FLAG_RECEIVER_BOOT_UPGRADE,
5300 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5301 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5302 FLAG_RECEIVER_FROM_SHELL,
5303 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5304 })
5305 @Retention(RetentionPolicy.SOURCE)
5306 public @interface MutableFlags {}
5307
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005308 /**
5309 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005310 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005311 * specified in its ClipData. When applying to an Intent's ClipData,
5312 * all URIs as well as recursive traversals through data or other ClipData
5313 * in Intent items will be granted; only the grant flags of the top-level
5314 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 */
5316 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5317 /**
5318 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005319 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005320 * specified in its ClipData. When applying to an Intent's ClipData,
5321 * all URIs as well as recursive traversals through data or other ClipData
5322 * in Intent items will be granted; only the grant flags of the top-level
5323 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005324 */
5325 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5326 /**
5327 * Can be set by the caller to indicate that this Intent is coming from
5328 * a background operation, not from direct user interaction.
5329 */
5330 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5331 /**
5332 * A flag you can enable for debugging: when set, log messages will be
5333 * printed during the resolution of this intent to show you what has
5334 * been found to create the final resolved list.
5335 */
5336 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005337 /**
5338 * If set, this intent will not match any components in packages that
5339 * are currently stopped. If this is not set, then the default behavior
5340 * is to include such applications in the result.
5341 */
5342 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5343 /**
5344 * If set, this intent will always match any components in packages that
5345 * are currently stopped. This is the default behavior when
5346 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5347 * flags are set, this one wins (it allows overriding of exclude for
5348 * places where the framework may automatically set the exclude flag).
5349 */
5350 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005351
5352 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005353 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005354 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005355 * persisted across device reboots until explicitly revoked with
5356 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5357 * grant for possible persisting; the receiving application must call
5358 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5359 * actually persist.
5360 *
5361 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5362 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5363 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005364 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005365 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005366 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005367
5368 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005369 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5370 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5371 * applies to any URI that is a prefix match against the original granted
5372 * URI. (Without this flag, the URI must match exactly for access to be
5373 * granted.) Another URI is considered a prefix match only when scheme,
5374 * authority, and all path segments defined by the prefix are an exact
5375 * match.
5376 */
5377 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5378
5379 /**
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005380 * Flag used to automatically match intents based on their Direct Boot
5381 * awareness and the current user state.
5382 * <p>
5383 * Since the default behavior is to automatically apply the current user
5384 * state, this is effectively a sentinel value that doesn't change the
5385 * output of any queries based on its presence or absence.
5386 * <p>
5387 * Instead, this value can be useful in conjunction with
5388 * {@link android.os.StrictMode.VmPolicy.Builder#detectImplicitDirectBoot()}
5389 * to detect when a caller is relying on implicit automatic matching,
5390 * instead of confirming the explicit behavior they want.
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005391 */
Jeff Sharkeyc59a5e72018-06-21 19:14:58 -06005392 public static final int FLAG_DIRECT_BOOT_AUTO = 0x00000100;
5393
5394 /** {@hide} */
5395 @Deprecated
5396 public static final int FLAG_DEBUG_TRIAGED_MISSING = FLAG_DIRECT_BOOT_AUTO;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005397
5398 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005399 * Internal flag used to indicate ephemeral applications should not be
5400 * considered when resolving the intent.
5401 *
5402 * @hide
5403 */
5404 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5405
5406 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005407 * If set, the new activity is not kept in the history stack. As soon as
5408 * the user navigates away from it, the activity is finished. This may also
5409 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5410 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005411 *
5412 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5413 * is never invoked when the current activity starts a new activity which
5414 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005415 */
5416 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5417 /**
5418 * If set, the activity will not be launched if it is already running
5419 * at the top of the history stack.
5420 */
5421 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5422 /**
5423 * If set, this activity will become the start of a new task on this
5424 * history stack. A task (from the activity that started it to the
5425 * next task activity) defines an atomic group of activities that the
5426 * user can move to. Tasks can be moved to the foreground and background;
5427 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005428 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005429 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5430 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005431 *
5432 * <p>This flag is generally used by activities that want
5433 * to present a "launcher" style behavior: they give the user a list of
5434 * separate things that can be done, which otherwise run completely
5435 * independently of the activity launching them.
5436 *
5437 * <p>When using this flag, if a task is already running for the activity
5438 * you are now starting, then a new activity will not be started; instead,
5439 * the current task will simply be brought to the front of the screen with
5440 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5441 * to disable this behavior.
5442 *
5443 * <p>This flag can not be used when the caller is requesting a result from
5444 * the activity being launched.
5445 */
5446 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5447 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005448 * This flag is used to create a new task and launch an activity into it.
5449 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5450 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5451 * search through existing tasks for ones matching this Intent. Only if no such
5452 * task is found would a new task be created. When paired with
5453 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5454 * the search for a matching task and unconditionally start a new task.
5455 *
5456 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5457 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005458 * top-level application launcher.</strong> Used in conjunction with
5459 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5460 * behavior of bringing an existing task to the foreground. When set,
5461 * a new task is <em>always</em> started to host the Activity for the
5462 * Intent, regardless of whether there is already an existing task running
5463 * the same thing.
5464 *
5465 * <p><strong>Because the default system does not include graphical task management,
5466 * you should not use this flag unless you provide some way for a user to
5467 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005468 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005469 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5470 * creating new document tasks.
5471 *
5472 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005473 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005474 *
Scott Main7aee61f2011-02-08 11:25:01 -08005475 * <p>See
5476 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5477 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005478 *
5479 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5480 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005481 */
5482 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5483 /**
5484 * If set, and the activity being launched is already running in the
5485 * current task, then instead of launching a new instance of that activity,
5486 * all of the other activities on top of it will be closed and this Intent
5487 * will be delivered to the (now on top) old activity as a new Intent.
5488 *
5489 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5490 * If D calls startActivity() with an Intent that resolves to the component
5491 * of activity B, then C and D will be finished and B receive the given
5492 * Intent, resulting in the stack now being: A, B.
5493 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005494 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005495 * either receive the new intent you are starting here in its
5496 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005497 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005498 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5499 * the same intent, then it will be finished and re-created; for all other
5500 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5501 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005502 *
5503 * <p>This launch mode can also be used to good effect in conjunction with
5504 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5505 * of a task, it will bring any currently running instance of that task
5506 * to the foreground, and then clear it to its root state. This is
5507 * especially useful, for example, when launching an activity from the
5508 * notification manager.
5509 *
Scott Main7aee61f2011-02-08 11:25:01 -08005510 * <p>See
5511 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5512 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005513 */
5514 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5515 /**
5516 * If set and this intent is being used to launch a new activity from an
5517 * existing one, then the reply target of the existing activity will be
5518 * transfered to the new activity. This way the new activity can call
5519 * {@link android.app.Activity#setResult} and have that result sent back to
5520 * the reply target of the original activity.
5521 */
5522 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5523 /**
5524 * If set and this intent is being used to launch a new activity from an
5525 * existing one, the current activity will not be counted as the top
5526 * activity for deciding whether the new intent should be delivered to
5527 * the top instead of starting a new one. The previous activity will
5528 * be used as the top, with the assumption being that the current activity
5529 * will finish itself immediately.
5530 */
5531 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5532 /**
5533 * If set, the new activity is not kept in the list of recently launched
5534 * activities.
5535 */
5536 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5537 /**
5538 * This flag is not normally set by application code, but set for you by
5539 * the system as described in the
5540 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5541 * launchMode} documentation for the singleTask mode.
5542 */
5543 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5544 /**
5545 * If set, and this activity is either being started in a new task or
5546 * bringing to the top an existing task, then it will be launched as
5547 * the front door of the task. This will result in the application of
5548 * any affinities needed to have that task in the proper state (either
5549 * moving activities to or from it), or simply resetting that task to
5550 * its initial state if needed.
5551 */
5552 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5553 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005554 * This flag is not normally set by application code, but set for you by
5555 * the system if this activity is being launched from history
5556 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005557 */
5558 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005559 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005560 * @deprecated As of API 21 this performs identically to
5561 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005562 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005563 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005564 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005565 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005566 * This flag is used to open a document into a new task rooted at the activity launched
5567 * by this Intent. Through the use of this flag, or its equivalent attribute,
5568 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005569 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005570 *
Craig Mautner026596b2014-05-21 15:35:44 -07005571 * <p>The use of the activity attribute form of this,
5572 * {@link android.R.attr#documentLaunchMode}, is
5573 * preferred over the Intent flag described here. The attribute form allows the
5574 * Activity to specify multiple document behavior for all launchers of the Activity
5575 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005576 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005577 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5578 * it is kept after the activity is finished is different than the use of
5579 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5580 * this flag is being used to create a new recents entry, then by default that entry
5581 * will be removed once the activity is finished. You can modify this behavior with
5582 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5583 *
Craig Mautner026596b2014-05-21 15:35:44 -07005584 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5585 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5586 * equivalent of the Activity manifest specifying {@link
5587 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5588 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5589 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005590 *
Craig Mautner026596b2014-05-21 15:35:44 -07005591 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005592 *
Craig Mautner026596b2014-05-21 15:35:44 -07005593 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005594 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5595 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005596 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005597 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005598 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005599 * callback from occurring on the current frontmost activity before it is
5600 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005601 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005602 * <p>Typically, an activity can rely on that callback to indicate that an
5603 * explicit user action has caused their activity to be moved out of the
5604 * foreground. The callback marks an appropriate point in the activity's
5605 * lifecycle for it to dismiss any notifications that it intends to display
5606 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005607 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005608 * <p>If an activity is ever started via any non-user-driven events such as
5609 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5610 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005611 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005612 */
5613 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005614 /**
5615 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5616 * this flag will cause the launched activity to be brought to the front of its
5617 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005618 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005619 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5620 * If D calls startActivity() with an Intent that resolves to the component
5621 * of activity B, then B will be brought to the front of the history stack,
5622 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005623 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005624 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005625 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005626 */
5627 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005628 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005629 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5630 * this flag will prevent the system from applying an activity transition
5631 * animation to go to the next activity state. This doesn't mean an
5632 * animation will never run -- if another activity change happens that doesn't
5633 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005634 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005635 * when you are going to do a series of activity operations but the
5636 * animation seen by the user shouldn't be driven by the first activity
5637 * change but rather a later one.
5638 */
5639 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5640 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005641 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5642 * this flag will cause any existing task that would be associated with the
5643 * activity to be cleared before the activity is started. That is, the activity
5644 * becomes the new root of an otherwise empty task, and any old activities
5645 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5646 */
5647 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5648 /**
5649 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5650 * this flag will cause a newly launching task to be placed on top of the current
5651 * home activity task (if there is one). That is, pressing back from the task
5652 * will always return the user to home even if that was not the last activity they
5653 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5654 */
5655 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5656 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005657 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5658 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005659 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005660 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005661 * this flag. When set and the task's activity is finished, the recents
5662 * entry will remain in the interface for the user to re-launch it, like a
5663 * recents entry for a top-level application.
5664 * <p>
5665 * The receiving activity can override this request with
5666 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5667 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005668 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005669 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005670 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005671
5672 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005673 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5674 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005675 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5676 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005677 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005678 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005679
Patrick Baumann577d4022018-01-31 16:55:10 +00005680
5681 /**
Patrick Baumann92ae2c62018-05-10 10:10:26 -07005682 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5683 * this flag will attempt to launch an instant app if no full app on the device can already
5684 * handle the intent.
5685 * <p>
5686 * When attempting to resolve instant apps externally, the following {@link Intent} properties
5687 * are supported:
5688 * <ul>
5689 * <li>{@link Intent#setAction(String)}</li>
5690 * <li>{@link Intent#addCategory(String)}</li>
5691 * <li>{@link Intent#setData(Uri)}</li>
5692 * <li>{@link Intent#setType(String)}</li>
5693 * <li>{@link Intent#setPackage(String)}</li>
5694 * <li>{@link Intent#addFlags(int)}</li>
5695 * </ul>
5696 * <p>
5697 * In the case that no instant app can be found, the installer will be launched to notify the
5698 * user that the intent could not be resolved. On devices that do not support instant apps,
5699 * the flag will be ignored.
Patrick Baumann577d4022018-01-31 16:55:10 +00005700 */
5701 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5702
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005703 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005704 * If set, when sending a broadcast only registered receivers will be
5705 * called -- no BroadcastReceiver components will be launched.
5706 */
5707 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005708 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005709 * If set, when sending a broadcast the new broadcast will replace
5710 * any existing pending broadcast that matches it. Matching is defined
5711 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5712 * true for the intents of the two broadcasts. When a match is found,
5713 * the new broadcast (and receivers associated with it) will replace the
5714 * existing one in the pending broadcast list, remaining at the same
5715 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005716 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005717 * <p>This flag is most typically used with sticky broadcasts, which
5718 * only care about delivering the most recent values of the broadcast
5719 * to their receivers.
5720 */
5721 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5722 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005723 * If set, when sending a broadcast the recipient is allowed to run at
5724 * foreground priority, with a shorter timeout interval. During normal
5725 * broadcasts the receivers are not automatically hoisted out of the
5726 * background priority class.
5727 */
5728 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5729 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005730 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5731 * They can still propagate results through to later receivers, but they can not prevent
5732 * later receivers from seeing the broadcast.
5733 */
5734 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5735 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005736 * If set, when sending a broadcast <i>before boot has completed</i> only
5737 * registered receivers will be called -- no BroadcastReceiver components
5738 * will be launched. Sticky intent state will be recorded properly even
5739 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5740 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005741 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005742 * <p>This flag is only for use by system sevices as a convenience to
5743 * avoid having to implement a more complex mechanism around detection
5744 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005745 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005746 * @hide
5747 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005748 @UnsupportedAppUsage
Dianne Hackborn6285a322013-09-18 12:09:47 -07005749 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005750 /**
5751 * Set when this broadcast is for a boot upgrade, a special mode that
5752 * allows the broadcast to be sent before the system is ready and launches
5753 * the app process with no providers running in it.
5754 * @hide
5755 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005756 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005757 /**
5758 * If set, the broadcast will always go to manifest receivers in background (cached
5759 * or not running) apps, regardless of whether that would be done by default. By
5760 * default they will only receive broadcasts if the broadcast has specified an
5761 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005762 *
5763 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5764 * the broadcast code there must also be changed to match.
5765 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005766 * @hide
5767 */
5768 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5769 /**
5770 * If set, the broadcast will never go to manifest receivers in background (cached
5771 * or not running) apps, regardless of whether that would be done by default. By
5772 * default they will receive broadcasts if the broadcast has specified an
5773 * explicit component or package name.
5774 * @hide
5775 */
5776 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005777 /**
5778 * If set, this broadcast is being sent from the shell.
5779 * @hide
5780 */
5781 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005782
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005783 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005784 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5785 * will not receive broadcasts.
5786 *
5787 * <em>This flag has no effect when used by an Instant App.</em>
5788 */
5789 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5790
5791 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005792 * @hide Flags that can't be changed with PendingIntent.
5793 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005794 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5795 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5796 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005797
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005798 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005799 // ---------------------------------------------------------------------
5800 // toUri() and parseUri() options.
5801
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005802 /** @hide */
5803 @IntDef(flag = true, prefix = { "URI_" }, value = {
5804 URI_ALLOW_UNSAFE,
5805 URI_ANDROID_APP_SCHEME,
5806 URI_INTENT_SCHEME,
5807 })
5808 @Retention(RetentionPolicy.SOURCE)
5809 public @interface UriFlags {}
5810
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005811 /**
5812 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5813 * always has the "intent:" scheme. This syntax can be used when you want
5814 * to later disambiguate between URIs that are intended to describe an
5815 * Intent vs. all others that should be treated as raw URIs. When used
5816 * with {@link #parseUri}, any other scheme will result in a generic
5817 * VIEW action for that raw URI.
5818 */
5819 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005820
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005821 /**
5822 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5823 * always has the "android-app:" scheme. This is a variation of
5824 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5825 * http/https URI being delivered to a specific package name. The format
5826 * is:
5827 *
5828 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005829 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005830 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005831 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5832 * you must also include a scheme; including a path also requires both a host and a scheme.
5833 * The final #Intent; fragment can be used without a scheme, host, or path.
5834 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005835 * used with intents that have a {@link #setSelector}, since the base intent
5836 * will always have an explicit package name.</p>
5837 *
5838 * <p>Some examples of how this scheme maps to Intent objects:</p>
5839 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5840 * <colgroup align="left" />
5841 * <colgroup align="left" />
5842 * <thead>
5843 * <tr><th>URI</th> <th>Intent</th></tr>
5844 * </thead>
5845 *
5846 * <tbody>
5847 * <tr><td><code>android-app://com.example.app</code></td>
5848 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5849 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5850 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5851 * </table></td>
5852 * </tr>
5853 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5854 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5855 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5856 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5857 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5858 * </table></td>
5859 * </tr>
5860 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5861 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5862 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5863 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5864 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5865 * </table></td>
5866 * </tr>
5867 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5868 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5869 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5870 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5871 * </table></td>
5872 * </tr>
5873 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5874 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5875 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5876 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5877 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5878 * </table></td>
5879 * </tr>
5880 * <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>
5881 * <td><table border="" style="margin:0" >
5882 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5883 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5884 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5885 * </table></td>
5886 * </tr>
5887 * </tbody>
5888 * </table>
5889 */
5890 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5891
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005892 /**
5893 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5894 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5895 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5896 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5897 * generated Intent can not cause unexpected data access to happen.
5898 *
5899 * <p>If you do not trust the source of the URI being parsed, you should still do further
5900 * processing to protect yourself from it. In particular, when using it to start an
5901 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5902 * that can handle it.</p>
5903 */
5904 public static final int URI_ALLOW_UNSAFE = 1<<2;
5905
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005906 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907
5908 private String mAction;
5909 private Uri mData;
5910 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005911 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005912 private ComponentName mComponent;
5913 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005914 private ArraySet<String> mCategories;
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005915 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005916 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005917 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005918 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005919 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005920 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005921 /** Token to track instant app launches. Local only; do not copy cross-process. */
5922 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005923
5924 // ---------------------------------------------------------------------
5925
Makoto Onuki97f82f22017-05-31 16:20:21 -07005926 private static final int COPY_MODE_ALL = 0;
5927 private static final int COPY_MODE_FILTER = 1;
5928 private static final int COPY_MODE_HISTORY = 2;
5929
5930 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07005931 @IntDef(prefix = { "COPY_MODE_" }, value = {
5932 COPY_MODE_ALL,
5933 COPY_MODE_FILTER,
5934 COPY_MODE_HISTORY
5935 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07005936 @Retention(RetentionPolicy.SOURCE)
5937 public @interface CopyMode {}
5938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005939 /**
5940 * Create an empty intent.
5941 */
5942 public Intent() {
5943 }
5944
5945 /**
5946 * Copy constructor.
5947 */
5948 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005949 this(o, COPY_MODE_ALL);
5950 }
5951
5952 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005953 this.mAction = o.mAction;
5954 this.mData = o.mData;
5955 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005956 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005957 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005958
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005959 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005960 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005961 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005962
5963 if (copyMode != COPY_MODE_FILTER) {
5964 this.mFlags = o.mFlags;
5965 this.mContentUserHint = o.mContentUserHint;
5966 this.mLaunchToken = o.mLaunchToken;
5967 if (o.mSourceBounds != null) {
5968 this.mSourceBounds = new Rect(o.mSourceBounds);
5969 }
5970 if (o.mSelector != null) {
5971 this.mSelector = new Intent(o.mSelector);
5972 }
5973
5974 if (copyMode != COPY_MODE_HISTORY) {
5975 if (o.mExtras != null) {
5976 this.mExtras = new Bundle(o.mExtras);
5977 }
5978 if (o.mClipData != null) {
5979 this.mClipData = new ClipData(o.mClipData);
5980 }
5981 } else {
5982 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5983 this.mExtras = Bundle.STRIPPED;
5984 }
5985
5986 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5987 // history.
5988 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005989 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005990 }
5991
5992 @Override
5993 public Object clone() {
5994 return new Intent(this);
5995 }
5996
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005997 /**
5998 * Make a clone of only the parts of the Intent that are relevant for
5999 * filter matching: the action, data, type, component, and categories.
6000 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006001 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07006002 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006003 }
6004
6005 /**
6006 * Create an intent with a given action. All other fields (data, type,
6007 * class) are null. Note that the action <em>must</em> be in a
6008 * namespace because Intents are used globally in the system -- for
6009 * example the system VIEW action is android.intent.action.VIEW; an
6010 * application's custom action would be something like
6011 * com.google.app.myapp.CUSTOM_ACTION.
6012 *
6013 * @param action The Intent action, such as ACTION_VIEW.
6014 */
6015 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006016 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006017 }
6018
6019 /**
6020 * Create an intent with a given action and for a given data url. Note
6021 * that the action <em>must</em> be in a namespace because Intents are
6022 * used globally in the system -- for example the system VIEW action is
6023 * android.intent.action.VIEW; an application's custom action would be
6024 * something like com.google.app.myapp.CUSTOM_ACTION.
6025 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006026 * <p><em>Note: scheme and host name matching in the Android framework is
6027 * case-sensitive, unlike the formal RFC. As a result,
6028 * you should always ensure that you write your Uri with these elements
6029 * using lower case letters, and normalize any Uris you receive from
6030 * outside of Android to ensure the scheme and host is lower case.</em></p>
6031 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006032 * @param action The Intent action, such as ACTION_VIEW.
6033 * @param uri The Intent data URI.
6034 */
6035 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006036 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006037 mData = uri;
6038 }
6039
6040 /**
6041 * Create an intent for a specific component. All other fields (action, data,
6042 * type, class) are null, though they can be modified later with explicit
6043 * calls. This provides a convenient way to create an intent that is
6044 * intended to execute a hard-coded class name, rather than relying on the
6045 * system to find an appropriate class for you; see {@link #setComponent}
6046 * for more information on the repercussions of this.
6047 *
6048 * @param packageContext A Context of the application package implementing
6049 * this class.
6050 * @param cls The component class that is to be used for the intent.
6051 *
6052 * @see #setClass
6053 * @see #setComponent
6054 * @see #Intent(String, android.net.Uri , Context, Class)
6055 */
6056 public Intent(Context packageContext, Class<?> cls) {
6057 mComponent = new ComponentName(packageContext, cls);
6058 }
6059
6060 /**
6061 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07006062 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 * construct the Intent and then calling {@link #setClass} to set its
6064 * class.
6065 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006066 * <p><em>Note: scheme and host name matching in the Android framework is
6067 * case-sensitive, unlike the formal RFC. As a result,
6068 * you should always ensure that you write your Uri with these elements
6069 * using lower case letters, and normalize any Uris you receive from
6070 * outside of Android to ensure the scheme and host is lower case.</em></p>
6071 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006072 * @param action The Intent action, such as ACTION_VIEW.
6073 * @param uri The Intent data URI.
6074 * @param packageContext A Context of the application package implementing
6075 * this class.
6076 * @param cls The component class that is to be used for the intent.
6077 *
6078 * @see #Intent(String, android.net.Uri)
6079 * @see #Intent(Context, Class)
6080 * @see #setClass
6081 * @see #setComponent
6082 */
6083 public Intent(String action, Uri uri,
6084 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006085 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006086 mData = uri;
6087 mComponent = new ComponentName(packageContext, cls);
6088 }
6089
6090 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006091 * Create an intent to launch the main (root) activity of a task. This
6092 * is the Intent that is started when the application's is launched from
6093 * Home. For anything else that wants to launch an application in the
6094 * same way, it is important that they use an Intent structured the same
6095 * way, and can use this function to ensure this is the case.
6096 *
6097 * <p>The returned Intent has the given Activity component as its explicit
6098 * component, {@link #ACTION_MAIN} as its action, and includes the
6099 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6100 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6101 * to do that through {@link #addFlags(int)} on the returned Intent.
6102 *
6103 * @param mainActivity The main activity component that this Intent will
6104 * launch.
6105 * @return Returns a newly created Intent that can be used to launch the
6106 * activity as a main application entry.
6107 *
6108 * @see #setClass
6109 * @see #setComponent
6110 */
6111 public static Intent makeMainActivity(ComponentName mainActivity) {
6112 Intent intent = new Intent(ACTION_MAIN);
6113 intent.setComponent(mainActivity);
6114 intent.addCategory(CATEGORY_LAUNCHER);
6115 return intent;
6116 }
6117
6118 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006119 * Make an Intent for the main activity of an application, without
6120 * specifying a specific activity to run but giving a selector to find
6121 * the activity. This results in a final Intent that is structured
6122 * the same as when the application is launched from
6123 * Home. For anything else that wants to launch an application in the
6124 * same way, it is important that they use an Intent structured the same
6125 * way, and can use this function to ensure this is the case.
6126 *
6127 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
6128 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
6129 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
6130 * to do that through {@link #addFlags(int)} on the returned Intent.
6131 *
6132 * @param selectorAction The action name of the Intent's selector.
6133 * @param selectorCategory The name of a category to add to the Intent's
6134 * selector.
6135 * @return Returns a newly created Intent that can be used to launch the
6136 * activity as a main application entry.
6137 *
6138 * @see #setSelector(Intent)
6139 */
6140 public static Intent makeMainSelectorActivity(String selectorAction,
6141 String selectorCategory) {
6142 Intent intent = new Intent(ACTION_MAIN);
6143 intent.addCategory(CATEGORY_LAUNCHER);
6144 Intent selector = new Intent();
6145 selector.setAction(selectorAction);
6146 selector.addCategory(selectorCategory);
6147 intent.setSelector(selector);
6148 return intent;
6149 }
6150
6151 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08006152 * Make an Intent that can be used to re-launch an application's task
6153 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
6154 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
6155 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
6156 *
6157 * @param mainActivity The activity component that is the root of the
6158 * task; this is the activity that has been published in the application's
6159 * manifest as the main launcher icon.
6160 *
6161 * @return Returns a newly created Intent that can be used to relaunch the
6162 * activity's task in its root state.
6163 */
6164 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
6165 Intent intent = makeMainActivity(mainActivity);
6166 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
6167 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
6168 return intent;
6169 }
6170
6171 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006172 * Call {@link #parseUri} with 0 flags.
6173 * @deprecated Use {@link #parseUri} instead.
6174 */
6175 @Deprecated
6176 public static Intent getIntent(String uri) throws URISyntaxException {
6177 return parseUri(uri, 0);
6178 }
Tom Taylord4a47292009-12-21 13:59:18 -08006179
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006180 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006181 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006182 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006183 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006184 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006185 *
6186 * <p>The URI given here must not be relative -- that is, it must include
6187 * the scheme and full path.
6188 *
6189 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006190 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006191 *
6192 * @return Intent The newly created Intent object.
6193 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006194 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6195 * it bad (as parsed by the Uri class) or the Intent data within the
6196 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006197 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006198 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006199 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006200 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006201 int i = 0;
6202 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006203 final boolean androidApp = uri.startsWith("android-app:");
6204
6205 // Validate intent scheme if requested.
6206 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6207 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006208 Intent intent = new Intent(ACTION_VIEW);
6209 try {
6210 intent.setData(Uri.parse(uri));
6211 } catch (IllegalArgumentException e) {
6212 throw new URISyntaxException(uri, e.getMessage());
6213 }
6214 return intent;
6215 }
6216 }
Tom Taylord4a47292009-12-21 13:59:18 -08006217
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006218 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006219 // simple case
6220 if (i == -1) {
6221 if (!androidApp) {
6222 return new Intent(ACTION_VIEW, Uri.parse(uri));
6223 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006224
6225 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006226 } else if (!uri.startsWith("#Intent;", i)) {
6227 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006228 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006229 } else {
6230 i = -1;
6231 }
6232 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006233
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006234 // new format
6235 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006236 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006237 boolean explicitAction = false;
6238 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006239
6240 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006241 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006242 String data;
6243 if (i >= 0) {
6244 data = uri.substring(0, i);
6245 i += 8; // length of "#Intent;"
6246 } else {
6247 data = uri;
6248 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006249
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006250 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006251 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006252 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006253 if (eq < 0) eq = i-1;
6254 int semi = uri.indexOf(';', i);
6255 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006256
6257 // action
6258 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006259 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006260 if (!inSelector) {
6261 explicitAction = true;
6262 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006263 }
6264
6265 // categories
6266 else if (uri.startsWith("category=", i)) {
6267 intent.addCategory(value);
6268 }
6269
6270 // type
6271 else if (uri.startsWith("type=", i)) {
6272 intent.mType = value;
6273 }
6274
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006275 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006276 else if (uri.startsWith("launchFlags=", i)) {
6277 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006278 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6279 intent.mFlags &= ~IMMUTABLE_FLAGS;
6280 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006281 }
6282
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006283 // package
6284 else if (uri.startsWith("package=", i)) {
6285 intent.mPackage = value;
6286 }
6287
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006288 // component
6289 else if (uri.startsWith("component=", i)) {
6290 intent.mComponent = ComponentName.unflattenFromString(value);
6291 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006292
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006293 // scheme
6294 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006295 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006296 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006297 } else {
6298 scheme = value;
6299 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006300 }
6301
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006302 // source bounds
6303 else if (uri.startsWith("sourceBounds=", i)) {
6304 intent.mSourceBounds = Rect.unflattenFromString(value);
6305 }
6306
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006307 // selector
6308 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6309 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006310 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006311 }
6312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006313 // extra
6314 else {
6315 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006316 // create Bundle if it doesn't already exist
6317 if (intent.mExtras == null) intent.mExtras = new Bundle();
6318 Bundle b = intent.mExtras;
6319 // add EXTRA
6320 if (uri.startsWith("S.", i)) b.putString(key, value);
6321 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6322 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6323 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6324 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6325 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6326 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6327 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6328 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6329 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6330 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006331
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006332 // move to the next item
6333 i = semi + 1;
6334 }
6335
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006336 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006337 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006338 if (baseIntent.mPackage == null) {
6339 baseIntent.setSelector(intent);
6340 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006341 intent = baseIntent;
6342 }
6343
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006344 if (data != null) {
6345 if (data.startsWith("intent:")) {
6346 data = data.substring(7);
6347 if (scheme != null) {
6348 data = scheme + ':' + data;
6349 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006350 } else if (data.startsWith("android-app:")) {
6351 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6352 // Correctly formed android-app, first part is package name.
6353 int end = data.indexOf('/', 14);
6354 if (end < 0) {
6355 // All we have is a package name.
6356 intent.mPackage = data.substring(14);
6357 if (!explicitAction) {
6358 intent.setAction(ACTION_MAIN);
6359 }
6360 data = "";
6361 } else {
6362 // Target the Intent at the given package name always.
6363 String authority = null;
6364 intent.mPackage = data.substring(14, end);
6365 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006366 if ((end+1) < data.length()) {
6367 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6368 // Found a scheme, remember it.
6369 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006370 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006371 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6372 // Found a authority, remember it.
6373 authority = data.substring(end+1, newEnd);
6374 end = newEnd;
6375 }
6376 } else {
6377 // All we have is a scheme.
6378 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006379 }
6380 }
6381 if (scheme == null) {
6382 // If there was no scheme, then this just targets the package.
6383 if (!explicitAction) {
6384 intent.setAction(ACTION_MAIN);
6385 }
6386 data = "";
6387 } else if (authority == null) {
6388 data = scheme + ":";
6389 } else {
6390 data = scheme + "://" + authority + data.substring(end);
6391 }
6392 }
6393 } else {
6394 data = "";
6395 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006396 }
Tom Taylord4a47292009-12-21 13:59:18 -08006397
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006398 if (data.length() > 0) {
6399 try {
6400 intent.mData = Uri.parse(data);
6401 } catch (IllegalArgumentException e) {
6402 throw new URISyntaxException(uri, e.getMessage());
6403 }
6404 }
6405 }
Tom Taylord4a47292009-12-21 13:59:18 -08006406
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006407 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006408
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006409 } catch (IndexOutOfBoundsException e) {
6410 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6411 }
6412 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006414 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006415 return getIntentOld(uri, 0);
6416 }
6417
6418 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006419 Intent intent;
6420
6421 int i = uri.lastIndexOf('#');
6422 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006424 final int intentFragmentStart = i;
6425 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006426
6427 i++;
6428
6429 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006430 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006431 i += 7;
6432 int j = uri.indexOf(')', i);
6433 action = uri.substring(i, j);
6434 i = j + 1;
6435 }
6436
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006437 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006438
6439 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006440 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006441 i += 11;
6442 int j = uri.indexOf(')', i);
6443 while (i < j) {
6444 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006445 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006446 if (i < sep) {
6447 intent.addCategory(uri.substring(i, sep));
6448 }
6449 i = sep + 1;
6450 }
6451 i = j + 1;
6452 }
6453
6454 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006455 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006456 i += 5;
6457 int j = uri.indexOf(')', i);
6458 intent.mType = uri.substring(i, j);
6459 i = j + 1;
6460 }
6461
6462 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006463 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 i += 12;
6465 int j = uri.indexOf(')', i);
6466 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006467 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6468 intent.mFlags &= ~IMMUTABLE_FLAGS;
6469 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006470 i = j + 1;
6471 }
6472
6473 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006474 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006475 i += 10;
6476 int j = uri.indexOf(')', i);
6477 int sep = uri.indexOf('!', i);
6478 if (sep >= 0 && sep < j) {
6479 String pkg = uri.substring(i, sep);
6480 String cls = uri.substring(sep + 1, j);
6481 intent.mComponent = new ComponentName(pkg, cls);
6482 }
6483 i = j + 1;
6484 }
6485
6486 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006487 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006488 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006489
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006490 final int closeParen = uri.indexOf(')', i);
6491 if (closeParen == -1) throw new URISyntaxException(uri,
6492 "EXTRA missing trailing ')'", i);
6493
6494 while (i < closeParen) {
6495 // fetch the key value
6496 int j = uri.indexOf('=', i);
6497 if (j <= i + 1 || i >= closeParen) {
6498 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6499 }
6500 char type = uri.charAt(i);
6501 i++;
6502 String key = uri.substring(i, j);
6503 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006505 // get type-value
6506 j = uri.indexOf('!', i);
6507 if (j == -1 || j >= closeParen) j = closeParen;
6508 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6509 String value = uri.substring(i, j);
6510 i = j;
6511
6512 // create Bundle if it doesn't already exist
6513 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006514
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006515 // add item to bundle
6516 try {
6517 switch (type) {
6518 case 'S':
6519 intent.mExtras.putString(key, Uri.decode(value));
6520 break;
6521 case 'B':
6522 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6523 break;
6524 case 'b':
6525 intent.mExtras.putByte(key, Byte.parseByte(value));
6526 break;
6527 case 'c':
6528 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6529 break;
6530 case 'd':
6531 intent.mExtras.putDouble(key, Double.parseDouble(value));
6532 break;
6533 case 'f':
6534 intent.mExtras.putFloat(key, Float.parseFloat(value));
6535 break;
6536 case 'i':
6537 intent.mExtras.putInt(key, Integer.parseInt(value));
6538 break;
6539 case 'l':
6540 intent.mExtras.putLong(key, Long.parseLong(value));
6541 break;
6542 case 's':
6543 intent.mExtras.putShort(key, Short.parseShort(value));
6544 break;
6545 default:
6546 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6547 }
6548 } catch (NumberFormatException e) {
6549 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6550 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006551
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006552 char ch = uri.charAt(i);
6553 if (ch == ')') break;
6554 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6555 i++;
6556 }
6557 }
6558
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006559 if (isIntentFragment) {
6560 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6561 } else {
6562 intent.mData = Uri.parse(uri);
6563 }
Tom Taylord4a47292009-12-21 13:59:18 -08006564
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006565 if (intent.mAction == null) {
6566 // By default, if no action is specified, then use VIEW.
6567 intent.mAction = ACTION_VIEW;
6568 }
6569
6570 } else {
6571 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6572 }
6573
6574 return intent;
6575 }
6576
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006577 /** @hide */
6578 public interface CommandOptionHandler {
6579 boolean handleOption(String opt, ShellCommand cmd);
6580 }
6581
6582 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006583 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006584 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6585 throws URISyntaxException {
6586 Intent intent = new Intent();
6587 Intent baseIntent = intent;
6588 boolean hasIntentInfo = false;
6589
6590 Uri data = null;
6591 String type = null;
6592
6593 String opt;
6594 while ((opt=cmd.getNextOption()) != null) {
6595 switch (opt) {
6596 case "-a":
6597 intent.setAction(cmd.getNextArgRequired());
6598 if (intent == baseIntent) {
6599 hasIntentInfo = true;
6600 }
6601 break;
6602 case "-d":
6603 data = Uri.parse(cmd.getNextArgRequired());
6604 if (intent == baseIntent) {
6605 hasIntentInfo = true;
6606 }
6607 break;
6608 case "-t":
6609 type = cmd.getNextArgRequired();
6610 if (intent == baseIntent) {
6611 hasIntentInfo = true;
6612 }
6613 break;
6614 case "-c":
6615 intent.addCategory(cmd.getNextArgRequired());
6616 if (intent == baseIntent) {
6617 hasIntentInfo = true;
6618 }
6619 break;
6620 case "-e":
6621 case "--es": {
6622 String key = cmd.getNextArgRequired();
6623 String value = cmd.getNextArgRequired();
6624 intent.putExtra(key, value);
6625 }
6626 break;
6627 case "--esn": {
6628 String key = cmd.getNextArgRequired();
6629 intent.putExtra(key, (String) null);
6630 }
6631 break;
6632 case "--ei": {
6633 String key = cmd.getNextArgRequired();
6634 String value = cmd.getNextArgRequired();
6635 intent.putExtra(key, Integer.decode(value));
6636 }
6637 break;
6638 case "--eu": {
6639 String key = cmd.getNextArgRequired();
6640 String value = cmd.getNextArgRequired();
6641 intent.putExtra(key, Uri.parse(value));
6642 }
6643 break;
6644 case "--ecn": {
6645 String key = cmd.getNextArgRequired();
6646 String value = cmd.getNextArgRequired();
6647 ComponentName cn = ComponentName.unflattenFromString(value);
6648 if (cn == null)
6649 throw new IllegalArgumentException("Bad component name: " + value);
6650 intent.putExtra(key, cn);
6651 }
6652 break;
6653 case "--eia": {
6654 String key = cmd.getNextArgRequired();
6655 String value = cmd.getNextArgRequired();
6656 String[] strings = value.split(",");
6657 int[] list = new int[strings.length];
6658 for (int i = 0; i < strings.length; i++) {
6659 list[i] = Integer.decode(strings[i]);
6660 }
6661 intent.putExtra(key, list);
6662 }
6663 break;
6664 case "--eial": {
6665 String key = cmd.getNextArgRequired();
6666 String value = cmd.getNextArgRequired();
6667 String[] strings = value.split(",");
6668 ArrayList<Integer> list = new ArrayList<>(strings.length);
6669 for (int i = 0; i < strings.length; i++) {
6670 list.add(Integer.decode(strings[i]));
6671 }
6672 intent.putExtra(key, list);
6673 }
6674 break;
6675 case "--el": {
6676 String key = cmd.getNextArgRequired();
6677 String value = cmd.getNextArgRequired();
6678 intent.putExtra(key, Long.valueOf(value));
6679 }
6680 break;
6681 case "--ela": {
6682 String key = cmd.getNextArgRequired();
6683 String value = cmd.getNextArgRequired();
6684 String[] strings = value.split(",");
6685 long[] list = new long[strings.length];
6686 for (int i = 0; i < strings.length; i++) {
6687 list[i] = Long.valueOf(strings[i]);
6688 }
6689 intent.putExtra(key, list);
6690 hasIntentInfo = true;
6691 }
6692 break;
6693 case "--elal": {
6694 String key = cmd.getNextArgRequired();
6695 String value = cmd.getNextArgRequired();
6696 String[] strings = value.split(",");
6697 ArrayList<Long> list = new ArrayList<>(strings.length);
6698 for (int i = 0; i < strings.length; i++) {
6699 list.add(Long.valueOf(strings[i]));
6700 }
6701 intent.putExtra(key, list);
6702 hasIntentInfo = true;
6703 }
6704 break;
6705 case "--ef": {
6706 String key = cmd.getNextArgRequired();
6707 String value = cmd.getNextArgRequired();
6708 intent.putExtra(key, Float.valueOf(value));
6709 hasIntentInfo = true;
6710 }
6711 break;
6712 case "--efa": {
6713 String key = cmd.getNextArgRequired();
6714 String value = cmd.getNextArgRequired();
6715 String[] strings = value.split(",");
6716 float[] list = new float[strings.length];
6717 for (int i = 0; i < strings.length; i++) {
6718 list[i] = Float.valueOf(strings[i]);
6719 }
6720 intent.putExtra(key, list);
6721 hasIntentInfo = true;
6722 }
6723 break;
6724 case "--efal": {
6725 String key = cmd.getNextArgRequired();
6726 String value = cmd.getNextArgRequired();
6727 String[] strings = value.split(",");
6728 ArrayList<Float> list = new ArrayList<>(strings.length);
6729 for (int i = 0; i < strings.length; i++) {
6730 list.add(Float.valueOf(strings[i]));
6731 }
6732 intent.putExtra(key, list);
6733 hasIntentInfo = true;
6734 }
6735 break;
6736 case "--esa": {
6737 String key = cmd.getNextArgRequired();
6738 String value = cmd.getNextArgRequired();
6739 // Split on commas unless they are preceeded by an escape.
6740 // The escape character must be escaped for the string and
6741 // again for the regex, thus four escape characters become one.
6742 String[] strings = value.split("(?<!\\\\),");
6743 intent.putExtra(key, strings);
6744 hasIntentInfo = true;
6745 }
6746 break;
6747 case "--esal": {
6748 String key = cmd.getNextArgRequired();
6749 String value = cmd.getNextArgRequired();
6750 // Split on commas unless they are preceeded by an escape.
6751 // The escape character must be escaped for the string and
6752 // again for the regex, thus four escape characters become one.
6753 String[] strings = value.split("(?<!\\\\),");
6754 ArrayList<String> list = new ArrayList<>(strings.length);
6755 for (int i = 0; i < strings.length; i++) {
6756 list.add(strings[i]);
6757 }
6758 intent.putExtra(key, list);
6759 hasIntentInfo = true;
6760 }
6761 break;
6762 case "--ez": {
6763 String key = cmd.getNextArgRequired();
6764 String value = cmd.getNextArgRequired().toLowerCase();
6765 // Boolean.valueOf() results in false for anything that is not "true", which is
6766 // error-prone in shell commands
6767 boolean arg;
6768 if ("true".equals(value) || "t".equals(value)) {
6769 arg = true;
6770 } else if ("false".equals(value) || "f".equals(value)) {
6771 arg = false;
6772 } else {
6773 try {
6774 arg = Integer.decode(value) != 0;
6775 } catch (NumberFormatException ex) {
6776 throw new IllegalArgumentException("Invalid boolean value: " + value);
6777 }
6778 }
6779
6780 intent.putExtra(key, arg);
6781 }
6782 break;
6783 case "-n": {
6784 String str = cmd.getNextArgRequired();
6785 ComponentName cn = ComponentName.unflattenFromString(str);
6786 if (cn == null)
6787 throw new IllegalArgumentException("Bad component name: " + str);
6788 intent.setComponent(cn);
6789 if (intent == baseIntent) {
6790 hasIntentInfo = true;
6791 }
6792 }
6793 break;
6794 case "-p": {
6795 String str = cmd.getNextArgRequired();
6796 intent.setPackage(str);
6797 if (intent == baseIntent) {
6798 hasIntentInfo = true;
6799 }
6800 }
6801 break;
6802 case "-f":
6803 String str = cmd.getNextArgRequired();
6804 intent.setFlags(Integer.decode(str).intValue());
6805 break;
6806 case "--grant-read-uri-permission":
6807 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6808 break;
6809 case "--grant-write-uri-permission":
6810 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6811 break;
6812 case "--grant-persistable-uri-permission":
6813 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6814 break;
6815 case "--grant-prefix-uri-permission":
6816 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6817 break;
6818 case "--exclude-stopped-packages":
6819 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6820 break;
6821 case "--include-stopped-packages":
6822 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6823 break;
6824 case "--debug-log-resolution":
6825 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6826 break;
6827 case "--activity-brought-to-front":
6828 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6829 break;
6830 case "--activity-clear-top":
6831 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6832 break;
6833 case "--activity-clear-when-task-reset":
6834 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6835 break;
6836 case "--activity-exclude-from-recents":
6837 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6838 break;
6839 case "--activity-launched-from-history":
6840 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6841 break;
6842 case "--activity-multiple-task":
6843 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6844 break;
6845 case "--activity-no-animation":
6846 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6847 break;
6848 case "--activity-no-history":
6849 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6850 break;
6851 case "--activity-no-user-action":
6852 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6853 break;
6854 case "--activity-previous-is-top":
6855 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6856 break;
6857 case "--activity-reorder-to-front":
6858 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6859 break;
6860 case "--activity-reset-task-if-needed":
6861 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6862 break;
6863 case "--activity-single-top":
6864 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6865 break;
6866 case "--activity-clear-task":
6867 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6868 break;
6869 case "--activity-task-on-home":
6870 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6871 break;
Patrick Baumann229141f2018-04-06 13:53:25 -07006872 case "--activity-match-external":
6873 intent.addFlags(Intent.FLAG_ACTIVITY_MATCH_EXTERNAL);
6874 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006875 case "--receiver-registered-only":
6876 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6877 break;
6878 case "--receiver-replace-pending":
6879 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6880 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006881 case "--receiver-foreground":
6882 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6883 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006884 case "--receiver-no-abort":
6885 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6886 break;
6887 case "--receiver-include-background":
6888 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6889 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006890 case "--selector":
6891 intent.setDataAndType(data, type);
6892 intent = new Intent();
6893 break;
6894 default:
6895 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6896 // Okay, caller handled this option.
6897 } else {
6898 throw new IllegalArgumentException("Unknown option: " + opt);
6899 }
6900 break;
6901 }
6902 }
6903 intent.setDataAndType(data, type);
6904
6905 final boolean hasSelector = intent != baseIntent;
6906 if (hasSelector) {
6907 // A selector was specified; fix up.
6908 baseIntent.setSelector(intent);
6909 intent = baseIntent;
6910 }
6911
6912 String arg = cmd.getNextArg();
6913 baseIntent = null;
6914 if (arg == null) {
6915 if (hasSelector) {
6916 // If a selector has been specified, and no arguments
6917 // have been supplied for the main Intent, then we can
6918 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6919 // need to have a component name specified yet, the
6920 // selector will take care of that.
6921 baseIntent = new Intent(Intent.ACTION_MAIN);
6922 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6923 }
6924 } else if (arg.indexOf(':') >= 0) {
6925 // The argument is a URI. Fully parse it, and use that result
6926 // to fill in any data not specified so far.
6927 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6928 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6929 } else if (arg.indexOf('/') >= 0) {
6930 // The argument is a component name. Build an Intent to launch
6931 // it.
6932 baseIntent = new Intent(Intent.ACTION_MAIN);
6933 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6934 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6935 } else {
6936 // Assume the argument is a package name.
6937 baseIntent = new Intent(Intent.ACTION_MAIN);
6938 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6939 baseIntent.setPackage(arg);
6940 }
6941 if (baseIntent != null) {
6942 Bundle extras = intent.getExtras();
6943 intent.replaceExtras((Bundle)null);
6944 Bundle uriExtras = baseIntent.getExtras();
6945 baseIntent.replaceExtras((Bundle)null);
6946 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6947 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6948 for (String c : cats) {
6949 baseIntent.removeCategory(c);
6950 }
6951 }
6952 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6953 if (extras == null) {
6954 extras = uriExtras;
6955 } else if (uriExtras != null) {
6956 uriExtras.putAll(extras);
6957 extras = uriExtras;
6958 }
6959 intent.replaceExtras(extras);
6960 hasIntentInfo = true;
6961 }
6962
6963 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6964 return intent;
6965 }
6966
6967 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01006968 @UnsupportedAppUsage
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006969 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6970 final String[] lines = new String[] {
6971 "<INTENT> specifications include these flags and arguments:",
6972 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6973 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
Felipe Leme4e02e252018-04-20 11:25:59 -07006974 " [-n <COMPONENT_NAME>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006975 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6976 " [--esn <EXTRA_KEY> ...]",
6977 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6978 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6979 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6980 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6981 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6982 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6983 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6984 " (mutiple extras passed as Integer[])",
6985 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6986 " (mutiple extras passed as List<Integer>)",
6987 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6988 " (mutiple extras passed as Long[])",
6989 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6990 " (mutiple extras passed as List<Long>)",
6991 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6992 " (mutiple extras passed as Float[])",
6993 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6994 " (mutiple extras passed as List<Float>)",
6995 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6996 " (mutiple extras passed as String[]; to embed a comma into a string,",
6997 " escape it using \"\\,\")",
6998 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6999 " (mutiple extras passed as List<String>; to embed a comma into a string,",
7000 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08007001 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007002 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
7003 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
7004 " [--debug-log-resolution] [--exclude-stopped-packages]",
7005 " [--include-stopped-packages]",
7006 " [--activity-brought-to-front] [--activity-clear-top]",
7007 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
7008 " [--activity-launched-from-history] [--activity-multiple-task]",
7009 " [--activity-no-animation] [--activity-no-history]",
7010 " [--activity-no-user-action] [--activity-previous-is-top]",
7011 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
7012 " [--activity-single-top] [--activity-clear-task]",
Patrick Baumann229141f2018-04-06 13:53:25 -07007013 " [--activity-task-on-home] [--activity-match-external]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007014 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08007015 " [--receiver-foreground] [--receiver-no-abort]",
7016 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08007017 " [--selector]",
7018 " [<URI> | <PACKAGE> | <COMPONENT>]"
7019 };
7020 for (String line : lines) {
7021 pw.print(prefix);
7022 pw.println(line);
7023 }
7024 }
7025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007026 /**
7027 * Retrieve the general action to be performed, such as
7028 * {@link #ACTION_VIEW}. The action describes the general way the rest of
7029 * the information in the intent should be interpreted -- most importantly,
7030 * what to do with the data returned by {@link #getData}.
7031 *
7032 * @return The action of this intent or null if none is specified.
7033 *
7034 * @see #setAction
7035 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007036 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007037 return mAction;
7038 }
7039
7040 /**
7041 * Retrieve data this intent is operating on. This URI specifies the name
7042 * of the data; often it uses the content: scheme, specifying data in a
7043 * content provider. Other schemes may be handled by specific activities,
7044 * such as http: by the web browser.
7045 *
7046 * @return The URI of the data this intent is targeting or null.
7047 *
7048 * @see #getScheme
7049 * @see #setData
7050 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007051 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007052 return mData;
7053 }
7054
7055 /**
7056 * The same as {@link #getData()}, but returns the URI as an encoded
7057 * String.
7058 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007059 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007060 return mData != null ? mData.toString() : null;
7061 }
7062
7063 /**
7064 * Return the scheme portion of the intent's data. If the data is null or
7065 * does not include a scheme, null is returned. Otherwise, the scheme
7066 * prefix without the final ':' is returned, i.e. "http".
7067 *
7068 * <p>This is the same as calling getData().getScheme() (and checking for
7069 * null data).
7070 *
7071 * @return The scheme of this intent.
7072 *
7073 * @see #getData
7074 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007075 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007076 return mData != null ? mData.getScheme() : null;
7077 }
7078
7079 /**
7080 * Retrieve any explicit MIME type included in the intent. This is usually
7081 * null, as the type is determined by the intent data.
7082 *
7083 * @return If a type was manually set, it is returned; else null is
7084 * returned.
7085 *
7086 * @see #resolveType(ContentResolver)
7087 * @see #setType
7088 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007089 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007090 return mType;
7091 }
7092
7093 /**
7094 * Return the MIME data type of this intent. If the type field is
7095 * explicitly set, that is simply returned. Otherwise, if the data is set,
7096 * the type of that data is returned. If neither fields are set, a null is
7097 * returned.
7098 *
7099 * @return The MIME type of this intent.
7100 *
7101 * @see #getType
7102 * @see #resolveType(ContentResolver)
7103 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007104 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007105 return resolveType(context.getContentResolver());
7106 }
7107
7108 /**
7109 * Return the MIME data type of this intent. If the type field is
7110 * explicitly set, that is simply returned. Otherwise, if the data is set,
7111 * the type of that data is returned. If neither fields are set, a null is
7112 * returned.
7113 *
7114 * @param resolver A ContentResolver that can be used to determine the MIME
7115 * type of the intent's data.
7116 *
7117 * @return The MIME type of this intent.
7118 *
7119 * @see #getType
7120 * @see #resolveType(Context)
7121 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007122 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007123 if (mType != null) {
7124 return mType;
7125 }
7126 if (mData != null) {
7127 if ("content".equals(mData.getScheme())) {
7128 return resolver.getType(mData);
7129 }
7130 }
7131 return null;
7132 }
7133
7134 /**
7135 * Return the MIME data type of this intent, only if it will be needed for
7136 * intent resolution. This is not generally useful for application code;
7137 * it is used by the frameworks for communicating with back-end system
7138 * services.
7139 *
7140 * @param resolver A ContentResolver that can be used to determine the MIME
7141 * type of the intent's data.
7142 *
7143 * @return The MIME type of this intent, or null if it is unknown or not
7144 * needed.
7145 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007146 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007147 if (mComponent != null) {
7148 return mType;
7149 }
7150 return resolveType(resolver);
7151 }
7152
7153 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007154 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007155 *
7156 * @param category The category to check.
7157 *
7158 * @return boolean True if the intent contains the category, else false.
7159 *
7160 * @see #getCategories
7161 * @see #addCategory
7162 */
7163 public boolean hasCategory(String category) {
7164 return mCategories != null && mCategories.contains(category);
7165 }
7166
7167 /**
7168 * Return the set of all categories in the intent. If there are no categories,
7169 * returns NULL.
7170 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007171 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007172 *
7173 * @see #hasCategory
7174 * @see #addCategory
7175 */
7176 public Set<String> getCategories() {
7177 return mCategories;
7178 }
7179
7180 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007181 * Return the specific selector associated with this Intent. If there is
7182 * none, returns null. See {@link #setSelector} for more information.
7183 *
7184 * @see #setSelector
7185 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007186 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007187 return mSelector;
7188 }
7189
7190 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007191 * Return the {@link ClipData} associated with this Intent. If there is
7192 * none, returns null. See {@link #setClipData} for more information.
7193 *
John Spurlock125d1332013-11-25 11:58:37 -05007194 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007195 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007196 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007197 return mClipData;
7198 }
7199
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007200 /** @hide */
7201 public int getContentUserHint() {
7202 return mContentUserHint;
7203 }
7204
Todd Kennedyb3b431302017-03-20 16:05:48 -07007205 /** @hide */
7206 public String getLaunchToken() {
7207 return mLaunchToken;
7208 }
7209
7210 /** @hide */
7211 public void setLaunchToken(String launchToken) {
7212 mLaunchToken = launchToken;
7213 }
7214
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007215 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007216 * Sets the ClassLoader that will be used when unmarshalling
7217 * any Parcelable values from the extras of this Intent.
7218 *
7219 * @param loader a ClassLoader, or null to use the default loader
7220 * at the time of unmarshalling.
7221 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007222 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007223 if (mExtras != null) {
7224 mExtras.setClassLoader(loader);
7225 }
7226 }
7227
7228 /**
7229 * Returns true if an extra value is associated with the given name.
7230 * @param name the extra's name
7231 * @return true if the given extra is present.
7232 */
7233 public boolean hasExtra(String name) {
7234 return mExtras != null && mExtras.containsKey(name);
7235 }
7236
7237 /**
7238 * Returns true if the Intent's extras contain a parcelled file descriptor.
7239 * @return true if the Intent contains a parcelled file descriptor.
7240 */
7241 public boolean hasFileDescriptors() {
7242 return mExtras != null && mExtras.hasFileDescriptors();
7243 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007244
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007245 /** {@hide} */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007246 @UnsupportedAppUsage
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007247 public void setAllowFds(boolean allowFds) {
7248 if (mExtras != null) {
7249 mExtras.setAllowFds(allowFds);
7250 }
7251 }
7252
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007253 /** {@hide} */
7254 public void setDefusable(boolean defusable) {
7255 if (mExtras != null) {
7256 mExtras.setDefusable(defusable);
7257 }
7258 }
7259
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007260 /**
7261 * Retrieve extended data from the intent.
7262 *
7263 * @param name The name of the desired item.
7264 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007265 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007266 * or null if none was found.
7267 *
7268 * @deprecated
7269 * @hide
7270 */
7271 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007272 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007273 public Object getExtra(String name) {
7274 return getExtra(name, null);
7275 }
7276
7277 /**
7278 * Retrieve extended data from the intent.
7279 *
7280 * @param name The name of the desired item.
7281 * @param defaultValue the value to be returned if no value of the desired
7282 * type is stored with the given name.
7283 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007284 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007285 * or the default value if none was found.
7286 *
7287 * @see #putExtra(String, boolean)
7288 */
7289 public boolean getBooleanExtra(String name, boolean defaultValue) {
7290 return mExtras == null ? defaultValue :
7291 mExtras.getBoolean(name, defaultValue);
7292 }
7293
7294 /**
7295 * Retrieve extended data from the intent.
7296 *
7297 * @param name The name of the desired item.
7298 * @param defaultValue the value to be returned if no value of the desired
7299 * type is stored with the given name.
7300 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007301 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007302 * or the default value if none was found.
7303 *
7304 * @see #putExtra(String, byte)
7305 */
7306 public byte getByteExtra(String name, byte defaultValue) {
7307 return mExtras == null ? defaultValue :
7308 mExtras.getByte(name, defaultValue);
7309 }
7310
7311 /**
7312 * Retrieve extended data from the intent.
7313 *
7314 * @param name The name of the desired item.
7315 * @param defaultValue the value to be returned if no value of the desired
7316 * type is stored with the given name.
7317 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007318 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007319 * or the default value if none was found.
7320 *
7321 * @see #putExtra(String, short)
7322 */
7323 public short getShortExtra(String name, short defaultValue) {
7324 return mExtras == null ? defaultValue :
7325 mExtras.getShort(name, defaultValue);
7326 }
7327
7328 /**
7329 * Retrieve extended data from the intent.
7330 *
7331 * @param name The name of the desired item.
7332 * @param defaultValue the value to be returned if no value of the desired
7333 * type is stored with the given name.
7334 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007335 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007336 * or the default value if none was found.
7337 *
7338 * @see #putExtra(String, char)
7339 */
7340 public char getCharExtra(String name, char defaultValue) {
7341 return mExtras == null ? defaultValue :
7342 mExtras.getChar(name, defaultValue);
7343 }
7344
7345 /**
7346 * Retrieve extended data from the intent.
7347 *
7348 * @param name The name of the desired item.
7349 * @param defaultValue the value to be returned if no value of the desired
7350 * type is stored with the given name.
7351 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007352 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007353 * or the default value if none was found.
7354 *
7355 * @see #putExtra(String, int)
7356 */
7357 public int getIntExtra(String name, int defaultValue) {
7358 return mExtras == null ? defaultValue :
7359 mExtras.getInt(name, defaultValue);
7360 }
7361
7362 /**
7363 * Retrieve extended data from the intent.
7364 *
7365 * @param name The name of the desired item.
7366 * @param defaultValue the value to be returned if no value of the desired
7367 * type is stored with the given name.
7368 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007369 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007370 * or the default value if none was found.
7371 *
7372 * @see #putExtra(String, long)
7373 */
7374 public long getLongExtra(String name, long defaultValue) {
7375 return mExtras == null ? defaultValue :
7376 mExtras.getLong(name, defaultValue);
7377 }
7378
7379 /**
7380 * Retrieve extended data from the intent.
7381 *
7382 * @param name The name of the desired item.
7383 * @param defaultValue the value to be returned if no value of the desired
7384 * type is stored with the given name.
7385 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007386 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007387 * or the default value if no such item is present
7388 *
7389 * @see #putExtra(String, float)
7390 */
7391 public float getFloatExtra(String name, float defaultValue) {
7392 return mExtras == null ? defaultValue :
7393 mExtras.getFloat(name, defaultValue);
7394 }
7395
7396 /**
7397 * Retrieve extended data from the intent.
7398 *
7399 * @param name The name of the desired item.
7400 * @param defaultValue the value to be returned if no value of the desired
7401 * type is stored with the given name.
7402 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007403 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007404 * or the default value if none was found.
7405 *
7406 * @see #putExtra(String, double)
7407 */
7408 public double getDoubleExtra(String name, double defaultValue) {
7409 return mExtras == null ? defaultValue :
7410 mExtras.getDouble(name, defaultValue);
7411 }
7412
7413 /**
7414 * Retrieve extended data from the intent.
7415 *
7416 * @param name The name of the desired item.
7417 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007418 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007419 * or null if no String value was found.
7420 *
7421 * @see #putExtra(String, String)
7422 */
7423 public String getStringExtra(String name) {
7424 return mExtras == null ? null : mExtras.getString(name);
7425 }
7426
7427 /**
7428 * Retrieve extended data from the intent.
7429 *
7430 * @param name The name of the desired item.
7431 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007432 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007433 * or null if no CharSequence value was found.
7434 *
7435 * @see #putExtra(String, CharSequence)
7436 */
7437 public CharSequence getCharSequenceExtra(String name) {
7438 return mExtras == null ? null : mExtras.getCharSequence(name);
7439 }
7440
7441 /**
7442 * Retrieve extended data from the intent.
7443 *
7444 * @param name The name of the desired item.
7445 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007446 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007447 * or null if no Parcelable value was found.
7448 *
7449 * @see #putExtra(String, Parcelable)
7450 */
7451 public <T extends Parcelable> T getParcelableExtra(String name) {
7452 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7453 }
7454
7455 /**
7456 * Retrieve extended data from the intent.
7457 *
7458 * @param name The name of the desired item.
7459 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007460 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007461 * or null if no Parcelable[] value was found.
7462 *
7463 * @see #putExtra(String, Parcelable[])
7464 */
7465 public Parcelable[] getParcelableArrayExtra(String name) {
7466 return mExtras == null ? null : mExtras.getParcelableArray(name);
7467 }
7468
7469 /**
7470 * Retrieve extended data from the intent.
7471 *
7472 * @param name The name of the desired item.
7473 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007474 * @return the value of an item previously added with
7475 * putParcelableArrayListExtra(), or null if no
7476 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007477 *
7478 * @see #putParcelableArrayListExtra(String, ArrayList)
7479 */
7480 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7481 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7482 }
7483
7484 /**
7485 * Retrieve extended data from the intent.
7486 *
7487 * @param name The name of the desired item.
7488 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007489 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007490 * or null if no Serializable value was found.
7491 *
7492 * @see #putExtra(String, Serializable)
7493 */
7494 public Serializable getSerializableExtra(String name) {
7495 return mExtras == null ? null : mExtras.getSerializable(name);
7496 }
7497
7498 /**
7499 * Retrieve extended data from the intent.
7500 *
7501 * @param name The name of the desired item.
7502 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007503 * @return the value of an item previously added with
7504 * putIntegerArrayListExtra(), or null if no
7505 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007506 *
7507 * @see #putIntegerArrayListExtra(String, ArrayList)
7508 */
7509 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7510 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7511 }
7512
7513 /**
7514 * Retrieve extended data from the intent.
7515 *
7516 * @param name The name of the desired item.
7517 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007518 * @return the value of an item previously added with
7519 * putStringArrayListExtra(), or null if no
7520 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007521 *
7522 * @see #putStringArrayListExtra(String, ArrayList)
7523 */
7524 public ArrayList<String> getStringArrayListExtra(String name) {
7525 return mExtras == null ? null : mExtras.getStringArrayList(name);
7526 }
7527
7528 /**
7529 * Retrieve extended data from the intent.
7530 *
7531 * @param name The name of the desired item.
7532 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007533 * @return the value of an item previously added with
7534 * putCharSequenceArrayListExtra, or null if no
7535 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007536 *
7537 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7538 */
7539 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7540 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7541 }
7542
7543 /**
7544 * Retrieve extended data from the intent.
7545 *
7546 * @param name The name of the desired item.
7547 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007548 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007549 * or null if no boolean array value was found.
7550 *
7551 * @see #putExtra(String, boolean[])
7552 */
7553 public boolean[] getBooleanArrayExtra(String name) {
7554 return mExtras == null ? null : mExtras.getBooleanArray(name);
7555 }
7556
7557 /**
7558 * Retrieve extended data from the intent.
7559 *
7560 * @param name The name of the desired item.
7561 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007562 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007563 * or null if no byte array value was found.
7564 *
7565 * @see #putExtra(String, byte[])
7566 */
7567 public byte[] getByteArrayExtra(String name) {
7568 return mExtras == null ? null : mExtras.getByteArray(name);
7569 }
7570
7571 /**
7572 * Retrieve extended data from the intent.
7573 *
7574 * @param name The name of the desired item.
7575 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007576 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007577 * or null if no short array value was found.
7578 *
7579 * @see #putExtra(String, short[])
7580 */
7581 public short[] getShortArrayExtra(String name) {
7582 return mExtras == null ? null : mExtras.getShortArray(name);
7583 }
7584
7585 /**
7586 * Retrieve extended data from the intent.
7587 *
7588 * @param name The name of the desired item.
7589 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007590 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007591 * or null if no char array value was found.
7592 *
7593 * @see #putExtra(String, char[])
7594 */
7595 public char[] getCharArrayExtra(String name) {
7596 return mExtras == null ? null : mExtras.getCharArray(name);
7597 }
7598
7599 /**
7600 * Retrieve extended data from the intent.
7601 *
7602 * @param name The name of the desired item.
7603 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007604 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007605 * or null if no int array value was found.
7606 *
7607 * @see #putExtra(String, int[])
7608 */
7609 public int[] getIntArrayExtra(String name) {
7610 return mExtras == null ? null : mExtras.getIntArray(name);
7611 }
7612
7613 /**
7614 * Retrieve extended data from the intent.
7615 *
7616 * @param name The name of the desired item.
7617 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007618 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007619 * or null if no long array value was found.
7620 *
7621 * @see #putExtra(String, long[])
7622 */
7623 public long[] getLongArrayExtra(String name) {
7624 return mExtras == null ? null : mExtras.getLongArray(name);
7625 }
7626
7627 /**
7628 * Retrieve extended data from the intent.
7629 *
7630 * @param name The name of the desired item.
7631 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007632 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007633 * or null if no float array value was found.
7634 *
7635 * @see #putExtra(String, float[])
7636 */
7637 public float[] getFloatArrayExtra(String name) {
7638 return mExtras == null ? null : mExtras.getFloatArray(name);
7639 }
7640
7641 /**
7642 * Retrieve extended data from the intent.
7643 *
7644 * @param name The name of the desired item.
7645 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007646 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007647 * or null if no double array value was found.
7648 *
7649 * @see #putExtra(String, double[])
7650 */
7651 public double[] getDoubleArrayExtra(String name) {
7652 return mExtras == null ? null : mExtras.getDoubleArray(name);
7653 }
7654
7655 /**
7656 * Retrieve extended data from the intent.
7657 *
7658 * @param name The name of the desired item.
7659 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007660 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007661 * or null if no String array value was found.
7662 *
7663 * @see #putExtra(String, String[])
7664 */
7665 public String[] getStringArrayExtra(String name) {
7666 return mExtras == null ? null : mExtras.getStringArray(name);
7667 }
7668
7669 /**
7670 * Retrieve extended data from the intent.
7671 *
7672 * @param name The name of the desired item.
7673 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007674 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007675 * or null if no CharSequence array value was found.
7676 *
7677 * @see #putExtra(String, CharSequence[])
7678 */
7679 public CharSequence[] getCharSequenceArrayExtra(String name) {
7680 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7681 }
7682
7683 /**
7684 * Retrieve extended data from the intent.
7685 *
7686 * @param name The name of the desired item.
7687 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007688 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007689 * or null if no Bundle value was found.
7690 *
7691 * @see #putExtra(String, Bundle)
7692 */
7693 public Bundle getBundleExtra(String name) {
7694 return mExtras == null ? null : mExtras.getBundle(name);
7695 }
7696
7697 /**
7698 * Retrieve extended data from the intent.
7699 *
7700 * @param name The name of the desired item.
7701 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007702 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007703 * or null if no IBinder value was found.
7704 *
7705 * @see #putExtra(String, IBinder)
7706 *
7707 * @deprecated
7708 * @hide
7709 */
7710 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007711 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007712 public IBinder getIBinderExtra(String name) {
7713 return mExtras == null ? null : mExtras.getIBinder(name);
7714 }
7715
7716 /**
7717 * Retrieve extended data from the intent.
7718 *
7719 * @param name The name of the desired item.
7720 * @param defaultValue The default value to return in case no item is
7721 * associated with the key 'name'
7722 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007723 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007724 * or defaultValue if none was found.
7725 *
7726 * @see #putExtra
7727 *
7728 * @deprecated
7729 * @hide
7730 */
7731 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007732 @UnsupportedAppUsage
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007733 public Object getExtra(String name, Object defaultValue) {
7734 Object result = defaultValue;
7735 if (mExtras != null) {
7736 Object result2 = mExtras.get(name);
7737 if (result2 != null) {
7738 result = result2;
7739 }
7740 }
7741
7742 return result;
7743 }
7744
7745 /**
7746 * Retrieves a map of extended data from the intent.
7747 *
7748 * @return the map of all extras previously added with putExtra(),
7749 * or null if none have been added.
7750 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007751 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007752 return (mExtras != null)
7753 ? new Bundle(mExtras)
7754 : null;
7755 }
7756
7757 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007758 * Filter extras to only basic types.
7759 * @hide
7760 */
7761 public void removeUnsafeExtras() {
7762 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007763 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007764 }
7765 }
7766
7767 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007768 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7769 * return itself as-is.
7770 * @hide
7771 */
7772 public boolean canStripForHistory() {
7773 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7774 }
7775
7776 /**
7777 * Call it when the system needs to keep an intent for logging purposes to remove fields
7778 * that are not needed for logging.
7779 * @hide
7780 */
7781 public Intent maybeStripForHistory() {
7782 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7783
7784 if (!canStripForHistory()) {
7785 return this;
7786 }
7787 return new Intent(this, COPY_MODE_HISTORY);
7788 }
7789
7790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007791 * Retrieve any special flags associated with this intent. You will
7792 * normally just set them with {@link #setFlags} and let the system
7793 * take the appropriate action with them.
7794 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007795 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007796 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007797 * @see #addFlags
7798 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007799 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007800 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007801 return mFlags;
7802 }
7803
Dianne Hackborne7f97212011-02-24 14:40:20 -08007804 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007805 @UnsupportedAppUsage
Dianne Hackborne7f97212011-02-24 14:40:20 -08007806 public boolean isExcludingStopped() {
7807 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7808 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7809 }
7810
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007811 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007812 * Retrieve the application package name this Intent is limited to. When
7813 * resolving an Intent, if non-null this limits the resolution to only
7814 * components in the given application package.
7815 *
7816 * @return The name of the application package for the Intent.
7817 *
7818 * @see #resolveActivity
7819 * @see #setPackage
7820 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007821 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007822 return mPackage;
7823 }
7824
7825 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007826 * Retrieve the concrete component associated with the intent. When receiving
7827 * an intent, this is the component that was found to best handle it (that is,
7828 * yourself) and will always be non-null; in all other cases it will be
7829 * null unless explicitly set.
7830 *
7831 * @return The name of the application component to handle the intent.
7832 *
7833 * @see #resolveActivity
7834 * @see #setComponent
7835 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007836 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007837 return mComponent;
7838 }
7839
7840 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007841 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7842 * used as a hint to the receiver for animations and the like. Null means that there
7843 * is no source bounds.
7844 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007845 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007846 return mSourceBounds;
7847 }
7848
7849 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007850 * Return the Activity component that should be used to handle this intent.
7851 * The appropriate component is determined based on the information in the
7852 * intent, evaluated as follows:
7853 *
7854 * <p>If {@link #getComponent} returns an explicit class, that is returned
7855 * without any further consideration.
7856 *
7857 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7858 * category to be considered.
7859 *
7860 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7861 * action.
7862 *
7863 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7864 * this type.
7865 *
7866 * <p>If {@link #addCategory} has added any categories, the activity must
7867 * handle ALL of the categories specified.
7868 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007869 * <p>If {@link #getPackage} is non-NULL, only activity components in
7870 * that application package will be considered.
7871 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007872 * <p>If there are no activities that satisfy all of these conditions, a
7873 * null string is returned.
7874 *
7875 * <p>If multiple activities are found to satisfy the intent, the one with
7876 * the highest priority will be used. If there are multiple activities
7877 * with the same priority, the system will either pick the best activity
7878 * based on user preference, or resolve to a system class that will allow
7879 * the user to pick an activity and forward from there.
7880 *
7881 * <p>This method is implemented simply by calling
7882 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7883 * true.</p>
7884 * <p> This API is called for you as part of starting an activity from an
7885 * intent. You do not normally need to call it yourself.</p>
7886 *
7887 * @param pm The package manager with which to resolve the Intent.
7888 *
7889 * @return Name of the component implementing an activity that can
7890 * display the intent.
7891 *
7892 * @see #setComponent
7893 * @see #getComponent
7894 * @see #resolveActivityInfo
7895 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007896 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007897 if (mComponent != null) {
7898 return mComponent;
7899 }
7900
7901 ResolveInfo info = pm.resolveActivity(
7902 this, PackageManager.MATCH_DEFAULT_ONLY);
7903 if (info != null) {
7904 return new ComponentName(
7905 info.activityInfo.applicationInfo.packageName,
7906 info.activityInfo.name);
7907 }
7908
7909 return null;
7910 }
7911
7912 /**
7913 * Resolve the Intent into an {@link ActivityInfo}
7914 * describing the activity that should execute the intent. Resolution
7915 * follows the same rules as described for {@link #resolveActivity}, but
7916 * you get back the completely information about the resolved activity
7917 * instead of just its class name.
7918 *
7919 * @param pm The package manager with which to resolve the Intent.
7920 * @param flags Addition information to retrieve as per
7921 * {@link PackageManager#getActivityInfo(ComponentName, int)
7922 * PackageManager.getActivityInfo()}.
7923 *
7924 * @return PackageManager.ActivityInfo
7925 *
7926 * @see #resolveActivity
7927 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007928 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7929 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007930 ActivityInfo ai = null;
7931 if (mComponent != null) {
7932 try {
7933 ai = pm.getActivityInfo(mComponent, flags);
7934 } catch (PackageManager.NameNotFoundException e) {
7935 // ignore
7936 }
7937 } else {
7938 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007939 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007940 if (info != null) {
7941 ai = info.activityInfo;
7942 }
7943 }
7944
7945 return ai;
7946 }
7947
7948 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007949 * Special function for use by the system to resolve service
7950 * intents to system apps. Throws an exception if there are
7951 * multiple potential matches to the Intent. Returns null if
7952 * there are no matches.
7953 * @hide
7954 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01007955 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007956 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7957 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007958 if (mComponent != null) {
7959 return mComponent;
7960 }
7961
7962 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7963 if (results == null) {
7964 return null;
7965 }
7966 ComponentName comp = null;
7967 for (int i=0; i<results.size(); i++) {
7968 ResolveInfo ri = results.get(i);
7969 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7970 continue;
7971 }
7972 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7973 ri.serviceInfo.name);
7974 if (comp != null) {
7975 throw new IllegalStateException("Multiple system services handle " + this
7976 + ": " + comp + ", " + foundComp);
7977 }
7978 comp = foundComp;
7979 }
7980 return comp;
7981 }
7982
7983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007984 * Set the general action to be performed.
7985 *
7986 * @param action An action name, such as ACTION_VIEW. Application-specific
7987 * actions should be prefixed with the vendor's package name.
7988 *
7989 * @return Returns the same Intent object, for chaining multiple calls
7990 * into a single statement.
7991 *
7992 * @see #getAction
7993 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007994 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007995 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007996 return this;
7997 }
7998
7999 /**
8000 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08008001 * clears any type that was previously set by {@link #setType} or
8002 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008003 *
Nick Pellyccae4122012-01-09 14:12:58 -08008004 * <p><em>Note: scheme matching in the Android framework is
8005 * case-sensitive, unlike the formal RFC. As a result,
8006 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008007 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008008 * {@link #setDataAndNormalize}
8009 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008010 *
Nick Pellyccae4122012-01-09 14:12:58 -08008011 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008012 *
8013 * @return Returns the same Intent object, for chaining multiple calls
8014 * into a single statement.
8015 *
8016 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08008017 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07008018 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008019 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008020 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008021 mData = data;
8022 mType = null;
8023 return this;
8024 }
8025
8026 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008027 * Normalize and set the data this intent is operating on.
8028 *
8029 * <p>This method automatically clears any type that was
8030 * previously set (for example, by {@link #setType}).
8031 *
8032 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008033 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08008034 * so really this is just a convenience method for
8035 * <pre>
8036 * setData(data.normalize())
8037 * </pre>
8038 *
8039 * @param data The Uri of the data this intent is now targeting.
8040 *
8041 * @return Returns the same Intent object, for chaining multiple calls
8042 * into a single statement.
8043 *
8044 * @see #getData
8045 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008046 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008047 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008048 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008049 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08008050 }
8051
8052 /**
8053 * Set an explicit MIME data type.
8054 *
8055 * <p>This is used to create intents that only specify a type and not data,
8056 * for example to indicate the type of data to return.
8057 *
8058 * <p>This method automatically clears any data that was
8059 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07008060 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008061 * <p><em>Note: MIME type matching in the Android framework is
8062 * case-sensitive, unlike formal RFC MIME types. As a result,
8063 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08008064 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
8065 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008066 *
8067 * @param type The MIME type of the data being handled by this intent.
8068 *
8069 * @return Returns the same Intent object, for chaining multiple calls
8070 * into a single statement.
8071 *
8072 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08008073 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008074 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08008075 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008076 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008077 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008078 mData = null;
8079 mType = type;
8080 return this;
8081 }
8082
8083 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008084 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008085 *
Nick Pellyccae4122012-01-09 14:12:58 -08008086 * <p>This is used to create intents that only specify a type and not data,
8087 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07008088 *
Nick Pellyccae4122012-01-09 14:12:58 -08008089 * <p>This method automatically clears any data that was
8090 * previously set (for example by {@link #setData}).
8091 *
8092 * <p>The MIME type is normalized using
8093 * {@link #normalizeMimeType} before it is set,
8094 * so really this is just a convenience method for
8095 * <pre>
8096 * setType(Intent.normalizeMimeType(type))
8097 * </pre>
8098 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008099 * @param type The MIME type of the data being handled by this intent.
8100 *
8101 * @return Returns the same Intent object, for chaining multiple calls
8102 * into a single statement.
8103 *
Nick Pellyccae4122012-01-09 14:12:58 -08008104 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008105 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08008106 * @see #normalizeMimeType
8107 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008108 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08008109 return setType(normalizeMimeType(type));
8110 }
8111
8112 /**
8113 * (Usually optional) Set the data for the intent along with an explicit
8114 * MIME data type. This method should very rarely be used -- it allows you
8115 * to override the MIME type that would ordinarily be inferred from the
8116 * data with your own type given here.
8117 *
8118 * <p><em>Note: MIME type and Uri scheme matching in the
8119 * Android framework is case-sensitive, unlike the formal RFC definitions.
8120 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008121 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08008122 * {@link #setDataAndTypeAndNormalize}
8123 * to ensure that they are converted to lower case.</em>
8124 *
8125 * @param data The Uri of the data this intent is now targeting.
8126 * @param type The MIME type of the data being handled by this intent.
8127 *
8128 * @return Returns the same Intent object, for chaining multiple calls
8129 * into a single statement.
8130 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008131 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08008132 * @see #setData
8133 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008134 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008135 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008136 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008137 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008138 mData = data;
8139 mType = type;
8140 return this;
8141 }
8142
8143 /**
Nick Pellyccae4122012-01-09 14:12:58 -08008144 * (Usually optional) Normalize and set both the data Uri and an explicit
8145 * MIME data type. This method should very rarely be used -- it allows you
8146 * to override the MIME type that would ordinarily be inferred from the
8147 * data with your own type given here.
8148 *
8149 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008150 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08008151 * before they are set, so really this is just a convenience method for
8152 * <pre>
8153 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
8154 * </pre>
8155 *
8156 * @param data The Uri of the data this intent is now targeting.
8157 * @param type The MIME type of the data being handled by this intent.
8158 *
8159 * @return Returns the same Intent object, for chaining multiple calls
8160 * into a single statement.
8161 *
8162 * @see #setType
8163 * @see #setData
8164 * @see #setDataAndType
8165 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008166 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08008167 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008168 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04008169 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08008170 }
8171
8172 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008173 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008174 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008175 * activities that provide <em>all</em> of the requested categories will be
8176 * used.
8177 *
8178 * @param category The desired category. This can be either one of the
8179 * predefined Intent categories, or a custom category in your own
8180 * namespace.
8181 *
8182 * @return Returns the same Intent object, for chaining multiple calls
8183 * into a single statement.
8184 *
8185 * @see #hasCategory
8186 * @see #removeCategory
8187 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008188 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008189 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008190 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008191 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008192 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008193 return this;
8194 }
8195
8196 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008197 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 *
8199 * @param category The category to remove.
8200 *
8201 * @see #addCategory
8202 */
8203 public void removeCategory(String category) {
8204 if (mCategories != null) {
8205 mCategories.remove(category);
8206 if (mCategories.size() == 0) {
8207 mCategories = null;
8208 }
8209 }
8210 }
8211
8212 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008213 * Set a selector for this Intent. This is a modification to the kinds of
8214 * things the Intent will match. If the selector is set, it will be used
8215 * when trying to find entities that can handle the Intent, instead of the
8216 * main contents of the Intent. This allows you build an Intent containing
8217 * a generic protocol while targeting it more specifically.
8218 *
8219 * <p>An example of where this may be used is with things like
8220 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8221 * Intent that will launch the Browser application. However, the correct
8222 * main entry point of an application is actually {@link #ACTION_MAIN}
8223 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8224 * used to specify the actual Activity to launch. If you launch the browser
8225 * with something different, undesired behavior may happen if the user has
8226 * previously or later launches it the normal way, since they do not match.
8227 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8228 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8229 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8230 *
8231 * <p>Setting a selector does not impact the behavior of
8232 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8233 * desired behavior of a selector -- it does not impact the base meaning
8234 * of the Intent, just what kinds of things will be matched against it
8235 * when determining who can handle it.</p>
8236 *
8237 * <p>You can not use both a selector and {@link #setPackage(String)} on
8238 * the same base Intent.</p>
8239 *
8240 * @param selector The desired selector Intent; set to null to not use
8241 * a special selector.
8242 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008243 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008244 if (selector == this) {
8245 throw new IllegalArgumentException(
8246 "Intent being set as a selector of itself");
8247 }
8248 if (selector != null && mPackage != null) {
8249 throw new IllegalArgumentException(
8250 "Can't set selector when package name is already set");
8251 }
8252 mSelector = selector;
8253 }
8254
8255 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008256 * Set a {@link ClipData} associated with this Intent. This replaces any
8257 * previously set ClipData.
8258 *
8259 * <p>The ClipData in an intent is not used for Intent matching or other
8260 * such operations. Semantically it is like extras, used to transmit
8261 * additional data with the Intent. The main feature of using this over
8262 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8263 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8264 * items included in the clip data. This is useful, in particular, if
8265 * you want to transmit an Intent containing multiple <code>content:</code>
8266 * URIs for which the recipient may not have global permission to access the
8267 * content provider.
8268 *
8269 * <p>If the ClipData contains items that are themselves Intents, any
8270 * grant flags in those Intents will be ignored. Only the top-level flags
8271 * of the main Intent are respected, and will be applied to all Uri or
8272 * Intent items in the clip (or sub-items of the clip).
8273 *
8274 * <p>The MIME type, label, and icon in the ClipData object are not
8275 * directly used by Intent. Applications should generally rely on the
8276 * MIME type of the Intent itself, not what it may find in the ClipData.
8277 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008278 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008279 *
8280 * @param clip The new clip to set. May be null to clear the current clip.
8281 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008282 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008283 mClipData = clip;
8284 }
8285
8286 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008287 * This is NOT a secure mechanism to identify the user who sent the intent.
8288 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8289 * who sent the intent.
8290 * @hide
8291 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008292 public void prepareToLeaveUser(int userId) {
8293 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8294 // We want mContentUserHint to refer to the original user, so don't do anything.
8295 if (mContentUserHint == UserHandle.USER_CURRENT) {
8296 mContentUserHint = userId;
8297 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008298 }
8299
8300 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008301 * Add extended data to the intent. The name must include a package
8302 * prefix, for example the app com.android.contacts would use names
8303 * like "com.android.contacts.ShowAll".
8304 *
8305 * @param name The name of the extra data, with package prefix.
8306 * @param value The boolean data value.
8307 *
8308 * @return Returns the same Intent object, for chaining multiple calls
8309 * into a single statement.
8310 *
8311 * @see #putExtras
8312 * @see #removeExtra
8313 * @see #getBooleanExtra(String, boolean)
8314 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008315 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008316 if (mExtras == null) {
8317 mExtras = new Bundle();
8318 }
8319 mExtras.putBoolean(name, value);
8320 return this;
8321 }
8322
8323 /**
8324 * Add extended data to the intent. The name must include a package
8325 * prefix, for example the app com.android.contacts would use names
8326 * like "com.android.contacts.ShowAll".
8327 *
8328 * @param name The name of the extra data, with package prefix.
8329 * @param value The byte data value.
8330 *
8331 * @return Returns the same Intent object, for chaining multiple calls
8332 * into a single statement.
8333 *
8334 * @see #putExtras
8335 * @see #removeExtra
8336 * @see #getByteExtra(String, byte)
8337 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008338 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008339 if (mExtras == null) {
8340 mExtras = new Bundle();
8341 }
8342 mExtras.putByte(name, value);
8343 return this;
8344 }
8345
8346 /**
8347 * Add extended data to the intent. The name must include a package
8348 * prefix, for example the app com.android.contacts would use names
8349 * like "com.android.contacts.ShowAll".
8350 *
8351 * @param name The name of the extra data, with package prefix.
8352 * @param value The char data value.
8353 *
8354 * @return Returns the same Intent object, for chaining multiple calls
8355 * into a single statement.
8356 *
8357 * @see #putExtras
8358 * @see #removeExtra
8359 * @see #getCharExtra(String, char)
8360 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008361 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008362 if (mExtras == null) {
8363 mExtras = new Bundle();
8364 }
8365 mExtras.putChar(name, value);
8366 return this;
8367 }
8368
8369 /**
8370 * Add extended data to the intent. The name must include a package
8371 * prefix, for example the app com.android.contacts would use names
8372 * like "com.android.contacts.ShowAll".
8373 *
8374 * @param name The name of the extra data, with package prefix.
8375 * @param value The short data value.
8376 *
8377 * @return Returns the same Intent object, for chaining multiple calls
8378 * into a single statement.
8379 *
8380 * @see #putExtras
8381 * @see #removeExtra
8382 * @see #getShortExtra(String, short)
8383 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008384 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008385 if (mExtras == null) {
8386 mExtras = new Bundle();
8387 }
8388 mExtras.putShort(name, value);
8389 return this;
8390 }
8391
8392 /**
8393 * Add extended data to the intent. The name must include a package
8394 * prefix, for example the app com.android.contacts would use names
8395 * like "com.android.contacts.ShowAll".
8396 *
8397 * @param name The name of the extra data, with package prefix.
8398 * @param value The integer data value.
8399 *
8400 * @return Returns the same Intent object, for chaining multiple calls
8401 * into a single statement.
8402 *
8403 * @see #putExtras
8404 * @see #removeExtra
8405 * @see #getIntExtra(String, int)
8406 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008407 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008408 if (mExtras == null) {
8409 mExtras = new Bundle();
8410 }
8411 mExtras.putInt(name, value);
8412 return this;
8413 }
8414
8415 /**
8416 * Add extended data to the intent. The name must include a package
8417 * prefix, for example the app com.android.contacts would use names
8418 * like "com.android.contacts.ShowAll".
8419 *
8420 * @param name The name of the extra data, with package prefix.
8421 * @param value The long data value.
8422 *
8423 * @return Returns the same Intent object, for chaining multiple calls
8424 * into a single statement.
8425 *
8426 * @see #putExtras
8427 * @see #removeExtra
8428 * @see #getLongExtra(String, long)
8429 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008430 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008431 if (mExtras == null) {
8432 mExtras = new Bundle();
8433 }
8434 mExtras.putLong(name, value);
8435 return this;
8436 }
8437
8438 /**
8439 * Add extended data to the intent. The name must include a package
8440 * prefix, for example the app com.android.contacts would use names
8441 * like "com.android.contacts.ShowAll".
8442 *
8443 * @param name The name of the extra data, with package prefix.
8444 * @param value The float data value.
8445 *
8446 * @return Returns the same Intent object, for chaining multiple calls
8447 * into a single statement.
8448 *
8449 * @see #putExtras
8450 * @see #removeExtra
8451 * @see #getFloatExtra(String, float)
8452 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008453 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008454 if (mExtras == null) {
8455 mExtras = new Bundle();
8456 }
8457 mExtras.putFloat(name, value);
8458 return this;
8459 }
8460
8461 /**
8462 * Add extended data to the intent. The name must include a package
8463 * prefix, for example the app com.android.contacts would use names
8464 * like "com.android.contacts.ShowAll".
8465 *
8466 * @param name The name of the extra data, with package prefix.
8467 * @param value The double data value.
8468 *
8469 * @return Returns the same Intent object, for chaining multiple calls
8470 * into a single statement.
8471 *
8472 * @see #putExtras
8473 * @see #removeExtra
8474 * @see #getDoubleExtra(String, double)
8475 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008476 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008477 if (mExtras == null) {
8478 mExtras = new Bundle();
8479 }
8480 mExtras.putDouble(name, value);
8481 return this;
8482 }
8483
8484 /**
8485 * Add extended data to the intent. The name must include a package
8486 * prefix, for example the app com.android.contacts would use names
8487 * like "com.android.contacts.ShowAll".
8488 *
8489 * @param name The name of the extra data, with package prefix.
8490 * @param value The String data value.
8491 *
8492 * @return Returns the same Intent object, for chaining multiple calls
8493 * into a single statement.
8494 *
8495 * @see #putExtras
8496 * @see #removeExtra
8497 * @see #getStringExtra(String)
8498 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008499 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008500 if (mExtras == null) {
8501 mExtras = new Bundle();
8502 }
8503 mExtras.putString(name, value);
8504 return this;
8505 }
8506
8507 /**
8508 * Add extended data to the intent. The name must include a package
8509 * prefix, for example the app com.android.contacts would use names
8510 * like "com.android.contacts.ShowAll".
8511 *
8512 * @param name The name of the extra data, with package prefix.
8513 * @param value The CharSequence data value.
8514 *
8515 * @return Returns the same Intent object, for chaining multiple calls
8516 * into a single statement.
8517 *
8518 * @see #putExtras
8519 * @see #removeExtra
8520 * @see #getCharSequenceExtra(String)
8521 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008522 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008523 if (mExtras == null) {
8524 mExtras = new Bundle();
8525 }
8526 mExtras.putCharSequence(name, value);
8527 return this;
8528 }
8529
8530 /**
8531 * Add extended data to the intent. The name must include a package
8532 * prefix, for example the app com.android.contacts would use names
8533 * like "com.android.contacts.ShowAll".
8534 *
8535 * @param name The name of the extra data, with package prefix.
8536 * @param value The Parcelable data value.
8537 *
8538 * @return Returns the same Intent object, for chaining multiple calls
8539 * into a single statement.
8540 *
8541 * @see #putExtras
8542 * @see #removeExtra
8543 * @see #getParcelableExtra(String)
8544 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008545 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008546 if (mExtras == null) {
8547 mExtras = new Bundle();
8548 }
8549 mExtras.putParcelable(name, value);
8550 return this;
8551 }
8552
8553 /**
8554 * Add extended data to the intent. The name must include a package
8555 * prefix, for example the app com.android.contacts would use names
8556 * like "com.android.contacts.ShowAll".
8557 *
8558 * @param name The name of the extra data, with package prefix.
8559 * @param value The Parcelable[] data value.
8560 *
8561 * @return Returns the same Intent object, for chaining multiple calls
8562 * into a single statement.
8563 *
8564 * @see #putExtras
8565 * @see #removeExtra
8566 * @see #getParcelableArrayExtra(String)
8567 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008568 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008569 if (mExtras == null) {
8570 mExtras = new Bundle();
8571 }
8572 mExtras.putParcelableArray(name, value);
8573 return this;
8574 }
8575
8576 /**
8577 * Add extended data to the intent. The name must include a package
8578 * prefix, for example the app com.android.contacts would use names
8579 * like "com.android.contacts.ShowAll".
8580 *
8581 * @param name The name of the extra data, with package prefix.
8582 * @param value The ArrayList<Parcelable> data value.
8583 *
8584 * @return Returns the same Intent object, for chaining multiple calls
8585 * into a single statement.
8586 *
8587 * @see #putExtras
8588 * @see #removeExtra
8589 * @see #getParcelableArrayListExtra(String)
8590 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008591 public @NonNull Intent putParcelableArrayListExtra(String name,
8592 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008593 if (mExtras == null) {
8594 mExtras = new Bundle();
8595 }
8596 mExtras.putParcelableArrayList(name, value);
8597 return this;
8598 }
8599
8600 /**
8601 * Add extended data to the intent. The name must include a package
8602 * prefix, for example the app com.android.contacts would use names
8603 * like "com.android.contacts.ShowAll".
8604 *
8605 * @param name The name of the extra data, with package prefix.
8606 * @param value The ArrayList<Integer> data value.
8607 *
8608 * @return Returns the same Intent object, for chaining multiple calls
8609 * into a single statement.
8610 *
8611 * @see #putExtras
8612 * @see #removeExtra
8613 * @see #getIntegerArrayListExtra(String)
8614 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008615 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008616 if (mExtras == null) {
8617 mExtras = new Bundle();
8618 }
8619 mExtras.putIntegerArrayList(name, value);
8620 return this;
8621 }
8622
8623 /**
8624 * Add extended data to the intent. The name must include a package
8625 * prefix, for example the app com.android.contacts would use names
8626 * like "com.android.contacts.ShowAll".
8627 *
8628 * @param name The name of the extra data, with package prefix.
8629 * @param value The ArrayList<String> data value.
8630 *
8631 * @return Returns the same Intent object, for chaining multiple calls
8632 * into a single statement.
8633 *
8634 * @see #putExtras
8635 * @see #removeExtra
8636 * @see #getStringArrayListExtra(String)
8637 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008638 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008639 if (mExtras == null) {
8640 mExtras = new Bundle();
8641 }
8642 mExtras.putStringArrayList(name, value);
8643 return this;
8644 }
8645
8646 /**
8647 * Add extended data to the intent. The name must include a package
8648 * prefix, for example the app com.android.contacts would use names
8649 * like "com.android.contacts.ShowAll".
8650 *
8651 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008652 * @param value The ArrayList<CharSequence> data value.
8653 *
8654 * @return Returns the same Intent object, for chaining multiple calls
8655 * into a single statement.
8656 *
8657 * @see #putExtras
8658 * @see #removeExtra
8659 * @see #getCharSequenceArrayListExtra(String)
8660 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008661 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8662 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008663 if (mExtras == null) {
8664 mExtras = new Bundle();
8665 }
8666 mExtras.putCharSequenceArrayList(name, value);
8667 return this;
8668 }
8669
8670 /**
8671 * Add extended data to the intent. The name must include a package
8672 * prefix, for example the app com.android.contacts would use names
8673 * like "com.android.contacts.ShowAll".
8674 *
8675 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008676 * @param value The Serializable data value.
8677 *
8678 * @return Returns the same Intent object, for chaining multiple calls
8679 * into a single statement.
8680 *
8681 * @see #putExtras
8682 * @see #removeExtra
8683 * @see #getSerializableExtra(String)
8684 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008685 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 if (mExtras == null) {
8687 mExtras = new Bundle();
8688 }
8689 mExtras.putSerializable(name, value);
8690 return this;
8691 }
8692
8693 /**
8694 * Add extended data to the intent. The name must include a package
8695 * prefix, for example the app com.android.contacts would use names
8696 * like "com.android.contacts.ShowAll".
8697 *
8698 * @param name The name of the extra data, with package prefix.
8699 * @param value The boolean array data value.
8700 *
8701 * @return Returns the same Intent object, for chaining multiple calls
8702 * into a single statement.
8703 *
8704 * @see #putExtras
8705 * @see #removeExtra
8706 * @see #getBooleanArrayExtra(String)
8707 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008708 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008709 if (mExtras == null) {
8710 mExtras = new Bundle();
8711 }
8712 mExtras.putBooleanArray(name, value);
8713 return this;
8714 }
8715
8716 /**
8717 * Add extended data to the intent. The name must include a package
8718 * prefix, for example the app com.android.contacts would use names
8719 * like "com.android.contacts.ShowAll".
8720 *
8721 * @param name The name of the extra data, with package prefix.
8722 * @param value The byte array data value.
8723 *
8724 * @return Returns the same Intent object, for chaining multiple calls
8725 * into a single statement.
8726 *
8727 * @see #putExtras
8728 * @see #removeExtra
8729 * @see #getByteArrayExtra(String)
8730 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008731 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 if (mExtras == null) {
8733 mExtras = new Bundle();
8734 }
8735 mExtras.putByteArray(name, value);
8736 return this;
8737 }
8738
8739 /**
8740 * Add extended data to the intent. The name must include a package
8741 * prefix, for example the app com.android.contacts would use names
8742 * like "com.android.contacts.ShowAll".
8743 *
8744 * @param name The name of the extra data, with package prefix.
8745 * @param value The short array data value.
8746 *
8747 * @return Returns the same Intent object, for chaining multiple calls
8748 * into a single statement.
8749 *
8750 * @see #putExtras
8751 * @see #removeExtra
8752 * @see #getShortArrayExtra(String)
8753 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008754 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008755 if (mExtras == null) {
8756 mExtras = new Bundle();
8757 }
8758 mExtras.putShortArray(name, value);
8759 return this;
8760 }
8761
8762 /**
8763 * Add extended data to the intent. The name must include a package
8764 * prefix, for example the app com.android.contacts would use names
8765 * like "com.android.contacts.ShowAll".
8766 *
8767 * @param name The name of the extra data, with package prefix.
8768 * @param value The char array data value.
8769 *
8770 * @return Returns the same Intent object, for chaining multiple calls
8771 * into a single statement.
8772 *
8773 * @see #putExtras
8774 * @see #removeExtra
8775 * @see #getCharArrayExtra(String)
8776 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008777 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008778 if (mExtras == null) {
8779 mExtras = new Bundle();
8780 }
8781 mExtras.putCharArray(name, value);
8782 return this;
8783 }
8784
8785 /**
8786 * Add extended data to the intent. The name must include a package
8787 * prefix, for example the app com.android.contacts would use names
8788 * like "com.android.contacts.ShowAll".
8789 *
8790 * @param name The name of the extra data, with package prefix.
8791 * @param value The int array data value.
8792 *
8793 * @return Returns the same Intent object, for chaining multiple calls
8794 * into a single statement.
8795 *
8796 * @see #putExtras
8797 * @see #removeExtra
8798 * @see #getIntArrayExtra(String)
8799 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008800 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008801 if (mExtras == null) {
8802 mExtras = new Bundle();
8803 }
8804 mExtras.putIntArray(name, value);
8805 return this;
8806 }
8807
8808 /**
8809 * Add extended data to the intent. The name must include a package
8810 * prefix, for example the app com.android.contacts would use names
8811 * like "com.android.contacts.ShowAll".
8812 *
8813 * @param name The name of the extra data, with package prefix.
8814 * @param value The byte array data value.
8815 *
8816 * @return Returns the same Intent object, for chaining multiple calls
8817 * into a single statement.
8818 *
8819 * @see #putExtras
8820 * @see #removeExtra
8821 * @see #getLongArrayExtra(String)
8822 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008823 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008824 if (mExtras == null) {
8825 mExtras = new Bundle();
8826 }
8827 mExtras.putLongArray(name, value);
8828 return this;
8829 }
8830
8831 /**
8832 * Add extended data to the intent. The name must include a package
8833 * prefix, for example the app com.android.contacts would use names
8834 * like "com.android.contacts.ShowAll".
8835 *
8836 * @param name The name of the extra data, with package prefix.
8837 * @param value The float array data value.
8838 *
8839 * @return Returns the same Intent object, for chaining multiple calls
8840 * into a single statement.
8841 *
8842 * @see #putExtras
8843 * @see #removeExtra
8844 * @see #getFloatArrayExtra(String)
8845 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008846 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008847 if (mExtras == null) {
8848 mExtras = new Bundle();
8849 }
8850 mExtras.putFloatArray(name, value);
8851 return this;
8852 }
8853
8854 /**
8855 * Add extended data to the intent. The name must include a package
8856 * prefix, for example the app com.android.contacts would use names
8857 * like "com.android.contacts.ShowAll".
8858 *
8859 * @param name The name of the extra data, with package prefix.
8860 * @param value The double array data value.
8861 *
8862 * @return Returns the same Intent object, for chaining multiple calls
8863 * into a single statement.
8864 *
8865 * @see #putExtras
8866 * @see #removeExtra
8867 * @see #getDoubleArrayExtra(String)
8868 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008869 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008870 if (mExtras == null) {
8871 mExtras = new Bundle();
8872 }
8873 mExtras.putDoubleArray(name, value);
8874 return this;
8875 }
8876
8877 /**
8878 * Add extended data to the intent. The name must include a package
8879 * prefix, for example the app com.android.contacts would use names
8880 * like "com.android.contacts.ShowAll".
8881 *
8882 * @param name The name of the extra data, with package prefix.
8883 * @param value The String array data value.
8884 *
8885 * @return Returns the same Intent object, for chaining multiple calls
8886 * into a single statement.
8887 *
8888 * @see #putExtras
8889 * @see #removeExtra
8890 * @see #getStringArrayExtra(String)
8891 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008892 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008893 if (mExtras == null) {
8894 mExtras = new Bundle();
8895 }
8896 mExtras.putStringArray(name, value);
8897 return this;
8898 }
8899
8900 /**
8901 * Add extended data to the intent. The name must include a package
8902 * prefix, for example the app com.android.contacts would use names
8903 * like "com.android.contacts.ShowAll".
8904 *
8905 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008906 * @param value The CharSequence array data value.
8907 *
8908 * @return Returns the same Intent object, for chaining multiple calls
8909 * into a single statement.
8910 *
8911 * @see #putExtras
8912 * @see #removeExtra
8913 * @see #getCharSequenceArrayExtra(String)
8914 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008915 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008916 if (mExtras == null) {
8917 mExtras = new Bundle();
8918 }
8919 mExtras.putCharSequenceArray(name, value);
8920 return this;
8921 }
8922
8923 /**
8924 * Add extended data to the intent. The name must include a package
8925 * prefix, for example the app com.android.contacts would use names
8926 * like "com.android.contacts.ShowAll".
8927 *
8928 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008929 * @param value The Bundle data value.
8930 *
8931 * @return Returns the same Intent object, for chaining multiple calls
8932 * into a single statement.
8933 *
8934 * @see #putExtras
8935 * @see #removeExtra
8936 * @see #getBundleExtra(String)
8937 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008938 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008939 if (mExtras == null) {
8940 mExtras = new Bundle();
8941 }
8942 mExtras.putBundle(name, value);
8943 return this;
8944 }
8945
8946 /**
8947 * Add extended data to the intent. The name must include a package
8948 * prefix, for example the app com.android.contacts would use names
8949 * like "com.android.contacts.ShowAll".
8950 *
8951 * @param name The name of the extra data, with package prefix.
8952 * @param value The IBinder data value.
8953 *
8954 * @return Returns the same Intent object, for chaining multiple calls
8955 * into a single statement.
8956 *
8957 * @see #putExtras
8958 * @see #removeExtra
8959 * @see #getIBinderExtra(String)
8960 *
8961 * @deprecated
8962 * @hide
8963 */
8964 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +01008965 @UnsupportedAppUsage
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008966 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008967 if (mExtras == null) {
8968 mExtras = new Bundle();
8969 }
8970 mExtras.putIBinder(name, value);
8971 return this;
8972 }
8973
8974 /**
8975 * Copy all extras in 'src' in to this intent.
8976 *
8977 * @param src Contains the extras to copy.
8978 *
8979 * @see #putExtra
8980 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008981 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008982 if (src.mExtras != null) {
8983 if (mExtras == null) {
8984 mExtras = new Bundle(src.mExtras);
8985 } else {
8986 mExtras.putAll(src.mExtras);
8987 }
8988 }
8989 return this;
8990 }
8991
8992 /**
8993 * Add a set of extended data to the intent. The keys must include a package
8994 * prefix, for example the app com.android.contacts would use names
8995 * like "com.android.contacts.ShowAll".
8996 *
8997 * @param extras The Bundle of extras to add to this intent.
8998 *
8999 * @see #putExtra
9000 * @see #removeExtra
9001 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009002 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009003 if (mExtras == null) {
9004 mExtras = new Bundle();
9005 }
9006 mExtras.putAll(extras);
9007 return this;
9008 }
9009
9010 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009011 * Completely replace the extras in the Intent with the extras in the
9012 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07009013 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009014 * @param src The exact extras contained in this Intent are copied
9015 * into the target intent, replacing any that were previously there.
9016 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009017 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009018 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
9019 return this;
9020 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009021
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009022 /**
9023 * Completely replace the extras in the Intent with the given Bundle of
9024 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07009025 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009026 * @param extras The new set of extras in the Intent, or null to erase
9027 * all extras.
9028 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009029 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009030 mExtras = extras != null ? new Bundle(extras) : null;
9031 return this;
9032 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009033
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009035 * Remove extended data from the intent.
9036 *
9037 * @see #putExtra
9038 */
9039 public void removeExtra(String name) {
9040 if (mExtras != null) {
9041 mExtras.remove(name);
9042 if (mExtras.size() == 0) {
9043 mExtras = null;
9044 }
9045 }
9046 }
9047
9048 /**
9049 * Set special flags controlling how this intent is handled. Most values
9050 * here depend on the type of component being executed by the Intent,
9051 * specifically the FLAG_ACTIVITY_* flags are all for use with
9052 * {@link Context#startActivity Context.startActivity()} and the
9053 * FLAG_RECEIVER_* flags are all for use with
9054 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
9055 *
Scott Main7aee61f2011-02-08 11:25:01 -08009056 * <p>See the
9057 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
9058 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009059 * the behavior of your application.
9060 *
9061 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009062 * @return Returns the same Intent object, for chaining multiple calls
9063 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009064 * @see #getFlags
9065 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009066 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009067 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009068 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009069 mFlags = flags;
9070 return this;
9071 }
9072
9073 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009074 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009075 *
9076 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009077 * @return Returns the same Intent object, for chaining multiple calls into
9078 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009079 * @see #setFlags
9080 * @see #getFlags
9081 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009082 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009083 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009084 mFlags |= flags;
9085 return this;
9086 }
9087
9088 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009089 * Remove these flags from the intent.
9090 *
9091 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009092 * @see #setFlags
9093 * @see #getFlags
9094 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009095 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009096 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07009097 mFlags &= ~flags;
9098 }
9099
9100 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009101 * (Usually optional) Set an explicit application package name that limits
9102 * the components this Intent will resolve to. If left to the default
9103 * value of null, all components in all applications will considered.
9104 * If non-null, the Intent can only match the components in the given
9105 * application package.
9106 *
9107 * @param packageName The name of the application package to handle the
9108 * intent, or null to allow any application package.
9109 *
9110 * @return Returns the same Intent object, for chaining multiple calls
9111 * into a single statement.
9112 *
9113 * @see #getPackage
9114 * @see #resolveActivity
9115 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009116 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009117 if (packageName != null && mSelector != null) {
9118 throw new IllegalArgumentException(
9119 "Can't set package name when selector is already set");
9120 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009121 mPackage = packageName;
9122 return this;
9123 }
9124
9125 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009126 * (Usually optional) Explicitly set the component to handle the intent.
9127 * If left with the default value of null, the system will determine the
9128 * appropriate class to use based on the other fields (action, data,
9129 * type, categories) in the Intent. If this class is defined, the
9130 * specified class will always be used regardless of the other fields. You
9131 * should only set this value when you know you absolutely want a specific
9132 * class to be used; otherwise it is better to let the system find the
9133 * appropriate class so that you will respect the installed applications
9134 * and user preferences.
9135 *
9136 * @param component The name of the application component to handle the
9137 * intent, or null to let the system find one for you.
9138 *
9139 * @return Returns the same Intent object, for chaining multiple calls
9140 * into a single statement.
9141 *
9142 * @see #setClass
9143 * @see #setClassName(Context, String)
9144 * @see #setClassName(String, String)
9145 * @see #getComponent
9146 * @see #resolveActivity
9147 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009148 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009149 mComponent = component;
9150 return this;
9151 }
9152
9153 /**
9154 * Convenience for calling {@link #setComponent} with an
9155 * explicit class name.
9156 *
9157 * @param packageContext A Context of the application package implementing
9158 * this class.
9159 * @param className The name of a class inside of the application package
9160 * that will be used as the component for this Intent.
9161 *
9162 * @return Returns the same Intent object, for chaining multiple calls
9163 * into a single statement.
9164 *
9165 * @see #setComponent
9166 * @see #setClass
9167 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009168 public @NonNull Intent setClassName(@NonNull Context packageContext,
9169 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009170 mComponent = new ComponentName(packageContext, className);
9171 return this;
9172 }
9173
9174 /**
9175 * Convenience for calling {@link #setComponent} with an
9176 * explicit application package name and class name.
9177 *
9178 * @param packageName The name of the package implementing the desired
9179 * component.
9180 * @param className The name of a class inside of the application package
9181 * that will be used as the component for this Intent.
9182 *
9183 * @return Returns the same Intent object, for chaining multiple calls
9184 * into a single statement.
9185 *
9186 * @see #setComponent
9187 * @see #setClass
9188 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009189 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009190 mComponent = new ComponentName(packageName, className);
9191 return this;
9192 }
9193
9194 /**
9195 * Convenience for calling {@link #setComponent(ComponentName)} with the
9196 * name returned by a {@link Class} object.
9197 *
9198 * @param packageContext A Context of the application package implementing
9199 * this class.
9200 * @param cls The class name to set, equivalent to
9201 * <code>setClassName(context, cls.getName())</code>.
9202 *
9203 * @return Returns the same Intent object, for chaining multiple calls
9204 * into a single statement.
9205 *
9206 * @see #setComponent
9207 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009208 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009209 mComponent = new ComponentName(packageContext, cls);
9210 return this;
9211 }
9212
9213 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009214 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9215 * used as a hint to the receiver for animations and the like. Null means that there
9216 * is no source bounds.
9217 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009218 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009219 if (r != null) {
9220 mSourceBounds = new Rect(r);
9221 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009222 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009223 }
9224 }
9225
Tor Norbyed9273d62013-05-30 15:59:53 -07009226 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009227 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9228 FILL_IN_ACTION,
9229 FILL_IN_DATA,
9230 FILL_IN_CATEGORIES,
9231 FILL_IN_COMPONENT,
9232 FILL_IN_PACKAGE,
9233 FILL_IN_SOURCE_BOUNDS,
9234 FILL_IN_SELECTOR,
9235 FILL_IN_CLIP_DATA
9236 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009237 @Retention(RetentionPolicy.SOURCE)
9238 public @interface FillInFlags {}
9239
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009241 * Use with {@link #fillIn} to allow the current action value to be
9242 * overwritten, even if it is already set.
9243 */
9244 public static final int FILL_IN_ACTION = 1<<0;
9245
9246 /**
9247 * Use with {@link #fillIn} to allow the current data or type value
9248 * overwritten, even if it is already set.
9249 */
9250 public static final int FILL_IN_DATA = 1<<1;
9251
9252 /**
9253 * Use with {@link #fillIn} to allow the current categories to be
9254 * overwritten, even if they are already set.
9255 */
9256 public static final int FILL_IN_CATEGORIES = 1<<2;
9257
9258 /**
9259 * Use with {@link #fillIn} to allow the current component value to be
9260 * overwritten, even if it is already set.
9261 */
9262 public static final int FILL_IN_COMPONENT = 1<<3;
9263
9264 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009265 * Use with {@link #fillIn} to allow the current package value to be
9266 * overwritten, even if it is already set.
9267 */
9268 public static final int FILL_IN_PACKAGE = 1<<4;
9269
9270 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009271 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009272 * overwritten, even if it is already set.
9273 */
9274 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9275
9276 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009277 * Use with {@link #fillIn} to allow the current selector to be
9278 * overwritten, even if it is already set.
9279 */
9280 public static final int FILL_IN_SELECTOR = 1<<6;
9281
9282 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009283 * Use with {@link #fillIn} to allow the current ClipData to be
9284 * overwritten, even if it is already set.
9285 */
9286 public static final int FILL_IN_CLIP_DATA = 1<<7;
9287
9288 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009289 * Copy the contents of <var>other</var> in to this object, but only
9290 * where fields are not defined by this object. For purposes of a field
9291 * being defined, the following pieces of data in the Intent are
9292 * considered to be separate fields:
9293 *
9294 * <ul>
9295 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009296 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009297 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9298 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009299 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009300 * <li> component, as set by {@link #setComponent(ComponentName)} or
9301 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009302 * <li> source bounds, as set by {@link #setSourceBounds}.
9303 * <li> selector, as set by {@link #setSelector(Intent)}.
9304 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009305 * <li> each top-level name in the associated extras.
9306 * </ul>
9307 *
9308 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009309 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009310 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9311 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9312 * the restriction where the corresponding field will not be replaced if
9313 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009314 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009315 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9316 * is explicitly specified. The selector will only be copied if
9317 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009318 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009319 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9320 * and Intent B with {action="gotit", data-type="some/thing",
9321 * categories="one","two"}.
9322 *
9323 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9324 * containing: {action="gotit", data-type="some/thing",
9325 * categories="bar"}.
9326 *
9327 * @param other Another Intent whose values are to be used to fill in
9328 * the current one.
9329 * @param flags Options to control which fields can be filled in.
9330 *
9331 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009332 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009333 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009334 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009335 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009336 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009337 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009338 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009339 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009340 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009341 if (other.mAction != null
9342 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009343 mAction = other.mAction;
9344 changes |= FILL_IN_ACTION;
9345 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009346 if ((other.mData != null || other.mType != null)
9347 && ((mData == null && mType == null)
9348 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009349 mData = other.mData;
9350 mType = other.mType;
9351 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009352 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009353 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009354 if (other.mCategories != null
9355 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009356 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009357 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009358 }
9359 changes |= FILL_IN_CATEGORIES;
9360 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009361 if (other.mPackage != null
9362 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009363 // Only do this if mSelector is not set.
9364 if (mSelector == null) {
9365 mPackage = other.mPackage;
9366 changes |= FILL_IN_PACKAGE;
9367 }
9368 }
9369 // Selector is special: it can only be set if explicitly allowed,
9370 // for the same reason as the component name.
9371 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9372 if (mPackage == null) {
9373 mSelector = new Intent(other.mSelector);
9374 mPackage = null;
9375 changes |= FILL_IN_SELECTOR;
9376 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009377 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009378 if (other.mClipData != null
9379 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9380 mClipData = other.mClipData;
9381 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009382 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009383 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009384 // Component is special: it can -only- be set if explicitly allowed,
9385 // since otherwise the sender could force the intent somewhere the
9386 // originator didn't intend.
9387 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009388 mComponent = other.mComponent;
9389 changes |= FILL_IN_COMPONENT;
9390 }
9391 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009392 if (other.mSourceBounds != null
9393 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9394 mSourceBounds = new Rect(other.mSourceBounds);
9395 changes |= FILL_IN_SOURCE_BOUNDS;
9396 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009397 if (mExtras == null) {
9398 if (other.mExtras != null) {
9399 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009400 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009401 }
9402 } else if (other.mExtras != null) {
9403 try {
9404 Bundle newb = new Bundle(other.mExtras);
9405 newb.putAll(mExtras);
9406 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009407 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009408 } catch (RuntimeException e) {
9409 // Modifying the extras can cause us to unparcel the contents
9410 // of the bundle, and if we do this in the system process that
9411 // may fail. We really should handle this (i.e., the Bundle
9412 // impl shouldn't be on top of a plain map), but for now just
9413 // ignore it and keep the original contents. :(
9414 Log.w("Intent", "Failure filling in extras", e);
9415 }
9416 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009417 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9418 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9419 mContentUserHint = other.mContentUserHint;
9420 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009421 return changes;
9422 }
9423
9424 /**
9425 * Wrapper class holding an Intent and implementing comparisons on it for
9426 * the purpose of filtering. The class implements its
9427 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9428 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9429 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9430 * on the wrapped Intent.
9431 */
9432 public static final class FilterComparison {
9433 private final Intent mIntent;
9434 private final int mHashCode;
9435
9436 public FilterComparison(Intent intent) {
9437 mIntent = intent;
9438 mHashCode = intent.filterHashCode();
9439 }
9440
9441 /**
9442 * Return the Intent that this FilterComparison represents.
9443 * @return Returns the Intent held by the FilterComparison. Do
9444 * not modify!
9445 */
9446 public Intent getIntent() {
9447 return mIntent;
9448 }
9449
9450 @Override
9451 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009452 if (obj instanceof FilterComparison) {
9453 Intent other = ((FilterComparison)obj).mIntent;
9454 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009455 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009456 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009457 }
9458
9459 @Override
9460 public int hashCode() {
9461 return mHashCode;
9462 }
9463 }
9464
9465 /**
9466 * Determine if two intents are the same for the purposes of intent
9467 * resolution (filtering). That is, if their action, data, type,
9468 * class, and categories are the same. This does <em>not</em> compare
9469 * any extra data included in the intents.
9470 *
9471 * @param other The other Intent to compare against.
9472 *
9473 * @return Returns true if action, data, type, class, and categories
9474 * are the same.
9475 */
9476 public boolean filterEquals(Intent other) {
9477 if (other == null) {
9478 return false;
9479 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009480 if (!Objects.equals(this.mAction, other.mAction)) return false;
9481 if (!Objects.equals(this.mData, other.mData)) return false;
9482 if (!Objects.equals(this.mType, other.mType)) return false;
9483 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9484 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9485 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009486
9487 return true;
9488 }
9489
9490 /**
9491 * Generate hash code that matches semantics of filterEquals().
9492 *
9493 * @return Returns the hash value of the action, data, type, class, and
9494 * categories.
9495 *
9496 * @see #filterEquals
9497 */
9498 public int filterHashCode() {
9499 int code = 0;
9500 if (mAction != null) {
9501 code += mAction.hashCode();
9502 }
9503 if (mData != null) {
9504 code += mData.hashCode();
9505 }
9506 if (mType != null) {
9507 code += mType.hashCode();
9508 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009509 if (mPackage != null) {
9510 code += mPackage.hashCode();
9511 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009512 if (mComponent != null) {
9513 code += mComponent.hashCode();
9514 }
9515 if (mCategories != null) {
9516 code += mCategories.hashCode();
9517 }
9518 return code;
9519 }
9520
9521 @Override
9522 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009523 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009524
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009525 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009526 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009527 b.append(" }");
9528
9529 return b.toString();
9530 }
9531
9532 /** @hide */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01009533 @UnsupportedAppUsage
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009534 public String toInsecureString() {
9535 StringBuilder b = new StringBuilder(128);
9536
9537 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009538 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009539 b.append(" }");
9540
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009541 return b.toString();
9542 }
Romain Guy4969af72009-06-17 10:53:19 -07009543
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009544 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009545 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009546 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009547
9548 b.append("Intent { ");
9549 toShortString(b, false, true, true, true);
9550 b.append(" }");
9551
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009552 return b.toString();
9553 }
9554
9555 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009556 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9557 StringBuilder b = new StringBuilder(128);
9558 toShortString(b, secure, comp, extras, clip);
9559 return b.toString();
9560 }
9561
9562 /** @hide */
9563 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9564 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009565 boolean first = true;
9566 if (mAction != null) {
9567 b.append("act=").append(mAction);
9568 first = false;
9569 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009570 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009571 if (!first) {
9572 b.append(' ');
9573 }
9574 first = false;
9575 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009576 for (int i=0; i<mCategories.size(); i++) {
9577 if (i > 0) b.append(',');
9578 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009579 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009580 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009581 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009582 if (mData != null) {
9583 if (!first) {
9584 b.append(' ');
9585 }
9586 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009587 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009588 if (secure) {
9589 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009590 } else {
9591 b.append(mData);
9592 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009593 }
9594 if (mType != null) {
9595 if (!first) {
9596 b.append(' ');
9597 }
9598 first = false;
9599 b.append("typ=").append(mType);
9600 }
9601 if (mFlags != 0) {
9602 if (!first) {
9603 b.append(' ');
9604 }
9605 first = false;
9606 b.append("flg=0x").append(Integer.toHexString(mFlags));
9607 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009608 if (mPackage != null) {
9609 if (!first) {
9610 b.append(' ');
9611 }
9612 first = false;
9613 b.append("pkg=").append(mPackage);
9614 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009615 if (comp && mComponent != null) {
9616 if (!first) {
9617 b.append(' ');
9618 }
9619 first = false;
9620 b.append("cmp=").append(mComponent.flattenToShortString());
9621 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009622 if (mSourceBounds != null) {
9623 if (!first) {
9624 b.append(' ');
9625 }
9626 first = false;
9627 b.append("bnds=").append(mSourceBounds.toShortString());
9628 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009629 if (mClipData != null) {
9630 if (!first) {
9631 b.append(' ');
9632 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009633 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009634 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009635 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009636 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009637 if (mClipData.getDescription() != null) {
9638 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9639 } else {
9640 first = true;
9641 }
9642 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009643 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009644 first = false;
9645 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009646 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009647 if (extras && mExtras != null) {
9648 if (!first) {
9649 b.append(' ');
9650 }
9651 first = false;
9652 b.append("(has extras)");
9653 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009654 if (mContentUserHint != UserHandle.USER_CURRENT) {
9655 if (!first) {
9656 b.append(' ');
9657 }
9658 first = false;
9659 b.append("u=").append(mContentUserHint);
9660 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009661 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009662 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009663 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009664 b.append("}");
9665 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009666 }
9667
Yi Jin129fc6c2017-09-28 15:48:38 -07009668 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009669 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9670 // Same input parameters that toString() gives to toShortString().
9671 writeToProto(proto, fieldId, true, true, true, false);
9672 }
9673
9674 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009675 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9676 boolean extras, boolean clip) {
9677 long token = proto.start(fieldId);
9678 if (mAction != null) {
9679 proto.write(IntentProto.ACTION, mAction);
9680 }
9681 if (mCategories != null) {
9682 for (String category : mCategories) {
9683 proto.write(IntentProto.CATEGORIES, category);
9684 }
9685 }
9686 if (mData != null) {
9687 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9688 }
9689 if (mType != null) {
9690 proto.write(IntentProto.TYPE, mType);
9691 }
9692 if (mFlags != 0) {
9693 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9694 }
9695 if (mPackage != null) {
9696 proto.write(IntentProto.PACKAGE, mPackage);
9697 }
9698 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009699 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009700 }
9701 if (mSourceBounds != null) {
9702 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9703 }
9704 if (mClipData != null) {
9705 StringBuilder b = new StringBuilder();
9706 if (clip) {
9707 mClipData.toShortString(b);
9708 } else {
9709 mClipData.toShortStringShortItems(b, false);
9710 }
9711 proto.write(IntentProto.CLIP_DATA, b.toString());
9712 }
9713 if (extras && mExtras != null) {
9714 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9715 }
9716 if (mContentUserHint != 0) {
9717 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9718 }
9719 if (mSelector != null) {
9720 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9721 }
9722 proto.end(token);
9723 }
9724
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009725 /**
9726 * Call {@link #toUri} with 0 flags.
9727 * @deprecated Use {@link #toUri} instead.
9728 */
9729 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009730 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009731 return toUri(0);
9732 }
9733
9734 /**
9735 * Convert this Intent into a String holding a URI representation of it.
9736 * The returned URI string has been properly URI encoded, so it can be
9737 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9738 * Intent's data as the base URI, with an additional fragment describing
9739 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009740 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009741 * <p>You can convert the returned string back to an Intent with
9742 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009743 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009744 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009745 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009746 * @return Returns a URI encoding URI string describing the entire contents
9747 * of the Intent.
9748 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009749 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009750 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009751 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9752 if (mPackage == null) {
9753 throw new IllegalArgumentException(
9754 "Intent must include an explicit package name to build an android-app: "
9755 + this);
9756 }
9757 uri.append("android-app://");
9758 uri.append(mPackage);
9759 String scheme = null;
9760 if (mData != null) {
9761 scheme = mData.getScheme();
9762 if (scheme != null) {
9763 uri.append('/');
9764 uri.append(scheme);
9765 String authority = mData.getEncodedAuthority();
9766 if (authority != null) {
9767 uri.append('/');
9768 uri.append(authority);
9769 String path = mData.getEncodedPath();
9770 if (path != null) {
9771 uri.append(path);
9772 }
9773 String queryParams = mData.getEncodedQuery();
9774 if (queryParams != null) {
9775 uri.append('?');
9776 uri.append(queryParams);
9777 }
9778 String fragment = mData.getEncodedFragment();
9779 if (fragment != null) {
9780 uri.append('#');
9781 uri.append(fragment);
9782 }
9783 }
9784 }
9785 }
9786 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9787 mPackage, flags);
9788 return uri.toString();
9789 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009790 String scheme = null;
9791 if (mData != null) {
9792 String data = mData.toString();
9793 if ((flags&URI_INTENT_SCHEME) != 0) {
9794 final int N = data.length();
9795 for (int i=0; i<N; i++) {
9796 char c = data.charAt(i);
9797 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009798 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009799 continue;
9800 }
9801 if (c == ':' && i > 0) {
9802 // Valid scheme.
9803 scheme = data.substring(0, i);
9804 uri.append("intent:");
9805 data = data.substring(i+1);
9806 break;
9807 }
Tom Taylord4a47292009-12-21 13:59:18 -08009808
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009809 // No scheme.
9810 break;
9811 }
9812 }
9813 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009814
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009815 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9816 uri.append("intent:");
9817 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009818
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009819 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009820
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009821 return uri.toString();
9822 }
9823
9824 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9825 String defPackage, int flags) {
9826 StringBuilder frag = new StringBuilder(128);
9827
9828 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009829 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009830 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009831 // Note that for now we are not going to try to handle the
9832 // data part; not clear how to represent this as a URI, and
9833 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009834 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9835 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009836 }
9837
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009838 if (frag.length() > 0) {
9839 uri.append("#Intent;");
9840 uri.append(frag);
9841 uri.append("end");
9842 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009843 }
9844
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009845 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9846 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009847 if (scheme != null) {
9848 uri.append("scheme=").append(scheme).append(';');
9849 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009850 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009851 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009852 }
9853 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009854 for (int i=0; i<mCategories.size(); i++) {
9855 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009856 }
9857 }
9858 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009859 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009860 }
9861 if (mFlags != 0) {
9862 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9863 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009864 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009865 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9866 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009867 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009868 uri.append("component=").append(Uri.encode(
9869 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009870 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009871 if (mSourceBounds != null) {
9872 uri.append("sourceBounds=")
9873 .append(Uri.encode(mSourceBounds.flattenToString()))
9874 .append(';');
9875 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009876 if (mExtras != null) {
9877 for (String key : mExtras.keySet()) {
9878 final Object value = mExtras.get(key);
9879 char entryType =
9880 value instanceof String ? 'S' :
9881 value instanceof Boolean ? 'B' :
9882 value instanceof Byte ? 'b' :
9883 value instanceof Character ? 'c' :
9884 value instanceof Double ? 'd' :
9885 value instanceof Float ? 'f' :
9886 value instanceof Integer ? 'i' :
9887 value instanceof Long ? 'l' :
9888 value instanceof Short ? 's' :
9889 '\0';
9890
9891 if (entryType != '\0') {
9892 uri.append(entryType);
9893 uri.append('.');
9894 uri.append(Uri.encode(key));
9895 uri.append('=');
9896 uri.append(Uri.encode(value.toString()));
9897 uri.append(';');
9898 }
9899 }
9900 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009901 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009902
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009903 public int describeContents() {
9904 return (mExtras != null) ? mExtras.describeContents() : 0;
9905 }
9906
9907 public void writeToParcel(Parcel out, int flags) {
9908 out.writeString(mAction);
9909 Uri.writeToParcel(out, mData);
9910 out.writeString(mType);
9911 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009912 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009913 ComponentName.writeToParcel(mComponent, out);
9914
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009915 if (mSourceBounds != null) {
9916 out.writeInt(1);
9917 mSourceBounds.writeToParcel(out, flags);
9918 } else {
9919 out.writeInt(0);
9920 }
9921
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009922 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009923 final int N = mCategories.size();
9924 out.writeInt(N);
9925 for (int i=0; i<N; i++) {
9926 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009927 }
9928 } else {
9929 out.writeInt(0);
9930 }
9931
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009932 if (mSelector != null) {
9933 out.writeInt(1);
9934 mSelector.writeToParcel(out, flags);
9935 } else {
9936 out.writeInt(0);
9937 }
9938
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009939 if (mClipData != null) {
9940 out.writeInt(1);
9941 mClipData.writeToParcel(out, flags);
9942 } else {
9943 out.writeInt(0);
9944 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009945 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009946 out.writeBundle(mExtras);
9947 }
9948
9949 public static final Parcelable.Creator<Intent> CREATOR
9950 = new Parcelable.Creator<Intent>() {
9951 public Intent createFromParcel(Parcel in) {
9952 return new Intent(in);
9953 }
9954 public Intent[] newArray(int size) {
9955 return new Intent[size];
9956 }
9957 };
9958
Dianne Hackborneb034652009-09-07 00:49:58 -07009959 /** @hide */
9960 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009961 readFromParcel(in);
9962 }
9963
9964 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009965 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009966 mData = Uri.CREATOR.createFromParcel(in);
9967 mType = in.readString();
9968 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009969 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009970 mComponent = ComponentName.readFromParcel(in);
9971
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009972 if (in.readInt() != 0) {
9973 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9974 }
9975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009976 int N = in.readInt();
9977 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009978 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009979 int i;
9980 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009981 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009982 }
9983 } else {
9984 mCategories = null;
9985 }
9986
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009987 if (in.readInt() != 0) {
9988 mSelector = new Intent(in);
9989 }
9990
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009991 if (in.readInt() != 0) {
9992 mClipData = new ClipData(in);
9993 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009994 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009995 mExtras = in.readBundle();
9996 }
9997
9998 /**
9999 * Parses the "intent" element (and its children) from XML and instantiates
10000 * an Intent object. The given XML parser should be located at the tag
10001 * where parsing should start (often named "intent"), from which the
10002 * basic action, data, type, and package and class name will be
10003 * retrieved. The function will then parse in to any child elements,
10004 * looking for <category android:name="xxx"> tags to add categories and
10005 * <extra android:name="xxx" android:value="yyy"> to attach extra data
10006 * to the intent.
10007 *
10008 * @param resources The Resources to use when inflating resources.
10009 * @param parser The XML parser pointing at an "intent" tag.
10010 * @param attrs The AttributeSet interface for retrieving extended
10011 * attribute data at the current <var>parser</var> location.
10012 * @return An Intent object matching the XML data.
10013 * @throws XmlPullParserException If there was an XML parsing error.
10014 * @throws IOException If there was an I/O error.
10015 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010016 public static @NonNull Intent parseIntent(@NonNull Resources resources,
10017 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010018 throws XmlPullParserException, IOException {
10019 Intent intent = new Intent();
10020
10021 TypedArray sa = resources.obtainAttributes(attrs,
10022 com.android.internal.R.styleable.Intent);
10023
10024 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
10025
10026 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
10027 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
10028 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
10029
10030 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
10031 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
10032 if (packageName != null && className != null) {
10033 intent.setComponent(new ComponentName(packageName, className));
10034 }
10035
10036 sa.recycle();
10037
10038 int outerDepth = parser.getDepth();
10039 int type;
10040 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
10041 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
10042 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
10043 continue;
10044 }
10045
10046 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -070010047 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010048 sa = resources.obtainAttributes(attrs,
10049 com.android.internal.R.styleable.IntentCategory);
10050 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
10051 sa.recycle();
10052
10053 if (cat != null) {
10054 intent.addCategory(cat);
10055 }
10056 XmlUtils.skipCurrentTag(parser);
10057
Craig Mautner21d24a22014-04-23 11:45:37 -070010058 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010059 if (intent.mExtras == null) {
10060 intent.mExtras = new Bundle();
10061 }
Craig Mautner21d24a22014-04-23 11:45:37 -070010062 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -080010063 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010064
10065 } else {
10066 XmlUtils.skipCurrentTag(parser);
10067 }
10068 }
10069
10070 return intent;
10071 }
Nick Pellyccae4122012-01-09 14:12:58 -080010072
Craig Mautner21d24a22014-04-23 11:45:37 -070010073 /** @hide */
10074 public void saveToXml(XmlSerializer out) throws IOException {
10075 if (mAction != null) {
10076 out.attribute(null, ATTR_ACTION, mAction);
10077 }
10078 if (mData != null) {
10079 out.attribute(null, ATTR_DATA, mData.toString());
10080 }
10081 if (mType != null) {
10082 out.attribute(null, ATTR_TYPE, mType);
10083 }
10084 if (mComponent != null) {
10085 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
10086 }
10087 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
10088
10089 if (mCategories != null) {
10090 out.startTag(null, TAG_CATEGORIES);
10091 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
10092 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
10093 }
Craig Mautner43e52ed2014-06-16 17:18:52 -070010094 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -070010095 }
10096 }
10097
10098 /** @hide */
10099 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
10100 XmlPullParserException {
10101 Intent intent = new Intent();
10102 final int outerDepth = in.getDepth();
10103
10104 int attrCount = in.getAttributeCount();
10105 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10106 final String attrName = in.getAttributeName(attrNdx);
10107 final String attrValue = in.getAttributeValue(attrNdx);
10108 if (ATTR_ACTION.equals(attrName)) {
10109 intent.setAction(attrValue);
10110 } else if (ATTR_DATA.equals(attrName)) {
10111 intent.setData(Uri.parse(attrValue));
10112 } else if (ATTR_TYPE.equals(attrName)) {
10113 intent.setType(attrValue);
10114 } else if (ATTR_COMPONENT.equals(attrName)) {
10115 intent.setComponent(ComponentName.unflattenFromString(attrValue));
10116 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +010010117 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -070010118 } else {
10119 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
10120 }
10121 }
10122
10123 int event;
10124 String name;
10125 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
10126 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
10127 if (event == XmlPullParser.START_TAG) {
10128 name = in.getName();
10129 if (TAG_CATEGORIES.equals(name)) {
10130 attrCount = in.getAttributeCount();
10131 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
10132 intent.addCategory(in.getAttributeValue(attrNdx));
10133 }
10134 } else {
10135 Log.w("Intent", "restoreFromXml: unknown name=" + name);
10136 XmlUtils.skipCurrentTag(in);
10137 }
10138 }
10139 }
10140
10141 return intent;
10142 }
10143
Nick Pellyccae4122012-01-09 14:12:58 -080010144 /**
10145 * Normalize a MIME data type.
10146 *
10147 * <p>A normalized MIME type has white-space trimmed,
10148 * content-type parameters removed, and is lower-case.
10149 * This aligns the type with Android best practices for
10150 * intent filtering.
10151 *
10152 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
10153 * "text/x-vCard" becomes "text/x-vcard".
10154 *
10155 * <p>All MIME types received from outside Android (such as user input,
10156 * or external sources like Bluetooth, NFC, or the Internet) should
10157 * be normalized before they are used to create an Intent.
10158 *
10159 * @param type MIME data type to normalize
10160 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -050010161 * @see #setType
10162 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -080010163 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060010164 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -080010165 if (type == null) {
10166 return null;
10167 }
10168
Elliott Hughescb64d432013-08-02 10:00:44 -070010169 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -080010170
10171 final int semicolonIndex = type.indexOf(';');
10172 if (semicolonIndex != -1) {
10173 type = type.substring(0, semicolonIndex);
10174 }
10175 return type;
10176 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010177
10178 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010179 * Prepare this {@link Intent} to leave an app process.
10180 *
10181 * @hide
10182 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +010010183 @UnsupportedAppUsage
Jeff Sharkey344744b2016-01-28 19:03:30 -070010184 public void prepareToLeaveProcess(Context context) {
10185 final boolean leavingPackage = (mComponent == null)
10186 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
10187 prepareToLeaveProcess(leavingPackage);
10188 }
10189
10190 /**
10191 * Prepare this {@link Intent} to leave an app process.
10192 *
10193 * @hide
10194 */
10195 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010196 setAllowFds(false);
10197
10198 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010199 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010200 }
10201 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010202 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010203 }
10204
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010205 if (mExtras != null && !mExtras.isParcelled()) {
10206 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10207 if (intent instanceof Intent) {
10208 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10209 }
10210 }
10211
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010212 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10213 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010214 switch (mAction) {
10215 case ACTION_MEDIA_REMOVED:
10216 case ACTION_MEDIA_UNMOUNTED:
10217 case ACTION_MEDIA_CHECKING:
10218 case ACTION_MEDIA_NOFS:
10219 case ACTION_MEDIA_MOUNTED:
10220 case ACTION_MEDIA_SHARED:
10221 case ACTION_MEDIA_UNSHARED:
10222 case ACTION_MEDIA_BAD_REMOVAL:
10223 case ACTION_MEDIA_UNMOUNTABLE:
10224 case ACTION_MEDIA_EJECT:
10225 case ACTION_MEDIA_SCANNER_STARTED:
10226 case ACTION_MEDIA_SCANNER_FINISHED:
10227 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010228 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10229 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010230 // Ignore legacy actions
10231 break;
10232 default:
10233 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010234 }
10235 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010236
10237 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10238 && leavingPackage) {
10239 switch (mAction) {
10240 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010241 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010242 // Ignore actions that don't need to grant
10243 break;
10244 default:
10245 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10246 }
10247 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010248 }
10249
10250 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010251 * @hide
10252 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010253 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010254 // We just entered destination process, so we should be able to read all
10255 // parcelables inside.
10256 setDefusable(true);
10257
10258 if (mSelector != null) {
10259 mSelector.prepareToEnterProcess();
10260 }
10261 if (mClipData != null) {
10262 mClipData.prepareToEnterProcess();
10263 }
10264
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010265 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010266 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10267 fixUris(mContentUserHint);
10268 mContentUserHint = UserHandle.USER_CURRENT;
10269 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010270 }
10271 }
10272
Patrick Baumann577d4022018-01-31 16:55:10 +000010273 /** @hide */
10274 public boolean hasWebURI() {
10275 if (getData() == null) {
10276 return false;
10277 }
10278 final String scheme = getScheme();
10279 if (TextUtils.isEmpty(scheme)) {
10280 return false;
10281 }
10282 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10283 }
10284
10285 /** @hide */
Patrick Baumann0da85372018-02-02 16:07:35 -080010286 public boolean isWebIntent() {
Patrick Baumann577d4022018-01-31 16:55:10 +000010287 return ACTION_VIEW.equals(mAction)
Patrick Baumann577d4022018-01-31 16:55:10 +000010288 && hasWebURI();
10289 }
10290
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010291 /**
10292 * @hide
10293 */
10294 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010295 Uri data = getData();
10296 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010297 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010298 }
10299 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010300 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010301 }
10302 String action = getAction();
10303 if (ACTION_SEND.equals(action)) {
10304 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10305 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010306 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010307 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010308 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010309 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10310 if (streams != null) {
10311 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10312 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010313 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010314 }
10315 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10316 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010317 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10318 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10319 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10320 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10321 if (output != null) {
10322 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10323 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010324 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010325 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010326
10327 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010328 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010329 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10330 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010331 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010332 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010333 * @hide
10334 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010335 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010336 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010337 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010338
10339 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010340 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010341
10342 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010343 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010344 // Inspect contained intents to see if we need to migrate extras. We
10345 // don't promote ClipData to the parent, since ChooserActivity will
10346 // already start the picked item as the caller, and we can't combine
10347 // the flags in a safe way.
10348
10349 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010350 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010351 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10352 if (intent != null) {
10353 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010354 }
10355 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010356 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010357 try {
10358 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10359 if (intents != null) {
10360 for (int i = 0; i < intents.length; i++) {
10361 final Intent intent = (Intent) intents[i];
10362 if (intent != null) {
10363 migrated |= intent.migrateExtraStreamToClipData();
10364 }
10365 }
10366 }
10367 } catch (ClassCastException e) {
10368 }
10369 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010370
10371 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010372 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010373 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10374 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10375 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10376 if (stream != null || text != null || htmlText != null) {
10377 final ClipData clipData = new ClipData(
10378 null, new String[] { getType() },
10379 new ClipData.Item(text, htmlText, null, stream));
10380 setClipData(clipData);
10381 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010382 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010383 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010384 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010385 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010386
10387 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010388 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010389 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10390 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10391 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10392 int num = -1;
10393 if (streams != null) {
10394 num = streams.size();
10395 }
10396 if (texts != null) {
10397 if (num >= 0 && num != texts.size()) {
10398 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010399 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010400 }
10401 num = texts.size();
10402 }
10403 if (htmlTexts != null) {
10404 if (num >= 0 && num != htmlTexts.size()) {
10405 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010406 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010407 }
10408 num = htmlTexts.size();
10409 }
10410 if (num > 0) {
10411 final ClipData clipData = new ClipData(
10412 null, new String[] { getType() },
10413 makeClipItem(streams, texts, htmlTexts, 0));
10414
10415 for (int i = 1; i < num; i++) {
10416 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10417 }
10418
10419 setClipData(clipData);
10420 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010421 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010422 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010423 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010424 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010425 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10426 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10427 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10428 final Uri output;
10429 try {
10430 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10431 } catch (ClassCastException e) {
10432 return false;
10433 }
10434 if (output != null) {
10435 setClipData(ClipData.newRawUri("", output));
10436 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10437 return true;
10438 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010439 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010440
10441 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010442 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010443
Michael Wright19859762017-09-18 20:57:58 +010010444 /**
10445 * Convert the dock state to a human readable format.
10446 * @hide
10447 */
10448 public static String dockStateToString(int dock) {
10449 switch (dock) {
10450 case EXTRA_DOCK_STATE_HE_DESK:
10451 return "EXTRA_DOCK_STATE_HE_DESK";
10452 case EXTRA_DOCK_STATE_LE_DESK:
10453 return "EXTRA_DOCK_STATE_LE_DESK";
10454 case EXTRA_DOCK_STATE_CAR:
10455 return "EXTRA_DOCK_STATE_CAR";
10456 case EXTRA_DOCK_STATE_DESK:
10457 return "EXTRA_DOCK_STATE_DESK";
10458 case EXTRA_DOCK_STATE_UNDOCKED:
10459 return "EXTRA_DOCK_STATE_UNDOCKED";
10460 default:
10461 return Integer.toString(dock);
10462 }
10463 }
10464
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010465 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10466 ArrayList<String> htmlTexts, int which) {
10467 Uri uri = streams != null ? streams.get(which) : null;
10468 CharSequence text = texts != null ? texts.get(which) : null;
10469 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10470 return new ClipData.Item(text, htmlText, null, uri);
10471 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010472
10473 /** @hide */
10474 public boolean isDocument() {
10475 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10476 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010477}