blob: 40712f1865f29155c3550491ee9e73d814a4ac6c [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Makoto Onuki7d1911f2017-06-09 12:30:09 -070019import static android.content.ContentProvider.maybeAddUserId;
20
Tor Norbye7b9c9122013-05-30 16:48:33 -070021import android.annotation.AnyRes;
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -070022import android.annotation.BroadcastBehavior;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.NonNull;
25import android.annotation.Nullable;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050030import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060031import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.content.pm.PackageManager;
33import android.content.pm.ResolveInfo;
34import android.content.res.Resources;
35import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080036import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060038import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.os.Bundle;
40import android.os.IBinder;
41import android.os.Parcel;
42import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000043import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050044import android.os.ResultReceiver;
45import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070046import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010047import android.os.UserHandle;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070048import android.provider.ContactsContract.QuickContact;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.OpenableColumns;
Patrick Baumann577d4022018-01-31 16:55:10 +000053import android.text.TextUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050054import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070055import android.util.AttributeSet;
56import android.util.Log;
Yi Jin129fc6c2017-09-28 15:48:38 -070057import android.util.proto.ProtoOutputStream;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070058
Dianne Hackborn2269d1572010-02-24 19:54:22 -080059import com.android.internal.util.XmlUtils;
Makoto Onuki7d1911f2017-06-09 12:30:09 -070060
Jason Monk2f68e8a2016-02-23 17:57:28 -050061import org.xmlpull.v1.XmlPullParser;
62import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070063import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070064
65import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080066import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070067import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070068import java.lang.annotation.Retention;
69import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070import java.net.URISyntaxException;
71import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080072import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070073import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080074import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070075import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070076import java.util.Set;
77
78/**
79 * An intent is an abstract description of an operation to be performed. It
80 * can be used with {@link Context#startActivity(Intent) startActivity} to
81 * launch an {@link android.app.Activity},
82 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
83 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
84 * and {@link android.content.Context#startService} or
85 * {@link android.content.Context#bindService} to communicate with a
86 * background {@link android.app.Service}.
87 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070088 * <p>An Intent provides a facility for performing late runtime binding between the code in
89 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070090 * can be thought of as the glue between activities. It is basically a passive data structure
91 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070092 *
93 * <div class="special reference">
94 * <h3>Developer Guides</h3>
95 * <p>For information about how to create and resolve intents, read the
96 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
97 * developer guide.</p>
98 * </div>
99 *
100 * <a name="IntentStructure"></a>
101 * <h3>Intent Structure</h3>
102 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700103 *
104 * <ul>
105 * <li> <p><b>action</b> -- The general action to be performed, such as
106 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
107 * etc.</p>
108 * </li>
109 * <li> <p><b>data</b> -- The data to operate on, such as a person record
110 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
111 * </li>
112 * </ul>
113 *
114 *
115 * <p>Some examples of action/data pairs are:</p>
116 *
117 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700118 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * information about the person whose identifier is "1".</p>
120 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700121 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700122 * the phone dialer with the person filled in.</p>
123 * </li>
124 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
125 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700126 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700127 * a particular URI.</p>
128 * </li>
129 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
130 * the phone dialer with the given number filled in.</p>
131 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700132 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700133 * information about the person whose identifier is "1".</p>
134 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700135 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700136 * a list of people, which the user can browse through. This example is a
137 * typical top-level entry into the Contacts application, showing you the
138 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700139 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700140 * being used to start an activity to display that person.</p>
141 * </li>
142 * </ul>
143 *
144 * <p>In addition to these primary attributes, there are a number of secondary
145 * attributes that you can also include with an intent:</p>
146 *
147 * <ul>
148 * <li> <p><b>category</b> -- Gives additional information about the action
149 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
150 * appear in the Launcher as a top-level application, while
151 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
152 * of alternative actions the user can perform on a piece of data.</p>
153 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
154 * intent data. Normally the type is inferred from the data itself.
155 * By setting this attribute, you disable that evaluation and force
156 * an explicit type.</p>
157 * <li> <p><b>component</b> -- Specifies an explicit name of a component
158 * class to use for the intent. Normally this is determined by looking
159 * at the other information in the intent (the action, data/type, and
160 * categories) and matching that with a component that can handle it.
161 * If this attribute is set then none of the evaluation is performed,
162 * and this component is used exactly as is. By specifying this attribute,
163 * all of the other Intent attributes become optional.</p>
164 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
165 * This can be used to provide extended information to the component.
166 * For example, if we have a action to send an e-mail message, we could
167 * also include extra pieces of data here to supply a subject, body,
168 * etc.</p>
169 * </ul>
170 *
171 * <p>Here are some examples of other operations you can specify as intents
172 * using these additional parameters:</p>
173 *
174 * <ul>
175 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
176 * Launch the home screen.</p>
177 * </li>
178 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
179 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
180 * vnd.android.cursor.item/phone}</i></b>
181 * -- Display the list of people's phone numbers, allowing the user to
182 * browse through them and pick one and return it to the parent activity.</p>
183 * </li>
184 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
185 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
186 * -- Display all pickers for data that can be opened with
187 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
188 * allowing the user to pick one of them and then some data inside of it
189 * and returning the resulting URI to the caller. This can be used,
190 * for example, in an e-mail application to allow the user to pick some
191 * data to include as an attachment.</p>
192 * </li>
193 * </ul>
194 *
195 * <p>There are a variety of standard Intent action and category constants
196 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700197 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700198 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700199 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700200 *
201 * <p>Put together, the set of actions, data types, categories, and extra data
202 * defines a language for the system allowing for the expression of phrases
203 * such as "call john smith's cell". As applications are added to the system,
204 * they can extend this language by adding new actions, types, and categories, or
205 * they can modify the behavior of existing phrases by supplying their own
206 * activities that handle them.</p>
207 *
208 * <a name="IntentResolution"></a>
209 * <h3>Intent Resolution</h3>
210 *
211 * <p>There are two primary forms of intents you will use.
212 *
213 * <ul>
214 * <li> <p><b>Explicit Intents</b> have specified a component (via
215 * {@link #setComponent} or {@link #setClass}), which provides the exact
216 * class to be run. Often these will not include any other information,
217 * simply being a way for an application to launch various internal
218 * activities it has as the user interacts with the application.
219 *
220 * <li> <p><b>Implicit Intents</b> have not specified a component;
221 * instead, they must include enough information for the system to
222 * determine which of the available components is best to run for that
223 * intent.
224 * </ul>
225 *
226 * <p>When using implicit intents, given such an arbitrary intent we need to
227 * know what to do with it. This is handled by the process of <em>Intent
228 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
229 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
230 * more activities/receivers) that can handle it.</p>
231 *
232 * <p>The intent resolution mechanism basically revolves around matching an
233 * Intent against all of the &lt;intent-filter&gt; descriptions in the
234 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
235 * objects explicitly registered with {@link Context#registerReceiver}.) More
236 * details on this can be found in the documentation on the {@link
237 * IntentFilter} class.</p>
238 *
239 * <p>There are three pieces of information in the Intent that are used for
240 * resolution: the action, type, and category. Using this information, a query
241 * is done on the {@link PackageManager} for a component that can handle the
242 * intent. The appropriate component is determined based on the intent
243 * information supplied in the <code>AndroidManifest.xml</code> file as
244 * follows:</p>
245 *
246 * <ul>
247 * <li> <p>The <b>action</b>, if given, must be listed by the component as
248 * one it handles.</p>
249 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
250 * already supplied in the Intent. Like the action, if a type is
251 * included in the intent (either explicitly or implicitly in its
252 * data), then this must be listed by the component as one it handles.</p>
253 * <li> For data that is not a <code>content:</code> URI and where no explicit
254 * type is included in the Intent, instead the <b>scheme</b> of the
255 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
256 * considered. Again like the action, if we are matching a scheme it
257 * must be listed by the component as one it can handle.
258 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
259 * by the activity as categories it handles. That is, if you include
260 * the categories {@link #CATEGORY_LAUNCHER} and
261 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
262 * with an intent that lists <em>both</em> of those categories.
263 * Activities will very often need to support the
264 * {@link #CATEGORY_DEFAULT} so that they can be found by
265 * {@link Context#startActivity Context.startActivity()}.</p>
266 * </ul>
267 *
268 * <p>For example, consider the Note Pad sample application that
269 * allows user to browse through a list of notes data and view details about
270 * individual items. Text in italics indicate places were you would replace a
271 * name with one specific to your own package.</p>
272 *
273 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
274 * package="<i>com.android.notepad</i>"&gt;
275 * &lt;application android:icon="@drawable/app_notes"
276 * android:label="@string/app_name"&gt;
277 *
278 * &lt;provider class=".NotePadProvider"
279 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
280 *
281 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.MAIN" /&gt;
284 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700285 * &lt;/intent-filter&gt;
286 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700287 * &lt;action android:name="android.intent.action.VIEW" /&gt;
288 * &lt;action android:name="android.intent.action.EDIT" /&gt;
289 * &lt;action android:name="android.intent.action.PICK" /&gt;
290 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
291 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700292 * &lt;/intent-filter&gt;
293 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
295 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
296 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700297 * &lt;/intent-filter&gt;
298 * &lt;/activity&gt;
299 *
300 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
301 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700302 * &lt;action android:name="android.intent.action.VIEW" /&gt;
303 * &lt;action android:name="android.intent.action.EDIT" /&gt;
304 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
305 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700306 * &lt;/intent-filter&gt;
307 *
308 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="android.intent.action.INSERT" /&gt;
310 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
311 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700312 * &lt;/intent-filter&gt;
313 *
314 * &lt;/activity&gt;
315 *
316 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
317 * android:theme="@android:style/Theme.Dialog"&gt;
318 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700319 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
320 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
321 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
322 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
323 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700324 * &lt;/intent-filter&gt;
325 * &lt;/activity&gt;
326 *
327 * &lt;/application&gt;
328 * &lt;/manifest&gt;</pre>
329 *
330 * <p>The first activity,
331 * <code>com.android.notepad.NotesList</code>, serves as our main
332 * entry into the app. It can do three things as described by its three intent
333 * templates:
334 * <ol>
335 * <li><pre>
336 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700337 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This provides a top-level entry into the NotePad application: the standard
341 * MAIN action is a main entry point (not requiring any other information in
342 * the Intent), and the LAUNCHER category says that this entry point should be
343 * listed in the application launcher.</p>
344 * <li><pre>
345 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700346 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
347 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
348 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
349 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700350 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * &lt;/intent-filter&gt;</pre>
352 * <p>This declares the things that the activity can do on a directory of
353 * notes. The type being supported is given with the &lt;type&gt; tag, where
354 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
355 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
356 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
357 * The activity allows the user to view or edit the directory of data (via
358 * the VIEW and EDIT actions), or to pick a particular note and return it
359 * to the caller (via the PICK action). Note also the DEFAULT category
360 * supplied here: this is <em>required</em> for the
361 * {@link Context#startActivity Context.startActivity} method to resolve your
362 * activity when its component name is not explicitly specified.</p>
363 * <li><pre>
364 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700365 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
366 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
367 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700368 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700369 * <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 -0700370 * the user without needing to know where it came from. The data type
371 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
372 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
373 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
374 * The GET_CONTENT action is similar to the PICK action, where the activity
375 * will return to its caller a piece of data selected by the user. Here,
376 * however, the caller specifies the type of data they desire instead of
377 * the type of data the user will be picking from.</p>
378 * </ol>
379 *
380 * <p>Given these capabilities, the following intents will resolve to the
381 * NotesList activity:</p>
382 *
383 * <ul>
384 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
385 * activities that can be used as top-level entry points into an
386 * application.</p>
387 * <li> <p><b>{ action=android.app.action.MAIN,
388 * category=android.app.category.LAUNCHER }</b> is the actual intent
389 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700390 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700391 * data=content://com.google.provider.NotePad/notes }</b>
392 * displays a list of all the notes under
393 * "content://com.google.provider.NotePad/notes", which
394 * the user can browse through and see the details on.</p>
395 * <li> <p><b>{ action=android.app.action.PICK
396 * data=content://com.google.provider.NotePad/notes }</b>
397 * provides a list of the notes under
398 * "content://com.google.provider.NotePad/notes", from which
399 * the user can pick a note whose data URL is returned back to the caller.</p>
400 * <li> <p><b>{ action=android.app.action.GET_CONTENT
401 * type=vnd.android.cursor.item/vnd.google.note }</b>
402 * is similar to the pick action, but allows the caller to specify the
403 * kind of data they want back so that the system can find the appropriate
404 * activity to pick something of that data type.</p>
405 * </ul>
406 *
407 * <p>The second activity,
408 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
409 * note entry and allows them to edit it. It can do two things as described
410 * by its two intent templates:
411 * <ol>
412 * <li><pre>
413 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700414 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
415 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
416 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
417 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700418 * &lt;/intent-filter&gt;</pre>
419 * <p>The first, primary, purpose of this activity is to let the user interact
420 * with a single note, as decribed by the MIME type
421 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
422 * either VIEW a note or allow the user to EDIT it. Again we support the
423 * DEFAULT category to allow the activity to be launched without explicitly
424 * specifying its component.</p>
425 * <li><pre>
426 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700427 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
429 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700430 * &lt;/intent-filter&gt;</pre>
431 * <p>The secondary use of this activity is to insert a new note entry into
432 * an existing directory of notes. This is used when the user creates a new
433 * note: the INSERT action is executed on the directory of notes, causing
434 * this activity to run and have the user create the new note data which
435 * it then adds to the content provider.</p>
436 * </ol>
437 *
438 * <p>Given these capabilities, the following intents will resolve to the
439 * NoteEditor activity:</p>
440 *
441 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700442 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700443 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
444 * shows the user the content of note <var>{ID}</var>.</p>
445 * <li> <p><b>{ action=android.app.action.EDIT
446 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
447 * allows the user to edit the content of note <var>{ID}</var>.</p>
448 * <li> <p><b>{ action=android.app.action.INSERT
449 * data=content://com.google.provider.NotePad/notes }</b>
450 * creates a new, empty note in the notes list at
451 * "content://com.google.provider.NotePad/notes"
452 * and allows the user to edit it. If they keep their changes, the URI
453 * of the newly created note is returned to the caller.</p>
454 * </ul>
455 *
456 * <p>The last activity,
457 * <code>com.android.notepad.TitleEditor</code>, allows the user to
458 * edit the title of a note. This could be implemented as a class that the
459 * application directly invokes (by explicitly setting its component in
460 * the Intent), but here we show a way you can publish alternative
461 * operations on existing data:</p>
462 *
463 * <pre>
464 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700465 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
466 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
467 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
468 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
469 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700470 * &lt;/intent-filter&gt;</pre>
471 *
472 * <p>In the single intent template here, we
473 * have created our own private action called
474 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
475 * edit the title of a note. It must be invoked on a specific note
476 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
477 * view and edit actions, but here displays and edits the title contained
478 * in the note data.
479 *
480 * <p>In addition to supporting the default category as usual, our title editor
481 * also supports two other standard categories: ALTERNATIVE and
482 * SELECTED_ALTERNATIVE. Implementing
483 * these categories allows others to find the special action it provides
484 * without directly knowing about it, through the
485 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
486 * more often to build dynamic menu items with
487 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
488 * template here was also supply an explicit name for the template
489 * (via <code>android:label="@string/resolve_title"</code>) to better control
490 * what the user sees when presented with this activity as an alternative
491 * action to the data they are viewing.
492 *
493 * <p>Given these capabilities, the following intent will resolve to the
494 * TitleEditor activity:</p>
495 *
496 * <ul>
497 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
498 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
499 * displays and allows the user to edit the title associated
500 * with note <var>{ID}</var>.</p>
501 * </ul>
502 *
503 * <h3>Standard Activity Actions</h3>
504 *
505 * <p>These are the current standard actions that Intent defines for launching
506 * activities (usually through {@link Context#startActivity}. The most
507 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
508 * {@link #ACTION_EDIT}.
509 *
510 * <ul>
511 * <li> {@link #ACTION_MAIN}
512 * <li> {@link #ACTION_VIEW}
513 * <li> {@link #ACTION_ATTACH_DATA}
514 * <li> {@link #ACTION_EDIT}
515 * <li> {@link #ACTION_PICK}
516 * <li> {@link #ACTION_CHOOSER}
517 * <li> {@link #ACTION_GET_CONTENT}
518 * <li> {@link #ACTION_DIAL}
519 * <li> {@link #ACTION_CALL}
520 * <li> {@link #ACTION_SEND}
521 * <li> {@link #ACTION_SENDTO}
522 * <li> {@link #ACTION_ANSWER}
523 * <li> {@link #ACTION_INSERT}
524 * <li> {@link #ACTION_DELETE}
525 * <li> {@link #ACTION_RUN}
526 * <li> {@link #ACTION_SYNC}
527 * <li> {@link #ACTION_PICK_ACTIVITY}
528 * <li> {@link #ACTION_SEARCH}
529 * <li> {@link #ACTION_WEB_SEARCH}
530 * <li> {@link #ACTION_FACTORY_TEST}
531 * </ul>
532 *
533 * <h3>Standard Broadcast Actions</h3>
534 *
535 * <p>These are the current standard actions that Intent defines for receiving
536 * broadcasts (usually through {@link Context#registerReceiver} or a
537 * &lt;receiver&gt; tag in a manifest).
538 *
539 * <ul>
540 * <li> {@link #ACTION_TIME_TICK}
541 * <li> {@link #ACTION_TIME_CHANGED}
542 * <li> {@link #ACTION_TIMEZONE_CHANGED}
543 * <li> {@link #ACTION_BOOT_COMPLETED}
544 * <li> {@link #ACTION_PACKAGE_ADDED}
545 * <li> {@link #ACTION_PACKAGE_CHANGED}
546 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800547 * <li> {@link #ACTION_PACKAGE_RESTARTED}
548 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000549 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
550 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 * <li> {@link #ACTION_UID_REMOVED}
552 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700553 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700554 * <li> {@link #ACTION_POWER_DISCONNECTED}
555 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700556 * </ul>
557 *
558 * <h3>Standard Categories</h3>
559 *
560 * <p>These are the current standard categories that can be used to further
561 * clarify an Intent via {@link #addCategory}.
562 *
563 * <ul>
564 * <li> {@link #CATEGORY_DEFAULT}
565 * <li> {@link #CATEGORY_BROWSABLE}
566 * <li> {@link #CATEGORY_TAB}
567 * <li> {@link #CATEGORY_ALTERNATIVE}
568 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
569 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800570 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #CATEGORY_HOME}
572 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400574 * <li> {@link #CATEGORY_CAR_DOCK}
575 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500576 * <li> {@link #CATEGORY_LE_DESK_DOCK}
577 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200578 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700579 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800580 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * </ul>
582 *
583 * <h3>Standard Extra Data</h3>
584 *
585 * <p>These are the current standard fields that can be used as extra data via
586 * {@link #putExtra}.
587 *
588 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_ALARM_COUNT}
590 * <li> {@link #EXTRA_BCC}
591 * <li> {@link #EXTRA_CC}
592 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
593 * <li> {@link #EXTRA_DATA_REMOVED}
594 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500595 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
596 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_DOCK_STATE_CAR}
598 * <li> {@link #EXTRA_DOCK_STATE_DESK}
599 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
600 * <li> {@link #EXTRA_DONT_KILL_APP}
601 * <li> {@link #EXTRA_EMAIL}
602 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700603 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700605 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700607 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800608 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
609 * <li> {@link #EXTRA_REPLACING}
610 * <li> {@link #EXTRA_SHORTCUT_ICON}
611 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
612 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800614 * <li> {@link #EXTRA_SHORTCUT_NAME}
615 * <li> {@link #EXTRA_SUBJECT}
616 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700617 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800618 * <li> {@link #EXTRA_TITLE}
619 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700620 * </ul>
621 *
622 * <h3>Flags</h3>
623 *
624 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800625 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
626 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800628public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700629 private static final String ATTR_ACTION = "action";
630 private static final String TAG_CATEGORIES = "categories";
631 private static final String ATTR_CATEGORY = "category";
632 private static final String TAG_EXTRA = "extra";
633 private static final String ATTR_TYPE = "type";
634 private static final String ATTR_COMPONENT = "component";
635 private static final String ATTR_DATA = "data";
636 private static final String ATTR_FLAGS = "flags";
637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 // ---------------------------------------------------------------------
639 // ---------------------------------------------------------------------
640 // Standard intent activity actions (see action variable).
641
642 /**
643 * Activity Action: Start as a main entry point, does not expect to
644 * receive data.
645 * <p>Input: nothing
646 * <p>Output: nothing
647 */
648 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
649 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700651 /**
652 * Activity Action: Display the data to the user. This is the most common
653 * action performed on data -- it is the generic action you can use on
654 * a piece of data to get the most reasonable thing to occur. For example,
655 * when used on a contacts entry it will view the entry; when used on a
656 * mailto: URI it will bring up a compose window filled with the information
657 * supplied by the URI; when used with a tel: URI it will invoke the
658 * dialer.
659 * <p>Input: {@link #getData} is URI from which to retrieve data.
660 * <p>Output: nothing.
661 */
662 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
663 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800664
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700665 /**
Dianne Hackborna320f012017-04-07 13:57:48 -0700666 * Extra that can be included on activity intents coming from the storage UI
667 * when it launches sub-activities to manage various types of storage. For example,
668 * it may use {@link #ACTION_VIEW} with a "image/*" MIME type to have an app show
669 * the images on the device, and in that case also include this extra to tell the
670 * app it is coming from the storage UI so should help the user manage storage of
671 * this type.
672 */
673 public static final String EXTRA_FROM_STORAGE = "android.intent.extra.FROM_STORAGE";
674
675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
677 * performed on a piece of data.
678 */
679 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800680
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700681 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900682 * Activity Action: Quick view the data. Launches a quick viewer for
683 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900684 * <p>Activities handling this intent action should handle the vast majority of
685 * MIME types rather than only specific ones.
Garfield Tance1d0e92017-03-23 10:52:48 -0700686 * <p>Quick viewers must render the quick view image locally, and must not send
687 * file content outside current device.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900688 * <p>Input: {@link #getData} is a mandatory content URI of the item to
689 * preview. {@link #getClipData} contains an optional list of content URIs
690 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
691 * optional index of the URI in the clip data to show first.
Garfield Tance1d0e92017-03-23 10:52:48 -0700692 * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features
693 * that can be shown in the quick view UI.
Steve McKayc78bcb82015-07-31 14:35:22 -0700694 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900695 * @see #EXTRA_INDEX
Garfield Tance1d0e92017-03-23 10:52:48 -0700696 * @see #EXTRA_QUICK_VIEW_FEATURES
Steve McKayc78bcb82015-07-31 14:35:22 -0700697 */
698 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
699 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
700
701 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 * Used to indicate that some piece of data should be attached to some other
703 * place. For example, image data could be attached to a contact. It is up
704 * to the recipient to decide where the data should be attached; the intent
705 * does not specify the ultimate destination.
706 * <p>Input: {@link #getData} is URI of data to be attached.
707 * <p>Output: nothing.
708 */
709 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
710 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800711
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700712 /**
713 * Activity Action: Provide explicit editable access to the given data.
714 * <p>Input: {@link #getData} is URI of data to be edited.
715 * <p>Output: nothing.
716 */
717 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
718 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 /**
721 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
722 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
723 * The extras can contain type specific data to pass through to the editing/creating
724 * activity.
725 * <p>Output: The URI of the item that was picked. This must be a content:
726 * URI so that any receiver can access it.
727 */
728 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
729 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800730
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700731 /**
732 * Activity Action: Pick an item from the data, returning what was selected.
733 * <p>Input: {@link #getData} is URI containing a directory of data
734 * (vnd.android.cursor.dir/*) from which to pick an item.
735 * <p>Output: The URI of the item that was picked.
736 */
737 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
738 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800739
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700740 /**
741 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800742 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800743 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
744 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700745 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
746 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800747 * (value: ShortcutIconResource).</p>
748 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800749 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700750 * @see #EXTRA_SHORTCUT_INTENT
751 * @see #EXTRA_SHORTCUT_NAME
752 * @see #EXTRA_SHORTCUT_ICON
753 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
757 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
758
759 /**
760 * The name of the extra used to define the Intent of a shortcut.
761 *
762 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800765 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700766 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
767 /**
768 * The name of the extra used to define the name of a shortcut.
769 *
770 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800771 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700772 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800773 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700774 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
775 /**
776 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
777 *
778 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800779 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700780 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800781 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
783 /**
784 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
785 *
786 * @see #ACTION_CREATE_SHORTCUT
787 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800788 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700789 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800790 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700791 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
792 "android.intent.extra.shortcut.ICON_RESOURCE";
793
794 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500795 * An activity that provides a user interface for adjusting application preferences.
796 * Optional but recommended settings for all applications which have settings.
797 */
798 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
799 public static final String ACTION_APPLICATION_PREFERENCES
800 = "android.intent.action.APPLICATION_PREFERENCES";
801
802 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700803 * Activity Action: Launch an activity showing the app information.
804 * For applications which install other applications (such as app stores), it is recommended
805 * to handle this action for providing the app information to the user.
806 *
807 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
808 * to be displayed.
809 * <p>Output: Nothing.
810 */
811 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
812 public static final String ACTION_SHOW_APP_INFO
813 = "android.intent.action.SHOW_APP_INFO";
814
815 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800816 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700817 *
818 * @see Intent#ACTION_CREATE_SHORTCUT
819 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800820 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
821 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700822 */
823 public static class ShortcutIconResource implements Parcelable {
824 /**
825 * The package name of the application containing the icon.
826 */
827 public String packageName;
828
829 /**
830 * The resource name of the icon, including package, name and type.
831 */
832 public String resourceName;
833
834 /**
835 * Creates a new ShortcutIconResource for the specified context and resource
836 * identifier.
837 *
838 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700839 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700841 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700842 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700843 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 ShortcutIconResource icon = new ShortcutIconResource();
845 icon.packageName = context.getPackageName();
846 icon.resourceName = context.getResources().getResourceName(resourceId);
847 return icon;
848 }
849
850 /**
851 * Used to read a ShortcutIconResource from a Parcel.
852 */
853 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
854 new Parcelable.Creator<ShortcutIconResource>() {
855
856 public ShortcutIconResource createFromParcel(Parcel source) {
857 ShortcutIconResource icon = new ShortcutIconResource();
858 icon.packageName = source.readString();
859 icon.resourceName = source.readString();
860 return icon;
861 }
862
863 public ShortcutIconResource[] newArray(int size) {
864 return new ShortcutIconResource[size];
865 }
866 };
867
868 /**
869 * No special parcel contents.
870 */
871 public int describeContents() {
872 return 0;
873 }
874
875 public void writeToParcel(Parcel dest, int flags) {
876 dest.writeString(packageName);
877 dest.writeString(resourceName);
878 }
879
880 @Override
881 public String toString() {
882 return resourceName;
883 }
884 }
885
886 /**
887 * Activity Action: Display an activity chooser, allowing the user to pick
888 * what they want to before proceeding. This can be used as an alternative
889 * to the standard activity picker that is displayed by the system when
890 * you try to start an activity with multiple possible matches, with these
891 * differences in behavior:
892 * <ul>
893 * <li>You can specify the title that will appear in the activity chooser.
894 * <li>The user does not have the option to make one of the matching
895 * activities a preferred activity, and all possible activities will
896 * always be shown even if one of them is currently marked as the
897 * preferred activity.
898 * </ul>
899 * <p>
900 * This action should be used when the user will naturally expect to
901 * select an activity in order to proceed. An example if when not to use
902 * it is when the user clicks on a "mailto:" link. They would naturally
903 * expect to go directly to their mail app, so startActivity() should be
904 * called directly: it will
905 * either launch the current preferred app, or put up a dialog allowing the
906 * user to pick an app to use and optionally marking that as preferred.
907 * <p>
908 * In contrast, if the user is selecting a menu item to send a picture
909 * they are viewing to someone else, there are many different things they
910 * may want to do at this point: send it through e-mail, upload it to a
911 * web service, etc. In this case the CHOOSER action should be used, to
912 * always present to the user a list of the things they can do, with a
913 * nice title given by the caller such as "Send this photo with:".
914 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700915 * If you need to grant URI permissions through a chooser, you must specify
916 * the permissions to be granted on the ACTION_CHOOSER Intent
917 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
918 * {@link #setClipData} to specify the URIs to be granted as well as
919 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
920 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
921 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700922 * As a convenience, an Intent of this form can be created with the
923 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700924 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700925 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
927 * and can optionally have a {@link #EXTRA_TITLE} field containing the
928 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700929 * <p>
930 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 */
932 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
933 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
934
935 /**
936 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
937 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700938 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
939 * target intent, also optionally supplying a title. If the target
940 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
941 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
942 * set in the returned chooser intent, with its ClipData set appropriately:
943 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500944 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700945 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700946 * @param target The Intent that the user will be selecting an activity
947 * to perform.
948 * @param title Optional title that will be displayed in the chooser.
949 * @return Return a new Intent object that you can hand to
950 * {@link Context#startActivity(Intent) Context.startActivity()} and
951 * related methods.
952 */
953 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700954 return createChooser(target, title, null);
955 }
956
957 /**
958 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
959 *
960 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
961 * target intent, also optionally supplying a title. If the target
962 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
963 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
964 * set in the returned chooser intent, with its ClipData set appropriately:
965 * either a direct reflection of {@link #getClipData()} if that is non-null,
966 * or a new ClipData built from {@link #getData()}.</p>
967 *
968 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
969 * when the user makes a choice. This can be useful if the calling application wants
970 * to remember the last chosen target and surface it as a more prominent or one-touch
971 * affordance elsewhere in the UI for next time.</p>
972 *
973 * @param target The Intent that the user will be selecting an activity
974 * to perform.
975 * @param title Optional title that will be displayed in the chooser.
976 * @param sender Optional IntentSender to be called when a choice is made.
977 * @return Return a new Intent object that you can hand to
978 * {@link Context#startActivity(Intent) Context.startActivity()} and
979 * related methods.
980 */
981 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 Intent intent = new Intent(ACTION_CHOOSER);
983 intent.putExtra(EXTRA_INTENT, target);
984 if (title != null) {
985 intent.putExtra(EXTRA_TITLE, title);
986 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700987
Adam Powell0b3c1122014-10-09 12:50:14 -0700988 if (sender != null) {
989 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
990 }
991
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700992 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700993 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
994 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
995 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700996 if (permFlags != 0) {
997 ClipData targetClipData = target.getClipData();
998 if (targetClipData == null && target.getData() != null) {
999 ClipData.Item item = new ClipData.Item(target.getData());
1000 String[] mimeTypes;
1001 if (target.getType() != null) {
1002 mimeTypes = new String[] { target.getType() };
1003 } else {
1004 mimeTypes = new String[] { };
1005 }
1006 targetClipData = new ClipData(null, mimeTypes, item);
1007 }
1008 if (targetClipData != null) {
1009 intent.setClipData(targetClipData);
1010 intent.addFlags(permFlags);
1011 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001012 }
Dianne Hackborne302a162012-05-15 14:58:32 -07001013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001014 return intent;
1015 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001016
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 /**
1018 * Activity Action: Allow the user to select a particular kind of data and
1019 * return it. This is different than {@link #ACTION_PICK} in that here we
1020 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001021 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001022 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001023 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * etc.
1025 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001026 * 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 -07001027 * of data, such as a person contact, you set the MIME type to the kind of
1028 * data you want and launch it with {@link Context#startActivity(Intent)}.
1029 * The system will then launch the best application to select that kind
1030 * of data for you.
1031 * <p>
1032 * You may also be interested in any of a set of types of content the user
1033 * can pick. For example, an e-mail application that wants to allow the
1034 * user to add an attachment to an e-mail message can use this action to
1035 * bring up a list of all of the types of content the user can attach.
1036 * <p>
1037 * In this case, you should wrap the GET_CONTENT intent with a chooser
1038 * (through {@link #createChooser}), which will give the proper interface
1039 * for the user to pick how to send your data and allow you to specify
1040 * a prompt indicating what they are doing. You will usually specify a
1041 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1042 * broad range of content types the user can select from.
1043 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001044 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001045 * only pick from data that can be represented as a stream. This is
1046 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1047 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001048 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001049 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001050 * is locally available on the device. For example, if this extra is set
1051 * to true then an image picker should not show any pictures that are available
1052 * from a remote server but not already on the local device (thus requiring
1053 * they be downloaded when opened).
1054 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001055 * If the caller can handle multiple returned items (the user performing
1056 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1057 * to indicate this.
1058 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1060 * that no URI is supplied in the intent, as there are no constraints on
1061 * where the returned data originally comes from. You may also include the
1062 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001063 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001064 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1065 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001066 * <p>
1067 * Output: The URI of the item that was picked. This must be a content:
1068 * URI so that any receiver can access it.
1069 */
1070 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1071 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1072 /**
1073 * Activity Action: Dial a number as specified by the data. This shows a
1074 * UI with the number being dialed, allowing the user to explicitly
1075 * initiate the call.
1076 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1077 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1078 * number.
1079 * <p>Output: nothing.
1080 */
1081 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1082 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1083 /**
1084 * Activity Action: Perform a call to someone specified by the data.
1085 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1086 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1087 * number.
1088 * <p>Output: nothing.
1089 *
1090 * <p>Note: there will be restrictions on which applications can initiate a
1091 * call; most applications should use the {@link #ACTION_DIAL}.
1092 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1093 * numbers. Applications can <strong>dial</strong> emergency numbers using
1094 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001095 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001096 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001097 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001098 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001099 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_CALL = "android.intent.action.CALL";
1103 /**
1104 * Activity Action: Perform a call to an emergency number specified by the
1105 * data.
1106 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1107 * tel: URI of an explicit phone number.
1108 * <p>Output: nothing.
1109 * @hide
1110 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001111 @SystemApi
1112 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001113 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1114 /**
1115 * Activity action: Perform a call to any number (emergency or not)
1116 * specified by the data.
1117 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1118 * tel: URI of an explicit phone number.
1119 * <p>Output: nothing.
1120 * @hide
1121 */
Brad Ebinger7a8d3522017-03-31 10:21:09 -07001122 @SystemApi
1123 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001124 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
fionaxu77a744c2017-03-17 14:35:39 -07001125
Santos Cordon15a13782015-03-31 18:32:31 -07001126 /**
fionaxuadfe7002017-02-17 17:20:46 -08001127 * Activity Action: Main entry point for carrier setup apps.
1128 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1129 * carrier service and typically require
1130 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1131 * fulfill their duties.
1132 */
1133 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1134 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1135 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001136 * Activity Action: Send a message to someone specified by the data.
1137 * <p>Input: {@link #getData} is URI describing the target.
1138 * <p>Output: nothing.
1139 */
1140 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1141 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1142 /**
1143 * Activity Action: Deliver some data to someone else. Who the data is
1144 * being delivered to is not specified; it is up to the receiver of this
1145 * action to ask the user where the data should be sent.
1146 * <p>
1147 * When launching a SEND intent, you should usually wrap it in a chooser
1148 * (through {@link #createChooser}), which will give the proper interface
1149 * for the user to pick how to send your data and allow you to specify
1150 * a prompt indicating what they are doing.
1151 * <p>
1152 * Input: {@link #getType} is the MIME type of the data being sent.
1153 * get*Extra can have either a {@link #EXTRA_TEXT}
1154 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1155 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1156 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1157 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001158 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1159 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1160 * your text with HTML formatting.
1161 * <p>
1162 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1163 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1164 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1165 * content: URIs and other advanced features of {@link ClipData}. If
1166 * using this approach, you still must supply the same data through the
1167 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1168 * for compatibility with old applications. If you don't set a ClipData,
1169 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001170 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001171 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1172 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1173 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1174 * be openable only as asset typed files using
1175 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1176 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 * Optional standard extras, which may be interpreted by some recipients as
1178 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1179 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1180 * <p>
1181 * Output: nothing.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_SEND = "android.intent.action.SEND";
1185 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001186 * Activity Action: Deliver multiple data to someone else.
1187 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001188 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001189 * <p>
1190 * Input: {@link #getType} is the MIME type of the data being sent.
1191 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001192 * #EXTRA_STREAM} field, containing the data to be sent. If using
1193 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1194 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001195 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001196 * Multiple types are supported, and receivers should handle mixed types
1197 * whenever possible. The right way for the receiver to check them is to
1198 * use the content resolver on each URI. The intent sender should try to
1199 * put the most concrete mime type in the intent type, but it can fall
1200 * back to {@literal <type>/*} or {@literal *}/* as needed.
1201 * <p>
1202 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1203 * be image/jpg, but if you are sending image/jpg and image/png, then the
1204 * intent's type should be image/*.
1205 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001206 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1207 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1208 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1209 * content: URIs and other advanced features of {@link ClipData}. If
1210 * using this approach, you still must supply the same data through the
1211 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1212 * for compatibility with old applications. If you don't set a ClipData,
1213 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1214 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001215 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1216 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1217 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1218 * be openable only as asset typed files using
1219 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1220 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001221 * Optional standard extras, which may be interpreted by some recipients as
1222 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1223 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1224 * <p>
1225 * Output: nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1229 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001230 * Activity Action: Handle an incoming phone call.
1231 * <p>Input: nothing.
1232 * <p>Output: nothing.
1233 */
1234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1235 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1236 /**
1237 * Activity Action: Insert an empty item into the given container.
1238 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1239 * in which to place the data.
1240 * <p>Output: URI of the new data that was created.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1244 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001245 * Activity Action: Create a new item in the given container, initializing it
1246 * from the current contents of the clipboard.
1247 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1248 * in which to place the data.
1249 * <p>Output: URI of the new data that was created.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001254 * Activity Action: Delete the given data from its container.
1255 * <p>Input: {@link #getData} is URI of data to be deleted.
1256 * <p>Output: nothing.
1257 */
1258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1259 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1260 /**
1261 * Activity Action: Run the data, whatever that means.
1262 * <p>Input: ? (Note: this is currently specific to the test harness.)
1263 * <p>Output: nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_RUN = "android.intent.action.RUN";
1267 /**
1268 * Activity Action: Perform a data synchronization.
1269 * <p>Input: ?
1270 * <p>Output: ?
1271 */
1272 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1273 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1274 /**
1275 * Activity Action: Pick an activity given an intent, returning the class
1276 * selected.
1277 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1278 * used with {@link PackageManager#queryIntentActivities} to determine the
1279 * set of activities from which to pick.
1280 * <p>Output: Class name of the activity that was selected.
1281 */
1282 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1283 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1284 /**
1285 * Activity Action: Perform a search.
1286 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1287 * is the text to search for. If empty, simply
1288 * enter your search results Activity with the search UI activated.
1289 * <p>Output: nothing.
1290 */
1291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1292 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1293 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001294 * Activity Action: Start the platform-defined tutorial
1295 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1296 * is the text to search for. If empty, simply
1297 * enter your search results Activity with the search UI activated.
1298 * <p>Output: nothing.
1299 */
1300 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1301 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1302 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001303 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001304 * <p>
1305 * Input: {@link android.app.SearchManager#QUERY
1306 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1307 * a url starts with http or https, the site will be opened. If it is plain
1308 * text, Google search will be applied.
1309 * <p>
1310 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001311 */
1312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1313 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001314
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001315 /**
Jim Miller07994402012-05-02 14:22:27 -07001316 * Activity Action: Perform assist action.
1317 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001318 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1319 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001320 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1321 * information.
Jim Miller07994402012-05-02 14:22:27 -07001322 * Output: nothing.
1323 */
1324 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1325 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001326
1327 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001328 * Activity Action: Perform voice assist action.
1329 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001330 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1331 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001332 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001333 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001334 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001335 */
Amith Yamasani16452032017-03-03 10:15:57 -08001336 @SystemApi
Bjorn Bringertbc086862013-03-01 12:59:24 +00001337 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1338 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1339
1340 /**
Adam Skory7140a252013-09-11 12:04:58 +01001341 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1342 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001343 */
1344 public static final String EXTRA_ASSIST_PACKAGE
1345 = "android.intent.extra.ASSIST_PACKAGE";
1346
1347 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001348 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1349 * application package at the time the assist was invoked.
1350 */
1351 public static final String EXTRA_ASSIST_UID
1352 = "android.intent.extra.ASSIST_UID";
1353
1354 /**
Adam Skory7140a252013-09-11 12:04:58 +01001355 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1356 * information supplied by the current foreground app at the time of the assist request.
1357 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001358 */
1359 public static final String EXTRA_ASSIST_CONTEXT
1360 = "android.intent.extra.ASSIST_CONTEXT";
1361
Jim Miller07994402012-05-02 14:22:27 -07001362 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001363 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1364 * keyboard as the primary input device for assistance.
1365 */
1366 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1367 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1368
1369 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001370 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1371 * that was used to invoke the assist.
1372 */
1373 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1374 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1375
1376 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001377 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001378 * <p>Input: Nothing.
1379 * <p>Output: nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1383 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001384 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001385 * <p>Input: Nothing.
1386 * <p>Output: Nothing.
1387 */
1388 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1389 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1390
1391 /**
1392 * Activity Action: Show activity for reporting a bug.
1393 * <p>Input: Nothing.
1394 * <p>Output: Nothing.
1395 */
1396 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1397 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1398
1399 /**
1400 * Activity Action: Main entry point for factory tests. Only used when
1401 * the device is booting in factory test node. The implementing package
1402 * must be installed in the system image.
1403 * <p>Input: nothing
1404 * <p>Output: nothing
1405 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06001406 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001407 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1408
1409 /**
1410 * Activity Action: The user pressed the "call" button to go to the dialer
1411 * or other appropriate UI for placing a call.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 */
1415 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1416 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1417
1418 /**
1419 * Activity Action: Start Voice Command.
1420 * <p>Input: Nothing.
1421 * <p>Output: Nothing.
1422 */
1423 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1424 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001425
1426 /**
1427 * Activity Action: Start action associated with long pressing on the
1428 * search key.
1429 * <p>Input: Nothing.
1430 * <p>Output: Nothing.
1431 */
1432 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1433 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001434
Jacek Surazski86b6c532009-05-13 14:38:28 +02001435 /**
1436 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1437 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001438 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001439 * <p>Input: No data is specified. The bug report is passed in using
1440 * an {@link #EXTRA_BUG_REPORT} field.
1441 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001442 *
1443 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001444 */
1445 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1446 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001447
1448 /**
1449 * Activity Action: Show power usage information to the user.
1450 * <p>Input: Nothing.
1451 * <p>Output: Nothing.
1452 */
1453 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1454 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001455
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001456 /**
Russell Brenner4cd32e52017-02-24 11:11:47 -08001457 * Activity Action: Setup wizard action provided for OTA provisioning to determine if it needs
1458 * to run.
1459 * <p>Input: Nothing.
1460 * <p>Output: Nothing.
1461 * @deprecated As of {@link android.os.Build.VERSION_CODES#M}, setup wizard can be identified
1462 * using {@link #ACTION_MAIN} and {@link #CATEGORY_SETUP_WIZARD}
1463 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06001464 * @removed
Russell Brenner4cd32e52017-02-24 11:11:47 -08001465 */
1466 @Deprecated
1467 @SystemApi
1468 public static final String ACTION_DEVICE_INITIALIZATION_WIZARD =
1469 "android.intent.action.DEVICE_INITIALIZATION_WIZARD";
1470
1471 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001472 * Activity Action: Setup wizard to launch after a platform update. This
1473 * activity should have a string meta-data field associated with it,
1474 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1475 * the platform for setup. The activity will be launched only if
1476 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1477 * same value.
1478 * <p>Input: Nothing.
1479 * <p>Output: Nothing.
1480 * @hide
1481 */
Russell Brenner4cd32e52017-02-24 11:11:47 -08001482 @SystemApi
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001483 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1484 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001485
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001486 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001487 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1488 * <p>Input: Nothing.
1489 * <p>Output: Nothing.
1490 * @hide
1491 */
1492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1493 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001494 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001495
1496 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001497 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1498 * <p>Input: Nothing.
1499 * <p>Output: Nothing.
1500 * @hide
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
Clara Bayarri847d8682017-03-06 16:48:44 +00001504 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001505
1506 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001507 * Activity Action: Show settings for managing network data usage of a
1508 * specific application. Applications should define an activity that offers
1509 * options to control data usage.
1510 */
1511 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1512 public static final String ACTION_MANAGE_NETWORK_USAGE =
1513 "android.intent.action.MANAGE_NETWORK_USAGE";
1514
1515 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001516 * Activity Action: Launch application installer.
1517 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001518 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001519 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1520 * you can also use "package:<package-name>" to install an application for the
1521 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001522 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1523 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1524 * <p>
1525 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1526 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001527 * <p>
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001528 * <strong>Note:</strong>If your app is targeting API level higher than 25 you
Svet Ganov86877e42015-05-28 08:19:48 -07001529 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1530 * in order to launch the application installer.
1531 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001532 *
1533 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1534 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1535 * @see #EXTRA_RETURN_RESULT
1536 */
1537 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1538 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1539
1540 /**
Todd Kennedyd0084f72017-07-28 13:56:14 -07001541 * Activity Action: Activity to handle split installation failures.
1542 * <p>Splits may be installed dynamically. This happens when an Activity is launched,
1543 * but the split that contains the application isn't installed. When a split is
1544 * installed in this manner, the containing package usually doesn't know this is
1545 * happening. However, if an error occurs during installation, the containing
1546 * package can define a single activity handling this action to deal with such
1547 * failures.
1548 * <p>The activity handling this action must be in the base package.
1549 * <p>
1550 * Input: {@link #EXTRA_INTENT} the original intent that started split installation.
1551 * {@link #EXTRA_SPLIT_NAME} the name of the split that failed to be installed.
1552 */
1553 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1554 public static final String ACTION_INSTALL_FAILURE = "android.intent.action.INSTALL_FAILURE";
1555
1556 /**
Patrick Baumann1e0c9192018-01-31 02:30:36 +00001557 * @hide
1558 * @removed
1559 * @deprecated Do not use. This will go away.
1560 * Replace with {@link #ACTION_INSTALL_INSTANT_APP_PACKAGE}.
1561 */
1562 @SystemApi
1563 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1564 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1565 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1566 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001567 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001568 * <p class="note">
1569 * This is a protected intent that can only be sent by the system.
1570 * </p>
1571 *
1572 * @hide
1573 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001574 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001575 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001576 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1577 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001578
1579 /**
Patrick Baumann1e0c9192018-01-31 02:30:36 +00001580 * @hide
1581 * @removed
1582 * @deprecated Do not use. This will go away.
1583 * Replace with {@link #ACTION_RESOLVE_INSTANT_APP_PACKAGE}.
1584 */
1585 @SystemApi
1586 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1587 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1588 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1589 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001590 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001591 * <p>
1592 * The system will have a persistent connection to this service.
1593 * This is a protected intent that can only be sent by the system.
1594 * </p>
1595 *
1596 * @hide
1597 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001598 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001599 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001600 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1601 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001602
1603 /**
Patrick Baumann1e0c9192018-01-31 02:30:36 +00001604 * @hide
1605 * @removed
1606 * @deprecated Do not use. This will go away.
1607 * Replace with {@link #ACTION_INSTANT_APP_RESOLVER_SETTINGS}.
1608 */
1609 @SystemApi
1610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1611 public static final String ACTION_EPHEMERAL_RESOLVER_SETTINGS
1612 = "android.intent.action.EPHEMERAL_RESOLVER_SETTINGS";
1613 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001614 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001615 *
1616 * <p class="note">
1617 * This is a protected intent that can only be sent by the system.
1618 * </p>
1619 *
1620 * @hide
1621 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001622 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001623 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001624 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1625 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001626
1627 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001628 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1629 * package. Specifies the installer package name; this package will receive the
1630 * {@link #ACTION_APP_ERROR} intent.
1631 */
1632 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1633 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1634
1635 /**
1636 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1637 * package. Specifies that the application being installed should not be
1638 * treated as coming from an unknown source, but as coming from the app
1639 * invoking the Intent. For this to work you must start the installer with
1640 * startActivityForResult().
1641 */
1642 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1643 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1644
1645 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001646 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1647 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001648 * data field originated from.
1649 */
rich cannings706e8ba2012-08-20 13:20:14 -07001650 public static final String EXTRA_ORIGINATING_URI
1651 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001652
1653 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001654 * This extra can be used with any Intent used to launch an activity, supplying information
1655 * about who is launching that activity. This field contains a {@link android.net.Uri}
1656 * object, typically an http: or https: URI of the web site that the referral came from;
1657 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1658 * a native application that it came from.
1659 *
1660 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1661 * instead of directly retrieving the extra. It is also valid for applications to
1662 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1663 * a string, not a Uri; the field here, if supplied, will always take precedence,
1664 * however.</p>
1665 *
1666 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001667 */
1668 public static final String EXTRA_REFERRER
1669 = "android.intent.extra.REFERRER";
1670
1671 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001672 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1673 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1674 * not be created, in particular when Intent extras are supplied through the
1675 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1676 * schemes.
1677 *
1678 * @see #EXTRA_REFERRER
1679 */
1680 public static final String EXTRA_REFERRER_NAME
1681 = "android.intent.extra.REFERRER_NAME";
1682
1683 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001684 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001685 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001686 * Currently only a system app that hosts the provider authority "downloads" or holds the
1687 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001688 * @hide
1689 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001690 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001691 public static final String EXTRA_ORIGINATING_UID
1692 = "android.intent.extra.ORIGINATING_UID";
1693
1694 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001695 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1696 * package. Tells the installer UI to skip the confirmation with the user
1697 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001698 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1699 * will no longer show an interstitial message about updating existing
1700 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001701 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001702 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001703 public static final String EXTRA_ALLOW_REPLACE
1704 = "android.intent.extra.ALLOW_REPLACE";
1705
1706 /**
1707 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1708 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1709 * return to the application the result code of the install/uninstall. The returned result
1710 * code will be {@link android.app.Activity#RESULT_OK} on success or
1711 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1712 */
1713 public static final String EXTRA_RETURN_RESULT
1714 = "android.intent.extra.RETURN_RESULT";
1715
1716 /**
1717 * Package manager install result code. @hide because result codes are not
1718 * yet ready to be exposed.
1719 */
1720 public static final String EXTRA_INSTALL_RESULT
1721 = "android.intent.extra.INSTALL_RESULT";
1722
1723 /**
1724 * Activity Action: Launch application uninstaller.
1725 * <p>
1726 * Input: The data must be a package: URI whose scheme specific part is
1727 * the package name of the current installed package to be uninstalled.
1728 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1729 * <p>
1730 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1731 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001732 * <p>
1733 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1734 * since {@link Build.VERSION_CODES#P}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001735 */
1736 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1737 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1738
1739 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001740 * Specify whether the package should be uninstalled for all users.
1741 * @hide because these should not be part of normal application flow.
1742 */
1743 public static final String EXTRA_UNINSTALL_ALL_USERS
1744 = "android.intent.extra.UNINSTALL_ALL_USERS";
1745
1746 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001747 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1748 * describing the last run version of the platform that was setup.
1749 * @hide
1750 */
1751 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1752
Svet Ganov3695b8a2015-03-24 16:30:25 -07001753 /**
1754 * Activity action: Launch UI to manage the permissions of an app.
1755 * <p>
1756 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1757 * will be managed by the launched UI.
1758 * </p>
1759 * <p>
1760 * Output: Nothing.
1761 * </p>
1762 *
1763 * @see #EXTRA_PACKAGE_NAME
1764 *
1765 * @hide
1766 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001767 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001768 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1769 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1770 "android.intent.action.MANAGE_APP_PERMISSIONS";
1771
1772 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001773 * Activity action: Launch UI to manage permissions.
1774 * <p>
1775 * Input: Nothing.
1776 * </p>
1777 * <p>
1778 * Output: Nothing.
1779 * </p>
1780 *
1781 * @hide
1782 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001783 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001784 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1785 public static final String ACTION_MANAGE_PERMISSIONS =
1786 "android.intent.action.MANAGE_PERMISSIONS";
1787
1788 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001789 * Activity action: Launch UI to review permissions for an app.
1790 * The system uses this intent if permission review for apps not
1791 * supporting the new runtime permissions model is enabled. In
1792 * this mode a permission review is required before any of the
1793 * app components can run.
1794 * <p>
1795 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1796 * permissions will be reviewed (mandatory).
1797 * </p>
1798 * <p>
1799 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1800 * be fired after the permission review (optional).
1801 * </p>
1802 * <p>
1803 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1804 * be invoked after the permission review (optional).
1805 * </p>
1806 * <p>
1807 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1808 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1809 * </p>
1810 * <p>
1811 * Output: Nothing.
1812 * </p>
1813 *
1814 * @see #EXTRA_PACKAGE_NAME
1815 * @see #EXTRA_INTENT
1816 * @see #EXTRA_REMOTE_CALLBACK
1817 * @see #EXTRA_RESULT_NEEDED
1818 *
1819 * @hide
1820 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001821 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001822 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1823 public static final String ACTION_REVIEW_PERMISSIONS =
1824 "android.intent.action.REVIEW_PERMISSIONS";
1825
1826 /**
1827 * Intent extra: A callback for reporting remote result as a bundle.
1828 * <p>
1829 * Type: IRemoteCallback
1830 * </p>
1831 *
1832 * @hide
1833 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001834 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001835 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1836
1837 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001838 * Intent extra: An app package name.
1839 * <p>
1840 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001841 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001842 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001843 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001844 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1845
1846 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001847 * Intent extra: An app split name.
1848 * <p>
1849 * Type: String
1850 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001851 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001852 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1853
1854 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001855 * Intent extra: A {@link ComponentName} value.
1856 * <p>
1857 * Type: String
1858 * </p>
1859 */
1860 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1861
1862 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001863 * Intent extra: An extra for specifying whether a result is needed.
1864 * <p>
1865 * Type: boolean
1866 * </p>
1867 *
1868 * @hide
1869 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001870 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001871 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1872
1873 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001874 * Activity action: Launch UI to manage which apps have a given permission.
1875 * <p>
1876 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1877 * to which will be managed by the launched UI.
1878 * </p>
1879 * <p>
1880 * Output: Nothing.
1881 * </p>
1882 *
1883 * @see #EXTRA_PERMISSION_NAME
1884 *
1885 * @hide
1886 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001887 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001888 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1889 public static final String ACTION_MANAGE_PERMISSION_APPS =
1890 "android.intent.action.MANAGE_PERMISSION_APPS";
1891
1892 /**
1893 * Intent extra: The name of a permission.
1894 * <p>
1895 * Type: String
1896 * </p>
1897 *
1898 * @hide
1899 */
1900 @SystemApi
1901 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1902
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001903 // ---------------------------------------------------------------------
1904 // ---------------------------------------------------------------------
1905 // Standard intent broadcast actions (see action variable).
1906
1907 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001908 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1909 * <p>
1910 * For historical reasons, the name of this broadcast action refers to the power
1911 * state of the screen but it is actually sent in response to changes in the
1912 * overall interactive state of the device.
1913 * </p><p>
1914 * This broadcast is sent when the device becomes non-interactive which may have
1915 * nothing to do with the screen turning off. To determine the
1916 * actual state of the screen, use {@link android.view.Display#getState}.
1917 * </p><p>
1918 * See {@link android.os.PowerManager#isInteractive} for details.
1919 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001920 * You <em>cannot</em> receive this through components declared in
1921 * manifests, only by explicitly registering for it with
1922 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1923 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001924 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001925 * <p class="note">This is a protected intent that can only be sent
1926 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001930
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001932 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1933 * <p>
1934 * For historical reasons, the name of this broadcast action refers to the power
1935 * state of the screen but it is actually sent in response to changes in the
1936 * overall interactive state of the device.
1937 * </p><p>
1938 * This broadcast is sent when the device becomes interactive which may have
1939 * nothing to do with the screen turning on. To determine the
1940 * actual state of the screen, use {@link android.view.Display#getState}.
1941 * </p><p>
1942 * See {@link android.os.PowerManager#isInteractive} for details.
1943 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001944 * You <em>cannot</em> receive this through components declared in
1945 * manifests, only by explicitly registering for it with
1946 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1947 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001948 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001949 * <p class="note">This is a protected intent that can only be sent
1950 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001954
1955 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001956 * Broadcast Action: Sent after the system stops dreaming.
1957 *
1958 * <p class="note">This is a protected intent that can only be sent by the system.
1959 * It is only sent to registered receivers.</p>
1960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1962 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1963
1964 /**
1965 * Broadcast Action: Sent after the system starts dreaming.
1966 *
1967 * <p class="note">This is a protected intent that can only be sent by the system.
1968 * It is only sent to registered receivers.</p>
1969 */
1970 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1971 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1972
1973 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001974 * 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 -07001975 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001976 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001977 * <p class="note">This is a protected intent that can only be sent
1978 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001979 */
1980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001981 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001982
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 /**
1984 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001985 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001986 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001987 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1988 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001989 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001990 * <p class="note">This is a protected intent that can only be sent
1991 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1995 /**
1996 * Broadcast Action: The time was set.
1997 */
1998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1999 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
2000 /**
2001 * Broadcast Action: The date has changed.
2002 */
2003 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2004 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
2005 /**
2006 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
2007 * <ul>
2008 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
2009 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002010 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002011 * <p class="note">This is a protected intent that can only be sent
2012 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
2016 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07002017 * Clear DNS Cache Action: This is broadcast when networks have changed and old
2018 * DNS entries should be tossed.
2019 * @hide
2020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
2023 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002024 * Alarm Changed Action: This is broadcast when the AlarmClock
2025 * application's alarm is set or unset. It is used by the
2026 * AlarmClock application and the StatusBar service.
2027 * @hide
2028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002031
2032 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002033 * Broadcast Action: This is broadcast once, after the user has finished
2034 * booting, but while still in the "locked" state. It can be used to perform
2035 * application-specific initialization, such as installing alarms. You must
2036 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2037 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002038 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002039 * This broadcast is sent immediately at boot by all devices (regardless of
2040 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2041 * higher. Upon receipt of this broadcast, the user is still locked and only
2042 * device-protected storage can be accessed safely. If you want to access
2043 * credential-protected storage, you need to wait for the user to be
2044 * unlocked (typically by entering their lock pattern or PIN for the first
2045 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2046 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2047 * <p>
2048 * To receive this broadcast, your receiver component must be marked as
2049 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002050 * <p class="note">
2051 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002052 *
2053 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002059 * Broadcast Action: This is broadcast once, after the user has finished
2060 * booting. It can be used to perform application-specific initialization,
2061 * such as installing alarms. You must hold the
2062 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2063 * order to receive this broadcast.
2064 * <p>
2065 * This broadcast is sent at boot by all devices (both with and without
2066 * direct boot support). Upon receipt of this broadcast, the user is
2067 * unlocked and both device-protected and credential-protected storage can
2068 * accessed safely.
2069 * <p>
2070 * If you need to run while the user is still locked (before they've entered
2071 * their lock pattern or PIN for the first time), you can listen for the
2072 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2073 * <p class="note">
2074 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002077 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002079
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002080 /**
2081 * Broadcast Action: This is broadcast when a user action should request a
2082 * temporary system dialog to dismiss. Some examples of temporary system
2083 * dialogs are the notification window-shade and the recent tasks dialog.
2084 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002086 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2087 /**
2088 * Broadcast Action: Trigger the download and eventual installation
2089 * of a package.
2090 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002091 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002092 * <p class="note">This is a protected intent that can only be sent
2093 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002094 *
2095 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002097 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2099 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2100 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002101 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002102 * device. The data contains the name of the package. Note that the
2103 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002104 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002105 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002106 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2107 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002108 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2109 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002110 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2116 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002117 * Broadcast Action: A new version of an application package has been
2118 * installed, replacing an existing version that was previously installed.
2119 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002120 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002121 * <ul>
2122 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2123 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002124 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002125 * <p class="note">This is a protected intent that can only be sent
2126 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2130 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002131 * Broadcast Action: A new version of your application has been installed
2132 * over an existing one. This is only sent to the application that was
2133 * replaced. It does not contain any additional data; to receive it, just
2134 * use an intent filter for this action.
2135 *
2136 * <p class="note">This is a protected intent that can only be sent
2137 * by the system.
2138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2140 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2141 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002142 * Broadcast Action: An existing application package has been removed from
2143 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002144 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002145 * <ul>
2146 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2147 * to the package.
2148 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2149 * application -- data and code -- is being removed.
2150 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2151 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2152 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002153 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002154 * <p class="note">This is a protected intent that can only be sent
2155 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2159 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002160 * Broadcast Action: An existing application package has been completely
2161 * removed from the device. The data contains the name of the package.
2162 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2163 * {@link #EXTRA_DATA_REMOVED} is true and
2164 * {@link #EXTRA_REPLACING} is false of that broadcast.
2165 *
2166 * <ul>
2167 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2168 * to the package.
2169 * </ul>
2170 *
2171 * <p class="note">This is a protected intent that can only be sent
2172 * by the system.
2173 */
2174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2175 public static final String ACTION_PACKAGE_FULLY_REMOVED
2176 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2177 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002178 * Broadcast Action: An existing application package has been changed (for
2179 * example, a component has been enabled or disabled). The data contains
2180 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002181 * <ul>
2182 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002183 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002184 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002185 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2186 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002187 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002188 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002189 * <p class="note">This is a protected intent that can only be sent
2190 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2194 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002195 * @hide
2196 * Broadcast Action: Ask system services if there is any reason to
2197 * restart the given package. The data contains the name of the
2198 * package.
2199 * <ul>
2200 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2201 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2202 * </ul>
2203 *
2204 * <p class="note">This is a protected intent that can only be sent
2205 * by the system.
2206 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002207 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2209 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2210 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002211 * Broadcast Action: The user has restarted a package, and all of its
2212 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002213 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002214 * be removed. Note that the restarted package does <em>not</em>
2215 * receive this broadcast.
2216 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002217 * <ul>
2218 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2219 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002220 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002221 * <p class="note">This is a protected intent that can only be sent
2222 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002223 */
2224 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2225 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2226 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002227 * Broadcast Action: The user has cleared the data of a package. This should
2228 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002229 * its persistent data is erased and this broadcast sent.
2230 * Note that the cleared package does <em>not</em>
2231 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002232 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002233 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2234 * package whose data was cleared is an uninstalled instant app, then the UID
2235 * will be -1. The platform keeps some meta-data associated with instant apps
2236 * after they are uninstalled.
2237 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2238 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002239 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002240 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002241 * <p class="note">This is a protected intent that can only be sent
2242 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002243 */
2244 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2245 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2246 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002247 * Broadcast Action: Packages have been suspended.
2248 * <p>Includes the following extras:
2249 * <ul>
2250 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2251 * </ul>
2252 *
2253 * <p class="note">This is a protected intent that can only be sent
2254 * by the system. It is only sent to registered receivers.
2255 */
2256 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2257 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2258 /**
2259 * Broadcast Action: Packages have been unsuspended.
2260 * <p>Includes the following extras:
2261 * <ul>
2262 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2263 * </ul>
2264 *
2265 * <p class="note">This is a protected intent that can only be sent
2266 * by the system. It is only sent to registered receivers.
2267 */
2268 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2269 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2270 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 * Broadcast Action: A user ID has been removed from the system. The user
2272 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002273 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002274 * <p class="note">This is a protected intent that can only be sent
2275 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 */
2277 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2278 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002279
2280 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002281 * Broadcast Action: Sent to the installer package of an application when
2282 * that application is first launched (that is the first time it is moved
2283 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002284 *
2285 * <p class="note">This is a protected intent that can only be sent
2286 * by the system.
2287 */
2288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2289 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2290
2291 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002292 * Broadcast Action: Sent to the system package verifier when a package
2293 * needs to be verified. The data contains the package URI.
2294 * <p class="note">
2295 * This is a protected intent that can only be sent by the system.
2296 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2300
2301 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002302 * Broadcast Action: Sent to the system package verifier when a package is
2303 * verified. The data contains the package URI.
2304 * <p class="note">
2305 * This is a protected intent that can only be sent by the system.
2306 */
2307 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2308 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2309
2310 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002311 * Broadcast Action: Sent to the system intent filter verifier when an
2312 * intent filter needs to be verified. The data contains the filter data
2313 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002314 * <p class="note">
2315 * This is a protected intent that can only be sent by the system.
2316 * </p>
2317 *
2318 * @hide
2319 */
2320 @SystemApi
2321 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2322 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2323
2324 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002325 * Broadcast Action: Resources for a set of packages (which were
2326 * previously unavailable) are currently
2327 * available since the media on which they exist is available.
2328 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2329 * list of packages whose availability changed.
2330 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2331 * list of uids of packages whose availability changed.
2332 * Note that the
2333 * packages in this list do <em>not</em> receive this broadcast.
2334 * The specified set of packages are now available on the system.
2335 * <p>Includes the following extras:
2336 * <ul>
2337 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2338 * whose resources(were previously unavailable) are currently available.
2339 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2340 * packages whose resources(were previously unavailable)
2341 * are currently available.
2342 * </ul>
2343 *
2344 * <p class="note">This is a protected intent that can only be sent
2345 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002346 */
2347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002348 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2349 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002350
2351 /**
2352 * Broadcast Action: Resources for a set of packages are currently
2353 * unavailable since the media on which they exist is unavailable.
2354 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2355 * list of packages whose availability changed.
2356 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2357 * list of uids of packages whose availability changed.
2358 * The specified set of packages can no longer be
2359 * launched and are practically unavailable on the system.
2360 * <p>Inclues the following extras:
2361 * <ul>
2362 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2363 * whose resources are no longer available.
2364 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2365 * whose resources are no longer available.
2366 * </ul>
2367 *
2368 * <p class="note">This is a protected intent that can only be sent
2369 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002370 */
2371 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002372 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002373 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002374
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002375 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002376 * Broadcast Action: preferred activities have changed *explicitly*.
2377 *
2378 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2379 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2380 * be sent.
2381 *
2382 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2383 *
2384 * @hide
2385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2387 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2388 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2389
2390
2391 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002392 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002393 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002394 * This should <em>only</em> be used to determine when the wallpaper
2395 * has changed to show the new wallpaper to the user. You should certainly
2396 * never, in response to this, change the wallpaper or other attributes of
2397 * it such as the suggested size. That would be crazy, right? You'd cause
2398 * all kinds of loops, especially if other apps are doing similar things,
2399 * right? Of course. So please don't do this.
2400 *
2401 * @deprecated Modern applications should use
2402 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2403 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2404 * shown behind their UI, rather than watching for this broadcast and
2405 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002407 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002408 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2409 /**
2410 * Broadcast Action: The current device {@link android.content.res.Configuration}
2411 * (orientation, locale, etc) has changed. When such a change happens, the
2412 * UIs (view hierarchy) will need to be rebuilt based on this new
2413 * information; for the most part, applications don't need to worry about
2414 * this, because the system will take care of stopping and restarting the
2415 * application to make sure it sees the new changes. Some system code that
2416 * can not be restarted will need to watch for this action and handle it
2417 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002418 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002419 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002420 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002421 * in manifests, only by explicitly registering for it with
2422 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2423 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002424 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002425 * <p class="note">This is a protected intent that can only be sent
2426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002427 *
2428 * @see android.content.res.Configuration
2429 */
2430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2431 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2432 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002433 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002434 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002435 * <p class="note">This is a protected intent that can only be sent
2436 * by the system.
2437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2440 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002441 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2442 * charging state, level, and other information about the battery.
2443 * See {@link android.os.BatteryManager} for documentation on the
2444 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002445 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002447 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002448 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002449 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002450 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2451 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2452 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2453 * broadcasts that are sent and can be received through manifest
2454 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002455 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002456 * <p class="note">This is a protected intent that can only be sent
2457 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2461 /**
2462 * Broadcast Action: Indicates low battery condition on the device.
2463 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002464 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002465 * <p class="note">This is a protected intent that can only be sent
2466 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2470 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002471 * Broadcast Action: Indicates the battery is now okay after being low.
2472 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2473 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002474 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002475 * <p class="note">This is a protected intent that can only be sent
2476 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2480 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002481 * Broadcast Action: External power has been connected to the device.
2482 * This is intended for applications that wish to register specifically to this notification.
2483 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2484 * stay active to receive this notification. This action can be used to implement actions
2485 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002486 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002487 * <p class="note">This is a protected intent that can only be sent
2488 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002489 */
2490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002491 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002492 /**
2493 * Broadcast Action: External power has been removed from the device.
2494 * This is intended for applications that wish to register specifically to this notification.
2495 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2496 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002497 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002498 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002499 * <p class="note">This is a protected intent that can only be sent
2500 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002501 */
2502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002503 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002504 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002505 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002506 * Broadcast Action: Device is shutting down.
2507 * This is broadcast when the device is being shut down (completely turned
2508 * off, not sleeping). Once the broadcast is complete, the final shutdown
2509 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002510 * to handle this, since the foreground activity will be paused as well.
Fyodor Kupolov1fc62602018-02-01 15:48:53 -08002511 * <p>As of {@link Build.VERSION_CODES#P} this broadcast is only sent to receivers registered
2512 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2513 * Context.registerReceiver}.
Tom Taylord4a47292009-12-21 13:59:18 -08002514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002515 * <p class="note">This is a protected intent that can only be sent
2516 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002517 * <p>May include the following extras:
2518 * <ul>
2519 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2520 * shutdown is only for userspace processes. If not set, assumed to be false.
2521 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002524 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002525 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002526 * Activity Action: Start this activity to request system shutdown.
2527 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002528 * to request confirmation from the user before shutting down. The optional boolean
2529 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2530 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002531 *
2532 * <p class="note">This is a protected intent that can only be sent
2533 * by the system.
2534 *
2535 * {@hide}
2536 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002537 public static final String ACTION_REQUEST_SHUTDOWN
2538 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002539 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002540 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002541 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002542 * <p class="note">
2543 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002544 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002545 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2546 * or above, this broadcast will no longer be delivered to any
2547 * {@link BroadcastReceiver} defined in your manifest. Instead,
2548 * apps are strongly encouraged to use the improved
2549 * {@link Context#getCacheDir()} behavior so the system can
2550 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 */
2552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002553 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002554 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2555 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002556 * Broadcast Action: Indicates low storage space condition on the device no
2557 * longer exists
2558 * <p class="note">
2559 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002560 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002561 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2562 * or above, this broadcast will no longer be delivered to any
2563 * {@link BroadcastReceiver} defined in your manifest. Instead,
2564 * apps are strongly encouraged to use the improved
2565 * {@link Context#getCacheDir()} behavior so the system can
2566 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002567 */
2568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002569 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002570 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2571 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002572 * Broadcast Action: A sticky broadcast that indicates a storage space full
2573 * condition on the device. This is intended for activities that want to be
2574 * able to fill the data partition completely, leaving only enough free
2575 * space to prevent system-wide SQLite failures.
2576 * <p class="note">
2577 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002578 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002579 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2580 * or above, this broadcast will no longer be delivered to any
2581 * {@link BroadcastReceiver} defined in your manifest. Instead,
2582 * apps are strongly encouraged to use the improved
2583 * {@link Context#getCacheDir()} behavior so the system can
2584 * automatically free up storage when needed.
2585 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002586 */
2587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002588 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002589 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2590 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002591 * Broadcast Action: Indicates storage space full condition on the device no
2592 * longer exists.
2593 * <p class="note">
2594 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002595 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002596 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2597 * or above, this broadcast will no longer be delivered to any
2598 * {@link BroadcastReceiver} defined in your manifest. Instead,
2599 * apps are strongly encouraged to use the improved
2600 * {@link Context#getCacheDir()} behavior so the system can
2601 * automatically free up storage when needed.
2602 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002603 */
2604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002605 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002606 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2607 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2609 * and package management should be started.
2610 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2611 * notification.
2612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2615 /**
2616 * Broadcast Action: The device has entered USB Mass Storage mode.
2617 * This is used mainly for the USB Settings panel.
2618 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2619 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002620 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002622 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2625
2626 /**
2627 * Broadcast Action: The device has exited USB Mass Storage mode.
2628 * This is used mainly for the USB Settings panel.
2629 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2630 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002631 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002632 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002633 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002634 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002635 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2636
2637 /**
2638 * Broadcast Action: External media has been removed.
2639 * The path to the mount point for the removed media is contained in the Intent.mData field.
2640 */
2641 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2642 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2643
2644 /**
2645 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002646 * 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 -07002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2649 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2650
2651 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002652 * Broadcast Action: External media is present, and being disk-checked
2653 * 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 -08002654 */
2655 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2656 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2657
2658 /**
2659 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2660 * 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 -08002661 */
2662 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2663 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2664
2665 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002666 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002667 * 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 -07002668 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2669 * media was mounted read only.
2670 */
2671 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2672 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2673
2674 /**
2675 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002676 * 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 -07002677 */
2678 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2679 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2680
2681 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002682 * Broadcast Action: External media is no longer being shared via USB mass storage.
2683 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2684 *
2685 * @hide
2686 */
2687 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2688
2689 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2691 * The path to the mount point for the removed media is contained in the Intent.mData field.
2692 */
2693 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2694 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2695
2696 /**
2697 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002698 * 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 -07002699 */
2700 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2701 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2702
2703 /**
2704 * Broadcast Action: User has expressed the desire to remove the external storage media.
2705 * Applications should close all files they have open within the mount point when they receive this intent.
2706 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2707 */
2708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2709 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2710
2711 /**
2712 * Broadcast Action: The media scanner has started scanning a directory.
2713 * The path to the directory being scanned is contained in the Intent.mData field.
2714 */
2715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2716 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2717
2718 /**
2719 * Broadcast Action: The media scanner has finished scanning a directory.
2720 * The path to the scanned directory is contained in the Intent.mData field.
2721 */
2722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2723 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2724
2725 /**
2726 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2727 * The path to the file is contained in the Intent.mData field.
2728 */
2729 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2730 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2731
2732 /**
2733 * Broadcast Action: The "Media Button" was pressed. Includes a single
2734 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2735 * caused the broadcast.
2736 */
2737 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2738 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2739
2740 /**
2741 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2742 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2743 * caused the broadcast.
2744 */
2745 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2746 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2747
2748 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2749 // location; they are not general-purpose actions.
2750
2751 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002752 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002753 */
2754 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2755 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2756 "android.intent.action.GTALK_CONNECTED";
2757
2758 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002759 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002760 */
2761 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2762 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2763 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002764
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002765 /**
2766 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002767 */
2768 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2769 public static final String ACTION_INPUT_METHOD_CHANGED =
2770 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002771
2772 /**
2773 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2774 * more radios have been turned off or on. The intent will have the following extra value:</p>
2775 * <ul>
2776 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2777 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2778 * turned off</li>
2779 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002780 *
Peng Xua35b5532016-01-20 00:05:45 -08002781 * <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 -07002782 */
2783 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2784 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2785
2786 /**
2787 * Broadcast Action: Some content providers have parts of their namespace
2788 * where they publish new events or items that the user may be especially
2789 * interested in. For these things, they may broadcast this action when the
2790 * set of interesting items change.
2791 *
2792 * For example, GmailProvider sends this notification when the set of unread
2793 * mail in the inbox changes.
2794 *
2795 * <p>The data of the intent identifies which part of which provider
2796 * changed. When queried through the content resolver, the data URI will
2797 * return the data set in question.
2798 *
2799 * <p>The intent will have the following extra values:
2800 * <ul>
2801 * <li><em>count</em> - The number of items in the data set. This is the
2802 * same as the number of items in the cursor returned by querying the
2803 * data URI. </li>
2804 * </ul>
2805 *
2806 * This intent will be sent at boot (if the count is non-zero) and when the
2807 * data set changes. It is possible for the data set to change without the
2808 * count changing (for example, if a new unread message arrives in the same
2809 * sync operation in which a message is archived). The phone should still
2810 * ring/vibrate/etc as normal in this case.
2811 */
2812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2813 public static final String ACTION_PROVIDER_CHANGED =
2814 "android.intent.action.PROVIDER_CHANGED";
2815
2816 /**
2817 * Broadcast Action: Wired Headset plugged in or unplugged.
2818 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002819 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2820 * and documentation.
2821 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002822 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002823 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002824 */
2825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002826 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002827
2828 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002829 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2830 * <ul>
2831 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2832 * </ul>
2833 *
2834 * <p class="note">This is a protected intent that can only be sent
2835 * by the system.
2836 *
2837 * @hide
2838 */
2839 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2840 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2841 = "android.intent.action.ADVANCED_SETTINGS";
2842
2843 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002844 * Broadcast Action: Sent after application restrictions are changed.
2845 *
2846 * <p class="note">This is a protected intent that can only be sent
2847 * by the system.</p>
2848 */
2849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2850 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2851 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2852
2853 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002854 * Broadcast Action: An outgoing call is about to be placed.
2855 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002856 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002858 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 * the phone number originally intended to be dialed.</li>
2860 * </ul>
2861 * <p>Once the broadcast is finished, the resultData is used as the actual
2862 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002863 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002864 * outgoing call in turn: for example, a parental control application
2865 * might verify that the user is authorized to place the call at that
2866 * time, then a number-rewriting application might add an area code if
2867 * one was not specified.</p>
2868 * <p>For consistency, any receiver whose purpose is to prohibit phone
2869 * calls should have a priority of 0, to ensure it will see the final
2870 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002871 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002872 * should have a positive priority.
2873 * Negative priorities are reserved for the system for this broadcast;
2874 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002875 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2876 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002877 * <p>Emergency calls cannot be intercepted using this mechanism, and
2878 * other calls cannot be modified to call emergency numbers using this
2879 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002880 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2881 * call to use their own service instead. Those apps should first prevent
2882 * the call from being placed by setting resultData to <code>null</code>
2883 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002884 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002885 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2886 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002887 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002888 * <p class="note">This is a protected intent that can only be sent
2889 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002890 */
2891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2892 public static final String ACTION_NEW_OUTGOING_CALL =
2893 "android.intent.action.NEW_OUTGOING_CALL";
2894
2895 /**
2896 * Broadcast Action: Have the device reboot. This is only for use by
2897 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002899 * <p class="note">This is a protected intent that can only be sent
2900 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002901 */
2902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2903 public static final String ACTION_REBOOT =
2904 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002905
Wei Huang97ecc9c2009-05-11 17:44:20 -07002906 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002907 * Broadcast Action: A sticky broadcast for changes in the physical
2908 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002909 *
2910 * <p>The intent will have the following extra values:
2911 * <ul>
2912 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002913 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002914 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002915 * <p>This is intended for monitoring the current physical dock state.
2916 * See {@link android.app.UiModeManager} for the normal API dealing with
2917 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002918 */
2919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2920 public static final String ACTION_DOCK_EVENT =
2921 "android.intent.action.DOCK_EVENT";
2922
2923 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002924 * Broadcast Action: A broadcast when idle maintenance can be started.
2925 * This means that the user is not interacting with the device and is
2926 * not expected to do so soon. Typical use of the idle maintenance is
2927 * to perform somehow expensive tasks that can be postponed at a moment
2928 * when they will not degrade user experience.
2929 * <p>
2930 * <p class="note">In order to keep the device responsive in case of an
2931 * unexpected user interaction, implementations of a maintenance task
2932 * should be interruptible. In such a scenario a broadcast with action
2933 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2934 * should not do the maintenance work in
2935 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2936 * maintenance service by {@link Context#startService(Intent)}. Also
2937 * you should hold a wake lock while your maintenance service is running
2938 * to prevent the device going to sleep.
2939 * </p>
2940 * <p>
2941 * <p class="note">This is a protected intent that can only be sent by
2942 * the system.
2943 * </p>
2944 *
2945 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002946 *
2947 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002948 */
2949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2950 public static final String ACTION_IDLE_MAINTENANCE_START =
2951 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2952
2953 /**
2954 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2955 * This means that the user was not interacting with the device as a result
2956 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2957 * was sent and now the user started interacting with the device. Typical
2958 * use of the idle maintenance is to perform somehow expensive tasks that
2959 * can be postponed at a moment when they will not degrade user experience.
2960 * <p>
2961 * <p class="note">In order to keep the device responsive in case of an
2962 * unexpected user interaction, implementations of a maintenance task
2963 * should be interruptible. Hence, on receiving a broadcast with this
2964 * action, the maintenance task should be interrupted as soon as possible.
2965 * In other words, you should not do the maintenance work in
2966 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2967 * maintenance service that was started on receiving of
2968 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2969 * lock you acquired when your maintenance service started.
2970 * </p>
2971 * <p class="note">This is a protected intent that can only be sent
2972 * by the system.
2973 *
2974 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002975 *
2976 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002977 */
2978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2979 public static final String ACTION_IDLE_MAINTENANCE_END =
2980 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2981
2982 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002983 * Broadcast Action: a remote intent is to be broadcasted.
2984 *
2985 * A remote intent is used for remote RPC between devices. The remote intent
2986 * is serialized and sent from one device to another device. The receiving
2987 * device parses the remote intent and broadcasts it. Note that anyone can
2988 * broadcast a remote intent. However, if the intent receiver of the remote intent
2989 * does not trust intent broadcasts from arbitrary intent senders, it should require
2990 * the sender to hold certain permissions so only trusted sender's broadcast will be
2991 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002992 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002993 */
2994 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002995 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002996
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002997 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002998 * Broadcast Action: This is broadcast once when the user is booting after a
2999 * system update. It can be used to perform cleanup or upgrades after a
3000 * system update.
3001 * <p>
3002 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3003 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3004 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3005 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003006 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003007 * @hide
3008 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003009 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003010 public static final String ACTION_PRE_BOOT_COMPLETED =
3011 "android.intent.action.PRE_BOOT_COMPLETED";
3012
Amith Yamasani13593602012-03-22 16:16:17 -07003013 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003014 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003015 * on restricted users. The broadcast intent contains an extra
3016 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3017 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3018 * String[] depending on the restriction type.<p/>
3019 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003020 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3021 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3022 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003023 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3024 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003025 * @see RestrictionEntry
3026 */
3027 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3028 "android.intent.action.GET_RESTRICTION_ENTRIES";
3029
3030 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003031 * Sent the first time a user is starting, to allow system apps to
3032 * perform one time initialization. (This will not be seen by third
3033 * party applications because a newly initialized user does not have any
3034 * third party applications installed for it.) This is sent early in
3035 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003036 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3037 * broadcast, since it is part of a visible user interaction; be as quick
3038 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003039 */
3040 public static final String ACTION_USER_INITIALIZE =
3041 "android.intent.action.USER_INITIALIZE";
3042
3043 /**
3044 * Sent when a user switch is happening, causing the process's user to be
3045 * brought to the foreground. This is only sent to receivers registered
3046 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3047 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003048 * foreground. This is sent as a foreground
3049 * broadcast, since it is part of a visible user interaction; be as quick
3050 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003051 */
3052 public static final String ACTION_USER_FOREGROUND =
3053 "android.intent.action.USER_FOREGROUND";
3054
3055 /**
3056 * Sent when a user switch is happening, causing the process's user to be
3057 * sent to the background. This is only sent to receivers registered
3058 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3059 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003060 * background. This is sent as a foreground
3061 * broadcast, since it is part of a visible user interaction; be as quick
3062 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003063 */
3064 public static final String ACTION_USER_BACKGROUND =
3065 "android.intent.action.USER_BACKGROUND";
3066
3067 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003068 * Broadcast sent to the system when a user is added. Carries an extra
3069 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3070 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003071 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003072 * @hide
3073 */
3074 public static final String ACTION_USER_ADDED =
3075 "android.intent.action.USER_ADDED";
3076
3077 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003078 * Broadcast sent by the system when a user is started. Carries an extra
3079 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003080 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003081 * that has been started. This is sent as a foreground
3082 * broadcast, since it is part of a visible user interaction; be as quick
3083 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003084 * @hide
3085 */
3086 public static final String ACTION_USER_STARTED =
3087 "android.intent.action.USER_STARTED";
3088
3089 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003090 * Broadcast sent when a user is in the process of starting. Carries an extra
3091 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3092 * sent to registered receivers, not manifest receivers. It is sent to all
3093 * users (including the one that is being started). You must hold
3094 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3095 * this broadcast. This is sent as a background broadcast, since
3096 * its result is not part of the primary UX flow; to safely keep track of
3097 * started/stopped state of a user you can use this in conjunction with
3098 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3099 * other user state broadcasts since those are foreground broadcasts so can
3100 * execute in a different order.
3101 * @hide
3102 */
3103 public static final String ACTION_USER_STARTING =
3104 "android.intent.action.USER_STARTING";
3105
3106 /**
3107 * Broadcast sent when a user is going to be stopped. Carries an extra
3108 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3109 * sent to registered receivers, not manifest receivers. It is sent to all
3110 * users (including the one that is being stopped). You must hold
3111 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3112 * this broadcast. The user will not stop until all receivers have
3113 * handled the broadcast. This is sent as a background broadcast, since
3114 * its result is not part of the primary UX flow; to safely keep track of
3115 * started/stopped state of a user you can use this in conjunction with
3116 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3117 * other user state broadcasts since those are foreground broadcasts so can
3118 * execute in a different order.
3119 * @hide
3120 */
3121 public static final String ACTION_USER_STOPPING =
3122 "android.intent.action.USER_STOPPING";
3123
3124 /**
3125 * Broadcast sent to the system when a user is stopped. Carries an extra
3126 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3127 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3128 * specific package. This is only sent to registered receivers, not manifest
3129 * receivers. It is sent to all running users <em>except</em> the one that
3130 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003131 * @hide
3132 */
3133 public static final String ACTION_USER_STOPPED =
3134 "android.intent.action.USER_STOPPED";
3135
3136 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003137 * 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 -07003138 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003139 * one that has been removed. The user will not be completely removed until all receivers have
3140 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003141 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003142 * @hide
3143 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003144 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003145 public static final String ACTION_USER_REMOVED =
3146 "android.intent.action.USER_REMOVED";
3147
3148 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003149 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003150 * the userHandle of the user to become the current one. This is only sent to
3151 * registered receivers, not manifest receivers. It is sent to all running users.
3152 * You must hold
3153 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003154 * @hide
3155 */
3156 public static final String ACTION_USER_SWITCHED =
3157 "android.intent.action.USER_SWITCHED";
3158
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003159 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003160 * Broadcast Action: Sent when the credential-encrypted private storage has
3161 * become unlocked for the target user. This is only sent to registered
3162 * receivers, not manifest receivers.
3163 */
3164 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3165 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3166
3167 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003168 * Broadcast sent to the system when a user's information changes. Carries an extra
3169 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003170 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003171 * @hide
3172 */
3173 public static final String ACTION_USER_INFO_CHANGED =
3174 "android.intent.action.USER_INFO_CHANGED";
3175
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003176 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003177 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3178 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003179 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3180 * that need to display merged content across both primary and managed profiles need to
3181 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003182 * not manifest receivers.
3183 */
3184 public static final String ACTION_MANAGED_PROFILE_ADDED =
3185 "android.intent.action.MANAGED_PROFILE_ADDED";
3186
3187 /**
3188 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003189 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3190 * Only applications (for example Launchers) that need to display merged content across both
3191 * primary and managed profiles need to worry about this broadcast. This is only sent to
3192 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003193 */
3194 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3195 "android.intent.action.MANAGED_PROFILE_REMOVED";
3196
3197 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003198 * Broadcast sent to the primary user when the credential-encrypted private storage for
3199 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3200 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3201 * Launchers) that need to display merged content across both primary and managed profiles
3202 * need to worry about this broadcast. This is only sent to registered receivers,
3203 * not manifest receivers.
3204 */
3205 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3206 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3207
3208 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003209 * Broadcast sent to the primary user when an associated managed profile has become available.
3210 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003211 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3212 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3213 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003214 */
Rubin Xue95057a2016-04-01 16:49:25 +01003215 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3216 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3217
3218 /**
3219 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3220 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3221 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3222 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3223 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3224 */
3225 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3226 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003227
3228 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003229 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3230 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3231 * the device was locked or unlocked.
3232 *
3233 * This is only sent to registered receivers.
3234 *
3235 * @hide
3236 */
3237 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3238 "android.intent.action.DEVICE_LOCKED_CHANGED";
3239
3240 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003241 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3242 */
3243 public static final String ACTION_QUICK_CLOCK =
3244 "android.intent.action.QUICK_CLOCK";
3245
Michael Wright0087a142013-02-05 16:29:39 -08003246 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003247 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003248 * @hide
3249 */
3250 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003251 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003252
Justin Kohd378ad72013-04-01 12:18:26 -07003253 /**
3254 * Broadcast Action: A global button was pressed. Includes a single
3255 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3256 * caused the broadcast.
3257 * @hide
3258 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003259 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003260 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3261
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003262 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003263 * Broadcast Action: Sent when media resource is granted.
3264 * <p>
3265 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3266 * granted.
3267 * </p>
3268 * <p class="note">
3269 * This is a protected intent that can only be sent by the system.
3270 * </p>
3271 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003272 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003273 * </p>
3274 *
3275 * @hide
3276 */
3277 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3278 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3279
3280 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003281 * Broadcast Action: An overlay package has changed. The data contains the
3282 * name of the overlay package which has changed. This is broadcast on all
3283 * changes to the OverlayInfo returned by {@link
3284 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3285 * most common change is a state change that will change whether the
3286 * overlay is enabled or not.
3287 * @hide
3288 */
3289 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3290
3291 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003292 * Activity Action: Allow the user to select and return one or more existing
3293 * documents. When invoked, the system will display the various
3294 * {@link DocumentsProvider} instances installed on the device, letting the
3295 * user interactively navigate through them. These documents include local
3296 * media, such as photos and video, and documents provided by installed
3297 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003298 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003299 * Each document is represented as a {@code content://} URI backed by a
3300 * {@link DocumentsProvider}, which can be opened as a stream with
3301 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3302 * {@link android.provider.DocumentsContract.Document} metadata.
3303 * <p>
3304 * All selected documents are returned to the calling application with
3305 * persistable read and write permission grants. If you want to maintain
3306 * access to the documents across device reboots, you need to explicitly
3307 * take the persistable permissions using
3308 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3309 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003310 * Callers must indicate the acceptable document MIME types through
3311 * {@link #setType(String)}. For example, to select photos, use
3312 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3313 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3314 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003315 * <p>
3316 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003317 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3318 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003319 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003320 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3321 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003322 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003323 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003324 * Callers can set a document URI through
3325 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3326 * location of documents navigator. System will do its best to launch the
3327 * navigator in the specified document if it's a folder, or the folder that
3328 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003329 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003330 * Output: The URI of the item that was picked, returned in
3331 * {@link #getData()}. This must be a {@code content://} URI so that any
3332 * receiver can access it. If multiple documents were selected, they are
3333 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003334 *
3335 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003336 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003337 * @see #ACTION_CREATE_DOCUMENT
3338 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003339 */
3340 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3341 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3342
3343 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003344 * Activity Action: Allow the user to create a new document. When invoked,
3345 * the system will display the various {@link DocumentsProvider} instances
3346 * installed on the device, letting the user navigate through them. The
3347 * returned document may be a newly created document with no content, or it
3348 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003349 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003350 * Each document is represented as a {@code content://} URI backed by a
3351 * {@link DocumentsProvider}, which can be opened as a stream with
3352 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3353 * {@link android.provider.DocumentsContract.Document} metadata.
3354 * <p>
3355 * Callers must indicate the concrete MIME type of the document being
3356 * created by setting {@link #setType(String)}. This MIME type cannot be
3357 * changed after the document is created.
3358 * <p>
3359 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3360 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003361 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003362 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3363 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003364 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003365 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003366 * Callers can set a document URI through
3367 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3368 * location of documents navigator. System will do its best to launch the
3369 * navigator in the specified document if it's a folder, or the folder that
3370 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003371 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003372 * Output: The URI of the item that was created. This must be a
3373 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003374 *
3375 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003376 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003377 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003378 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003379 */
3380 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3381 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3382
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003383 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003384 * Activity Action: Allow the user to pick a directory subtree. When
3385 * invoked, the system will display the various {@link DocumentsProvider}
3386 * instances installed on the device, letting the user navigate through
3387 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003388 * <p>
3389 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003390 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3391 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3392 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003393 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003394 * Callers can set a document URI through
3395 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3396 * location of documents navigator. System will do its best to launch the
3397 * navigator in the specified document if it's a folder, or the folder that
3398 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003399 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003400 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003401 *
3402 * @see DocumentsContract
3403 */
3404 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003405 public static final String
3406 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003407
Felipe Lemec7b1f892016-01-15 15:02:31 -08003408 /**
Peng Xua35b5532016-01-20 00:05:45 -08003409 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3410 * exisiting sensor being disconnected.
3411 *
3412 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3413 *
3414 * {@hide}
3415 */
3416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3417 public static final String
3418 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3419
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003420 /**
Sam Line707f832017-04-13 17:00:55 -07003421 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003422 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003423 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003424 */
3425 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003426 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003427 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3428
Christopher Tate6597e342015-02-17 12:15:25 -08003429 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003430 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3431 * is about to be performed.
3432 * @hide
3433 */
3434 @SystemApi
3435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3436 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3437 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3438
3439 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003440 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3441 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3442 *
3443 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3444 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003445 * @hide
3446 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003447 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003448 public static final String EXTRA_FORCE_MASTER_CLEAR =
3449 "android.intent.extra.FORCE_MASTER_CLEAR";
3450
3451 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003452 * A broadcast action to trigger a factory reset.
3453 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003454 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3455 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003456 *
3457 * <p>Not for use by third-party applications.
3458 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003459 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003460 *
3461 * {@hide}
3462 */
3463 @SystemApi
3464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3465 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3466
3467 /**
3468 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3469 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3470 *
3471 * <p>Not for use by third-party applications.
3472 *
3473 * @hide
3474 */
3475 @SystemApi
3476 public static final String EXTRA_FORCE_FACTORY_RESET =
3477 "android.intent.extra.FORCE_FACTORY_RESET";
3478
3479 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003480 * Broadcast action: report that a settings element is being restored from backup. The intent
3481 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3482 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3483 * is the value of that settings entry prior to the restore operation, and
3484 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3485 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3486 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003487 *
3488 * <p>This broadcast is sent only for settings provider entries known to require special handling
3489 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3490 * the provider's backup agent implementation.
3491 *
3492 * @see #EXTRA_SETTING_NAME
3493 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3494 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003495 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003496 * {@hide}
3497 */
3498 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3499
3500 /** {@hide} */
3501 public static final String EXTRA_SETTING_NAME = "setting_name";
3502 /** {@hide} */
3503 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3504 /** {@hide} */
3505 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003506 /** {@hide} */
3507 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003508
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003509 /**
3510 * Activity Action: Process a piece of text.
3511 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3512 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3513 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3514 */
3515 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3516 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003517
3518 /**
3519 * Broadcast Action: The sim card state has changed.
3520 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3521 * because TelephonyIntents is an internal class.
3522 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003523 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3524 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003525 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003526 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003527 @SystemApi
3528 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3529 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3530
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003531 /**
fionaxu90fee272017-03-31 12:45:12 -07003532 * Broadcast Action: indicate that the phone service state has changed.
3533 * The intent will have the following extra values:</p>
3534 * <p>
3535 * @see #EXTRA_VOICE_REG_STATE
3536 * @see #EXTRA_DATA_REG_STATE
3537 * @see #EXTRA_VOICE_ROAMING_TYPE
3538 * @see #EXTRA_DATA_ROAMING_TYPE
3539 * @see #EXTRA_OPERATOR_ALPHA_LONG
3540 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3541 * @see #EXTRA_OPERATOR_NUMERIC
3542 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3543 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3544 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3545 * @see #EXTRA_MANUAL
3546 * @see #EXTRA_VOICE_RADIO_TECH
3547 * @see #EXTRA_DATA_RADIO_TECH
3548 * @see #EXTRA_CSS_INDICATOR
3549 * @see #EXTRA_NETWORK_ID
3550 * @see #EXTRA_SYSTEM_ID
3551 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3552 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3553 * @see #EXTRA_EMERGENCY_ONLY
3554 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3555 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3556 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3557 *
3558 * <p class="note">
3559 * Requires the READ_PHONE_STATE permission.
3560 *
3561 * <p class="note">This is a protected intent that can only be sent by the system.
3562 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003563 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003564 */
3565 @Deprecated
3566 @SystemApi
3567 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3568 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3569
3570 /**
3571 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3572 * state.
3573 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3574 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3575 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3576 * @see android.telephony.ServiceState#STATE_POWER_OFF
3577 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003578 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003579 */
3580 @Deprecated
3581 @SystemApi
3582 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3583
3584 /**
3585 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3586 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3587 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3588 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3589 * @see android.telephony.ServiceState#STATE_POWER_OFF
3590 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003591 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003592 */
3593 @Deprecated
3594 @SystemApi
3595 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3596
3597 /**
3598 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3599 * type.
3600 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003601 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003602 */
3603 @Deprecated
3604 @SystemApi
3605 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3606
3607 /**
3608 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3609 * type.
3610 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003611 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003612 */
3613 @Deprecated
3614 @SystemApi
3615 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3616
3617 /**
3618 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3619 * registered voice operator name in long alphanumeric format.
3620 * {@code null} if the operator name is not known or unregistered.
3621 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003622 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003623 */
3624 @Deprecated
3625 @SystemApi
3626 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3627
3628 /**
3629 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3630 * registered voice operator name in short alphanumeric format.
3631 * {@code null} if the operator name is not known or unregistered.
3632 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003633 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003634 */
3635 @Deprecated
3636 @SystemApi
3637 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3638
3639 /**
3640 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3641 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3642 * network.
3643 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003644 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003645 */
3646 @Deprecated
3647 @SystemApi
3648 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3649
3650 /**
3651 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3652 * registered data operator name in long alphanumeric format.
3653 * {@code null} if the operator name is not known or unregistered.
3654 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003655 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003656 */
3657 @Deprecated
3658 @SystemApi
3659 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3660
3661 /**
3662 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3663 * registered data operator name in short alphanumeric format.
3664 * {@code null} if the operator name is not known or unregistered.
3665 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003666 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003667 */
3668 @Deprecated
3669 @SystemApi
3670 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3671
3672 /**
3673 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3674 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3675 * data operator.
3676 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003677 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003678 */
3679 @Deprecated
3680 @SystemApi
3681 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3682
3683 /**
3684 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3685 * network selection mode is manual.
3686 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3687 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003688 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003689 */
3690 @Deprecated
3691 @SystemApi
3692 public static final String EXTRA_MANUAL = "manual";
3693
3694 /**
3695 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3696 * radio technology.
3697 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003698 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003699 */
3700 @Deprecated
3701 @SystemApi
3702 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3703
3704 /**
3705 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3706 * radio technology.
3707 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003708 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003709 */
3710 @Deprecated
3711 @SystemApi
3712 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3713
3714 /**
3715 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3716 * support on CDMA network.
3717 * Will be {@code true} if support, {@code false} otherwise.
3718 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003719 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003720 */
3721 @Deprecated
3722 @SystemApi
3723 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3724
3725 /**
3726 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3727 * id. {@code Integer.MAX_VALUE} if unknown.
3728 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003729 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003730 */
3731 @Deprecated
3732 @SystemApi
3733 public static final String EXTRA_NETWORK_ID = "networkId";
3734
3735 /**
3736 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3737 * {@code Integer.MAX_VALUE} if unknown.
3738 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003739 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003740 */
3741 @Deprecated
3742 @SystemApi
3743 public static final String EXTRA_SYSTEM_ID = "systemId";
3744
3745 /**
3746 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3747 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3748 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003749 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003750 */
3751 @Deprecated
3752 @SystemApi
3753 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3754
3755 /**
3756 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3757 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3758 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003759 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003760 */
3761 @Deprecated
3762 @SystemApi
3763 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3764
3765 /**
3766 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3767 * only mode.
3768 * {@code true} if in emergency only mode, {@code false} otherwise.
3769 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003770 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003771 */
3772 @Deprecated
3773 @SystemApi
3774 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3775
3776 /**
3777 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3778 * registration state is roaming.
3779 * {@code true} if registration indicates roaming, {@code false} otherwise
3780 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003781 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003782 */
3783 @Deprecated
3784 @SystemApi
3785 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3786 "isDataRoamingFromRegistration";
3787
3788 /**
3789 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3790 * aggregation is in use.
3791 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3792 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003793 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003794 */
3795 @Deprecated
3796 @SystemApi
3797 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3798
3799 /**
3800 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3801 * is reduced from the rsrp threshold while calculating signal strength level.
3802 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003803 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003804 */
3805 @Deprecated
3806 @SystemApi
3807 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3808
3809 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003810 * The name of the extra used to define the text to be processed, as a
3811 * CharSequence. Note that this may be a styled CharSequence, so you must use
3812 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003813 */
3814 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3815 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003816 * 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 +00003817 */
3818 public static final String EXTRA_PROCESS_TEXT_READONLY =
3819 "android.intent.extra.PROCESS_TEXT_READONLY";
3820
Bryce Leebc58f592015-09-25 16:43:01 -07003821 /**
3822 * Broadcast action: reports when a new thermal event has been reached. When the device
3823 * is reaching its maximum temperatue, the thermal level reported
3824 * {@hide}
3825 */
3826 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3827 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3828
3829 /** {@hide} */
3830 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3831
3832 /**
3833 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003834 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003835 * {@hide}
3836 */
3837 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3838
3839 /**
3840 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003841 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003842 * {@hide}
3843 */
3844 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3845
3846 /**
3847 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003848 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003849 * {@hide}
3850 */
3851 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3852
3853
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003854 // ---------------------------------------------------------------------
3855 // ---------------------------------------------------------------------
3856 // Standard intent categories (see addCategory()).
3857
3858 /**
3859 * Set if the activity should be an option for the default action
3860 * (center press) to perform on a piece of data. Setting this will
3861 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003862 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003863 * Intent when initiating an action -- it is for use in intent filters
3864 * specified in packages.
3865 */
3866 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3867 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3868 /**
3869 * Activities that can be safely invoked from a browser must support this
3870 * category. For example, if the user is viewing a web page or an e-mail
3871 * and clicks on a link in the text, the Intent generated execute that
3872 * link will require the BROWSABLE category, so that only activities
3873 * supporting this category will be considered as possible actions. By
3874 * supporting this category, you are promising that there is nothing
3875 * damaging (without user intervention) that can happen by invoking any
3876 * matching Intent.
3877 */
3878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3879 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3880 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003881 * Categories for activities that can participate in voice interaction.
3882 * An activity that supports this category must be prepared to run with
3883 * no UI shown at all (though in some case it may have a UI shown), and
3884 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3885 */
3886 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3887 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3888 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003889 * Set if the activity should be considered as an alternative action to
3890 * the data the user is currently viewing. See also
3891 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3892 * applies to the selection in a list of items.
3893 *
3894 * <p>Supporting this category means that you would like your activity to be
3895 * displayed in the set of alternative things the user can do, usually as
3896 * part of the current activity's options menu. You will usually want to
3897 * include a specific label in the &lt;intent-filter&gt; of this action
3898 * describing to the user what it does.
3899 *
3900 * <p>The action of IntentFilter with this category is important in that it
3901 * describes the specific action the target will perform. This generally
3902 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3903 * a specific name such as "com.android.camera.action.CROP. Only one
3904 * alternative of any particular action will be shown to the user, so using
3905 * a specific action like this makes sure that your alternative will be
3906 * displayed while also allowing other applications to provide their own
3907 * overrides of that particular action.
3908 */
3909 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3910 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3911 /**
3912 * Set if the activity should be considered as an alternative selection
3913 * action to the data the user has currently selected. This is like
3914 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3915 * of items from which the user can select, giving them alternatives to the
3916 * default action that will be performed on it.
3917 */
3918 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3919 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3920 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003921 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922 */
3923 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3924 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003926 * Should be displayed in the top-level launcher.
3927 */
3928 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3929 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3930 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003931 * Indicates an activity optimized for Leanback mode, and that should
3932 * be displayed in the Leanback launcher.
3933 */
3934 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3935 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3936 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08003937 * Indicates the preferred entry-point activity when an application is launched from a Car
3938 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
3939 * fallback, or exclude the application entirely.
3940 * @hide
3941 */
3942 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3943 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
3944 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003945 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3946 * @hide
3947 */
3948 @SystemApi
3949 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3950 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003951 * Provides information about the package it is in; typically used if
3952 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3953 * a front-door to the user without having to be shown in the all apps list.
3954 */
3955 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3956 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3957 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 * This is the home activity, that is the first activity that is displayed
3959 * when the device boots.
3960 */
3961 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3962 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3963 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003964 * This is the home activity that is displayed when the device is finished setting up and ready
3965 * for use.
3966 * @hide
3967 */
3968 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3969 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3970 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003971 * This is the setup wizard activity, that is the first activity that is displayed
3972 * when the user sets up the device for the first time.
3973 * @hide
3974 */
3975 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3976 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3977 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07003978 * This is the home activity, that is the activity that serves as the launcher app
3979 * from there the user can start other apps. Often components with lower/higher
3980 * priority intent filters handle the home intent, for example SetupWizard, to
3981 * setup the device and we need to be able to distinguish the home app from these
3982 * setup helpers.
3983 * @hide
3984 */
3985 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3986 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
3987 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003988 * This activity is a preference panel.
3989 */
3990 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3991 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3992 /**
3993 * This activity is a development preference panel.
3994 */
3995 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3996 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3997 /**
3998 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003999 */
4000 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4001 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
4002 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004003 * This activity allows the user to browse and download new applications.
4004 */
4005 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4006 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4007 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004008 * This activity may be exercised by the monkey or other automated test tools.
4009 */
4010 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4011 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4012 /**
4013 * To be used as a test (not part of the normal user experience).
4014 */
4015 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4016 /**
4017 * To be used as a unit test (run through the Test Harness).
4018 */
4019 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4020 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004021 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004022 * experience).
4023 */
4024 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004026 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004027 * Used to indicate that an intent only wants URIs that can be opened with
4028 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4029 * must support at least the columns defined in {@link OpenableColumns} when
4030 * queried.
4031 *
4032 * @see #ACTION_GET_CONTENT
4033 * @see #ACTION_OPEN_DOCUMENT
4034 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004035 */
4036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4037 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4038
4039 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004040 * Used to indicate that an intent filter can accept files which are not necessarily
4041 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4042 * at least streamable via
4043 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4044 * using one of the stream types exposed via
4045 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4046 *
4047 * @see #ACTION_SEND
4048 * @see #ACTION_SEND_MULTIPLE
4049 */
4050 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4051 public static final String CATEGORY_TYPED_OPENABLE =
4052 "android.intent.category.TYPED_OPENABLE";
4053
4054 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004055 * To be used as code under test for framework instrumentation tests.
4056 */
4057 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4058 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004059 /**
4060 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004061 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4062 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004063 */
4064 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4065 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4066 /**
4067 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004068 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4069 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004070 */
4071 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4072 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004073 /**
4074 * An activity to run when device is inserted into a analog (low end) dock.
4075 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4076 * information, see {@link android.app.UiModeManager}.
4077 */
4078 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4079 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4080
4081 /**
4082 * An activity to run when device is inserted into a digital (high end) dock.
4083 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4084 * information, see {@link android.app.UiModeManager}.
4085 */
4086 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4087 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004088
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004089 /**
4090 * Used to indicate that the activity can be used in a car environment.
4091 */
4092 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4093 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4094
Zak Cohendb6ca492017-01-26 14:09:00 -08004095 /**
4096 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4097 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4098 * information, see {@link android.app.UiModeManager}.
4099 */
4100 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4101 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004102 // ---------------------------------------------------------------------
4103 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004104 // Application launch intent categories (see addCategory()).
4105
4106 /**
4107 * Used with {@link #ACTION_MAIN} to launch the browser application.
4108 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004109 * <p>NOTE: This should not be used as the primary key of an Intent,
4110 * since it will not result in the app launching with the correct
4111 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004112 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004113 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004114 */
4115 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4116 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4117
4118 /**
4119 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4120 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004121 * <p>NOTE: This should not be used as the primary key of an Intent,
4122 * since it will not result in the app launching with the correct
4123 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004124 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004125 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004126 */
4127 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4128 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4129
4130 /**
4131 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4132 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004133 * <p>NOTE: This should not be used as the primary key of an Intent,
4134 * since it will not result in the app launching with the correct
4135 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004136 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004137 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004138 */
4139 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4140 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4141
4142 /**
4143 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4144 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004145 * <p>NOTE: This should not be used as the primary key of an Intent,
4146 * since it will not result in the app launching with the correct
4147 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004148 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004149 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004150 */
4151 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4152 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4153
4154 /**
4155 * Used with {@link #ACTION_MAIN} to launch the email application.
4156 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004157 * <p>NOTE: This should not be used as the primary key of an Intent,
4158 * since it will not result in the app launching with the correct
4159 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004160 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004161 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004162 */
4163 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4164 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4165
4166 /**
4167 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4168 * The activity should be able to view and manipulate image and video files
4169 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004170 * <p>NOTE: This should not be used as the primary key of an Intent,
4171 * since it will not result in the app launching with the correct
4172 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004173 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004174 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004175 */
4176 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4177 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4178
4179 /**
4180 * Used with {@link #ACTION_MAIN} to launch the maps application.
4181 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004182 * <p>NOTE: This should not be used as the primary key of an Intent,
4183 * since it will not result in the app launching with the correct
4184 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004185 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004186 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004187 */
4188 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4189 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4190
4191 /**
4192 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4193 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004194 * <p>NOTE: This should not be used as the primary key of an Intent,
4195 * since it will not result in the app launching with the correct
4196 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004197 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004198 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004199 */
4200 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4201 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4202
4203 /**
4204 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004205 * The activity should be able to play, browse, or manipulate music files
4206 * stored on the device.
4207 * <p>NOTE: This should not be used as the primary key of an Intent,
4208 * since it will not result in the app launching with the correct
4209 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004210 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004211 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004212 */
4213 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4214 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4215
4216 // ---------------------------------------------------------------------
4217 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004218 // Standard extra data keys.
4219
4220 /**
4221 * The initial data to place in a newly created record. Use with
4222 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4223 * fields as would be given to the underlying ContentProvider.insert()
4224 * call.
4225 */
4226 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4227
4228 /**
4229 * A constant CharSequence that is associated with the Intent, used with
4230 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4231 * this may be a styled CharSequence, so you must use
4232 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4233 * retrieve it.
4234 */
4235 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4236
4237 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004238 * A constant String that is associated with the Intent, used with
4239 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4240 * as HTML formatted text. Note that you <em>must</em> also supply
4241 * {@link #EXTRA_TEXT}.
4242 */
4243 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4244
4245 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004246 * A content: URI holding a stream of data associated with the Intent,
4247 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004248 */
4249 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4250
4251 /**
4252 * A String[] holding e-mail addresses that should be delivered to.
4253 */
4254 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4255
4256 /**
4257 * A String[] holding e-mail addresses that should be carbon copied.
4258 */
4259 public static final String EXTRA_CC = "android.intent.extra.CC";
4260
4261 /**
4262 * A String[] holding e-mail addresses that should be blind carbon copied.
4263 */
4264 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4265
4266 /**
4267 * A constant string holding the desired subject line of a message.
4268 */
4269 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4270
4271 /**
4272 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004273 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004274 */
4275 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4276
4277 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004278 * An int representing the user id to be used.
4279 *
4280 * @hide
4281 */
4282 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4283
4284 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004285 * An int representing the task id to be retrieved. This is used when a launch from recents is
4286 * intercepted by another action such as credentials confirmation to remember which task should
4287 * be resumed when complete.
4288 *
4289 * @hide
4290 */
4291 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4292
4293 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004294 * An Intent[] describing additional, alternate choices you would like shown with
4295 * {@link #ACTION_CHOOSER}.
4296 *
4297 * <p>An app may be capable of providing several different payload types to complete a
4298 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4299 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4300 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4301 * photo data or a hosted link where the photos can be viewed.</p>
4302 *
4303 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4304 * first/primary/preferred intent in the set. Additional intents specified in
4305 * this extra are ordered; by default intents that appear earlier in the array will be
4306 * preferred over intents that appear later in the array as matches for the same
4307 * target component. To alter this preference, a calling app may also supply
4308 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4309 */
4310 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4311
4312 /**
Adam Powell52c39212016-04-07 15:14:18 -07004313 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4314 * and omitted from a list of components presented to the user.
4315 *
4316 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4317 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4318 * from your own package or other apps from your organization if the idea of sending to those
4319 * targets would be redundant with other app functionality. Filtered components will not
4320 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4321 */
4322 public static final String EXTRA_EXCLUDE_COMPONENTS
4323 = "android.intent.extra.EXCLUDE_COMPONENTS";
4324
4325 /**
4326 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4327 * describing additional high-priority deep-link targets for the chooser to present to the user.
4328 *
4329 * <p>Targets provided in this way will be presented inline with all other targets provided
4330 * by services from other apps. They will be prioritized before other service targets, but
4331 * after those targets provided by sources that the user has manually pinned to the front.</p>
4332 *
4333 * @see #ACTION_CHOOSER
4334 */
4335 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4336
4337 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004338 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4339 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4340 *
4341 * <p>An app preparing an action for another app to complete may wish to allow the user to
4342 * disambiguate between several options for completing the action based on the chosen target
4343 * or otherwise refine the action before it is invoked.
4344 * </p>
4345 *
4346 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4347 * <ul>
4348 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4349 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4350 * chosen target beyond the first</li>
4351 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4352 * should fill in and send once the disambiguation is complete</li>
4353 * </ul>
4354 */
4355 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4356 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4357
4358 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004359 * An {@code ArrayList} of {@code String} annotations describing content for
4360 * {@link #ACTION_CHOOSER}.
4361 *
4362 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4363 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4364 *
4365 * <p>Annotations should describe the major components or topics of the content. It is up to
4366 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4367 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004368 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4369 * character. Performance on customized annotations can suffer, if they are rarely used for
4370 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4371 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004372 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004373 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004374 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004375 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004376 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004377 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004378 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004379 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004380 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004381 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4382 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4383 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4384 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4385 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004386 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004387 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4388 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004389 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004390 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004391 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004392 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004393 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004394 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004395 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004396 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004397 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004398 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004399 * Christmas and Thanksgiving.</li>
4400 * </ul>
4401 */
4402 public static final String EXTRA_CONTENT_ANNOTATIONS
4403 = "android.intent.extra.CONTENT_ANNOTATIONS";
4404
4405 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004406 * A {@link ResultReceiver} used to return data back to the sender.
4407 *
4408 * <p>Used to complete an app-specific
4409 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4410 *
4411 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4412 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4413 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4414 * when the user selects a target component from the chooser. It is up to the recipient
4415 * to send a result to this ResultReceiver to signal that disambiguation is complete
4416 * and that the chooser should invoke the user's choice.</p>
4417 *
4418 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4419 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4420 * to match and fill in the final Intent or ChooserTarget before starting it.
4421 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4422 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4423 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4424 *
4425 * <p>The result code passed to the ResultReceiver should be
4426 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4427 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4428 * the chooser should finish without starting a target.</p>
4429 */
4430 public static final String EXTRA_RESULT_RECEIVER
4431 = "android.intent.extra.RESULT_RECEIVER";
4432
4433 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004434 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004435 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004436 */
4437 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4438
4439 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004440 * A Parcelable[] of {@link Intent} or
4441 * {@link android.content.pm.LabeledIntent} objects as set with
4442 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4443 * a the front of the list of choices, when shown to the user with a
4444 * {@link #ACTION_CHOOSER}.
4445 */
4446 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4447
4448 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004449 * A {@link IntentSender} to start after ephemeral installation success.
4450 * @hide
4451 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004452 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4453
4454 /**
4455 * A {@link IntentSender} to start after ephemeral installation failure.
4456 * @hide
4457 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004458 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4459
4460 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004461 * The host name that triggered an ephemeral resolution.
4462 * @hide
4463 */
4464 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4465
4466 /**
4467 * An opaque token to track ephemeral resolution.
4468 * @hide
4469 */
4470 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4471
4472 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004473 * The action that triggered an instant application resolution.
4474 * @hide
4475 */
4476 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4477
4478 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004479 * An array of {@link Bundle}s containing details about resolved instant apps..
4480 * @hide
4481 */
4482 @SystemApi
4483 public static final String EXTRA_INSTANT_APP_BUNDLES =
4484 "android.intent.extra.INSTANT_APP_BUNDLES";
4485
4486 /**
4487 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004488 * installed. This data is populated from the response to
4489 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4490 * instant application resolver.
4491 * @hide
4492 */
4493 public static final String EXTRA_INSTANT_APP_EXTRAS =
4494 "android.intent.extra.INSTANT_APP_EXTRAS";
4495
4496 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004497 * A boolean value indicating that the instant app resolver was unable to state with certainty
4498 * that it did or did not have an app for the sanitized {@link Intent} defined at
4499 * {@link #EXTRA_INTENT}.
4500 * @hide
4501 */
4502 @SystemApi
4503 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4504 "android.intent.extra.UNKNOWN_INSTANT_APP";
4505
4506 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004507 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004508 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004509 * @hide
4510 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004511 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004512 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4513
4514 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004515 * The version code of the app to install components from.
4516 * @hide
4517 */
4518 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4519
4520 /**
Chad Brubaker06068612017-04-06 09:43:47 -07004521 * The app that triggered the ephemeral installation.
4522 * @hide
4523 */
4524 public static final String EXTRA_CALLING_PACKAGE
4525 = "android.intent.extra.CALLING_PACKAGE";
4526
4527 /**
4528 * Optional calling app provided bundle containing additional launch information the
4529 * installer may use.
4530 * @hide
4531 */
4532 public static final String EXTRA_VERIFICATION_BUNDLE
4533 = "android.intent.extra.VERIFICATION_BUNDLE";
4534
4535 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004536 * A Bundle forming a mapping of potential target package names to different extras Bundles
4537 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4538 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4539 * be currently installed on the device.
4540 *
4541 * <p>An application may choose to provide alternate extras for the case where a user
4542 * selects an activity from a predetermined set of target packages. If the activity
4543 * the user selects from the chooser belongs to a package with its package name as
4544 * a key in this bundle, the corresponding extras for that package will be merged with
4545 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4546 * extra has the same key as an extra already present in the intent it will overwrite
4547 * the extra from the intent.</p>
4548 *
4549 * <p><em>Examples:</em>
4550 * <ul>
4551 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4552 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4553 * parameters for that target.</li>
4554 * <li>An application may offer additional metadata for known targets of a given intent
4555 * to pass along information only relevant to that target such as account or content
4556 * identifiers already known to that application.</li>
4557 * </ul></p>
4558 */
4559 public static final String EXTRA_REPLACEMENT_EXTRAS =
4560 "android.intent.extra.REPLACEMENT_EXTRAS";
4561
4562 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004563 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4564 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4565 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4566 * {@link ComponentName} of the chosen component.
4567 *
4568 * <p>In some situations this callback may never come, for example if the user abandons
4569 * the chooser, switches to another task or any number of other reasons. Apps should not
4570 * be written assuming that this callback will always occur.</p>
4571 */
4572 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4573 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4574
4575 /**
4576 * The {@link ComponentName} chosen by the user to complete an action.
4577 *
4578 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4579 */
4580 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4581
4582 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004583 * A {@link android.view.KeyEvent} object containing the event that
4584 * triggered the creation of the Intent it is in.
4585 */
4586 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4587
4588 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004589 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4590 * before shutting down.
4591 *
4592 * {@hide}
4593 */
4594 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4595
4596 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004597 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4598 * requested by the user.
4599 *
4600 * {@hide}
4601 */
4602 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4603 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4604
4605 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004606 * 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 -07004607 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4608 * of restarting the application.
4609 */
4610 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4611
4612 /**
4613 * A String holding the phone number originally entered in
4614 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4615 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4616 */
4617 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004619 /**
4620 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4621 * intents to supply the uid the package had been assigned. Also an optional
4622 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4623 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4624 * purpose.
4625 */
4626 public static final String EXTRA_UID = "android.intent.extra.UID";
4627
4628 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004629 * @hide String array of package names.
4630 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004631 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004632 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4633
4634 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004635 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4636 * intents to indicate whether this represents a full uninstall (removing
4637 * both the code and its data) or a partial uninstall (leaving its data,
4638 * implying that this is an update).
4639 */
4640 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004641
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004642 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004643 * @hide
4644 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4645 * intents to indicate that at this point the package has been removed for
4646 * all users on the device.
4647 */
4648 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4649 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4650
4651 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004652 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4653 * intents to indicate that this is a replacement of the package, so this
4654 * broadcast will immediately be followed by an add broadcast for a
4655 * different version of the same package.
4656 */
4657 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004658
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004659 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004660 * Used as an int extra field in {@link android.app.AlarmManager} intents
4661 * to tell the application being invoked how many pending alarms are being
4662 * delievered with the intent. For one-shot alarms this will always be 1.
4663 * For recurring alarms, this might be greater than 1 if the device was
4664 * asleep or powered off at the time an earlier alarm would have been
4665 * delivered.
4666 */
4667 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004668
Jacek Surazski86b6c532009-05-13 14:38:28 +02004669 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004670 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4671 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004672 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4673 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004674 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4675 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4676 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004677 */
4678 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4679
4680 /**
4681 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4682 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004683 */
4684 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4685
4686 /**
4687 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4688 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004689 */
4690 public static final int EXTRA_DOCK_STATE_DESK = 1;
4691
4692 /**
4693 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4694 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004695 */
4696 public static final int EXTRA_DOCK_STATE_CAR = 2;
4697
4698 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004699 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4700 * to represent that the phone is in a analog (low end) dock.
4701 */
4702 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4703
4704 /**
4705 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4706 * to represent that the phone is in a digital (high end) dock.
4707 */
4708 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4709
4710 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004711 * Boolean that can be supplied as meta-data with a dock activity, to
4712 * indicate that the dock should take over the home key when it is active.
4713 */
4714 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004715
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004716 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004717 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4718 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004719 */
4720 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4721
4722 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004723 * Used in the extra field in the remote intent. It's astring token passed with the
4724 * remote intent.
4725 */
4726 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4727 "android.intent.extra.remote_intent_token";
4728
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004729 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004730 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004731 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004732 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004733 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004734 "android.intent.extra.changed_component_name";
4735
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004736 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004737 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004738 * and contains a string array of all of the components that have changed. If
4739 * the state of the overall package has changed, then it will contain an entry
4740 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004741 */
4742 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4743 "android.intent.extra.changed_component_name_list";
4744
4745 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004746 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004747 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004748 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4749 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4750 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004751 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004752 */
4753 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4754 "android.intent.extra.changed_package_list";
4755
4756 /**
4757 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004758 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4759 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004760 * and contains an integer array of uids of all of the components
4761 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004762 */
4763 public static final String EXTRA_CHANGED_UID_LIST =
4764 "android.intent.extra.changed_uid_list";
4765
4766 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004767 * @hide
4768 * Magic extra system code can use when binding, to give a label for
4769 * who it is that has bound to a service. This is an integer giving
4770 * a framework string resource that can be displayed to the user.
4771 */
4772 public static final String EXTRA_CLIENT_LABEL =
4773 "android.intent.extra.client_label";
4774
4775 /**
4776 * @hide
4777 * Magic extra system code can use when binding, to give a PendingIntent object
4778 * that can be launched for the user to disable the system's use of this
4779 * service.
4780 */
4781 public static final String EXTRA_CLIENT_INTENT =
4782 "android.intent.extra.client_intent";
4783
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004784 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004785 * Extra used to indicate that an intent should only return data that is on
4786 * the local device. This is a boolean extra; the default is false. If true,
4787 * an implementation should only allow the user to select data that is
4788 * already on the device, not requiring it be downloaded from a remote
4789 * service when opened.
4790 *
4791 * @see #ACTION_GET_CONTENT
4792 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004793 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004794 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004795 */
4796 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004797 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004798
Amith Yamasani13593602012-03-22 16:16:17 -07004799 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004800 * Extra used to indicate that an intent can allow the user to select and
4801 * return multiple items. This is a boolean extra; the default is false. If
4802 * true, an implementation is allowed to present the user with a UI where
4803 * they can pick multiple items that are all returned to the caller. When
4804 * this happens, they should be returned as the {@link #getClipData()} part
4805 * of the result Intent.
4806 *
4807 * @see #ACTION_GET_CONTENT
4808 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004809 */
4810 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004811 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004812
4813 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004814 * The integer userHandle carried with broadcast intents related to addition, removal and
4815 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4816 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4817 *
Amith Yamasani13593602012-03-22 16:16:17 -07004818 * @hide
4819 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004820 public static final String EXTRA_USER_HANDLE =
4821 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004822
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004823 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004824 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4825 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4826 */
4827 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004828 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004829
4830 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004831 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004832 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4833 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004834 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004835 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4836
4837 /**
4838 * Extra sent in the intent to the BroadcastReceiver that handles
4839 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4840 * the restrictions as key/value pairs.
4841 */
4842 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4843 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004844
Amith Yamasani86118ba2013-03-28 14:33:16 -07004845 /**
4846 * Extra used in the response from a BroadcastReceiver that handles
4847 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4848 */
4849 public static final String EXTRA_RESTRICTIONS_INTENT =
4850 "android.intent.extra.restrictions_intent";
4851
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004852 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004853 * Extra used to communicate a set of acceptable MIME types. The type of the
4854 * extra is {@code String[]}. Values may be a combination of concrete MIME
4855 * types (such as "image/png") and/or partial MIME types (such as
4856 * "audio/*").
4857 *
4858 * @see #ACTION_GET_CONTENT
4859 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004860 */
4861 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4862
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004863 /**
4864 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4865 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004866 * When this is true, hardware devices can use this information to determine that
4867 * they shouldn't do a complete shutdown of their device since this is not a
4868 * complete shutdown down to the kernel, but only user space restarting.
4869 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004870 */
4871 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4872 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4873
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004874 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004875 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4876 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4877 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4878 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004879 *
4880 * @hide for internal use only.
4881 */
4882 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4883 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004884 /** @hide */
4885 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4886 /** @hide */
4887 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4888 /** @hide */
4889 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004890
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07004891 /**
4892 * Intent extra: the reason that the operation associated with this intent is being performed.
4893 *
4894 * <p>Type: String
4895 * @hide
4896 */
4897 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004898 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4899
qingxi240c2bb2017-04-12 17:31:18 -07004900 /**
4901 * {@hide}
4902 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4903 */
Rubin Xue8490f12015-06-25 12:17:48 +01004904 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4905
Santos Cordon15a13782015-03-31 18:32:31 -07004906 /**
qingxi240c2bb2017-04-12 17:31:18 -07004907 * {@hide}
4908 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4909 * reset for the device with eSIM. This extra will be sent together with
4910 * {@link #ACTION_FACTORY_RESET}
4911 */
4912 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4913
4914 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004915 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4916 * activation request.
4917 * TODO: Add information about the structure and response data used with the pending intent.
4918 * @hide
4919 */
4920 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4921 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4922
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004923 /**
4924 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004925 *
4926 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004927 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004928 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004929 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4930
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004931 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004932 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4933 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4934 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004935 *
4936 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004937 * @see #ACTION_QUICK_VIEW
4938 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004939 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004940 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004941 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4942 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004943
4944 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004945 * An optional extra of {@code String[]} indicating which quick view features should be made
4946 * available to the user in the quick view UI while handing a
4947 * {@link Intent#ACTION_QUICK_VIEW} intent.
4948 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4949 * Quick viewer can implement features not listed below.
4950 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05004951 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
4952 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
4953 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07004954 * <p>
4955 * Requirements:
4956 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4957 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4958 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4959 * internal policies.
4960 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4961 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4962 * disable or hide features.
4963 *
4964 * @see #ACTION_QUICK_VIEW
4965 */
4966 public static final String EXTRA_QUICK_VIEW_FEATURES =
4967 "android.intent.extra.QUICK_VIEW_FEATURES";
4968
4969 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004970 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004971 * When a profile goes into quiet mode, all apps in the profile are killed and the
4972 * profile user is stopped. Widgets originating from the profile are masked, and app
4973 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004974 */
4975 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004976
4977 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004978 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004979 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004980 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4981 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004982 *
4983 * @hide
4984 */
4985 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4986 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4987
4988 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004989 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4990 * whether to show the chooser or not when there is only one application available
4991 * to choose from.
4992 *
4993 * @hide
4994 */
4995 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4996 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4997
4998 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004999 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005000 * to represent that a video codec is allowed to use.
5001 *
5002 * @hide
5003 */
5004 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5005
5006 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005007 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005008 * to represent that a audio codec is allowed to use.
5009 *
5010 * @hide
5011 */
5012 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005014 // ---------------------------------------------------------------------
5015 // ---------------------------------------------------------------------
5016 // Intent flags (see mFlags variable).
5017
Tor Norbyed9273d62013-05-30 15:59:53 -07005018 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005019 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005020 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5021 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005022 @Retention(RetentionPolicy.SOURCE)
5023 public @interface GrantUriMode {}
5024
Jeff Sharkey846318a2014-04-04 12:12:41 -07005025 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005026 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005027 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5028 @Retention(RetentionPolicy.SOURCE)
5029 public @interface AccessUriMode {}
5030
5031 /**
5032 * Test if given mode flags specify an access mode, which must be at least
5033 * read and/or write.
5034 *
5035 * @hide
5036 */
5037 public static boolean isAccessUriMode(int modeFlags) {
5038 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5039 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5040 }
5041
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005042 /** @hide */
5043 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5044 FLAG_GRANT_READ_URI_PERMISSION,
5045 FLAG_GRANT_WRITE_URI_PERMISSION,
5046 FLAG_FROM_BACKGROUND,
5047 FLAG_DEBUG_LOG_RESOLUTION,
5048 FLAG_EXCLUDE_STOPPED_PACKAGES,
5049 FLAG_INCLUDE_STOPPED_PACKAGES,
5050 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5051 FLAG_GRANT_PREFIX_URI_PERMISSION,
5052 FLAG_DEBUG_TRIAGED_MISSING,
5053 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005054 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005055 FLAG_ACTIVITY_NO_HISTORY,
5056 FLAG_ACTIVITY_SINGLE_TOP,
5057 FLAG_ACTIVITY_NEW_TASK,
5058 FLAG_ACTIVITY_MULTIPLE_TASK,
5059 FLAG_ACTIVITY_CLEAR_TOP,
5060 FLAG_ACTIVITY_FORWARD_RESULT,
5061 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5062 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5063 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5064 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5065 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5066 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5067 FLAG_ACTIVITY_NEW_DOCUMENT,
5068 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5069 FLAG_ACTIVITY_NO_USER_ACTION,
5070 FLAG_ACTIVITY_REORDER_TO_FRONT,
5071 FLAG_ACTIVITY_NO_ANIMATION,
5072 FLAG_ACTIVITY_CLEAR_TASK,
5073 FLAG_ACTIVITY_TASK_ON_HOME,
5074 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5075 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5076 FLAG_RECEIVER_REGISTERED_ONLY,
5077 FLAG_RECEIVER_REPLACE_PENDING,
5078 FLAG_RECEIVER_FOREGROUND,
5079 FLAG_RECEIVER_NO_ABORT,
5080 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5081 FLAG_RECEIVER_BOOT_UPGRADE,
5082 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5083 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5084 FLAG_RECEIVER_FROM_SHELL,
5085 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5086 })
5087 @Retention(RetentionPolicy.SOURCE)
5088 public @interface Flags {}
5089
5090 /** @hide */
5091 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5092 FLAG_FROM_BACKGROUND,
5093 FLAG_DEBUG_LOG_RESOLUTION,
5094 FLAG_EXCLUDE_STOPPED_PACKAGES,
5095 FLAG_INCLUDE_STOPPED_PACKAGES,
5096 FLAG_DEBUG_TRIAGED_MISSING,
5097 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005098 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005099 FLAG_ACTIVITY_NO_HISTORY,
5100 FLAG_ACTIVITY_SINGLE_TOP,
5101 FLAG_ACTIVITY_NEW_TASK,
5102 FLAG_ACTIVITY_MULTIPLE_TASK,
5103 FLAG_ACTIVITY_CLEAR_TOP,
5104 FLAG_ACTIVITY_FORWARD_RESULT,
5105 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5106 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5107 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5108 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5109 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5110 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5111 FLAG_ACTIVITY_NEW_DOCUMENT,
5112 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5113 FLAG_ACTIVITY_NO_USER_ACTION,
5114 FLAG_ACTIVITY_REORDER_TO_FRONT,
5115 FLAG_ACTIVITY_NO_ANIMATION,
5116 FLAG_ACTIVITY_CLEAR_TASK,
5117 FLAG_ACTIVITY_TASK_ON_HOME,
5118 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5119 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5120 FLAG_RECEIVER_REGISTERED_ONLY,
5121 FLAG_RECEIVER_REPLACE_PENDING,
5122 FLAG_RECEIVER_FOREGROUND,
5123 FLAG_RECEIVER_NO_ABORT,
5124 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5125 FLAG_RECEIVER_BOOT_UPGRADE,
5126 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5127 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5128 FLAG_RECEIVER_FROM_SHELL,
5129 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5130 })
5131 @Retention(RetentionPolicy.SOURCE)
5132 public @interface MutableFlags {}
5133
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005134 /**
5135 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005136 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005137 * specified in its ClipData. When applying to an Intent's ClipData,
5138 * all URIs as well as recursive traversals through data or other ClipData
5139 * in Intent items will be granted; only the grant flags of the top-level
5140 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005141 */
5142 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5143 /**
5144 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005145 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005146 * specified in its ClipData. When applying to an Intent's ClipData,
5147 * all URIs as well as recursive traversals through data or other ClipData
5148 * in Intent items will be granted; only the grant flags of the top-level
5149 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005150 */
5151 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5152 /**
5153 * Can be set by the caller to indicate that this Intent is coming from
5154 * a background operation, not from direct user interaction.
5155 */
5156 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5157 /**
5158 * A flag you can enable for debugging: when set, log messages will be
5159 * printed during the resolution of this intent to show you what has
5160 * been found to create the final resolved list.
5161 */
5162 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005163 /**
5164 * If set, this intent will not match any components in packages that
5165 * are currently stopped. If this is not set, then the default behavior
5166 * is to include such applications in the result.
5167 */
5168 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5169 /**
5170 * If set, this intent will always match any components in packages that
5171 * are currently stopped. This is the default behavior when
5172 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5173 * flags are set, this one wins (it allows overriding of exclude for
5174 * places where the framework may automatically set the exclude flag).
5175 */
5176 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005177
5178 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005179 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005180 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005181 * persisted across device reboots until explicitly revoked with
5182 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5183 * grant for possible persisting; the receiving application must call
5184 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5185 * actually persist.
5186 *
5187 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5188 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5189 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005190 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005191 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005192 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005193
5194 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005195 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5196 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5197 * applies to any URI that is a prefix match against the original granted
5198 * URI. (Without this flag, the URI must match exactly for access to be
5199 * granted.) Another URI is considered a prefix match only when scheme,
5200 * authority, and all path segments defined by the prefix are an exact
5201 * match.
5202 */
5203 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5204
5205 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005206 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005207 * homework and verified that they correctly handle packages and components
5208 * that come and go over time. In particular:
5209 * <ul>
5210 * <li>Apps installed on external storage, which will appear to be
5211 * uninstalled while the the device is ejected.
5212 * <li>Apps with encryption unaware components, which will appear to not
5213 * exist while the device is locked.
5214 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005215 *
5216 * @hide
5217 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005218 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005219
5220 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005221 * Internal flag used to indicate ephemeral applications should not be
5222 * considered when resolving the intent.
5223 *
5224 * @hide
5225 */
5226 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5227
5228 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005229 * If set, the new activity is not kept in the history stack. As soon as
5230 * the user navigates away from it, the activity is finished. This may also
5231 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5232 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005233 *
5234 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5235 * is never invoked when the current activity starts a new activity which
5236 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 */
5238 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5239 /**
5240 * If set, the activity will not be launched if it is already running
5241 * at the top of the history stack.
5242 */
5243 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5244 /**
5245 * If set, this activity will become the start of a new task on this
5246 * history stack. A task (from the activity that started it to the
5247 * next task activity) defines an atomic group of activities that the
5248 * user can move to. Tasks can be moved to the foreground and background;
5249 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005250 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005251 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5252 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005253 *
5254 * <p>This flag is generally used by activities that want
5255 * to present a "launcher" style behavior: they give the user a list of
5256 * separate things that can be done, which otherwise run completely
5257 * independently of the activity launching them.
5258 *
5259 * <p>When using this flag, if a task is already running for the activity
5260 * you are now starting, then a new activity will not be started; instead,
5261 * the current task will simply be brought to the front of the screen with
5262 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5263 * to disable this behavior.
5264 *
5265 * <p>This flag can not be used when the caller is requesting a result from
5266 * the activity being launched.
5267 */
5268 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5269 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005270 * This flag is used to create a new task and launch an activity into it.
5271 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5272 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5273 * search through existing tasks for ones matching this Intent. Only if no such
5274 * task is found would a new task be created. When paired with
5275 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5276 * the search for a matching task and unconditionally start a new task.
5277 *
5278 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5279 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280 * top-level application launcher.</strong> Used in conjunction with
5281 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5282 * behavior of bringing an existing task to the foreground. When set,
5283 * a new task is <em>always</em> started to host the Activity for the
5284 * Intent, regardless of whether there is already an existing task running
5285 * the same thing.
5286 *
5287 * <p><strong>Because the default system does not include graphical task management,
5288 * you should not use this flag unless you provide some way for a user to
5289 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005290 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005291 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5292 * creating new document tasks.
5293 *
5294 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005295 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005296 *
Scott Main7aee61f2011-02-08 11:25:01 -08005297 * <p>See
5298 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5299 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005300 *
5301 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5302 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005303 */
5304 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5305 /**
5306 * If set, and the activity being launched is already running in the
5307 * current task, then instead of launching a new instance of that activity,
5308 * all of the other activities on top of it will be closed and this Intent
5309 * will be delivered to the (now on top) old activity as a new Intent.
5310 *
5311 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5312 * If D calls startActivity() with an Intent that resolves to the component
5313 * of activity B, then C and D will be finished and B receive the given
5314 * Intent, resulting in the stack now being: A, B.
5315 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005316 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005317 * either receive the new intent you are starting here in its
5318 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005319 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005320 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5321 * the same intent, then it will be finished and re-created; for all other
5322 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5323 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005324 *
5325 * <p>This launch mode can also be used to good effect in conjunction with
5326 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5327 * of a task, it will bring any currently running instance of that task
5328 * to the foreground, and then clear it to its root state. This is
5329 * especially useful, for example, when launching an activity from the
5330 * notification manager.
5331 *
Scott Main7aee61f2011-02-08 11:25:01 -08005332 * <p>See
5333 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5334 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005335 */
5336 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5337 /**
5338 * If set and this intent is being used to launch a new activity from an
5339 * existing one, then the reply target of the existing activity will be
5340 * transfered to the new activity. This way the new activity can call
5341 * {@link android.app.Activity#setResult} and have that result sent back to
5342 * the reply target of the original activity.
5343 */
5344 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5345 /**
5346 * If set and this intent is being used to launch a new activity from an
5347 * existing one, the current activity will not be counted as the top
5348 * activity for deciding whether the new intent should be delivered to
5349 * the top instead of starting a new one. The previous activity will
5350 * be used as the top, with the assumption being that the current activity
5351 * will finish itself immediately.
5352 */
5353 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5354 /**
5355 * If set, the new activity is not kept in the list of recently launched
5356 * activities.
5357 */
5358 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5359 /**
5360 * This flag is not normally set by application code, but set for you by
5361 * the system as described in the
5362 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5363 * launchMode} documentation for the singleTask mode.
5364 */
5365 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5366 /**
5367 * If set, and this activity is either being started in a new task or
5368 * bringing to the top an existing task, then it will be launched as
5369 * the front door of the task. This will result in the application of
5370 * any affinities needed to have that task in the proper state (either
5371 * moving activities to or from it), or simply resetting that task to
5372 * its initial state if needed.
5373 */
5374 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5375 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005376 * This flag is not normally set by application code, but set for you by
5377 * the system if this activity is being launched from history
5378 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005379 */
5380 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005381 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005382 * @deprecated As of API 21 this performs identically to
5383 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005384 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005385 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005386 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005387 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005388 * This flag is used to open a document into a new task rooted at the activity launched
5389 * by this Intent. Through the use of this flag, or its equivalent attribute,
5390 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005391 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005392 *
Craig Mautner026596b2014-05-21 15:35:44 -07005393 * <p>The use of the activity attribute form of this,
5394 * {@link android.R.attr#documentLaunchMode}, is
5395 * preferred over the Intent flag described here. The attribute form allows the
5396 * Activity to specify multiple document behavior for all launchers of the Activity
5397 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005398 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005399 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5400 * it is kept after the activity is finished is different than the use of
5401 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5402 * this flag is being used to create a new recents entry, then by default that entry
5403 * will be removed once the activity is finished. You can modify this behavior with
5404 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5405 *
Craig Mautner026596b2014-05-21 15:35:44 -07005406 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5407 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5408 * equivalent of the Activity manifest specifying {@link
5409 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5410 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5411 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005412 *
Craig Mautner026596b2014-05-21 15:35:44 -07005413 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005414 *
Craig Mautner026596b2014-05-21 15:35:44 -07005415 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005416 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5417 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005418 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005419 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005420 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005421 * callback from occurring on the current frontmost activity before it is
5422 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005423 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005424 * <p>Typically, an activity can rely on that callback to indicate that an
5425 * explicit user action has caused their activity to be moved out of the
5426 * foreground. The callback marks an appropriate point in the activity's
5427 * lifecycle for it to dismiss any notifications that it intends to display
5428 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005429 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005430 * <p>If an activity is ever started via any non-user-driven events such as
5431 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5432 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005433 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005434 */
5435 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005436 /**
5437 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5438 * this flag will cause the launched activity to be brought to the front of its
5439 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005440 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005441 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5442 * If D calls startActivity() with an Intent that resolves to the component
5443 * of activity B, then B will be brought to the front of the history stack,
5444 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005445 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005446 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005447 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005448 */
5449 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005450 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005451 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5452 * this flag will prevent the system from applying an activity transition
5453 * animation to go to the next activity state. This doesn't mean an
5454 * animation will never run -- if another activity change happens that doesn't
5455 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005456 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005457 * when you are going to do a series of activity operations but the
5458 * animation seen by the user shouldn't be driven by the first activity
5459 * change but rather a later one.
5460 */
5461 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5462 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005463 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5464 * this flag will cause any existing task that would be associated with the
5465 * activity to be cleared before the activity is started. That is, the activity
5466 * becomes the new root of an otherwise empty task, and any old activities
5467 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5468 */
5469 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5470 /**
5471 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5472 * this flag will cause a newly launching task to be placed on top of the current
5473 * home activity task (if there is one). That is, pressing back from the task
5474 * will always return the user to home even if that was not the last activity they
5475 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5476 */
5477 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5478 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005479 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5480 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005481 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005482 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005483 * this flag. When set and the task's activity is finished, the recents
5484 * entry will remain in the interface for the user to re-launch it, like a
5485 * recents entry for a top-level application.
5486 * <p>
5487 * The receiving activity can override this request with
5488 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5489 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005490 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005491 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005492 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005493
5494 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005495 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5496 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005497 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5498 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005499 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005500 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005501
Patrick Baumann577d4022018-01-31 16:55:10 +00005502
5503 /**
5504 * If set, resolution of this intent may take place via an instant app not
5505 * yet on the device if there does not yet exist an app on device to
5506 * resolve it.
5507 */
5508 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5509
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005510 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005511 * If set, when sending a broadcast only registered receivers will be
5512 * called -- no BroadcastReceiver components will be launched.
5513 */
5514 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005515 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005516 * If set, when sending a broadcast the new broadcast will replace
5517 * any existing pending broadcast that matches it. Matching is defined
5518 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5519 * true for the intents of the two broadcasts. When a match is found,
5520 * the new broadcast (and receivers associated with it) will replace the
5521 * existing one in the pending broadcast list, remaining at the same
5522 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005523 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005524 * <p>This flag is most typically used with sticky broadcasts, which
5525 * only care about delivering the most recent values of the broadcast
5526 * to their receivers.
5527 */
5528 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5529 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005530 * If set, when sending a broadcast the recipient is allowed to run at
5531 * foreground priority, with a shorter timeout interval. During normal
5532 * broadcasts the receivers are not automatically hoisted out of the
5533 * background priority class.
5534 */
5535 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5536 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005537 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5538 * They can still propagate results through to later receivers, but they can not prevent
5539 * later receivers from seeing the broadcast.
5540 */
5541 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5542 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005543 * If set, when sending a broadcast <i>before boot has completed</i> only
5544 * registered receivers will be called -- no BroadcastReceiver components
5545 * will be launched. Sticky intent state will be recorded properly even
5546 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5547 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005548 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005549 * <p>This flag is only for use by system sevices as a convenience to
5550 * avoid having to implement a more complex mechanism around detection
5551 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005552 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005553 * @hide
5554 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005555 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005556 /**
5557 * Set when this broadcast is for a boot upgrade, a special mode that
5558 * allows the broadcast to be sent before the system is ready and launches
5559 * the app process with no providers running in it.
5560 * @hide
5561 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005562 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005563 /**
5564 * If set, the broadcast will always go to manifest receivers in background (cached
5565 * or not running) apps, regardless of whether that would be done by default. By
5566 * default they will only receive broadcasts if the broadcast has specified an
5567 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005568 *
5569 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5570 * the broadcast code there must also be changed to match.
5571 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005572 * @hide
5573 */
5574 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5575 /**
5576 * If set, the broadcast will never go to manifest receivers in background (cached
5577 * or not running) apps, regardless of whether that would be done by default. By
5578 * default they will receive broadcasts if the broadcast has specified an
5579 * explicit component or package name.
5580 * @hide
5581 */
5582 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005583 /**
5584 * If set, this broadcast is being sent from the shell.
5585 * @hide
5586 */
5587 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005588
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005589 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005590 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5591 * will not receive broadcasts.
5592 *
5593 * <em>This flag has no effect when used by an Instant App.</em>
5594 */
5595 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5596
5597 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005598 * @hide Flags that can't be changed with PendingIntent.
5599 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005600 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5601 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5602 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005603
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005604 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005605 // ---------------------------------------------------------------------
5606 // toUri() and parseUri() options.
5607
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005608 /** @hide */
5609 @IntDef(flag = true, prefix = { "URI_" }, value = {
5610 URI_ALLOW_UNSAFE,
5611 URI_ANDROID_APP_SCHEME,
5612 URI_INTENT_SCHEME,
5613 })
5614 @Retention(RetentionPolicy.SOURCE)
5615 public @interface UriFlags {}
5616
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005617 /**
5618 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5619 * always has the "intent:" scheme. This syntax can be used when you want
5620 * to later disambiguate between URIs that are intended to describe an
5621 * Intent vs. all others that should be treated as raw URIs. When used
5622 * with {@link #parseUri}, any other scheme will result in a generic
5623 * VIEW action for that raw URI.
5624 */
5625 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005626
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005627 /**
5628 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5629 * always has the "android-app:" scheme. This is a variation of
5630 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5631 * http/https URI being delivered to a specific package name. The format
5632 * is:
5633 *
5634 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005635 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005636 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005637 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5638 * you must also include a scheme; including a path also requires both a host and a scheme.
5639 * The final #Intent; fragment can be used without a scheme, host, or path.
5640 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005641 * used with intents that have a {@link #setSelector}, since the base intent
5642 * will always have an explicit package name.</p>
5643 *
5644 * <p>Some examples of how this scheme maps to Intent objects:</p>
5645 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5646 * <colgroup align="left" />
5647 * <colgroup align="left" />
5648 * <thead>
5649 * <tr><th>URI</th> <th>Intent</th></tr>
5650 * </thead>
5651 *
5652 * <tbody>
5653 * <tr><td><code>android-app://com.example.app</code></td>
5654 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5655 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5656 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5657 * </table></td>
5658 * </tr>
5659 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5660 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5661 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5662 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5663 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5664 * </table></td>
5665 * </tr>
5666 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5667 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5668 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5669 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5670 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5671 * </table></td>
5672 * </tr>
5673 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5674 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5675 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5676 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5677 * </table></td>
5678 * </tr>
5679 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5680 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5681 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5682 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5683 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5684 * </table></td>
5685 * </tr>
5686 * <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>
5687 * <td><table border="" style="margin:0" >
5688 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5689 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5690 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5691 * </table></td>
5692 * </tr>
5693 * </tbody>
5694 * </table>
5695 */
5696 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5697
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005698 /**
5699 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5700 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5701 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5702 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5703 * generated Intent can not cause unexpected data access to happen.
5704 *
5705 * <p>If you do not trust the source of the URI being parsed, you should still do further
5706 * processing to protect yourself from it. In particular, when using it to start an
5707 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5708 * that can handle it.</p>
5709 */
5710 public static final int URI_ALLOW_UNSAFE = 1<<2;
5711
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005712 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005713
5714 private String mAction;
5715 private Uri mData;
5716 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005717 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005718 private ComponentName mComponent;
5719 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005720 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005721 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005722 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005723 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005724 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005725 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005726 /** Token to track instant app launches. Local only; do not copy cross-process. */
5727 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005728
5729 // ---------------------------------------------------------------------
5730
Makoto Onuki97f82f22017-05-31 16:20:21 -07005731 private static final int COPY_MODE_ALL = 0;
5732 private static final int COPY_MODE_FILTER = 1;
5733 private static final int COPY_MODE_HISTORY = 2;
5734
5735 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07005736 @IntDef(prefix = { "COPY_MODE_" }, value = {
5737 COPY_MODE_ALL,
5738 COPY_MODE_FILTER,
5739 COPY_MODE_HISTORY
5740 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07005741 @Retention(RetentionPolicy.SOURCE)
5742 public @interface CopyMode {}
5743
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005744 /**
5745 * Create an empty intent.
5746 */
5747 public Intent() {
5748 }
5749
5750 /**
5751 * Copy constructor.
5752 */
5753 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005754 this(o, COPY_MODE_ALL);
5755 }
5756
5757 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005758 this.mAction = o.mAction;
5759 this.mData = o.mData;
5760 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005761 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005762 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005763
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005764 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005765 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005766 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005767
5768 if (copyMode != COPY_MODE_FILTER) {
5769 this.mFlags = o.mFlags;
5770 this.mContentUserHint = o.mContentUserHint;
5771 this.mLaunchToken = o.mLaunchToken;
5772 if (o.mSourceBounds != null) {
5773 this.mSourceBounds = new Rect(o.mSourceBounds);
5774 }
5775 if (o.mSelector != null) {
5776 this.mSelector = new Intent(o.mSelector);
5777 }
5778
5779 if (copyMode != COPY_MODE_HISTORY) {
5780 if (o.mExtras != null) {
5781 this.mExtras = new Bundle(o.mExtras);
5782 }
5783 if (o.mClipData != null) {
5784 this.mClipData = new ClipData(o.mClipData);
5785 }
5786 } else {
5787 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5788 this.mExtras = Bundle.STRIPPED;
5789 }
5790
5791 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5792 // history.
5793 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005794 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005795 }
5796
5797 @Override
5798 public Object clone() {
5799 return new Intent(this);
5800 }
5801
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005802 /**
5803 * Make a clone of only the parts of the Intent that are relevant for
5804 * filter matching: the action, data, type, component, and categories.
5805 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005806 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005807 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005808 }
5809
5810 /**
5811 * Create an intent with a given action. All other fields (data, type,
5812 * class) are null. Note that the action <em>must</em> be in a
5813 * namespace because Intents are used globally in the system -- for
5814 * example the system VIEW action is android.intent.action.VIEW; an
5815 * application's custom action would be something like
5816 * com.google.app.myapp.CUSTOM_ACTION.
5817 *
5818 * @param action The Intent action, such as ACTION_VIEW.
5819 */
5820 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005821 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005822 }
5823
5824 /**
5825 * Create an intent with a given action and for a given data url. Note
5826 * that the action <em>must</em> be in a namespace because Intents are
5827 * used globally in the system -- for example the system VIEW action is
5828 * android.intent.action.VIEW; an application's custom action would be
5829 * something like com.google.app.myapp.CUSTOM_ACTION.
5830 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005831 * <p><em>Note: scheme and host name matching in the Android framework is
5832 * case-sensitive, unlike the formal RFC. As a result,
5833 * you should always ensure that you write your Uri with these elements
5834 * using lower case letters, and normalize any Uris you receive from
5835 * outside of Android to ensure the scheme and host is lower case.</em></p>
5836 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005837 * @param action The Intent action, such as ACTION_VIEW.
5838 * @param uri The Intent data URI.
5839 */
5840 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005841 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005842 mData = uri;
5843 }
5844
5845 /**
5846 * Create an intent for a specific component. All other fields (action, data,
5847 * type, class) are null, though they can be modified later with explicit
5848 * calls. This provides a convenient way to create an intent that is
5849 * intended to execute a hard-coded class name, rather than relying on the
5850 * system to find an appropriate class for you; see {@link #setComponent}
5851 * for more information on the repercussions of this.
5852 *
5853 * @param packageContext A Context of the application package implementing
5854 * this class.
5855 * @param cls The component class that is to be used for the intent.
5856 *
5857 * @see #setClass
5858 * @see #setComponent
5859 * @see #Intent(String, android.net.Uri , Context, Class)
5860 */
5861 public Intent(Context packageContext, Class<?> cls) {
5862 mComponent = new ComponentName(packageContext, cls);
5863 }
5864
5865 /**
5866 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005867 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005868 * construct the Intent and then calling {@link #setClass} to set its
5869 * class.
5870 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005871 * <p><em>Note: scheme and host name matching in the Android framework is
5872 * case-sensitive, unlike the formal RFC. As a result,
5873 * you should always ensure that you write your Uri with these elements
5874 * using lower case letters, and normalize any Uris you receive from
5875 * outside of Android to ensure the scheme and host is lower case.</em></p>
5876 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005877 * @param action The Intent action, such as ACTION_VIEW.
5878 * @param uri The Intent data URI.
5879 * @param packageContext A Context of the application package implementing
5880 * this class.
5881 * @param cls The component class that is to be used for the intent.
5882 *
5883 * @see #Intent(String, android.net.Uri)
5884 * @see #Intent(Context, Class)
5885 * @see #setClass
5886 * @see #setComponent
5887 */
5888 public Intent(String action, Uri uri,
5889 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005890 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005891 mData = uri;
5892 mComponent = new ComponentName(packageContext, cls);
5893 }
5894
5895 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005896 * Create an intent to launch the main (root) activity of a task. This
5897 * is the Intent that is started when the application's is launched from
5898 * Home. For anything else that wants to launch an application in the
5899 * same way, it is important that they use an Intent structured the same
5900 * way, and can use this function to ensure this is the case.
5901 *
5902 * <p>The returned Intent has the given Activity component as its explicit
5903 * component, {@link #ACTION_MAIN} as its action, and includes the
5904 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5905 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5906 * to do that through {@link #addFlags(int)} on the returned Intent.
5907 *
5908 * @param mainActivity The main activity component that this Intent will
5909 * launch.
5910 * @return Returns a newly created Intent that can be used to launch the
5911 * activity as a main application entry.
5912 *
5913 * @see #setClass
5914 * @see #setComponent
5915 */
5916 public static Intent makeMainActivity(ComponentName mainActivity) {
5917 Intent intent = new Intent(ACTION_MAIN);
5918 intent.setComponent(mainActivity);
5919 intent.addCategory(CATEGORY_LAUNCHER);
5920 return intent;
5921 }
5922
5923 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005924 * Make an Intent for the main activity of an application, without
5925 * specifying a specific activity to run but giving a selector to find
5926 * the activity. This results in a final Intent that is structured
5927 * the same as when the application is launched from
5928 * Home. For anything else that wants to launch an application in the
5929 * same way, it is important that they use an Intent structured the same
5930 * way, and can use this function to ensure this is the case.
5931 *
5932 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5933 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5934 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5935 * to do that through {@link #addFlags(int)} on the returned Intent.
5936 *
5937 * @param selectorAction The action name of the Intent's selector.
5938 * @param selectorCategory The name of a category to add to the Intent's
5939 * selector.
5940 * @return Returns a newly created Intent that can be used to launch the
5941 * activity as a main application entry.
5942 *
5943 * @see #setSelector(Intent)
5944 */
5945 public static Intent makeMainSelectorActivity(String selectorAction,
5946 String selectorCategory) {
5947 Intent intent = new Intent(ACTION_MAIN);
5948 intent.addCategory(CATEGORY_LAUNCHER);
5949 Intent selector = new Intent();
5950 selector.setAction(selectorAction);
5951 selector.addCategory(selectorCategory);
5952 intent.setSelector(selector);
5953 return intent;
5954 }
5955
5956 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005957 * Make an Intent that can be used to re-launch an application's task
5958 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5959 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5960 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5961 *
5962 * @param mainActivity The activity component that is the root of the
5963 * task; this is the activity that has been published in the application's
5964 * manifest as the main launcher icon.
5965 *
5966 * @return Returns a newly created Intent that can be used to relaunch the
5967 * activity's task in its root state.
5968 */
5969 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5970 Intent intent = makeMainActivity(mainActivity);
5971 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5972 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5973 return intent;
5974 }
5975
5976 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005977 * Call {@link #parseUri} with 0 flags.
5978 * @deprecated Use {@link #parseUri} instead.
5979 */
5980 @Deprecated
5981 public static Intent getIntent(String uri) throws URISyntaxException {
5982 return parseUri(uri, 0);
5983 }
Tom Taylord4a47292009-12-21 13:59:18 -08005984
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005985 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005986 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005987 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005988 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005989 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005990 *
5991 * <p>The URI given here must not be relative -- that is, it must include
5992 * the scheme and full path.
5993 *
5994 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005995 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005996 *
5997 * @return Intent The newly created Intent object.
5998 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005999 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6000 * it bad (as parsed by the Uri class) or the Intent data within the
6001 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006002 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006003 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006004 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006005 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006006 int i = 0;
6007 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006008 final boolean androidApp = uri.startsWith("android-app:");
6009
6010 // Validate intent scheme if requested.
6011 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6012 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006013 Intent intent = new Intent(ACTION_VIEW);
6014 try {
6015 intent.setData(Uri.parse(uri));
6016 } catch (IllegalArgumentException e) {
6017 throw new URISyntaxException(uri, e.getMessage());
6018 }
6019 return intent;
6020 }
6021 }
Tom Taylord4a47292009-12-21 13:59:18 -08006022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006023 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006024 // simple case
6025 if (i == -1) {
6026 if (!androidApp) {
6027 return new Intent(ACTION_VIEW, Uri.parse(uri));
6028 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006029
6030 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006031 } else if (!uri.startsWith("#Intent;", i)) {
6032 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006033 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006034 } else {
6035 i = -1;
6036 }
6037 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006038
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006039 // new format
6040 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006041 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006042 boolean explicitAction = false;
6043 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006044
6045 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006046 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006047 String data;
6048 if (i >= 0) {
6049 data = uri.substring(0, i);
6050 i += 8; // length of "#Intent;"
6051 } else {
6052 data = uri;
6053 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006055 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006056 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006057 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006058 if (eq < 0) eq = i-1;
6059 int semi = uri.indexOf(';', i);
6060 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006061
6062 // action
6063 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006064 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006065 if (!inSelector) {
6066 explicitAction = true;
6067 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006068 }
6069
6070 // categories
6071 else if (uri.startsWith("category=", i)) {
6072 intent.addCategory(value);
6073 }
6074
6075 // type
6076 else if (uri.startsWith("type=", i)) {
6077 intent.mType = value;
6078 }
6079
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006080 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 else if (uri.startsWith("launchFlags=", i)) {
6082 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006083 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6084 intent.mFlags &= ~IMMUTABLE_FLAGS;
6085 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006086 }
6087
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006088 // package
6089 else if (uri.startsWith("package=", i)) {
6090 intent.mPackage = value;
6091 }
6092
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006093 // component
6094 else if (uri.startsWith("component=", i)) {
6095 intent.mComponent = ComponentName.unflattenFromString(value);
6096 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006097
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006098 // scheme
6099 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006100 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006101 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006102 } else {
6103 scheme = value;
6104 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006105 }
6106
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006107 // source bounds
6108 else if (uri.startsWith("sourceBounds=", i)) {
6109 intent.mSourceBounds = Rect.unflattenFromString(value);
6110 }
6111
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006112 // selector
6113 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6114 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006115 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006116 }
6117
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006118 // extra
6119 else {
6120 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006121 // create Bundle if it doesn't already exist
6122 if (intent.mExtras == null) intent.mExtras = new Bundle();
6123 Bundle b = intent.mExtras;
6124 // add EXTRA
6125 if (uri.startsWith("S.", i)) b.putString(key, value);
6126 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6127 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6128 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6129 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6130 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6131 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6132 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6133 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6134 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6135 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006136
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006137 // move to the next item
6138 i = semi + 1;
6139 }
6140
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006141 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006142 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006143 if (baseIntent.mPackage == null) {
6144 baseIntent.setSelector(intent);
6145 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006146 intent = baseIntent;
6147 }
6148
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006149 if (data != null) {
6150 if (data.startsWith("intent:")) {
6151 data = data.substring(7);
6152 if (scheme != null) {
6153 data = scheme + ':' + data;
6154 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006155 } else if (data.startsWith("android-app:")) {
6156 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6157 // Correctly formed android-app, first part is package name.
6158 int end = data.indexOf('/', 14);
6159 if (end < 0) {
6160 // All we have is a package name.
6161 intent.mPackage = data.substring(14);
6162 if (!explicitAction) {
6163 intent.setAction(ACTION_MAIN);
6164 }
6165 data = "";
6166 } else {
6167 // Target the Intent at the given package name always.
6168 String authority = null;
6169 intent.mPackage = data.substring(14, end);
6170 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006171 if ((end+1) < data.length()) {
6172 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6173 // Found a scheme, remember it.
6174 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006175 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006176 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6177 // Found a authority, remember it.
6178 authority = data.substring(end+1, newEnd);
6179 end = newEnd;
6180 }
6181 } else {
6182 // All we have is a scheme.
6183 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006184 }
6185 }
6186 if (scheme == null) {
6187 // If there was no scheme, then this just targets the package.
6188 if (!explicitAction) {
6189 intent.setAction(ACTION_MAIN);
6190 }
6191 data = "";
6192 } else if (authority == null) {
6193 data = scheme + ":";
6194 } else {
6195 data = scheme + "://" + authority + data.substring(end);
6196 }
6197 }
6198 } else {
6199 data = "";
6200 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006201 }
Tom Taylord4a47292009-12-21 13:59:18 -08006202
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006203 if (data.length() > 0) {
6204 try {
6205 intent.mData = Uri.parse(data);
6206 } catch (IllegalArgumentException e) {
6207 throw new URISyntaxException(uri, e.getMessage());
6208 }
6209 }
6210 }
Tom Taylord4a47292009-12-21 13:59:18 -08006211
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006212 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006214 } catch (IndexOutOfBoundsException e) {
6215 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6216 }
6217 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006218
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006219 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006220 return getIntentOld(uri, 0);
6221 }
6222
6223 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006224 Intent intent;
6225
6226 int i = uri.lastIndexOf('#');
6227 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006228 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006229 final int intentFragmentStart = i;
6230 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006231
6232 i++;
6233
6234 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006235 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 i += 7;
6237 int j = uri.indexOf(')', i);
6238 action = uri.substring(i, j);
6239 i = j + 1;
6240 }
6241
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006242 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006243
6244 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006245 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006246 i += 11;
6247 int j = uri.indexOf(')', i);
6248 while (i < j) {
6249 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006250 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006251 if (i < sep) {
6252 intent.addCategory(uri.substring(i, sep));
6253 }
6254 i = sep + 1;
6255 }
6256 i = j + 1;
6257 }
6258
6259 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006260 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006261 i += 5;
6262 int j = uri.indexOf(')', i);
6263 intent.mType = uri.substring(i, j);
6264 i = j + 1;
6265 }
6266
6267 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006268 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006269 i += 12;
6270 int j = uri.indexOf(')', i);
6271 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006272 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6273 intent.mFlags &= ~IMMUTABLE_FLAGS;
6274 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006275 i = j + 1;
6276 }
6277
6278 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006279 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006280 i += 10;
6281 int j = uri.indexOf(')', i);
6282 int sep = uri.indexOf('!', i);
6283 if (sep >= 0 && sep < j) {
6284 String pkg = uri.substring(i, sep);
6285 String cls = uri.substring(sep + 1, j);
6286 intent.mComponent = new ComponentName(pkg, cls);
6287 }
6288 i = j + 1;
6289 }
6290
6291 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006292 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006293 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006294
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006295 final int closeParen = uri.indexOf(')', i);
6296 if (closeParen == -1) throw new URISyntaxException(uri,
6297 "EXTRA missing trailing ')'", i);
6298
6299 while (i < closeParen) {
6300 // fetch the key value
6301 int j = uri.indexOf('=', i);
6302 if (j <= i + 1 || i >= closeParen) {
6303 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6304 }
6305 char type = uri.charAt(i);
6306 i++;
6307 String key = uri.substring(i, j);
6308 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006309
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006310 // get type-value
6311 j = uri.indexOf('!', i);
6312 if (j == -1 || j >= closeParen) j = closeParen;
6313 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6314 String value = uri.substring(i, j);
6315 i = j;
6316
6317 // create Bundle if it doesn't already exist
6318 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006319
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006320 // add item to bundle
6321 try {
6322 switch (type) {
6323 case 'S':
6324 intent.mExtras.putString(key, Uri.decode(value));
6325 break;
6326 case 'B':
6327 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6328 break;
6329 case 'b':
6330 intent.mExtras.putByte(key, Byte.parseByte(value));
6331 break;
6332 case 'c':
6333 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6334 break;
6335 case 'd':
6336 intent.mExtras.putDouble(key, Double.parseDouble(value));
6337 break;
6338 case 'f':
6339 intent.mExtras.putFloat(key, Float.parseFloat(value));
6340 break;
6341 case 'i':
6342 intent.mExtras.putInt(key, Integer.parseInt(value));
6343 break;
6344 case 'l':
6345 intent.mExtras.putLong(key, Long.parseLong(value));
6346 break;
6347 case 's':
6348 intent.mExtras.putShort(key, Short.parseShort(value));
6349 break;
6350 default:
6351 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6352 }
6353 } catch (NumberFormatException e) {
6354 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6355 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006356
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006357 char ch = uri.charAt(i);
6358 if (ch == ')') break;
6359 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6360 i++;
6361 }
6362 }
6363
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006364 if (isIntentFragment) {
6365 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6366 } else {
6367 intent.mData = Uri.parse(uri);
6368 }
Tom Taylord4a47292009-12-21 13:59:18 -08006369
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006370 if (intent.mAction == null) {
6371 // By default, if no action is specified, then use VIEW.
6372 intent.mAction = ACTION_VIEW;
6373 }
6374
6375 } else {
6376 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6377 }
6378
6379 return intent;
6380 }
6381
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006382 /** @hide */
6383 public interface CommandOptionHandler {
6384 boolean handleOption(String opt, ShellCommand cmd);
6385 }
6386
6387 /** @hide */
6388 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6389 throws URISyntaxException {
6390 Intent intent = new Intent();
6391 Intent baseIntent = intent;
6392 boolean hasIntentInfo = false;
6393
6394 Uri data = null;
6395 String type = null;
6396
6397 String opt;
6398 while ((opt=cmd.getNextOption()) != null) {
6399 switch (opt) {
6400 case "-a":
6401 intent.setAction(cmd.getNextArgRequired());
6402 if (intent == baseIntent) {
6403 hasIntentInfo = true;
6404 }
6405 break;
6406 case "-d":
6407 data = Uri.parse(cmd.getNextArgRequired());
6408 if (intent == baseIntent) {
6409 hasIntentInfo = true;
6410 }
6411 break;
6412 case "-t":
6413 type = cmd.getNextArgRequired();
6414 if (intent == baseIntent) {
6415 hasIntentInfo = true;
6416 }
6417 break;
6418 case "-c":
6419 intent.addCategory(cmd.getNextArgRequired());
6420 if (intent == baseIntent) {
6421 hasIntentInfo = true;
6422 }
6423 break;
6424 case "-e":
6425 case "--es": {
6426 String key = cmd.getNextArgRequired();
6427 String value = cmd.getNextArgRequired();
6428 intent.putExtra(key, value);
6429 }
6430 break;
6431 case "--esn": {
6432 String key = cmd.getNextArgRequired();
6433 intent.putExtra(key, (String) null);
6434 }
6435 break;
6436 case "--ei": {
6437 String key = cmd.getNextArgRequired();
6438 String value = cmd.getNextArgRequired();
6439 intent.putExtra(key, Integer.decode(value));
6440 }
6441 break;
6442 case "--eu": {
6443 String key = cmd.getNextArgRequired();
6444 String value = cmd.getNextArgRequired();
6445 intent.putExtra(key, Uri.parse(value));
6446 }
6447 break;
6448 case "--ecn": {
6449 String key = cmd.getNextArgRequired();
6450 String value = cmd.getNextArgRequired();
6451 ComponentName cn = ComponentName.unflattenFromString(value);
6452 if (cn == null)
6453 throw new IllegalArgumentException("Bad component name: " + value);
6454 intent.putExtra(key, cn);
6455 }
6456 break;
6457 case "--eia": {
6458 String key = cmd.getNextArgRequired();
6459 String value = cmd.getNextArgRequired();
6460 String[] strings = value.split(",");
6461 int[] list = new int[strings.length];
6462 for (int i = 0; i < strings.length; i++) {
6463 list[i] = Integer.decode(strings[i]);
6464 }
6465 intent.putExtra(key, list);
6466 }
6467 break;
6468 case "--eial": {
6469 String key = cmd.getNextArgRequired();
6470 String value = cmd.getNextArgRequired();
6471 String[] strings = value.split(",");
6472 ArrayList<Integer> list = new ArrayList<>(strings.length);
6473 for (int i = 0; i < strings.length; i++) {
6474 list.add(Integer.decode(strings[i]));
6475 }
6476 intent.putExtra(key, list);
6477 }
6478 break;
6479 case "--el": {
6480 String key = cmd.getNextArgRequired();
6481 String value = cmd.getNextArgRequired();
6482 intent.putExtra(key, Long.valueOf(value));
6483 }
6484 break;
6485 case "--ela": {
6486 String key = cmd.getNextArgRequired();
6487 String value = cmd.getNextArgRequired();
6488 String[] strings = value.split(",");
6489 long[] list = new long[strings.length];
6490 for (int i = 0; i < strings.length; i++) {
6491 list[i] = Long.valueOf(strings[i]);
6492 }
6493 intent.putExtra(key, list);
6494 hasIntentInfo = true;
6495 }
6496 break;
6497 case "--elal": {
6498 String key = cmd.getNextArgRequired();
6499 String value = cmd.getNextArgRequired();
6500 String[] strings = value.split(",");
6501 ArrayList<Long> list = new ArrayList<>(strings.length);
6502 for (int i = 0; i < strings.length; i++) {
6503 list.add(Long.valueOf(strings[i]));
6504 }
6505 intent.putExtra(key, list);
6506 hasIntentInfo = true;
6507 }
6508 break;
6509 case "--ef": {
6510 String key = cmd.getNextArgRequired();
6511 String value = cmd.getNextArgRequired();
6512 intent.putExtra(key, Float.valueOf(value));
6513 hasIntentInfo = true;
6514 }
6515 break;
6516 case "--efa": {
6517 String key = cmd.getNextArgRequired();
6518 String value = cmd.getNextArgRequired();
6519 String[] strings = value.split(",");
6520 float[] list = new float[strings.length];
6521 for (int i = 0; i < strings.length; i++) {
6522 list[i] = Float.valueOf(strings[i]);
6523 }
6524 intent.putExtra(key, list);
6525 hasIntentInfo = true;
6526 }
6527 break;
6528 case "--efal": {
6529 String key = cmd.getNextArgRequired();
6530 String value = cmd.getNextArgRequired();
6531 String[] strings = value.split(",");
6532 ArrayList<Float> list = new ArrayList<>(strings.length);
6533 for (int i = 0; i < strings.length; i++) {
6534 list.add(Float.valueOf(strings[i]));
6535 }
6536 intent.putExtra(key, list);
6537 hasIntentInfo = true;
6538 }
6539 break;
6540 case "--esa": {
6541 String key = cmd.getNextArgRequired();
6542 String value = cmd.getNextArgRequired();
6543 // Split on commas unless they are preceeded by an escape.
6544 // The escape character must be escaped for the string and
6545 // again for the regex, thus four escape characters become one.
6546 String[] strings = value.split("(?<!\\\\),");
6547 intent.putExtra(key, strings);
6548 hasIntentInfo = true;
6549 }
6550 break;
6551 case "--esal": {
6552 String key = cmd.getNextArgRequired();
6553 String value = cmd.getNextArgRequired();
6554 // Split on commas unless they are preceeded by an escape.
6555 // The escape character must be escaped for the string and
6556 // again for the regex, thus four escape characters become one.
6557 String[] strings = value.split("(?<!\\\\),");
6558 ArrayList<String> list = new ArrayList<>(strings.length);
6559 for (int i = 0; i < strings.length; i++) {
6560 list.add(strings[i]);
6561 }
6562 intent.putExtra(key, list);
6563 hasIntentInfo = true;
6564 }
6565 break;
6566 case "--ez": {
6567 String key = cmd.getNextArgRequired();
6568 String value = cmd.getNextArgRequired().toLowerCase();
6569 // Boolean.valueOf() results in false for anything that is not "true", which is
6570 // error-prone in shell commands
6571 boolean arg;
6572 if ("true".equals(value) || "t".equals(value)) {
6573 arg = true;
6574 } else if ("false".equals(value) || "f".equals(value)) {
6575 arg = false;
6576 } else {
6577 try {
6578 arg = Integer.decode(value) != 0;
6579 } catch (NumberFormatException ex) {
6580 throw new IllegalArgumentException("Invalid boolean value: " + value);
6581 }
6582 }
6583
6584 intent.putExtra(key, arg);
6585 }
6586 break;
6587 case "-n": {
6588 String str = cmd.getNextArgRequired();
6589 ComponentName cn = ComponentName.unflattenFromString(str);
6590 if (cn == null)
6591 throw new IllegalArgumentException("Bad component name: " + str);
6592 intent.setComponent(cn);
6593 if (intent == baseIntent) {
6594 hasIntentInfo = true;
6595 }
6596 }
6597 break;
6598 case "-p": {
6599 String str = cmd.getNextArgRequired();
6600 intent.setPackage(str);
6601 if (intent == baseIntent) {
6602 hasIntentInfo = true;
6603 }
6604 }
6605 break;
6606 case "-f":
6607 String str = cmd.getNextArgRequired();
6608 intent.setFlags(Integer.decode(str).intValue());
6609 break;
6610 case "--grant-read-uri-permission":
6611 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6612 break;
6613 case "--grant-write-uri-permission":
6614 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6615 break;
6616 case "--grant-persistable-uri-permission":
6617 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6618 break;
6619 case "--grant-prefix-uri-permission":
6620 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6621 break;
6622 case "--exclude-stopped-packages":
6623 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6624 break;
6625 case "--include-stopped-packages":
6626 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6627 break;
6628 case "--debug-log-resolution":
6629 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6630 break;
6631 case "--activity-brought-to-front":
6632 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6633 break;
6634 case "--activity-clear-top":
6635 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6636 break;
6637 case "--activity-clear-when-task-reset":
6638 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6639 break;
6640 case "--activity-exclude-from-recents":
6641 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6642 break;
6643 case "--activity-launched-from-history":
6644 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6645 break;
6646 case "--activity-multiple-task":
6647 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6648 break;
6649 case "--activity-no-animation":
6650 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6651 break;
6652 case "--activity-no-history":
6653 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6654 break;
6655 case "--activity-no-user-action":
6656 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6657 break;
6658 case "--activity-previous-is-top":
6659 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6660 break;
6661 case "--activity-reorder-to-front":
6662 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6663 break;
6664 case "--activity-reset-task-if-needed":
6665 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6666 break;
6667 case "--activity-single-top":
6668 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6669 break;
6670 case "--activity-clear-task":
6671 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6672 break;
6673 case "--activity-task-on-home":
6674 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6675 break;
6676 case "--receiver-registered-only":
6677 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6678 break;
6679 case "--receiver-replace-pending":
6680 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6681 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006682 case "--receiver-foreground":
6683 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6684 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006685 case "--receiver-no-abort":
6686 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6687 break;
6688 case "--receiver-include-background":
6689 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6690 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006691 case "--selector":
6692 intent.setDataAndType(data, type);
6693 intent = new Intent();
6694 break;
6695 default:
6696 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6697 // Okay, caller handled this option.
6698 } else {
6699 throw new IllegalArgumentException("Unknown option: " + opt);
6700 }
6701 break;
6702 }
6703 }
6704 intent.setDataAndType(data, type);
6705
6706 final boolean hasSelector = intent != baseIntent;
6707 if (hasSelector) {
6708 // A selector was specified; fix up.
6709 baseIntent.setSelector(intent);
6710 intent = baseIntent;
6711 }
6712
6713 String arg = cmd.getNextArg();
6714 baseIntent = null;
6715 if (arg == null) {
6716 if (hasSelector) {
6717 // If a selector has been specified, and no arguments
6718 // have been supplied for the main Intent, then we can
6719 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6720 // need to have a component name specified yet, the
6721 // selector will take care of that.
6722 baseIntent = new Intent(Intent.ACTION_MAIN);
6723 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6724 }
6725 } else if (arg.indexOf(':') >= 0) {
6726 // The argument is a URI. Fully parse it, and use that result
6727 // to fill in any data not specified so far.
6728 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6729 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6730 } else if (arg.indexOf('/') >= 0) {
6731 // The argument is a component name. Build an Intent to launch
6732 // it.
6733 baseIntent = new Intent(Intent.ACTION_MAIN);
6734 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6735 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6736 } else {
6737 // Assume the argument is a package name.
6738 baseIntent = new Intent(Intent.ACTION_MAIN);
6739 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6740 baseIntent.setPackage(arg);
6741 }
6742 if (baseIntent != null) {
6743 Bundle extras = intent.getExtras();
6744 intent.replaceExtras((Bundle)null);
6745 Bundle uriExtras = baseIntent.getExtras();
6746 baseIntent.replaceExtras((Bundle)null);
6747 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6748 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6749 for (String c : cats) {
6750 baseIntent.removeCategory(c);
6751 }
6752 }
6753 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6754 if (extras == null) {
6755 extras = uriExtras;
6756 } else if (uriExtras != null) {
6757 uriExtras.putAll(extras);
6758 extras = uriExtras;
6759 }
6760 intent.replaceExtras(extras);
6761 hasIntentInfo = true;
6762 }
6763
6764 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6765 return intent;
6766 }
6767
6768 /** @hide */
6769 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6770 final String[] lines = new String[] {
6771 "<INTENT> specifications include these flags and arguments:",
6772 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6773 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6774 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6775 " [--esn <EXTRA_KEY> ...]",
6776 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6777 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6778 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6779 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6780 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6781 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6782 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6783 " (mutiple extras passed as Integer[])",
6784 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6785 " (mutiple extras passed as List<Integer>)",
6786 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6787 " (mutiple extras passed as Long[])",
6788 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6789 " (mutiple extras passed as List<Long>)",
6790 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6791 " (mutiple extras passed as Float[])",
6792 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6793 " (mutiple extras passed as List<Float>)",
6794 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6795 " (mutiple extras passed as String[]; to embed a comma into a string,",
6796 " escape it using \"\\,\")",
6797 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6798 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6799 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006800 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006801 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6802 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6803 " [--debug-log-resolution] [--exclude-stopped-packages]",
6804 " [--include-stopped-packages]",
6805 " [--activity-brought-to-front] [--activity-clear-top]",
6806 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6807 " [--activity-launched-from-history] [--activity-multiple-task]",
6808 " [--activity-no-animation] [--activity-no-history]",
6809 " [--activity-no-user-action] [--activity-previous-is-top]",
6810 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6811 " [--activity-single-top] [--activity-clear-task]",
6812 " [--activity-task-on-home]",
6813 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006814 " [--receiver-foreground] [--receiver-no-abort]",
6815 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006816 " [--selector]",
6817 " [<URI> | <PACKAGE> | <COMPONENT>]"
6818 };
6819 for (String line : lines) {
6820 pw.print(prefix);
6821 pw.println(line);
6822 }
6823 }
6824
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006825 /**
6826 * Retrieve the general action to be performed, such as
6827 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6828 * the information in the intent should be interpreted -- most importantly,
6829 * what to do with the data returned by {@link #getData}.
6830 *
6831 * @return The action of this intent or null if none is specified.
6832 *
6833 * @see #setAction
6834 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006835 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006836 return mAction;
6837 }
6838
6839 /**
6840 * Retrieve data this intent is operating on. This URI specifies the name
6841 * of the data; often it uses the content: scheme, specifying data in a
6842 * content provider. Other schemes may be handled by specific activities,
6843 * such as http: by the web browser.
6844 *
6845 * @return The URI of the data this intent is targeting or null.
6846 *
6847 * @see #getScheme
6848 * @see #setData
6849 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006850 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006851 return mData;
6852 }
6853
6854 /**
6855 * The same as {@link #getData()}, but returns the URI as an encoded
6856 * String.
6857 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006858 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 return mData != null ? mData.toString() : null;
6860 }
6861
6862 /**
6863 * Return the scheme portion of the intent's data. If the data is null or
6864 * does not include a scheme, null is returned. Otherwise, the scheme
6865 * prefix without the final ':' is returned, i.e. "http".
6866 *
6867 * <p>This is the same as calling getData().getScheme() (and checking for
6868 * null data).
6869 *
6870 * @return The scheme of this intent.
6871 *
6872 * @see #getData
6873 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006874 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006875 return mData != null ? mData.getScheme() : null;
6876 }
6877
6878 /**
6879 * Retrieve any explicit MIME type included in the intent. This is usually
6880 * null, as the type is determined by the intent data.
6881 *
6882 * @return If a type was manually set, it is returned; else null is
6883 * returned.
6884 *
6885 * @see #resolveType(ContentResolver)
6886 * @see #setType
6887 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006888 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 return mType;
6890 }
6891
6892 /**
6893 * Return the MIME data type of this intent. If the type field is
6894 * explicitly set, that is simply returned. Otherwise, if the data is set,
6895 * the type of that data is returned. If neither fields are set, a null is
6896 * returned.
6897 *
6898 * @return The MIME type of this intent.
6899 *
6900 * @see #getType
6901 * @see #resolveType(ContentResolver)
6902 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006903 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006904 return resolveType(context.getContentResolver());
6905 }
6906
6907 /**
6908 * Return the MIME data type of this intent. If the type field is
6909 * explicitly set, that is simply returned. Otherwise, if the data is set,
6910 * the type of that data is returned. If neither fields are set, a null is
6911 * returned.
6912 *
6913 * @param resolver A ContentResolver that can be used to determine the MIME
6914 * type of the intent's data.
6915 *
6916 * @return The MIME type of this intent.
6917 *
6918 * @see #getType
6919 * @see #resolveType(Context)
6920 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006921 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006922 if (mType != null) {
6923 return mType;
6924 }
6925 if (mData != null) {
6926 if ("content".equals(mData.getScheme())) {
6927 return resolver.getType(mData);
6928 }
6929 }
6930 return null;
6931 }
6932
6933 /**
6934 * Return the MIME data type of this intent, only if it will be needed for
6935 * intent resolution. This is not generally useful for application code;
6936 * it is used by the frameworks for communicating with back-end system
6937 * services.
6938 *
6939 * @param resolver A ContentResolver that can be used to determine the MIME
6940 * type of the intent's data.
6941 *
6942 * @return The MIME type of this intent, or null if it is unknown or not
6943 * needed.
6944 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006945 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006946 if (mComponent != null) {
6947 return mType;
6948 }
6949 return resolveType(resolver);
6950 }
6951
6952 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006953 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006954 *
6955 * @param category The category to check.
6956 *
6957 * @return boolean True if the intent contains the category, else false.
6958 *
6959 * @see #getCategories
6960 * @see #addCategory
6961 */
6962 public boolean hasCategory(String category) {
6963 return mCategories != null && mCategories.contains(category);
6964 }
6965
6966 /**
6967 * Return the set of all categories in the intent. If there are no categories,
6968 * returns NULL.
6969 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006970 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006971 *
6972 * @see #hasCategory
6973 * @see #addCategory
6974 */
6975 public Set<String> getCategories() {
6976 return mCategories;
6977 }
6978
6979 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006980 * Return the specific selector associated with this Intent. If there is
6981 * none, returns null. See {@link #setSelector} for more information.
6982 *
6983 * @see #setSelector
6984 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006985 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006986 return mSelector;
6987 }
6988
6989 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006990 * Return the {@link ClipData} associated with this Intent. If there is
6991 * none, returns null. See {@link #setClipData} for more information.
6992 *
John Spurlock125d1332013-11-25 11:58:37 -05006993 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006994 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006995 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006996 return mClipData;
6997 }
6998
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006999 /** @hide */
7000 public int getContentUserHint() {
7001 return mContentUserHint;
7002 }
7003
Todd Kennedyb3b431302017-03-20 16:05:48 -07007004 /** @hide */
7005 public String getLaunchToken() {
7006 return mLaunchToken;
7007 }
7008
7009 /** @hide */
7010 public void setLaunchToken(String launchToken) {
7011 mLaunchToken = launchToken;
7012 }
7013
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007015 * Sets the ClassLoader that will be used when unmarshalling
7016 * any Parcelable values from the extras of this Intent.
7017 *
7018 * @param loader a ClassLoader, or null to use the default loader
7019 * at the time of unmarshalling.
7020 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007021 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007022 if (mExtras != null) {
7023 mExtras.setClassLoader(loader);
7024 }
7025 }
7026
7027 /**
7028 * Returns true if an extra value is associated with the given name.
7029 * @param name the extra's name
7030 * @return true if the given extra is present.
7031 */
7032 public boolean hasExtra(String name) {
7033 return mExtras != null && mExtras.containsKey(name);
7034 }
7035
7036 /**
7037 * Returns true if the Intent's extras contain a parcelled file descriptor.
7038 * @return true if the Intent contains a parcelled file descriptor.
7039 */
7040 public boolean hasFileDescriptors() {
7041 return mExtras != null && mExtras.hasFileDescriptors();
7042 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007043
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007044 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007045 public void setAllowFds(boolean allowFds) {
7046 if (mExtras != null) {
7047 mExtras.setAllowFds(allowFds);
7048 }
7049 }
7050
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007051 /** {@hide} */
7052 public void setDefusable(boolean defusable) {
7053 if (mExtras != null) {
7054 mExtras.setDefusable(defusable);
7055 }
7056 }
7057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007058 /**
7059 * Retrieve extended data from the intent.
7060 *
7061 * @param name The name of the desired item.
7062 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007063 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007064 * or null if none was found.
7065 *
7066 * @deprecated
7067 * @hide
7068 */
7069 @Deprecated
7070 public Object getExtra(String name) {
7071 return getExtra(name, null);
7072 }
7073
7074 /**
7075 * Retrieve extended data from the intent.
7076 *
7077 * @param name The name of the desired item.
7078 * @param defaultValue the value to be returned if no value of the desired
7079 * type is stored with the given name.
7080 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007081 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007082 * or the default value if none was found.
7083 *
7084 * @see #putExtra(String, boolean)
7085 */
7086 public boolean getBooleanExtra(String name, boolean defaultValue) {
7087 return mExtras == null ? defaultValue :
7088 mExtras.getBoolean(name, defaultValue);
7089 }
7090
7091 /**
7092 * Retrieve extended data from the intent.
7093 *
7094 * @param name The name of the desired item.
7095 * @param defaultValue the value to be returned if no value of the desired
7096 * type is stored with the given name.
7097 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007098 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007099 * or the default value if none was found.
7100 *
7101 * @see #putExtra(String, byte)
7102 */
7103 public byte getByteExtra(String name, byte defaultValue) {
7104 return mExtras == null ? defaultValue :
7105 mExtras.getByte(name, defaultValue);
7106 }
7107
7108 /**
7109 * Retrieve extended data from the intent.
7110 *
7111 * @param name The name of the desired item.
7112 * @param defaultValue the value to be returned if no value of the desired
7113 * type is stored with the given name.
7114 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007115 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007116 * or the default value if none was found.
7117 *
7118 * @see #putExtra(String, short)
7119 */
7120 public short getShortExtra(String name, short defaultValue) {
7121 return mExtras == null ? defaultValue :
7122 mExtras.getShort(name, defaultValue);
7123 }
7124
7125 /**
7126 * Retrieve extended data from the intent.
7127 *
7128 * @param name The name of the desired item.
7129 * @param defaultValue the value to be returned if no value of the desired
7130 * type is stored with the given name.
7131 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007132 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007133 * or the default value if none was found.
7134 *
7135 * @see #putExtra(String, char)
7136 */
7137 public char getCharExtra(String name, char defaultValue) {
7138 return mExtras == null ? defaultValue :
7139 mExtras.getChar(name, defaultValue);
7140 }
7141
7142 /**
7143 * Retrieve extended data from the intent.
7144 *
7145 * @param name The name of the desired item.
7146 * @param defaultValue the value to be returned if no value of the desired
7147 * type is stored with the given name.
7148 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007149 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007150 * or the default value if none was found.
7151 *
7152 * @see #putExtra(String, int)
7153 */
7154 public int getIntExtra(String name, int defaultValue) {
7155 return mExtras == null ? defaultValue :
7156 mExtras.getInt(name, defaultValue);
7157 }
7158
7159 /**
7160 * Retrieve extended data from the intent.
7161 *
7162 * @param name The name of the desired item.
7163 * @param defaultValue the value to be returned if no value of the desired
7164 * type is stored with the given name.
7165 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007166 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007167 * or the default value if none was found.
7168 *
7169 * @see #putExtra(String, long)
7170 */
7171 public long getLongExtra(String name, long defaultValue) {
7172 return mExtras == null ? defaultValue :
7173 mExtras.getLong(name, defaultValue);
7174 }
7175
7176 /**
7177 * Retrieve extended data from the intent.
7178 *
7179 * @param name The name of the desired item.
7180 * @param defaultValue the value to be returned if no value of the desired
7181 * type is stored with the given name.
7182 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007183 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007184 * or the default value if no such item is present
7185 *
7186 * @see #putExtra(String, float)
7187 */
7188 public float getFloatExtra(String name, float defaultValue) {
7189 return mExtras == null ? defaultValue :
7190 mExtras.getFloat(name, defaultValue);
7191 }
7192
7193 /**
7194 * Retrieve extended data from the intent.
7195 *
7196 * @param name The name of the desired item.
7197 * @param defaultValue the value to be returned if no value of the desired
7198 * type is stored with the given name.
7199 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007200 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007201 * or the default value if none was found.
7202 *
7203 * @see #putExtra(String, double)
7204 */
7205 public double getDoubleExtra(String name, double defaultValue) {
7206 return mExtras == null ? defaultValue :
7207 mExtras.getDouble(name, defaultValue);
7208 }
7209
7210 /**
7211 * Retrieve extended data from the intent.
7212 *
7213 * @param name The name of the desired item.
7214 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007215 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007216 * or null if no String value was found.
7217 *
7218 * @see #putExtra(String, String)
7219 */
7220 public String getStringExtra(String name) {
7221 return mExtras == null ? null : mExtras.getString(name);
7222 }
7223
7224 /**
7225 * Retrieve extended data from the intent.
7226 *
7227 * @param name The name of the desired item.
7228 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007229 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007230 * or null if no CharSequence value was found.
7231 *
7232 * @see #putExtra(String, CharSequence)
7233 */
7234 public CharSequence getCharSequenceExtra(String name) {
7235 return mExtras == null ? null : mExtras.getCharSequence(name);
7236 }
7237
7238 /**
7239 * Retrieve extended data from the intent.
7240 *
7241 * @param name The name of the desired item.
7242 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007243 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007244 * or null if no Parcelable value was found.
7245 *
7246 * @see #putExtra(String, Parcelable)
7247 */
7248 public <T extends Parcelable> T getParcelableExtra(String name) {
7249 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7250 }
7251
7252 /**
7253 * Retrieve extended data from the intent.
7254 *
7255 * @param name The name of the desired item.
7256 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007257 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007258 * or null if no Parcelable[] value was found.
7259 *
7260 * @see #putExtra(String, Parcelable[])
7261 */
7262 public Parcelable[] getParcelableArrayExtra(String name) {
7263 return mExtras == null ? null : mExtras.getParcelableArray(name);
7264 }
7265
7266 /**
7267 * Retrieve extended data from the intent.
7268 *
7269 * @param name The name of the desired item.
7270 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007271 * @return the value of an item previously added with
7272 * putParcelableArrayListExtra(), or null if no
7273 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007274 *
7275 * @see #putParcelableArrayListExtra(String, ArrayList)
7276 */
7277 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7278 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7279 }
7280
7281 /**
7282 * Retrieve extended data from the intent.
7283 *
7284 * @param name The name of the desired item.
7285 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007286 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007287 * or null if no Serializable value was found.
7288 *
7289 * @see #putExtra(String, Serializable)
7290 */
7291 public Serializable getSerializableExtra(String name) {
7292 return mExtras == null ? null : mExtras.getSerializable(name);
7293 }
7294
7295 /**
7296 * Retrieve extended data from the intent.
7297 *
7298 * @param name The name of the desired item.
7299 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007300 * @return the value of an item previously added with
7301 * putIntegerArrayListExtra(), or null if no
7302 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007303 *
7304 * @see #putIntegerArrayListExtra(String, ArrayList)
7305 */
7306 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7307 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7308 }
7309
7310 /**
7311 * Retrieve extended data from the intent.
7312 *
7313 * @param name The name of the desired item.
7314 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007315 * @return the value of an item previously added with
7316 * putStringArrayListExtra(), or null if no
7317 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007318 *
7319 * @see #putStringArrayListExtra(String, ArrayList)
7320 */
7321 public ArrayList<String> getStringArrayListExtra(String name) {
7322 return mExtras == null ? null : mExtras.getStringArrayList(name);
7323 }
7324
7325 /**
7326 * Retrieve extended data from the intent.
7327 *
7328 * @param name The name of the desired item.
7329 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007330 * @return the value of an item previously added with
7331 * putCharSequenceArrayListExtra, or null if no
7332 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007333 *
7334 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7335 */
7336 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7337 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7338 }
7339
7340 /**
7341 * Retrieve extended data from the intent.
7342 *
7343 * @param name The name of the desired item.
7344 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007345 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007346 * or null if no boolean array value was found.
7347 *
7348 * @see #putExtra(String, boolean[])
7349 */
7350 public boolean[] getBooleanArrayExtra(String name) {
7351 return mExtras == null ? null : mExtras.getBooleanArray(name);
7352 }
7353
7354 /**
7355 * Retrieve extended data from the intent.
7356 *
7357 * @param name The name of the desired item.
7358 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007359 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007360 * or null if no byte array value was found.
7361 *
7362 * @see #putExtra(String, byte[])
7363 */
7364 public byte[] getByteArrayExtra(String name) {
7365 return mExtras == null ? null : mExtras.getByteArray(name);
7366 }
7367
7368 /**
7369 * Retrieve extended data from the intent.
7370 *
7371 * @param name The name of the desired item.
7372 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007373 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007374 * or null if no short array value was found.
7375 *
7376 * @see #putExtra(String, short[])
7377 */
7378 public short[] getShortArrayExtra(String name) {
7379 return mExtras == null ? null : mExtras.getShortArray(name);
7380 }
7381
7382 /**
7383 * Retrieve extended data from the intent.
7384 *
7385 * @param name The name of the desired item.
7386 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007387 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007388 * or null if no char array value was found.
7389 *
7390 * @see #putExtra(String, char[])
7391 */
7392 public char[] getCharArrayExtra(String name) {
7393 return mExtras == null ? null : mExtras.getCharArray(name);
7394 }
7395
7396 /**
7397 * Retrieve extended data from the intent.
7398 *
7399 * @param name The name of the desired item.
7400 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007401 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007402 * or null if no int array value was found.
7403 *
7404 * @see #putExtra(String, int[])
7405 */
7406 public int[] getIntArrayExtra(String name) {
7407 return mExtras == null ? null : mExtras.getIntArray(name);
7408 }
7409
7410 /**
7411 * Retrieve extended data from the intent.
7412 *
7413 * @param name The name of the desired item.
7414 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007415 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007416 * or null if no long array value was found.
7417 *
7418 * @see #putExtra(String, long[])
7419 */
7420 public long[] getLongArrayExtra(String name) {
7421 return mExtras == null ? null : mExtras.getLongArray(name);
7422 }
7423
7424 /**
7425 * Retrieve extended data from the intent.
7426 *
7427 * @param name The name of the desired item.
7428 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007429 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007430 * or null if no float array value was found.
7431 *
7432 * @see #putExtra(String, float[])
7433 */
7434 public float[] getFloatArrayExtra(String name) {
7435 return mExtras == null ? null : mExtras.getFloatArray(name);
7436 }
7437
7438 /**
7439 * Retrieve extended data from the intent.
7440 *
7441 * @param name The name of the desired item.
7442 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007443 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007444 * or null if no double array value was found.
7445 *
7446 * @see #putExtra(String, double[])
7447 */
7448 public double[] getDoubleArrayExtra(String name) {
7449 return mExtras == null ? null : mExtras.getDoubleArray(name);
7450 }
7451
7452 /**
7453 * Retrieve extended data from the intent.
7454 *
7455 * @param name The name of the desired item.
7456 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007457 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007458 * or null if no String array value was found.
7459 *
7460 * @see #putExtra(String, String[])
7461 */
7462 public String[] getStringArrayExtra(String name) {
7463 return mExtras == null ? null : mExtras.getStringArray(name);
7464 }
7465
7466 /**
7467 * Retrieve extended data from the intent.
7468 *
7469 * @param name The name of the desired item.
7470 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007471 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007472 * or null if no CharSequence array value was found.
7473 *
7474 * @see #putExtra(String, CharSequence[])
7475 */
7476 public CharSequence[] getCharSequenceArrayExtra(String name) {
7477 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7478 }
7479
7480 /**
7481 * Retrieve extended data from the intent.
7482 *
7483 * @param name The name of the desired item.
7484 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007485 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007486 * or null if no Bundle value was found.
7487 *
7488 * @see #putExtra(String, Bundle)
7489 */
7490 public Bundle getBundleExtra(String name) {
7491 return mExtras == null ? null : mExtras.getBundle(name);
7492 }
7493
7494 /**
7495 * Retrieve extended data from the intent.
7496 *
7497 * @param name The name of the desired item.
7498 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007499 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007500 * or null if no IBinder value was found.
7501 *
7502 * @see #putExtra(String, IBinder)
7503 *
7504 * @deprecated
7505 * @hide
7506 */
7507 @Deprecated
7508 public IBinder getIBinderExtra(String name) {
7509 return mExtras == null ? null : mExtras.getIBinder(name);
7510 }
7511
7512 /**
7513 * Retrieve extended data from the intent.
7514 *
7515 * @param name The name of the desired item.
7516 * @param defaultValue The default value to return in case no item is
7517 * associated with the key 'name'
7518 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007519 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007520 * or defaultValue if none was found.
7521 *
7522 * @see #putExtra
7523 *
7524 * @deprecated
7525 * @hide
7526 */
7527 @Deprecated
7528 public Object getExtra(String name, Object defaultValue) {
7529 Object result = defaultValue;
7530 if (mExtras != null) {
7531 Object result2 = mExtras.get(name);
7532 if (result2 != null) {
7533 result = result2;
7534 }
7535 }
7536
7537 return result;
7538 }
7539
7540 /**
7541 * Retrieves a map of extended data from the intent.
7542 *
7543 * @return the map of all extras previously added with putExtra(),
7544 * or null if none have been added.
7545 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007546 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007547 return (mExtras != null)
7548 ? new Bundle(mExtras)
7549 : null;
7550 }
7551
7552 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007553 * Filter extras to only basic types.
7554 * @hide
7555 */
7556 public void removeUnsafeExtras() {
7557 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007558 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007559 }
7560 }
7561
7562 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007563 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7564 * return itself as-is.
7565 * @hide
7566 */
7567 public boolean canStripForHistory() {
7568 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7569 }
7570
7571 /**
7572 * Call it when the system needs to keep an intent for logging purposes to remove fields
7573 * that are not needed for logging.
7574 * @hide
7575 */
7576 public Intent maybeStripForHistory() {
7577 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7578
7579 if (!canStripForHistory()) {
7580 return this;
7581 }
7582 return new Intent(this, COPY_MODE_HISTORY);
7583 }
7584
7585 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007586 * Retrieve any special flags associated with this intent. You will
7587 * normally just set them with {@link #setFlags} and let the system
7588 * take the appropriate action with them.
7589 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007590 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007591 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007592 * @see #addFlags
7593 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007594 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007595 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007596 return mFlags;
7597 }
7598
Dianne Hackborne7f97212011-02-24 14:40:20 -08007599 /** @hide */
7600 public boolean isExcludingStopped() {
7601 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7602 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7603 }
7604
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007605 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007606 * Retrieve the application package name this Intent is limited to. When
7607 * resolving an Intent, if non-null this limits the resolution to only
7608 * components in the given application package.
7609 *
7610 * @return The name of the application package for the Intent.
7611 *
7612 * @see #resolveActivity
7613 * @see #setPackage
7614 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007615 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007616 return mPackage;
7617 }
7618
7619 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007620 * Retrieve the concrete component associated with the intent. When receiving
7621 * an intent, this is the component that was found to best handle it (that is,
7622 * yourself) and will always be non-null; in all other cases it will be
7623 * null unless explicitly set.
7624 *
7625 * @return The name of the application component to handle the intent.
7626 *
7627 * @see #resolveActivity
7628 * @see #setComponent
7629 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007630 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007631 return mComponent;
7632 }
7633
7634 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007635 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7636 * used as a hint to the receiver for animations and the like. Null means that there
7637 * is no source bounds.
7638 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007639 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007640 return mSourceBounds;
7641 }
7642
7643 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007644 * Return the Activity component that should be used to handle this intent.
7645 * The appropriate component is determined based on the information in the
7646 * intent, evaluated as follows:
7647 *
7648 * <p>If {@link #getComponent} returns an explicit class, that is returned
7649 * without any further consideration.
7650 *
7651 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7652 * category to be considered.
7653 *
7654 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7655 * action.
7656 *
7657 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7658 * this type.
7659 *
7660 * <p>If {@link #addCategory} has added any categories, the activity must
7661 * handle ALL of the categories specified.
7662 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007663 * <p>If {@link #getPackage} is non-NULL, only activity components in
7664 * that application package will be considered.
7665 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007666 * <p>If there are no activities that satisfy all of these conditions, a
7667 * null string is returned.
7668 *
7669 * <p>If multiple activities are found to satisfy the intent, the one with
7670 * the highest priority will be used. If there are multiple activities
7671 * with the same priority, the system will either pick the best activity
7672 * based on user preference, or resolve to a system class that will allow
7673 * the user to pick an activity and forward from there.
7674 *
7675 * <p>This method is implemented simply by calling
7676 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7677 * true.</p>
7678 * <p> This API is called for you as part of starting an activity from an
7679 * intent. You do not normally need to call it yourself.</p>
7680 *
7681 * @param pm The package manager with which to resolve the Intent.
7682 *
7683 * @return Name of the component implementing an activity that can
7684 * display the intent.
7685 *
7686 * @see #setComponent
7687 * @see #getComponent
7688 * @see #resolveActivityInfo
7689 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007690 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007691 if (mComponent != null) {
7692 return mComponent;
7693 }
7694
7695 ResolveInfo info = pm.resolveActivity(
7696 this, PackageManager.MATCH_DEFAULT_ONLY);
7697 if (info != null) {
7698 return new ComponentName(
7699 info.activityInfo.applicationInfo.packageName,
7700 info.activityInfo.name);
7701 }
7702
7703 return null;
7704 }
7705
7706 /**
7707 * Resolve the Intent into an {@link ActivityInfo}
7708 * describing the activity that should execute the intent. Resolution
7709 * follows the same rules as described for {@link #resolveActivity}, but
7710 * you get back the completely information about the resolved activity
7711 * instead of just its class name.
7712 *
7713 * @param pm The package manager with which to resolve the Intent.
7714 * @param flags Addition information to retrieve as per
7715 * {@link PackageManager#getActivityInfo(ComponentName, int)
7716 * PackageManager.getActivityInfo()}.
7717 *
7718 * @return PackageManager.ActivityInfo
7719 *
7720 * @see #resolveActivity
7721 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007722 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7723 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007724 ActivityInfo ai = null;
7725 if (mComponent != null) {
7726 try {
7727 ai = pm.getActivityInfo(mComponent, flags);
7728 } catch (PackageManager.NameNotFoundException e) {
7729 // ignore
7730 }
7731 } else {
7732 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007733 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007734 if (info != null) {
7735 ai = info.activityInfo;
7736 }
7737 }
7738
7739 return ai;
7740 }
7741
7742 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007743 * Special function for use by the system to resolve service
7744 * intents to system apps. Throws an exception if there are
7745 * multiple potential matches to the Intent. Returns null if
7746 * there are no matches.
7747 * @hide
7748 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007749 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7750 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007751 if (mComponent != null) {
7752 return mComponent;
7753 }
7754
7755 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7756 if (results == null) {
7757 return null;
7758 }
7759 ComponentName comp = null;
7760 for (int i=0; i<results.size(); i++) {
7761 ResolveInfo ri = results.get(i);
7762 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7763 continue;
7764 }
7765 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7766 ri.serviceInfo.name);
7767 if (comp != null) {
7768 throw new IllegalStateException("Multiple system services handle " + this
7769 + ": " + comp + ", " + foundComp);
7770 }
7771 comp = foundComp;
7772 }
7773 return comp;
7774 }
7775
7776 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007777 * Set the general action to be performed.
7778 *
7779 * @param action An action name, such as ACTION_VIEW. Application-specific
7780 * actions should be prefixed with the vendor's package name.
7781 *
7782 * @return Returns the same Intent object, for chaining multiple calls
7783 * into a single statement.
7784 *
7785 * @see #getAction
7786 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007787 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007788 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007789 return this;
7790 }
7791
7792 /**
7793 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007794 * clears any type that was previously set by {@link #setType} or
7795 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007796 *
Nick Pellyccae4122012-01-09 14:12:58 -08007797 * <p><em>Note: scheme matching in the Android framework is
7798 * case-sensitive, unlike the formal RFC. As a result,
7799 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007800 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007801 * {@link #setDataAndNormalize}
7802 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007803 *
Nick Pellyccae4122012-01-09 14:12:58 -08007804 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007805 *
7806 * @return Returns the same Intent object, for chaining multiple calls
7807 * into a single statement.
7808 *
7809 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007810 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007811 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007812 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007813 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007814 mData = data;
7815 mType = null;
7816 return this;
7817 }
7818
7819 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007820 * Normalize and set the data this intent is operating on.
7821 *
7822 * <p>This method automatically clears any type that was
7823 * previously set (for example, by {@link #setType}).
7824 *
7825 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007826 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007827 * so really this is just a convenience method for
7828 * <pre>
7829 * setData(data.normalize())
7830 * </pre>
7831 *
7832 * @param data The Uri of the data this intent is now targeting.
7833 *
7834 * @return Returns the same Intent object, for chaining multiple calls
7835 * into a single statement.
7836 *
7837 * @see #getData
7838 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007839 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007840 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007841 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007842 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007843 }
7844
7845 /**
7846 * Set an explicit MIME data type.
7847 *
7848 * <p>This is used to create intents that only specify a type and not data,
7849 * for example to indicate the type of data to return.
7850 *
7851 * <p>This method automatically clears any data that was
7852 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007853 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007854 * <p><em>Note: MIME type matching in the Android framework is
7855 * case-sensitive, unlike formal RFC MIME types. As a result,
7856 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007857 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7858 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007859 *
7860 * @param type The MIME type of the data being handled by this intent.
7861 *
7862 * @return Returns the same Intent object, for chaining multiple calls
7863 * into a single statement.
7864 *
7865 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007866 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007867 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007868 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007869 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007870 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007871 mData = null;
7872 mType = type;
7873 return this;
7874 }
7875
7876 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007877 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007878 *
Nick Pellyccae4122012-01-09 14:12:58 -08007879 * <p>This is used to create intents that only specify a type and not data,
7880 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007881 *
Nick Pellyccae4122012-01-09 14:12:58 -08007882 * <p>This method automatically clears any data that was
7883 * previously set (for example by {@link #setData}).
7884 *
7885 * <p>The MIME type is normalized using
7886 * {@link #normalizeMimeType} before it is set,
7887 * so really this is just a convenience method for
7888 * <pre>
7889 * setType(Intent.normalizeMimeType(type))
7890 * </pre>
7891 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007892 * @param type The MIME type of the data being handled by this intent.
7893 *
7894 * @return Returns the same Intent object, for chaining multiple calls
7895 * into a single statement.
7896 *
Nick Pellyccae4122012-01-09 14:12:58 -08007897 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007898 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007899 * @see #normalizeMimeType
7900 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007901 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007902 return setType(normalizeMimeType(type));
7903 }
7904
7905 /**
7906 * (Usually optional) Set the data for the intent along with an explicit
7907 * MIME data type. This method should very rarely be used -- it allows you
7908 * to override the MIME type that would ordinarily be inferred from the
7909 * data with your own type given here.
7910 *
7911 * <p><em>Note: MIME type and Uri scheme matching in the
7912 * Android framework is case-sensitive, unlike the formal RFC definitions.
7913 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007914 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007915 * {@link #setDataAndTypeAndNormalize}
7916 * to ensure that they are converted to lower case.</em>
7917 *
7918 * @param data The Uri of the data this intent is now targeting.
7919 * @param type The MIME type of the data being handled by this intent.
7920 *
7921 * @return Returns the same Intent object, for chaining multiple calls
7922 * into a single statement.
7923 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007924 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007925 * @see #setData
7926 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007927 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007928 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007929 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007930 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007931 mData = data;
7932 mType = type;
7933 return this;
7934 }
7935
7936 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007937 * (Usually optional) Normalize and set both the data Uri and an explicit
7938 * MIME data type. This method should very rarely be used -- it allows you
7939 * to override the MIME type that would ordinarily be inferred from the
7940 * data with your own type given here.
7941 *
7942 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007943 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007944 * before they are set, so really this is just a convenience method for
7945 * <pre>
7946 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7947 * </pre>
7948 *
7949 * @param data The Uri of the data this intent is now targeting.
7950 * @param type The MIME type of the data being handled by this intent.
7951 *
7952 * @return Returns the same Intent object, for chaining multiple calls
7953 * into a single statement.
7954 *
7955 * @see #setType
7956 * @see #setData
7957 * @see #setDataAndType
7958 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007959 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007960 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007961 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007962 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007963 }
7964
7965 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007966 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007967 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007968 * activities that provide <em>all</em> of the requested categories will be
7969 * used.
7970 *
7971 * @param category The desired category. This can be either one of the
7972 * predefined Intent categories, or a custom category in your own
7973 * namespace.
7974 *
7975 * @return Returns the same Intent object, for chaining multiple calls
7976 * into a single statement.
7977 *
7978 * @see #hasCategory
7979 * @see #removeCategory
7980 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007981 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007982 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007983 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007984 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007985 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007986 return this;
7987 }
7988
7989 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007990 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007991 *
7992 * @param category The category to remove.
7993 *
7994 * @see #addCategory
7995 */
7996 public void removeCategory(String category) {
7997 if (mCategories != null) {
7998 mCategories.remove(category);
7999 if (mCategories.size() == 0) {
8000 mCategories = null;
8001 }
8002 }
8003 }
8004
8005 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008006 * Set a selector for this Intent. This is a modification to the kinds of
8007 * things the Intent will match. If the selector is set, it will be used
8008 * when trying to find entities that can handle the Intent, instead of the
8009 * main contents of the Intent. This allows you build an Intent containing
8010 * a generic protocol while targeting it more specifically.
8011 *
8012 * <p>An example of where this may be used is with things like
8013 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8014 * Intent that will launch the Browser application. However, the correct
8015 * main entry point of an application is actually {@link #ACTION_MAIN}
8016 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8017 * used to specify the actual Activity to launch. If you launch the browser
8018 * with something different, undesired behavior may happen if the user has
8019 * previously or later launches it the normal way, since they do not match.
8020 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8021 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8022 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8023 *
8024 * <p>Setting a selector does not impact the behavior of
8025 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8026 * desired behavior of a selector -- it does not impact the base meaning
8027 * of the Intent, just what kinds of things will be matched against it
8028 * when determining who can handle it.</p>
8029 *
8030 * <p>You can not use both a selector and {@link #setPackage(String)} on
8031 * the same base Intent.</p>
8032 *
8033 * @param selector The desired selector Intent; set to null to not use
8034 * a special selector.
8035 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008036 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008037 if (selector == this) {
8038 throw new IllegalArgumentException(
8039 "Intent being set as a selector of itself");
8040 }
8041 if (selector != null && mPackage != null) {
8042 throw new IllegalArgumentException(
8043 "Can't set selector when package name is already set");
8044 }
8045 mSelector = selector;
8046 }
8047
8048 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008049 * Set a {@link ClipData} associated with this Intent. This replaces any
8050 * previously set ClipData.
8051 *
8052 * <p>The ClipData in an intent is not used for Intent matching or other
8053 * such operations. Semantically it is like extras, used to transmit
8054 * additional data with the Intent. The main feature of using this over
8055 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8056 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8057 * items included in the clip data. This is useful, in particular, if
8058 * you want to transmit an Intent containing multiple <code>content:</code>
8059 * URIs for which the recipient may not have global permission to access the
8060 * content provider.
8061 *
8062 * <p>If the ClipData contains items that are themselves Intents, any
8063 * grant flags in those Intents will be ignored. Only the top-level flags
8064 * of the main Intent are respected, and will be applied to all Uri or
8065 * Intent items in the clip (or sub-items of the clip).
8066 *
8067 * <p>The MIME type, label, and icon in the ClipData object are not
8068 * directly used by Intent. Applications should generally rely on the
8069 * MIME type of the Intent itself, not what it may find in the ClipData.
8070 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008071 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008072 *
8073 * @param clip The new clip to set. May be null to clear the current clip.
8074 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008075 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008076 mClipData = clip;
8077 }
8078
8079 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008080 * This is NOT a secure mechanism to identify the user who sent the intent.
8081 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8082 * who sent the intent.
8083 * @hide
8084 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008085 public void prepareToLeaveUser(int userId) {
8086 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8087 // We want mContentUserHint to refer to the original user, so don't do anything.
8088 if (mContentUserHint == UserHandle.USER_CURRENT) {
8089 mContentUserHint = userId;
8090 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008091 }
8092
8093 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008094 * Add extended data to the intent. The name must include a package
8095 * prefix, for example the app com.android.contacts would use names
8096 * like "com.android.contacts.ShowAll".
8097 *
8098 * @param name The name of the extra data, with package prefix.
8099 * @param value The boolean data value.
8100 *
8101 * @return Returns the same Intent object, for chaining multiple calls
8102 * into a single statement.
8103 *
8104 * @see #putExtras
8105 * @see #removeExtra
8106 * @see #getBooleanExtra(String, boolean)
8107 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008108 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008109 if (mExtras == null) {
8110 mExtras = new Bundle();
8111 }
8112 mExtras.putBoolean(name, value);
8113 return this;
8114 }
8115
8116 /**
8117 * Add extended data to the intent. The name must include a package
8118 * prefix, for example the app com.android.contacts would use names
8119 * like "com.android.contacts.ShowAll".
8120 *
8121 * @param name The name of the extra data, with package prefix.
8122 * @param value The byte data value.
8123 *
8124 * @return Returns the same Intent object, for chaining multiple calls
8125 * into a single statement.
8126 *
8127 * @see #putExtras
8128 * @see #removeExtra
8129 * @see #getByteExtra(String, byte)
8130 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008131 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008132 if (mExtras == null) {
8133 mExtras = new Bundle();
8134 }
8135 mExtras.putByte(name, value);
8136 return this;
8137 }
8138
8139 /**
8140 * Add extended data to the intent. The name must include a package
8141 * prefix, for example the app com.android.contacts would use names
8142 * like "com.android.contacts.ShowAll".
8143 *
8144 * @param name The name of the extra data, with package prefix.
8145 * @param value The char data value.
8146 *
8147 * @return Returns the same Intent object, for chaining multiple calls
8148 * into a single statement.
8149 *
8150 * @see #putExtras
8151 * @see #removeExtra
8152 * @see #getCharExtra(String, char)
8153 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008154 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008155 if (mExtras == null) {
8156 mExtras = new Bundle();
8157 }
8158 mExtras.putChar(name, value);
8159 return this;
8160 }
8161
8162 /**
8163 * Add extended data to the intent. The name must include a package
8164 * prefix, for example the app com.android.contacts would use names
8165 * like "com.android.contacts.ShowAll".
8166 *
8167 * @param name The name of the extra data, with package prefix.
8168 * @param value The short data value.
8169 *
8170 * @return Returns the same Intent object, for chaining multiple calls
8171 * into a single statement.
8172 *
8173 * @see #putExtras
8174 * @see #removeExtra
8175 * @see #getShortExtra(String, short)
8176 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008177 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008178 if (mExtras == null) {
8179 mExtras = new Bundle();
8180 }
8181 mExtras.putShort(name, value);
8182 return this;
8183 }
8184
8185 /**
8186 * Add extended data to the intent. The name must include a package
8187 * prefix, for example the app com.android.contacts would use names
8188 * like "com.android.contacts.ShowAll".
8189 *
8190 * @param name The name of the extra data, with package prefix.
8191 * @param value The integer data value.
8192 *
8193 * @return Returns the same Intent object, for chaining multiple calls
8194 * into a single statement.
8195 *
8196 * @see #putExtras
8197 * @see #removeExtra
8198 * @see #getIntExtra(String, int)
8199 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008200 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008201 if (mExtras == null) {
8202 mExtras = new Bundle();
8203 }
8204 mExtras.putInt(name, value);
8205 return this;
8206 }
8207
8208 /**
8209 * Add extended data to the intent. The name must include a package
8210 * prefix, for example the app com.android.contacts would use names
8211 * like "com.android.contacts.ShowAll".
8212 *
8213 * @param name The name of the extra data, with package prefix.
8214 * @param value The long data value.
8215 *
8216 * @return Returns the same Intent object, for chaining multiple calls
8217 * into a single statement.
8218 *
8219 * @see #putExtras
8220 * @see #removeExtra
8221 * @see #getLongExtra(String, long)
8222 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008223 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008224 if (mExtras == null) {
8225 mExtras = new Bundle();
8226 }
8227 mExtras.putLong(name, value);
8228 return this;
8229 }
8230
8231 /**
8232 * Add extended data to the intent. The name must include a package
8233 * prefix, for example the app com.android.contacts would use names
8234 * like "com.android.contacts.ShowAll".
8235 *
8236 * @param name The name of the extra data, with package prefix.
8237 * @param value The float data value.
8238 *
8239 * @return Returns the same Intent object, for chaining multiple calls
8240 * into a single statement.
8241 *
8242 * @see #putExtras
8243 * @see #removeExtra
8244 * @see #getFloatExtra(String, float)
8245 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008246 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008247 if (mExtras == null) {
8248 mExtras = new Bundle();
8249 }
8250 mExtras.putFloat(name, value);
8251 return this;
8252 }
8253
8254 /**
8255 * Add extended data to the intent. The name must include a package
8256 * prefix, for example the app com.android.contacts would use names
8257 * like "com.android.contacts.ShowAll".
8258 *
8259 * @param name The name of the extra data, with package prefix.
8260 * @param value The double data value.
8261 *
8262 * @return Returns the same Intent object, for chaining multiple calls
8263 * into a single statement.
8264 *
8265 * @see #putExtras
8266 * @see #removeExtra
8267 * @see #getDoubleExtra(String, double)
8268 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008269 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008270 if (mExtras == null) {
8271 mExtras = new Bundle();
8272 }
8273 mExtras.putDouble(name, value);
8274 return this;
8275 }
8276
8277 /**
8278 * Add extended data to the intent. The name must include a package
8279 * prefix, for example the app com.android.contacts would use names
8280 * like "com.android.contacts.ShowAll".
8281 *
8282 * @param name The name of the extra data, with package prefix.
8283 * @param value The String data value.
8284 *
8285 * @return Returns the same Intent object, for chaining multiple calls
8286 * into a single statement.
8287 *
8288 * @see #putExtras
8289 * @see #removeExtra
8290 * @see #getStringExtra(String)
8291 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008292 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008293 if (mExtras == null) {
8294 mExtras = new Bundle();
8295 }
8296 mExtras.putString(name, value);
8297 return this;
8298 }
8299
8300 /**
8301 * 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 CharSequence 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 #getCharSequenceExtra(String)
8314 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008315 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008316 if (mExtras == null) {
8317 mExtras = new Bundle();
8318 }
8319 mExtras.putCharSequence(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 Parcelable 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 #getParcelableExtra(String)
8337 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008338 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008339 if (mExtras == null) {
8340 mExtras = new Bundle();
8341 }
8342 mExtras.putParcelable(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 Parcelable[] 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 #getParcelableArrayExtra(String)
8360 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008361 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008362 if (mExtras == null) {
8363 mExtras = new Bundle();
8364 }
8365 mExtras.putParcelableArray(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 ArrayList<Parcelable> 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 #getParcelableArrayListExtra(String)
8383 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008384 public @NonNull Intent putParcelableArrayListExtra(String name,
8385 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008386 if (mExtras == null) {
8387 mExtras = new Bundle();
8388 }
8389 mExtras.putParcelableArrayList(name, value);
8390 return this;
8391 }
8392
8393 /**
8394 * Add extended data to the intent. The name must include a package
8395 * prefix, for example the app com.android.contacts would use names
8396 * like "com.android.contacts.ShowAll".
8397 *
8398 * @param name The name of the extra data, with package prefix.
8399 * @param value The ArrayList<Integer> data value.
8400 *
8401 * @return Returns the same Intent object, for chaining multiple calls
8402 * into a single statement.
8403 *
8404 * @see #putExtras
8405 * @see #removeExtra
8406 * @see #getIntegerArrayListExtra(String)
8407 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008408 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008409 if (mExtras == null) {
8410 mExtras = new Bundle();
8411 }
8412 mExtras.putIntegerArrayList(name, value);
8413 return this;
8414 }
8415
8416 /**
8417 * Add extended data to the intent. The name must include a package
8418 * prefix, for example the app com.android.contacts would use names
8419 * like "com.android.contacts.ShowAll".
8420 *
8421 * @param name The name of the extra data, with package prefix.
8422 * @param value The ArrayList<String> data value.
8423 *
8424 * @return Returns the same Intent object, for chaining multiple calls
8425 * into a single statement.
8426 *
8427 * @see #putExtras
8428 * @see #removeExtra
8429 * @see #getStringArrayListExtra(String)
8430 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008431 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008432 if (mExtras == null) {
8433 mExtras = new Bundle();
8434 }
8435 mExtras.putStringArrayList(name, value);
8436 return this;
8437 }
8438
8439 /**
8440 * Add extended data to the intent. The name must include a package
8441 * prefix, for example the app com.android.contacts would use names
8442 * like "com.android.contacts.ShowAll".
8443 *
8444 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008445 * @param value The ArrayList<CharSequence> data value.
8446 *
8447 * @return Returns the same Intent object, for chaining multiple calls
8448 * into a single statement.
8449 *
8450 * @see #putExtras
8451 * @see #removeExtra
8452 * @see #getCharSequenceArrayListExtra(String)
8453 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008454 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8455 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008456 if (mExtras == null) {
8457 mExtras = new Bundle();
8458 }
8459 mExtras.putCharSequenceArrayList(name, value);
8460 return this;
8461 }
8462
8463 /**
8464 * Add extended data to the intent. The name must include a package
8465 * prefix, for example the app com.android.contacts would use names
8466 * like "com.android.contacts.ShowAll".
8467 *
8468 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008469 * @param value The Serializable data value.
8470 *
8471 * @return Returns the same Intent object, for chaining multiple calls
8472 * into a single statement.
8473 *
8474 * @see #putExtras
8475 * @see #removeExtra
8476 * @see #getSerializableExtra(String)
8477 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008478 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008479 if (mExtras == null) {
8480 mExtras = new Bundle();
8481 }
8482 mExtras.putSerializable(name, value);
8483 return this;
8484 }
8485
8486 /**
8487 * Add extended data to the intent. The name must include a package
8488 * prefix, for example the app com.android.contacts would use names
8489 * like "com.android.contacts.ShowAll".
8490 *
8491 * @param name The name of the extra data, with package prefix.
8492 * @param value The boolean array data value.
8493 *
8494 * @return Returns the same Intent object, for chaining multiple calls
8495 * into a single statement.
8496 *
8497 * @see #putExtras
8498 * @see #removeExtra
8499 * @see #getBooleanArrayExtra(String)
8500 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008501 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008502 if (mExtras == null) {
8503 mExtras = new Bundle();
8504 }
8505 mExtras.putBooleanArray(name, value);
8506 return this;
8507 }
8508
8509 /**
8510 * Add extended data to the intent. The name must include a package
8511 * prefix, for example the app com.android.contacts would use names
8512 * like "com.android.contacts.ShowAll".
8513 *
8514 * @param name The name of the extra data, with package prefix.
8515 * @param value The byte array data value.
8516 *
8517 * @return Returns the same Intent object, for chaining multiple calls
8518 * into a single statement.
8519 *
8520 * @see #putExtras
8521 * @see #removeExtra
8522 * @see #getByteArrayExtra(String)
8523 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008524 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008525 if (mExtras == null) {
8526 mExtras = new Bundle();
8527 }
8528 mExtras.putByteArray(name, value);
8529 return this;
8530 }
8531
8532 /**
8533 * Add extended data to the intent. The name must include a package
8534 * prefix, for example the app com.android.contacts would use names
8535 * like "com.android.contacts.ShowAll".
8536 *
8537 * @param name The name of the extra data, with package prefix.
8538 * @param value The short array data value.
8539 *
8540 * @return Returns the same Intent object, for chaining multiple calls
8541 * into a single statement.
8542 *
8543 * @see #putExtras
8544 * @see #removeExtra
8545 * @see #getShortArrayExtra(String)
8546 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008547 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008548 if (mExtras == null) {
8549 mExtras = new Bundle();
8550 }
8551 mExtras.putShortArray(name, value);
8552 return this;
8553 }
8554
8555 /**
8556 * Add extended data to the intent. The name must include a package
8557 * prefix, for example the app com.android.contacts would use names
8558 * like "com.android.contacts.ShowAll".
8559 *
8560 * @param name The name of the extra data, with package prefix.
8561 * @param value The char array data value.
8562 *
8563 * @return Returns the same Intent object, for chaining multiple calls
8564 * into a single statement.
8565 *
8566 * @see #putExtras
8567 * @see #removeExtra
8568 * @see #getCharArrayExtra(String)
8569 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008570 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008571 if (mExtras == null) {
8572 mExtras = new Bundle();
8573 }
8574 mExtras.putCharArray(name, value);
8575 return this;
8576 }
8577
8578 /**
8579 * Add extended data to the intent. The name must include a package
8580 * prefix, for example the app com.android.contacts would use names
8581 * like "com.android.contacts.ShowAll".
8582 *
8583 * @param name The name of the extra data, with package prefix.
8584 * @param value The int array data value.
8585 *
8586 * @return Returns the same Intent object, for chaining multiple calls
8587 * into a single statement.
8588 *
8589 * @see #putExtras
8590 * @see #removeExtra
8591 * @see #getIntArrayExtra(String)
8592 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008593 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008594 if (mExtras == null) {
8595 mExtras = new Bundle();
8596 }
8597 mExtras.putIntArray(name, value);
8598 return this;
8599 }
8600
8601 /**
8602 * Add extended data to the intent. The name must include a package
8603 * prefix, for example the app com.android.contacts would use names
8604 * like "com.android.contacts.ShowAll".
8605 *
8606 * @param name The name of the extra data, with package prefix.
8607 * @param value The byte array data value.
8608 *
8609 * @return Returns the same Intent object, for chaining multiple calls
8610 * into a single statement.
8611 *
8612 * @see #putExtras
8613 * @see #removeExtra
8614 * @see #getLongArrayExtra(String)
8615 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008616 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008617 if (mExtras == null) {
8618 mExtras = new Bundle();
8619 }
8620 mExtras.putLongArray(name, value);
8621 return this;
8622 }
8623
8624 /**
8625 * Add extended data to the intent. The name must include a package
8626 * prefix, for example the app com.android.contacts would use names
8627 * like "com.android.contacts.ShowAll".
8628 *
8629 * @param name The name of the extra data, with package prefix.
8630 * @param value The float array data value.
8631 *
8632 * @return Returns the same Intent object, for chaining multiple calls
8633 * into a single statement.
8634 *
8635 * @see #putExtras
8636 * @see #removeExtra
8637 * @see #getFloatArrayExtra(String)
8638 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008639 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008640 if (mExtras == null) {
8641 mExtras = new Bundle();
8642 }
8643 mExtras.putFloatArray(name, value);
8644 return this;
8645 }
8646
8647 /**
8648 * Add extended data to the intent. The name must include a package
8649 * prefix, for example the app com.android.contacts would use names
8650 * like "com.android.contacts.ShowAll".
8651 *
8652 * @param name The name of the extra data, with package prefix.
8653 * @param value The double array data value.
8654 *
8655 * @return Returns the same Intent object, for chaining multiple calls
8656 * into a single statement.
8657 *
8658 * @see #putExtras
8659 * @see #removeExtra
8660 * @see #getDoubleArrayExtra(String)
8661 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008662 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008663 if (mExtras == null) {
8664 mExtras = new Bundle();
8665 }
8666 mExtras.putDoubleArray(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.
8676 * @param value The String array 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 #getStringArrayExtra(String)
8684 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008685 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 if (mExtras == null) {
8687 mExtras = new Bundle();
8688 }
8689 mExtras.putStringArray(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008699 * @param value The CharSequence 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 #getCharSequenceArrayExtra(String)
8707 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008708 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008709 if (mExtras == null) {
8710 mExtras = new Bundle();
8711 }
8712 mExtras.putCharSequenceArray(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008722 * @param value The Bundle 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 #getBundleExtra(String)
8730 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008731 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 if (mExtras == null) {
8733 mExtras = new Bundle();
8734 }
8735 mExtras.putBundle(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 IBinder 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 #getIBinderExtra(String)
8753 *
8754 * @deprecated
8755 * @hide
8756 */
8757 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008758 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008759 if (mExtras == null) {
8760 mExtras = new Bundle();
8761 }
8762 mExtras.putIBinder(name, value);
8763 return this;
8764 }
8765
8766 /**
8767 * Copy all extras in 'src' in to this intent.
8768 *
8769 * @param src Contains the extras to copy.
8770 *
8771 * @see #putExtra
8772 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008773 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008774 if (src.mExtras != null) {
8775 if (mExtras == null) {
8776 mExtras = new Bundle(src.mExtras);
8777 } else {
8778 mExtras.putAll(src.mExtras);
8779 }
8780 }
8781 return this;
8782 }
8783
8784 /**
8785 * Add a set of extended data to the intent. The keys must include a package
8786 * prefix, for example the app com.android.contacts would use names
8787 * like "com.android.contacts.ShowAll".
8788 *
8789 * @param extras The Bundle of extras to add to this intent.
8790 *
8791 * @see #putExtra
8792 * @see #removeExtra
8793 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008794 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008795 if (mExtras == null) {
8796 mExtras = new Bundle();
8797 }
8798 mExtras.putAll(extras);
8799 return this;
8800 }
8801
8802 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008803 * Completely replace the extras in the Intent with the extras in the
8804 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008805 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008806 * @param src The exact extras contained in this Intent are copied
8807 * into the target intent, replacing any that were previously there.
8808 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008809 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008810 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8811 return this;
8812 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008813
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008814 /**
8815 * Completely replace the extras in the Intent with the given Bundle of
8816 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008817 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008818 * @param extras The new set of extras in the Intent, or null to erase
8819 * all extras.
8820 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008821 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008822 mExtras = extras != null ? new Bundle(extras) : null;
8823 return this;
8824 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008825
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008826 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008827 * Remove extended data from the intent.
8828 *
8829 * @see #putExtra
8830 */
8831 public void removeExtra(String name) {
8832 if (mExtras != null) {
8833 mExtras.remove(name);
8834 if (mExtras.size() == 0) {
8835 mExtras = null;
8836 }
8837 }
8838 }
8839
8840 /**
8841 * Set special flags controlling how this intent is handled. Most values
8842 * here depend on the type of component being executed by the Intent,
8843 * specifically the FLAG_ACTIVITY_* flags are all for use with
8844 * {@link Context#startActivity Context.startActivity()} and the
8845 * FLAG_RECEIVER_* flags are all for use with
8846 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8847 *
Scott Main7aee61f2011-02-08 11:25:01 -08008848 * <p>See the
8849 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8850 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008851 * the behavior of your application.
8852 *
8853 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008854 * @return Returns the same Intent object, for chaining multiple calls
8855 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008856 * @see #getFlags
8857 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008858 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008859 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008860 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008861 mFlags = flags;
8862 return this;
8863 }
8864
8865 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008866 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008867 *
8868 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008869 * @return Returns the same Intent object, for chaining multiple calls into
8870 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008871 * @see #setFlags
8872 * @see #getFlags
8873 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008874 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008875 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008876 mFlags |= flags;
8877 return this;
8878 }
8879
8880 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008881 * Remove these flags from the intent.
8882 *
8883 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008884 * @see #setFlags
8885 * @see #getFlags
8886 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008887 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008888 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008889 mFlags &= ~flags;
8890 }
8891
8892 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008893 * (Usually optional) Set an explicit application package name that limits
8894 * the components this Intent will resolve to. If left to the default
8895 * value of null, all components in all applications will considered.
8896 * If non-null, the Intent can only match the components in the given
8897 * application package.
8898 *
8899 * @param packageName The name of the application package to handle the
8900 * intent, or null to allow any application package.
8901 *
8902 * @return Returns the same Intent object, for chaining multiple calls
8903 * into a single statement.
8904 *
8905 * @see #getPackage
8906 * @see #resolveActivity
8907 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008908 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008909 if (packageName != null && mSelector != null) {
8910 throw new IllegalArgumentException(
8911 "Can't set package name when selector is already set");
8912 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008913 mPackage = packageName;
8914 return this;
8915 }
8916
8917 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008918 * (Usually optional) Explicitly set the component to handle the intent.
8919 * If left with the default value of null, the system will determine the
8920 * appropriate class to use based on the other fields (action, data,
8921 * type, categories) in the Intent. If this class is defined, the
8922 * specified class will always be used regardless of the other fields. You
8923 * should only set this value when you know you absolutely want a specific
8924 * class to be used; otherwise it is better to let the system find the
8925 * appropriate class so that you will respect the installed applications
8926 * and user preferences.
8927 *
8928 * @param component The name of the application component to handle the
8929 * intent, or null to let the system find one for you.
8930 *
8931 * @return Returns the same Intent object, for chaining multiple calls
8932 * into a single statement.
8933 *
8934 * @see #setClass
8935 * @see #setClassName(Context, String)
8936 * @see #setClassName(String, String)
8937 * @see #getComponent
8938 * @see #resolveActivity
8939 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008940 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008941 mComponent = component;
8942 return this;
8943 }
8944
8945 /**
8946 * Convenience for calling {@link #setComponent} with an
8947 * explicit class name.
8948 *
8949 * @param packageContext A Context of the application package implementing
8950 * this class.
8951 * @param className The name of a class inside of the application package
8952 * that will be used as the component for this Intent.
8953 *
8954 * @return Returns the same Intent object, for chaining multiple calls
8955 * into a single statement.
8956 *
8957 * @see #setComponent
8958 * @see #setClass
8959 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008960 public @NonNull Intent setClassName(@NonNull Context packageContext,
8961 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008962 mComponent = new ComponentName(packageContext, className);
8963 return this;
8964 }
8965
8966 /**
8967 * Convenience for calling {@link #setComponent} with an
8968 * explicit application package name and class name.
8969 *
8970 * @param packageName The name of the package implementing the desired
8971 * component.
8972 * @param className The name of a class inside of the application package
8973 * that will be used as the component for this Intent.
8974 *
8975 * @return Returns the same Intent object, for chaining multiple calls
8976 * into a single statement.
8977 *
8978 * @see #setComponent
8979 * @see #setClass
8980 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008981 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008982 mComponent = new ComponentName(packageName, className);
8983 return this;
8984 }
8985
8986 /**
8987 * Convenience for calling {@link #setComponent(ComponentName)} with the
8988 * name returned by a {@link Class} object.
8989 *
8990 * @param packageContext A Context of the application package implementing
8991 * this class.
8992 * @param cls The class name to set, equivalent to
8993 * <code>setClassName(context, cls.getName())</code>.
8994 *
8995 * @return Returns the same Intent object, for chaining multiple calls
8996 * into a single statement.
8997 *
8998 * @see #setComponent
8999 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009000 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009001 mComponent = new ComponentName(packageContext, cls);
9002 return this;
9003 }
9004
9005 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009006 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9007 * used as a hint to the receiver for animations and the like. Null means that there
9008 * is no source bounds.
9009 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009010 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009011 if (r != null) {
9012 mSourceBounds = new Rect(r);
9013 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009014 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009015 }
9016 }
9017
Tor Norbyed9273d62013-05-30 15:59:53 -07009018 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009019 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9020 FILL_IN_ACTION,
9021 FILL_IN_DATA,
9022 FILL_IN_CATEGORIES,
9023 FILL_IN_COMPONENT,
9024 FILL_IN_PACKAGE,
9025 FILL_IN_SOURCE_BOUNDS,
9026 FILL_IN_SELECTOR,
9027 FILL_IN_CLIP_DATA
9028 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009029 @Retention(RetentionPolicy.SOURCE)
9030 public @interface FillInFlags {}
9031
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009032 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009033 * Use with {@link #fillIn} to allow the current action value to be
9034 * overwritten, even if it is already set.
9035 */
9036 public static final int FILL_IN_ACTION = 1<<0;
9037
9038 /**
9039 * Use with {@link #fillIn} to allow the current data or type value
9040 * overwritten, even if it is already set.
9041 */
9042 public static final int FILL_IN_DATA = 1<<1;
9043
9044 /**
9045 * Use with {@link #fillIn} to allow the current categories to be
9046 * overwritten, even if they are already set.
9047 */
9048 public static final int FILL_IN_CATEGORIES = 1<<2;
9049
9050 /**
9051 * Use with {@link #fillIn} to allow the current component value to be
9052 * overwritten, even if it is already set.
9053 */
9054 public static final int FILL_IN_COMPONENT = 1<<3;
9055
9056 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009057 * Use with {@link #fillIn} to allow the current package value to be
9058 * overwritten, even if it is already set.
9059 */
9060 public static final int FILL_IN_PACKAGE = 1<<4;
9061
9062 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009063 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009064 * overwritten, even if it is already set.
9065 */
9066 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9067
9068 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009069 * Use with {@link #fillIn} to allow the current selector to be
9070 * overwritten, even if it is already set.
9071 */
9072 public static final int FILL_IN_SELECTOR = 1<<6;
9073
9074 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009075 * Use with {@link #fillIn} to allow the current ClipData to be
9076 * overwritten, even if it is already set.
9077 */
9078 public static final int FILL_IN_CLIP_DATA = 1<<7;
9079
9080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009081 * Copy the contents of <var>other</var> in to this object, but only
9082 * where fields are not defined by this object. For purposes of a field
9083 * being defined, the following pieces of data in the Intent are
9084 * considered to be separate fields:
9085 *
9086 * <ul>
9087 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009088 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009089 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9090 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009091 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009092 * <li> component, as set by {@link #setComponent(ComponentName)} or
9093 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009094 * <li> source bounds, as set by {@link #setSourceBounds}.
9095 * <li> selector, as set by {@link #setSelector(Intent)}.
9096 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009097 * <li> each top-level name in the associated extras.
9098 * </ul>
9099 *
9100 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009101 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009102 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9103 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9104 * the restriction where the corresponding field will not be replaced if
9105 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009106 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009107 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9108 * is explicitly specified. The selector will only be copied if
9109 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009110 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009111 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9112 * and Intent B with {action="gotit", data-type="some/thing",
9113 * categories="one","two"}.
9114 *
9115 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9116 * containing: {action="gotit", data-type="some/thing",
9117 * categories="bar"}.
9118 *
9119 * @param other Another Intent whose values are to be used to fill in
9120 * the current one.
9121 * @param flags Options to control which fields can be filled in.
9122 *
9123 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009124 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009125 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009126 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009127 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009128 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009129 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009130 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009131 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009132 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009133 if (other.mAction != null
9134 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009135 mAction = other.mAction;
9136 changes |= FILL_IN_ACTION;
9137 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009138 if ((other.mData != null || other.mType != null)
9139 && ((mData == null && mType == null)
9140 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009141 mData = other.mData;
9142 mType = other.mType;
9143 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009144 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009145 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009146 if (other.mCategories != null
9147 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009148 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009149 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009150 }
9151 changes |= FILL_IN_CATEGORIES;
9152 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009153 if (other.mPackage != null
9154 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009155 // Only do this if mSelector is not set.
9156 if (mSelector == null) {
9157 mPackage = other.mPackage;
9158 changes |= FILL_IN_PACKAGE;
9159 }
9160 }
9161 // Selector is special: it can only be set if explicitly allowed,
9162 // for the same reason as the component name.
9163 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9164 if (mPackage == null) {
9165 mSelector = new Intent(other.mSelector);
9166 mPackage = null;
9167 changes |= FILL_IN_SELECTOR;
9168 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009169 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009170 if (other.mClipData != null
9171 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9172 mClipData = other.mClipData;
9173 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009174 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009175 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009176 // Component is special: it can -only- be set if explicitly allowed,
9177 // since otherwise the sender could force the intent somewhere the
9178 // originator didn't intend.
9179 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009180 mComponent = other.mComponent;
9181 changes |= FILL_IN_COMPONENT;
9182 }
9183 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009184 if (other.mSourceBounds != null
9185 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9186 mSourceBounds = new Rect(other.mSourceBounds);
9187 changes |= FILL_IN_SOURCE_BOUNDS;
9188 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009189 if (mExtras == null) {
9190 if (other.mExtras != null) {
9191 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009192 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009193 }
9194 } else if (other.mExtras != null) {
9195 try {
9196 Bundle newb = new Bundle(other.mExtras);
9197 newb.putAll(mExtras);
9198 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009199 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009200 } catch (RuntimeException e) {
9201 // Modifying the extras can cause us to unparcel the contents
9202 // of the bundle, and if we do this in the system process that
9203 // may fail. We really should handle this (i.e., the Bundle
9204 // impl shouldn't be on top of a plain map), but for now just
9205 // ignore it and keep the original contents. :(
9206 Log.w("Intent", "Failure filling in extras", e);
9207 }
9208 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009209 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9210 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9211 mContentUserHint = other.mContentUserHint;
9212 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009213 return changes;
9214 }
9215
9216 /**
9217 * Wrapper class holding an Intent and implementing comparisons on it for
9218 * the purpose of filtering. The class implements its
9219 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9220 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9221 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9222 * on the wrapped Intent.
9223 */
9224 public static final class FilterComparison {
9225 private final Intent mIntent;
9226 private final int mHashCode;
9227
9228 public FilterComparison(Intent intent) {
9229 mIntent = intent;
9230 mHashCode = intent.filterHashCode();
9231 }
9232
9233 /**
9234 * Return the Intent that this FilterComparison represents.
9235 * @return Returns the Intent held by the FilterComparison. Do
9236 * not modify!
9237 */
9238 public Intent getIntent() {
9239 return mIntent;
9240 }
9241
9242 @Override
9243 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009244 if (obj instanceof FilterComparison) {
9245 Intent other = ((FilterComparison)obj).mIntent;
9246 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009247 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009248 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009249 }
9250
9251 @Override
9252 public int hashCode() {
9253 return mHashCode;
9254 }
9255 }
9256
9257 /**
9258 * Determine if two intents are the same for the purposes of intent
9259 * resolution (filtering). That is, if their action, data, type,
9260 * class, and categories are the same. This does <em>not</em> compare
9261 * any extra data included in the intents.
9262 *
9263 * @param other The other Intent to compare against.
9264 *
9265 * @return Returns true if action, data, type, class, and categories
9266 * are the same.
9267 */
9268 public boolean filterEquals(Intent other) {
9269 if (other == null) {
9270 return false;
9271 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009272 if (!Objects.equals(this.mAction, other.mAction)) return false;
9273 if (!Objects.equals(this.mData, other.mData)) return false;
9274 if (!Objects.equals(this.mType, other.mType)) return false;
9275 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9276 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9277 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009278
9279 return true;
9280 }
9281
9282 /**
9283 * Generate hash code that matches semantics of filterEquals().
9284 *
9285 * @return Returns the hash value of the action, data, type, class, and
9286 * categories.
9287 *
9288 * @see #filterEquals
9289 */
9290 public int filterHashCode() {
9291 int code = 0;
9292 if (mAction != null) {
9293 code += mAction.hashCode();
9294 }
9295 if (mData != null) {
9296 code += mData.hashCode();
9297 }
9298 if (mType != null) {
9299 code += mType.hashCode();
9300 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009301 if (mPackage != null) {
9302 code += mPackage.hashCode();
9303 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009304 if (mComponent != null) {
9305 code += mComponent.hashCode();
9306 }
9307 if (mCategories != null) {
9308 code += mCategories.hashCode();
9309 }
9310 return code;
9311 }
9312
9313 @Override
9314 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009315 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009316
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009317 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009318 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009319 b.append(" }");
9320
9321 return b.toString();
9322 }
9323
9324 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009325 public String toInsecureString() {
9326 StringBuilder b = new StringBuilder(128);
9327
9328 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009329 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009330 b.append(" }");
9331
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009332 return b.toString();
9333 }
Romain Guy4969af72009-06-17 10:53:19 -07009334
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009335 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009336 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009337 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009338
9339 b.append("Intent { ");
9340 toShortString(b, false, true, true, true);
9341 b.append(" }");
9342
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009343 return b.toString();
9344 }
9345
9346 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009347 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9348 StringBuilder b = new StringBuilder(128);
9349 toShortString(b, secure, comp, extras, clip);
9350 return b.toString();
9351 }
9352
9353 /** @hide */
9354 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9355 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009356 boolean first = true;
9357 if (mAction != null) {
9358 b.append("act=").append(mAction);
9359 first = false;
9360 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009361 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009362 if (!first) {
9363 b.append(' ');
9364 }
9365 first = false;
9366 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009367 for (int i=0; i<mCategories.size(); i++) {
9368 if (i > 0) b.append(',');
9369 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009370 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009371 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009372 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009373 if (mData != null) {
9374 if (!first) {
9375 b.append(' ');
9376 }
9377 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009378 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009379 if (secure) {
9380 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009381 } else {
9382 b.append(mData);
9383 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009384 }
9385 if (mType != null) {
9386 if (!first) {
9387 b.append(' ');
9388 }
9389 first = false;
9390 b.append("typ=").append(mType);
9391 }
9392 if (mFlags != 0) {
9393 if (!first) {
9394 b.append(' ');
9395 }
9396 first = false;
9397 b.append("flg=0x").append(Integer.toHexString(mFlags));
9398 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009399 if (mPackage != null) {
9400 if (!first) {
9401 b.append(' ');
9402 }
9403 first = false;
9404 b.append("pkg=").append(mPackage);
9405 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009406 if (comp && mComponent != null) {
9407 if (!first) {
9408 b.append(' ');
9409 }
9410 first = false;
9411 b.append("cmp=").append(mComponent.flattenToShortString());
9412 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009413 if (mSourceBounds != null) {
9414 if (!first) {
9415 b.append(' ');
9416 }
9417 first = false;
9418 b.append("bnds=").append(mSourceBounds.toShortString());
9419 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009420 if (mClipData != null) {
9421 if (!first) {
9422 b.append(' ');
9423 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009424 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009425 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009426 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009427 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009428 if (mClipData.getDescription() != null) {
9429 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9430 } else {
9431 first = true;
9432 }
9433 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009434 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009435 first = false;
9436 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009437 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009438 if (extras && mExtras != null) {
9439 if (!first) {
9440 b.append(' ');
9441 }
9442 first = false;
9443 b.append("(has extras)");
9444 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009445 if (mContentUserHint != UserHandle.USER_CURRENT) {
9446 if (!first) {
9447 b.append(' ');
9448 }
9449 first = false;
9450 b.append("u=").append(mContentUserHint);
9451 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009452 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009453 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009454 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009455 b.append("}");
9456 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009457 }
9458
Yi Jin129fc6c2017-09-28 15:48:38 -07009459 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009460 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9461 // Same input parameters that toString() gives to toShortString().
9462 writeToProto(proto, fieldId, true, true, true, false);
9463 }
9464
9465 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009466 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9467 boolean extras, boolean clip) {
9468 long token = proto.start(fieldId);
9469 if (mAction != null) {
9470 proto.write(IntentProto.ACTION, mAction);
9471 }
9472 if (mCategories != null) {
9473 for (String category : mCategories) {
9474 proto.write(IntentProto.CATEGORIES, category);
9475 }
9476 }
9477 if (mData != null) {
9478 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9479 }
9480 if (mType != null) {
9481 proto.write(IntentProto.TYPE, mType);
9482 }
9483 if (mFlags != 0) {
9484 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9485 }
9486 if (mPackage != null) {
9487 proto.write(IntentProto.PACKAGE, mPackage);
9488 }
9489 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009490 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009491 }
9492 if (mSourceBounds != null) {
9493 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9494 }
9495 if (mClipData != null) {
9496 StringBuilder b = new StringBuilder();
9497 if (clip) {
9498 mClipData.toShortString(b);
9499 } else {
9500 mClipData.toShortStringShortItems(b, false);
9501 }
9502 proto.write(IntentProto.CLIP_DATA, b.toString());
9503 }
9504 if (extras && mExtras != null) {
9505 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9506 }
9507 if (mContentUserHint != 0) {
9508 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9509 }
9510 if (mSelector != null) {
9511 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9512 }
9513 proto.end(token);
9514 }
9515
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009516 /**
9517 * Call {@link #toUri} with 0 flags.
9518 * @deprecated Use {@link #toUri} instead.
9519 */
9520 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009521 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009522 return toUri(0);
9523 }
9524
9525 /**
9526 * Convert this Intent into a String holding a URI representation of it.
9527 * The returned URI string has been properly URI encoded, so it can be
9528 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9529 * Intent's data as the base URI, with an additional fragment describing
9530 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009531 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009532 * <p>You can convert the returned string back to an Intent with
9533 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009534 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009535 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009536 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009537 * @return Returns a URI encoding URI string describing the entire contents
9538 * of the Intent.
9539 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009540 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009541 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009542 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9543 if (mPackage == null) {
9544 throw new IllegalArgumentException(
9545 "Intent must include an explicit package name to build an android-app: "
9546 + this);
9547 }
9548 uri.append("android-app://");
9549 uri.append(mPackage);
9550 String scheme = null;
9551 if (mData != null) {
9552 scheme = mData.getScheme();
9553 if (scheme != null) {
9554 uri.append('/');
9555 uri.append(scheme);
9556 String authority = mData.getEncodedAuthority();
9557 if (authority != null) {
9558 uri.append('/');
9559 uri.append(authority);
9560 String path = mData.getEncodedPath();
9561 if (path != null) {
9562 uri.append(path);
9563 }
9564 String queryParams = mData.getEncodedQuery();
9565 if (queryParams != null) {
9566 uri.append('?');
9567 uri.append(queryParams);
9568 }
9569 String fragment = mData.getEncodedFragment();
9570 if (fragment != null) {
9571 uri.append('#');
9572 uri.append(fragment);
9573 }
9574 }
9575 }
9576 }
9577 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9578 mPackage, flags);
9579 return uri.toString();
9580 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009581 String scheme = null;
9582 if (mData != null) {
9583 String data = mData.toString();
9584 if ((flags&URI_INTENT_SCHEME) != 0) {
9585 final int N = data.length();
9586 for (int i=0; i<N; i++) {
9587 char c = data.charAt(i);
9588 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009589 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009590 continue;
9591 }
9592 if (c == ':' && i > 0) {
9593 // Valid scheme.
9594 scheme = data.substring(0, i);
9595 uri.append("intent:");
9596 data = data.substring(i+1);
9597 break;
9598 }
Tom Taylord4a47292009-12-21 13:59:18 -08009599
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009600 // No scheme.
9601 break;
9602 }
9603 }
9604 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009605
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009606 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9607 uri.append("intent:");
9608 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009609
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009610 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009611
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009612 return uri.toString();
9613 }
9614
9615 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9616 String defPackage, int flags) {
9617 StringBuilder frag = new StringBuilder(128);
9618
9619 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009620 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009621 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009622 // Note that for now we are not going to try to handle the
9623 // data part; not clear how to represent this as a URI, and
9624 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009625 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9626 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009627 }
9628
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009629 if (frag.length() > 0) {
9630 uri.append("#Intent;");
9631 uri.append(frag);
9632 uri.append("end");
9633 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009634 }
9635
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009636 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9637 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009638 if (scheme != null) {
9639 uri.append("scheme=").append(scheme).append(';');
9640 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009641 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009642 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009643 }
9644 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009645 for (int i=0; i<mCategories.size(); i++) {
9646 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009647 }
9648 }
9649 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009650 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009651 }
9652 if (mFlags != 0) {
9653 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9654 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009655 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009656 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9657 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009658 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009659 uri.append("component=").append(Uri.encode(
9660 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009661 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009662 if (mSourceBounds != null) {
9663 uri.append("sourceBounds=")
9664 .append(Uri.encode(mSourceBounds.flattenToString()))
9665 .append(';');
9666 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009667 if (mExtras != null) {
9668 for (String key : mExtras.keySet()) {
9669 final Object value = mExtras.get(key);
9670 char entryType =
9671 value instanceof String ? 'S' :
9672 value instanceof Boolean ? 'B' :
9673 value instanceof Byte ? 'b' :
9674 value instanceof Character ? 'c' :
9675 value instanceof Double ? 'd' :
9676 value instanceof Float ? 'f' :
9677 value instanceof Integer ? 'i' :
9678 value instanceof Long ? 'l' :
9679 value instanceof Short ? 's' :
9680 '\0';
9681
9682 if (entryType != '\0') {
9683 uri.append(entryType);
9684 uri.append('.');
9685 uri.append(Uri.encode(key));
9686 uri.append('=');
9687 uri.append(Uri.encode(value.toString()));
9688 uri.append(';');
9689 }
9690 }
9691 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009692 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009693
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009694 public int describeContents() {
9695 return (mExtras != null) ? mExtras.describeContents() : 0;
9696 }
9697
9698 public void writeToParcel(Parcel out, int flags) {
9699 out.writeString(mAction);
9700 Uri.writeToParcel(out, mData);
9701 out.writeString(mType);
9702 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009703 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009704 ComponentName.writeToParcel(mComponent, out);
9705
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009706 if (mSourceBounds != null) {
9707 out.writeInt(1);
9708 mSourceBounds.writeToParcel(out, flags);
9709 } else {
9710 out.writeInt(0);
9711 }
9712
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009713 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009714 final int N = mCategories.size();
9715 out.writeInt(N);
9716 for (int i=0; i<N; i++) {
9717 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009718 }
9719 } else {
9720 out.writeInt(0);
9721 }
9722
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009723 if (mSelector != null) {
9724 out.writeInt(1);
9725 mSelector.writeToParcel(out, flags);
9726 } else {
9727 out.writeInt(0);
9728 }
9729
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009730 if (mClipData != null) {
9731 out.writeInt(1);
9732 mClipData.writeToParcel(out, flags);
9733 } else {
9734 out.writeInt(0);
9735 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009736 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009737 out.writeBundle(mExtras);
9738 }
9739
9740 public static final Parcelable.Creator<Intent> CREATOR
9741 = new Parcelable.Creator<Intent>() {
9742 public Intent createFromParcel(Parcel in) {
9743 return new Intent(in);
9744 }
9745 public Intent[] newArray(int size) {
9746 return new Intent[size];
9747 }
9748 };
9749
Dianne Hackborneb034652009-09-07 00:49:58 -07009750 /** @hide */
9751 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009752 readFromParcel(in);
9753 }
9754
9755 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009756 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009757 mData = Uri.CREATOR.createFromParcel(in);
9758 mType = in.readString();
9759 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009760 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009761 mComponent = ComponentName.readFromParcel(in);
9762
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009763 if (in.readInt() != 0) {
9764 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9765 }
9766
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009767 int N = in.readInt();
9768 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009769 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009770 int i;
9771 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009772 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009773 }
9774 } else {
9775 mCategories = null;
9776 }
9777
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009778 if (in.readInt() != 0) {
9779 mSelector = new Intent(in);
9780 }
9781
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009782 if (in.readInt() != 0) {
9783 mClipData = new ClipData(in);
9784 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009785 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009786 mExtras = in.readBundle();
9787 }
9788
9789 /**
9790 * Parses the "intent" element (and its children) from XML and instantiates
9791 * an Intent object. The given XML parser should be located at the tag
9792 * where parsing should start (often named "intent"), from which the
9793 * basic action, data, type, and package and class name will be
9794 * retrieved. The function will then parse in to any child elements,
9795 * looking for <category android:name="xxx"> tags to add categories and
9796 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9797 * to the intent.
9798 *
9799 * @param resources The Resources to use when inflating resources.
9800 * @param parser The XML parser pointing at an "intent" tag.
9801 * @param attrs The AttributeSet interface for retrieving extended
9802 * attribute data at the current <var>parser</var> location.
9803 * @return An Intent object matching the XML data.
9804 * @throws XmlPullParserException If there was an XML parsing error.
9805 * @throws IOException If there was an I/O error.
9806 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009807 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9808 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009809 throws XmlPullParserException, IOException {
9810 Intent intent = new Intent();
9811
9812 TypedArray sa = resources.obtainAttributes(attrs,
9813 com.android.internal.R.styleable.Intent);
9814
9815 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9816
9817 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9818 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9819 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9820
9821 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9822 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9823 if (packageName != null && className != null) {
9824 intent.setComponent(new ComponentName(packageName, className));
9825 }
9826
9827 sa.recycle();
9828
9829 int outerDepth = parser.getDepth();
9830 int type;
9831 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9832 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9833 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9834 continue;
9835 }
9836
9837 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009838 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009839 sa = resources.obtainAttributes(attrs,
9840 com.android.internal.R.styleable.IntentCategory);
9841 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9842 sa.recycle();
9843
9844 if (cat != null) {
9845 intent.addCategory(cat);
9846 }
9847 XmlUtils.skipCurrentTag(parser);
9848
Craig Mautner21d24a22014-04-23 11:45:37 -07009849 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009850 if (intent.mExtras == null) {
9851 intent.mExtras = new Bundle();
9852 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009853 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009854 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009855
9856 } else {
9857 XmlUtils.skipCurrentTag(parser);
9858 }
9859 }
9860
9861 return intent;
9862 }
Nick Pellyccae4122012-01-09 14:12:58 -08009863
Craig Mautner21d24a22014-04-23 11:45:37 -07009864 /** @hide */
9865 public void saveToXml(XmlSerializer out) throws IOException {
9866 if (mAction != null) {
9867 out.attribute(null, ATTR_ACTION, mAction);
9868 }
9869 if (mData != null) {
9870 out.attribute(null, ATTR_DATA, mData.toString());
9871 }
9872 if (mType != null) {
9873 out.attribute(null, ATTR_TYPE, mType);
9874 }
9875 if (mComponent != null) {
9876 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9877 }
9878 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9879
9880 if (mCategories != null) {
9881 out.startTag(null, TAG_CATEGORIES);
9882 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9883 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9884 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009885 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009886 }
9887 }
9888
9889 /** @hide */
9890 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9891 XmlPullParserException {
9892 Intent intent = new Intent();
9893 final int outerDepth = in.getDepth();
9894
9895 int attrCount = in.getAttributeCount();
9896 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9897 final String attrName = in.getAttributeName(attrNdx);
9898 final String attrValue = in.getAttributeValue(attrNdx);
9899 if (ATTR_ACTION.equals(attrName)) {
9900 intent.setAction(attrValue);
9901 } else if (ATTR_DATA.equals(attrName)) {
9902 intent.setData(Uri.parse(attrValue));
9903 } else if (ATTR_TYPE.equals(attrName)) {
9904 intent.setType(attrValue);
9905 } else if (ATTR_COMPONENT.equals(attrName)) {
9906 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9907 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009908 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009909 } else {
9910 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9911 }
9912 }
9913
9914 int event;
9915 String name;
9916 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9917 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9918 if (event == XmlPullParser.START_TAG) {
9919 name = in.getName();
9920 if (TAG_CATEGORIES.equals(name)) {
9921 attrCount = in.getAttributeCount();
9922 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9923 intent.addCategory(in.getAttributeValue(attrNdx));
9924 }
9925 } else {
9926 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9927 XmlUtils.skipCurrentTag(in);
9928 }
9929 }
9930 }
9931
9932 return intent;
9933 }
9934
Nick Pellyccae4122012-01-09 14:12:58 -08009935 /**
9936 * Normalize a MIME data type.
9937 *
9938 * <p>A normalized MIME type has white-space trimmed,
9939 * content-type parameters removed, and is lower-case.
9940 * This aligns the type with Android best practices for
9941 * intent filtering.
9942 *
9943 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9944 * "text/x-vCard" becomes "text/x-vcard".
9945 *
9946 * <p>All MIME types received from outside Android (such as user input,
9947 * or external sources like Bluetooth, NFC, or the Internet) should
9948 * be normalized before they are used to create an Intent.
9949 *
9950 * @param type MIME data type to normalize
9951 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009952 * @see #setType
9953 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009954 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009955 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009956 if (type == null) {
9957 return null;
9958 }
9959
Elliott Hughescb64d432013-08-02 10:00:44 -07009960 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009961
9962 final int semicolonIndex = type.indexOf(';');
9963 if (semicolonIndex != -1) {
9964 type = type.substring(0, semicolonIndex);
9965 }
9966 return type;
9967 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009968
9969 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009970 * Prepare this {@link Intent} to leave an app process.
9971 *
9972 * @hide
9973 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009974 public void prepareToLeaveProcess(Context context) {
9975 final boolean leavingPackage = (mComponent == null)
9976 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9977 prepareToLeaveProcess(leavingPackage);
9978 }
9979
9980 /**
9981 * Prepare this {@link Intent} to leave an app process.
9982 *
9983 * @hide
9984 */
9985 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009986 setAllowFds(false);
9987
9988 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009989 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009990 }
9991 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009992 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009993 }
9994
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009995 if (mExtras != null && !mExtras.isParcelled()) {
9996 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9997 if (intent instanceof Intent) {
9998 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9999 }
10000 }
10001
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010002 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10003 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010004 switch (mAction) {
10005 case ACTION_MEDIA_REMOVED:
10006 case ACTION_MEDIA_UNMOUNTED:
10007 case ACTION_MEDIA_CHECKING:
10008 case ACTION_MEDIA_NOFS:
10009 case ACTION_MEDIA_MOUNTED:
10010 case ACTION_MEDIA_SHARED:
10011 case ACTION_MEDIA_UNSHARED:
10012 case ACTION_MEDIA_BAD_REMOVAL:
10013 case ACTION_MEDIA_UNMOUNTABLE:
10014 case ACTION_MEDIA_EJECT:
10015 case ACTION_MEDIA_SCANNER_STARTED:
10016 case ACTION_MEDIA_SCANNER_FINISHED:
10017 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010018 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10019 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010020 // Ignore legacy actions
10021 break;
10022 default:
10023 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010024 }
10025 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010026
10027 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10028 && leavingPackage) {
10029 switch (mAction) {
10030 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010031 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010032 // Ignore actions that don't need to grant
10033 break;
10034 default:
10035 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10036 }
10037 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010038 }
10039
10040 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010041 * @hide
10042 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010043 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010044 // We just entered destination process, so we should be able to read all
10045 // parcelables inside.
10046 setDefusable(true);
10047
10048 if (mSelector != null) {
10049 mSelector.prepareToEnterProcess();
10050 }
10051 if (mClipData != null) {
10052 mClipData.prepareToEnterProcess();
10053 }
10054
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010055 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010056 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10057 fixUris(mContentUserHint);
10058 mContentUserHint = UserHandle.USER_CURRENT;
10059 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010060 }
10061 }
10062
Patrick Baumann577d4022018-01-31 16:55:10 +000010063 /** @hide */
10064 public boolean hasWebURI() {
10065 if (getData() == null) {
10066 return false;
10067 }
10068 final String scheme = getScheme();
10069 if (TextUtils.isEmpty(scheme)) {
10070 return false;
10071 }
10072 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10073 }
10074
10075 /** @hide */
10076 public boolean isBrowsableWebIntent() {
10077 return ACTION_VIEW.equals(mAction)
10078 && hasCategory(CATEGORY_BROWSABLE)
10079 && hasWebURI();
10080 }
10081
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010082 /**
10083 * @hide
10084 */
10085 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010086 Uri data = getData();
10087 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010088 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010089 }
10090 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010091 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010092 }
10093 String action = getAction();
10094 if (ACTION_SEND.equals(action)) {
10095 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10096 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010097 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010098 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010099 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010100 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10101 if (streams != null) {
10102 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10103 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010104 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010105 }
10106 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10107 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010108 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10109 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10110 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10111 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10112 if (output != null) {
10113 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10114 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010115 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010116 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010117
10118 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010119 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010120 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10121 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010122 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010123 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010124 * @hide
10125 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010126 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010127 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010128 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010129
10130 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010131 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010132
10133 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010134 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010135 // Inspect contained intents to see if we need to migrate extras. We
10136 // don't promote ClipData to the parent, since ChooserActivity will
10137 // already start the picked item as the caller, and we can't combine
10138 // the flags in a safe way.
10139
10140 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010141 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010142 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10143 if (intent != null) {
10144 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010145 }
10146 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010147 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010148 try {
10149 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10150 if (intents != null) {
10151 for (int i = 0; i < intents.length; i++) {
10152 final Intent intent = (Intent) intents[i];
10153 if (intent != null) {
10154 migrated |= intent.migrateExtraStreamToClipData();
10155 }
10156 }
10157 }
10158 } catch (ClassCastException e) {
10159 }
10160 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010161
10162 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010163 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010164 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10165 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10166 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10167 if (stream != null || text != null || htmlText != null) {
10168 final ClipData clipData = new ClipData(
10169 null, new String[] { getType() },
10170 new ClipData.Item(text, htmlText, null, stream));
10171 setClipData(clipData);
10172 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010173 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010174 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010175 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010176 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010177
10178 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010179 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010180 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10181 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10182 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10183 int num = -1;
10184 if (streams != null) {
10185 num = streams.size();
10186 }
10187 if (texts != null) {
10188 if (num >= 0 && num != texts.size()) {
10189 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010190 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010191 }
10192 num = texts.size();
10193 }
10194 if (htmlTexts != null) {
10195 if (num >= 0 && num != htmlTexts.size()) {
10196 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010197 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010198 }
10199 num = htmlTexts.size();
10200 }
10201 if (num > 0) {
10202 final ClipData clipData = new ClipData(
10203 null, new String[] { getType() },
10204 makeClipItem(streams, texts, htmlTexts, 0));
10205
10206 for (int i = 1; i < num; i++) {
10207 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10208 }
10209
10210 setClipData(clipData);
10211 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010212 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010213 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010214 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010215 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010216 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10217 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10218 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10219 final Uri output;
10220 try {
10221 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10222 } catch (ClassCastException e) {
10223 return false;
10224 }
10225 if (output != null) {
10226 setClipData(ClipData.newRawUri("", output));
10227 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10228 return true;
10229 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010230 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010231
10232 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010233 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010234
Michael Wright19859762017-09-18 20:57:58 +010010235 /**
10236 * Convert the dock state to a human readable format.
10237 * @hide
10238 */
10239 public static String dockStateToString(int dock) {
10240 switch (dock) {
10241 case EXTRA_DOCK_STATE_HE_DESK:
10242 return "EXTRA_DOCK_STATE_HE_DESK";
10243 case EXTRA_DOCK_STATE_LE_DESK:
10244 return "EXTRA_DOCK_STATE_LE_DESK";
10245 case EXTRA_DOCK_STATE_CAR:
10246 return "EXTRA_DOCK_STATE_CAR";
10247 case EXTRA_DOCK_STATE_DESK:
10248 return "EXTRA_DOCK_STATE_DESK";
10249 case EXTRA_DOCK_STATE_UNDOCKED:
10250 return "EXTRA_DOCK_STATE_UNDOCKED";
10251 default:
10252 return Integer.toString(dock);
10253 }
10254 }
10255
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010256 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10257 ArrayList<String> htmlTexts, int which) {
10258 Uri uri = streams != null ? streams.get(which) : null;
10259 CharSequence text = texts != null ? texts.get(which) : null;
10260 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10261 return new ClipData.Item(text, htmlText, null, uri);
10262 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010263
10264 /** @hide */
10265 public boolean isDocument() {
10266 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10267 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010268}