blob: b3c8737a283112bdecc7c4a39afcfa305fa58e28 [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.
Tom Taylord4a47292009-12-21 13:59:18 -08002511 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002512 * <p class="note">This is a protected intent that can only be sent
2513 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002514 * <p>May include the following extras:
2515 * <ul>
2516 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2517 * shutdown is only for userspace processes. If not set, assumed to be false.
2518 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002519 */
2520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002521 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002522 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002523 * Activity Action: Start this activity to request system shutdown.
2524 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002525 * to request confirmation from the user before shutting down. The optional boolean
2526 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2527 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002528 *
2529 * <p class="note">This is a protected intent that can only be sent
2530 * by the system.
2531 *
2532 * {@hide}
2533 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002534 public static final String ACTION_REQUEST_SHUTDOWN
2535 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002536 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002537 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002538 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002539 * <p class="note">
2540 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002541 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002542 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2543 * or above, this broadcast will no longer be delivered to any
2544 * {@link BroadcastReceiver} defined in your manifest. Instead,
2545 * apps are strongly encouraged to use the improved
2546 * {@link Context#getCacheDir()} behavior so the system can
2547 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002548 */
2549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002550 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2552 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002553 * Broadcast Action: Indicates low storage space condition on the device no
2554 * longer exists
2555 * <p class="note">
2556 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002557 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002558 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2559 * or above, this broadcast will no longer be delivered to any
2560 * {@link BroadcastReceiver} defined in your manifest. Instead,
2561 * apps are strongly encouraged to use the improved
2562 * {@link Context#getCacheDir()} behavior so the system can
2563 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 */
2565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002566 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002567 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2568 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002569 * Broadcast Action: A sticky broadcast that indicates a storage space full
2570 * condition on the device. This is intended for activities that want to be
2571 * able to fill the data partition completely, leaving only enough free
2572 * space to prevent system-wide SQLite failures.
2573 * <p class="note">
2574 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002575 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002576 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2577 * or above, this broadcast will no longer be delivered to any
2578 * {@link BroadcastReceiver} defined in your manifest. Instead,
2579 * apps are strongly encouraged to use the improved
2580 * {@link Context#getCacheDir()} behavior so the system can
2581 * automatically free up storage when needed.
2582 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002585 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002586 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2587 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002588 * Broadcast Action: Indicates storage space full condition on the device no
2589 * longer exists.
2590 * <p class="note">
2591 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002592 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002593 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2594 * or above, this broadcast will no longer be delivered to any
2595 * {@link BroadcastReceiver} defined in your manifest. Instead,
2596 * apps are strongly encouraged to use the improved
2597 * {@link Context#getCacheDir()} behavior so the system can
2598 * automatically free up storage when needed.
2599 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002602 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002603 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2604 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2606 * and package management should be started.
2607 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2608 * notification.
2609 */
2610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2611 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2612 /**
2613 * Broadcast Action: The device has entered USB Mass Storage mode.
2614 * This is used mainly for the USB Settings panel.
2615 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2616 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002617 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002618 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002619 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2622
2623 /**
2624 * Broadcast Action: The device has exited USB Mass Storage mode.
2625 * This is used mainly for the USB Settings panel.
2626 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2627 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002628 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002629 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002630 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002632 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2633
2634 /**
2635 * Broadcast Action: External media has been removed.
2636 * The path to the mount point for the removed media is contained in the Intent.mData field.
2637 */
2638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2639 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2640
2641 /**
2642 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002643 * 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 -07002644 */
2645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2646 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2647
2648 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002649 * Broadcast Action: External media is present, and being disk-checked
2650 * 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 -08002651 */
2652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2653 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2654
2655 /**
2656 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2657 * 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 -08002658 */
2659 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2660 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2661
2662 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002664 * 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 -07002665 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2666 * media was mounted read only.
2667 */
2668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2669 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2670
2671 /**
2672 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002673 * 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 -07002674 */
2675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2676 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2677
2678 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002679 * Broadcast Action: External media is no longer being shared via USB mass storage.
2680 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2681 *
2682 * @hide
2683 */
2684 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2685
2686 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2688 * The path to the mount point for the removed media is contained in the Intent.mData field.
2689 */
2690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2691 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2692
2693 /**
2694 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002695 * 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 -07002696 */
2697 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2698 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2699
2700 /**
2701 * Broadcast Action: User has expressed the desire to remove the external storage media.
2702 * Applications should close all files they have open within the mount point when they receive this intent.
2703 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2704 */
2705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2706 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2707
2708 /**
2709 * Broadcast Action: The media scanner has started scanning a directory.
2710 * The path to the directory being scanned is contained in the Intent.mData field.
2711 */
2712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2713 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2714
2715 /**
2716 * Broadcast Action: The media scanner has finished scanning a directory.
2717 * The path to the scanned directory is contained in the Intent.mData field.
2718 */
2719 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2720 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2721
2722 /**
2723 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2724 * The path to the file is contained in the Intent.mData field.
2725 */
2726 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2727 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2728
2729 /**
2730 * Broadcast Action: The "Media Button" was pressed. Includes a single
2731 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2732 * caused the broadcast.
2733 */
2734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2735 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2736
2737 /**
2738 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2739 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2740 * caused the broadcast.
2741 */
2742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2743 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2744
2745 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2746 // location; they are not general-purpose actions.
2747
2748 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002749 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 */
2751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2752 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2753 "android.intent.action.GTALK_CONNECTED";
2754
2755 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002756 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002757 */
2758 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2759 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2760 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002761
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002762 /**
2763 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002764 */
2765 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2766 public static final String ACTION_INPUT_METHOD_CHANGED =
2767 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002768
2769 /**
2770 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2771 * more radios have been turned off or on. The intent will have the following extra value:</p>
2772 * <ul>
2773 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2774 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2775 * turned off</li>
2776 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002777 *
Peng Xua35b5532016-01-20 00:05:45 -08002778 * <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 -07002779 */
2780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2781 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2782
2783 /**
2784 * Broadcast Action: Some content providers have parts of their namespace
2785 * where they publish new events or items that the user may be especially
2786 * interested in. For these things, they may broadcast this action when the
2787 * set of interesting items change.
2788 *
2789 * For example, GmailProvider sends this notification when the set of unread
2790 * mail in the inbox changes.
2791 *
2792 * <p>The data of the intent identifies which part of which provider
2793 * changed. When queried through the content resolver, the data URI will
2794 * return the data set in question.
2795 *
2796 * <p>The intent will have the following extra values:
2797 * <ul>
2798 * <li><em>count</em> - The number of items in the data set. This is the
2799 * same as the number of items in the cursor returned by querying the
2800 * data URI. </li>
2801 * </ul>
2802 *
2803 * This intent will be sent at boot (if the count is non-zero) and when the
2804 * data set changes. It is possible for the data set to change without the
2805 * count changing (for example, if a new unread message arrives in the same
2806 * sync operation in which a message is archived). The phone should still
2807 * ring/vibrate/etc as normal in this case.
2808 */
2809 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2810 public static final String ACTION_PROVIDER_CHANGED =
2811 "android.intent.action.PROVIDER_CHANGED";
2812
2813 /**
2814 * Broadcast Action: Wired Headset plugged in or unplugged.
2815 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002816 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2817 * and documentation.
2818 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002819 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002820 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002821 */
2822 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002823 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002824
2825 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002826 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2827 * <ul>
2828 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2829 * </ul>
2830 *
2831 * <p class="note">This is a protected intent that can only be sent
2832 * by the system.
2833 *
2834 * @hide
2835 */
2836 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2837 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2838 = "android.intent.action.ADVANCED_SETTINGS";
2839
2840 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002841 * Broadcast Action: Sent after application restrictions are changed.
2842 *
2843 * <p class="note">This is a protected intent that can only be sent
2844 * by the system.</p>
2845 */
2846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2847 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2848 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2849
2850 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002851 * Broadcast Action: An outgoing call is about to be placed.
2852 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002853 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002854 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002855 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002856 * the phone number originally intended to be dialed.</li>
2857 * </ul>
2858 * <p>Once the broadcast is finished, the resultData is used as the actual
2859 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002860 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002861 * outgoing call in turn: for example, a parental control application
2862 * might verify that the user is authorized to place the call at that
2863 * time, then a number-rewriting application might add an area code if
2864 * one was not specified.</p>
2865 * <p>For consistency, any receiver whose purpose is to prohibit phone
2866 * calls should have a priority of 0, to ensure it will see the final
2867 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002868 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002869 * should have a positive priority.
2870 * Negative priorities are reserved for the system for this broadcast;
2871 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002872 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2873 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002874 * <p>Emergency calls cannot be intercepted using this mechanism, and
2875 * other calls cannot be modified to call emergency numbers using this
2876 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002877 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2878 * call to use their own service instead. Those apps should first prevent
2879 * the call from being placed by setting resultData to <code>null</code>
2880 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002881 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2883 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002884 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002885 * <p class="note">This is a protected intent that can only be sent
2886 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002887 */
2888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2889 public static final String ACTION_NEW_OUTGOING_CALL =
2890 "android.intent.action.NEW_OUTGOING_CALL";
2891
2892 /**
2893 * Broadcast Action: Have the device reboot. This is only for use by
2894 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002895 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002896 * <p class="note">This is a protected intent that can only be sent
2897 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002898 */
2899 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2900 public static final String ACTION_REBOOT =
2901 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002902
Wei Huang97ecc9c2009-05-11 17:44:20 -07002903 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002904 * Broadcast Action: A sticky broadcast for changes in the physical
2905 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002906 *
2907 * <p>The intent will have the following extra values:
2908 * <ul>
2909 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002910 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002911 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002912 * <p>This is intended for monitoring the current physical dock state.
2913 * See {@link android.app.UiModeManager} for the normal API dealing with
2914 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002915 */
2916 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2917 public static final String ACTION_DOCK_EVENT =
2918 "android.intent.action.DOCK_EVENT";
2919
2920 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002921 * Broadcast Action: A broadcast when idle maintenance can be started.
2922 * This means that the user is not interacting with the device and is
2923 * not expected to do so soon. Typical use of the idle maintenance is
2924 * to perform somehow expensive tasks that can be postponed at a moment
2925 * when they will not degrade user experience.
2926 * <p>
2927 * <p class="note">In order to keep the device responsive in case of an
2928 * unexpected user interaction, implementations of a maintenance task
2929 * should be interruptible. In such a scenario a broadcast with action
2930 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2931 * should not do the maintenance work in
2932 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2933 * maintenance service by {@link Context#startService(Intent)}. Also
2934 * you should hold a wake lock while your maintenance service is running
2935 * to prevent the device going to sleep.
2936 * </p>
2937 * <p>
2938 * <p class="note">This is a protected intent that can only be sent by
2939 * the system.
2940 * </p>
2941 *
2942 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002943 *
2944 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002945 */
2946 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2947 public static final String ACTION_IDLE_MAINTENANCE_START =
2948 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2949
2950 /**
2951 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2952 * This means that the user was not interacting with the device as a result
2953 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2954 * was sent and now the user started interacting with the device. Typical
2955 * use of the idle maintenance is to perform somehow expensive tasks that
2956 * can be postponed at a moment when they will not degrade user experience.
2957 * <p>
2958 * <p class="note">In order to keep the device responsive in case of an
2959 * unexpected user interaction, implementations of a maintenance task
2960 * should be interruptible. Hence, on receiving a broadcast with this
2961 * action, the maintenance task should be interrupted as soon as possible.
2962 * In other words, you should not do the maintenance work in
2963 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2964 * maintenance service that was started on receiving of
2965 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2966 * lock you acquired when your maintenance service started.
2967 * </p>
2968 * <p class="note">This is a protected intent that can only be sent
2969 * by the system.
2970 *
2971 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002972 *
2973 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002974 */
2975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2976 public static final String ACTION_IDLE_MAINTENANCE_END =
2977 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2978
2979 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002980 * Broadcast Action: a remote intent is to be broadcasted.
2981 *
2982 * A remote intent is used for remote RPC between devices. The remote intent
2983 * is serialized and sent from one device to another device. The receiving
2984 * device parses the remote intent and broadcasts it. Note that anyone can
2985 * broadcast a remote intent. However, if the intent receiver of the remote intent
2986 * does not trust intent broadcasts from arbitrary intent senders, it should require
2987 * the sender to hold certain permissions so only trusted sender's broadcast will be
2988 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002989 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002990 */
2991 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002992 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002993
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002994 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002995 * Broadcast Action: This is broadcast once when the user is booting after a
2996 * system update. It can be used to perform cleanup or upgrades after a
2997 * system update.
2998 * <p>
2999 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
3000 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
3001 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
3002 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003003 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003004 * @hide
3005 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003006 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003007 public static final String ACTION_PRE_BOOT_COMPLETED =
3008 "android.intent.action.PRE_BOOT_COMPLETED";
3009
Amith Yamasani13593602012-03-22 16:16:17 -07003010 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003011 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003012 * on restricted users. The broadcast intent contains an extra
3013 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
3014 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
3015 * String[] depending on the restriction type.<p/>
3016 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07003017 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
3018 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
3019 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003020 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
3021 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003022 * @see RestrictionEntry
3023 */
3024 public static final String ACTION_GET_RESTRICTION_ENTRIES =
3025 "android.intent.action.GET_RESTRICTION_ENTRIES";
3026
3027 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003028 * Sent the first time a user is starting, to allow system apps to
3029 * perform one time initialization. (This will not be seen by third
3030 * party applications because a newly initialized user does not have any
3031 * third party applications installed for it.) This is sent early in
3032 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003033 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3034 * broadcast, since it is part of a visible user interaction; be as quick
3035 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003036 */
3037 public static final String ACTION_USER_INITIALIZE =
3038 "android.intent.action.USER_INITIALIZE";
3039
3040 /**
3041 * Sent when a user switch is happening, causing the process's user to be
3042 * brought to the foreground. This is only sent to receivers registered
3043 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3044 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003045 * foreground. This is sent as a foreground
3046 * broadcast, since it is part of a visible user interaction; be as quick
3047 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003048 */
3049 public static final String ACTION_USER_FOREGROUND =
3050 "android.intent.action.USER_FOREGROUND";
3051
3052 /**
3053 * Sent when a user switch is happening, causing the process's user to be
3054 * sent to the background. This is only sent to receivers registered
3055 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3056 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003057 * background. This is sent as a foreground
3058 * broadcast, since it is part of a visible user interaction; be as quick
3059 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003060 */
3061 public static final String ACTION_USER_BACKGROUND =
3062 "android.intent.action.USER_BACKGROUND";
3063
3064 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003065 * Broadcast sent to the system when a user is added. Carries an extra
3066 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3067 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003068 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003069 * @hide
3070 */
3071 public static final String ACTION_USER_ADDED =
3072 "android.intent.action.USER_ADDED";
3073
3074 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003075 * Broadcast sent by the system when a user is started. Carries an extra
3076 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003077 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003078 * that has been started. This is sent as a foreground
3079 * broadcast, since it is part of a visible user interaction; be as quick
3080 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003081 * @hide
3082 */
3083 public static final String ACTION_USER_STARTED =
3084 "android.intent.action.USER_STARTED";
3085
3086 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003087 * Broadcast sent when a user is in the process of starting. Carries an extra
3088 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3089 * sent to registered receivers, not manifest receivers. It is sent to all
3090 * users (including the one that is being started). You must hold
3091 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3092 * this broadcast. This is sent as a background broadcast, since
3093 * its result is not part of the primary UX flow; to safely keep track of
3094 * started/stopped state of a user you can use this in conjunction with
3095 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3096 * other user state broadcasts since those are foreground broadcasts so can
3097 * execute in a different order.
3098 * @hide
3099 */
3100 public static final String ACTION_USER_STARTING =
3101 "android.intent.action.USER_STARTING";
3102
3103 /**
3104 * Broadcast sent when a user is going to be stopped. Carries an extra
3105 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3106 * sent to registered receivers, not manifest receivers. It is sent to all
3107 * users (including the one that is being stopped). You must hold
3108 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3109 * this broadcast. The user will not stop until all receivers have
3110 * handled the broadcast. This is sent as a background broadcast, since
3111 * its result is not part of the primary UX flow; to safely keep track of
3112 * started/stopped state of a user you can use this in conjunction with
3113 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3114 * other user state broadcasts since those are foreground broadcasts so can
3115 * execute in a different order.
3116 * @hide
3117 */
3118 public static final String ACTION_USER_STOPPING =
3119 "android.intent.action.USER_STOPPING";
3120
3121 /**
3122 * Broadcast sent to the system when a user is stopped. Carries an extra
3123 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3124 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3125 * specific package. This is only sent to registered receivers, not manifest
3126 * receivers. It is sent to all running users <em>except</em> the one that
3127 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003128 * @hide
3129 */
3130 public static final String ACTION_USER_STOPPED =
3131 "android.intent.action.USER_STOPPED";
3132
3133 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003134 * 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 -07003135 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003136 * one that has been removed. The user will not be completely removed until all receivers have
3137 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003138 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003139 * @hide
3140 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003141 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003142 public static final String ACTION_USER_REMOVED =
3143 "android.intent.action.USER_REMOVED";
3144
3145 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003146 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003147 * the userHandle of the user to become the current one. This is only sent to
3148 * registered receivers, not manifest receivers. It is sent to all running users.
3149 * You must hold
3150 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003151 * @hide
3152 */
3153 public static final String ACTION_USER_SWITCHED =
3154 "android.intent.action.USER_SWITCHED";
3155
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003156 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003157 * Broadcast Action: Sent when the credential-encrypted private storage has
3158 * become unlocked for the target user. This is only sent to registered
3159 * receivers, not manifest receivers.
3160 */
3161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3162 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3163
3164 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003165 * Broadcast sent to the system when a user's information changes. Carries an extra
3166 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003167 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003168 * @hide
3169 */
3170 public static final String ACTION_USER_INFO_CHANGED =
3171 "android.intent.action.USER_INFO_CHANGED";
3172
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003173 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003174 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3175 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003176 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3177 * that need to display merged content across both primary and managed profiles need to
3178 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003179 * not manifest receivers.
3180 */
3181 public static final String ACTION_MANAGED_PROFILE_ADDED =
3182 "android.intent.action.MANAGED_PROFILE_ADDED";
3183
3184 /**
3185 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003186 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3187 * Only applications (for example Launchers) that need to display merged content across both
3188 * primary and managed profiles need to worry about this broadcast. This is only sent to
3189 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003190 */
3191 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3192 "android.intent.action.MANAGED_PROFILE_REMOVED";
3193
3194 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003195 * Broadcast sent to the primary user when the credential-encrypted private storage for
3196 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3197 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3198 * Launchers) that need to display merged content across both primary and managed profiles
3199 * need to worry about this broadcast. This is only sent to registered receivers,
3200 * not manifest receivers.
3201 */
3202 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3203 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3204
3205 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003206 * Broadcast sent to the primary user when an associated managed profile has become available.
3207 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003208 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3209 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3210 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003211 */
Rubin Xue95057a2016-04-01 16:49:25 +01003212 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3213 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3214
3215 /**
3216 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3217 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3218 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3219 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3220 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3221 */
3222 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3223 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003224
3225 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003226 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3227 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3228 * the device was locked or unlocked.
3229 *
3230 * This is only sent to registered receivers.
3231 *
3232 * @hide
3233 */
3234 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3235 "android.intent.action.DEVICE_LOCKED_CHANGED";
3236
3237 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003238 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3239 */
3240 public static final String ACTION_QUICK_CLOCK =
3241 "android.intent.action.QUICK_CLOCK";
3242
Michael Wright0087a142013-02-05 16:29:39 -08003243 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003244 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003245 * @hide
3246 */
3247 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003248 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003249
Justin Kohd378ad72013-04-01 12:18:26 -07003250 /**
3251 * Broadcast Action: A global button was pressed. Includes a single
3252 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3253 * caused the broadcast.
3254 * @hide
3255 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003256 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003257 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3258
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003259 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003260 * Broadcast Action: Sent when media resource is granted.
3261 * <p>
3262 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3263 * granted.
3264 * </p>
3265 * <p class="note">
3266 * This is a protected intent that can only be sent by the system.
3267 * </p>
3268 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003269 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003270 * </p>
3271 *
3272 * @hide
3273 */
3274 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3275 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3276
3277 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003278 * Broadcast Action: An overlay package has changed. The data contains the
3279 * name of the overlay package which has changed. This is broadcast on all
3280 * changes to the OverlayInfo returned by {@link
3281 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3282 * most common change is a state change that will change whether the
3283 * overlay is enabled or not.
3284 * @hide
3285 */
3286 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3287
3288 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003289 * Activity Action: Allow the user to select and return one or more existing
3290 * documents. When invoked, the system will display the various
3291 * {@link DocumentsProvider} instances installed on the device, letting the
3292 * user interactively navigate through them. These documents include local
3293 * media, such as photos and video, and documents provided by installed
3294 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003295 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003296 * Each document is represented as a {@code content://} URI backed by a
3297 * {@link DocumentsProvider}, which can be opened as a stream with
3298 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3299 * {@link android.provider.DocumentsContract.Document} metadata.
3300 * <p>
3301 * All selected documents are returned to the calling application with
3302 * persistable read and write permission grants. If you want to maintain
3303 * access to the documents across device reboots, you need to explicitly
3304 * take the persistable permissions using
3305 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3306 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003307 * Callers must indicate the acceptable document MIME types through
3308 * {@link #setType(String)}. For example, to select photos, use
3309 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3310 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3311 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003312 * <p>
3313 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003314 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3315 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003316 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003317 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3318 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003319 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003320 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003321 * Callers can set a document URI through
3322 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3323 * location of documents navigator. System will do its best to launch the
3324 * navigator in the specified document if it's a folder, or the folder that
3325 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003326 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003327 * Output: The URI of the item that was picked, returned in
3328 * {@link #getData()}. This must be a {@code content://} URI so that any
3329 * receiver can access it. If multiple documents were selected, they are
3330 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003331 *
3332 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003333 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003334 * @see #ACTION_CREATE_DOCUMENT
3335 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003336 */
3337 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3338 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3339
3340 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003341 * Activity Action: Allow the user to create a new document. When invoked,
3342 * the system will display the various {@link DocumentsProvider} instances
3343 * installed on the device, letting the user navigate through them. The
3344 * returned document may be a newly created document with no content, or it
3345 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003346 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003347 * Each document is represented as a {@code content://} URI backed by a
3348 * {@link DocumentsProvider}, which can be opened as a stream with
3349 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3350 * {@link android.provider.DocumentsContract.Document} metadata.
3351 * <p>
3352 * Callers must indicate the concrete MIME type of the document being
3353 * created by setting {@link #setType(String)}. This MIME type cannot be
3354 * changed after the document is created.
3355 * <p>
3356 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3357 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003358 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003359 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3360 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003361 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003362 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003363 * Callers can set a document URI through
3364 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3365 * location of documents navigator. System will do its best to launch the
3366 * navigator in the specified document if it's a folder, or the folder that
3367 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003368 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003369 * Output: The URI of the item that was created. This must be a
3370 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003371 *
3372 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003373 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003374 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003375 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003376 */
3377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3378 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3379
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003380 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003381 * Activity Action: Allow the user to pick a directory subtree. When
3382 * invoked, the system will display the various {@link DocumentsProvider}
3383 * instances installed on the device, letting the user navigate through
3384 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003385 * <p>
3386 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003387 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3388 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3389 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003390 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003391 * Callers can set a document URI through
3392 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3393 * location of documents navigator. System will do its best to launch the
3394 * navigator in the specified document if it's a folder, or the folder that
3395 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003396 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003397 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003398 *
3399 * @see DocumentsContract
3400 */
3401 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003402 public static final String
3403 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003404
Felipe Lemec7b1f892016-01-15 15:02:31 -08003405 /**
Peng Xua35b5532016-01-20 00:05:45 -08003406 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3407 * exisiting sensor being disconnected.
3408 *
3409 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3410 *
3411 * {@hide}
3412 */
3413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3414 public static final String
3415 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3416
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003417 /**
Sam Line707f832017-04-13 17:00:55 -07003418 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003419 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003420 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003421 */
3422 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003423 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003424 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3425
Christopher Tate6597e342015-02-17 12:15:25 -08003426 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003427 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3428 * is about to be performed.
3429 * @hide
3430 */
3431 @SystemApi
3432 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3433 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3434 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3435
3436 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003437 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3438 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3439 *
3440 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3441 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003442 * @hide
3443 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003444 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003445 public static final String EXTRA_FORCE_MASTER_CLEAR =
3446 "android.intent.extra.FORCE_MASTER_CLEAR";
3447
3448 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003449 * A broadcast action to trigger a factory reset.
3450 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003451 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3452 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003453 *
3454 * <p>Not for use by third-party applications.
3455 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003456 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003457 *
3458 * {@hide}
3459 */
3460 @SystemApi
3461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3462 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3463
3464 /**
3465 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3466 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3467 *
3468 * <p>Not for use by third-party applications.
3469 *
3470 * @hide
3471 */
3472 @SystemApi
3473 public static final String EXTRA_FORCE_FACTORY_RESET =
3474 "android.intent.extra.FORCE_FACTORY_RESET";
3475
3476 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003477 * Broadcast action: report that a settings element is being restored from backup. The intent
3478 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3479 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3480 * is the value of that settings entry prior to the restore operation, and
3481 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3482 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3483 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003484 *
3485 * <p>This broadcast is sent only for settings provider entries known to require special handling
3486 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3487 * the provider's backup agent implementation.
3488 *
3489 * @see #EXTRA_SETTING_NAME
3490 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3491 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003492 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003493 * {@hide}
3494 */
3495 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3496
3497 /** {@hide} */
3498 public static final String EXTRA_SETTING_NAME = "setting_name";
3499 /** {@hide} */
3500 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3501 /** {@hide} */
3502 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003503 /** {@hide} */
3504 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003505
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003506 /**
3507 * Activity Action: Process a piece of text.
3508 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3509 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3510 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3511 */
3512 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3513 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003514
3515 /**
3516 * Broadcast Action: The sim card state has changed.
3517 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3518 * because TelephonyIntents is an internal class.
3519 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003520 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3521 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003522 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003523 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003524 @SystemApi
3525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3526 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3527
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003528 /**
fionaxu90fee272017-03-31 12:45:12 -07003529 * Broadcast Action: indicate that the phone service state has changed.
3530 * The intent will have the following extra values:</p>
3531 * <p>
3532 * @see #EXTRA_VOICE_REG_STATE
3533 * @see #EXTRA_DATA_REG_STATE
3534 * @see #EXTRA_VOICE_ROAMING_TYPE
3535 * @see #EXTRA_DATA_ROAMING_TYPE
3536 * @see #EXTRA_OPERATOR_ALPHA_LONG
3537 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3538 * @see #EXTRA_OPERATOR_NUMERIC
3539 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3540 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3541 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3542 * @see #EXTRA_MANUAL
3543 * @see #EXTRA_VOICE_RADIO_TECH
3544 * @see #EXTRA_DATA_RADIO_TECH
3545 * @see #EXTRA_CSS_INDICATOR
3546 * @see #EXTRA_NETWORK_ID
3547 * @see #EXTRA_SYSTEM_ID
3548 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3549 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3550 * @see #EXTRA_EMERGENCY_ONLY
3551 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3552 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3553 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3554 *
3555 * <p class="note">
3556 * Requires the READ_PHONE_STATE permission.
3557 *
3558 * <p class="note">This is a protected intent that can only be sent by the system.
3559 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003560 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003561 */
3562 @Deprecated
3563 @SystemApi
3564 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3565 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3566
3567 /**
3568 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3569 * state.
3570 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3571 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3572 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3573 * @see android.telephony.ServiceState#STATE_POWER_OFF
3574 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003575 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003576 */
3577 @Deprecated
3578 @SystemApi
3579 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3580
3581 /**
3582 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3583 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3584 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3585 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3586 * @see android.telephony.ServiceState#STATE_POWER_OFF
3587 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003588 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003589 */
3590 @Deprecated
3591 @SystemApi
3592 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3593
3594 /**
3595 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3596 * type.
3597 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003598 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003599 */
3600 @Deprecated
3601 @SystemApi
3602 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3603
3604 /**
3605 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3606 * type.
3607 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003608 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003609 */
3610 @Deprecated
3611 @SystemApi
3612 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3613
3614 /**
3615 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3616 * registered voice operator name in long alphanumeric format.
3617 * {@code null} if the operator name is not known or unregistered.
3618 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003619 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003620 */
3621 @Deprecated
3622 @SystemApi
3623 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3624
3625 /**
3626 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3627 * registered voice operator name in short alphanumeric format.
3628 * {@code null} if the operator name is not known or unregistered.
3629 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003630 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003631 */
3632 @Deprecated
3633 @SystemApi
3634 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3635
3636 /**
3637 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3638 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3639 * network.
3640 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003641 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003642 */
3643 @Deprecated
3644 @SystemApi
3645 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3646
3647 /**
3648 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3649 * registered data operator name in long alphanumeric format.
3650 * {@code null} if the operator name is not known or unregistered.
3651 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003652 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003653 */
3654 @Deprecated
3655 @SystemApi
3656 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3657
3658 /**
3659 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3660 * registered data operator name in short alphanumeric format.
3661 * {@code null} if the operator name is not known or unregistered.
3662 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003663 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003664 */
3665 @Deprecated
3666 @SystemApi
3667 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3668
3669 /**
3670 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3671 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3672 * data operator.
3673 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003674 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003675 */
3676 @Deprecated
3677 @SystemApi
3678 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3679
3680 /**
3681 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3682 * network selection mode is manual.
3683 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3684 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003685 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003686 */
3687 @Deprecated
3688 @SystemApi
3689 public static final String EXTRA_MANUAL = "manual";
3690
3691 /**
3692 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3693 * radio technology.
3694 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003695 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003696 */
3697 @Deprecated
3698 @SystemApi
3699 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3700
3701 /**
3702 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3703 * radio technology.
3704 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003705 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003706 */
3707 @Deprecated
3708 @SystemApi
3709 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3710
3711 /**
3712 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3713 * support on CDMA network.
3714 * Will be {@code true} if support, {@code false} otherwise.
3715 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003716 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003717 */
3718 @Deprecated
3719 @SystemApi
3720 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3721
3722 /**
3723 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3724 * id. {@code Integer.MAX_VALUE} if unknown.
3725 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003726 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003727 */
3728 @Deprecated
3729 @SystemApi
3730 public static final String EXTRA_NETWORK_ID = "networkId";
3731
3732 /**
3733 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3734 * {@code Integer.MAX_VALUE} if unknown.
3735 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003736 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003737 */
3738 @Deprecated
3739 @SystemApi
3740 public static final String EXTRA_SYSTEM_ID = "systemId";
3741
3742 /**
3743 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3744 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
3745 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003746 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003747 */
3748 @Deprecated
3749 @SystemApi
3750 public static final String EXTRA_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3751
3752 /**
3753 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3754 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
3755 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003756 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003757 */
3758 @Deprecated
3759 @SystemApi
3760 public static final String EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3761
3762 /**
3763 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3764 * only mode.
3765 * {@code true} if in emergency only mode, {@code false} otherwise.
3766 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003767 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003768 */
3769 @Deprecated
3770 @SystemApi
3771 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3772
3773 /**
3774 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3775 * registration state is roaming.
3776 * {@code true} if registration indicates roaming, {@code false} otherwise
3777 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003778 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003779 */
3780 @Deprecated
3781 @SystemApi
3782 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3783 "isDataRoamingFromRegistration";
3784
3785 /**
3786 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3787 * aggregation is in use.
3788 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3789 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003790 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003791 */
3792 @Deprecated
3793 @SystemApi
3794 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3795
3796 /**
3797 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3798 * is reduced from the rsrp threshold while calculating signal strength level.
3799 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003800 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003801 */
3802 @Deprecated
3803 @SystemApi
3804 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3805
3806 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003807 * The name of the extra used to define the text to be processed, as a
3808 * CharSequence. Note that this may be a styled CharSequence, so you must use
3809 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003810 */
3811 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3812 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003813 * 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 +00003814 */
3815 public static final String EXTRA_PROCESS_TEXT_READONLY =
3816 "android.intent.extra.PROCESS_TEXT_READONLY";
3817
Bryce Leebc58f592015-09-25 16:43:01 -07003818 /**
3819 * Broadcast action: reports when a new thermal event has been reached. When the device
3820 * is reaching its maximum temperatue, the thermal level reported
3821 * {@hide}
3822 */
3823 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3824 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3825
3826 /** {@hide} */
3827 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3828
3829 /**
3830 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003831 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003832 * {@hide}
3833 */
3834 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3835
3836 /**
3837 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003838 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003839 * {@hide}
3840 */
3841 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3842
3843 /**
3844 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003845 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003846 * {@hide}
3847 */
3848 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3849
3850
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003851 // ---------------------------------------------------------------------
3852 // ---------------------------------------------------------------------
3853 // Standard intent categories (see addCategory()).
3854
3855 /**
3856 * Set if the activity should be an option for the default action
3857 * (center press) to perform on a piece of data. Setting this will
3858 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003859 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003860 * Intent when initiating an action -- it is for use in intent filters
3861 * specified in packages.
3862 */
3863 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3864 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3865 /**
3866 * Activities that can be safely invoked from a browser must support this
3867 * category. For example, if the user is viewing a web page or an e-mail
3868 * and clicks on a link in the text, the Intent generated execute that
3869 * link will require the BROWSABLE category, so that only activities
3870 * supporting this category will be considered as possible actions. By
3871 * supporting this category, you are promising that there is nothing
3872 * damaging (without user intervention) that can happen by invoking any
3873 * matching Intent.
3874 */
3875 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3876 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3877 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003878 * Categories for activities that can participate in voice interaction.
3879 * An activity that supports this category must be prepared to run with
3880 * no UI shown at all (though in some case it may have a UI shown), and
3881 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3882 */
3883 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3884 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3885 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 * Set if the activity should be considered as an alternative action to
3887 * the data the user is currently viewing. See also
3888 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3889 * applies to the selection in a list of items.
3890 *
3891 * <p>Supporting this category means that you would like your activity to be
3892 * displayed in the set of alternative things the user can do, usually as
3893 * part of the current activity's options menu. You will usually want to
3894 * include a specific label in the &lt;intent-filter&gt; of this action
3895 * describing to the user what it does.
3896 *
3897 * <p>The action of IntentFilter with this category is important in that it
3898 * describes the specific action the target will perform. This generally
3899 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3900 * a specific name such as "com.android.camera.action.CROP. Only one
3901 * alternative of any particular action will be shown to the user, so using
3902 * a specific action like this makes sure that your alternative will be
3903 * displayed while also allowing other applications to provide their own
3904 * overrides of that particular action.
3905 */
3906 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3907 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3908 /**
3909 * Set if the activity should be considered as an alternative selection
3910 * action to the data the user has currently selected. This is like
3911 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3912 * of items from which the user can select, giving them alternatives to the
3913 * default action that will be performed on it.
3914 */
3915 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3916 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3917 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003918 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003919 */
3920 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3921 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3922 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003923 * Should be displayed in the top-level launcher.
3924 */
3925 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3926 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3927 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003928 * Indicates an activity optimized for Leanback mode, and that should
3929 * be displayed in the Leanback launcher.
3930 */
3931 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3932 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3933 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08003934 * Indicates the preferred entry-point activity when an application is launched from a Car
3935 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
3936 * fallback, or exclude the application entirely.
3937 * @hide
3938 */
3939 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3940 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
3941 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003942 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3943 * @hide
3944 */
3945 @SystemApi
3946 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3947 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003948 * Provides information about the package it is in; typically used if
3949 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3950 * a front-door to the user without having to be shown in the all apps list.
3951 */
3952 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3953 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 * This is the home activity, that is the first activity that is displayed
3956 * when the device boots.
3957 */
3958 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3959 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3960 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003961 * This is the home activity that is displayed when the device is finished setting up and ready
3962 * for use.
3963 * @hide
3964 */
3965 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3966 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3967 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003968 * This is the setup wizard activity, that is the first activity that is displayed
3969 * when the user sets up the device for the first time.
3970 * @hide
3971 */
3972 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3973 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3974 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07003975 * This is the home activity, that is the activity that serves as the launcher app
3976 * from there the user can start other apps. Often components with lower/higher
3977 * priority intent filters handle the home intent, for example SetupWizard, to
3978 * setup the device and we need to be able to distinguish the home app from these
3979 * setup helpers.
3980 * @hide
3981 */
3982 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3983 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
3984 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985 * This activity is a preference panel.
3986 */
3987 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3988 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3989 /**
3990 * This activity is a development preference panel.
3991 */
3992 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3993 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3994 /**
3995 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003996 */
3997 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3998 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3999 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07004000 * This activity allows the user to browse and download new applications.
4001 */
4002 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4003 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
4004 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004005 * This activity may be exercised by the monkey or other automated test tools.
4006 */
4007 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4008 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
4009 /**
4010 * To be used as a test (not part of the normal user experience).
4011 */
4012 public static final String CATEGORY_TEST = "android.intent.category.TEST";
4013 /**
4014 * To be used as a unit test (run through the Test Harness).
4015 */
4016 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
4017 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004018 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004019 * experience).
4020 */
4021 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004023 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004024 * Used to indicate that an intent only wants URIs that can be opened with
4025 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
4026 * must support at least the columns defined in {@link OpenableColumns} when
4027 * queried.
4028 *
4029 * @see #ACTION_GET_CONTENT
4030 * @see #ACTION_OPEN_DOCUMENT
4031 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004032 */
4033 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4034 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4035
4036 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004037 * Used to indicate that an intent filter can accept files which are not necessarily
4038 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4039 * at least streamable via
4040 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4041 * using one of the stream types exposed via
4042 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4043 *
4044 * @see #ACTION_SEND
4045 * @see #ACTION_SEND_MULTIPLE
4046 */
4047 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4048 public static final String CATEGORY_TYPED_OPENABLE =
4049 "android.intent.category.TYPED_OPENABLE";
4050
4051 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 * To be used as code under test for framework instrumentation tests.
4053 */
4054 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4055 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004056 /**
4057 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004058 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4059 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004060 */
4061 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4062 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4063 /**
4064 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004065 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4066 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004067 */
4068 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4069 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004070 /**
4071 * An activity to run when device is inserted into a analog (low end) dock.
4072 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4073 * information, see {@link android.app.UiModeManager}.
4074 */
4075 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4076 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4077
4078 /**
4079 * An activity to run when device is inserted into a digital (high end) dock.
4080 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4081 * information, see {@link android.app.UiModeManager}.
4082 */
4083 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4084 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004085
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004086 /**
4087 * Used to indicate that the activity can be used in a car environment.
4088 */
4089 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4090 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4091
Zak Cohendb6ca492017-01-26 14:09:00 -08004092 /**
4093 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4094 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4095 * information, see {@link android.app.UiModeManager}.
4096 */
4097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4098 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004099 // ---------------------------------------------------------------------
4100 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004101 // Application launch intent categories (see addCategory()).
4102
4103 /**
4104 * Used with {@link #ACTION_MAIN} to launch the browser application.
4105 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004106 * <p>NOTE: This should not be used as the primary key of an Intent,
4107 * since it will not result in the app launching with the correct
4108 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004109 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004110 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004111 */
4112 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4113 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4114
4115 /**
4116 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4117 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004118 * <p>NOTE: This should not be used as the primary key of an Intent,
4119 * since it will not result in the app launching with the correct
4120 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004121 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004122 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004123 */
4124 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4125 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4126
4127 /**
4128 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4129 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004130 * <p>NOTE: This should not be used as the primary key of an Intent,
4131 * since it will not result in the app launching with the correct
4132 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004133 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004134 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004135 */
4136 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4137 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4138
4139 /**
4140 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4141 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004142 * <p>NOTE: This should not be used as the primary key of an Intent,
4143 * since it will not result in the app launching with the correct
4144 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004145 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004146 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004147 */
4148 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4149 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4150
4151 /**
4152 * Used with {@link #ACTION_MAIN} to launch the email application.
4153 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004154 * <p>NOTE: This should not be used as the primary key of an Intent,
4155 * since it will not result in the app launching with the correct
4156 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004157 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004158 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004159 */
4160 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4161 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4162
4163 /**
4164 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4165 * The activity should be able to view and manipulate image and video files
4166 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004167 * <p>NOTE: This should not be used as the primary key of an Intent,
4168 * since it will not result in the app launching with the correct
4169 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004170 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004171 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004172 */
4173 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4174 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4175
4176 /**
4177 * Used with {@link #ACTION_MAIN} to launch the maps application.
4178 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004179 * <p>NOTE: This should not be used as the primary key of an Intent,
4180 * since it will not result in the app launching with the correct
4181 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004182 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004183 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004184 */
4185 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4186 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4187
4188 /**
4189 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4190 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004191 * <p>NOTE: This should not be used as the primary key of an Intent,
4192 * since it will not result in the app launching with the correct
4193 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004194 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004195 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004196 */
4197 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4198 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4199
4200 /**
4201 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004202 * The activity should be able to play, browse, or manipulate music files
4203 * stored on the device.
4204 * <p>NOTE: This should not be used as the primary key of an Intent,
4205 * since it will not result in the app launching with the correct
4206 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004207 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004208 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004209 */
4210 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4211 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4212
4213 // ---------------------------------------------------------------------
4214 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004215 // Standard extra data keys.
4216
4217 /**
4218 * The initial data to place in a newly created record. Use with
4219 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4220 * fields as would be given to the underlying ContentProvider.insert()
4221 * call.
4222 */
4223 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4224
4225 /**
4226 * A constant CharSequence that is associated with the Intent, used with
4227 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4228 * this may be a styled CharSequence, so you must use
4229 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4230 * retrieve it.
4231 */
4232 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4233
4234 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004235 * A constant String that is associated with the Intent, used with
4236 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4237 * as HTML formatted text. Note that you <em>must</em> also supply
4238 * {@link #EXTRA_TEXT}.
4239 */
4240 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4241
4242 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004243 * A content: URI holding a stream of data associated with the Intent,
4244 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004245 */
4246 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4247
4248 /**
4249 * A String[] holding e-mail addresses that should be delivered to.
4250 */
4251 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4252
4253 /**
4254 * A String[] holding e-mail addresses that should be carbon copied.
4255 */
4256 public static final String EXTRA_CC = "android.intent.extra.CC";
4257
4258 /**
4259 * A String[] holding e-mail addresses that should be blind carbon copied.
4260 */
4261 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4262
4263 /**
4264 * A constant string holding the desired subject line of a message.
4265 */
4266 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4267
4268 /**
4269 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004270 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271 */
4272 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4273
4274 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004275 * An int representing the user id to be used.
4276 *
4277 * @hide
4278 */
4279 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4280
4281 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004282 * An int representing the task id to be retrieved. This is used when a launch from recents is
4283 * intercepted by another action such as credentials confirmation to remember which task should
4284 * be resumed when complete.
4285 *
4286 * @hide
4287 */
4288 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4289
4290 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004291 * An Intent[] describing additional, alternate choices you would like shown with
4292 * {@link #ACTION_CHOOSER}.
4293 *
4294 * <p>An app may be capable of providing several different payload types to complete a
4295 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4296 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4297 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4298 * photo data or a hosted link where the photos can be viewed.</p>
4299 *
4300 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4301 * first/primary/preferred intent in the set. Additional intents specified in
4302 * this extra are ordered; by default intents that appear earlier in the array will be
4303 * preferred over intents that appear later in the array as matches for the same
4304 * target component. To alter this preference, a calling app may also supply
4305 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4306 */
4307 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4308
4309 /**
Adam Powell52c39212016-04-07 15:14:18 -07004310 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4311 * and omitted from a list of components presented to the user.
4312 *
4313 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4314 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4315 * from your own package or other apps from your organization if the idea of sending to those
4316 * targets would be redundant with other app functionality. Filtered components will not
4317 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4318 */
4319 public static final String EXTRA_EXCLUDE_COMPONENTS
4320 = "android.intent.extra.EXCLUDE_COMPONENTS";
4321
4322 /**
4323 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4324 * describing additional high-priority deep-link targets for the chooser to present to the user.
4325 *
4326 * <p>Targets provided in this way will be presented inline with all other targets provided
4327 * by services from other apps. They will be prioritized before other service targets, but
4328 * after those targets provided by sources that the user has manually pinned to the front.</p>
4329 *
4330 * @see #ACTION_CHOOSER
4331 */
4332 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4333
4334 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004335 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4336 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4337 *
4338 * <p>An app preparing an action for another app to complete may wish to allow the user to
4339 * disambiguate between several options for completing the action based on the chosen target
4340 * or otherwise refine the action before it is invoked.
4341 * </p>
4342 *
4343 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4344 * <ul>
4345 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4346 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4347 * chosen target beyond the first</li>
4348 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4349 * should fill in and send once the disambiguation is complete</li>
4350 * </ul>
4351 */
4352 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4353 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4354
4355 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004356 * An {@code ArrayList} of {@code String} annotations describing content for
4357 * {@link #ACTION_CHOOSER}.
4358 *
4359 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4360 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4361 *
4362 * <p>Annotations should describe the major components or topics of the content. It is up to
4363 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4364 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004365 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4366 * character. Performance on customized annotations can suffer, if they are rarely used for
4367 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4368 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004369 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004370 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004371 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004372 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004373 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004374 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004375 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004376 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004377 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004378 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4379 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4380 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4381 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4382 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004383 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004384 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4385 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004386 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004387 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004388 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004389 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004390 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004391 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004392 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004393 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004394 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004395 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004396 * Christmas and Thanksgiving.</li>
4397 * </ul>
4398 */
4399 public static final String EXTRA_CONTENT_ANNOTATIONS
4400 = "android.intent.extra.CONTENT_ANNOTATIONS";
4401
4402 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004403 * A {@link ResultReceiver} used to return data back to the sender.
4404 *
4405 * <p>Used to complete an app-specific
4406 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4407 *
4408 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4409 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4410 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4411 * when the user selects a target component from the chooser. It is up to the recipient
4412 * to send a result to this ResultReceiver to signal that disambiguation is complete
4413 * and that the chooser should invoke the user's choice.</p>
4414 *
4415 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4416 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4417 * to match and fill in the final Intent or ChooserTarget before starting it.
4418 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4419 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4420 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4421 *
4422 * <p>The result code passed to the ResultReceiver should be
4423 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4424 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4425 * the chooser should finish without starting a target.</p>
4426 */
4427 public static final String EXTRA_RESULT_RECEIVER
4428 = "android.intent.extra.RESULT_RECEIVER";
4429
4430 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004431 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004432 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004433 */
4434 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4435
4436 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004437 * A Parcelable[] of {@link Intent} or
4438 * {@link android.content.pm.LabeledIntent} objects as set with
4439 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4440 * a the front of the list of choices, when shown to the user with a
4441 * {@link #ACTION_CHOOSER}.
4442 */
4443 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4444
4445 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004446 * A {@link IntentSender} to start after ephemeral installation success.
4447 * @hide
4448 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004449 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4450
4451 /**
4452 * A {@link IntentSender} to start after ephemeral installation failure.
4453 * @hide
4454 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004455 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4456
4457 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004458 * The host name that triggered an ephemeral resolution.
4459 * @hide
4460 */
4461 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4462
4463 /**
4464 * An opaque token to track ephemeral resolution.
4465 * @hide
4466 */
4467 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4468
4469 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004470 * The action that triggered an instant application resolution.
4471 * @hide
4472 */
4473 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4474
4475 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004476 * An array of {@link Bundle}s containing details about resolved instant apps..
4477 * @hide
4478 */
4479 @SystemApi
4480 public static final String EXTRA_INSTANT_APP_BUNDLES =
4481 "android.intent.extra.INSTANT_APP_BUNDLES";
4482
4483 /**
4484 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004485 * installed. This data is populated from the response to
4486 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4487 * instant application resolver.
4488 * @hide
4489 */
4490 public static final String EXTRA_INSTANT_APP_EXTRAS =
4491 "android.intent.extra.INSTANT_APP_EXTRAS";
4492
4493 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004494 * A boolean value indicating that the instant app resolver was unable to state with certainty
4495 * that it did or did not have an app for the sanitized {@link Intent} defined at
4496 * {@link #EXTRA_INTENT}.
4497 * @hide
4498 */
4499 @SystemApi
4500 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4501 "android.intent.extra.UNKNOWN_INSTANT_APP";
4502
4503 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004504 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004505 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004506 * @hide
4507 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004508 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004509 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4510
4511 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004512 * The version code of the app to install components from.
4513 * @hide
4514 */
4515 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4516
4517 /**
Chad Brubaker06068612017-04-06 09:43:47 -07004518 * The app that triggered the ephemeral installation.
4519 * @hide
4520 */
4521 public static final String EXTRA_CALLING_PACKAGE
4522 = "android.intent.extra.CALLING_PACKAGE";
4523
4524 /**
4525 * Optional calling app provided bundle containing additional launch information the
4526 * installer may use.
4527 * @hide
4528 */
4529 public static final String EXTRA_VERIFICATION_BUNDLE
4530 = "android.intent.extra.VERIFICATION_BUNDLE";
4531
4532 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004533 * A Bundle forming a mapping of potential target package names to different extras Bundles
4534 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4535 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4536 * be currently installed on the device.
4537 *
4538 * <p>An application may choose to provide alternate extras for the case where a user
4539 * selects an activity from a predetermined set of target packages. If the activity
4540 * the user selects from the chooser belongs to a package with its package name as
4541 * a key in this bundle, the corresponding extras for that package will be merged with
4542 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4543 * extra has the same key as an extra already present in the intent it will overwrite
4544 * the extra from the intent.</p>
4545 *
4546 * <p><em>Examples:</em>
4547 * <ul>
4548 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4549 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4550 * parameters for that target.</li>
4551 * <li>An application may offer additional metadata for known targets of a given intent
4552 * to pass along information only relevant to that target such as account or content
4553 * identifiers already known to that application.</li>
4554 * </ul></p>
4555 */
4556 public static final String EXTRA_REPLACEMENT_EXTRAS =
4557 "android.intent.extra.REPLACEMENT_EXTRAS";
4558
4559 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004560 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4561 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4562 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4563 * {@link ComponentName} of the chosen component.
4564 *
4565 * <p>In some situations this callback may never come, for example if the user abandons
4566 * the chooser, switches to another task or any number of other reasons. Apps should not
4567 * be written assuming that this callback will always occur.</p>
4568 */
4569 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4570 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4571
4572 /**
4573 * The {@link ComponentName} chosen by the user to complete an action.
4574 *
4575 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4576 */
4577 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4578
4579 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004580 * A {@link android.view.KeyEvent} object containing the event that
4581 * triggered the creation of the Intent it is in.
4582 */
4583 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4584
4585 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004586 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4587 * before shutting down.
4588 *
4589 * {@hide}
4590 */
4591 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4592
4593 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004594 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4595 * requested by the user.
4596 *
4597 * {@hide}
4598 */
4599 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4600 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4601
4602 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004603 * 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 -07004604 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4605 * of restarting the application.
4606 */
4607 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4608
4609 /**
4610 * A String holding the phone number originally entered in
4611 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4612 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4613 */
4614 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004615
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004616 /**
4617 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4618 * intents to supply the uid the package had been assigned. Also an optional
4619 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4620 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4621 * purpose.
4622 */
4623 public static final String EXTRA_UID = "android.intent.extra.UID";
4624
4625 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004626 * @hide String array of package names.
4627 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004628 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004629 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4630
4631 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004632 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4633 * intents to indicate whether this represents a full uninstall (removing
4634 * both the code and its data) or a partial uninstall (leaving its data,
4635 * implying that this is an update).
4636 */
4637 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004638
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004639 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004640 * @hide
4641 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4642 * intents to indicate that at this point the package has been removed for
4643 * all users on the device.
4644 */
4645 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4646 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4647
4648 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004649 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4650 * intents to indicate that this is a replacement of the package, so this
4651 * broadcast will immediately be followed by an add broadcast for a
4652 * different version of the same package.
4653 */
4654 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004655
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004656 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 * Used as an int extra field in {@link android.app.AlarmManager} intents
4658 * to tell the application being invoked how many pending alarms are being
4659 * delievered with the intent. For one-shot alarms this will always be 1.
4660 * For recurring alarms, this might be greater than 1 if the device was
4661 * asleep or powered off at the time an earlier alarm would have been
4662 * delivered.
4663 */
4664 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004665
Jacek Surazski86b6c532009-05-13 14:38:28 +02004666 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004667 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4668 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004669 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4670 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004671 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4672 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4673 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004674 */
4675 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4676
4677 /**
4678 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4679 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004680 */
4681 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4682
4683 /**
4684 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4685 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004686 */
4687 public static final int EXTRA_DOCK_STATE_DESK = 1;
4688
4689 /**
4690 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4691 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004692 */
4693 public static final int EXTRA_DOCK_STATE_CAR = 2;
4694
4695 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004696 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4697 * to represent that the phone is in a analog (low end) dock.
4698 */
4699 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4700
4701 /**
4702 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4703 * to represent that the phone is in a digital (high end) dock.
4704 */
4705 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4706
4707 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004708 * Boolean that can be supplied as meta-data with a dock activity, to
4709 * indicate that the dock should take over the home key when it is active.
4710 */
4711 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004712
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004713 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004714 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4715 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004716 */
4717 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4718
4719 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004720 * Used in the extra field in the remote intent. It's astring token passed with the
4721 * remote intent.
4722 */
4723 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4724 "android.intent.extra.remote_intent_token";
4725
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004726 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004727 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004728 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004729 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004730 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004731 "android.intent.extra.changed_component_name";
4732
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004733 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004734 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004735 * and contains a string array of all of the components that have changed. If
4736 * the state of the overall package has changed, then it will contain an entry
4737 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004738 */
4739 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4740 "android.intent.extra.changed_component_name_list";
4741
4742 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004743 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004744 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004745 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4746 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4747 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004748 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004749 */
4750 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4751 "android.intent.extra.changed_package_list";
4752
4753 /**
4754 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004755 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4756 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004757 * and contains an integer array of uids of all of the components
4758 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004759 */
4760 public static final String EXTRA_CHANGED_UID_LIST =
4761 "android.intent.extra.changed_uid_list";
4762
4763 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004764 * @hide
4765 * Magic extra system code can use when binding, to give a label for
4766 * who it is that has bound to a service. This is an integer giving
4767 * a framework string resource that can be displayed to the user.
4768 */
4769 public static final String EXTRA_CLIENT_LABEL =
4770 "android.intent.extra.client_label";
4771
4772 /**
4773 * @hide
4774 * Magic extra system code can use when binding, to give a PendingIntent object
4775 * that can be launched for the user to disable the system's use of this
4776 * service.
4777 */
4778 public static final String EXTRA_CLIENT_INTENT =
4779 "android.intent.extra.client_intent";
4780
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004781 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004782 * Extra used to indicate that an intent should only return data that is on
4783 * the local device. This is a boolean extra; the default is false. If true,
4784 * an implementation should only allow the user to select data that is
4785 * already on the device, not requiring it be downloaded from a remote
4786 * service when opened.
4787 *
4788 * @see #ACTION_GET_CONTENT
4789 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004790 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004791 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004792 */
4793 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004794 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004795
Amith Yamasani13593602012-03-22 16:16:17 -07004796 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004797 * Extra used to indicate that an intent can allow the user to select and
4798 * return multiple items. This is a boolean extra; the default is false. If
4799 * true, an implementation is allowed to present the user with a UI where
4800 * they can pick multiple items that are all returned to the caller. When
4801 * this happens, they should be returned as the {@link #getClipData()} part
4802 * of the result Intent.
4803 *
4804 * @see #ACTION_GET_CONTENT
4805 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004806 */
4807 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004808 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004809
4810 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004811 * The integer userHandle carried with broadcast intents related to addition, removal and
4812 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4813 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4814 *
Amith Yamasani13593602012-03-22 16:16:17 -07004815 * @hide
4816 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004817 public static final String EXTRA_USER_HANDLE =
4818 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004819
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004820 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004821 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4822 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4823 */
4824 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004825 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004826
4827 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004828 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004829 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4830 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004831 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004832 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4833
4834 /**
4835 * Extra sent in the intent to the BroadcastReceiver that handles
4836 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4837 * the restrictions as key/value pairs.
4838 */
4839 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4840 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004841
Amith Yamasani86118ba2013-03-28 14:33:16 -07004842 /**
4843 * Extra used in the response from a BroadcastReceiver that handles
4844 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4845 */
4846 public static final String EXTRA_RESTRICTIONS_INTENT =
4847 "android.intent.extra.restrictions_intent";
4848
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004849 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004850 * Extra used to communicate a set of acceptable MIME types. The type of the
4851 * extra is {@code String[]}. Values may be a combination of concrete MIME
4852 * types (such as "image/png") and/or partial MIME types (such as
4853 * "audio/*").
4854 *
4855 * @see #ACTION_GET_CONTENT
4856 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004857 */
4858 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4859
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004860 /**
4861 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4862 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004863 * When this is true, hardware devices can use this information to determine that
4864 * they shouldn't do a complete shutdown of their device since this is not a
4865 * complete shutdown down to the kernel, but only user space restarting.
4866 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004867 */
4868 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4869 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4870
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004871 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004872 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4873 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4874 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4875 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004876 *
4877 * @hide for internal use only.
4878 */
4879 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4880 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004881 /** @hide */
4882 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4883 /** @hide */
4884 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4885 /** @hide */
4886 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004887
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07004888 /**
4889 * Intent extra: the reason that the operation associated with this intent is being performed.
4890 *
4891 * <p>Type: String
4892 * @hide
4893 */
4894 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004895 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4896
qingxi240c2bb2017-04-12 17:31:18 -07004897 /**
4898 * {@hide}
4899 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4900 */
Rubin Xue8490f12015-06-25 12:17:48 +01004901 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4902
Santos Cordon15a13782015-03-31 18:32:31 -07004903 /**
qingxi240c2bb2017-04-12 17:31:18 -07004904 * {@hide}
4905 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4906 * reset for the device with eSIM. This extra will be sent together with
4907 * {@link #ACTION_FACTORY_RESET}
4908 */
4909 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4910
4911 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004912 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4913 * activation request.
4914 * TODO: Add information about the structure and response data used with the pending intent.
4915 * @hide
4916 */
4917 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4918 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4919
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004920 /**
4921 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004922 *
4923 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004924 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004925 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004926 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4927
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004928 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004929 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4930 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4931 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004932 *
4933 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004934 * @see #ACTION_QUICK_VIEW
4935 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004936 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004937 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004938 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4939 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004940
4941 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004942 * An optional extra of {@code String[]} indicating which quick view features should be made
4943 * available to the user in the quick view UI while handing a
4944 * {@link Intent#ACTION_QUICK_VIEW} intent.
4945 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4946 * Quick viewer can implement features not listed below.
4947 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05004948 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
4949 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
4950 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07004951 * <p>
4952 * Requirements:
4953 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4954 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4955 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4956 * internal policies.
4957 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4958 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4959 * disable or hide features.
4960 *
4961 * @see #ACTION_QUICK_VIEW
4962 */
4963 public static final String EXTRA_QUICK_VIEW_FEATURES =
4964 "android.intent.extra.QUICK_VIEW_FEATURES";
4965
4966 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004967 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004968 * When a profile goes into quiet mode, all apps in the profile are killed and the
4969 * profile user is stopped. Widgets originating from the profile are masked, and app
4970 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004971 */
4972 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004973
4974 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004975 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004976 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004977 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4978 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004979 *
4980 * @hide
4981 */
4982 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4983 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4984
4985 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004986 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4987 * whether to show the chooser or not when there is only one application available
4988 * to choose from.
4989 *
4990 * @hide
4991 */
4992 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4993 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4994
4995 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004996 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004997 * to represent that a video codec is allowed to use.
4998 *
4999 * @hide
5000 */
5001 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5002
5003 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005004 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005005 * to represent that a audio codec is allowed to use.
5006 *
5007 * @hide
5008 */
5009 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5010
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005011 // ---------------------------------------------------------------------
5012 // ---------------------------------------------------------------------
5013 // Intent flags (see mFlags variable).
5014
Tor Norbyed9273d62013-05-30 15:59:53 -07005015 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005016 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005017 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5018 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005019 @Retention(RetentionPolicy.SOURCE)
5020 public @interface GrantUriMode {}
5021
Jeff Sharkey846318a2014-04-04 12:12:41 -07005022 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005023 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005024 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5025 @Retention(RetentionPolicy.SOURCE)
5026 public @interface AccessUriMode {}
5027
5028 /**
5029 * Test if given mode flags specify an access mode, which must be at least
5030 * read and/or write.
5031 *
5032 * @hide
5033 */
5034 public static boolean isAccessUriMode(int modeFlags) {
5035 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5036 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5037 }
5038
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005039 /** @hide */
5040 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5041 FLAG_GRANT_READ_URI_PERMISSION,
5042 FLAG_GRANT_WRITE_URI_PERMISSION,
5043 FLAG_FROM_BACKGROUND,
5044 FLAG_DEBUG_LOG_RESOLUTION,
5045 FLAG_EXCLUDE_STOPPED_PACKAGES,
5046 FLAG_INCLUDE_STOPPED_PACKAGES,
5047 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5048 FLAG_GRANT_PREFIX_URI_PERMISSION,
5049 FLAG_DEBUG_TRIAGED_MISSING,
5050 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005051 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005052 FLAG_ACTIVITY_NO_HISTORY,
5053 FLAG_ACTIVITY_SINGLE_TOP,
5054 FLAG_ACTIVITY_NEW_TASK,
5055 FLAG_ACTIVITY_MULTIPLE_TASK,
5056 FLAG_ACTIVITY_CLEAR_TOP,
5057 FLAG_ACTIVITY_FORWARD_RESULT,
5058 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5059 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5060 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5061 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5062 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5063 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5064 FLAG_ACTIVITY_NEW_DOCUMENT,
5065 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5066 FLAG_ACTIVITY_NO_USER_ACTION,
5067 FLAG_ACTIVITY_REORDER_TO_FRONT,
5068 FLAG_ACTIVITY_NO_ANIMATION,
5069 FLAG_ACTIVITY_CLEAR_TASK,
5070 FLAG_ACTIVITY_TASK_ON_HOME,
5071 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5072 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5073 FLAG_RECEIVER_REGISTERED_ONLY,
5074 FLAG_RECEIVER_REPLACE_PENDING,
5075 FLAG_RECEIVER_FOREGROUND,
5076 FLAG_RECEIVER_NO_ABORT,
5077 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5078 FLAG_RECEIVER_BOOT_UPGRADE,
5079 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5080 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5081 FLAG_RECEIVER_FROM_SHELL,
5082 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5083 })
5084 @Retention(RetentionPolicy.SOURCE)
5085 public @interface Flags {}
5086
5087 /** @hide */
5088 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5089 FLAG_FROM_BACKGROUND,
5090 FLAG_DEBUG_LOG_RESOLUTION,
5091 FLAG_EXCLUDE_STOPPED_PACKAGES,
5092 FLAG_INCLUDE_STOPPED_PACKAGES,
5093 FLAG_DEBUG_TRIAGED_MISSING,
5094 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005095 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005096 FLAG_ACTIVITY_NO_HISTORY,
5097 FLAG_ACTIVITY_SINGLE_TOP,
5098 FLAG_ACTIVITY_NEW_TASK,
5099 FLAG_ACTIVITY_MULTIPLE_TASK,
5100 FLAG_ACTIVITY_CLEAR_TOP,
5101 FLAG_ACTIVITY_FORWARD_RESULT,
5102 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5103 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5104 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5105 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5106 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5107 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5108 FLAG_ACTIVITY_NEW_DOCUMENT,
5109 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5110 FLAG_ACTIVITY_NO_USER_ACTION,
5111 FLAG_ACTIVITY_REORDER_TO_FRONT,
5112 FLAG_ACTIVITY_NO_ANIMATION,
5113 FLAG_ACTIVITY_CLEAR_TASK,
5114 FLAG_ACTIVITY_TASK_ON_HOME,
5115 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5116 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5117 FLAG_RECEIVER_REGISTERED_ONLY,
5118 FLAG_RECEIVER_REPLACE_PENDING,
5119 FLAG_RECEIVER_FOREGROUND,
5120 FLAG_RECEIVER_NO_ABORT,
5121 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5122 FLAG_RECEIVER_BOOT_UPGRADE,
5123 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5124 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5125 FLAG_RECEIVER_FROM_SHELL,
5126 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5127 })
5128 @Retention(RetentionPolicy.SOURCE)
5129 public @interface MutableFlags {}
5130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005131 /**
5132 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005133 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005134 * specified in its ClipData. When applying to an Intent's ClipData,
5135 * all URIs as well as recursive traversals through data or other ClipData
5136 * in Intent items will be granted; only the grant flags of the top-level
5137 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005138 */
5139 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5140 /**
5141 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005142 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005143 * specified in its ClipData. When applying to an Intent's ClipData,
5144 * all URIs as well as recursive traversals through data or other ClipData
5145 * in Intent items will be granted; only the grant flags of the top-level
5146 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005147 */
5148 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5149 /**
5150 * Can be set by the caller to indicate that this Intent is coming from
5151 * a background operation, not from direct user interaction.
5152 */
5153 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5154 /**
5155 * A flag you can enable for debugging: when set, log messages will be
5156 * printed during the resolution of this intent to show you what has
5157 * been found to create the final resolved list.
5158 */
5159 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005160 /**
5161 * If set, this intent will not match any components in packages that
5162 * are currently stopped. If this is not set, then the default behavior
5163 * is to include such applications in the result.
5164 */
5165 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5166 /**
5167 * If set, this intent will always match any components in packages that
5168 * are currently stopped. This is the default behavior when
5169 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5170 * flags are set, this one wins (it allows overriding of exclude for
5171 * places where the framework may automatically set the exclude flag).
5172 */
5173 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005174
5175 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005176 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005177 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005178 * persisted across device reboots until explicitly revoked with
5179 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5180 * grant for possible persisting; the receiving application must call
5181 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5182 * actually persist.
5183 *
5184 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5185 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5186 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005187 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005188 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005189 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005190
5191 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005192 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5193 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5194 * applies to any URI that is a prefix match against the original granted
5195 * URI. (Without this flag, the URI must match exactly for access to be
5196 * granted.) Another URI is considered a prefix match only when scheme,
5197 * authority, and all path segments defined by the prefix are an exact
5198 * match.
5199 */
5200 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5201
5202 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005203 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005204 * homework and verified that they correctly handle packages and components
5205 * that come and go over time. In particular:
5206 * <ul>
5207 * <li>Apps installed on external storage, which will appear to be
5208 * uninstalled while the the device is ejected.
5209 * <li>Apps with encryption unaware components, which will appear to not
5210 * exist while the device is locked.
5211 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005212 *
5213 * @hide
5214 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005215 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005216
5217 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005218 * Internal flag used to indicate ephemeral applications should not be
5219 * considered when resolving the intent.
5220 *
5221 * @hide
5222 */
5223 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5224
5225 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005226 * If set, the new activity is not kept in the history stack. As soon as
5227 * the user navigates away from it, the activity is finished. This may also
5228 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5229 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005230 *
5231 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5232 * is never invoked when the current activity starts a new activity which
5233 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005234 */
5235 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5236 /**
5237 * If set, the activity will not be launched if it is already running
5238 * at the top of the history stack.
5239 */
5240 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5241 /**
5242 * If set, this activity will become the start of a new task on this
5243 * history stack. A task (from the activity that started it to the
5244 * next task activity) defines an atomic group of activities that the
5245 * user can move to. Tasks can be moved to the foreground and background;
5246 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005247 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005248 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5249 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250 *
5251 * <p>This flag is generally used by activities that want
5252 * to present a "launcher" style behavior: they give the user a list of
5253 * separate things that can be done, which otherwise run completely
5254 * independently of the activity launching them.
5255 *
5256 * <p>When using this flag, if a task is already running for the activity
5257 * you are now starting, then a new activity will not be started; instead,
5258 * the current task will simply be brought to the front of the screen with
5259 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5260 * to disable this behavior.
5261 *
5262 * <p>This flag can not be used when the caller is requesting a result from
5263 * the activity being launched.
5264 */
5265 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5266 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005267 * This flag is used to create a new task and launch an activity into it.
5268 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5269 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5270 * search through existing tasks for ones matching this Intent. Only if no such
5271 * task is found would a new task be created. When paired with
5272 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5273 * the search for a matching task and unconditionally start a new task.
5274 *
5275 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5276 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005277 * top-level application launcher.</strong> Used in conjunction with
5278 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5279 * behavior of bringing an existing task to the foreground. When set,
5280 * a new task is <em>always</em> started to host the Activity for the
5281 * Intent, regardless of whether there is already an existing task running
5282 * the same thing.
5283 *
5284 * <p><strong>Because the default system does not include graphical task management,
5285 * you should not use this flag unless you provide some way for a user to
5286 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005287 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005288 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5289 * creating new document tasks.
5290 *
5291 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005292 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005293 *
Scott Main7aee61f2011-02-08 11:25:01 -08005294 * <p>See
5295 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5296 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005297 *
5298 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5299 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005300 */
5301 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5302 /**
5303 * If set, and the activity being launched is already running in the
5304 * current task, then instead of launching a new instance of that activity,
5305 * all of the other activities on top of it will be closed and this Intent
5306 * will be delivered to the (now on top) old activity as a new Intent.
5307 *
5308 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5309 * If D calls startActivity() with an Intent that resolves to the component
5310 * of activity B, then C and D will be finished and B receive the given
5311 * Intent, resulting in the stack now being: A, B.
5312 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005313 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005314 * either receive the new intent you are starting here in its
5315 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005316 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005317 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5318 * the same intent, then it will be finished and re-created; for all other
5319 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5320 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005321 *
5322 * <p>This launch mode can also be used to good effect in conjunction with
5323 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5324 * of a task, it will bring any currently running instance of that task
5325 * to the foreground, and then clear it to its root state. This is
5326 * especially useful, for example, when launching an activity from the
5327 * notification manager.
5328 *
Scott Main7aee61f2011-02-08 11:25:01 -08005329 * <p>See
5330 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5331 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005332 */
5333 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5334 /**
5335 * If set and this intent is being used to launch a new activity from an
5336 * existing one, then the reply target of the existing activity will be
5337 * transfered to the new activity. This way the new activity can call
5338 * {@link android.app.Activity#setResult} and have that result sent back to
5339 * the reply target of the original activity.
5340 */
5341 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5342 /**
5343 * If set and this intent is being used to launch a new activity from an
5344 * existing one, the current activity will not be counted as the top
5345 * activity for deciding whether the new intent should be delivered to
5346 * the top instead of starting a new one. The previous activity will
5347 * be used as the top, with the assumption being that the current activity
5348 * will finish itself immediately.
5349 */
5350 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5351 /**
5352 * If set, the new activity is not kept in the list of recently launched
5353 * activities.
5354 */
5355 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5356 /**
5357 * This flag is not normally set by application code, but set for you by
5358 * the system as described in the
5359 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5360 * launchMode} documentation for the singleTask mode.
5361 */
5362 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5363 /**
5364 * If set, and this activity is either being started in a new task or
5365 * bringing to the top an existing task, then it will be launched as
5366 * the front door of the task. This will result in the application of
5367 * any affinities needed to have that task in the proper state (either
5368 * moving activities to or from it), or simply resetting that task to
5369 * its initial state if needed.
5370 */
5371 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5372 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005373 * This flag is not normally set by application code, but set for you by
5374 * the system if this activity is being launched from history
5375 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005376 */
5377 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005378 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005379 * @deprecated As of API 21 this performs identically to
5380 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005381 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005382 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005383 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005384 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005385 * This flag is used to open a document into a new task rooted at the activity launched
5386 * by this Intent. Through the use of this flag, or its equivalent attribute,
5387 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005388 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005389 *
Craig Mautner026596b2014-05-21 15:35:44 -07005390 * <p>The use of the activity attribute form of this,
5391 * {@link android.R.attr#documentLaunchMode}, is
5392 * preferred over the Intent flag described here. The attribute form allows the
5393 * Activity to specify multiple document behavior for all launchers of the Activity
5394 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005395 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005396 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5397 * it is kept after the activity is finished is different than the use of
5398 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5399 * this flag is being used to create a new recents entry, then by default that entry
5400 * will be removed once the activity is finished. You can modify this behavior with
5401 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5402 *
Craig Mautner026596b2014-05-21 15:35:44 -07005403 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5404 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5405 * equivalent of the Activity manifest specifying {@link
5406 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5407 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5408 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005409 *
Craig Mautner026596b2014-05-21 15:35:44 -07005410 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005411 *
Craig Mautner026596b2014-05-21 15:35:44 -07005412 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005413 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5414 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005415 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005416 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005417 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005418 * callback from occurring on the current frontmost activity before it is
5419 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005420 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005421 * <p>Typically, an activity can rely on that callback to indicate that an
5422 * explicit user action has caused their activity to be moved out of the
5423 * foreground. The callback marks an appropriate point in the activity's
5424 * lifecycle for it to dismiss any notifications that it intends to display
5425 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005426 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005427 * <p>If an activity is ever started via any non-user-driven events such as
5428 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5429 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005430 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005431 */
5432 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005433 /**
5434 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5435 * this flag will cause the launched activity to be brought to the front of its
5436 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005437 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005438 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5439 * If D calls startActivity() with an Intent that resolves to the component
5440 * of activity B, then B will be brought to the front of the history stack,
5441 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005442 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005443 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005444 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005445 */
5446 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005447 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005448 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5449 * this flag will prevent the system from applying an activity transition
5450 * animation to go to the next activity state. This doesn't mean an
5451 * animation will never run -- if another activity change happens that doesn't
5452 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005453 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005454 * when you are going to do a series of activity operations but the
5455 * animation seen by the user shouldn't be driven by the first activity
5456 * change but rather a later one.
5457 */
5458 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5459 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005460 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5461 * this flag will cause any existing task that would be associated with the
5462 * activity to be cleared before the activity is started. That is, the activity
5463 * becomes the new root of an otherwise empty task, and any old activities
5464 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5465 */
5466 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5467 /**
5468 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5469 * this flag will cause a newly launching task to be placed on top of the current
5470 * home activity task (if there is one). That is, pressing back from the task
5471 * will always return the user to home even if that was not the last activity they
5472 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5473 */
5474 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5475 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005476 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5477 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005478 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005479 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005480 * this flag. When set and the task's activity is finished, the recents
5481 * entry will remain in the interface for the user to re-launch it, like a
5482 * recents entry for a top-level application.
5483 * <p>
5484 * The receiving activity can override this request with
5485 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5486 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005487 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005488 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005489 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005490
5491 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005492 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5493 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005494 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5495 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005496 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005497 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005498
Patrick Baumann577d4022018-01-31 16:55:10 +00005499
5500 /**
5501 * If set, resolution of this intent may take place via an instant app not
5502 * yet on the device if there does not yet exist an app on device to
5503 * resolve it.
5504 */
5505 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5506
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005507 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005508 * If set, when sending a broadcast only registered receivers will be
5509 * called -- no BroadcastReceiver components will be launched.
5510 */
5511 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005512 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005513 * If set, when sending a broadcast the new broadcast will replace
5514 * any existing pending broadcast that matches it. Matching is defined
5515 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5516 * true for the intents of the two broadcasts. When a match is found,
5517 * the new broadcast (and receivers associated with it) will replace the
5518 * existing one in the pending broadcast list, remaining at the same
5519 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005520 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005521 * <p>This flag is most typically used with sticky broadcasts, which
5522 * only care about delivering the most recent values of the broadcast
5523 * to their receivers.
5524 */
5525 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5526 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005527 * If set, when sending a broadcast the recipient is allowed to run at
5528 * foreground priority, with a shorter timeout interval. During normal
5529 * broadcasts the receivers are not automatically hoisted out of the
5530 * background priority class.
5531 */
5532 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5533 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005534 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5535 * They can still propagate results through to later receivers, but they can not prevent
5536 * later receivers from seeing the broadcast.
5537 */
5538 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5539 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005540 * If set, when sending a broadcast <i>before boot has completed</i> only
5541 * registered receivers will be called -- no BroadcastReceiver components
5542 * will be launched. Sticky intent state will be recorded properly even
5543 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5544 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005545 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005546 * <p>This flag is only for use by system sevices as a convenience to
5547 * avoid having to implement a more complex mechanism around detection
5548 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005549 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005550 * @hide
5551 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005552 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005553 /**
5554 * Set when this broadcast is for a boot upgrade, a special mode that
5555 * allows the broadcast to be sent before the system is ready and launches
5556 * the app process with no providers running in it.
5557 * @hide
5558 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005559 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005560 /**
5561 * If set, the broadcast will always go to manifest receivers in background (cached
5562 * or not running) apps, regardless of whether that would be done by default. By
5563 * default they will only receive broadcasts if the broadcast has specified an
5564 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005565 *
5566 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5567 * the broadcast code there must also be changed to match.
5568 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005569 * @hide
5570 */
5571 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5572 /**
5573 * If set, the broadcast will never go to manifest receivers in background (cached
5574 * or not running) apps, regardless of whether that would be done by default. By
5575 * default they will receive broadcasts if the broadcast has specified an
5576 * explicit component or package name.
5577 * @hide
5578 */
5579 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005580 /**
5581 * If set, this broadcast is being sent from the shell.
5582 * @hide
5583 */
5584 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005585
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005586 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005587 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5588 * will not receive broadcasts.
5589 *
5590 * <em>This flag has no effect when used by an Instant App.</em>
5591 */
5592 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5593
5594 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005595 * @hide Flags that can't be changed with PendingIntent.
5596 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005597 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5598 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5599 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005600
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005601 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005602 // ---------------------------------------------------------------------
5603 // toUri() and parseUri() options.
5604
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005605 /** @hide */
5606 @IntDef(flag = true, prefix = { "URI_" }, value = {
5607 URI_ALLOW_UNSAFE,
5608 URI_ANDROID_APP_SCHEME,
5609 URI_INTENT_SCHEME,
5610 })
5611 @Retention(RetentionPolicy.SOURCE)
5612 public @interface UriFlags {}
5613
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005614 /**
5615 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5616 * always has the "intent:" scheme. This syntax can be used when you want
5617 * to later disambiguate between URIs that are intended to describe an
5618 * Intent vs. all others that should be treated as raw URIs. When used
5619 * with {@link #parseUri}, any other scheme will result in a generic
5620 * VIEW action for that raw URI.
5621 */
5622 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005623
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005624 /**
5625 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5626 * always has the "android-app:" scheme. This is a variation of
5627 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5628 * http/https URI being delivered to a specific package name. The format
5629 * is:
5630 *
5631 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005632 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005633 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005634 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5635 * you must also include a scheme; including a path also requires both a host and a scheme.
5636 * The final #Intent; fragment can be used without a scheme, host, or path.
5637 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005638 * used with intents that have a {@link #setSelector}, since the base intent
5639 * will always have an explicit package name.</p>
5640 *
5641 * <p>Some examples of how this scheme maps to Intent objects:</p>
5642 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5643 * <colgroup align="left" />
5644 * <colgroup align="left" />
5645 * <thead>
5646 * <tr><th>URI</th> <th>Intent</th></tr>
5647 * </thead>
5648 *
5649 * <tbody>
5650 * <tr><td><code>android-app://com.example.app</code></td>
5651 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5652 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5653 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5654 * </table></td>
5655 * </tr>
5656 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5657 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5658 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5659 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5660 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5661 * </table></td>
5662 * </tr>
5663 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5664 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5665 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5666 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5667 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5668 * </table></td>
5669 * </tr>
5670 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5671 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5672 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5673 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5674 * </table></td>
5675 * </tr>
5676 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5677 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5678 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5679 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5680 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5681 * </table></td>
5682 * </tr>
5683 * <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>
5684 * <td><table border="" style="margin:0" >
5685 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5686 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5687 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5688 * </table></td>
5689 * </tr>
5690 * </tbody>
5691 * </table>
5692 */
5693 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5694
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005695 /**
5696 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5697 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5698 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5699 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5700 * generated Intent can not cause unexpected data access to happen.
5701 *
5702 * <p>If you do not trust the source of the URI being parsed, you should still do further
5703 * processing to protect yourself from it. In particular, when using it to start an
5704 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5705 * that can handle it.</p>
5706 */
5707 public static final int URI_ALLOW_UNSAFE = 1<<2;
5708
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005709 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005710
5711 private String mAction;
5712 private Uri mData;
5713 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005714 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005715 private ComponentName mComponent;
5716 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005717 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005718 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005719 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005720 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005721 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005722 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005723 /** Token to track instant app launches. Local only; do not copy cross-process. */
5724 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005725
5726 // ---------------------------------------------------------------------
5727
Makoto Onuki97f82f22017-05-31 16:20:21 -07005728 private static final int COPY_MODE_ALL = 0;
5729 private static final int COPY_MODE_FILTER = 1;
5730 private static final int COPY_MODE_HISTORY = 2;
5731
5732 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07005733 @IntDef(prefix = { "COPY_MODE_" }, value = {
5734 COPY_MODE_ALL,
5735 COPY_MODE_FILTER,
5736 COPY_MODE_HISTORY
5737 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07005738 @Retention(RetentionPolicy.SOURCE)
5739 public @interface CopyMode {}
5740
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005741 /**
5742 * Create an empty intent.
5743 */
5744 public Intent() {
5745 }
5746
5747 /**
5748 * Copy constructor.
5749 */
5750 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005751 this(o, COPY_MODE_ALL);
5752 }
5753
5754 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005755 this.mAction = o.mAction;
5756 this.mData = o.mData;
5757 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005758 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005759 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005760
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005761 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005762 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005763 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005764
5765 if (copyMode != COPY_MODE_FILTER) {
5766 this.mFlags = o.mFlags;
5767 this.mContentUserHint = o.mContentUserHint;
5768 this.mLaunchToken = o.mLaunchToken;
5769 if (o.mSourceBounds != null) {
5770 this.mSourceBounds = new Rect(o.mSourceBounds);
5771 }
5772 if (o.mSelector != null) {
5773 this.mSelector = new Intent(o.mSelector);
5774 }
5775
5776 if (copyMode != COPY_MODE_HISTORY) {
5777 if (o.mExtras != null) {
5778 this.mExtras = new Bundle(o.mExtras);
5779 }
5780 if (o.mClipData != null) {
5781 this.mClipData = new ClipData(o.mClipData);
5782 }
5783 } else {
5784 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5785 this.mExtras = Bundle.STRIPPED;
5786 }
5787
5788 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5789 // history.
5790 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005791 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005792 }
5793
5794 @Override
5795 public Object clone() {
5796 return new Intent(this);
5797 }
5798
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005799 /**
5800 * Make a clone of only the parts of the Intent that are relevant for
5801 * filter matching: the action, data, type, component, and categories.
5802 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005803 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005804 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005805 }
5806
5807 /**
5808 * Create an intent with a given action. All other fields (data, type,
5809 * class) are null. Note that the action <em>must</em> be in a
5810 * namespace because Intents are used globally in the system -- for
5811 * example the system VIEW action is android.intent.action.VIEW; an
5812 * application's custom action would be something like
5813 * com.google.app.myapp.CUSTOM_ACTION.
5814 *
5815 * @param action The Intent action, such as ACTION_VIEW.
5816 */
5817 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005818 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005819 }
5820
5821 /**
5822 * Create an intent with a given action and for a given data url. Note
5823 * that the action <em>must</em> be in a namespace because Intents are
5824 * used globally in the system -- for example the system VIEW action is
5825 * android.intent.action.VIEW; an application's custom action would be
5826 * something like com.google.app.myapp.CUSTOM_ACTION.
5827 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005828 * <p><em>Note: scheme and host name matching in the Android framework is
5829 * case-sensitive, unlike the formal RFC. As a result,
5830 * you should always ensure that you write your Uri with these elements
5831 * using lower case letters, and normalize any Uris you receive from
5832 * outside of Android to ensure the scheme and host is lower case.</em></p>
5833 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005834 * @param action The Intent action, such as ACTION_VIEW.
5835 * @param uri The Intent data URI.
5836 */
5837 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005838 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005839 mData = uri;
5840 }
5841
5842 /**
5843 * Create an intent for a specific component. All other fields (action, data,
5844 * type, class) are null, though they can be modified later with explicit
5845 * calls. This provides a convenient way to create an intent that is
5846 * intended to execute a hard-coded class name, rather than relying on the
5847 * system to find an appropriate class for you; see {@link #setComponent}
5848 * for more information on the repercussions of this.
5849 *
5850 * @param packageContext A Context of the application package implementing
5851 * this class.
5852 * @param cls The component class that is to be used for the intent.
5853 *
5854 * @see #setClass
5855 * @see #setComponent
5856 * @see #Intent(String, android.net.Uri , Context, Class)
5857 */
5858 public Intent(Context packageContext, Class<?> cls) {
5859 mComponent = new ComponentName(packageContext, cls);
5860 }
5861
5862 /**
5863 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005864 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005865 * construct the Intent and then calling {@link #setClass} to set its
5866 * class.
5867 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005868 * <p><em>Note: scheme and host name matching in the Android framework is
5869 * case-sensitive, unlike the formal RFC. As a result,
5870 * you should always ensure that you write your Uri with these elements
5871 * using lower case letters, and normalize any Uris you receive from
5872 * outside of Android to ensure the scheme and host is lower case.</em></p>
5873 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005874 * @param action The Intent action, such as ACTION_VIEW.
5875 * @param uri The Intent data URI.
5876 * @param packageContext A Context of the application package implementing
5877 * this class.
5878 * @param cls The component class that is to be used for the intent.
5879 *
5880 * @see #Intent(String, android.net.Uri)
5881 * @see #Intent(Context, Class)
5882 * @see #setClass
5883 * @see #setComponent
5884 */
5885 public Intent(String action, Uri uri,
5886 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005887 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005888 mData = uri;
5889 mComponent = new ComponentName(packageContext, cls);
5890 }
5891
5892 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005893 * Create an intent to launch the main (root) activity of a task. This
5894 * is the Intent that is started when the application's is launched from
5895 * Home. For anything else that wants to launch an application in the
5896 * same way, it is important that they use an Intent structured the same
5897 * way, and can use this function to ensure this is the case.
5898 *
5899 * <p>The returned Intent has the given Activity component as its explicit
5900 * component, {@link #ACTION_MAIN} as its action, and includes the
5901 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5902 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5903 * to do that through {@link #addFlags(int)} on the returned Intent.
5904 *
5905 * @param mainActivity The main activity component that this Intent will
5906 * launch.
5907 * @return Returns a newly created Intent that can be used to launch the
5908 * activity as a main application entry.
5909 *
5910 * @see #setClass
5911 * @see #setComponent
5912 */
5913 public static Intent makeMainActivity(ComponentName mainActivity) {
5914 Intent intent = new Intent(ACTION_MAIN);
5915 intent.setComponent(mainActivity);
5916 intent.addCategory(CATEGORY_LAUNCHER);
5917 return intent;
5918 }
5919
5920 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005921 * Make an Intent for the main activity of an application, without
5922 * specifying a specific activity to run but giving a selector to find
5923 * the activity. This results in a final Intent that is structured
5924 * the same as when the application is launched from
5925 * Home. For anything else that wants to launch an application in the
5926 * same way, it is important that they use an Intent structured the same
5927 * way, and can use this function to ensure this is the case.
5928 *
5929 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5930 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5931 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5932 * to do that through {@link #addFlags(int)} on the returned Intent.
5933 *
5934 * @param selectorAction The action name of the Intent's selector.
5935 * @param selectorCategory The name of a category to add to the Intent's
5936 * selector.
5937 * @return Returns a newly created Intent that can be used to launch the
5938 * activity as a main application entry.
5939 *
5940 * @see #setSelector(Intent)
5941 */
5942 public static Intent makeMainSelectorActivity(String selectorAction,
5943 String selectorCategory) {
5944 Intent intent = new Intent(ACTION_MAIN);
5945 intent.addCategory(CATEGORY_LAUNCHER);
5946 Intent selector = new Intent();
5947 selector.setAction(selectorAction);
5948 selector.addCategory(selectorCategory);
5949 intent.setSelector(selector);
5950 return intent;
5951 }
5952
5953 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005954 * Make an Intent that can be used to re-launch an application's task
5955 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5956 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5957 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5958 *
5959 * @param mainActivity The activity component that is the root of the
5960 * task; this is the activity that has been published in the application's
5961 * manifest as the main launcher icon.
5962 *
5963 * @return Returns a newly created Intent that can be used to relaunch the
5964 * activity's task in its root state.
5965 */
5966 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5967 Intent intent = makeMainActivity(mainActivity);
5968 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5969 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5970 return intent;
5971 }
5972
5973 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005974 * Call {@link #parseUri} with 0 flags.
5975 * @deprecated Use {@link #parseUri} instead.
5976 */
5977 @Deprecated
5978 public static Intent getIntent(String uri) throws URISyntaxException {
5979 return parseUri(uri, 0);
5980 }
Tom Taylord4a47292009-12-21 13:59:18 -08005981
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005982 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005983 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005984 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005985 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005986 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005987 *
5988 * <p>The URI given here must not be relative -- that is, it must include
5989 * the scheme and full path.
5990 *
5991 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005992 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005993 *
5994 * @return Intent The newly created Intent object.
5995 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005996 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5997 * it bad (as parsed by the Uri class) or the Intent data within the
5998 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005999 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006000 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006001 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006002 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006003 int i = 0;
6004 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006005 final boolean androidApp = uri.startsWith("android-app:");
6006
6007 // Validate intent scheme if requested.
6008 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6009 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006010 Intent intent = new Intent(ACTION_VIEW);
6011 try {
6012 intent.setData(Uri.parse(uri));
6013 } catch (IllegalArgumentException e) {
6014 throw new URISyntaxException(uri, e.getMessage());
6015 }
6016 return intent;
6017 }
6018 }
Tom Taylord4a47292009-12-21 13:59:18 -08006019
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006020 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006021 // simple case
6022 if (i == -1) {
6023 if (!androidApp) {
6024 return new Intent(ACTION_VIEW, Uri.parse(uri));
6025 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006026
6027 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006028 } else if (!uri.startsWith("#Intent;", i)) {
6029 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006030 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006031 } else {
6032 i = -1;
6033 }
6034 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006036 // new format
6037 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006038 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006039 boolean explicitAction = false;
6040 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006041
6042 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006043 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006044 String data;
6045 if (i >= 0) {
6046 data = uri.substring(0, i);
6047 i += 8; // length of "#Intent;"
6048 } else {
6049 data = uri;
6050 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006051
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006052 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006053 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006054 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006055 if (eq < 0) eq = i-1;
6056 int semi = uri.indexOf(';', i);
6057 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006058
6059 // action
6060 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006061 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006062 if (!inSelector) {
6063 explicitAction = true;
6064 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006065 }
6066
6067 // categories
6068 else if (uri.startsWith("category=", i)) {
6069 intent.addCategory(value);
6070 }
6071
6072 // type
6073 else if (uri.startsWith("type=", i)) {
6074 intent.mType = value;
6075 }
6076
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006077 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006078 else if (uri.startsWith("launchFlags=", i)) {
6079 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006080 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6081 intent.mFlags &= ~IMMUTABLE_FLAGS;
6082 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006083 }
6084
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006085 // package
6086 else if (uri.startsWith("package=", i)) {
6087 intent.mPackage = value;
6088 }
6089
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006090 // component
6091 else if (uri.startsWith("component=", i)) {
6092 intent.mComponent = ComponentName.unflattenFromString(value);
6093 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006094
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006095 // scheme
6096 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006097 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006098 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006099 } else {
6100 scheme = value;
6101 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006102 }
6103
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006104 // source bounds
6105 else if (uri.startsWith("sourceBounds=", i)) {
6106 intent.mSourceBounds = Rect.unflattenFromString(value);
6107 }
6108
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006109 // selector
6110 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6111 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006112 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006113 }
6114
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115 // extra
6116 else {
6117 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006118 // create Bundle if it doesn't already exist
6119 if (intent.mExtras == null) intent.mExtras = new Bundle();
6120 Bundle b = intent.mExtras;
6121 // add EXTRA
6122 if (uri.startsWith("S.", i)) b.putString(key, value);
6123 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6124 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6125 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6126 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6127 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6128 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6129 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6130 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6131 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6132 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006133
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134 // move to the next item
6135 i = semi + 1;
6136 }
6137
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006138 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006139 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006140 if (baseIntent.mPackage == null) {
6141 baseIntent.setSelector(intent);
6142 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006143 intent = baseIntent;
6144 }
6145
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006146 if (data != null) {
6147 if (data.startsWith("intent:")) {
6148 data = data.substring(7);
6149 if (scheme != null) {
6150 data = scheme + ':' + data;
6151 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006152 } else if (data.startsWith("android-app:")) {
6153 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6154 // Correctly formed android-app, first part is package name.
6155 int end = data.indexOf('/', 14);
6156 if (end < 0) {
6157 // All we have is a package name.
6158 intent.mPackage = data.substring(14);
6159 if (!explicitAction) {
6160 intent.setAction(ACTION_MAIN);
6161 }
6162 data = "";
6163 } else {
6164 // Target the Intent at the given package name always.
6165 String authority = null;
6166 intent.mPackage = data.substring(14, end);
6167 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006168 if ((end+1) < data.length()) {
6169 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6170 // Found a scheme, remember it.
6171 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006172 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006173 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6174 // Found a authority, remember it.
6175 authority = data.substring(end+1, newEnd);
6176 end = newEnd;
6177 }
6178 } else {
6179 // All we have is a scheme.
6180 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006181 }
6182 }
6183 if (scheme == null) {
6184 // If there was no scheme, then this just targets the package.
6185 if (!explicitAction) {
6186 intent.setAction(ACTION_MAIN);
6187 }
6188 data = "";
6189 } else if (authority == null) {
6190 data = scheme + ":";
6191 } else {
6192 data = scheme + "://" + authority + data.substring(end);
6193 }
6194 }
6195 } else {
6196 data = "";
6197 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006198 }
Tom Taylord4a47292009-12-21 13:59:18 -08006199
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006200 if (data.length() > 0) {
6201 try {
6202 intent.mData = Uri.parse(data);
6203 } catch (IllegalArgumentException e) {
6204 throw new URISyntaxException(uri, e.getMessage());
6205 }
6206 }
6207 }
Tom Taylord4a47292009-12-21 13:59:18 -08006208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006209 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006210
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006211 } catch (IndexOutOfBoundsException e) {
6212 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6213 }
6214 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006216 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006217 return getIntentOld(uri, 0);
6218 }
6219
6220 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006221 Intent intent;
6222
6223 int i = uri.lastIndexOf('#');
6224 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006225 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006226 final int intentFragmentStart = i;
6227 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006228
6229 i++;
6230
6231 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006232 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006233 i += 7;
6234 int j = uri.indexOf(')', i);
6235 action = uri.substring(i, j);
6236 i = j + 1;
6237 }
6238
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006239 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006240
6241 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006242 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006243 i += 11;
6244 int j = uri.indexOf(')', i);
6245 while (i < j) {
6246 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006247 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006248 if (i < sep) {
6249 intent.addCategory(uri.substring(i, sep));
6250 }
6251 i = sep + 1;
6252 }
6253 i = j + 1;
6254 }
6255
6256 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006257 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006258 i += 5;
6259 int j = uri.indexOf(')', i);
6260 intent.mType = uri.substring(i, j);
6261 i = j + 1;
6262 }
6263
6264 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006265 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006266 i += 12;
6267 int j = uri.indexOf(')', i);
6268 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006269 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6270 intent.mFlags &= ~IMMUTABLE_FLAGS;
6271 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006272 i = j + 1;
6273 }
6274
6275 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006276 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006277 i += 10;
6278 int j = uri.indexOf(')', i);
6279 int sep = uri.indexOf('!', i);
6280 if (sep >= 0 && sep < j) {
6281 String pkg = uri.substring(i, sep);
6282 String cls = uri.substring(sep + 1, j);
6283 intent.mComponent = new ComponentName(pkg, cls);
6284 }
6285 i = j + 1;
6286 }
6287
6288 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006289 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006290 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006291
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006292 final int closeParen = uri.indexOf(')', i);
6293 if (closeParen == -1) throw new URISyntaxException(uri,
6294 "EXTRA missing trailing ')'", i);
6295
6296 while (i < closeParen) {
6297 // fetch the key value
6298 int j = uri.indexOf('=', i);
6299 if (j <= i + 1 || i >= closeParen) {
6300 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6301 }
6302 char type = uri.charAt(i);
6303 i++;
6304 String key = uri.substring(i, j);
6305 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006306
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006307 // get type-value
6308 j = uri.indexOf('!', i);
6309 if (j == -1 || j >= closeParen) j = closeParen;
6310 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6311 String value = uri.substring(i, j);
6312 i = j;
6313
6314 // create Bundle if it doesn't already exist
6315 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006316
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006317 // add item to bundle
6318 try {
6319 switch (type) {
6320 case 'S':
6321 intent.mExtras.putString(key, Uri.decode(value));
6322 break;
6323 case 'B':
6324 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6325 break;
6326 case 'b':
6327 intent.mExtras.putByte(key, Byte.parseByte(value));
6328 break;
6329 case 'c':
6330 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6331 break;
6332 case 'd':
6333 intent.mExtras.putDouble(key, Double.parseDouble(value));
6334 break;
6335 case 'f':
6336 intent.mExtras.putFloat(key, Float.parseFloat(value));
6337 break;
6338 case 'i':
6339 intent.mExtras.putInt(key, Integer.parseInt(value));
6340 break;
6341 case 'l':
6342 intent.mExtras.putLong(key, Long.parseLong(value));
6343 break;
6344 case 's':
6345 intent.mExtras.putShort(key, Short.parseShort(value));
6346 break;
6347 default:
6348 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6349 }
6350 } catch (NumberFormatException e) {
6351 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6352 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006353
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006354 char ch = uri.charAt(i);
6355 if (ch == ')') break;
6356 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6357 i++;
6358 }
6359 }
6360
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006361 if (isIntentFragment) {
6362 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6363 } else {
6364 intent.mData = Uri.parse(uri);
6365 }
Tom Taylord4a47292009-12-21 13:59:18 -08006366
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006367 if (intent.mAction == null) {
6368 // By default, if no action is specified, then use VIEW.
6369 intent.mAction = ACTION_VIEW;
6370 }
6371
6372 } else {
6373 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6374 }
6375
6376 return intent;
6377 }
6378
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006379 /** @hide */
6380 public interface CommandOptionHandler {
6381 boolean handleOption(String opt, ShellCommand cmd);
6382 }
6383
6384 /** @hide */
6385 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6386 throws URISyntaxException {
6387 Intent intent = new Intent();
6388 Intent baseIntent = intent;
6389 boolean hasIntentInfo = false;
6390
6391 Uri data = null;
6392 String type = null;
6393
6394 String opt;
6395 while ((opt=cmd.getNextOption()) != null) {
6396 switch (opt) {
6397 case "-a":
6398 intent.setAction(cmd.getNextArgRequired());
6399 if (intent == baseIntent) {
6400 hasIntentInfo = true;
6401 }
6402 break;
6403 case "-d":
6404 data = Uri.parse(cmd.getNextArgRequired());
6405 if (intent == baseIntent) {
6406 hasIntentInfo = true;
6407 }
6408 break;
6409 case "-t":
6410 type = cmd.getNextArgRequired();
6411 if (intent == baseIntent) {
6412 hasIntentInfo = true;
6413 }
6414 break;
6415 case "-c":
6416 intent.addCategory(cmd.getNextArgRequired());
6417 if (intent == baseIntent) {
6418 hasIntentInfo = true;
6419 }
6420 break;
6421 case "-e":
6422 case "--es": {
6423 String key = cmd.getNextArgRequired();
6424 String value = cmd.getNextArgRequired();
6425 intent.putExtra(key, value);
6426 }
6427 break;
6428 case "--esn": {
6429 String key = cmd.getNextArgRequired();
6430 intent.putExtra(key, (String) null);
6431 }
6432 break;
6433 case "--ei": {
6434 String key = cmd.getNextArgRequired();
6435 String value = cmd.getNextArgRequired();
6436 intent.putExtra(key, Integer.decode(value));
6437 }
6438 break;
6439 case "--eu": {
6440 String key = cmd.getNextArgRequired();
6441 String value = cmd.getNextArgRequired();
6442 intent.putExtra(key, Uri.parse(value));
6443 }
6444 break;
6445 case "--ecn": {
6446 String key = cmd.getNextArgRequired();
6447 String value = cmd.getNextArgRequired();
6448 ComponentName cn = ComponentName.unflattenFromString(value);
6449 if (cn == null)
6450 throw new IllegalArgumentException("Bad component name: " + value);
6451 intent.putExtra(key, cn);
6452 }
6453 break;
6454 case "--eia": {
6455 String key = cmd.getNextArgRequired();
6456 String value = cmd.getNextArgRequired();
6457 String[] strings = value.split(",");
6458 int[] list = new int[strings.length];
6459 for (int i = 0; i < strings.length; i++) {
6460 list[i] = Integer.decode(strings[i]);
6461 }
6462 intent.putExtra(key, list);
6463 }
6464 break;
6465 case "--eial": {
6466 String key = cmd.getNextArgRequired();
6467 String value = cmd.getNextArgRequired();
6468 String[] strings = value.split(",");
6469 ArrayList<Integer> list = new ArrayList<>(strings.length);
6470 for (int i = 0; i < strings.length; i++) {
6471 list.add(Integer.decode(strings[i]));
6472 }
6473 intent.putExtra(key, list);
6474 }
6475 break;
6476 case "--el": {
6477 String key = cmd.getNextArgRequired();
6478 String value = cmd.getNextArgRequired();
6479 intent.putExtra(key, Long.valueOf(value));
6480 }
6481 break;
6482 case "--ela": {
6483 String key = cmd.getNextArgRequired();
6484 String value = cmd.getNextArgRequired();
6485 String[] strings = value.split(",");
6486 long[] list = new long[strings.length];
6487 for (int i = 0; i < strings.length; i++) {
6488 list[i] = Long.valueOf(strings[i]);
6489 }
6490 intent.putExtra(key, list);
6491 hasIntentInfo = true;
6492 }
6493 break;
6494 case "--elal": {
6495 String key = cmd.getNextArgRequired();
6496 String value = cmd.getNextArgRequired();
6497 String[] strings = value.split(",");
6498 ArrayList<Long> list = new ArrayList<>(strings.length);
6499 for (int i = 0; i < strings.length; i++) {
6500 list.add(Long.valueOf(strings[i]));
6501 }
6502 intent.putExtra(key, list);
6503 hasIntentInfo = true;
6504 }
6505 break;
6506 case "--ef": {
6507 String key = cmd.getNextArgRequired();
6508 String value = cmd.getNextArgRequired();
6509 intent.putExtra(key, Float.valueOf(value));
6510 hasIntentInfo = true;
6511 }
6512 break;
6513 case "--efa": {
6514 String key = cmd.getNextArgRequired();
6515 String value = cmd.getNextArgRequired();
6516 String[] strings = value.split(",");
6517 float[] list = new float[strings.length];
6518 for (int i = 0; i < strings.length; i++) {
6519 list[i] = Float.valueOf(strings[i]);
6520 }
6521 intent.putExtra(key, list);
6522 hasIntentInfo = true;
6523 }
6524 break;
6525 case "--efal": {
6526 String key = cmd.getNextArgRequired();
6527 String value = cmd.getNextArgRequired();
6528 String[] strings = value.split(",");
6529 ArrayList<Float> list = new ArrayList<>(strings.length);
6530 for (int i = 0; i < strings.length; i++) {
6531 list.add(Float.valueOf(strings[i]));
6532 }
6533 intent.putExtra(key, list);
6534 hasIntentInfo = true;
6535 }
6536 break;
6537 case "--esa": {
6538 String key = cmd.getNextArgRequired();
6539 String value = cmd.getNextArgRequired();
6540 // Split on commas unless they are preceeded by an escape.
6541 // The escape character must be escaped for the string and
6542 // again for the regex, thus four escape characters become one.
6543 String[] strings = value.split("(?<!\\\\),");
6544 intent.putExtra(key, strings);
6545 hasIntentInfo = true;
6546 }
6547 break;
6548 case "--esal": {
6549 String key = cmd.getNextArgRequired();
6550 String value = cmd.getNextArgRequired();
6551 // Split on commas unless they are preceeded by an escape.
6552 // The escape character must be escaped for the string and
6553 // again for the regex, thus four escape characters become one.
6554 String[] strings = value.split("(?<!\\\\),");
6555 ArrayList<String> list = new ArrayList<>(strings.length);
6556 for (int i = 0; i < strings.length; i++) {
6557 list.add(strings[i]);
6558 }
6559 intent.putExtra(key, list);
6560 hasIntentInfo = true;
6561 }
6562 break;
6563 case "--ez": {
6564 String key = cmd.getNextArgRequired();
6565 String value = cmd.getNextArgRequired().toLowerCase();
6566 // Boolean.valueOf() results in false for anything that is not "true", which is
6567 // error-prone in shell commands
6568 boolean arg;
6569 if ("true".equals(value) || "t".equals(value)) {
6570 arg = true;
6571 } else if ("false".equals(value) || "f".equals(value)) {
6572 arg = false;
6573 } else {
6574 try {
6575 arg = Integer.decode(value) != 0;
6576 } catch (NumberFormatException ex) {
6577 throw new IllegalArgumentException("Invalid boolean value: " + value);
6578 }
6579 }
6580
6581 intent.putExtra(key, arg);
6582 }
6583 break;
6584 case "-n": {
6585 String str = cmd.getNextArgRequired();
6586 ComponentName cn = ComponentName.unflattenFromString(str);
6587 if (cn == null)
6588 throw new IllegalArgumentException("Bad component name: " + str);
6589 intent.setComponent(cn);
6590 if (intent == baseIntent) {
6591 hasIntentInfo = true;
6592 }
6593 }
6594 break;
6595 case "-p": {
6596 String str = cmd.getNextArgRequired();
6597 intent.setPackage(str);
6598 if (intent == baseIntent) {
6599 hasIntentInfo = true;
6600 }
6601 }
6602 break;
6603 case "-f":
6604 String str = cmd.getNextArgRequired();
6605 intent.setFlags(Integer.decode(str).intValue());
6606 break;
6607 case "--grant-read-uri-permission":
6608 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6609 break;
6610 case "--grant-write-uri-permission":
6611 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6612 break;
6613 case "--grant-persistable-uri-permission":
6614 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6615 break;
6616 case "--grant-prefix-uri-permission":
6617 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6618 break;
6619 case "--exclude-stopped-packages":
6620 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6621 break;
6622 case "--include-stopped-packages":
6623 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6624 break;
6625 case "--debug-log-resolution":
6626 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6627 break;
6628 case "--activity-brought-to-front":
6629 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6630 break;
6631 case "--activity-clear-top":
6632 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6633 break;
6634 case "--activity-clear-when-task-reset":
6635 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6636 break;
6637 case "--activity-exclude-from-recents":
6638 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6639 break;
6640 case "--activity-launched-from-history":
6641 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6642 break;
6643 case "--activity-multiple-task":
6644 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6645 break;
6646 case "--activity-no-animation":
6647 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6648 break;
6649 case "--activity-no-history":
6650 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6651 break;
6652 case "--activity-no-user-action":
6653 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6654 break;
6655 case "--activity-previous-is-top":
6656 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6657 break;
6658 case "--activity-reorder-to-front":
6659 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6660 break;
6661 case "--activity-reset-task-if-needed":
6662 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6663 break;
6664 case "--activity-single-top":
6665 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6666 break;
6667 case "--activity-clear-task":
6668 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6669 break;
6670 case "--activity-task-on-home":
6671 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6672 break;
6673 case "--receiver-registered-only":
6674 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6675 break;
6676 case "--receiver-replace-pending":
6677 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6678 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006679 case "--receiver-foreground":
6680 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6681 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006682 case "--receiver-no-abort":
6683 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6684 break;
6685 case "--receiver-include-background":
6686 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6687 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006688 case "--selector":
6689 intent.setDataAndType(data, type);
6690 intent = new Intent();
6691 break;
6692 default:
6693 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6694 // Okay, caller handled this option.
6695 } else {
6696 throw new IllegalArgumentException("Unknown option: " + opt);
6697 }
6698 break;
6699 }
6700 }
6701 intent.setDataAndType(data, type);
6702
6703 final boolean hasSelector = intent != baseIntent;
6704 if (hasSelector) {
6705 // A selector was specified; fix up.
6706 baseIntent.setSelector(intent);
6707 intent = baseIntent;
6708 }
6709
6710 String arg = cmd.getNextArg();
6711 baseIntent = null;
6712 if (arg == null) {
6713 if (hasSelector) {
6714 // If a selector has been specified, and no arguments
6715 // have been supplied for the main Intent, then we can
6716 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6717 // need to have a component name specified yet, the
6718 // selector will take care of that.
6719 baseIntent = new Intent(Intent.ACTION_MAIN);
6720 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6721 }
6722 } else if (arg.indexOf(':') >= 0) {
6723 // The argument is a URI. Fully parse it, and use that result
6724 // to fill in any data not specified so far.
6725 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6726 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6727 } else if (arg.indexOf('/') >= 0) {
6728 // The argument is a component name. Build an Intent to launch
6729 // it.
6730 baseIntent = new Intent(Intent.ACTION_MAIN);
6731 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6732 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6733 } else {
6734 // Assume the argument is a package name.
6735 baseIntent = new Intent(Intent.ACTION_MAIN);
6736 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6737 baseIntent.setPackage(arg);
6738 }
6739 if (baseIntent != null) {
6740 Bundle extras = intent.getExtras();
6741 intent.replaceExtras((Bundle)null);
6742 Bundle uriExtras = baseIntent.getExtras();
6743 baseIntent.replaceExtras((Bundle)null);
6744 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6745 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6746 for (String c : cats) {
6747 baseIntent.removeCategory(c);
6748 }
6749 }
6750 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6751 if (extras == null) {
6752 extras = uriExtras;
6753 } else if (uriExtras != null) {
6754 uriExtras.putAll(extras);
6755 extras = uriExtras;
6756 }
6757 intent.replaceExtras(extras);
6758 hasIntentInfo = true;
6759 }
6760
6761 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6762 return intent;
6763 }
6764
6765 /** @hide */
6766 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6767 final String[] lines = new String[] {
6768 "<INTENT> specifications include these flags and arguments:",
6769 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6770 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6771 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6772 " [--esn <EXTRA_KEY> ...]",
6773 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6774 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6775 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6776 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6777 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6778 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6779 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6780 " (mutiple extras passed as Integer[])",
6781 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6782 " (mutiple extras passed as List<Integer>)",
6783 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6784 " (mutiple extras passed as Long[])",
6785 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6786 " (mutiple extras passed as List<Long>)",
6787 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6788 " (mutiple extras passed as Float[])",
6789 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6790 " (mutiple extras passed as List<Float>)",
6791 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6792 " (mutiple extras passed as String[]; to embed a comma into a string,",
6793 " escape it using \"\\,\")",
6794 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6795 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6796 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006797 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006798 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6799 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6800 " [--debug-log-resolution] [--exclude-stopped-packages]",
6801 " [--include-stopped-packages]",
6802 " [--activity-brought-to-front] [--activity-clear-top]",
6803 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6804 " [--activity-launched-from-history] [--activity-multiple-task]",
6805 " [--activity-no-animation] [--activity-no-history]",
6806 " [--activity-no-user-action] [--activity-previous-is-top]",
6807 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6808 " [--activity-single-top] [--activity-clear-task]",
6809 " [--activity-task-on-home]",
6810 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006811 " [--receiver-foreground] [--receiver-no-abort]",
6812 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006813 " [--selector]",
6814 " [<URI> | <PACKAGE> | <COMPONENT>]"
6815 };
6816 for (String line : lines) {
6817 pw.print(prefix);
6818 pw.println(line);
6819 }
6820 }
6821
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006822 /**
6823 * Retrieve the general action to be performed, such as
6824 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6825 * the information in the intent should be interpreted -- most importantly,
6826 * what to do with the data returned by {@link #getData}.
6827 *
6828 * @return The action of this intent or null if none is specified.
6829 *
6830 * @see #setAction
6831 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006832 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006833 return mAction;
6834 }
6835
6836 /**
6837 * Retrieve data this intent is operating on. This URI specifies the name
6838 * of the data; often it uses the content: scheme, specifying data in a
6839 * content provider. Other schemes may be handled by specific activities,
6840 * such as http: by the web browser.
6841 *
6842 * @return The URI of the data this intent is targeting or null.
6843 *
6844 * @see #getScheme
6845 * @see #setData
6846 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006847 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006848 return mData;
6849 }
6850
6851 /**
6852 * The same as {@link #getData()}, but returns the URI as an encoded
6853 * String.
6854 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006855 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006856 return mData != null ? mData.toString() : null;
6857 }
6858
6859 /**
6860 * Return the scheme portion of the intent's data. If the data is null or
6861 * does not include a scheme, null is returned. Otherwise, the scheme
6862 * prefix without the final ':' is returned, i.e. "http".
6863 *
6864 * <p>This is the same as calling getData().getScheme() (and checking for
6865 * null data).
6866 *
6867 * @return The scheme of this intent.
6868 *
6869 * @see #getData
6870 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006871 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006872 return mData != null ? mData.getScheme() : null;
6873 }
6874
6875 /**
6876 * Retrieve any explicit MIME type included in the intent. This is usually
6877 * null, as the type is determined by the intent data.
6878 *
6879 * @return If a type was manually set, it is returned; else null is
6880 * returned.
6881 *
6882 * @see #resolveType(ContentResolver)
6883 * @see #setType
6884 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006885 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006886 return mType;
6887 }
6888
6889 /**
6890 * Return the MIME data type of this intent. If the type field is
6891 * explicitly set, that is simply returned. Otherwise, if the data is set,
6892 * the type of that data is returned. If neither fields are set, a null is
6893 * returned.
6894 *
6895 * @return The MIME type of this intent.
6896 *
6897 * @see #getType
6898 * @see #resolveType(ContentResolver)
6899 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006900 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006901 return resolveType(context.getContentResolver());
6902 }
6903
6904 /**
6905 * Return the MIME data type of this intent. If the type field is
6906 * explicitly set, that is simply returned. Otherwise, if the data is set,
6907 * the type of that data is returned. If neither fields are set, a null is
6908 * returned.
6909 *
6910 * @param resolver A ContentResolver that can be used to determine the MIME
6911 * type of the intent's data.
6912 *
6913 * @return The MIME type of this intent.
6914 *
6915 * @see #getType
6916 * @see #resolveType(Context)
6917 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006918 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006919 if (mType != null) {
6920 return mType;
6921 }
6922 if (mData != null) {
6923 if ("content".equals(mData.getScheme())) {
6924 return resolver.getType(mData);
6925 }
6926 }
6927 return null;
6928 }
6929
6930 /**
6931 * Return the MIME data type of this intent, only if it will be needed for
6932 * intent resolution. This is not generally useful for application code;
6933 * it is used by the frameworks for communicating with back-end system
6934 * services.
6935 *
6936 * @param resolver A ContentResolver that can be used to determine the MIME
6937 * type of the intent's data.
6938 *
6939 * @return The MIME type of this intent, or null if it is unknown or not
6940 * needed.
6941 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006942 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006943 if (mComponent != null) {
6944 return mType;
6945 }
6946 return resolveType(resolver);
6947 }
6948
6949 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006950 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 *
6952 * @param category The category to check.
6953 *
6954 * @return boolean True if the intent contains the category, else false.
6955 *
6956 * @see #getCategories
6957 * @see #addCategory
6958 */
6959 public boolean hasCategory(String category) {
6960 return mCategories != null && mCategories.contains(category);
6961 }
6962
6963 /**
6964 * Return the set of all categories in the intent. If there are no categories,
6965 * returns NULL.
6966 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006967 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006968 *
6969 * @see #hasCategory
6970 * @see #addCategory
6971 */
6972 public Set<String> getCategories() {
6973 return mCategories;
6974 }
6975
6976 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006977 * Return the specific selector associated with this Intent. If there is
6978 * none, returns null. See {@link #setSelector} for more information.
6979 *
6980 * @see #setSelector
6981 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006982 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006983 return mSelector;
6984 }
6985
6986 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006987 * Return the {@link ClipData} associated with this Intent. If there is
6988 * none, returns null. See {@link #setClipData} for more information.
6989 *
John Spurlock125d1332013-11-25 11:58:37 -05006990 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006991 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006992 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006993 return mClipData;
6994 }
6995
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006996 /** @hide */
6997 public int getContentUserHint() {
6998 return mContentUserHint;
6999 }
7000
Todd Kennedyb3b431302017-03-20 16:05:48 -07007001 /** @hide */
7002 public String getLaunchToken() {
7003 return mLaunchToken;
7004 }
7005
7006 /** @hide */
7007 public void setLaunchToken(String launchToken) {
7008 mLaunchToken = launchToken;
7009 }
7010
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007012 * Sets the ClassLoader that will be used when unmarshalling
7013 * any Parcelable values from the extras of this Intent.
7014 *
7015 * @param loader a ClassLoader, or null to use the default loader
7016 * at the time of unmarshalling.
7017 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007018 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007019 if (mExtras != null) {
7020 mExtras.setClassLoader(loader);
7021 }
7022 }
7023
7024 /**
7025 * Returns true if an extra value is associated with the given name.
7026 * @param name the extra's name
7027 * @return true if the given extra is present.
7028 */
7029 public boolean hasExtra(String name) {
7030 return mExtras != null && mExtras.containsKey(name);
7031 }
7032
7033 /**
7034 * Returns true if the Intent's extras contain a parcelled file descriptor.
7035 * @return true if the Intent contains a parcelled file descriptor.
7036 */
7037 public boolean hasFileDescriptors() {
7038 return mExtras != null && mExtras.hasFileDescriptors();
7039 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007040
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007041 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007042 public void setAllowFds(boolean allowFds) {
7043 if (mExtras != null) {
7044 mExtras.setAllowFds(allowFds);
7045 }
7046 }
7047
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007048 /** {@hide} */
7049 public void setDefusable(boolean defusable) {
7050 if (mExtras != null) {
7051 mExtras.setDefusable(defusable);
7052 }
7053 }
7054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007055 /**
7056 * Retrieve extended data from the intent.
7057 *
7058 * @param name The name of the desired item.
7059 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007060 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007061 * or null if none was found.
7062 *
7063 * @deprecated
7064 * @hide
7065 */
7066 @Deprecated
7067 public Object getExtra(String name) {
7068 return getExtra(name, null);
7069 }
7070
7071 /**
7072 * Retrieve extended data from the intent.
7073 *
7074 * @param name The name of the desired item.
7075 * @param defaultValue the value to be returned if no value of the desired
7076 * type is stored with the given name.
7077 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007078 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007079 * or the default value if none was found.
7080 *
7081 * @see #putExtra(String, boolean)
7082 */
7083 public boolean getBooleanExtra(String name, boolean defaultValue) {
7084 return mExtras == null ? defaultValue :
7085 mExtras.getBoolean(name, defaultValue);
7086 }
7087
7088 /**
7089 * Retrieve extended data from the intent.
7090 *
7091 * @param name The name of the desired item.
7092 * @param defaultValue the value to be returned if no value of the desired
7093 * type is stored with the given name.
7094 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007095 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007096 * or the default value if none was found.
7097 *
7098 * @see #putExtra(String, byte)
7099 */
7100 public byte getByteExtra(String name, byte defaultValue) {
7101 return mExtras == null ? defaultValue :
7102 mExtras.getByte(name, defaultValue);
7103 }
7104
7105 /**
7106 * Retrieve extended data from the intent.
7107 *
7108 * @param name The name of the desired item.
7109 * @param defaultValue the value to be returned if no value of the desired
7110 * type is stored with the given name.
7111 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007112 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007113 * or the default value if none was found.
7114 *
7115 * @see #putExtra(String, short)
7116 */
7117 public short getShortExtra(String name, short defaultValue) {
7118 return mExtras == null ? defaultValue :
7119 mExtras.getShort(name, defaultValue);
7120 }
7121
7122 /**
7123 * Retrieve extended data from the intent.
7124 *
7125 * @param name The name of the desired item.
7126 * @param defaultValue the value to be returned if no value of the desired
7127 * type is stored with the given name.
7128 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007129 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007130 * or the default value if none was found.
7131 *
7132 * @see #putExtra(String, char)
7133 */
7134 public char getCharExtra(String name, char defaultValue) {
7135 return mExtras == null ? defaultValue :
7136 mExtras.getChar(name, defaultValue);
7137 }
7138
7139 /**
7140 * Retrieve extended data from the intent.
7141 *
7142 * @param name The name of the desired item.
7143 * @param defaultValue the value to be returned if no value of the desired
7144 * type is stored with the given name.
7145 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007146 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007147 * or the default value if none was found.
7148 *
7149 * @see #putExtra(String, int)
7150 */
7151 public int getIntExtra(String name, int defaultValue) {
7152 return mExtras == null ? defaultValue :
7153 mExtras.getInt(name, defaultValue);
7154 }
7155
7156 /**
7157 * Retrieve extended data from the intent.
7158 *
7159 * @param name The name of the desired item.
7160 * @param defaultValue the value to be returned if no value of the desired
7161 * type is stored with the given name.
7162 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007163 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 * or the default value if none was found.
7165 *
7166 * @see #putExtra(String, long)
7167 */
7168 public long getLongExtra(String name, long defaultValue) {
7169 return mExtras == null ? defaultValue :
7170 mExtras.getLong(name, defaultValue);
7171 }
7172
7173 /**
7174 * Retrieve extended data from the intent.
7175 *
7176 * @param name The name of the desired item.
7177 * @param defaultValue the value to be returned if no value of the desired
7178 * type is stored with the given name.
7179 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007180 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007181 * or the default value if no such item is present
7182 *
7183 * @see #putExtra(String, float)
7184 */
7185 public float getFloatExtra(String name, float defaultValue) {
7186 return mExtras == null ? defaultValue :
7187 mExtras.getFloat(name, defaultValue);
7188 }
7189
7190 /**
7191 * Retrieve extended data from the intent.
7192 *
7193 * @param name The name of the desired item.
7194 * @param defaultValue the value to be returned if no value of the desired
7195 * type is stored with the given name.
7196 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007197 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007198 * or the default value if none was found.
7199 *
7200 * @see #putExtra(String, double)
7201 */
7202 public double getDoubleExtra(String name, double defaultValue) {
7203 return mExtras == null ? defaultValue :
7204 mExtras.getDouble(name, defaultValue);
7205 }
7206
7207 /**
7208 * Retrieve extended data from the intent.
7209 *
7210 * @param name The name of the desired item.
7211 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007212 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007213 * or null if no String value was found.
7214 *
7215 * @see #putExtra(String, String)
7216 */
7217 public String getStringExtra(String name) {
7218 return mExtras == null ? null : mExtras.getString(name);
7219 }
7220
7221 /**
7222 * Retrieve extended data from the intent.
7223 *
7224 * @param name The name of the desired item.
7225 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007226 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007227 * or null if no CharSequence value was found.
7228 *
7229 * @see #putExtra(String, CharSequence)
7230 */
7231 public CharSequence getCharSequenceExtra(String name) {
7232 return mExtras == null ? null : mExtras.getCharSequence(name);
7233 }
7234
7235 /**
7236 * Retrieve extended data from the intent.
7237 *
7238 * @param name The name of the desired item.
7239 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007240 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007241 * or null if no Parcelable value was found.
7242 *
7243 * @see #putExtra(String, Parcelable)
7244 */
7245 public <T extends Parcelable> T getParcelableExtra(String name) {
7246 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7247 }
7248
7249 /**
7250 * Retrieve extended data from the intent.
7251 *
7252 * @param name The name of the desired item.
7253 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007254 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007255 * or null if no Parcelable[] value was found.
7256 *
7257 * @see #putExtra(String, Parcelable[])
7258 */
7259 public Parcelable[] getParcelableArrayExtra(String name) {
7260 return mExtras == null ? null : mExtras.getParcelableArray(name);
7261 }
7262
7263 /**
7264 * Retrieve extended data from the intent.
7265 *
7266 * @param name The name of the desired item.
7267 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007268 * @return the value of an item previously added with
7269 * putParcelableArrayListExtra(), or null if no
7270 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007271 *
7272 * @see #putParcelableArrayListExtra(String, ArrayList)
7273 */
7274 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7275 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7276 }
7277
7278 /**
7279 * Retrieve extended data from the intent.
7280 *
7281 * @param name The name of the desired item.
7282 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007283 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007284 * or null if no Serializable value was found.
7285 *
7286 * @see #putExtra(String, Serializable)
7287 */
7288 public Serializable getSerializableExtra(String name) {
7289 return mExtras == null ? null : mExtras.getSerializable(name);
7290 }
7291
7292 /**
7293 * Retrieve extended data from the intent.
7294 *
7295 * @param name The name of the desired item.
7296 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007297 * @return the value of an item previously added with
7298 * putIntegerArrayListExtra(), or null if no
7299 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007300 *
7301 * @see #putIntegerArrayListExtra(String, ArrayList)
7302 */
7303 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7304 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7305 }
7306
7307 /**
7308 * Retrieve extended data from the intent.
7309 *
7310 * @param name The name of the desired item.
7311 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007312 * @return the value of an item previously added with
7313 * putStringArrayListExtra(), or null if no
7314 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007315 *
7316 * @see #putStringArrayListExtra(String, ArrayList)
7317 */
7318 public ArrayList<String> getStringArrayListExtra(String name) {
7319 return mExtras == null ? null : mExtras.getStringArrayList(name);
7320 }
7321
7322 /**
7323 * Retrieve extended data from the intent.
7324 *
7325 * @param name The name of the desired item.
7326 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007327 * @return the value of an item previously added with
7328 * putCharSequenceArrayListExtra, or null if no
7329 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007330 *
7331 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7332 */
7333 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7334 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7335 }
7336
7337 /**
7338 * Retrieve extended data from the intent.
7339 *
7340 * @param name The name of the desired item.
7341 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007342 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007343 * or null if no boolean array value was found.
7344 *
7345 * @see #putExtra(String, boolean[])
7346 */
7347 public boolean[] getBooleanArrayExtra(String name) {
7348 return mExtras == null ? null : mExtras.getBooleanArray(name);
7349 }
7350
7351 /**
7352 * Retrieve extended data from the intent.
7353 *
7354 * @param name The name of the desired item.
7355 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007356 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007357 * or null if no byte array value was found.
7358 *
7359 * @see #putExtra(String, byte[])
7360 */
7361 public byte[] getByteArrayExtra(String name) {
7362 return mExtras == null ? null : mExtras.getByteArray(name);
7363 }
7364
7365 /**
7366 * Retrieve extended data from the intent.
7367 *
7368 * @param name The name of the desired item.
7369 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007370 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007371 * or null if no short array value was found.
7372 *
7373 * @see #putExtra(String, short[])
7374 */
7375 public short[] getShortArrayExtra(String name) {
7376 return mExtras == null ? null : mExtras.getShortArray(name);
7377 }
7378
7379 /**
7380 * Retrieve extended data from the intent.
7381 *
7382 * @param name The name of the desired item.
7383 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007384 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007385 * or null if no char array value was found.
7386 *
7387 * @see #putExtra(String, char[])
7388 */
7389 public char[] getCharArrayExtra(String name) {
7390 return mExtras == null ? null : mExtras.getCharArray(name);
7391 }
7392
7393 /**
7394 * Retrieve extended data from the intent.
7395 *
7396 * @param name The name of the desired item.
7397 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007398 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007399 * or null if no int array value was found.
7400 *
7401 * @see #putExtra(String, int[])
7402 */
7403 public int[] getIntArrayExtra(String name) {
7404 return mExtras == null ? null : mExtras.getIntArray(name);
7405 }
7406
7407 /**
7408 * Retrieve extended data from the intent.
7409 *
7410 * @param name The name of the desired item.
7411 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007412 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007413 * or null if no long array value was found.
7414 *
7415 * @see #putExtra(String, long[])
7416 */
7417 public long[] getLongArrayExtra(String name) {
7418 return mExtras == null ? null : mExtras.getLongArray(name);
7419 }
7420
7421 /**
7422 * Retrieve extended data from the intent.
7423 *
7424 * @param name The name of the desired item.
7425 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007426 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007427 * or null if no float array value was found.
7428 *
7429 * @see #putExtra(String, float[])
7430 */
7431 public float[] getFloatArrayExtra(String name) {
7432 return mExtras == null ? null : mExtras.getFloatArray(name);
7433 }
7434
7435 /**
7436 * Retrieve extended data from the intent.
7437 *
7438 * @param name The name of the desired item.
7439 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007440 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007441 * or null if no double array value was found.
7442 *
7443 * @see #putExtra(String, double[])
7444 */
7445 public double[] getDoubleArrayExtra(String name) {
7446 return mExtras == null ? null : mExtras.getDoubleArray(name);
7447 }
7448
7449 /**
7450 * Retrieve extended data from the intent.
7451 *
7452 * @param name The name of the desired item.
7453 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007454 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007455 * or null if no String array value was found.
7456 *
7457 * @see #putExtra(String, String[])
7458 */
7459 public String[] getStringArrayExtra(String name) {
7460 return mExtras == null ? null : mExtras.getStringArray(name);
7461 }
7462
7463 /**
7464 * Retrieve extended data from the intent.
7465 *
7466 * @param name The name of the desired item.
7467 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007468 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007469 * or null if no CharSequence array value was found.
7470 *
7471 * @see #putExtra(String, CharSequence[])
7472 */
7473 public CharSequence[] getCharSequenceArrayExtra(String name) {
7474 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7475 }
7476
7477 /**
7478 * Retrieve extended data from the intent.
7479 *
7480 * @param name The name of the desired item.
7481 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007482 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007483 * or null if no Bundle value was found.
7484 *
7485 * @see #putExtra(String, Bundle)
7486 */
7487 public Bundle getBundleExtra(String name) {
7488 return mExtras == null ? null : mExtras.getBundle(name);
7489 }
7490
7491 /**
7492 * Retrieve extended data from the intent.
7493 *
7494 * @param name The name of the desired item.
7495 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007496 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007497 * or null if no IBinder value was found.
7498 *
7499 * @see #putExtra(String, IBinder)
7500 *
7501 * @deprecated
7502 * @hide
7503 */
7504 @Deprecated
7505 public IBinder getIBinderExtra(String name) {
7506 return mExtras == null ? null : mExtras.getIBinder(name);
7507 }
7508
7509 /**
7510 * Retrieve extended data from the intent.
7511 *
7512 * @param name The name of the desired item.
7513 * @param defaultValue The default value to return in case no item is
7514 * associated with the key 'name'
7515 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007516 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007517 * or defaultValue if none was found.
7518 *
7519 * @see #putExtra
7520 *
7521 * @deprecated
7522 * @hide
7523 */
7524 @Deprecated
7525 public Object getExtra(String name, Object defaultValue) {
7526 Object result = defaultValue;
7527 if (mExtras != null) {
7528 Object result2 = mExtras.get(name);
7529 if (result2 != null) {
7530 result = result2;
7531 }
7532 }
7533
7534 return result;
7535 }
7536
7537 /**
7538 * Retrieves a map of extended data from the intent.
7539 *
7540 * @return the map of all extras previously added with putExtra(),
7541 * or null if none have been added.
7542 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007543 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007544 return (mExtras != null)
7545 ? new Bundle(mExtras)
7546 : null;
7547 }
7548
7549 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007550 * Filter extras to only basic types.
7551 * @hide
7552 */
7553 public void removeUnsafeExtras() {
7554 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007555 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007556 }
7557 }
7558
7559 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007560 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7561 * return itself as-is.
7562 * @hide
7563 */
7564 public boolean canStripForHistory() {
7565 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7566 }
7567
7568 /**
7569 * Call it when the system needs to keep an intent for logging purposes to remove fields
7570 * that are not needed for logging.
7571 * @hide
7572 */
7573 public Intent maybeStripForHistory() {
7574 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7575
7576 if (!canStripForHistory()) {
7577 return this;
7578 }
7579 return new Intent(this, COPY_MODE_HISTORY);
7580 }
7581
7582 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007583 * Retrieve any special flags associated with this intent. You will
7584 * normally just set them with {@link #setFlags} and let the system
7585 * take the appropriate action with them.
7586 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007587 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007588 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007589 * @see #addFlags
7590 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007591 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007592 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007593 return mFlags;
7594 }
7595
Dianne Hackborne7f97212011-02-24 14:40:20 -08007596 /** @hide */
7597 public boolean isExcludingStopped() {
7598 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7599 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7600 }
7601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007602 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007603 * Retrieve the application package name this Intent is limited to. When
7604 * resolving an Intent, if non-null this limits the resolution to only
7605 * components in the given application package.
7606 *
7607 * @return The name of the application package for the Intent.
7608 *
7609 * @see #resolveActivity
7610 * @see #setPackage
7611 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007612 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007613 return mPackage;
7614 }
7615
7616 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007617 * Retrieve the concrete component associated with the intent. When receiving
7618 * an intent, this is the component that was found to best handle it (that is,
7619 * yourself) and will always be non-null; in all other cases it will be
7620 * null unless explicitly set.
7621 *
7622 * @return The name of the application component to handle the intent.
7623 *
7624 * @see #resolveActivity
7625 * @see #setComponent
7626 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007627 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007628 return mComponent;
7629 }
7630
7631 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007632 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7633 * used as a hint to the receiver for animations and the like. Null means that there
7634 * is no source bounds.
7635 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007636 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007637 return mSourceBounds;
7638 }
7639
7640 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007641 * Return the Activity component that should be used to handle this intent.
7642 * The appropriate component is determined based on the information in the
7643 * intent, evaluated as follows:
7644 *
7645 * <p>If {@link #getComponent} returns an explicit class, that is returned
7646 * without any further consideration.
7647 *
7648 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7649 * category to be considered.
7650 *
7651 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7652 * action.
7653 *
7654 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7655 * this type.
7656 *
7657 * <p>If {@link #addCategory} has added any categories, the activity must
7658 * handle ALL of the categories specified.
7659 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007660 * <p>If {@link #getPackage} is non-NULL, only activity components in
7661 * that application package will be considered.
7662 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007663 * <p>If there are no activities that satisfy all of these conditions, a
7664 * null string is returned.
7665 *
7666 * <p>If multiple activities are found to satisfy the intent, the one with
7667 * the highest priority will be used. If there are multiple activities
7668 * with the same priority, the system will either pick the best activity
7669 * based on user preference, or resolve to a system class that will allow
7670 * the user to pick an activity and forward from there.
7671 *
7672 * <p>This method is implemented simply by calling
7673 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7674 * true.</p>
7675 * <p> This API is called for you as part of starting an activity from an
7676 * intent. You do not normally need to call it yourself.</p>
7677 *
7678 * @param pm The package manager with which to resolve the Intent.
7679 *
7680 * @return Name of the component implementing an activity that can
7681 * display the intent.
7682 *
7683 * @see #setComponent
7684 * @see #getComponent
7685 * @see #resolveActivityInfo
7686 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007687 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007688 if (mComponent != null) {
7689 return mComponent;
7690 }
7691
7692 ResolveInfo info = pm.resolveActivity(
7693 this, PackageManager.MATCH_DEFAULT_ONLY);
7694 if (info != null) {
7695 return new ComponentName(
7696 info.activityInfo.applicationInfo.packageName,
7697 info.activityInfo.name);
7698 }
7699
7700 return null;
7701 }
7702
7703 /**
7704 * Resolve the Intent into an {@link ActivityInfo}
7705 * describing the activity that should execute the intent. Resolution
7706 * follows the same rules as described for {@link #resolveActivity}, but
7707 * you get back the completely information about the resolved activity
7708 * instead of just its class name.
7709 *
7710 * @param pm The package manager with which to resolve the Intent.
7711 * @param flags Addition information to retrieve as per
7712 * {@link PackageManager#getActivityInfo(ComponentName, int)
7713 * PackageManager.getActivityInfo()}.
7714 *
7715 * @return PackageManager.ActivityInfo
7716 *
7717 * @see #resolveActivity
7718 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007719 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7720 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007721 ActivityInfo ai = null;
7722 if (mComponent != null) {
7723 try {
7724 ai = pm.getActivityInfo(mComponent, flags);
7725 } catch (PackageManager.NameNotFoundException e) {
7726 // ignore
7727 }
7728 } else {
7729 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007730 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007731 if (info != null) {
7732 ai = info.activityInfo;
7733 }
7734 }
7735
7736 return ai;
7737 }
7738
7739 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007740 * Special function for use by the system to resolve service
7741 * intents to system apps. Throws an exception if there are
7742 * multiple potential matches to the Intent. Returns null if
7743 * there are no matches.
7744 * @hide
7745 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007746 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7747 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007748 if (mComponent != null) {
7749 return mComponent;
7750 }
7751
7752 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7753 if (results == null) {
7754 return null;
7755 }
7756 ComponentName comp = null;
7757 for (int i=0; i<results.size(); i++) {
7758 ResolveInfo ri = results.get(i);
7759 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7760 continue;
7761 }
7762 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7763 ri.serviceInfo.name);
7764 if (comp != null) {
7765 throw new IllegalStateException("Multiple system services handle " + this
7766 + ": " + comp + ", " + foundComp);
7767 }
7768 comp = foundComp;
7769 }
7770 return comp;
7771 }
7772
7773 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007774 * Set the general action to be performed.
7775 *
7776 * @param action An action name, such as ACTION_VIEW. Application-specific
7777 * actions should be prefixed with the vendor's package name.
7778 *
7779 * @return Returns the same Intent object, for chaining multiple calls
7780 * into a single statement.
7781 *
7782 * @see #getAction
7783 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007784 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007785 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007786 return this;
7787 }
7788
7789 /**
7790 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007791 * clears any type that was previously set by {@link #setType} or
7792 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007793 *
Nick Pellyccae4122012-01-09 14:12:58 -08007794 * <p><em>Note: scheme matching in the Android framework is
7795 * case-sensitive, unlike the formal RFC. As a result,
7796 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007797 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007798 * {@link #setDataAndNormalize}
7799 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007800 *
Nick Pellyccae4122012-01-09 14:12:58 -08007801 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007802 *
7803 * @return Returns the same Intent object, for chaining multiple calls
7804 * into a single statement.
7805 *
7806 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007807 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007808 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007809 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007810 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007811 mData = data;
7812 mType = null;
7813 return this;
7814 }
7815
7816 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007817 * Normalize and set the data this intent is operating on.
7818 *
7819 * <p>This method automatically clears any type that was
7820 * previously set (for example, by {@link #setType}).
7821 *
7822 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007823 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007824 * so really this is just a convenience method for
7825 * <pre>
7826 * setData(data.normalize())
7827 * </pre>
7828 *
7829 * @param data The Uri of the data this intent is now targeting.
7830 *
7831 * @return Returns the same Intent object, for chaining multiple calls
7832 * into a single statement.
7833 *
7834 * @see #getData
7835 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007836 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007837 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007838 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007839 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007840 }
7841
7842 /**
7843 * Set an explicit MIME data type.
7844 *
7845 * <p>This is used to create intents that only specify a type and not data,
7846 * for example to indicate the type of data to return.
7847 *
7848 * <p>This method automatically clears any data that was
7849 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007850 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007851 * <p><em>Note: MIME type matching in the Android framework is
7852 * case-sensitive, unlike formal RFC MIME types. As a result,
7853 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007854 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7855 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007856 *
7857 * @param type The MIME type of the data being handled by this intent.
7858 *
7859 * @return Returns the same Intent object, for chaining multiple calls
7860 * into a single statement.
7861 *
7862 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007863 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007864 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007865 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007866 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007867 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007868 mData = null;
7869 mType = type;
7870 return this;
7871 }
7872
7873 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007874 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007875 *
Nick Pellyccae4122012-01-09 14:12:58 -08007876 * <p>This is used to create intents that only specify a type and not data,
7877 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007878 *
Nick Pellyccae4122012-01-09 14:12:58 -08007879 * <p>This method automatically clears any data that was
7880 * previously set (for example by {@link #setData}).
7881 *
7882 * <p>The MIME type is normalized using
7883 * {@link #normalizeMimeType} before it is set,
7884 * so really this is just a convenience method for
7885 * <pre>
7886 * setType(Intent.normalizeMimeType(type))
7887 * </pre>
7888 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007889 * @param type The MIME type of the data being handled by this intent.
7890 *
7891 * @return Returns the same Intent object, for chaining multiple calls
7892 * into a single statement.
7893 *
Nick Pellyccae4122012-01-09 14:12:58 -08007894 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007895 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007896 * @see #normalizeMimeType
7897 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007898 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007899 return setType(normalizeMimeType(type));
7900 }
7901
7902 /**
7903 * (Usually optional) Set the data for the intent along with an explicit
7904 * MIME data type. This method should very rarely be used -- it allows you
7905 * to override the MIME type that would ordinarily be inferred from the
7906 * data with your own type given here.
7907 *
7908 * <p><em>Note: MIME type and Uri scheme matching in the
7909 * Android framework is case-sensitive, unlike the formal RFC definitions.
7910 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007911 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007912 * {@link #setDataAndTypeAndNormalize}
7913 * to ensure that they are converted to lower case.</em>
7914 *
7915 * @param data The Uri of the data this intent is now targeting.
7916 * @param type The MIME type of the data being handled by this intent.
7917 *
7918 * @return Returns the same Intent object, for chaining multiple calls
7919 * into a single statement.
7920 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007921 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007922 * @see #setData
7923 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007924 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007925 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007926 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007927 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007928 mData = data;
7929 mType = type;
7930 return this;
7931 }
7932
7933 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007934 * (Usually optional) Normalize and set both the data Uri and an explicit
7935 * MIME data type. This method should very rarely be used -- it allows you
7936 * to override the MIME type that would ordinarily be inferred from the
7937 * data with your own type given here.
7938 *
7939 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007940 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007941 * before they are set, so really this is just a convenience method for
7942 * <pre>
7943 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7944 * </pre>
7945 *
7946 * @param data The Uri of the data this intent is now targeting.
7947 * @param type The MIME type of the data being handled by this intent.
7948 *
7949 * @return Returns the same Intent object, for chaining multiple calls
7950 * into a single statement.
7951 *
7952 * @see #setType
7953 * @see #setData
7954 * @see #setDataAndType
7955 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007956 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007957 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007958 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007959 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007960 }
7961
7962 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007963 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007964 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007965 * activities that provide <em>all</em> of the requested categories will be
7966 * used.
7967 *
7968 * @param category The desired category. This can be either one of the
7969 * predefined Intent categories, or a custom category in your own
7970 * namespace.
7971 *
7972 * @return Returns the same Intent object, for chaining multiple calls
7973 * into a single statement.
7974 *
7975 * @see #hasCategory
7976 * @see #removeCategory
7977 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007978 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007979 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007980 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007981 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007982 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007983 return this;
7984 }
7985
7986 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007987 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007988 *
7989 * @param category The category to remove.
7990 *
7991 * @see #addCategory
7992 */
7993 public void removeCategory(String category) {
7994 if (mCategories != null) {
7995 mCategories.remove(category);
7996 if (mCategories.size() == 0) {
7997 mCategories = null;
7998 }
7999 }
8000 }
8001
8002 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008003 * Set a selector for this Intent. This is a modification to the kinds of
8004 * things the Intent will match. If the selector is set, it will be used
8005 * when trying to find entities that can handle the Intent, instead of the
8006 * main contents of the Intent. This allows you build an Intent containing
8007 * a generic protocol while targeting it more specifically.
8008 *
8009 * <p>An example of where this may be used is with things like
8010 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8011 * Intent that will launch the Browser application. However, the correct
8012 * main entry point of an application is actually {@link #ACTION_MAIN}
8013 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8014 * used to specify the actual Activity to launch. If you launch the browser
8015 * with something different, undesired behavior may happen if the user has
8016 * previously or later launches it the normal way, since they do not match.
8017 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8018 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8019 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8020 *
8021 * <p>Setting a selector does not impact the behavior of
8022 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8023 * desired behavior of a selector -- it does not impact the base meaning
8024 * of the Intent, just what kinds of things will be matched against it
8025 * when determining who can handle it.</p>
8026 *
8027 * <p>You can not use both a selector and {@link #setPackage(String)} on
8028 * the same base Intent.</p>
8029 *
8030 * @param selector The desired selector Intent; set to null to not use
8031 * a special selector.
8032 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008033 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008034 if (selector == this) {
8035 throw new IllegalArgumentException(
8036 "Intent being set as a selector of itself");
8037 }
8038 if (selector != null && mPackage != null) {
8039 throw new IllegalArgumentException(
8040 "Can't set selector when package name is already set");
8041 }
8042 mSelector = selector;
8043 }
8044
8045 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008046 * Set a {@link ClipData} associated with this Intent. This replaces any
8047 * previously set ClipData.
8048 *
8049 * <p>The ClipData in an intent is not used for Intent matching or other
8050 * such operations. Semantically it is like extras, used to transmit
8051 * additional data with the Intent. The main feature of using this over
8052 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8053 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8054 * items included in the clip data. This is useful, in particular, if
8055 * you want to transmit an Intent containing multiple <code>content:</code>
8056 * URIs for which the recipient may not have global permission to access the
8057 * content provider.
8058 *
8059 * <p>If the ClipData contains items that are themselves Intents, any
8060 * grant flags in those Intents will be ignored. Only the top-level flags
8061 * of the main Intent are respected, and will be applied to all Uri or
8062 * Intent items in the clip (or sub-items of the clip).
8063 *
8064 * <p>The MIME type, label, and icon in the ClipData object are not
8065 * directly used by Intent. Applications should generally rely on the
8066 * MIME type of the Intent itself, not what it may find in the ClipData.
8067 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008068 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008069 *
8070 * @param clip The new clip to set. May be null to clear the current clip.
8071 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008072 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008073 mClipData = clip;
8074 }
8075
8076 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008077 * This is NOT a secure mechanism to identify the user who sent the intent.
8078 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8079 * who sent the intent.
8080 * @hide
8081 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008082 public void prepareToLeaveUser(int userId) {
8083 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8084 // We want mContentUserHint to refer to the original user, so don't do anything.
8085 if (mContentUserHint == UserHandle.USER_CURRENT) {
8086 mContentUserHint = userId;
8087 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008088 }
8089
8090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008091 * Add extended data to the intent. The name must include a package
8092 * prefix, for example the app com.android.contacts would use names
8093 * like "com.android.contacts.ShowAll".
8094 *
8095 * @param name The name of the extra data, with package prefix.
8096 * @param value The boolean data value.
8097 *
8098 * @return Returns the same Intent object, for chaining multiple calls
8099 * into a single statement.
8100 *
8101 * @see #putExtras
8102 * @see #removeExtra
8103 * @see #getBooleanExtra(String, boolean)
8104 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008105 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008106 if (mExtras == null) {
8107 mExtras = new Bundle();
8108 }
8109 mExtras.putBoolean(name, value);
8110 return this;
8111 }
8112
8113 /**
8114 * Add extended data to the intent. The name must include a package
8115 * prefix, for example the app com.android.contacts would use names
8116 * like "com.android.contacts.ShowAll".
8117 *
8118 * @param name The name of the extra data, with package prefix.
8119 * @param value The byte data value.
8120 *
8121 * @return Returns the same Intent object, for chaining multiple calls
8122 * into a single statement.
8123 *
8124 * @see #putExtras
8125 * @see #removeExtra
8126 * @see #getByteExtra(String, byte)
8127 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008128 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008129 if (mExtras == null) {
8130 mExtras = new Bundle();
8131 }
8132 mExtras.putByte(name, value);
8133 return this;
8134 }
8135
8136 /**
8137 * Add extended data to the intent. The name must include a package
8138 * prefix, for example the app com.android.contacts would use names
8139 * like "com.android.contacts.ShowAll".
8140 *
8141 * @param name The name of the extra data, with package prefix.
8142 * @param value The char data value.
8143 *
8144 * @return Returns the same Intent object, for chaining multiple calls
8145 * into a single statement.
8146 *
8147 * @see #putExtras
8148 * @see #removeExtra
8149 * @see #getCharExtra(String, char)
8150 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008151 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008152 if (mExtras == null) {
8153 mExtras = new Bundle();
8154 }
8155 mExtras.putChar(name, value);
8156 return this;
8157 }
8158
8159 /**
8160 * Add extended data to the intent. The name must include a package
8161 * prefix, for example the app com.android.contacts would use names
8162 * like "com.android.contacts.ShowAll".
8163 *
8164 * @param name The name of the extra data, with package prefix.
8165 * @param value The short data value.
8166 *
8167 * @return Returns the same Intent object, for chaining multiple calls
8168 * into a single statement.
8169 *
8170 * @see #putExtras
8171 * @see #removeExtra
8172 * @see #getShortExtra(String, short)
8173 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008174 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008175 if (mExtras == null) {
8176 mExtras = new Bundle();
8177 }
8178 mExtras.putShort(name, value);
8179 return this;
8180 }
8181
8182 /**
8183 * Add extended data to the intent. The name must include a package
8184 * prefix, for example the app com.android.contacts would use names
8185 * like "com.android.contacts.ShowAll".
8186 *
8187 * @param name The name of the extra data, with package prefix.
8188 * @param value The integer data value.
8189 *
8190 * @return Returns the same Intent object, for chaining multiple calls
8191 * into a single statement.
8192 *
8193 * @see #putExtras
8194 * @see #removeExtra
8195 * @see #getIntExtra(String, int)
8196 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008197 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 if (mExtras == null) {
8199 mExtras = new Bundle();
8200 }
8201 mExtras.putInt(name, value);
8202 return this;
8203 }
8204
8205 /**
8206 * Add extended data to the intent. The name must include a package
8207 * prefix, for example the app com.android.contacts would use names
8208 * like "com.android.contacts.ShowAll".
8209 *
8210 * @param name The name of the extra data, with package prefix.
8211 * @param value The long data value.
8212 *
8213 * @return Returns the same Intent object, for chaining multiple calls
8214 * into a single statement.
8215 *
8216 * @see #putExtras
8217 * @see #removeExtra
8218 * @see #getLongExtra(String, long)
8219 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008220 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008221 if (mExtras == null) {
8222 mExtras = new Bundle();
8223 }
8224 mExtras.putLong(name, value);
8225 return this;
8226 }
8227
8228 /**
8229 * Add extended data to the intent. The name must include a package
8230 * prefix, for example the app com.android.contacts would use names
8231 * like "com.android.contacts.ShowAll".
8232 *
8233 * @param name The name of the extra data, with package prefix.
8234 * @param value The float data value.
8235 *
8236 * @return Returns the same Intent object, for chaining multiple calls
8237 * into a single statement.
8238 *
8239 * @see #putExtras
8240 * @see #removeExtra
8241 * @see #getFloatExtra(String, float)
8242 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008243 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008244 if (mExtras == null) {
8245 mExtras = new Bundle();
8246 }
8247 mExtras.putFloat(name, value);
8248 return this;
8249 }
8250
8251 /**
8252 * Add extended data to the intent. The name must include a package
8253 * prefix, for example the app com.android.contacts would use names
8254 * like "com.android.contacts.ShowAll".
8255 *
8256 * @param name The name of the extra data, with package prefix.
8257 * @param value The double data value.
8258 *
8259 * @return Returns the same Intent object, for chaining multiple calls
8260 * into a single statement.
8261 *
8262 * @see #putExtras
8263 * @see #removeExtra
8264 * @see #getDoubleExtra(String, double)
8265 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008266 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008267 if (mExtras == null) {
8268 mExtras = new Bundle();
8269 }
8270 mExtras.putDouble(name, value);
8271 return this;
8272 }
8273
8274 /**
8275 * Add extended data to the intent. The name must include a package
8276 * prefix, for example the app com.android.contacts would use names
8277 * like "com.android.contacts.ShowAll".
8278 *
8279 * @param name The name of the extra data, with package prefix.
8280 * @param value The String data value.
8281 *
8282 * @return Returns the same Intent object, for chaining multiple calls
8283 * into a single statement.
8284 *
8285 * @see #putExtras
8286 * @see #removeExtra
8287 * @see #getStringExtra(String)
8288 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008289 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008290 if (mExtras == null) {
8291 mExtras = new Bundle();
8292 }
8293 mExtras.putString(name, value);
8294 return this;
8295 }
8296
8297 /**
8298 * Add extended data to the intent. The name must include a package
8299 * prefix, for example the app com.android.contacts would use names
8300 * like "com.android.contacts.ShowAll".
8301 *
8302 * @param name The name of the extra data, with package prefix.
8303 * @param value The CharSequence data value.
8304 *
8305 * @return Returns the same Intent object, for chaining multiple calls
8306 * into a single statement.
8307 *
8308 * @see #putExtras
8309 * @see #removeExtra
8310 * @see #getCharSequenceExtra(String)
8311 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008312 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008313 if (mExtras == null) {
8314 mExtras = new Bundle();
8315 }
8316 mExtras.putCharSequence(name, value);
8317 return this;
8318 }
8319
8320 /**
8321 * Add extended data to the intent. The name must include a package
8322 * prefix, for example the app com.android.contacts would use names
8323 * like "com.android.contacts.ShowAll".
8324 *
8325 * @param name The name of the extra data, with package prefix.
8326 * @param value The Parcelable data value.
8327 *
8328 * @return Returns the same Intent object, for chaining multiple calls
8329 * into a single statement.
8330 *
8331 * @see #putExtras
8332 * @see #removeExtra
8333 * @see #getParcelableExtra(String)
8334 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008335 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008336 if (mExtras == null) {
8337 mExtras = new Bundle();
8338 }
8339 mExtras.putParcelable(name, value);
8340 return this;
8341 }
8342
8343 /**
8344 * Add extended data to the intent. The name must include a package
8345 * prefix, for example the app com.android.contacts would use names
8346 * like "com.android.contacts.ShowAll".
8347 *
8348 * @param name The name of the extra data, with package prefix.
8349 * @param value The Parcelable[] data value.
8350 *
8351 * @return Returns the same Intent object, for chaining multiple calls
8352 * into a single statement.
8353 *
8354 * @see #putExtras
8355 * @see #removeExtra
8356 * @see #getParcelableArrayExtra(String)
8357 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008358 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008359 if (mExtras == null) {
8360 mExtras = new Bundle();
8361 }
8362 mExtras.putParcelableArray(name, value);
8363 return this;
8364 }
8365
8366 /**
8367 * Add extended data to the intent. The name must include a package
8368 * prefix, for example the app com.android.contacts would use names
8369 * like "com.android.contacts.ShowAll".
8370 *
8371 * @param name The name of the extra data, with package prefix.
8372 * @param value The ArrayList<Parcelable> data value.
8373 *
8374 * @return Returns the same Intent object, for chaining multiple calls
8375 * into a single statement.
8376 *
8377 * @see #putExtras
8378 * @see #removeExtra
8379 * @see #getParcelableArrayListExtra(String)
8380 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008381 public @NonNull Intent putParcelableArrayListExtra(String name,
8382 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008383 if (mExtras == null) {
8384 mExtras = new Bundle();
8385 }
8386 mExtras.putParcelableArrayList(name, value);
8387 return this;
8388 }
8389
8390 /**
8391 * Add extended data to the intent. The name must include a package
8392 * prefix, for example the app com.android.contacts would use names
8393 * like "com.android.contacts.ShowAll".
8394 *
8395 * @param name The name of the extra data, with package prefix.
8396 * @param value The ArrayList<Integer> data value.
8397 *
8398 * @return Returns the same Intent object, for chaining multiple calls
8399 * into a single statement.
8400 *
8401 * @see #putExtras
8402 * @see #removeExtra
8403 * @see #getIntegerArrayListExtra(String)
8404 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008405 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008406 if (mExtras == null) {
8407 mExtras = new Bundle();
8408 }
8409 mExtras.putIntegerArrayList(name, value);
8410 return this;
8411 }
8412
8413 /**
8414 * Add extended data to the intent. The name must include a package
8415 * prefix, for example the app com.android.contacts would use names
8416 * like "com.android.contacts.ShowAll".
8417 *
8418 * @param name The name of the extra data, with package prefix.
8419 * @param value The ArrayList<String> data value.
8420 *
8421 * @return Returns the same Intent object, for chaining multiple calls
8422 * into a single statement.
8423 *
8424 * @see #putExtras
8425 * @see #removeExtra
8426 * @see #getStringArrayListExtra(String)
8427 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008428 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008429 if (mExtras == null) {
8430 mExtras = new Bundle();
8431 }
8432 mExtras.putStringArrayList(name, value);
8433 return this;
8434 }
8435
8436 /**
8437 * Add extended data to the intent. The name must include a package
8438 * prefix, for example the app com.android.contacts would use names
8439 * like "com.android.contacts.ShowAll".
8440 *
8441 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008442 * @param value The ArrayList<CharSequence> data value.
8443 *
8444 * @return Returns the same Intent object, for chaining multiple calls
8445 * into a single statement.
8446 *
8447 * @see #putExtras
8448 * @see #removeExtra
8449 * @see #getCharSequenceArrayListExtra(String)
8450 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008451 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8452 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008453 if (mExtras == null) {
8454 mExtras = new Bundle();
8455 }
8456 mExtras.putCharSequenceArrayList(name, value);
8457 return this;
8458 }
8459
8460 /**
8461 * Add extended data to the intent. The name must include a package
8462 * prefix, for example the app com.android.contacts would use names
8463 * like "com.android.contacts.ShowAll".
8464 *
8465 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008466 * @param value The Serializable data value.
8467 *
8468 * @return Returns the same Intent object, for chaining multiple calls
8469 * into a single statement.
8470 *
8471 * @see #putExtras
8472 * @see #removeExtra
8473 * @see #getSerializableExtra(String)
8474 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008475 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008476 if (mExtras == null) {
8477 mExtras = new Bundle();
8478 }
8479 mExtras.putSerializable(name, value);
8480 return this;
8481 }
8482
8483 /**
8484 * Add extended data to the intent. The name must include a package
8485 * prefix, for example the app com.android.contacts would use names
8486 * like "com.android.contacts.ShowAll".
8487 *
8488 * @param name The name of the extra data, with package prefix.
8489 * @param value The boolean array data value.
8490 *
8491 * @return Returns the same Intent object, for chaining multiple calls
8492 * into a single statement.
8493 *
8494 * @see #putExtras
8495 * @see #removeExtra
8496 * @see #getBooleanArrayExtra(String)
8497 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008498 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008499 if (mExtras == null) {
8500 mExtras = new Bundle();
8501 }
8502 mExtras.putBooleanArray(name, value);
8503 return this;
8504 }
8505
8506 /**
8507 * Add extended data to the intent. The name must include a package
8508 * prefix, for example the app com.android.contacts would use names
8509 * like "com.android.contacts.ShowAll".
8510 *
8511 * @param name The name of the extra data, with package prefix.
8512 * @param value The byte array data value.
8513 *
8514 * @return Returns the same Intent object, for chaining multiple calls
8515 * into a single statement.
8516 *
8517 * @see #putExtras
8518 * @see #removeExtra
8519 * @see #getByteArrayExtra(String)
8520 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008521 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008522 if (mExtras == null) {
8523 mExtras = new Bundle();
8524 }
8525 mExtras.putByteArray(name, value);
8526 return this;
8527 }
8528
8529 /**
8530 * Add extended data to the intent. The name must include a package
8531 * prefix, for example the app com.android.contacts would use names
8532 * like "com.android.contacts.ShowAll".
8533 *
8534 * @param name The name of the extra data, with package prefix.
8535 * @param value The short array data value.
8536 *
8537 * @return Returns the same Intent object, for chaining multiple calls
8538 * into a single statement.
8539 *
8540 * @see #putExtras
8541 * @see #removeExtra
8542 * @see #getShortArrayExtra(String)
8543 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008544 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008545 if (mExtras == null) {
8546 mExtras = new Bundle();
8547 }
8548 mExtras.putShortArray(name, value);
8549 return this;
8550 }
8551
8552 /**
8553 * Add extended data to the intent. The name must include a package
8554 * prefix, for example the app com.android.contacts would use names
8555 * like "com.android.contacts.ShowAll".
8556 *
8557 * @param name The name of the extra data, with package prefix.
8558 * @param value The char array data value.
8559 *
8560 * @return Returns the same Intent object, for chaining multiple calls
8561 * into a single statement.
8562 *
8563 * @see #putExtras
8564 * @see #removeExtra
8565 * @see #getCharArrayExtra(String)
8566 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008567 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008568 if (mExtras == null) {
8569 mExtras = new Bundle();
8570 }
8571 mExtras.putCharArray(name, value);
8572 return this;
8573 }
8574
8575 /**
8576 * Add extended data to the intent. The name must include a package
8577 * prefix, for example the app com.android.contacts would use names
8578 * like "com.android.contacts.ShowAll".
8579 *
8580 * @param name The name of the extra data, with package prefix.
8581 * @param value The int array data value.
8582 *
8583 * @return Returns the same Intent object, for chaining multiple calls
8584 * into a single statement.
8585 *
8586 * @see #putExtras
8587 * @see #removeExtra
8588 * @see #getIntArrayExtra(String)
8589 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008590 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008591 if (mExtras == null) {
8592 mExtras = new Bundle();
8593 }
8594 mExtras.putIntArray(name, value);
8595 return this;
8596 }
8597
8598 /**
8599 * Add extended data to the intent. The name must include a package
8600 * prefix, for example the app com.android.contacts would use names
8601 * like "com.android.contacts.ShowAll".
8602 *
8603 * @param name The name of the extra data, with package prefix.
8604 * @param value The byte array data value.
8605 *
8606 * @return Returns the same Intent object, for chaining multiple calls
8607 * into a single statement.
8608 *
8609 * @see #putExtras
8610 * @see #removeExtra
8611 * @see #getLongArrayExtra(String)
8612 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008613 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008614 if (mExtras == null) {
8615 mExtras = new Bundle();
8616 }
8617 mExtras.putLongArray(name, value);
8618 return this;
8619 }
8620
8621 /**
8622 * Add extended data to the intent. The name must include a package
8623 * prefix, for example the app com.android.contacts would use names
8624 * like "com.android.contacts.ShowAll".
8625 *
8626 * @param name The name of the extra data, with package prefix.
8627 * @param value The float array data value.
8628 *
8629 * @return Returns the same Intent object, for chaining multiple calls
8630 * into a single statement.
8631 *
8632 * @see #putExtras
8633 * @see #removeExtra
8634 * @see #getFloatArrayExtra(String)
8635 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008636 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008637 if (mExtras == null) {
8638 mExtras = new Bundle();
8639 }
8640 mExtras.putFloatArray(name, value);
8641 return this;
8642 }
8643
8644 /**
8645 * Add extended data to the intent. The name must include a package
8646 * prefix, for example the app com.android.contacts would use names
8647 * like "com.android.contacts.ShowAll".
8648 *
8649 * @param name The name of the extra data, with package prefix.
8650 * @param value The double array data value.
8651 *
8652 * @return Returns the same Intent object, for chaining multiple calls
8653 * into a single statement.
8654 *
8655 * @see #putExtras
8656 * @see #removeExtra
8657 * @see #getDoubleArrayExtra(String)
8658 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008659 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008660 if (mExtras == null) {
8661 mExtras = new Bundle();
8662 }
8663 mExtras.putDoubleArray(name, value);
8664 return this;
8665 }
8666
8667 /**
8668 * Add extended data to the intent. The name must include a package
8669 * prefix, for example the app com.android.contacts would use names
8670 * like "com.android.contacts.ShowAll".
8671 *
8672 * @param name The name of the extra data, with package prefix.
8673 * @param value The String array data value.
8674 *
8675 * @return Returns the same Intent object, for chaining multiple calls
8676 * into a single statement.
8677 *
8678 * @see #putExtras
8679 * @see #removeExtra
8680 * @see #getStringArrayExtra(String)
8681 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008682 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683 if (mExtras == null) {
8684 mExtras = new Bundle();
8685 }
8686 mExtras.putStringArray(name, value);
8687 return this;
8688 }
8689
8690 /**
8691 * Add extended data to the intent. The name must include a package
8692 * prefix, for example the app com.android.contacts would use names
8693 * like "com.android.contacts.ShowAll".
8694 *
8695 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008696 * @param value The CharSequence array data value.
8697 *
8698 * @return Returns the same Intent object, for chaining multiple calls
8699 * into a single statement.
8700 *
8701 * @see #putExtras
8702 * @see #removeExtra
8703 * @see #getCharSequenceArrayExtra(String)
8704 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008705 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008706 if (mExtras == null) {
8707 mExtras = new Bundle();
8708 }
8709 mExtras.putCharSequenceArray(name, value);
8710 return this;
8711 }
8712
8713 /**
8714 * Add extended data to the intent. The name must include a package
8715 * prefix, for example the app com.android.contacts would use names
8716 * like "com.android.contacts.ShowAll".
8717 *
8718 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008719 * @param value The Bundle data value.
8720 *
8721 * @return Returns the same Intent object, for chaining multiple calls
8722 * into a single statement.
8723 *
8724 * @see #putExtras
8725 * @see #removeExtra
8726 * @see #getBundleExtra(String)
8727 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008728 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008729 if (mExtras == null) {
8730 mExtras = new Bundle();
8731 }
8732 mExtras.putBundle(name, value);
8733 return this;
8734 }
8735
8736 /**
8737 * Add extended data to the intent. The name must include a package
8738 * prefix, for example the app com.android.contacts would use names
8739 * like "com.android.contacts.ShowAll".
8740 *
8741 * @param name The name of the extra data, with package prefix.
8742 * @param value The IBinder data value.
8743 *
8744 * @return Returns the same Intent object, for chaining multiple calls
8745 * into a single statement.
8746 *
8747 * @see #putExtras
8748 * @see #removeExtra
8749 * @see #getIBinderExtra(String)
8750 *
8751 * @deprecated
8752 * @hide
8753 */
8754 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008755 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008756 if (mExtras == null) {
8757 mExtras = new Bundle();
8758 }
8759 mExtras.putIBinder(name, value);
8760 return this;
8761 }
8762
8763 /**
8764 * Copy all extras in 'src' in to this intent.
8765 *
8766 * @param src Contains the extras to copy.
8767 *
8768 * @see #putExtra
8769 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008770 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008771 if (src.mExtras != null) {
8772 if (mExtras == null) {
8773 mExtras = new Bundle(src.mExtras);
8774 } else {
8775 mExtras.putAll(src.mExtras);
8776 }
8777 }
8778 return this;
8779 }
8780
8781 /**
8782 * Add a set of extended data to the intent. The keys must include a package
8783 * prefix, for example the app com.android.contacts would use names
8784 * like "com.android.contacts.ShowAll".
8785 *
8786 * @param extras The Bundle of extras to add to this intent.
8787 *
8788 * @see #putExtra
8789 * @see #removeExtra
8790 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008791 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008792 if (mExtras == null) {
8793 mExtras = new Bundle();
8794 }
8795 mExtras.putAll(extras);
8796 return this;
8797 }
8798
8799 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008800 * Completely replace the extras in the Intent with the extras in the
8801 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008802 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008803 * @param src The exact extras contained in this Intent are copied
8804 * into the target intent, replacing any that were previously there.
8805 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008806 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008807 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8808 return this;
8809 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008810
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008811 /**
8812 * Completely replace the extras in the Intent with the given Bundle of
8813 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008814 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008815 * @param extras The new set of extras in the Intent, or null to erase
8816 * all extras.
8817 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008818 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008819 mExtras = extras != null ? new Bundle(extras) : null;
8820 return this;
8821 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008822
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008823 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008824 * Remove extended data from the intent.
8825 *
8826 * @see #putExtra
8827 */
8828 public void removeExtra(String name) {
8829 if (mExtras != null) {
8830 mExtras.remove(name);
8831 if (mExtras.size() == 0) {
8832 mExtras = null;
8833 }
8834 }
8835 }
8836
8837 /**
8838 * Set special flags controlling how this intent is handled. Most values
8839 * here depend on the type of component being executed by the Intent,
8840 * specifically the FLAG_ACTIVITY_* flags are all for use with
8841 * {@link Context#startActivity Context.startActivity()} and the
8842 * FLAG_RECEIVER_* flags are all for use with
8843 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8844 *
Scott Main7aee61f2011-02-08 11:25:01 -08008845 * <p>See the
8846 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8847 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008848 * the behavior of your application.
8849 *
8850 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008851 * @return Returns the same Intent object, for chaining multiple calls
8852 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008853 * @see #getFlags
8854 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008855 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008856 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008857 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008858 mFlags = flags;
8859 return this;
8860 }
8861
8862 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008863 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008864 *
8865 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008866 * @return Returns the same Intent object, for chaining multiple calls into
8867 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008868 * @see #setFlags
8869 * @see #getFlags
8870 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008871 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008872 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008873 mFlags |= flags;
8874 return this;
8875 }
8876
8877 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008878 * Remove these flags from the intent.
8879 *
8880 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008881 * @see #setFlags
8882 * @see #getFlags
8883 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008884 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008885 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008886 mFlags &= ~flags;
8887 }
8888
8889 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008890 * (Usually optional) Set an explicit application package name that limits
8891 * the components this Intent will resolve to. If left to the default
8892 * value of null, all components in all applications will considered.
8893 * If non-null, the Intent can only match the components in the given
8894 * application package.
8895 *
8896 * @param packageName The name of the application package to handle the
8897 * intent, or null to allow any application package.
8898 *
8899 * @return Returns the same Intent object, for chaining multiple calls
8900 * into a single statement.
8901 *
8902 * @see #getPackage
8903 * @see #resolveActivity
8904 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008905 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008906 if (packageName != null && mSelector != null) {
8907 throw new IllegalArgumentException(
8908 "Can't set package name when selector is already set");
8909 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008910 mPackage = packageName;
8911 return this;
8912 }
8913
8914 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008915 * (Usually optional) Explicitly set the component to handle the intent.
8916 * If left with the default value of null, the system will determine the
8917 * appropriate class to use based on the other fields (action, data,
8918 * type, categories) in the Intent. If this class is defined, the
8919 * specified class will always be used regardless of the other fields. You
8920 * should only set this value when you know you absolutely want a specific
8921 * class to be used; otherwise it is better to let the system find the
8922 * appropriate class so that you will respect the installed applications
8923 * and user preferences.
8924 *
8925 * @param component The name of the application component to handle the
8926 * intent, or null to let the system find one for you.
8927 *
8928 * @return Returns the same Intent object, for chaining multiple calls
8929 * into a single statement.
8930 *
8931 * @see #setClass
8932 * @see #setClassName(Context, String)
8933 * @see #setClassName(String, String)
8934 * @see #getComponent
8935 * @see #resolveActivity
8936 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008937 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008938 mComponent = component;
8939 return this;
8940 }
8941
8942 /**
8943 * Convenience for calling {@link #setComponent} with an
8944 * explicit class name.
8945 *
8946 * @param packageContext A Context of the application package implementing
8947 * this class.
8948 * @param className The name of a class inside of the application package
8949 * that will be used as the component for this Intent.
8950 *
8951 * @return Returns the same Intent object, for chaining multiple calls
8952 * into a single statement.
8953 *
8954 * @see #setComponent
8955 * @see #setClass
8956 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008957 public @NonNull Intent setClassName(@NonNull Context packageContext,
8958 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008959 mComponent = new ComponentName(packageContext, className);
8960 return this;
8961 }
8962
8963 /**
8964 * Convenience for calling {@link #setComponent} with an
8965 * explicit application package name and class name.
8966 *
8967 * @param packageName The name of the package implementing the desired
8968 * component.
8969 * @param className The name of a class inside of the application package
8970 * that will be used as the component for this Intent.
8971 *
8972 * @return Returns the same Intent object, for chaining multiple calls
8973 * into a single statement.
8974 *
8975 * @see #setComponent
8976 * @see #setClass
8977 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008978 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008979 mComponent = new ComponentName(packageName, className);
8980 return this;
8981 }
8982
8983 /**
8984 * Convenience for calling {@link #setComponent(ComponentName)} with the
8985 * name returned by a {@link Class} object.
8986 *
8987 * @param packageContext A Context of the application package implementing
8988 * this class.
8989 * @param cls The class name to set, equivalent to
8990 * <code>setClassName(context, cls.getName())</code>.
8991 *
8992 * @return Returns the same Intent object, for chaining multiple calls
8993 * into a single statement.
8994 *
8995 * @see #setComponent
8996 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008997 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008998 mComponent = new ComponentName(packageContext, cls);
8999 return this;
9000 }
9001
9002 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009003 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9004 * used as a hint to the receiver for animations and the like. Null means that there
9005 * is no source bounds.
9006 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009007 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009008 if (r != null) {
9009 mSourceBounds = new Rect(r);
9010 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009011 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009012 }
9013 }
9014
Tor Norbyed9273d62013-05-30 15:59:53 -07009015 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009016 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9017 FILL_IN_ACTION,
9018 FILL_IN_DATA,
9019 FILL_IN_CATEGORIES,
9020 FILL_IN_COMPONENT,
9021 FILL_IN_PACKAGE,
9022 FILL_IN_SOURCE_BOUNDS,
9023 FILL_IN_SELECTOR,
9024 FILL_IN_CLIP_DATA
9025 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009026 @Retention(RetentionPolicy.SOURCE)
9027 public @interface FillInFlags {}
9028
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009029 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009030 * Use with {@link #fillIn} to allow the current action value to be
9031 * overwritten, even if it is already set.
9032 */
9033 public static final int FILL_IN_ACTION = 1<<0;
9034
9035 /**
9036 * Use with {@link #fillIn} to allow the current data or type value
9037 * overwritten, even if it is already set.
9038 */
9039 public static final int FILL_IN_DATA = 1<<1;
9040
9041 /**
9042 * Use with {@link #fillIn} to allow the current categories to be
9043 * overwritten, even if they are already set.
9044 */
9045 public static final int FILL_IN_CATEGORIES = 1<<2;
9046
9047 /**
9048 * Use with {@link #fillIn} to allow the current component value to be
9049 * overwritten, even if it is already set.
9050 */
9051 public static final int FILL_IN_COMPONENT = 1<<3;
9052
9053 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009054 * Use with {@link #fillIn} to allow the current package value to be
9055 * overwritten, even if it is already set.
9056 */
9057 public static final int FILL_IN_PACKAGE = 1<<4;
9058
9059 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009060 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009061 * overwritten, even if it is already set.
9062 */
9063 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9064
9065 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009066 * Use with {@link #fillIn} to allow the current selector to be
9067 * overwritten, even if it is already set.
9068 */
9069 public static final int FILL_IN_SELECTOR = 1<<6;
9070
9071 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009072 * Use with {@link #fillIn} to allow the current ClipData to be
9073 * overwritten, even if it is already set.
9074 */
9075 public static final int FILL_IN_CLIP_DATA = 1<<7;
9076
9077 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009078 * Copy the contents of <var>other</var> in to this object, but only
9079 * where fields are not defined by this object. For purposes of a field
9080 * being defined, the following pieces of data in the Intent are
9081 * considered to be separate fields:
9082 *
9083 * <ul>
9084 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009085 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009086 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9087 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009088 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009089 * <li> component, as set by {@link #setComponent(ComponentName)} or
9090 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009091 * <li> source bounds, as set by {@link #setSourceBounds}.
9092 * <li> selector, as set by {@link #setSelector(Intent)}.
9093 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009094 * <li> each top-level name in the associated extras.
9095 * </ul>
9096 *
9097 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009098 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009099 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9100 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9101 * the restriction where the corresponding field will not be replaced if
9102 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009103 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009104 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9105 * is explicitly specified. The selector will only be copied if
9106 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009107 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009108 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9109 * and Intent B with {action="gotit", data-type="some/thing",
9110 * categories="one","two"}.
9111 *
9112 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9113 * containing: {action="gotit", data-type="some/thing",
9114 * categories="bar"}.
9115 *
9116 * @param other Another Intent whose values are to be used to fill in
9117 * the current one.
9118 * @param flags Options to control which fields can be filled in.
9119 *
9120 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009121 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009122 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009123 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009124 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009125 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009126 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009127 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009128 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009129 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009130 if (other.mAction != null
9131 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009132 mAction = other.mAction;
9133 changes |= FILL_IN_ACTION;
9134 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009135 if ((other.mData != null || other.mType != null)
9136 && ((mData == null && mType == null)
9137 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009138 mData = other.mData;
9139 mType = other.mType;
9140 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009141 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009142 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009143 if (other.mCategories != null
9144 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009145 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009146 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009147 }
9148 changes |= FILL_IN_CATEGORIES;
9149 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009150 if (other.mPackage != null
9151 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009152 // Only do this if mSelector is not set.
9153 if (mSelector == null) {
9154 mPackage = other.mPackage;
9155 changes |= FILL_IN_PACKAGE;
9156 }
9157 }
9158 // Selector is special: it can only be set if explicitly allowed,
9159 // for the same reason as the component name.
9160 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9161 if (mPackage == null) {
9162 mSelector = new Intent(other.mSelector);
9163 mPackage = null;
9164 changes |= FILL_IN_SELECTOR;
9165 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009166 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009167 if (other.mClipData != null
9168 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9169 mClipData = other.mClipData;
9170 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009171 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009172 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009173 // Component is special: it can -only- be set if explicitly allowed,
9174 // since otherwise the sender could force the intent somewhere the
9175 // originator didn't intend.
9176 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009177 mComponent = other.mComponent;
9178 changes |= FILL_IN_COMPONENT;
9179 }
9180 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009181 if (other.mSourceBounds != null
9182 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9183 mSourceBounds = new Rect(other.mSourceBounds);
9184 changes |= FILL_IN_SOURCE_BOUNDS;
9185 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009186 if (mExtras == null) {
9187 if (other.mExtras != null) {
9188 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009189 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009190 }
9191 } else if (other.mExtras != null) {
9192 try {
9193 Bundle newb = new Bundle(other.mExtras);
9194 newb.putAll(mExtras);
9195 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009196 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009197 } catch (RuntimeException e) {
9198 // Modifying the extras can cause us to unparcel the contents
9199 // of the bundle, and if we do this in the system process that
9200 // may fail. We really should handle this (i.e., the Bundle
9201 // impl shouldn't be on top of a plain map), but for now just
9202 // ignore it and keep the original contents. :(
9203 Log.w("Intent", "Failure filling in extras", e);
9204 }
9205 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009206 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9207 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9208 mContentUserHint = other.mContentUserHint;
9209 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009210 return changes;
9211 }
9212
9213 /**
9214 * Wrapper class holding an Intent and implementing comparisons on it for
9215 * the purpose of filtering. The class implements its
9216 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9217 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9218 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9219 * on the wrapped Intent.
9220 */
9221 public static final class FilterComparison {
9222 private final Intent mIntent;
9223 private final int mHashCode;
9224
9225 public FilterComparison(Intent intent) {
9226 mIntent = intent;
9227 mHashCode = intent.filterHashCode();
9228 }
9229
9230 /**
9231 * Return the Intent that this FilterComparison represents.
9232 * @return Returns the Intent held by the FilterComparison. Do
9233 * not modify!
9234 */
9235 public Intent getIntent() {
9236 return mIntent;
9237 }
9238
9239 @Override
9240 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009241 if (obj instanceof FilterComparison) {
9242 Intent other = ((FilterComparison)obj).mIntent;
9243 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009244 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009245 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009246 }
9247
9248 @Override
9249 public int hashCode() {
9250 return mHashCode;
9251 }
9252 }
9253
9254 /**
9255 * Determine if two intents are the same for the purposes of intent
9256 * resolution (filtering). That is, if their action, data, type,
9257 * class, and categories are the same. This does <em>not</em> compare
9258 * any extra data included in the intents.
9259 *
9260 * @param other The other Intent to compare against.
9261 *
9262 * @return Returns true if action, data, type, class, and categories
9263 * are the same.
9264 */
9265 public boolean filterEquals(Intent other) {
9266 if (other == null) {
9267 return false;
9268 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009269 if (!Objects.equals(this.mAction, other.mAction)) return false;
9270 if (!Objects.equals(this.mData, other.mData)) return false;
9271 if (!Objects.equals(this.mType, other.mType)) return false;
9272 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9273 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9274 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009275
9276 return true;
9277 }
9278
9279 /**
9280 * Generate hash code that matches semantics of filterEquals().
9281 *
9282 * @return Returns the hash value of the action, data, type, class, and
9283 * categories.
9284 *
9285 * @see #filterEquals
9286 */
9287 public int filterHashCode() {
9288 int code = 0;
9289 if (mAction != null) {
9290 code += mAction.hashCode();
9291 }
9292 if (mData != null) {
9293 code += mData.hashCode();
9294 }
9295 if (mType != null) {
9296 code += mType.hashCode();
9297 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009298 if (mPackage != null) {
9299 code += mPackage.hashCode();
9300 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009301 if (mComponent != null) {
9302 code += mComponent.hashCode();
9303 }
9304 if (mCategories != null) {
9305 code += mCategories.hashCode();
9306 }
9307 return code;
9308 }
9309
9310 @Override
9311 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009312 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009313
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009314 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009315 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009316 b.append(" }");
9317
9318 return b.toString();
9319 }
9320
9321 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009322 public String toInsecureString() {
9323 StringBuilder b = new StringBuilder(128);
9324
9325 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009326 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009327 b.append(" }");
9328
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009329 return b.toString();
9330 }
Romain Guy4969af72009-06-17 10:53:19 -07009331
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009332 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009333 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009334 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009335
9336 b.append("Intent { ");
9337 toShortString(b, false, true, true, true);
9338 b.append(" }");
9339
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009340 return b.toString();
9341 }
9342
9343 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009344 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9345 StringBuilder b = new StringBuilder(128);
9346 toShortString(b, secure, comp, extras, clip);
9347 return b.toString();
9348 }
9349
9350 /** @hide */
9351 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9352 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009353 boolean first = true;
9354 if (mAction != null) {
9355 b.append("act=").append(mAction);
9356 first = false;
9357 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009358 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009359 if (!first) {
9360 b.append(' ');
9361 }
9362 first = false;
9363 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009364 for (int i=0; i<mCategories.size(); i++) {
9365 if (i > 0) b.append(',');
9366 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009367 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009368 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009369 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009370 if (mData != null) {
9371 if (!first) {
9372 b.append(' ');
9373 }
9374 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009375 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009376 if (secure) {
9377 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009378 } else {
9379 b.append(mData);
9380 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009381 }
9382 if (mType != null) {
9383 if (!first) {
9384 b.append(' ');
9385 }
9386 first = false;
9387 b.append("typ=").append(mType);
9388 }
9389 if (mFlags != 0) {
9390 if (!first) {
9391 b.append(' ');
9392 }
9393 first = false;
9394 b.append("flg=0x").append(Integer.toHexString(mFlags));
9395 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009396 if (mPackage != null) {
9397 if (!first) {
9398 b.append(' ');
9399 }
9400 first = false;
9401 b.append("pkg=").append(mPackage);
9402 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009403 if (comp && mComponent != null) {
9404 if (!first) {
9405 b.append(' ');
9406 }
9407 first = false;
9408 b.append("cmp=").append(mComponent.flattenToShortString());
9409 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009410 if (mSourceBounds != null) {
9411 if (!first) {
9412 b.append(' ');
9413 }
9414 first = false;
9415 b.append("bnds=").append(mSourceBounds.toShortString());
9416 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009417 if (mClipData != null) {
9418 if (!first) {
9419 b.append(' ');
9420 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009421 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009422 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009423 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009424 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009425 if (mClipData.getDescription() != null) {
9426 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9427 } else {
9428 first = true;
9429 }
9430 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009431 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009432 first = false;
9433 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009434 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009435 if (extras && mExtras != null) {
9436 if (!first) {
9437 b.append(' ');
9438 }
9439 first = false;
9440 b.append("(has extras)");
9441 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009442 if (mContentUserHint != UserHandle.USER_CURRENT) {
9443 if (!first) {
9444 b.append(' ');
9445 }
9446 first = false;
9447 b.append("u=").append(mContentUserHint);
9448 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009449 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009450 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009451 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009452 b.append("}");
9453 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009454 }
9455
Yi Jin129fc6c2017-09-28 15:48:38 -07009456 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009457 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9458 // Same input parameters that toString() gives to toShortString().
9459 writeToProto(proto, fieldId, true, true, true, false);
9460 }
9461
9462 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009463 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9464 boolean extras, boolean clip) {
9465 long token = proto.start(fieldId);
9466 if (mAction != null) {
9467 proto.write(IntentProto.ACTION, mAction);
9468 }
9469 if (mCategories != null) {
9470 for (String category : mCategories) {
9471 proto.write(IntentProto.CATEGORIES, category);
9472 }
9473 }
9474 if (mData != null) {
9475 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9476 }
9477 if (mType != null) {
9478 proto.write(IntentProto.TYPE, mType);
9479 }
9480 if (mFlags != 0) {
9481 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9482 }
9483 if (mPackage != null) {
9484 proto.write(IntentProto.PACKAGE, mPackage);
9485 }
9486 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009487 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009488 }
9489 if (mSourceBounds != null) {
9490 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9491 }
9492 if (mClipData != null) {
9493 StringBuilder b = new StringBuilder();
9494 if (clip) {
9495 mClipData.toShortString(b);
9496 } else {
9497 mClipData.toShortStringShortItems(b, false);
9498 }
9499 proto.write(IntentProto.CLIP_DATA, b.toString());
9500 }
9501 if (extras && mExtras != null) {
9502 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9503 }
9504 if (mContentUserHint != 0) {
9505 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9506 }
9507 if (mSelector != null) {
9508 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9509 }
9510 proto.end(token);
9511 }
9512
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009513 /**
9514 * Call {@link #toUri} with 0 flags.
9515 * @deprecated Use {@link #toUri} instead.
9516 */
9517 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009518 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009519 return toUri(0);
9520 }
9521
9522 /**
9523 * Convert this Intent into a String holding a URI representation of it.
9524 * The returned URI string has been properly URI encoded, so it can be
9525 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9526 * Intent's data as the base URI, with an additional fragment describing
9527 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009528 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009529 * <p>You can convert the returned string back to an Intent with
9530 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009531 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009532 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009533 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009534 * @return Returns a URI encoding URI string describing the entire contents
9535 * of the Intent.
9536 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009537 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009538 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009539 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9540 if (mPackage == null) {
9541 throw new IllegalArgumentException(
9542 "Intent must include an explicit package name to build an android-app: "
9543 + this);
9544 }
9545 uri.append("android-app://");
9546 uri.append(mPackage);
9547 String scheme = null;
9548 if (mData != null) {
9549 scheme = mData.getScheme();
9550 if (scheme != null) {
9551 uri.append('/');
9552 uri.append(scheme);
9553 String authority = mData.getEncodedAuthority();
9554 if (authority != null) {
9555 uri.append('/');
9556 uri.append(authority);
9557 String path = mData.getEncodedPath();
9558 if (path != null) {
9559 uri.append(path);
9560 }
9561 String queryParams = mData.getEncodedQuery();
9562 if (queryParams != null) {
9563 uri.append('?');
9564 uri.append(queryParams);
9565 }
9566 String fragment = mData.getEncodedFragment();
9567 if (fragment != null) {
9568 uri.append('#');
9569 uri.append(fragment);
9570 }
9571 }
9572 }
9573 }
9574 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9575 mPackage, flags);
9576 return uri.toString();
9577 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009578 String scheme = null;
9579 if (mData != null) {
9580 String data = mData.toString();
9581 if ((flags&URI_INTENT_SCHEME) != 0) {
9582 final int N = data.length();
9583 for (int i=0; i<N; i++) {
9584 char c = data.charAt(i);
9585 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009586 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009587 continue;
9588 }
9589 if (c == ':' && i > 0) {
9590 // Valid scheme.
9591 scheme = data.substring(0, i);
9592 uri.append("intent:");
9593 data = data.substring(i+1);
9594 break;
9595 }
Tom Taylord4a47292009-12-21 13:59:18 -08009596
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009597 // No scheme.
9598 break;
9599 }
9600 }
9601 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009602
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009603 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9604 uri.append("intent:");
9605 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009606
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009607 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009608
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009609 return uri.toString();
9610 }
9611
9612 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9613 String defPackage, int flags) {
9614 StringBuilder frag = new StringBuilder(128);
9615
9616 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009617 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009618 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009619 // Note that for now we are not going to try to handle the
9620 // data part; not clear how to represent this as a URI, and
9621 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009622 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9623 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009624 }
9625
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009626 if (frag.length() > 0) {
9627 uri.append("#Intent;");
9628 uri.append(frag);
9629 uri.append("end");
9630 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009631 }
9632
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009633 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9634 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009635 if (scheme != null) {
9636 uri.append("scheme=").append(scheme).append(';');
9637 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009638 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009639 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009640 }
9641 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009642 for (int i=0; i<mCategories.size(); i++) {
9643 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009644 }
9645 }
9646 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009647 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009648 }
9649 if (mFlags != 0) {
9650 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9651 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009652 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009653 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9654 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009655 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009656 uri.append("component=").append(Uri.encode(
9657 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009658 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009659 if (mSourceBounds != null) {
9660 uri.append("sourceBounds=")
9661 .append(Uri.encode(mSourceBounds.flattenToString()))
9662 .append(';');
9663 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009664 if (mExtras != null) {
9665 for (String key : mExtras.keySet()) {
9666 final Object value = mExtras.get(key);
9667 char entryType =
9668 value instanceof String ? 'S' :
9669 value instanceof Boolean ? 'B' :
9670 value instanceof Byte ? 'b' :
9671 value instanceof Character ? 'c' :
9672 value instanceof Double ? 'd' :
9673 value instanceof Float ? 'f' :
9674 value instanceof Integer ? 'i' :
9675 value instanceof Long ? 'l' :
9676 value instanceof Short ? 's' :
9677 '\0';
9678
9679 if (entryType != '\0') {
9680 uri.append(entryType);
9681 uri.append('.');
9682 uri.append(Uri.encode(key));
9683 uri.append('=');
9684 uri.append(Uri.encode(value.toString()));
9685 uri.append(';');
9686 }
9687 }
9688 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009689 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009691 public int describeContents() {
9692 return (mExtras != null) ? mExtras.describeContents() : 0;
9693 }
9694
9695 public void writeToParcel(Parcel out, int flags) {
9696 out.writeString(mAction);
9697 Uri.writeToParcel(out, mData);
9698 out.writeString(mType);
9699 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009700 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009701 ComponentName.writeToParcel(mComponent, out);
9702
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009703 if (mSourceBounds != null) {
9704 out.writeInt(1);
9705 mSourceBounds.writeToParcel(out, flags);
9706 } else {
9707 out.writeInt(0);
9708 }
9709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009710 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009711 final int N = mCategories.size();
9712 out.writeInt(N);
9713 for (int i=0; i<N; i++) {
9714 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009715 }
9716 } else {
9717 out.writeInt(0);
9718 }
9719
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009720 if (mSelector != null) {
9721 out.writeInt(1);
9722 mSelector.writeToParcel(out, flags);
9723 } else {
9724 out.writeInt(0);
9725 }
9726
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009727 if (mClipData != null) {
9728 out.writeInt(1);
9729 mClipData.writeToParcel(out, flags);
9730 } else {
9731 out.writeInt(0);
9732 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009733 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009734 out.writeBundle(mExtras);
9735 }
9736
9737 public static final Parcelable.Creator<Intent> CREATOR
9738 = new Parcelable.Creator<Intent>() {
9739 public Intent createFromParcel(Parcel in) {
9740 return new Intent(in);
9741 }
9742 public Intent[] newArray(int size) {
9743 return new Intent[size];
9744 }
9745 };
9746
Dianne Hackborneb034652009-09-07 00:49:58 -07009747 /** @hide */
9748 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009749 readFromParcel(in);
9750 }
9751
9752 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009753 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009754 mData = Uri.CREATOR.createFromParcel(in);
9755 mType = in.readString();
9756 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009757 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009758 mComponent = ComponentName.readFromParcel(in);
9759
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009760 if (in.readInt() != 0) {
9761 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9762 }
9763
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009764 int N = in.readInt();
9765 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009766 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009767 int i;
9768 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009769 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009770 }
9771 } else {
9772 mCategories = null;
9773 }
9774
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009775 if (in.readInt() != 0) {
9776 mSelector = new Intent(in);
9777 }
9778
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009779 if (in.readInt() != 0) {
9780 mClipData = new ClipData(in);
9781 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009782 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009783 mExtras = in.readBundle();
9784 }
9785
9786 /**
9787 * Parses the "intent" element (and its children) from XML and instantiates
9788 * an Intent object. The given XML parser should be located at the tag
9789 * where parsing should start (often named "intent"), from which the
9790 * basic action, data, type, and package and class name will be
9791 * retrieved. The function will then parse in to any child elements,
9792 * looking for <category android:name="xxx"> tags to add categories and
9793 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9794 * to the intent.
9795 *
9796 * @param resources The Resources to use when inflating resources.
9797 * @param parser The XML parser pointing at an "intent" tag.
9798 * @param attrs The AttributeSet interface for retrieving extended
9799 * attribute data at the current <var>parser</var> location.
9800 * @return An Intent object matching the XML data.
9801 * @throws XmlPullParserException If there was an XML parsing error.
9802 * @throws IOException If there was an I/O error.
9803 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009804 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9805 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009806 throws XmlPullParserException, IOException {
9807 Intent intent = new Intent();
9808
9809 TypedArray sa = resources.obtainAttributes(attrs,
9810 com.android.internal.R.styleable.Intent);
9811
9812 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9813
9814 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9815 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9816 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9817
9818 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9819 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9820 if (packageName != null && className != null) {
9821 intent.setComponent(new ComponentName(packageName, className));
9822 }
9823
9824 sa.recycle();
9825
9826 int outerDepth = parser.getDepth();
9827 int type;
9828 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9829 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9830 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9831 continue;
9832 }
9833
9834 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009835 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009836 sa = resources.obtainAttributes(attrs,
9837 com.android.internal.R.styleable.IntentCategory);
9838 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9839 sa.recycle();
9840
9841 if (cat != null) {
9842 intent.addCategory(cat);
9843 }
9844 XmlUtils.skipCurrentTag(parser);
9845
Craig Mautner21d24a22014-04-23 11:45:37 -07009846 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009847 if (intent.mExtras == null) {
9848 intent.mExtras = new Bundle();
9849 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009850 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009851 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009852
9853 } else {
9854 XmlUtils.skipCurrentTag(parser);
9855 }
9856 }
9857
9858 return intent;
9859 }
Nick Pellyccae4122012-01-09 14:12:58 -08009860
Craig Mautner21d24a22014-04-23 11:45:37 -07009861 /** @hide */
9862 public void saveToXml(XmlSerializer out) throws IOException {
9863 if (mAction != null) {
9864 out.attribute(null, ATTR_ACTION, mAction);
9865 }
9866 if (mData != null) {
9867 out.attribute(null, ATTR_DATA, mData.toString());
9868 }
9869 if (mType != null) {
9870 out.attribute(null, ATTR_TYPE, mType);
9871 }
9872 if (mComponent != null) {
9873 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9874 }
9875 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9876
9877 if (mCategories != null) {
9878 out.startTag(null, TAG_CATEGORIES);
9879 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9880 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9881 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009882 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009883 }
9884 }
9885
9886 /** @hide */
9887 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9888 XmlPullParserException {
9889 Intent intent = new Intent();
9890 final int outerDepth = in.getDepth();
9891
9892 int attrCount = in.getAttributeCount();
9893 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9894 final String attrName = in.getAttributeName(attrNdx);
9895 final String attrValue = in.getAttributeValue(attrNdx);
9896 if (ATTR_ACTION.equals(attrName)) {
9897 intent.setAction(attrValue);
9898 } else if (ATTR_DATA.equals(attrName)) {
9899 intent.setData(Uri.parse(attrValue));
9900 } else if (ATTR_TYPE.equals(attrName)) {
9901 intent.setType(attrValue);
9902 } else if (ATTR_COMPONENT.equals(attrName)) {
9903 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9904 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009905 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009906 } else {
9907 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9908 }
9909 }
9910
9911 int event;
9912 String name;
9913 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9914 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9915 if (event == XmlPullParser.START_TAG) {
9916 name = in.getName();
9917 if (TAG_CATEGORIES.equals(name)) {
9918 attrCount = in.getAttributeCount();
9919 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9920 intent.addCategory(in.getAttributeValue(attrNdx));
9921 }
9922 } else {
9923 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9924 XmlUtils.skipCurrentTag(in);
9925 }
9926 }
9927 }
9928
9929 return intent;
9930 }
9931
Nick Pellyccae4122012-01-09 14:12:58 -08009932 /**
9933 * Normalize a MIME data type.
9934 *
9935 * <p>A normalized MIME type has white-space trimmed,
9936 * content-type parameters removed, and is lower-case.
9937 * This aligns the type with Android best practices for
9938 * intent filtering.
9939 *
9940 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9941 * "text/x-vCard" becomes "text/x-vcard".
9942 *
9943 * <p>All MIME types received from outside Android (such as user input,
9944 * or external sources like Bluetooth, NFC, or the Internet) should
9945 * be normalized before they are used to create an Intent.
9946 *
9947 * @param type MIME data type to normalize
9948 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009949 * @see #setType
9950 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009951 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009952 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009953 if (type == null) {
9954 return null;
9955 }
9956
Elliott Hughescb64d432013-08-02 10:00:44 -07009957 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009958
9959 final int semicolonIndex = type.indexOf(';');
9960 if (semicolonIndex != -1) {
9961 type = type.substring(0, semicolonIndex);
9962 }
9963 return type;
9964 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009965
9966 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009967 * Prepare this {@link Intent} to leave an app process.
9968 *
9969 * @hide
9970 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009971 public void prepareToLeaveProcess(Context context) {
9972 final boolean leavingPackage = (mComponent == null)
9973 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9974 prepareToLeaveProcess(leavingPackage);
9975 }
9976
9977 /**
9978 * Prepare this {@link Intent} to leave an app process.
9979 *
9980 * @hide
9981 */
9982 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009983 setAllowFds(false);
9984
9985 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009986 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009987 }
9988 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009989 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009990 }
9991
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -07009992 if (mExtras != null && !mExtras.isParcelled()) {
9993 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
9994 if (intent instanceof Intent) {
9995 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
9996 }
9997 }
9998
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009999 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10000 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010001 switch (mAction) {
10002 case ACTION_MEDIA_REMOVED:
10003 case ACTION_MEDIA_UNMOUNTED:
10004 case ACTION_MEDIA_CHECKING:
10005 case ACTION_MEDIA_NOFS:
10006 case ACTION_MEDIA_MOUNTED:
10007 case ACTION_MEDIA_SHARED:
10008 case ACTION_MEDIA_UNSHARED:
10009 case ACTION_MEDIA_BAD_REMOVAL:
10010 case ACTION_MEDIA_UNMOUNTABLE:
10011 case ACTION_MEDIA_EJECT:
10012 case ACTION_MEDIA_SCANNER_STARTED:
10013 case ACTION_MEDIA_SCANNER_FINISHED:
10014 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010015 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10016 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010017 // Ignore legacy actions
10018 break;
10019 default:
10020 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010021 }
10022 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010023
10024 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10025 && leavingPackage) {
10026 switch (mAction) {
10027 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010028 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010029 // Ignore actions that don't need to grant
10030 break;
10031 default:
10032 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10033 }
10034 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010035 }
10036
10037 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010038 * @hide
10039 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010040 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010041 // We just entered destination process, so we should be able to read all
10042 // parcelables inside.
10043 setDefusable(true);
10044
10045 if (mSelector != null) {
10046 mSelector.prepareToEnterProcess();
10047 }
10048 if (mClipData != null) {
10049 mClipData.prepareToEnterProcess();
10050 }
10051
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010052 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010053 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10054 fixUris(mContentUserHint);
10055 mContentUserHint = UserHandle.USER_CURRENT;
10056 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010057 }
10058 }
10059
Patrick Baumann577d4022018-01-31 16:55:10 +000010060 /** @hide */
10061 public boolean hasWebURI() {
10062 if (getData() == null) {
10063 return false;
10064 }
10065 final String scheme = getScheme();
10066 if (TextUtils.isEmpty(scheme)) {
10067 return false;
10068 }
10069 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10070 }
10071
10072 /** @hide */
10073 public boolean isBrowsableWebIntent() {
10074 return ACTION_VIEW.equals(mAction)
10075 && hasCategory(CATEGORY_BROWSABLE)
10076 && hasWebURI();
10077 }
10078
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010079 /**
10080 * @hide
10081 */
10082 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010083 Uri data = getData();
10084 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010085 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010086 }
10087 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010088 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010089 }
10090 String action = getAction();
10091 if (ACTION_SEND.equals(action)) {
10092 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10093 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010094 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010095 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010096 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010097 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10098 if (streams != null) {
10099 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10100 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010101 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010102 }
10103 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10104 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010105 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10106 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10107 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10108 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10109 if (output != null) {
10110 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10111 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010112 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010113 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010114
10115 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010116 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010117 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10118 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010119 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010120 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010121 * @hide
10122 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010123 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010124 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010125 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010126
10127 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010128 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010129
10130 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010131 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010132 // Inspect contained intents to see if we need to migrate extras. We
10133 // don't promote ClipData to the parent, since ChooserActivity will
10134 // already start the picked item as the caller, and we can't combine
10135 // the flags in a safe way.
10136
10137 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010138 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010139 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10140 if (intent != null) {
10141 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010142 }
10143 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010144 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010145 try {
10146 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10147 if (intents != null) {
10148 for (int i = 0; i < intents.length; i++) {
10149 final Intent intent = (Intent) intents[i];
10150 if (intent != null) {
10151 migrated |= intent.migrateExtraStreamToClipData();
10152 }
10153 }
10154 }
10155 } catch (ClassCastException e) {
10156 }
10157 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010158
10159 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010160 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010161 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10162 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10163 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10164 if (stream != null || text != null || htmlText != null) {
10165 final ClipData clipData = new ClipData(
10166 null, new String[] { getType() },
10167 new ClipData.Item(text, htmlText, null, stream));
10168 setClipData(clipData);
10169 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010170 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010171 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010172 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010173 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010174
10175 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010176 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010177 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10178 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10179 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10180 int num = -1;
10181 if (streams != null) {
10182 num = streams.size();
10183 }
10184 if (texts != null) {
10185 if (num >= 0 && num != texts.size()) {
10186 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010187 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010188 }
10189 num = texts.size();
10190 }
10191 if (htmlTexts != null) {
10192 if (num >= 0 && num != htmlTexts.size()) {
10193 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010194 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010195 }
10196 num = htmlTexts.size();
10197 }
10198 if (num > 0) {
10199 final ClipData clipData = new ClipData(
10200 null, new String[] { getType() },
10201 makeClipItem(streams, texts, htmlTexts, 0));
10202
10203 for (int i = 1; i < num; i++) {
10204 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10205 }
10206
10207 setClipData(clipData);
10208 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010209 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010210 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010211 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010212 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010213 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10214 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10215 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10216 final Uri output;
10217 try {
10218 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10219 } catch (ClassCastException e) {
10220 return false;
10221 }
10222 if (output != null) {
10223 setClipData(ClipData.newRawUri("", output));
10224 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10225 return true;
10226 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010227 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010228
10229 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010230 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010231
Michael Wright19859762017-09-18 20:57:58 +010010232 /**
10233 * Convert the dock state to a human readable format.
10234 * @hide
10235 */
10236 public static String dockStateToString(int dock) {
10237 switch (dock) {
10238 case EXTRA_DOCK_STATE_HE_DESK:
10239 return "EXTRA_DOCK_STATE_HE_DESK";
10240 case EXTRA_DOCK_STATE_LE_DESK:
10241 return "EXTRA_DOCK_STATE_LE_DESK";
10242 case EXTRA_DOCK_STATE_CAR:
10243 return "EXTRA_DOCK_STATE_CAR";
10244 case EXTRA_DOCK_STATE_DESK:
10245 return "EXTRA_DOCK_STATE_DESK";
10246 case EXTRA_DOCK_STATE_UNDOCKED:
10247 return "EXTRA_DOCK_STATE_UNDOCKED";
10248 default:
10249 return Integer.toString(dock);
10250 }
10251 }
10252
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010253 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10254 ArrayList<String> htmlTexts, int which) {
10255 Uri uri = streams != null ? streams.get(which) : null;
10256 CharSequence text = texts != null ? texts.get(which) : null;
10257 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10258 return new ClipData.Item(text, htmlText, null, uri);
10259 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010260
10261 /** @hide */
10262 public boolean isDocument() {
10263 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10264 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010265}