blob: 9b62f192ae62c3220d189a5a4ee4c8240747cba1 [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 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001557 * Activity Action: Launch instant application installer.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001558 * <p class="note">
1559 * This is a protected intent that can only be sent by the system.
1560 * </p>
1561 *
1562 * @hide
1563 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001564 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001565 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001566 public static final String ACTION_INSTALL_INSTANT_APP_PACKAGE
1567 = "android.intent.action.INSTALL_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001568
1569 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001570 * Service Action: Resolve instant application.
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001571 * <p>
1572 * The system will have a persistent connection to this service.
1573 * This is a protected intent that can only be sent by the system.
1574 * </p>
1575 *
1576 * @hide
1577 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001578 @SystemApi
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001579 @SdkConstant(SdkConstantType.SERVICE_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001580 public static final String ACTION_RESOLVE_INSTANT_APP_PACKAGE
1581 = "android.intent.action.RESOLVE_INSTANT_APP_PACKAGE";
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001582
1583 /**
Todd Kennedyd46a1602017-04-03 15:22:38 -07001584 * Activity Action: Launch instant app settings.
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001585 *
1586 * <p class="note">
1587 * This is a protected intent that can only be sent by the system.
1588 * </p>
1589 *
1590 * @hide
1591 */
Todd Kennedyd46a1602017-04-03 15:22:38 -07001592 @SystemApi
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001593 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Todd Kennedyd46a1602017-04-03 15:22:38 -07001594 public static final String ACTION_INSTANT_APP_RESOLVER_SETTINGS
1595 = "android.intent.action.INSTANT_APP_RESOLVER_SETTINGS";
Chad Brubaker336ae5b2017-03-24 15:53:09 -07001596
1597 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001598 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1599 * package. Specifies the installer package name; this package will receive the
1600 * {@link #ACTION_APP_ERROR} intent.
1601 */
1602 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1603 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1604
1605 /**
1606 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1607 * package. Specifies that the application being installed should not be
1608 * treated as coming from an unknown source, but as coming from the app
1609 * invoking the Intent. For this to work you must start the installer with
1610 * startActivityForResult().
1611 */
1612 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1613 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1614
1615 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001616 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1617 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001618 * data field originated from.
1619 */
rich cannings706e8ba2012-08-20 13:20:14 -07001620 public static final String EXTRA_ORIGINATING_URI
1621 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001622
1623 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001624 * This extra can be used with any Intent used to launch an activity, supplying information
1625 * about who is launching that activity. This field contains a {@link android.net.Uri}
1626 * object, typically an http: or https: URI of the web site that the referral came from;
1627 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1628 * a native application that it came from.
1629 *
1630 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1631 * instead of directly retrieving the extra. It is also valid for applications to
1632 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1633 * a string, not a Uri; the field here, if supplied, will always take precedence,
1634 * however.</p>
1635 *
1636 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001637 */
1638 public static final String EXTRA_REFERRER
1639 = "android.intent.extra.REFERRER";
1640
1641 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001642 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1643 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1644 * not be created, in particular when Intent extras are supplied through the
1645 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1646 * schemes.
1647 *
1648 * @see #EXTRA_REFERRER
1649 */
1650 public static final String EXTRA_REFERRER_NAME
1651 = "android.intent.extra.REFERRER_NAME";
1652
1653 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001654 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001655 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Suprabh Shukla54a10e62017-04-14 18:17:23 -07001656 * Currently only a system app that hosts the provider authority "downloads" or holds the
1657 * permission {@link android.Manifest.permission.MANAGE_DOCUMENTS} can use this.
Ben Gruver37d83a32012-09-27 13:02:06 -07001658 * @hide
1659 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001660 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001661 public static final String EXTRA_ORIGINATING_UID
1662 = "android.intent.extra.ORIGINATING_UID";
1663
1664 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001665 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1666 * package. Tells the installer UI to skip the confirmation with the user
1667 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001668 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1669 * will no longer show an interstitial message about updating existing
1670 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001671 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001672 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001673 public static final String EXTRA_ALLOW_REPLACE
1674 = "android.intent.extra.ALLOW_REPLACE";
1675
1676 /**
1677 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1678 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1679 * return to the application the result code of the install/uninstall. The returned result
1680 * code will be {@link android.app.Activity#RESULT_OK} on success or
1681 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1682 */
1683 public static final String EXTRA_RETURN_RESULT
1684 = "android.intent.extra.RETURN_RESULT";
1685
1686 /**
1687 * Package manager install result code. @hide because result codes are not
1688 * yet ready to be exposed.
1689 */
1690 public static final String EXTRA_INSTALL_RESULT
1691 = "android.intent.extra.INSTALL_RESULT";
1692
1693 /**
1694 * Activity Action: Launch application uninstaller.
1695 * <p>
1696 * Input: The data must be a package: URI whose scheme specific part is
1697 * the package name of the current installed package to be uninstalled.
1698 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1699 * <p>
1700 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1701 * succeeded.
Philip P. Moltmannd9bb39a2017-09-05 12:41:15 -07001702 * <p>
1703 * Requires {@link android.Manifest.permission#REQUEST_DELETE_PACKAGES}
1704 * since {@link Build.VERSION_CODES#P}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001705 */
1706 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1707 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1708
1709 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001710 * Specify whether the package should be uninstalled for all users.
1711 * @hide because these should not be part of normal application flow.
1712 */
1713 public static final String EXTRA_UNINSTALL_ALL_USERS
1714 = "android.intent.extra.UNINSTALL_ALL_USERS";
1715
1716 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001717 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1718 * describing the last run version of the platform that was setup.
1719 * @hide
1720 */
1721 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1722
Svet Ganov3695b8a2015-03-24 16:30:25 -07001723 /**
1724 * Activity action: Launch UI to manage the permissions of an app.
1725 * <p>
1726 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1727 * will be managed by the launched UI.
1728 * </p>
1729 * <p>
1730 * Output: Nothing.
1731 * </p>
1732 *
1733 * @see #EXTRA_PACKAGE_NAME
1734 *
1735 * @hide
1736 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001737 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001738 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1739 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1740 "android.intent.action.MANAGE_APP_PERMISSIONS";
1741
1742 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001743 * Activity action: Launch UI to manage permissions.
1744 * <p>
1745 * Input: Nothing.
1746 * </p>
1747 * <p>
1748 * Output: Nothing.
1749 * </p>
1750 *
1751 * @hide
1752 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001753 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1755 public static final String ACTION_MANAGE_PERMISSIONS =
1756 "android.intent.action.MANAGE_PERMISSIONS";
1757
1758 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001759 * Activity action: Launch UI to review permissions for an app.
1760 * The system uses this intent if permission review for apps not
1761 * supporting the new runtime permissions model is enabled. In
1762 * this mode a permission review is required before any of the
1763 * app components can run.
1764 * <p>
1765 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1766 * permissions will be reviewed (mandatory).
1767 * </p>
1768 * <p>
1769 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1770 * be fired after the permission review (optional).
1771 * </p>
1772 * <p>
1773 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1774 * be invoked after the permission review (optional).
1775 * </p>
1776 * <p>
1777 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1778 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1779 * </p>
1780 * <p>
1781 * Output: Nothing.
1782 * </p>
1783 *
1784 * @see #EXTRA_PACKAGE_NAME
1785 * @see #EXTRA_INTENT
1786 * @see #EXTRA_REMOTE_CALLBACK
1787 * @see #EXTRA_RESULT_NEEDED
1788 *
1789 * @hide
1790 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001791 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001792 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1793 public static final String ACTION_REVIEW_PERMISSIONS =
1794 "android.intent.action.REVIEW_PERMISSIONS";
1795
1796 /**
1797 * Intent extra: A callback for reporting remote result as a bundle.
1798 * <p>
1799 * Type: IRemoteCallback
1800 * </p>
1801 *
1802 * @hide
1803 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001804 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001805 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1806
1807 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001808 * Intent extra: An app package name.
1809 * <p>
1810 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001811 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001812 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001813 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001814 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1815
1816 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001817 * Intent extra: An app split name.
1818 * <p>
1819 * Type: String
1820 * </p>
Todd Kennedye5195dd2016-10-19 15:29:19 -07001821 */
Todd Kennedye5195dd2016-10-19 15:29:19 -07001822 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1823
1824 /**
Jeff Sharkey1a749422017-04-28 14:19:50 -06001825 * Intent extra: A {@link ComponentName} value.
1826 * <p>
1827 * Type: String
1828 * </p>
1829 */
1830 public static final String EXTRA_COMPONENT_NAME = "android.intent.extra.COMPONENT_NAME";
1831
1832 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001833 * Intent extra: An extra for specifying whether a result is needed.
1834 * <p>
1835 * Type: boolean
1836 * </p>
1837 *
1838 * @hide
1839 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001840 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001841 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1842
1843 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001844 * Activity action: Launch UI to manage which apps have a given permission.
1845 * <p>
1846 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1847 * to which will be managed by the launched UI.
1848 * </p>
1849 * <p>
1850 * Output: Nothing.
1851 * </p>
1852 *
1853 * @see #EXTRA_PERMISSION_NAME
1854 *
1855 * @hide
1856 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001857 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001858 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1859 public static final String ACTION_MANAGE_PERMISSION_APPS =
1860 "android.intent.action.MANAGE_PERMISSION_APPS";
1861
1862 /**
1863 * Intent extra: The name of a permission.
1864 * <p>
1865 * Type: String
1866 * </p>
1867 *
1868 * @hide
1869 */
1870 @SystemApi
1871 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1872
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001873 // ---------------------------------------------------------------------
1874 // ---------------------------------------------------------------------
1875 // Standard intent broadcast actions (see action variable).
1876
1877 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001878 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1879 * <p>
1880 * For historical reasons, the name of this broadcast action refers to the power
1881 * state of the screen but it is actually sent in response to changes in the
1882 * overall interactive state of the device.
1883 * </p><p>
1884 * This broadcast is sent when the device becomes non-interactive which may have
1885 * nothing to do with the screen turning off. To determine the
1886 * actual state of the screen, use {@link android.view.Display#getState}.
1887 * </p><p>
1888 * See {@link android.os.PowerManager#isInteractive} for details.
1889 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001890 * You <em>cannot</em> receive this through components declared in
1891 * manifests, only by explicitly registering for it with
1892 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1893 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001894 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001895 * <p class="note">This is a protected intent that can only be sent
1896 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1899 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001902 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1903 * <p>
1904 * For historical reasons, the name of this broadcast action refers to the power
1905 * state of the screen but it is actually sent in response to changes in the
1906 * overall interactive state of the device.
1907 * </p><p>
1908 * This broadcast is sent when the device becomes interactive which may have
1909 * nothing to do with the screen turning on. To determine the
1910 * actual state of the screen, use {@link android.view.Display#getState}.
1911 * </p><p>
1912 * See {@link android.os.PowerManager#isInteractive} for details.
1913 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001914 * You <em>cannot</em> receive this through components declared in
1915 * manifests, only by explicitly registering for it with
1916 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1917 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001918 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001919 * <p class="note">This is a protected intent that can only be sent
1920 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001924
1925 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001926 * Broadcast Action: Sent after the system stops dreaming.
1927 *
1928 * <p class="note">This is a protected intent that can only be sent by the system.
1929 * It is only sent to registered receivers.</p>
1930 */
1931 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1932 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1933
1934 /**
1935 * Broadcast Action: Sent after the system starts dreaming.
1936 *
1937 * <p class="note">This is a protected intent that can only be sent by the system.
1938 * It is only sent to registered receivers.</p>
1939 */
1940 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1941 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1942
1943 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001944 * 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 -07001945 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001946 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001951 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001952
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 /**
1954 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001955 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001956 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001957 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1958 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001959 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001960 * <p class="note">This is a protected intent that can only be sent
1961 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1965 /**
1966 * Broadcast Action: The time was set.
1967 */
1968 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1969 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1970 /**
1971 * Broadcast Action: The date has changed.
1972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1974 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1975 /**
1976 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1977 * <ul>
1978 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1979 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001980 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001981 * <p class="note">This is a protected intent that can only be sent
1982 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 */
1984 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1985 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1986 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001987 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1988 * DNS entries should be tossed.
1989 * @hide
1990 */
1991 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1992 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1993 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001994 * Alarm Changed Action: This is broadcast when the AlarmClock
1995 * application's alarm is set or unset. It is used by the
1996 * AlarmClock application and the StatusBar service.
1997 * @hide
1998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002001
2002 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002003 * Broadcast Action: This is broadcast once, after the user has finished
2004 * booting, but while still in the "locked" state. It can be used to perform
2005 * application-specific initialization, such as installing alarms. You must
2006 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
2007 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002008 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002009 * This broadcast is sent immediately at boot by all devices (regardless of
2010 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
2011 * higher. Upon receipt of this broadcast, the user is still locked and only
2012 * device-protected storage can be accessed safely. If you want to access
2013 * credential-protected storage, you need to wait for the user to be
2014 * unlocked (typically by entering their lock pattern or PIN for the first
2015 * time), after which the {@link #ACTION_USER_UNLOCKED} and
2016 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
2017 * <p>
2018 * To receive this broadcast, your receiver component must be marked as
2019 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002020 * <p class="note">
2021 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002022 *
2023 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
2027
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002028 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002029 * Broadcast Action: This is broadcast once, after the user has finished
2030 * booting. It can be used to perform application-specific initialization,
2031 * such as installing alarms. You must hold the
2032 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2033 * order to receive this broadcast.
2034 * <p>
2035 * This broadcast is sent at boot by all devices (both with and without
2036 * direct boot support). Upon receipt of this broadcast, the user is
2037 * unlocked and both device-protected and credential-protected storage can
2038 * accessed safely.
2039 * <p>
2040 * If you need to run while the user is still locked (before they've entered
2041 * their lock pattern or PIN for the first time), you can listen for the
2042 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2043 * <p class="note">
2044 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey32ee8ee2017-03-08 20:17:51 -07002047 @BroadcastBehavior(includeBackground = true)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002048 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002049
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002050 /**
2051 * Broadcast Action: This is broadcast when a user action should request a
2052 * temporary system dialog to dismiss. Some examples of temporary system
2053 * dialogs are the notification window-shade and the recent tasks dialog.
2054 */
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002056 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2057 /**
2058 * Broadcast Action: Trigger the download and eventual installation
2059 * of a package.
2060 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002061 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002062 * <p class="note">This is a protected intent that can only be sent
2063 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002064 *
2065 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002066 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002067 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2070 /**
Christopher Tate94b91db2017-04-19 15:49:17 -07002071 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002072 * device. The data contains the name of the package. Note that the
2073 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002074 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002075 * <ul>
Christopher Tate94b91db2017-04-19 15:49:17 -07002076 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2077 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2079 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002080 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002081 * <p class="note">This is a protected intent that can only be sent
2082 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002083 */
2084 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2085 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2086 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002087 * Broadcast Action: A new version of an application package has been
2088 * installed, replacing an existing version that was previously installed.
2089 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002090 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002091 * <ul>
2092 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2093 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002094 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002095 * <p class="note">This is a protected intent that can only be sent
2096 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002097 */
2098 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2099 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2100 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002101 * Broadcast Action: A new version of your application has been installed
2102 * over an existing one. This is only sent to the application that was
2103 * replaced. It does not contain any additional data; to receive it, just
2104 * use an intent filter for this action.
2105 *
2106 * <p class="note">This is a protected intent that can only be sent
2107 * by the system.
2108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2111 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002112 * Broadcast Action: An existing application package has been removed from
2113 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002114 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002115 * <ul>
2116 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2117 * to the package.
2118 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2119 * application -- data and code -- is being removed.
2120 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2121 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2122 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002123 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002124 * <p class="note">This is a protected intent that can only be sent
2125 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002126 */
2127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2129 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002130 * Broadcast Action: An existing application package has been completely
2131 * removed from the device. The data contains the name of the package.
2132 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2133 * {@link #EXTRA_DATA_REMOVED} is true and
2134 * {@link #EXTRA_REPLACING} is false of that broadcast.
2135 *
2136 * <ul>
2137 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2138 * to the package.
2139 * </ul>
2140 *
2141 * <p class="note">This is a protected intent that can only be sent
2142 * by the system.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_FULLY_REMOVED
2146 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2147 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002148 * Broadcast Action: An existing application package has been changed (for
2149 * example, a component has been enabled or disabled). The data contains
2150 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002151 * <ul>
2152 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002153 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002154 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002155 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2156 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002157 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002158 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002159 * <p class="note">This is a protected intent that can only be sent
2160 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002161 */
2162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2163 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2164 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002165 * @hide
2166 * Broadcast Action: Ask system services if there is any reason to
2167 * restart the given package. The data contains the name of the
2168 * package.
2169 * <ul>
2170 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2171 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2172 * </ul>
2173 *
2174 * <p class="note">This is a protected intent that can only be sent
2175 * by the system.
2176 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002177 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2180 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002181 * Broadcast Action: The user has restarted a package, and all of its
2182 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002183 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002184 * be removed. Note that the restarted package does <em>not</em>
2185 * receive this broadcast.
2186 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002187 * <ul>
2188 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2189 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002190 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002191 * <p class="note">This is a protected intent that can only be sent
2192 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002193 */
2194 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2195 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2196 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002197 * Broadcast Action: The user has cleared the data of a package. This should
2198 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002199 * its persistent data is erased and this broadcast sent.
2200 * Note that the cleared package does <em>not</em>
2201 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002202 * <ul>
Svet Ganovf935a702017-08-22 12:15:58 -07002203 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package. If the
2204 * package whose data was cleared is an uninstalled instant app, then the UID
2205 * will be -1. The platform keeps some meta-data associated with instant apps
2206 * after they are uninstalled.
2207 * <li> {@link #EXTRA_PACKAGE_NAME} containing the package name only if the cleared
2208 * data was for an instant app.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002209 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002210 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002211 * <p class="note">This is a protected intent that can only be sent
2212 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002213 */
2214 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2215 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2216 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002217 * Broadcast Action: Packages have been suspended.
2218 * <p>Includes the following extras:
2219 * <ul>
2220 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2221 * </ul>
2222 *
2223 * <p class="note">This is a protected intent that can only be sent
2224 * by the system. It is only sent to registered receivers.
2225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2227 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2228 /**
2229 * Broadcast Action: Packages have been unsuspended.
2230 * <p>Includes the following extras:
2231 * <ul>
2232 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2233 * </ul>
2234 *
2235 * <p class="note">This is a protected intent that can only be sent
2236 * by the system. It is only sent to registered receivers.
2237 */
2238 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2239 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002241 * Broadcast Action: A user ID has been removed from the system. The user
2242 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002243 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002244 * <p class="note">This is a protected intent that can only be sent
2245 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002249
2250 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002251 * Broadcast Action: Sent to the installer package of an application when
2252 * that application is first launched (that is the first time it is moved
2253 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002254 *
2255 * <p class="note">This is a protected intent that can only be sent
2256 * by the system.
2257 */
2258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2259 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2260
2261 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002262 * Broadcast Action: Sent to the system package verifier when a package
2263 * needs to be verified. The data contains the package URI.
2264 * <p class="note">
2265 * This is a protected intent that can only be sent by the system.
2266 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002267 */
2268 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2269 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2270
2271 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002272 * Broadcast Action: Sent to the system package verifier when a package is
2273 * verified. The data contains the package URI.
2274 * <p class="note">
2275 * This is a protected intent that can only be sent by the system.
2276 */
2277 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2278 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2279
2280 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002281 * Broadcast Action: Sent to the system intent filter verifier when an
2282 * intent filter needs to be verified. The data contains the filter data
2283 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002284 * <p class="note">
2285 * This is a protected intent that can only be sent by the system.
2286 * </p>
2287 *
2288 * @hide
2289 */
2290 @SystemApi
2291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2292 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2293
2294 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002295 * Broadcast Action: Resources for a set of packages (which were
2296 * previously unavailable) are currently
2297 * available since the media on which they exist is available.
2298 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2299 * list of packages whose availability changed.
2300 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2301 * list of uids of packages whose availability changed.
2302 * Note that the
2303 * packages in this list do <em>not</em> receive this broadcast.
2304 * The specified set of packages are now available on the system.
2305 * <p>Includes the following extras:
2306 * <ul>
2307 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2308 * whose resources(were previously unavailable) are currently available.
2309 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2310 * packages whose resources(were previously unavailable)
2311 * are currently available.
2312 * </ul>
2313 *
2314 * <p class="note">This is a protected intent that can only be sent
2315 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002316 */
2317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002318 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2319 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002320
2321 /**
2322 * Broadcast Action: Resources for a set of packages are currently
2323 * unavailable since the media on which they exist is unavailable.
2324 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2325 * list of packages whose availability changed.
2326 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2327 * list of uids of packages whose availability changed.
2328 * The specified set of packages can no longer be
2329 * launched and are practically unavailable on the system.
2330 * <p>Inclues the following extras:
2331 * <ul>
2332 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2333 * whose resources are no longer available.
2334 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2335 * whose resources are no longer available.
2336 * </ul>
2337 *
2338 * <p class="note">This is a protected intent that can only be sent
2339 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002340 */
2341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002342 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002343 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002344
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002345 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002346 * Broadcast Action: preferred activities have changed *explicitly*.
2347 *
2348 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2349 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2350 * be sent.
2351 *
2352 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2353 *
2354 * @hide
2355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2358 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2359
2360
2361 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002362 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002363 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002364 * This should <em>only</em> be used to determine when the wallpaper
2365 * has changed to show the new wallpaper to the user. You should certainly
2366 * never, in response to this, change the wallpaper or other attributes of
2367 * it such as the suggested size. That would be crazy, right? You'd cause
2368 * all kinds of loops, especially if other apps are doing similar things,
2369 * right? Of course. So please don't do this.
2370 *
2371 * @deprecated Modern applications should use
2372 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2373 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2374 * shown behind their UI, rather than watching for this broadcast and
2375 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002376 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002377 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002378 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2379 /**
2380 * Broadcast Action: The current device {@link android.content.res.Configuration}
2381 * (orientation, locale, etc) has changed. When such a change happens, the
2382 * UIs (view hierarchy) will need to be rebuilt based on this new
2383 * information; for the most part, applications don't need to worry about
2384 * this, because the system will take care of stopping and restarting the
2385 * application to make sure it sees the new changes. Some system code that
2386 * can not be restarted will need to watch for this action and handle it
2387 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002388 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002389 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002390 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002391 * in manifests, only by explicitly registering for it with
2392 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2393 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002394 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002395 * <p class="note">This is a protected intent that can only be sent
2396 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397 *
2398 * @see android.content.res.Configuration
2399 */
2400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2401 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2402 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002403 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002404 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002405 * <p class="note">This is a protected intent that can only be sent
2406 * by the system.
2407 */
2408 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2409 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2410 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002411 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2412 * charging state, level, and other information about the battery.
2413 * See {@link android.os.BatteryManager} for documentation on the
2414 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002415 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002416 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002417 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002418 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002419 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002420 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2421 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2422 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2423 * broadcasts that are sent and can be received through manifest
2424 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002425 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002426 * <p class="note">This is a protected intent that can only be sent
2427 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002428 */
2429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2430 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2431 /**
2432 * Broadcast Action: Indicates low battery condition on the device.
2433 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002434 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002435 * <p class="note">This is a protected intent that can only be sent
2436 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2440 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002441 * Broadcast Action: Indicates the battery is now okay after being low.
2442 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2443 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002444 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002445 * <p class="note">This is a protected intent that can only be sent
2446 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002447 */
2448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2449 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2450 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002451 * Broadcast Action: External power has been connected to the device.
2452 * This is intended for applications that wish to register specifically to this notification.
2453 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2454 * stay active to receive this notification. This action can be used to implement actions
2455 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002456 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002457 * <p class="note">This is a protected intent that can only be sent
2458 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002459 */
2460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002461 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002462 /**
2463 * Broadcast Action: External power has been removed from the device.
2464 * This is intended for applications that wish to register specifically to this notification.
2465 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2466 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002467 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002468 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002469 * <p class="note">This is a protected intent that can only be sent
2470 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002471 */
2472 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002473 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002474 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002475 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002476 * Broadcast Action: Device is shutting down.
2477 * This is broadcast when the device is being shut down (completely turned
2478 * off, not sleeping). Once the broadcast is complete, the final shutdown
2479 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002480 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002481 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002482 * <p class="note">This is a protected intent that can only be sent
2483 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002484 * <p>May include the following extras:
2485 * <ul>
2486 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2487 * shutdown is only for userspace processes. If not set, assumed to be false.
2488 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002489 */
2490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002491 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002492 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002493 * Activity Action: Start this activity to request system shutdown.
2494 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002495 * to request confirmation from the user before shutting down. The optional boolean
2496 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2497 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002498 *
2499 * <p class="note">This is a protected intent that can only be sent
2500 * by the system.
2501 *
2502 * {@hide}
2503 */
Sudheer Shanka218190a2017-03-30 16:07:54 -07002504 public static final String ACTION_REQUEST_SHUTDOWN
2505 = "com.android.internal.intent.action.REQUEST_SHUTDOWN";
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002506 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002507 * Broadcast Action: A sticky broadcast that indicates low storage space
Dianne Hackbornedd93162009-09-19 14:03:05 -07002508 * condition on the device
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002509 * <p class="note">
2510 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002511 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002512 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2513 * or above, this broadcast will no longer be delivered to any
2514 * {@link BroadcastReceiver} defined in your manifest. Instead,
2515 * apps are strongly encouraged to use the improved
2516 * {@link Context#getCacheDir()} behavior so the system can
2517 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002518 */
2519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002520 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002521 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2522 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002523 * Broadcast Action: Indicates low storage space condition on the device no
2524 * longer exists
2525 * <p class="note">
2526 * This is a protected intent that can only be sent by the system.
Tom Taylord4a47292009-12-21 13:59:18 -08002527 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002528 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2529 * or above, this broadcast will no longer be delivered to any
2530 * {@link BroadcastReceiver} defined in your manifest. Instead,
2531 * apps are strongly encouraged to use the improved
2532 * {@link Context#getCacheDir()} behavior so the system can
2533 * automatically free up storage when needed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 */
2535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002536 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002537 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2538 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002539 * Broadcast Action: A sticky broadcast that indicates a storage space full
2540 * condition on the device. This is intended for activities that want to be
2541 * able to fill the data partition completely, leaving only enough free
2542 * space to prevent system-wide SQLite failures.
2543 * <p class="note">
2544 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002545 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002546 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2547 * or above, this broadcast will no longer be delivered to any
2548 * {@link BroadcastReceiver} defined in your manifest. Instead,
2549 * apps are strongly encouraged to use the improved
2550 * {@link Context#getCacheDir()} behavior so the system can
2551 * automatically free up storage when needed.
2552 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002555 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002556 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2557 /**
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002558 * Broadcast Action: Indicates storage space full condition on the device no
2559 * longer exists.
2560 * <p class="note">
2561 * This is a protected intent that can only be sent by the system.
Jake Hambybb371632010-08-23 18:16:48 -07002562 *
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002563 * @deprecated if your app targets {@link android.os.Build.VERSION_CODES#O}
2564 * or above, this broadcast will no longer be delivered to any
2565 * {@link BroadcastReceiver} defined in your manifest. Instead,
2566 * apps are strongly encouraged to use the improved
2567 * {@link Context#getCacheDir()} behavior so the system can
2568 * automatically free up storage when needed.
2569 * @hide
Jake Hambybb371632010-08-23 18:16:48 -07002570 */
2571 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey179d6b32017-03-12 17:27:47 -06002572 @Deprecated
Jake Hambybb371632010-08-23 18:16:48 -07002573 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2574 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002575 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2576 * and package management should be started.
2577 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2578 * notification.
2579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2581 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2582 /**
2583 * Broadcast Action: The device has entered USB Mass Storage mode.
2584 * This is used mainly for the USB Settings panel.
2585 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2586 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002587 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002588 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002589 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002591 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2592
2593 /**
2594 * Broadcast Action: The device has exited USB Mass Storage mode.
2595 * This is used mainly for the USB Settings panel.
2596 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2597 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002598 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002599 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002600 @Deprecated
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -06002601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002602 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2603
2604 /**
2605 * Broadcast Action: External media has been removed.
2606 * The path to the mount point for the removed media is contained in the Intent.mData field.
2607 */
2608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2609 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2610
2611 /**
2612 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002613 * 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 -07002614 */
2615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2616 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2617
2618 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002619 * Broadcast Action: External media is present, and being disk-checked
2620 * 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 -08002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2623 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2624
2625 /**
2626 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2627 * 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 -08002628 */
2629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2630 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2631
2632 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002633 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002634 * 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 -07002635 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2636 * media was mounted read only.
2637 */
2638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2639 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2640
2641 /**
2642 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002643 * 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 -07002644 */
2645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2646 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2647
2648 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002649 * Broadcast Action: External media is no longer being shared via USB mass storage.
2650 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2651 *
2652 * @hide
2653 */
2654 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2655
2656 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002657 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2658 * The path to the mount point for the removed media is contained in the Intent.mData field.
2659 */
2660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2661 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2662
2663 /**
2664 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002665 * 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 -07002666 */
2667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2668 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2669
2670 /**
2671 * Broadcast Action: User has expressed the desire to remove the external storage media.
2672 * Applications should close all files they have open within the mount point when they receive this intent.
2673 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2674 */
2675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2676 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2677
2678 /**
2679 * Broadcast Action: The media scanner has started scanning a directory.
2680 * The path to the directory being scanned is contained in the Intent.mData field.
2681 */
2682 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2683 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2684
2685 /**
2686 * Broadcast Action: The media scanner has finished scanning a directory.
2687 * The path to the scanned directory is contained in the Intent.mData field.
2688 */
2689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2690 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2691
2692 /**
2693 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2694 * The path to the file is contained in the Intent.mData field.
2695 */
2696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2697 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2698
2699 /**
2700 * Broadcast Action: The "Media Button" was pressed. Includes a single
2701 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2702 * caused the broadcast.
2703 */
2704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2705 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2706
2707 /**
2708 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2709 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2710 * caused the broadcast.
2711 */
2712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2713 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2714
2715 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2716 // location; they are not general-purpose actions.
2717
2718 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002719 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 */
2721 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2722 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2723 "android.intent.action.GTALK_CONNECTED";
2724
2725 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002726 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002727 */
2728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2729 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2730 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002731
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002732 /**
2733 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002734 */
2735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2736 public static final String ACTION_INPUT_METHOD_CHANGED =
2737 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738
2739 /**
2740 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2741 * more radios have been turned off or on. The intent will have the following extra value:</p>
2742 * <ul>
2743 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2744 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2745 * turned off</li>
2746 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002747 *
Peng Xua35b5532016-01-20 00:05:45 -08002748 * <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 -07002749 */
2750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2751 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2752
2753 /**
2754 * Broadcast Action: Some content providers have parts of their namespace
2755 * where they publish new events or items that the user may be especially
2756 * interested in. For these things, they may broadcast this action when the
2757 * set of interesting items change.
2758 *
2759 * For example, GmailProvider sends this notification when the set of unread
2760 * mail in the inbox changes.
2761 *
2762 * <p>The data of the intent identifies which part of which provider
2763 * changed. When queried through the content resolver, the data URI will
2764 * return the data set in question.
2765 *
2766 * <p>The intent will have the following extra values:
2767 * <ul>
2768 * <li><em>count</em> - The number of items in the data set. This is the
2769 * same as the number of items in the cursor returned by querying the
2770 * data URI. </li>
2771 * </ul>
2772 *
2773 * This intent will be sent at boot (if the count is non-zero) and when the
2774 * data set changes. It is possible for the data set to change without the
2775 * count changing (for example, if a new unread message arrives in the same
2776 * sync operation in which a message is archived). The phone should still
2777 * ring/vibrate/etc as normal in this case.
2778 */
2779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2780 public static final String ACTION_PROVIDER_CHANGED =
2781 "android.intent.action.PROVIDER_CHANGED";
2782
2783 /**
2784 * Broadcast Action: Wired Headset plugged in or unplugged.
2785 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002786 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2787 * and documentation.
2788 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002789 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002790 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002791 */
2792 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002793 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002794
2795 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002796 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2797 * <ul>
2798 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2799 * </ul>
2800 *
2801 * <p class="note">This is a protected intent that can only be sent
2802 * by the system.
2803 *
2804 * @hide
2805 */
2806 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2807 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2808 = "android.intent.action.ADVANCED_SETTINGS";
2809
2810 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002811 * Broadcast Action: Sent after application restrictions are changed.
2812 *
2813 * <p class="note">This is a protected intent that can only be sent
2814 * by the system.</p>
2815 */
2816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2817 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2818 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2819
2820 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002821 * Broadcast Action: An outgoing call is about to be placed.
2822 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002823 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002824 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002825 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002826 * the phone number originally intended to be dialed.</li>
2827 * </ul>
2828 * <p>Once the broadcast is finished, the resultData is used as the actual
2829 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002830 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002831 * outgoing call in turn: for example, a parental control application
2832 * might verify that the user is authorized to place the call at that
2833 * time, then a number-rewriting application might add an area code if
2834 * one was not specified.</p>
2835 * <p>For consistency, any receiver whose purpose is to prohibit phone
2836 * calls should have a priority of 0, to ensure it will see the final
2837 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002838 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002839 * should have a positive priority.
2840 * Negative priorities are reserved for the system for this broadcast;
2841 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002842 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2843 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002844 * <p>Emergency calls cannot be intercepted using this mechanism, and
2845 * other calls cannot be modified to call emergency numbers using this
2846 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002847 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2848 * call to use their own service instead. Those apps should first prevent
2849 * the call from being placed by setting resultData to <code>null</code>
2850 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002851 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002852 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2853 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002854 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002855 * <p class="note">This is a protected intent that can only be sent
2856 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 */
2858 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2859 public static final String ACTION_NEW_OUTGOING_CALL =
2860 "android.intent.action.NEW_OUTGOING_CALL";
2861
2862 /**
2863 * Broadcast Action: Have the device reboot. This is only for use by
2864 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002865 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002866 * <p class="note">This is a protected intent that can only be sent
2867 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002868 */
2869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2870 public static final String ACTION_REBOOT =
2871 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002872
Wei Huang97ecc9c2009-05-11 17:44:20 -07002873 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002874 * Broadcast Action: A sticky broadcast for changes in the physical
2875 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002876 *
2877 * <p>The intent will have the following extra values:
2878 * <ul>
2879 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002880 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002881 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002882 * <p>This is intended for monitoring the current physical dock state.
2883 * See {@link android.app.UiModeManager} for the normal API dealing with
2884 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002885 */
2886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2887 public static final String ACTION_DOCK_EVENT =
2888 "android.intent.action.DOCK_EVENT";
2889
2890 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002891 * Broadcast Action: A broadcast when idle maintenance can be started.
2892 * This means that the user is not interacting with the device and is
2893 * not expected to do so soon. Typical use of the idle maintenance is
2894 * to perform somehow expensive tasks that can be postponed at a moment
2895 * when they will not degrade user experience.
2896 * <p>
2897 * <p class="note">In order to keep the device responsive in case of an
2898 * unexpected user interaction, implementations of a maintenance task
2899 * should be interruptible. In such a scenario a broadcast with action
2900 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2901 * should not do the maintenance work in
2902 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2903 * maintenance service by {@link Context#startService(Intent)}. Also
2904 * you should hold a wake lock while your maintenance service is running
2905 * to prevent the device going to sleep.
2906 * </p>
2907 * <p>
2908 * <p class="note">This is a protected intent that can only be sent by
2909 * the system.
2910 * </p>
2911 *
2912 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002913 *
2914 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002915 */
2916 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2917 public static final String ACTION_IDLE_MAINTENANCE_START =
2918 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2919
2920 /**
2921 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2922 * This means that the user was not interacting with the device as a result
2923 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2924 * was sent and now the user started interacting with the device. Typical
2925 * use of the idle maintenance is to perform somehow expensive tasks that
2926 * can be postponed at a moment when they will not degrade user experience.
2927 * <p>
2928 * <p class="note">In order to keep the device responsive in case of an
2929 * unexpected user interaction, implementations of a maintenance task
2930 * should be interruptible. Hence, on receiving a broadcast with this
2931 * action, the maintenance task should be interrupted as soon as possible.
2932 * In other words, you should not do the maintenance work in
2933 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2934 * maintenance service that was started on receiving of
2935 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2936 * lock you acquired when your maintenance service started.
2937 * </p>
2938 * <p class="note">This is a protected intent that can only be sent
2939 * by the system.
2940 *
2941 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002942 *
2943 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002944 */
2945 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2946 public static final String ACTION_IDLE_MAINTENANCE_END =
2947 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2948
2949 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002950 * Broadcast Action: a remote intent is to be broadcasted.
2951 *
2952 * A remote intent is used for remote RPC between devices. The remote intent
2953 * is serialized and sent from one device to another device. The receiving
2954 * device parses the remote intent and broadcasts it. Note that anyone can
2955 * broadcast a remote intent. However, if the intent receiver of the remote intent
2956 * does not trust intent broadcasts from arbitrary intent senders, it should require
2957 * the sender to hold certain permissions so only trusted sender's broadcast will be
2958 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002959 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002960 */
2961 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002962 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002963
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002964 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002965 * Broadcast Action: This is broadcast once when the user is booting after a
2966 * system update. It can be used to perform cleanup or upgrades after a
2967 * system update.
2968 * <p>
2969 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2970 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2971 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2972 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002973 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002974 * @hide
2975 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002976 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002977 public static final String ACTION_PRE_BOOT_COMPLETED =
2978 "android.intent.action.PRE_BOOT_COMPLETED";
2979
Amith Yamasani13593602012-03-22 16:16:17 -07002980 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002981 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002982 * on restricted users. The broadcast intent contains an extra
2983 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2984 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2985 * String[] depending on the restriction type.<p/>
2986 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002987 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2988 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2989 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002990 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2991 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002992 * @see RestrictionEntry
2993 */
2994 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2995 "android.intent.action.GET_RESTRICTION_ENTRIES";
2996
2997 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002998 * Sent the first time a user is starting, to allow system apps to
2999 * perform one time initialization. (This will not be seen by third
3000 * party applications because a newly initialized user does not have any
3001 * third party applications installed for it.) This is sent early in
3002 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003003 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
3004 * broadcast, since it is part of a visible user interaction; be as quick
3005 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003006 */
3007 public static final String ACTION_USER_INITIALIZE =
3008 "android.intent.action.USER_INITIALIZE";
3009
3010 /**
3011 * Sent when a user switch is happening, causing the process's user to be
3012 * brought to the foreground. This is only sent to receivers registered
3013 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3014 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003015 * foreground. This is sent as a foreground
3016 * broadcast, since it is part of a visible user interaction; be as quick
3017 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003018 */
3019 public static final String ACTION_USER_FOREGROUND =
3020 "android.intent.action.USER_FOREGROUND";
3021
3022 /**
3023 * Sent when a user switch is happening, causing the process's user to be
3024 * sent to the background. This is only sent to receivers registered
3025 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
3026 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003027 * background. This is sent as a foreground
3028 * broadcast, since it is part of a visible user interaction; be as quick
3029 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003030 */
3031 public static final String ACTION_USER_BACKGROUND =
3032 "android.intent.action.USER_BACKGROUND";
3033
3034 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003035 * Broadcast sent to the system when a user is added. Carries an extra
3036 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
3037 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003038 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003039 * @hide
3040 */
3041 public static final String ACTION_USER_ADDED =
3042 "android.intent.action.USER_ADDED";
3043
3044 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003045 * Broadcast sent by the system when a user is started. Carries an extra
3046 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003047 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003048 * that has been started. This is sent as a foreground
3049 * broadcast, since it is part of a visible user interaction; be as quick
3050 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003051 * @hide
3052 */
3053 public static final String ACTION_USER_STARTED =
3054 "android.intent.action.USER_STARTED";
3055
3056 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07003057 * Broadcast sent when a user is in the process of starting. Carries an extra
3058 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3059 * sent to registered receivers, not manifest receivers. It is sent to all
3060 * users (including the one that is being started). You must hold
3061 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3062 * this broadcast. This is sent as a background broadcast, since
3063 * its result is not part of the primary UX flow; to safely keep track of
3064 * started/stopped state of a user you can use this in conjunction with
3065 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
3066 * other user state broadcasts since those are foreground broadcasts so can
3067 * execute in a different order.
3068 * @hide
3069 */
3070 public static final String ACTION_USER_STARTING =
3071 "android.intent.action.USER_STARTING";
3072
3073 /**
3074 * Broadcast sent when a user is going to be stopped. Carries an extra
3075 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
3076 * sent to registered receivers, not manifest receivers. It is sent to all
3077 * users (including the one that is being stopped). You must hold
3078 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
3079 * this broadcast. The user will not stop until all receivers have
3080 * handled the broadcast. This is sent as a background broadcast, since
3081 * its result is not part of the primary UX flow; to safely keep track of
3082 * started/stopped state of a user you can use this in conjunction with
3083 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3084 * other user state broadcasts since those are foreground broadcasts so can
3085 * execute in a different order.
3086 * @hide
3087 */
3088 public static final String ACTION_USER_STOPPING =
3089 "android.intent.action.USER_STOPPING";
3090
3091 /**
3092 * Broadcast sent to the system when a user is stopped. Carries an extra
3093 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3094 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3095 * specific package. This is only sent to registered receivers, not manifest
3096 * receivers. It is sent to all running users <em>except</em> the one that
3097 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003098 * @hide
3099 */
3100 public static final String ACTION_USER_STOPPED =
3101 "android.intent.action.USER_STOPPED";
3102
3103 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003104 * 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 -07003105 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003106 * one that has been removed. The user will not be completely removed until all receivers have
3107 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003108 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003109 * @hide
3110 */
Sudheer Shanka166a81b2017-03-30 15:42:51 -07003111 @SystemApi
Amith Yamasani13593602012-03-22 16:16:17 -07003112 public static final String ACTION_USER_REMOVED =
3113 "android.intent.action.USER_REMOVED";
3114
3115 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003116 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003117 * the userHandle of the user to become the current one. This is only sent to
3118 * registered receivers, not manifest receivers. It is sent to all running users.
3119 * You must hold
3120 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003121 * @hide
3122 */
3123 public static final String ACTION_USER_SWITCHED =
3124 "android.intent.action.USER_SWITCHED";
3125
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003126 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003127 * Broadcast Action: Sent when the credential-encrypted private storage has
3128 * become unlocked for the target user. This is only sent to registered
3129 * receivers, not manifest receivers.
3130 */
3131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3132 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3133
3134 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003135 * Broadcast sent to the system when a user's information changes. Carries an extra
3136 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003137 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003138 * @hide
3139 */
3140 public static final String ACTION_USER_INFO_CHANGED =
3141 "android.intent.action.USER_INFO_CHANGED";
3142
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003143 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003144 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3145 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003146 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3147 * that need to display merged content across both primary and managed profiles need to
3148 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003149 * not manifest receivers.
3150 */
3151 public static final String ACTION_MANAGED_PROFILE_ADDED =
3152 "android.intent.action.MANAGED_PROFILE_ADDED";
3153
3154 /**
3155 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003156 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3157 * Only applications (for example Launchers) that need to display merged content across both
3158 * primary and managed profiles need to worry about this broadcast. This is only sent to
3159 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003160 */
3161 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3162 "android.intent.action.MANAGED_PROFILE_REMOVED";
3163
3164 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003165 * Broadcast sent to the primary user when the credential-encrypted private storage for
3166 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3167 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3168 * Launchers) that need to display merged content across both primary and managed profiles
3169 * need to worry about this broadcast. This is only sent to registered receivers,
3170 * not manifest receivers.
3171 */
3172 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3173 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3174
3175 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003176 * Broadcast sent to the primary user when an associated managed profile has become available.
3177 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003178 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3179 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3180 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003181 */
Rubin Xue95057a2016-04-01 16:49:25 +01003182 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3183 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3184
3185 /**
3186 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3187 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3188 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3189 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3190 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3191 */
3192 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3193 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003194
3195 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003196 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3197 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3198 * the device was locked or unlocked.
3199 *
3200 * This is only sent to registered receivers.
3201 *
3202 * @hide
3203 */
3204 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3205 "android.intent.action.DEVICE_LOCKED_CHANGED";
3206
3207 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003208 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3209 */
3210 public static final String ACTION_QUICK_CLOCK =
3211 "android.intent.action.QUICK_CLOCK";
3212
Michael Wright0087a142013-02-05 16:29:39 -08003213 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003214 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003215 * @hide
3216 */
3217 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003218 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003219
Justin Kohd378ad72013-04-01 12:18:26 -07003220 /**
3221 * Broadcast Action: A global button was pressed. Includes a single
3222 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3223 * caused the broadcast.
3224 * @hide
3225 */
Sujith Ramakrishnan48e19c82017-04-24 15:57:58 -07003226 @SystemApi
Justin Kohd378ad72013-04-01 12:18:26 -07003227 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3228
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003229 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003230 * Broadcast Action: Sent when media resource is granted.
3231 * <p>
3232 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3233 * granted.
3234 * </p>
3235 * <p class="note">
3236 * This is a protected intent that can only be sent by the system.
3237 * </p>
3238 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003239 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003240 * </p>
3241 *
3242 * @hide
3243 */
3244 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3245 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3246
3247 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003248 * Broadcast Action: An overlay package has changed. The data contains the
3249 * name of the overlay package which has changed. This is broadcast on all
3250 * changes to the OverlayInfo returned by {@link
3251 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3252 * most common change is a state change that will change whether the
3253 * overlay is enabled or not.
3254 * @hide
3255 */
3256 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3257
3258 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003259 * Activity Action: Allow the user to select and return one or more existing
3260 * documents. When invoked, the system will display the various
3261 * {@link DocumentsProvider} instances installed on the device, letting the
3262 * user interactively navigate through them. These documents include local
3263 * media, such as photos and video, and documents provided by installed
3264 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003265 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003266 * Each document is represented as a {@code content://} URI backed by a
3267 * {@link DocumentsProvider}, which can be opened as a stream with
3268 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3269 * {@link android.provider.DocumentsContract.Document} metadata.
3270 * <p>
3271 * All selected documents are returned to the calling application with
3272 * persistable read and write permission grants. If you want to maintain
3273 * access to the documents across device reboots, you need to explicitly
3274 * take the persistable permissions using
3275 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3276 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003277 * Callers must indicate the acceptable document MIME types through
3278 * {@link #setType(String)}. For example, to select photos, use
3279 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3280 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3281 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003282 * <p>
3283 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003284 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3285 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003286 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003287 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3288 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003289 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003290 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003291 * Callers can set a document URI through
3292 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3293 * location of documents navigator. System will do its best to launch the
3294 * navigator in the specified document if it's a folder, or the folder that
3295 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003296 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003297 * Output: The URI of the item that was picked, returned in
3298 * {@link #getData()}. This must be a {@code content://} URI so that any
3299 * receiver can access it. If multiple documents were selected, they are
3300 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003301 *
3302 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003303 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003304 * @see #ACTION_CREATE_DOCUMENT
3305 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003306 */
3307 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3308 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3309
3310 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003311 * Activity Action: Allow the user to create a new document. When invoked,
3312 * the system will display the various {@link DocumentsProvider} instances
3313 * installed on the device, letting the user navigate through them. The
3314 * returned document may be a newly created document with no content, or it
3315 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003316 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003317 * Each document is represented as a {@code content://} URI backed by a
3318 * {@link DocumentsProvider}, which can be opened as a stream with
3319 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3320 * {@link android.provider.DocumentsContract.Document} metadata.
3321 * <p>
3322 * Callers must indicate the concrete MIME type of the document being
3323 * created by setting {@link #setType(String)}. This MIME type cannot be
3324 * changed after the document is created.
3325 * <p>
3326 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3327 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003328 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003329 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3330 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003331 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003332 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003333 * Callers can set a document URI through
3334 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3335 * location of documents navigator. System will do its best to launch the
3336 * navigator in the specified document if it's a folder, or the folder that
3337 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003338 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003339 * Output: The URI of the item that was created. This must be a
3340 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003341 *
3342 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003343 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003344 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003345 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003346 */
3347 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3348 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3349
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003350 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003351 * Activity Action: Allow the user to pick a directory subtree. When
3352 * invoked, the system will display the various {@link DocumentsProvider}
3353 * instances installed on the device, letting the user navigate through
3354 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003355 * <p>
3356 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003357 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3358 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3359 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003360 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003361 * Callers can set a document URI through
3362 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3363 * location of documents navigator. System will do its best to launch the
3364 * navigator in the specified document if it's a folder, or the folder that
3365 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003366 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003367 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003368 *
3369 * @see DocumentsContract
3370 */
3371 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003372 public static final String
3373 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003374
Felipe Lemec7b1f892016-01-15 15:02:31 -08003375 /**
Peng Xua35b5532016-01-20 00:05:45 -08003376 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3377 * exisiting sensor being disconnected.
3378 *
3379 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3380 *
3381 * {@hide}
3382 */
3383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3384 public static final String
3385 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3386
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003387 /**
Sam Line707f832017-04-13 17:00:55 -07003388 * Deprecated - use ACTION_FACTORY_RESET instead.
Amith Yamasanie99757e42017-04-14 14:41:45 -07003389 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003390 * @removed
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003391 */
3392 @Deprecated
Amith Yamasanie99757e42017-04-14 14:41:45 -07003393 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003394 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3395
Christopher Tate6597e342015-02-17 12:15:25 -08003396 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003397 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3398 * is about to be performed.
3399 * @hide
3400 */
3401 @SystemApi
3402 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3403 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3404 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3405
3406 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003407 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3408 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3409 *
3410 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3411 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003412 * @hide
3413 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003414 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003415 public static final String EXTRA_FORCE_MASTER_CLEAR =
3416 "android.intent.extra.FORCE_MASTER_CLEAR";
3417
3418 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003419 * A broadcast action to trigger a factory reset.
3420 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003421 * <p>The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission. The
3422 * reason for the factory reset should be specified as {@link #EXTRA_REASON}.
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003423 *
3424 * <p>Not for use by third-party applications.
3425 *
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07003426 * @see #EXTRA_FORCE_FACTORY_RESET
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003427 *
3428 * {@hide}
3429 */
3430 @SystemApi
3431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3432 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3433
3434 /**
3435 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3436 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3437 *
3438 * <p>Not for use by third-party applications.
3439 *
3440 * @hide
3441 */
3442 @SystemApi
3443 public static final String EXTRA_FORCE_FACTORY_RESET =
3444 "android.intent.extra.FORCE_FACTORY_RESET";
3445
3446 /**
Michal Karpinski6135a262017-08-11 10:45:58 +01003447 * Broadcast action: report that a settings element is being restored from backup. The intent
3448 * contains four extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3449 * EXTRA_SETTING_NEW_VALUE is the value being restored, EXTRA_SETTING_PREVIOUS_VALUE
3450 * is the value of that settings entry prior to the restore operation, and
3451 * EXTRA_SETTING_RESTORED_FROM_SDK_INT is the version of the SDK that the setting has been
3452 * restored from (corresponds to {@link android.os.Build.VERSION#SDK_INT}). The first three
3453 * values are represented as strings, the fourth one as int.
Christopher Tate6597e342015-02-17 12:15:25 -08003454 *
3455 * <p>This broadcast is sent only for settings provider entries known to require special handling
3456 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3457 * the provider's backup agent implementation.
3458 *
3459 * @see #EXTRA_SETTING_NAME
3460 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3461 * @see #EXTRA_SETTING_NEW_VALUE
Michal Karpinski6135a262017-08-11 10:45:58 +01003462 * @see #EXTRA_SETTING_RESTORED_FROM_SDK_INT
Christopher Tate6597e342015-02-17 12:15:25 -08003463 * {@hide}
3464 */
3465 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3466
3467 /** {@hide} */
3468 public static final String EXTRA_SETTING_NAME = "setting_name";
3469 /** {@hide} */
3470 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3471 /** {@hide} */
3472 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
Michal Karpinski6135a262017-08-11 10:45:58 +01003473 /** {@hide} */
3474 public static final String EXTRA_SETTING_RESTORED_FROM_SDK_INT = "restored_from_sdk_int";
Christopher Tate6597e342015-02-17 12:15:25 -08003475
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003476 /**
3477 * Activity Action: Process a piece of text.
3478 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3479 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3480 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3481 */
3482 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3483 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003484
3485 /**
3486 * Broadcast Action: The sim card state has changed.
3487 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3488 * because TelephonyIntents is an internal class.
3489 * @hide
Amit Mahajan052e1e22018-01-12 17:40:29 -08003490 * @deprecated Use {@link #ACTION_SIM_CARD_STATE_CHANGED} or
3491 * {@link #ACTION_SIM_APPLICATION_STATE_CHANGED}
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003492 */
Amit Mahajan052e1e22018-01-12 17:40:29 -08003493 @Deprecated
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003494 @SystemApi
3495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3496 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3497
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003498 /**
fionaxu90fee272017-03-31 12:45:12 -07003499 * Broadcast Action: indicate that the phone service state has changed.
3500 * The intent will have the following extra values:</p>
3501 * <p>
3502 * @see #EXTRA_VOICE_REG_STATE
3503 * @see #EXTRA_DATA_REG_STATE
3504 * @see #EXTRA_VOICE_ROAMING_TYPE
3505 * @see #EXTRA_DATA_ROAMING_TYPE
3506 * @see #EXTRA_OPERATOR_ALPHA_LONG
3507 * @see #EXTRA_OPERATOR_ALPHA_SHORT
3508 * @see #EXTRA_OPERATOR_NUMERIC
3509 * @see #EXTRA_DATA_OPERATOR_ALPHA_LONG
3510 * @see #EXTRA_DATA_OPERATOR_ALPHA_SHORT
3511 * @see #EXTRA_DATA_OPERATOR_NUMERIC
3512 * @see #EXTRA_MANUAL
3513 * @see #EXTRA_VOICE_RADIO_TECH
3514 * @see #EXTRA_DATA_RADIO_TECH
3515 * @see #EXTRA_CSS_INDICATOR
3516 * @see #EXTRA_NETWORK_ID
3517 * @see #EXTRA_SYSTEM_ID
3518 * @see #EXTRA_CDMA_ROAMING_INDICATOR
3519 * @see #EXTRA_CDMA_DEFAULT_ROAMING_INDICATOR
3520 * @see #EXTRA_EMERGENCY_ONLY
3521 * @see #EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION
3522 * @see #EXTRA_IS_USING_CARRIER_AGGREGATION
3523 * @see #EXTRA_LTE_EARFCN_RSRP_BOOST
3524 *
3525 * <p class="note">
3526 * Requires the READ_PHONE_STATE permission.
3527 *
3528 * <p class="note">This is a protected intent that can only be sent by the system.
3529 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003530 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003531 */
3532 @Deprecated
3533 @SystemApi
3534 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION)
3535 public static final String ACTION_SERVICE_STATE = "android.intent.action.SERVICE_STATE";
3536
3537 /**
3538 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates voice registration
3539 * state.
3540 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3541 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3542 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3543 * @see android.telephony.ServiceState#STATE_POWER_OFF
3544 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003545 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003546 */
3547 @Deprecated
3548 @SystemApi
3549 public static final String EXTRA_VOICE_REG_STATE = "voiceRegState";
3550
3551 /**
3552 * An int extra used with {@link #ACTION_SERVICE_STATE} which indicates data registration state.
3553 * @see android.telephony.ServiceState#STATE_EMERGENCY_ONLY
3554 * @see android.telephony.ServiceState#STATE_IN_SERVICE
3555 * @see android.telephony.ServiceState#STATE_OUT_OF_SERVICE
3556 * @see android.telephony.ServiceState#STATE_POWER_OFF
3557 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003558 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003559 */
3560 @Deprecated
3561 @SystemApi
3562 public static final String EXTRA_DATA_REG_STATE = "dataRegState";
3563
3564 /**
3565 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the voice roaming
3566 * type.
3567 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003568 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003569 */
3570 @Deprecated
3571 @SystemApi
3572 public static final String EXTRA_VOICE_ROAMING_TYPE = "voiceRoamingType";
3573
3574 /**
3575 * An integer extra used with {@link #ACTION_SERVICE_STATE} which indicates the data roaming
3576 * type.
3577 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003578 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003579 */
3580 @Deprecated
3581 @SystemApi
3582 public static final String EXTRA_DATA_ROAMING_TYPE = "dataRoamingType";
3583
3584 /**
3585 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3586 * registered voice operator name in long alphanumeric format.
3587 * {@code null} if the operator name is not known or unregistered.
3588 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003589 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003590 */
3591 @Deprecated
3592 @SystemApi
3593 public static final String EXTRA_OPERATOR_ALPHA_LONG = "operator-alpha-long";
3594
3595 /**
3596 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3597 * registered voice operator name in short alphanumeric format.
3598 * {@code null} if the operator name is not known or unregistered.
3599 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003600 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003601 */
3602 @Deprecated
3603 @SystemApi
3604 public static final String EXTRA_OPERATOR_ALPHA_SHORT = "operator-alpha-short";
3605
3606 /**
3607 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3608 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the mobile
3609 * network.
3610 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003611 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003612 */
3613 @Deprecated
3614 @SystemApi
3615 public static final String EXTRA_OPERATOR_NUMERIC = "operator-numeric";
3616
3617 /**
3618 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3619 * registered data operator name in long alphanumeric format.
3620 * {@code null} if the operator name is not known or unregistered.
3621 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003622 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003623 */
3624 @Deprecated
3625 @SystemApi
3626 public static final String EXTRA_DATA_OPERATOR_ALPHA_LONG = "data-operator-alpha-long";
3627
3628 /**
3629 * A string extra used with {@link #ACTION_SERVICE_STATE} which represents the current
3630 * registered data operator name in short alphanumeric format.
3631 * {@code null} if the operator name is not known or unregistered.
3632 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003633 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003634 */
3635 @Deprecated
3636 @SystemApi
3637 public static final String EXTRA_DATA_OPERATOR_ALPHA_SHORT = "data-operator-alpha-short";
3638
3639 /**
3640 * A string extra used with {@link #ACTION_SERVICE_STATE} containing the MCC
3641 * (Mobile Country Code, 3 digits) and MNC (Mobile Network code, 2-3 digits) for the
3642 * data operator.
3643 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003644 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003645 */
3646 @Deprecated
3647 @SystemApi
3648 public static final String EXTRA_DATA_OPERATOR_NUMERIC = "data-operator-numeric";
3649
3650 /**
3651 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether the current
3652 * network selection mode is manual.
3653 * Will be {@code true} if manual mode, {@code false} if automatic mode.
3654 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003655 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003656 */
3657 @Deprecated
3658 @SystemApi
3659 public static final String EXTRA_MANUAL = "manual";
3660
3661 /**
3662 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current voice
3663 * radio technology.
3664 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003665 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003666 */
3667 @Deprecated
3668 @SystemApi
3669 public static final String EXTRA_VOICE_RADIO_TECH = "radioTechnology";
3670
3671 /**
3672 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the current data
3673 * radio technology.
3674 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003675 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003676 */
3677 @Deprecated
3678 @SystemApi
3679 public static final String EXTRA_DATA_RADIO_TECH = "dataRadioTechnology";
3680
3681 /**
3682 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which represents concurrent service
3683 * support on CDMA network.
3684 * Will be {@code true} if support, {@code false} otherwise.
3685 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003686 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003687 */
3688 @Deprecated
3689 @SystemApi
3690 public static final String EXTRA_CSS_INDICATOR = "cssIndicator";
3691
3692 /**
3693 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA network
3694 * id. {@code Integer.MAX_VALUE} if unknown.
3695 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003696 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003697 */
3698 @Deprecated
3699 @SystemApi
3700 public static final String EXTRA_NETWORK_ID = "networkId";
3701
3702 /**
3703 * An integer extra used with {@link #ACTION_SERVICE_STATE} which represents the CDMA system id.
3704 * {@code Integer.MAX_VALUE} if unknown.
3705 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003706 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003707 */
3708 @Deprecated
3709 @SystemApi
3710 public static final String EXTRA_SYSTEM_ID = "systemId";
3711
3712 /**
3713 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the TSB-58 roaming
3714 * indicator if registered on a CDMA or EVDO system or {@code -1} if not.
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_CDMA_ROAMING_INDICATOR = "cdmaRoamingIndicator";
3721
3722 /**
3723 * An integer extra used with {@link #ACTION_SERVICE_STATE} represents the default roaming
3724 * indicator from the PRL if registered on a CDMA or EVDO system {@code -1} if not.
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_CDMA_DEFAULT_ROAMING_INDICATOR = "cdmaDefaultRoamingIndicator";
3731
3732 /**
3733 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if under emergency
3734 * only mode.
3735 * {@code true} if in emergency only mode, {@code false} otherwise.
3736 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003737 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003738 */
3739 @Deprecated
3740 @SystemApi
3741 public static final String EXTRA_EMERGENCY_ONLY = "emergencyOnly";
3742
3743 /**
3744 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates whether data network
3745 * registration state is roaming.
3746 * {@code true} if registration indicates roaming, {@code false} otherwise
3747 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003748 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003749 */
3750 @Deprecated
3751 @SystemApi
3752 public static final String EXTRA_IS_DATA_ROAMING_FROM_REGISTRATION =
3753 "isDataRoamingFromRegistration";
3754
3755 /**
3756 * A boolean extra used with {@link #ACTION_SERVICE_STATE} which indicates if carrier
3757 * aggregation is in use.
3758 * {@code true} if carrier aggregation is in use, {@code false} otherwise.
3759 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003760 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003761 */
3762 @Deprecated
3763 @SystemApi
3764 public static final String EXTRA_IS_USING_CARRIER_AGGREGATION = "isUsingCarrierAggregation";
3765
3766 /**
3767 * An integer extra used with {@link #ACTION_SERVICE_STATE} representing the offset which
3768 * is reduced from the rsrp threshold while calculating signal strength level.
3769 * @hide
Jeff Sharkey84789112017-08-11 14:45:43 -06003770 * @removed
fionaxu90fee272017-03-31 12:45:12 -07003771 */
3772 @Deprecated
3773 @SystemApi
3774 public static final String EXTRA_LTE_EARFCN_RSRP_BOOST = "LteEarfcnRsrpBoost";
3775
3776 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003777 * The name of the extra used to define the text to be processed, as a
3778 * CharSequence. Note that this may be a styled CharSequence, so you must use
3779 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003780 */
3781 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3782 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003783 * 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 +00003784 */
3785 public static final String EXTRA_PROCESS_TEXT_READONLY =
3786 "android.intent.extra.PROCESS_TEXT_READONLY";
3787
Bryce Leebc58f592015-09-25 16:43:01 -07003788 /**
3789 * Broadcast action: reports when a new thermal event has been reached. When the device
3790 * is reaching its maximum temperatue, the thermal level reported
3791 * {@hide}
3792 */
3793 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3794 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3795
3796 /** {@hide} */
3797 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3798
3799 /**
3800 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003801 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003802 * {@hide}
3803 */
3804 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3805
3806 /**
3807 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003808 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003809 * {@hide}
3810 */
3811 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3812
3813 /**
3814 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003815 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003816 * {@hide}
3817 */
3818 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3819
3820
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003821 // ---------------------------------------------------------------------
3822 // ---------------------------------------------------------------------
3823 // Standard intent categories (see addCategory()).
3824
3825 /**
3826 * Set if the activity should be an option for the default action
3827 * (center press) to perform on a piece of data. Setting this will
3828 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003829 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003830 * Intent when initiating an action -- it is for use in intent filters
3831 * specified in packages.
3832 */
3833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3834 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3835 /**
3836 * Activities that can be safely invoked from a browser must support this
3837 * category. For example, if the user is viewing a web page or an e-mail
3838 * and clicks on a link in the text, the Intent generated execute that
3839 * link will require the BROWSABLE category, so that only activities
3840 * supporting this category will be considered as possible actions. By
3841 * supporting this category, you are promising that there is nothing
3842 * damaging (without user intervention) that can happen by invoking any
3843 * matching Intent.
3844 */
3845 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3846 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3847 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003848 * Categories for activities that can participate in voice interaction.
3849 * An activity that supports this category must be prepared to run with
3850 * no UI shown at all (though in some case it may have a UI shown), and
3851 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3852 */
3853 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3854 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3855 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003856 * Set if the activity should be considered as an alternative action to
3857 * the data the user is currently viewing. See also
3858 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3859 * applies to the selection in a list of items.
3860 *
3861 * <p>Supporting this category means that you would like your activity to be
3862 * displayed in the set of alternative things the user can do, usually as
3863 * part of the current activity's options menu. You will usually want to
3864 * include a specific label in the &lt;intent-filter&gt; of this action
3865 * describing to the user what it does.
3866 *
3867 * <p>The action of IntentFilter with this category is important in that it
3868 * describes the specific action the target will perform. This generally
3869 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3870 * a specific name such as "com.android.camera.action.CROP. Only one
3871 * alternative of any particular action will be shown to the user, so using
3872 * a specific action like this makes sure that your alternative will be
3873 * displayed while also allowing other applications to provide their own
3874 * overrides of that particular action.
3875 */
3876 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3877 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3878 /**
3879 * Set if the activity should be considered as an alternative selection
3880 * action to the data the user has currently selected. This is like
3881 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3882 * of items from which the user can select, giving them alternatives to the
3883 * default action that will be performed on it.
3884 */
3885 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3886 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3887 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003888 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003889 */
3890 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3891 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3892 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 * Should be displayed in the top-level launcher.
3894 */
3895 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3896 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3897 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003898 * Indicates an activity optimized for Leanback mode, and that should
3899 * be displayed in the Leanback launcher.
3900 */
3901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3902 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3903 /**
Roberto Perez7ee1a7a2017-12-04 17:14:33 -08003904 * Indicates the preferred entry-point activity when an application is launched from a Car
3905 * launcher. If not present, Car launcher can optionally use {@link #CATEGORY_LAUNCHER} as a
3906 * fallback, or exclude the application entirely.
3907 * @hide
3908 */
3909 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3910 public static final String CATEGORY_CAR_LAUNCHER = "android.intent.category.CAR_LAUNCHER";
3911 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003912 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3913 * @hide
3914 */
3915 @SystemApi
3916 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003918 * Provides information about the package it is in; typically used if
3919 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3920 * a front-door to the user without having to be shown in the all apps list.
3921 */
3922 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3923 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3924 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003925 * This is the home activity, that is the first activity that is displayed
3926 * when the device boots.
3927 */
3928 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3929 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3930 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003931 * This is the home activity that is displayed when the device is finished setting up and ready
3932 * for use.
3933 * @hide
3934 */
3935 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3936 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3937 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003938 * This is the setup wizard activity, that is the first activity that is displayed
3939 * when the user sets up the device for the first time.
3940 * @hide
3941 */
3942 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3943 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3944 /**
Svet Ganov5bb6bc62017-08-28 12:39:35 -07003945 * This is the home activity, that is the activity that serves as the launcher app
3946 * from there the user can start other apps. Often components with lower/higher
3947 * priority intent filters handle the home intent, for example SetupWizard, to
3948 * setup the device and we need to be able to distinguish the home app from these
3949 * setup helpers.
3950 * @hide
3951 */
3952 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3953 public static final String CATEGORY_LAUNCHER_APP = "android.intent.category.LAUNCHER_APP";
3954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 * This activity is a preference panel.
3956 */
3957 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3958 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3959 /**
3960 * This activity is a development preference panel.
3961 */
3962 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3963 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3964 /**
3965 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003966 */
3967 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3968 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3969 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003970 * This activity allows the user to browse and download new applications.
3971 */
3972 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3973 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3974 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 * This activity may be exercised by the monkey or other automated test tools.
3976 */
3977 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3978 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3979 /**
3980 * To be used as a test (not part of the normal user experience).
3981 */
3982 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3983 /**
3984 * To be used as a unit test (run through the Test Harness).
3985 */
3986 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3987 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003988 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003989 * experience).
3990 */
3991 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003992
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003993 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003994 * Used to indicate that an intent only wants URIs that can be opened with
3995 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3996 * must support at least the columns defined in {@link OpenableColumns} when
3997 * queried.
3998 *
3999 * @see #ACTION_GET_CONTENT
4000 * @see #ACTION_OPEN_DOCUMENT
4001 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004002 */
4003 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4004 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
4005
4006 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09004007 * Used to indicate that an intent filter can accept files which are not necessarily
4008 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
4009 * at least streamable via
4010 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
4011 * using one of the stream types exposed via
4012 * {@link ContentResolver#getStreamTypes(Uri, String)}.
4013 *
4014 * @see #ACTION_SEND
4015 * @see #ACTION_SEND_MULTIPLE
4016 */
4017 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4018 public static final String CATEGORY_TYPED_OPENABLE =
4019 "android.intent.category.TYPED_OPENABLE";
4020
4021 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004022 * To be used as code under test for framework instrumentation tests.
4023 */
4024 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
4025 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04004026 /**
4027 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004028 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4029 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004030 */
4031 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4032 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
4033 /**
4034 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08004035 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4036 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04004037 */
4038 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4039 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004040 /**
4041 * An activity to run when device is inserted into a analog (low end) dock.
4042 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4043 * information, see {@link android.app.UiModeManager}.
4044 */
4045 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4046 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
4047
4048 /**
4049 * An activity to run when device is inserted into a digital (high end) dock.
4050 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4051 * information, see {@link android.app.UiModeManager}.
4052 */
4053 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4054 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004055
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004056 /**
4057 * Used to indicate that the activity can be used in a car environment.
4058 */
4059 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4060 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
4061
Zak Cohendb6ca492017-01-26 14:09:00 -08004062 /**
4063 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
4064 * Used with {@link #ACTION_MAIN} to launch an activity. For more
4065 * information, see {@link android.app.UiModeManager}.
4066 */
4067 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4068 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004069 // ---------------------------------------------------------------------
4070 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08004071 // Application launch intent categories (see addCategory()).
4072
4073 /**
4074 * Used with {@link #ACTION_MAIN} to launch the browser application.
4075 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004076 * <p>NOTE: This should not be used as the primary key of an Intent,
4077 * since it will not result in the app launching with the correct
4078 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004079 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004080 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004081 */
4082 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4083 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
4084
4085 /**
4086 * Used with {@link #ACTION_MAIN} to launch the calculator application.
4087 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004088 * <p>NOTE: This should not be used as the primary key of an Intent,
4089 * since it will not result in the app launching with the correct
4090 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004091 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004092 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004093 */
4094 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4095 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
4096
4097 /**
4098 * Used with {@link #ACTION_MAIN} to launch the calendar application.
4099 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004100 * <p>NOTE: This should not be used as the primary key of an Intent,
4101 * since it will not result in the app launching with the correct
4102 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004103 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004104 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004105 */
4106 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4107 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
4108
4109 /**
4110 * Used with {@link #ACTION_MAIN} to launch the contacts application.
4111 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004112 * <p>NOTE: This should not be used as the primary key of an Intent,
4113 * since it will not result in the app launching with the correct
4114 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004115 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004116 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004117 */
4118 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4119 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
4120
4121 /**
4122 * Used with {@link #ACTION_MAIN} to launch the email application.
4123 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004124 * <p>NOTE: This should not be used as the primary key of an Intent,
4125 * since it will not result in the app launching with the correct
4126 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004127 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004128 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004129 */
4130 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4131 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
4132
4133 /**
4134 * Used with {@link #ACTION_MAIN} to launch the gallery application.
4135 * The activity should be able to view and manipulate image and video files
4136 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004137 * <p>NOTE: This should not be used as the primary key of an Intent,
4138 * since it will not result in the app launching with the correct
4139 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004140 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004141 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004142 */
4143 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4144 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
4145
4146 /**
4147 * Used with {@link #ACTION_MAIN} to launch the maps application.
4148 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004149 * <p>NOTE: This should not be used as the primary key of an Intent,
4150 * since it will not result in the app launching with the correct
4151 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004152 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004153 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004154 */
4155 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4156 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
4157
4158 /**
4159 * Used with {@link #ACTION_MAIN} to launch the messaging application.
4160 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004161 * <p>NOTE: This should not be used as the primary key of an Intent,
4162 * since it will not result in the app launching with the correct
4163 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004164 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004165 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004166 */
4167 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4168 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
4169
4170 /**
4171 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004172 * The activity should be able to play, browse, or manipulate music files
4173 * stored on the device.
4174 * <p>NOTE: This should not be used as the primary key of an Intent,
4175 * since it will not result in the app launching with the correct
4176 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08004177 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004178 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08004179 */
4180 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
4181 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
4182
4183 // ---------------------------------------------------------------------
4184 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004185 // Standard extra data keys.
4186
4187 /**
4188 * The initial data to place in a newly created record. Use with
4189 * {@link #ACTION_INSERT}. The data here is a Map containing the same
4190 * fields as would be given to the underlying ContentProvider.insert()
4191 * call.
4192 */
4193 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
4194
4195 /**
4196 * A constant CharSequence that is associated with the Intent, used with
4197 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
4198 * this may be a styled CharSequence, so you must use
4199 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
4200 * retrieve it.
4201 */
4202 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
4203
4204 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07004205 * A constant String that is associated with the Intent, used with
4206 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
4207 * as HTML formatted text. Note that you <em>must</em> also supply
4208 * {@link #EXTRA_TEXT}.
4209 */
4210 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
4211
4212 /**
Jeff Sharkey81aebe72017-04-03 20:14:10 +00004213 * A content: URI holding a stream of data associated with the Intent,
4214 * used with {@link #ACTION_SEND} to supply the data being sent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004215 */
4216 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
4217
4218 /**
4219 * A String[] holding e-mail addresses that should be delivered to.
4220 */
4221 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
4222
4223 /**
4224 * A String[] holding e-mail addresses that should be carbon copied.
4225 */
4226 public static final String EXTRA_CC = "android.intent.extra.CC";
4227
4228 /**
4229 * A String[] holding e-mail addresses that should be blind carbon copied.
4230 */
4231 public static final String EXTRA_BCC = "android.intent.extra.BCC";
4232
4233 /**
4234 * A constant string holding the desired subject line of a message.
4235 */
4236 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
4237
4238 /**
4239 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07004240 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004241 */
4242 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
4243
4244 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01004245 * An int representing the user id to be used.
4246 *
4247 * @hide
4248 */
4249 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
4250
4251 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00004252 * An int representing the task id to be retrieved. This is used when a launch from recents is
4253 * intercepted by another action such as credentials confirmation to remember which task should
4254 * be resumed when complete.
4255 *
4256 * @hide
4257 */
4258 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
4259
4260 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004261 * An Intent[] describing additional, alternate choices you would like shown with
4262 * {@link #ACTION_CHOOSER}.
4263 *
4264 * <p>An app may be capable of providing several different payload types to complete a
4265 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
4266 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
4267 * several different supported sending mechanisms for sharing, such as the actual "image/*"
4268 * photo data or a hosted link where the photos can be viewed.</p>
4269 *
4270 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
4271 * first/primary/preferred intent in the set. Additional intents specified in
4272 * this extra are ordered; by default intents that appear earlier in the array will be
4273 * preferred over intents that appear later in the array as matches for the same
4274 * target component. To alter this preference, a calling app may also supply
4275 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
4276 */
4277 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
4278
4279 /**
Adam Powell52c39212016-04-07 15:14:18 -07004280 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
4281 * and omitted from a list of components presented to the user.
4282 *
4283 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
4284 * in this array if it otherwise would have shown them. Useful for omitting specific targets
4285 * from your own package or other apps from your organization if the idea of sending to those
4286 * targets would be redundant with other app functionality. Filtered components will not
4287 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
4288 */
4289 public static final String EXTRA_EXCLUDE_COMPONENTS
4290 = "android.intent.extra.EXCLUDE_COMPONENTS";
4291
4292 /**
4293 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
4294 * describing additional high-priority deep-link targets for the chooser to present to the user.
4295 *
4296 * <p>Targets provided in this way will be presented inline with all other targets provided
4297 * by services from other apps. They will be prioritized before other service targets, but
4298 * after those targets provided by sources that the user has manually pinned to the front.</p>
4299 *
4300 * @see #ACTION_CHOOSER
4301 */
4302 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
4303
4304 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004305 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
4306 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
4307 *
4308 * <p>An app preparing an action for another app to complete may wish to allow the user to
4309 * disambiguate between several options for completing the action based on the chosen target
4310 * or otherwise refine the action before it is invoked.
4311 * </p>
4312 *
4313 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
4314 * <ul>
4315 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
4316 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
4317 * chosen target beyond the first</li>
4318 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
4319 * should fill in and send once the disambiguation is complete</li>
4320 * </ul>
4321 */
4322 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
4323 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
4324
4325 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08004326 * An {@code ArrayList} of {@code String} annotations describing content for
4327 * {@link #ACTION_CHOOSER}.
4328 *
4329 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
4330 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
4331 *
4332 * <p>Annotations should describe the major components or topics of the content. It is up to
4333 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
4334 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
Kang Li2f85e8a2017-04-26 09:19:54 -07004335 * start {@link #ACTION_CHOOSER}. Names of customized annotations should not contain the colon
4336 * character. Performance on customized annotations can suffer, if they are rarely used for
4337 * {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to use the
4338 * following annotations when applicable.</p>
Kang Li9fa2a2c2017-01-06 13:33:24 -08004339 * <ul>
Kang Lifadc0162017-04-19 11:56:05 -07004340 * <li>"product" represents that the topic of the content is mainly about products, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004341 * health & beauty, and office supplies.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004342 * <li>"emotion" represents that the topic of the content is mainly about emotions, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004343 * happy, and sad.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004344 * <li>"person" represents that the topic of the content is mainly about persons, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004345 * face, finger, standing, and walking.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004346 * <li>"child" represents that the topic of the content is mainly about children, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004347 * child, and baby.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004348 * <li>"selfie" represents that the topic of the content is mainly about selfies.</li>
4349 * <li>"crowd" represents that the topic of the content is mainly about crowds.</li>
4350 * <li>"party" represents that the topic of the content is mainly about parties.</li>
4351 * <li>"animal" represent that the topic of the content is mainly about animals.</li>
4352 * <li>"plant" represents that the topic of the content is mainly about plants, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004353 * flowers.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004354 * <li>"vacation" represents that the topic of the content is mainly about vacations.</li>
4355 * <li>"fashion" represents that the topic of the content is mainly about fashion, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004356 * sunglasses, jewelry, handbags and clothing.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004357 * <li>"material" represents that the topic of the content is mainly about materials, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004358 * paper, and silk.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004359 * <li>"vehicle" represents that the topic of the content is mainly about vehicles, like
Kang Li9fa2a2c2017-01-06 13:33:24 -08004360 * cars, and boats.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004361 * <li>"document" represents that the topic of the content is mainly about documents, e.g.
Kang Li9fa2a2c2017-01-06 13:33:24 -08004362 * posters.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004363 * <li>"design" represents that the topic of the content is mainly about design, e.g. arts
Kang Li9fa2a2c2017-01-06 13:33:24 -08004364 * and designs of houses.</li>
Kang Lifadc0162017-04-19 11:56:05 -07004365 * <li>"holiday" represents that the topic of the content is mainly about holidays, e.g.,
Kang Li9fa2a2c2017-01-06 13:33:24 -08004366 * Christmas and Thanksgiving.</li>
4367 * </ul>
4368 */
4369 public static final String EXTRA_CONTENT_ANNOTATIONS
4370 = "android.intent.extra.CONTENT_ANNOTATIONS";
4371
4372 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07004373 * A {@link ResultReceiver} used to return data back to the sender.
4374 *
4375 * <p>Used to complete an app-specific
4376 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
4377 *
4378 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
4379 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
4380 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
4381 * when the user selects a target component from the chooser. It is up to the recipient
4382 * to send a result to this ResultReceiver to signal that disambiguation is complete
4383 * and that the chooser should invoke the user's choice.</p>
4384 *
4385 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4386 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4387 * to match and fill in the final Intent or ChooserTarget before starting it.
4388 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4389 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4390 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4391 *
4392 * <p>The result code passed to the ResultReceiver should be
4393 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4394 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4395 * the chooser should finish without starting a target.</p>
4396 */
4397 public static final String EXTRA_RESULT_RECEIVER
4398 = "android.intent.extra.RESULT_RECEIVER";
4399
4400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004401 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004402 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004403 */
4404 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4405
4406 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004407 * A Parcelable[] of {@link Intent} or
4408 * {@link android.content.pm.LabeledIntent} objects as set with
4409 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4410 * a the front of the list of choices, when shown to the user with a
4411 * {@link #ACTION_CHOOSER}.
4412 */
4413 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4414
4415 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004416 * A {@link IntentSender} to start after ephemeral installation success.
Patrick Baumann159cd022018-01-11 13:25:05 -08004417 * @deprecated Use {@link #EXTRA_INSTANT_APP_SUCCESS).
4418 * @removed
Todd Kennedy7440f172015-12-09 14:31:22 -08004419 * @hide
4420 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004421 @Deprecated
Todd Kennedy7440f172015-12-09 14:31:22 -08004422 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4423
4424 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004425 * A {@link IntentSender} to start after instant app installation success.
Todd Kennedy7440f172015-12-09 14:31:22 -08004426 * @hide
4427 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004428 @SystemApi
4429 public static final String EXTRA_INSTANT_APP_SUCCESS =
4430 "android.intent.extra.INSTANT_APP_SUCCESS";
4431
4432 /**
4433 * A {@link IntentSender} to start after ephemeral installation failure.
4434 * @deprecated Use {@link #EXTRA_INSTANT_APP_FAILURE).
4435 * @removed
4436 * @hide
4437 */
4438 @Deprecated
Todd Kennedy7440f172015-12-09 14:31:22 -08004439 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4440
4441 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004442 * A {@link IntentSender} to start after instant app installation failure.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004443 * @hide
4444 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004445 @SystemApi
4446 public static final String EXTRA_INSTANT_APP_FAILURE =
4447 "android.intent.extra.INSTANT_APP_FAILURE";
4448
4449 /**
4450 * The host name that triggered an ephemeral resolution.
4451 * @deprecated Use {@link #EXTRA_INSTANT_APP_HOSTNAME).
4452 * @removed
4453 * @hide
4454 */
4455 @Deprecated
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004456 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4457
4458 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004459 * The host name that triggered an instant app resolution.
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004460 * @hide
4461 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004462 @SystemApi
4463 public static final String EXTRA_INSTANT_APP_HOSTNAME =
4464 "android.intent.extra.INSTANT_APP_HOSTNAME";
4465
4466 /**
4467 * An opaque token to track ephemeral resolution.
4468 * @deprecated Use {@link #EXTRA_INSTANT_APP_TOKEN).
4469 * @removed
4470 * @hide
4471 */
4472 @Deprecated
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004473 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4474
4475 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004476 * An opaque token to track instant app resolution.
4477 * @hide
4478 */
4479 @SystemApi
4480 public static final String EXTRA_INSTANT_APP_TOKEN =
4481 "android.intent.extra.INSTANT_APP_TOKEN";
4482
4483 /**
Patrick Baumannb4165d72017-12-04 11:29:24 -08004484 * The action that triggered an instant application resolution.
4485 * @hide
4486 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004487 @SystemApi
Patrick Baumannb4165d72017-12-04 11:29:24 -08004488 public static final String EXTRA_INSTANT_APP_ACTION = "android.intent.extra.INSTANT_APP_ACTION";
4489
4490 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004491 * An array of {@link Bundle}s containing details about resolved instant apps..
4492 * @hide
4493 */
4494 @SystemApi
4495 public static final String EXTRA_INSTANT_APP_BUNDLES =
4496 "android.intent.extra.INSTANT_APP_BUNDLES";
4497
4498 /**
4499 * A {@link Bundle} of metadata that describes the instant application that needs to be
Patrick Baumann709ee152017-12-04 16:12:52 -08004500 * installed. This data is populated from the response to
4501 * {@link android.content.pm.InstantAppResolveInfo#getExtras()} as provided by the registered
4502 * instant application resolver.
4503 * @hide
4504 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004505 @SystemApi
Patrick Baumann709ee152017-12-04 16:12:52 -08004506 public static final String EXTRA_INSTANT_APP_EXTRAS =
4507 "android.intent.extra.INSTANT_APP_EXTRAS";
4508
4509 /**
Patrick Baumann577d4022018-01-31 16:55:10 +00004510 * A boolean value indicating that the instant app resolver was unable to state with certainty
4511 * that it did or did not have an app for the sanitized {@link Intent} defined at
4512 * {@link #EXTRA_INTENT}.
4513 * @hide
4514 */
4515 @SystemApi
4516 public static final String EXTRA_UNKNOWN_INSTANT_APP =
4517 "android.intent.extra.UNKNOWN_INSTANT_APP";
4518
4519 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004520 * The version code of the app to install components from.
Dianne Hackborn3accca02013-09-20 09:32:11 -07004521 * @deprecated Use {@link #EXTRA_LONG_VERSION_CODE).
Todd Kennedy316c2f22017-01-23 15:40:07 -08004522 * @hide
4523 */
Dianne Hackborn3accca02013-09-20 09:32:11 -07004524 @Deprecated
Todd Kennedy316c2f22017-01-23 15:40:07 -08004525 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4526
4527 /**
Dianne Hackborn3accca02013-09-20 09:32:11 -07004528 * The version code of the app to install components from.
4529 * @hide
4530 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004531 @SystemApi
Dianne Hackborn3accca02013-09-20 09:32:11 -07004532 public static final String EXTRA_LONG_VERSION_CODE = "android.intent.extra.LONG_VERSION_CODE";
4533
4534 /**
Patrick Baumann159cd022018-01-11 13:25:05 -08004535 * The app that triggered the instant app installation.
Chad Brubaker06068612017-04-06 09:43:47 -07004536 * @hide
4537 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004538 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004539 public static final String EXTRA_CALLING_PACKAGE
4540 = "android.intent.extra.CALLING_PACKAGE";
4541
4542 /**
4543 * Optional calling app provided bundle containing additional launch information the
4544 * installer may use.
4545 * @hide
4546 */
Patrick Baumann159cd022018-01-11 13:25:05 -08004547 @SystemApi
Chad Brubaker06068612017-04-06 09:43:47 -07004548 public static final String EXTRA_VERIFICATION_BUNDLE
4549 = "android.intent.extra.VERIFICATION_BUNDLE";
4550
4551 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004552 * A Bundle forming a mapping of potential target package names to different extras Bundles
4553 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4554 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4555 * be currently installed on the device.
4556 *
4557 * <p>An application may choose to provide alternate extras for the case where a user
4558 * selects an activity from a predetermined set of target packages. If the activity
4559 * the user selects from the chooser belongs to a package with its package name as
4560 * a key in this bundle, the corresponding extras for that package will be merged with
4561 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4562 * extra has the same key as an extra already present in the intent it will overwrite
4563 * the extra from the intent.</p>
4564 *
4565 * <p><em>Examples:</em>
4566 * <ul>
4567 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4568 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4569 * parameters for that target.</li>
4570 * <li>An application may offer additional metadata for known targets of a given intent
4571 * to pass along information only relevant to that target such as account or content
4572 * identifiers already known to that application.</li>
4573 * </ul></p>
4574 */
4575 public static final String EXTRA_REPLACEMENT_EXTRAS =
4576 "android.intent.extra.REPLACEMENT_EXTRAS";
4577
4578 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004579 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4580 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4581 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4582 * {@link ComponentName} of the chosen component.
4583 *
4584 * <p>In some situations this callback may never come, for example if the user abandons
4585 * the chooser, switches to another task or any number of other reasons. Apps should not
4586 * be written assuming that this callback will always occur.</p>
4587 */
4588 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4589 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4590
4591 /**
4592 * The {@link ComponentName} chosen by the user to complete an action.
4593 *
4594 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4595 */
4596 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4597
4598 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004599 * A {@link android.view.KeyEvent} object containing the event that
4600 * triggered the creation of the Intent it is in.
4601 */
4602 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4603
4604 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004605 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4606 * before shutting down.
4607 *
4608 * {@hide}
4609 */
4610 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4611
4612 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004613 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4614 * requested by the user.
4615 *
4616 * {@hide}
4617 */
4618 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4619 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4620
4621 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004622 * 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 -07004623 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4624 * of restarting the application.
4625 */
4626 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4627
4628 /**
4629 * A String holding the phone number originally entered in
4630 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4631 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4632 */
4633 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004634
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004635 /**
4636 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4637 * intents to supply the uid the package had been assigned. Also an optional
4638 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4639 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4640 * purpose.
4641 */
4642 public static final String EXTRA_UID = "android.intent.extra.UID";
4643
4644 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004645 * @hide String array of package names.
4646 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004647 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004648 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4649
4650 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004651 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4652 * intents to indicate whether this represents a full uninstall (removing
4653 * both the code and its data) or a partial uninstall (leaving its data,
4654 * implying that this is an update).
4655 */
4656 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004657
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004658 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004659 * @hide
4660 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4661 * intents to indicate that at this point the package has been removed for
4662 * all users on the device.
4663 */
4664 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4665 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4666
4667 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004668 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4669 * intents to indicate that this is a replacement of the package, so this
4670 * broadcast will immediately be followed by an add broadcast for a
4671 * different version of the same package.
4672 */
4673 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004674
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004676 * Used as an int extra field in {@link android.app.AlarmManager} intents
4677 * to tell the application being invoked how many pending alarms are being
4678 * delievered with the intent. For one-shot alarms this will always be 1.
4679 * For recurring alarms, this might be greater than 1 if the device was
4680 * asleep or powered off at the time an earlier alarm would have been
4681 * delivered.
4682 */
4683 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004684
Jacek Surazski86b6c532009-05-13 14:38:28 +02004685 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004686 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4687 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004688 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4689 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004690 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4691 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4692 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004693 */
4694 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4695
4696 /**
4697 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4698 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004699 */
4700 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4701
4702 /**
4703 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4704 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004705 */
4706 public static final int EXTRA_DOCK_STATE_DESK = 1;
4707
4708 /**
4709 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4710 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004711 */
4712 public static final int EXTRA_DOCK_STATE_CAR = 2;
4713
4714 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004715 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4716 * to represent that the phone is in a analog (low end) dock.
4717 */
4718 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4719
4720 /**
4721 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4722 * to represent that the phone is in a digital (high end) dock.
4723 */
4724 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4725
4726 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004727 * Boolean that can be supplied as meta-data with a dock activity, to
4728 * indicate that the dock should take over the home key when it is active.
4729 */
4730 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004731
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004732 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004733 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4734 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004735 */
4736 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4737
4738 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004739 * Used in the extra field in the remote intent. It's astring token passed with the
4740 * remote intent.
4741 */
4742 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4743 "android.intent.extra.remote_intent_token";
4744
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004745 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004746 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004747 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004748 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004749 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004750 "android.intent.extra.changed_component_name";
4751
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004752 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004753 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004754 * and contains a string array of all of the components that have changed. If
4755 * the state of the overall package has changed, then it will contain an entry
4756 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004757 */
4758 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4759 "android.intent.extra.changed_component_name_list";
4760
4761 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004762 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004763 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004764 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4765 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4766 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004767 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004768 */
4769 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4770 "android.intent.extra.changed_package_list";
4771
4772 /**
4773 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004774 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4775 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004776 * and contains an integer array of uids of all of the components
4777 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004778 */
4779 public static final String EXTRA_CHANGED_UID_LIST =
4780 "android.intent.extra.changed_uid_list";
4781
4782 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004783 * @hide
4784 * Magic extra system code can use when binding, to give a label for
4785 * who it is that has bound to a service. This is an integer giving
4786 * a framework string resource that can be displayed to the user.
4787 */
4788 public static final String EXTRA_CLIENT_LABEL =
4789 "android.intent.extra.client_label";
4790
4791 /**
4792 * @hide
4793 * Magic extra system code can use when binding, to give a PendingIntent object
4794 * that can be launched for the user to disable the system's use of this
4795 * service.
4796 */
4797 public static final String EXTRA_CLIENT_INTENT =
4798 "android.intent.extra.client_intent";
4799
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004800 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004801 * Extra used to indicate that an intent should only return data that is on
4802 * the local device. This is a boolean extra; the default is false. If true,
4803 * an implementation should only allow the user to select data that is
4804 * already on the device, not requiring it be downloaded from a remote
4805 * service when opened.
4806 *
4807 * @see #ACTION_GET_CONTENT
4808 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004809 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004810 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004811 */
4812 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004813 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004814
Amith Yamasani13593602012-03-22 16:16:17 -07004815 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004816 * Extra used to indicate that an intent can allow the user to select and
4817 * return multiple items. This is a boolean extra; the default is false. If
4818 * true, an implementation is allowed to present the user with a UI where
4819 * they can pick multiple items that are all returned to the caller. When
4820 * this happens, they should be returned as the {@link #getClipData()} part
4821 * of the result Intent.
4822 *
4823 * @see #ACTION_GET_CONTENT
4824 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004825 */
4826 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004827 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004828
4829 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004830 * The integer userHandle carried with broadcast intents related to addition, removal and
4831 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4832 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4833 *
Amith Yamasani13593602012-03-22 16:16:17 -07004834 * @hide
4835 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004836 public static final String EXTRA_USER_HANDLE =
4837 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004838
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004839 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004840 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4841 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4842 */
4843 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004844 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004845
4846 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004847 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004848 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4849 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004850 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004851 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4852
4853 /**
4854 * Extra sent in the intent to the BroadcastReceiver that handles
4855 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4856 * the restrictions as key/value pairs.
4857 */
4858 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4859 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004860
Amith Yamasani86118ba2013-03-28 14:33:16 -07004861 /**
4862 * Extra used in the response from a BroadcastReceiver that handles
4863 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4864 */
4865 public static final String EXTRA_RESTRICTIONS_INTENT =
4866 "android.intent.extra.restrictions_intent";
4867
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004868 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004869 * Extra used to communicate a set of acceptable MIME types. The type of the
4870 * extra is {@code String[]}. Values may be a combination of concrete MIME
4871 * types (such as "image/png") and/or partial MIME types (such as
4872 * "audio/*").
4873 *
4874 * @see #ACTION_GET_CONTENT
4875 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004876 */
4877 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4878
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004879 /**
4880 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4881 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004882 * When this is true, hardware devices can use this information to determine that
4883 * they shouldn't do a complete shutdown of their device since this is not a
4884 * complete shutdown down to the kernel, but only user space restarting.
4885 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004886 */
4887 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4888 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4889
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004890 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004891 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4892 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4893 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4894 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004895 *
4896 * @hide for internal use only.
4897 */
4898 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4899 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004900 /** @hide */
4901 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4902 /** @hide */
4903 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4904 /** @hide */
4905 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004906
Jeff Davidsona0c7d1f2017-11-01 17:41:41 -07004907 /**
4908 * Intent extra: the reason that the operation associated with this intent is being performed.
4909 *
4910 * <p>Type: String
4911 * @hide
4912 */
4913 @SystemApi
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004914 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4915
qingxi240c2bb2017-04-12 17:31:18 -07004916 /**
4917 * {@hide}
4918 * This extra will be send together with {@link #ACTION_FACTORY_RESET}
4919 */
Rubin Xue8490f12015-06-25 12:17:48 +01004920 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4921
Santos Cordon15a13782015-03-31 18:32:31 -07004922 /**
qingxi240c2bb2017-04-12 17:31:18 -07004923 * {@hide}
4924 * This extra will be set to true when the user choose to wipe the data on eSIM during factory
4925 * reset for the device with eSIM. This extra will be sent together with
4926 * {@link #ACTION_FACTORY_RESET}
4927 */
4928 public static final String EXTRA_WIPE_ESIMS = "com.android.internal.intent.extra.WIPE_ESIMS";
4929
4930 /**
Santos Cordon15a13782015-03-31 18:32:31 -07004931 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4932 * activation request.
4933 * TODO: Add information about the structure and response data used with the pending intent.
4934 * @hide
4935 */
4936 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4937 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4938
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004939 /**
4940 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004941 *
4942 * <p>The value must be an integer greater or equal to 0.
Garfield Tance1d0e92017-03-23 10:52:48 -07004943 * @see #ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004944 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004945 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4946
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004947 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004948 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4949 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4950 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004951 *
4952 * <p>The value is boolean. By default false.
Garfield Tance1d0e92017-03-23 10:52:48 -07004953 * @see #ACTION_QUICK_VIEW
4954 * @removed
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004955 */
Garfield Tance1d0e92017-03-23 10:52:48 -07004956 @Deprecated
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004957 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4958 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004959
4960 /**
Garfield Tance1d0e92017-03-23 10:52:48 -07004961 * An optional extra of {@code String[]} indicating which quick view features should be made
4962 * available to the user in the quick view UI while handing a
4963 * {@link Intent#ACTION_QUICK_VIEW} intent.
4964 * <li>Enumeration of features here is not meant to restrict capabilities of the quick viewer.
4965 * Quick viewer can implement features not listed below.
4966 * <li>Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW},
Geoffrey Pitschbc02b772017-12-06 11:24:15 -05004967 * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DELETE},
4968 * {@link QuickViewConstants#FEATURE_DOWNLOAD}, {@link QuickViewConstants#FEATURE_SEND},
4969 * {@link QuickViewConstants#FEATURE_PRINT}.
Garfield Tance1d0e92017-03-23 10:52:48 -07004970 * <p>
4971 * Requirements:
4972 * <li>Quick viewer shouldn't show a feature if the feature is absent in
4973 * {@link #EXTRA_QUICK_VIEW_FEATURES}.
4974 * <li>When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow
4975 * internal policies.
4976 * <li>Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a
4977 * requirement that the feature be shown. Quick viewer may, according to its own policies,
4978 * disable or hide features.
4979 *
4980 * @see #ACTION_QUICK_VIEW
4981 */
4982 public static final String EXTRA_QUICK_VIEW_FEATURES =
4983 "android.intent.extra.QUICK_VIEW_FEATURES";
4984
4985 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004986 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004987 * When a profile goes into quiet mode, all apps in the profile are killed and the
4988 * profile user is stopped. Widgets originating from the profile are masked, and app
4989 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004990 */
4991 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004992
4993 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004994 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004995 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004996 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4997 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004998 *
4999 * @hide
5000 */
5001 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
5002 "android.intent.extra.MEDIA_RESOURCE_TYPE";
5003
5004 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07005005 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
5006 * whether to show the chooser or not when there is only one application available
5007 * to choose from.
5008 *
5009 * @hide
5010 */
5011 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
5012 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
5013
5014 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005015 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005016 * to represent that a video codec is allowed to use.
5017 *
5018 * @hide
5019 */
5020 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
5021
5022 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08005023 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09005024 * to represent that a audio codec is allowed to use.
5025 *
5026 * @hide
5027 */
5028 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
5029
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005030 // ---------------------------------------------------------------------
5031 // ---------------------------------------------------------------------
5032 // Intent flags (see mFlags variable).
5033
Tor Norbyed9273d62013-05-30 15:59:53 -07005034 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005035 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005036 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
5037 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07005038 @Retention(RetentionPolicy.SOURCE)
5039 public @interface GrantUriMode {}
5040
Jeff Sharkey846318a2014-04-04 12:12:41 -07005041 /** @hide */
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005042 @IntDef(flag = true, prefix = { "FLAG_GRANT_" }, value = {
Jeff Sharkey846318a2014-04-04 12:12:41 -07005043 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
5044 @Retention(RetentionPolicy.SOURCE)
5045 public @interface AccessUriMode {}
5046
5047 /**
5048 * Test if given mode flags specify an access mode, which must be at least
5049 * read and/or write.
5050 *
5051 * @hide
5052 */
5053 public static boolean isAccessUriMode(int modeFlags) {
5054 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
5055 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
5056 }
5057
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005058 /** @hide */
5059 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5060 FLAG_GRANT_READ_URI_PERMISSION,
5061 FLAG_GRANT_WRITE_URI_PERMISSION,
5062 FLAG_FROM_BACKGROUND,
5063 FLAG_DEBUG_LOG_RESOLUTION,
5064 FLAG_EXCLUDE_STOPPED_PACKAGES,
5065 FLAG_INCLUDE_STOPPED_PACKAGES,
5066 FLAG_GRANT_PERSISTABLE_URI_PERMISSION,
5067 FLAG_GRANT_PREFIX_URI_PERMISSION,
5068 FLAG_DEBUG_TRIAGED_MISSING,
5069 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005070 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005071 FLAG_ACTIVITY_NO_HISTORY,
5072 FLAG_ACTIVITY_SINGLE_TOP,
5073 FLAG_ACTIVITY_NEW_TASK,
5074 FLAG_ACTIVITY_MULTIPLE_TASK,
5075 FLAG_ACTIVITY_CLEAR_TOP,
5076 FLAG_ACTIVITY_FORWARD_RESULT,
5077 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5078 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5079 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5080 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5081 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5082 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5083 FLAG_ACTIVITY_NEW_DOCUMENT,
5084 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5085 FLAG_ACTIVITY_NO_USER_ACTION,
5086 FLAG_ACTIVITY_REORDER_TO_FRONT,
5087 FLAG_ACTIVITY_NO_ANIMATION,
5088 FLAG_ACTIVITY_CLEAR_TASK,
5089 FLAG_ACTIVITY_TASK_ON_HOME,
5090 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5091 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5092 FLAG_RECEIVER_REGISTERED_ONLY,
5093 FLAG_RECEIVER_REPLACE_PENDING,
5094 FLAG_RECEIVER_FOREGROUND,
5095 FLAG_RECEIVER_NO_ABORT,
5096 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5097 FLAG_RECEIVER_BOOT_UPGRADE,
5098 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5099 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5100 FLAG_RECEIVER_FROM_SHELL,
5101 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5102 })
5103 @Retention(RetentionPolicy.SOURCE)
5104 public @interface Flags {}
5105
5106 /** @hide */
5107 @IntDef(flag = true, prefix = { "FLAG_" }, value = {
5108 FLAG_FROM_BACKGROUND,
5109 FLAG_DEBUG_LOG_RESOLUTION,
5110 FLAG_EXCLUDE_STOPPED_PACKAGES,
5111 FLAG_INCLUDE_STOPPED_PACKAGES,
5112 FLAG_DEBUG_TRIAGED_MISSING,
5113 FLAG_IGNORE_EPHEMERAL,
Patrick Baumann577d4022018-01-31 16:55:10 +00005114 FLAG_ACTIVITY_MATCH_EXTERNAL,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005115 FLAG_ACTIVITY_NO_HISTORY,
5116 FLAG_ACTIVITY_SINGLE_TOP,
5117 FLAG_ACTIVITY_NEW_TASK,
5118 FLAG_ACTIVITY_MULTIPLE_TASK,
5119 FLAG_ACTIVITY_CLEAR_TOP,
5120 FLAG_ACTIVITY_FORWARD_RESULT,
5121 FLAG_ACTIVITY_PREVIOUS_IS_TOP,
5122 FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS,
5123 FLAG_ACTIVITY_BROUGHT_TO_FRONT,
5124 FLAG_ACTIVITY_RESET_TASK_IF_NEEDED,
5125 FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY,
5126 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5127 FLAG_ACTIVITY_NEW_DOCUMENT,
5128 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET,
5129 FLAG_ACTIVITY_NO_USER_ACTION,
5130 FLAG_ACTIVITY_REORDER_TO_FRONT,
5131 FLAG_ACTIVITY_NO_ANIMATION,
5132 FLAG_ACTIVITY_CLEAR_TASK,
5133 FLAG_ACTIVITY_TASK_ON_HOME,
5134 FLAG_ACTIVITY_RETAIN_IN_RECENTS,
5135 FLAG_ACTIVITY_LAUNCH_ADJACENT,
5136 FLAG_RECEIVER_REGISTERED_ONLY,
5137 FLAG_RECEIVER_REPLACE_PENDING,
5138 FLAG_RECEIVER_FOREGROUND,
5139 FLAG_RECEIVER_NO_ABORT,
5140 FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT,
5141 FLAG_RECEIVER_BOOT_UPGRADE,
5142 FLAG_RECEIVER_INCLUDE_BACKGROUND,
5143 FLAG_RECEIVER_EXCLUDE_BACKGROUND,
5144 FLAG_RECEIVER_FROM_SHELL,
5145 FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS,
5146 })
5147 @Retention(RetentionPolicy.SOURCE)
5148 public @interface MutableFlags {}
5149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005150 /**
5151 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005152 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005153 * specified in its ClipData. When applying to an Intent's ClipData,
5154 * all URIs as well as recursive traversals through data or other ClipData
5155 * in Intent items will be granted; only the grant flags of the top-level
5156 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005157 */
5158 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
5159 /**
5160 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005161 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005162 * specified in its ClipData. When applying to an Intent's ClipData,
5163 * all URIs as well as recursive traversals through data or other ClipData
5164 * in Intent items will be granted; only the grant flags of the top-level
5165 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005166 */
5167 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
5168 /**
5169 * Can be set by the caller to indicate that this Intent is coming from
5170 * a background operation, not from direct user interaction.
5171 */
5172 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
5173 /**
5174 * A flag you can enable for debugging: when set, log messages will be
5175 * printed during the resolution of this intent to show you what has
5176 * been found to create the final resolved list.
5177 */
5178 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08005179 /**
5180 * If set, this intent will not match any components in packages that
5181 * are currently stopped. If this is not set, then the default behavior
5182 * is to include such applications in the result.
5183 */
5184 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
5185 /**
5186 * If set, this intent will always match any components in packages that
5187 * are currently stopped. This is the default behavior when
5188 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
5189 * flags are set, this one wins (it allows overriding of exclude for
5190 * places where the framework may automatically set the exclude flag).
5191 */
5192 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005193
5194 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005195 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005196 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005197 * persisted across device reboots until explicitly revoked with
5198 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
5199 * grant for possible persisting; the receiving application must call
5200 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
5201 * actually persist.
5202 *
5203 * @see ContentResolver#takePersistableUriPermission(Uri, int)
5204 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
5205 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07005206 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005207 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07005208 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07005209
5210 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07005211 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
5212 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
5213 * applies to any URI that is a prefix match against the original granted
5214 * URI. (Without this flag, the URI must match exactly for access to be
5215 * granted.) Another URI is considered a prefix match only when scheme,
5216 * authority, and all path segments defined by the prefix are an exact
5217 * match.
5218 */
5219 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
5220
5221 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005222 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005223 * homework and verified that they correctly handle packages and components
5224 * that come and go over time. In particular:
5225 * <ul>
5226 * <li>Apps installed on external storage, which will appear to be
5227 * uninstalled while the the device is ejected.
5228 * <li>Apps with encryption unaware components, which will appear to not
5229 * exist while the device is locked.
5230 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005231 *
5232 * @hide
5233 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07005234 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07005235
5236 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07005237 * Internal flag used to indicate ephemeral applications should not be
5238 * considered when resolving the intent.
5239 *
5240 * @hide
5241 */
5242 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
5243
5244 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005245 * If set, the new activity is not kept in the history stack. As soon as
5246 * the user navigates away from it, the activity is finished. This may also
5247 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
5248 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07005249 *
5250 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
5251 * is never invoked when the current activity starts a new activity which
5252 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005253 */
5254 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
5255 /**
5256 * If set, the activity will not be launched if it is already running
5257 * at the top of the history stack.
5258 */
5259 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
5260 /**
5261 * If set, this activity will become the start of a new task on this
5262 * history stack. A task (from the activity that started it to the
5263 * next task activity) defines an atomic group of activities that the
5264 * user can move to. Tasks can be moved to the foreground and background;
5265 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07005266 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08005267 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5268 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005269 *
5270 * <p>This flag is generally used by activities that want
5271 * to present a "launcher" style behavior: they give the user a list of
5272 * separate things that can be done, which otherwise run completely
5273 * independently of the activity launching them.
5274 *
5275 * <p>When using this flag, if a task is already running for the activity
5276 * you are now starting, then a new activity will not be started; instead,
5277 * the current task will simply be brought to the front of the screen with
5278 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
5279 * to disable this behavior.
5280 *
5281 * <p>This flag can not be used when the caller is requesting a result from
5282 * the activity being launched.
5283 */
5284 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
5285 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07005286 * This flag is used to create a new task and launch an activity into it.
5287 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
5288 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
5289 * search through existing tasks for ones matching this Intent. Only if no such
5290 * task is found would a new task be created. When paired with
5291 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
5292 * the search for a matching task and unconditionally start a new task.
5293 *
5294 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
5295 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005296 * top-level application launcher.</strong> Used in conjunction with
5297 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
5298 * behavior of bringing an existing task to the foreground. When set,
5299 * a new task is <em>always</em> started to host the Activity for the
5300 * Intent, regardless of whether there is already an existing task running
5301 * the same thing.
5302 *
5303 * <p><strong>Because the default system does not include graphical task management,
5304 * you should not use this flag unless you provide some way for a user to
5305 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07005306 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07005307 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
5308 * creating new document tasks.
5309 *
5310 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07005311 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005312 *
Scott Main7aee61f2011-02-08 11:25:01 -08005313 * <p>See
5314 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5315 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005316 *
5317 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
5318 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005319 */
5320 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
5321 /**
5322 * If set, and the activity being launched is already running in the
5323 * current task, then instead of launching a new instance of that activity,
5324 * all of the other activities on top of it will be closed and this Intent
5325 * will be delivered to the (now on top) old activity as a new Intent.
5326 *
5327 * <p>For example, consider a task consisting of the activities: A, B, C, D.
5328 * If D calls startActivity() with an Intent that resolves to the component
5329 * of activity B, then C and D will be finished and B receive the given
5330 * Intent, resulting in the stack now being: A, B.
5331 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005332 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005333 * either receive the new intent you are starting here in its
5334 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005335 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07005336 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
5337 * the same intent, then it will be finished and re-created; for all other
5338 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
5339 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005340 *
5341 * <p>This launch mode can also be used to good effect in conjunction with
5342 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
5343 * of a task, it will bring any currently running instance of that task
5344 * to the foreground, and then clear it to its root state. This is
5345 * especially useful, for example, when launching an activity from the
5346 * notification manager.
5347 *
Scott Main7aee61f2011-02-08 11:25:01 -08005348 * <p>See
5349 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5350 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005351 */
5352 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
5353 /**
5354 * If set and this intent is being used to launch a new activity from an
5355 * existing one, then the reply target of the existing activity will be
5356 * transfered to the new activity. This way the new activity can call
5357 * {@link android.app.Activity#setResult} and have that result sent back to
5358 * the reply target of the original activity.
5359 */
5360 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
5361 /**
5362 * If set and this intent is being used to launch a new activity from an
5363 * existing one, the current activity will not be counted as the top
5364 * activity for deciding whether the new intent should be delivered to
5365 * the top instead of starting a new one. The previous activity will
5366 * be used as the top, with the assumption being that the current activity
5367 * will finish itself immediately.
5368 */
5369 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
5370 /**
5371 * If set, the new activity is not kept in the list of recently launched
5372 * activities.
5373 */
5374 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
5375 /**
5376 * This flag is not normally set by application code, but set for you by
5377 * the system as described in the
5378 * {@link android.R.styleable#AndroidManifestActivity_launchMode
5379 * launchMode} documentation for the singleTask mode.
5380 */
5381 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
5382 /**
5383 * If set, and this activity is either being started in a new task or
5384 * bringing to the top an existing task, then it will be launched as
5385 * the front door of the task. This will result in the application of
5386 * any affinities needed to have that task in the proper state (either
5387 * moving activities to or from it), or simply resetting that task to
5388 * its initial state if needed.
5389 */
5390 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
5391 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005392 * This flag is not normally set by application code, but set for you by
5393 * the system if this activity is being launched from history
5394 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 */
5396 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005397 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005398 * @deprecated As of API 21 this performs identically to
5399 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005400 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07005401 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005402 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005403 /**
Craig Mautner026596b2014-05-21 15:35:44 -07005404 * This flag is used to open a document into a new task rooted at the activity launched
5405 * by this Intent. Through the use of this flag, or its equivalent attribute,
5406 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00005407 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005408 *
Craig Mautner026596b2014-05-21 15:35:44 -07005409 * <p>The use of the activity attribute form of this,
5410 * {@link android.R.attr#documentLaunchMode}, is
5411 * preferred over the Intent flag described here. The attribute form allows the
5412 * Activity to specify multiple document behavior for all launchers of the Activity
5413 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005414 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07005415 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
5416 * it is kept after the activity is finished is different than the use of
5417 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
5418 * this flag is being used to create a new recents entry, then by default that entry
5419 * will be removed once the activity is finished. You can modify this behavior with
5420 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
5421 *
Craig Mautner026596b2014-05-21 15:35:44 -07005422 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
5423 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
5424 * equivalent of the Activity manifest specifying {@link
5425 * android.R.attr#documentLaunchMode}="intoExisting". When used with
5426 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
5427 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07005428 *
Craig Mautner026596b2014-05-21 15:35:44 -07005429 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07005430 *
Craig Mautner026596b2014-05-21 15:35:44 -07005431 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07005432 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5433 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07005434 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07005435 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005436 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005437 * callback from occurring on the current frontmost activity before it is
5438 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07005439 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005440 * <p>Typically, an activity can rely on that callback to indicate that an
5441 * explicit user action has caused their activity to be moved out of the
5442 * foreground. The callback marks an appropriate point in the activity's
5443 * lifecycle for it to dismiss any notifications that it intends to display
5444 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07005445 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005446 * <p>If an activity is ever started via any non-user-driven events such as
5447 * phone-call receipt or an alarm handler, this flag should be passed to {@link
5448 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07005449 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005450 */
5451 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005452 /**
5453 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5454 * this flag will cause the launched activity to be brought to the front of its
5455 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07005456 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005457 * <p>For example, consider a task consisting of four activities: A, B, C, D.
5458 * If D calls startActivity() with an Intent that resolves to the component
5459 * of activity B, then B will be brought to the front of the history stack,
5460 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07005461 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005462 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07005463 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005464 */
5465 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005466 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005467 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5468 * this flag will prevent the system from applying an activity transition
5469 * animation to go to the next activity state. This doesn't mean an
5470 * animation will never run -- if another activity change happens that doesn't
5471 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005472 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07005473 * when you are going to do a series of activity operations but the
5474 * animation seen by the user shouldn't be driven by the first activity
5475 * change but rather a later one.
5476 */
5477 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
5478 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005479 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5480 * this flag will cause any existing task that would be associated with the
5481 * activity to be cleared before the activity is started. That is, the activity
5482 * becomes the new root of an otherwise empty task, and any old activities
5483 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5484 */
5485 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
5486 /**
5487 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
5488 * this flag will cause a newly launching task to be placed on top of the current
5489 * home activity task (if there is one). That is, pressing back from the task
5490 * will always return the user to home even if that was not the last activity they
5491 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
5492 */
5493 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
5494 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07005495 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
5496 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005497 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07005498 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07005499 * this flag. When set and the task's activity is finished, the recents
5500 * entry will remain in the interface for the user to re-launch it, like a
5501 * recents entry for a top-level application.
5502 * <p>
5503 * The receiving activity can override this request with
5504 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
5505 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07005506 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07005507 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07005508 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07005509
5510 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005511 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
5512 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08005513 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
5514 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005515 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08005516 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005517
Patrick Baumann577d4022018-01-31 16:55:10 +00005518
5519 /**
5520 * If set, resolution of this intent may take place via an instant app not
5521 * yet on the device if there does not yet exist an app on device to
5522 * resolve it.
5523 */
5524 public static final int FLAG_ACTIVITY_MATCH_EXTERNAL = 0x00000800;
5525
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08005526 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 * If set, when sending a broadcast only registered receivers will be
5528 * called -- no BroadcastReceiver components will be launched.
5529 */
5530 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005531 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005532 * If set, when sending a broadcast the new broadcast will replace
5533 * any existing pending broadcast that matches it. Matching is defined
5534 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
5535 * true for the intents of the two broadcasts. When a match is found,
5536 * the new broadcast (and receivers associated with it) will replace the
5537 * existing one in the pending broadcast list, remaining at the same
5538 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08005539 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08005540 * <p>This flag is most typically used with sticky broadcasts, which
5541 * only care about delivering the most recent values of the broadcast
5542 * to their receivers.
5543 */
5544 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
5545 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08005546 * If set, when sending a broadcast the recipient is allowed to run at
5547 * foreground priority, with a shorter timeout interval. During normal
5548 * broadcasts the receivers are not automatically hoisted out of the
5549 * background priority class.
5550 */
5551 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
5552 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07005553 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
5554 * They can still propagate results through to later receivers, but they can not prevent
5555 * later receivers from seeing the broadcast.
5556 */
5557 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
5558 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005559 * If set, when sending a broadcast <i>before boot has completed</i> only
5560 * registered receivers will be called -- no BroadcastReceiver components
5561 * will be launched. Sticky intent state will be recorded properly even
5562 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
5563 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07005564 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005565 * <p>This flag is only for use by system sevices as a convenience to
5566 * avoid having to implement a more complex mechanism around detection
5567 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07005568 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005569 * @hide
5570 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005571 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07005572 /**
5573 * Set when this broadcast is for a boot upgrade, a special mode that
5574 * allows the broadcast to be sent before the system is ready and launches
5575 * the app process with no providers running in it.
5576 * @hide
5577 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07005578 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005579 /**
5580 * If set, the broadcast will always go to manifest receivers in background (cached
5581 * or not running) apps, regardless of whether that would be done by default. By
5582 * default they will only receive broadcasts if the broadcast has specified an
5583 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08005584 *
5585 * NOTE: dumpstate uses this flag numerically, so when its value is changed
5586 * the broadcast code there must also be changed to match.
5587 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08005588 * @hide
5589 */
5590 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
5591 /**
5592 * If set, the broadcast will never go to manifest receivers in background (cached
5593 * or not running) apps, regardless of whether that would be done by default. By
5594 * default they will receive broadcasts if the broadcast has specified an
5595 * explicit component or package name.
5596 * @hide
5597 */
5598 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07005599 /**
5600 * If set, this broadcast is being sent from the shell.
5601 * @hide
5602 */
5603 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005604
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005605 /**
Chad Brubakerb7e34d52017-02-22 12:36:06 -08005606 * If set, the broadcast will be visible to receivers in Instant Apps. By default Instant Apps
5607 * will not receive broadcasts.
5608 *
5609 * <em>This flag has no effect when used by an Instant App.</em>
5610 */
5611 public static final int FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x00200000;
5612
5613 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07005614 * @hide Flags that can't be changed with PendingIntent.
5615 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07005616 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
5617 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
5618 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08005619
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005620 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005621 // ---------------------------------------------------------------------
5622 // toUri() and parseUri() options.
5623
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005624 /** @hide */
5625 @IntDef(flag = true, prefix = { "URI_" }, value = {
5626 URI_ALLOW_UNSAFE,
5627 URI_ANDROID_APP_SCHEME,
5628 URI_INTENT_SCHEME,
5629 })
5630 @Retention(RetentionPolicy.SOURCE)
5631 public @interface UriFlags {}
5632
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005633 /**
5634 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5635 * always has the "intent:" scheme. This syntax can be used when you want
5636 * to later disambiguate between URIs that are intended to describe an
5637 * Intent vs. all others that should be treated as raw URIs. When used
5638 * with {@link #parseUri}, any other scheme will result in a generic
5639 * VIEW action for that raw URI.
5640 */
5641 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08005642
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005643 /**
5644 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
5645 * always has the "android-app:" scheme. This is a variation of
5646 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
5647 * http/https URI being delivered to a specific package name. The format
5648 * is:
5649 *
5650 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005651 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005652 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005653 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5654 * you must also include a scheme; including a path also requires both a host and a scheme.
5655 * The final #Intent; fragment can be used without a scheme, host, or path.
5656 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005657 * used with intents that have a {@link #setSelector}, since the base intent
5658 * will always have an explicit package name.</p>
5659 *
5660 * <p>Some examples of how this scheme maps to Intent objects:</p>
5661 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5662 * <colgroup align="left" />
5663 * <colgroup align="left" />
5664 * <thead>
5665 * <tr><th>URI</th> <th>Intent</th></tr>
5666 * </thead>
5667 *
5668 * <tbody>
5669 * <tr><td><code>android-app://com.example.app</code></td>
5670 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5671 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5672 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5673 * </table></td>
5674 * </tr>
5675 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5676 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5677 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5678 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5679 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5680 * </table></td>
5681 * </tr>
5682 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5683 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5684 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5685 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5686 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5687 * </table></td>
5688 * </tr>
5689 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5690 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5691 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5692 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5693 * </table></td>
5694 * </tr>
5695 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5696 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5697 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5698 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5699 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5700 * </table></td>
5701 * </tr>
5702 * <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>
5703 * <td><table border="" style="margin:0" >
5704 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5705 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5706 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5707 * </table></td>
5708 * </tr>
5709 * </tbody>
5710 * </table>
5711 */
5712 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5713
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005714 /**
5715 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5716 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5717 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5718 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5719 * generated Intent can not cause unexpected data access to happen.
5720 *
5721 * <p>If you do not trust the source of the URI being parsed, you should still do further
5722 * processing to protect yourself from it. In particular, when using it to start an
5723 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5724 * that can handle it.</p>
5725 */
5726 public static final int URI_ALLOW_UNSAFE = 1<<2;
5727
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005728 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005729
5730 private String mAction;
5731 private Uri mData;
5732 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005733 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005734 private ComponentName mComponent;
5735 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005736 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005738 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005739 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005740 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005741 private int mContentUserHint = UserHandle.USER_CURRENT;
Todd Kennedyb3b431302017-03-20 16:05:48 -07005742 /** Token to track instant app launches. Local only; do not copy cross-process. */
5743 private String mLaunchToken;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005744
5745 // ---------------------------------------------------------------------
5746
Makoto Onuki97f82f22017-05-31 16:20:21 -07005747 private static final int COPY_MODE_ALL = 0;
5748 private static final int COPY_MODE_FILTER = 1;
5749 private static final int COPY_MODE_HISTORY = 2;
5750
5751 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07005752 @IntDef(prefix = { "COPY_MODE_" }, value = {
5753 COPY_MODE_ALL,
5754 COPY_MODE_FILTER,
5755 COPY_MODE_HISTORY
5756 })
Makoto Onuki97f82f22017-05-31 16:20:21 -07005757 @Retention(RetentionPolicy.SOURCE)
5758 public @interface CopyMode {}
5759
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005760 /**
5761 * Create an empty intent.
5762 */
5763 public Intent() {
5764 }
5765
5766 /**
5767 * Copy constructor.
5768 */
5769 public Intent(Intent o) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005770 this(o, COPY_MODE_ALL);
5771 }
5772
5773 private Intent(Intent o, @CopyMode int copyMode) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005774 this.mAction = o.mAction;
5775 this.mData = o.mData;
5776 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005777 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005778 this.mComponent = o.mComponent;
Makoto Onuki97f82f22017-05-31 16:20:21 -07005779
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005780 if (o.mCategories != null) {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005781 this.mCategories = new ArraySet<>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005782 }
Makoto Onuki97f82f22017-05-31 16:20:21 -07005783
5784 if (copyMode != COPY_MODE_FILTER) {
5785 this.mFlags = o.mFlags;
5786 this.mContentUserHint = o.mContentUserHint;
5787 this.mLaunchToken = o.mLaunchToken;
5788 if (o.mSourceBounds != null) {
5789 this.mSourceBounds = new Rect(o.mSourceBounds);
5790 }
5791 if (o.mSelector != null) {
5792 this.mSelector = new Intent(o.mSelector);
5793 }
5794
5795 if (copyMode != COPY_MODE_HISTORY) {
5796 if (o.mExtras != null) {
5797 this.mExtras = new Bundle(o.mExtras);
5798 }
5799 if (o.mClipData != null) {
5800 this.mClipData = new ClipData(o.mClipData);
5801 }
5802 } else {
5803 if (o.mExtras != null && !o.mExtras.maybeIsEmpty()) {
5804 this.mExtras = Bundle.STRIPPED;
5805 }
5806
5807 // Also set "stripped" clip data when we ever log mClipData in the (broadcast)
5808 // history.
5809 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005810 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005811 }
5812
5813 @Override
5814 public Object clone() {
5815 return new Intent(this);
5816 }
5817
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005818 /**
5819 * Make a clone of only the parts of the Intent that are relevant for
5820 * filter matching: the action, data, type, component, and categories.
5821 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005822 public @NonNull Intent cloneFilter() {
Makoto Onuki97f82f22017-05-31 16:20:21 -07005823 return new Intent(this, COPY_MODE_FILTER);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005824 }
5825
5826 /**
5827 * Create an intent with a given action. All other fields (data, type,
5828 * class) are null. Note that the action <em>must</em> be in a
5829 * namespace because Intents are used globally in the system -- for
5830 * example the system VIEW action is android.intent.action.VIEW; an
5831 * application's custom action would be something like
5832 * com.google.app.myapp.CUSTOM_ACTION.
5833 *
5834 * @param action The Intent action, such as ACTION_VIEW.
5835 */
5836 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005837 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005838 }
5839
5840 /**
5841 * Create an intent with a given action and for a given data url. Note
5842 * that the action <em>must</em> be in a namespace because Intents are
5843 * used globally in the system -- for example the system VIEW action is
5844 * android.intent.action.VIEW; an application's custom action would be
5845 * something like com.google.app.myapp.CUSTOM_ACTION.
5846 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005847 * <p><em>Note: scheme and host name matching in the Android framework is
5848 * case-sensitive, unlike the formal RFC. As a result,
5849 * you should always ensure that you write your Uri with these elements
5850 * using lower case letters, and normalize any Uris you receive from
5851 * outside of Android to ensure the scheme and host is lower case.</em></p>
5852 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005853 * @param action The Intent action, such as ACTION_VIEW.
5854 * @param uri The Intent data URI.
5855 */
5856 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005857 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005858 mData = uri;
5859 }
5860
5861 /**
5862 * Create an intent for a specific component. All other fields (action, data,
5863 * type, class) are null, though they can be modified later with explicit
5864 * calls. This provides a convenient way to create an intent that is
5865 * intended to execute a hard-coded class name, rather than relying on the
5866 * system to find an appropriate class for you; see {@link #setComponent}
5867 * for more information on the repercussions of this.
5868 *
5869 * @param packageContext A Context of the application package implementing
5870 * this class.
5871 * @param cls The component class that is to be used for the intent.
5872 *
5873 * @see #setClass
5874 * @see #setComponent
5875 * @see #Intent(String, android.net.Uri , Context, Class)
5876 */
5877 public Intent(Context packageContext, Class<?> cls) {
5878 mComponent = new ComponentName(packageContext, cls);
5879 }
5880
5881 /**
5882 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005883 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005884 * construct the Intent and then calling {@link #setClass} to set its
5885 * class.
5886 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005887 * <p><em>Note: scheme and host name matching in the Android framework is
5888 * case-sensitive, unlike the formal RFC. As a result,
5889 * you should always ensure that you write your Uri with these elements
5890 * using lower case letters, and normalize any Uris you receive from
5891 * outside of Android to ensure the scheme and host is lower case.</em></p>
5892 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005893 * @param action The Intent action, such as ACTION_VIEW.
5894 * @param uri The Intent data URI.
5895 * @param packageContext A Context of the application package implementing
5896 * this class.
5897 * @param cls The component class that is to be used for the intent.
5898 *
5899 * @see #Intent(String, android.net.Uri)
5900 * @see #Intent(Context, Class)
5901 * @see #setClass
5902 * @see #setComponent
5903 */
5904 public Intent(String action, Uri uri,
5905 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005906 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907 mData = uri;
5908 mComponent = new ComponentName(packageContext, cls);
5909 }
5910
5911 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005912 * Create an intent to launch the main (root) activity of a task. This
5913 * is the Intent that is started when the application's is launched from
5914 * Home. For anything else that wants to launch an application in the
5915 * same way, it is important that they use an Intent structured the same
5916 * way, and can use this function to ensure this is the case.
5917 *
5918 * <p>The returned Intent has the given Activity component as its explicit
5919 * component, {@link #ACTION_MAIN} as its action, and includes the
5920 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5921 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5922 * to do that through {@link #addFlags(int)} on the returned Intent.
5923 *
5924 * @param mainActivity The main activity component that this Intent will
5925 * launch.
5926 * @return Returns a newly created Intent that can be used to launch the
5927 * activity as a main application entry.
5928 *
5929 * @see #setClass
5930 * @see #setComponent
5931 */
5932 public static Intent makeMainActivity(ComponentName mainActivity) {
5933 Intent intent = new Intent(ACTION_MAIN);
5934 intent.setComponent(mainActivity);
5935 intent.addCategory(CATEGORY_LAUNCHER);
5936 return intent;
5937 }
5938
5939 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005940 * Make an Intent for the main activity of an application, without
5941 * specifying a specific activity to run but giving a selector to find
5942 * the activity. This results in a final Intent that is structured
5943 * the same as when the application is launched from
5944 * Home. For anything else that wants to launch an application in the
5945 * same way, it is important that they use an Intent structured the same
5946 * way, and can use this function to ensure this is the case.
5947 *
5948 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5949 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5950 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5951 * to do that through {@link #addFlags(int)} on the returned Intent.
5952 *
5953 * @param selectorAction The action name of the Intent's selector.
5954 * @param selectorCategory The name of a category to add to the Intent's
5955 * selector.
5956 * @return Returns a newly created Intent that can be used to launch the
5957 * activity as a main application entry.
5958 *
5959 * @see #setSelector(Intent)
5960 */
5961 public static Intent makeMainSelectorActivity(String selectorAction,
5962 String selectorCategory) {
5963 Intent intent = new Intent(ACTION_MAIN);
5964 intent.addCategory(CATEGORY_LAUNCHER);
5965 Intent selector = new Intent();
5966 selector.setAction(selectorAction);
5967 selector.addCategory(selectorCategory);
5968 intent.setSelector(selector);
5969 return intent;
5970 }
5971
5972 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005973 * Make an Intent that can be used to re-launch an application's task
5974 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5975 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5976 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5977 *
5978 * @param mainActivity The activity component that is the root of the
5979 * task; this is the activity that has been published in the application's
5980 * manifest as the main launcher icon.
5981 *
5982 * @return Returns a newly created Intent that can be used to relaunch the
5983 * activity's task in its root state.
5984 */
5985 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5986 Intent intent = makeMainActivity(mainActivity);
5987 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5988 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5989 return intent;
5990 }
5991
5992 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005993 * Call {@link #parseUri} with 0 flags.
5994 * @deprecated Use {@link #parseUri} instead.
5995 */
5996 @Deprecated
5997 public static Intent getIntent(String uri) throws URISyntaxException {
5998 return parseUri(uri, 0);
5999 }
Tom Taylord4a47292009-12-21 13:59:18 -08006000
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006001 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006002 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006003 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07006004 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006005 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006006 *
6007 * <p>The URI given here must not be relative -- that is, it must include
6008 * the scheme and full path.
6009 *
6010 * @param uri The URI to turn into an Intent.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006011 * @param flags Additional processing flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006012 *
6013 * @return Intent The newly created Intent object.
6014 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006015 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
6016 * it bad (as parsed by the Uri class) or the Intent data within the
6017 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08006018 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006019 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006020 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006021 public static Intent parseUri(String uri, @UriFlags int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006022 int i = 0;
6023 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006024 final boolean androidApp = uri.startsWith("android-app:");
6025
6026 // Validate intent scheme if requested.
6027 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
6028 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006029 Intent intent = new Intent(ACTION_VIEW);
6030 try {
6031 intent.setData(Uri.parse(uri));
6032 } catch (IllegalArgumentException e) {
6033 throw new URISyntaxException(uri, e.getMessage());
6034 }
6035 return intent;
6036 }
6037 }
Tom Taylord4a47292009-12-21 13:59:18 -08006038
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006039 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006040 // simple case
6041 if (i == -1) {
6042 if (!androidApp) {
6043 return new Intent(ACTION_VIEW, Uri.parse(uri));
6044 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006045
6046 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006047 } else if (!uri.startsWith("#Intent;", i)) {
6048 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006049 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006050 } else {
6051 i = -1;
6052 }
6053 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006055 // new format
6056 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006057 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006058 boolean explicitAction = false;
6059 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006060
6061 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006062 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006063 String data;
6064 if (i >= 0) {
6065 data = uri.substring(0, i);
6066 i += 8; // length of "#Intent;"
6067 } else {
6068 data = uri;
6069 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006070
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006071 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006072 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006073 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006074 if (eq < 0) eq = i-1;
6075 int semi = uri.indexOf(';', i);
6076 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006077
6078 // action
6079 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006080 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006081 if (!inSelector) {
6082 explicitAction = true;
6083 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006084 }
6085
6086 // categories
6087 else if (uri.startsWith("category=", i)) {
6088 intent.addCategory(value);
6089 }
6090
6091 // type
6092 else if (uri.startsWith("type=", i)) {
6093 intent.mType = value;
6094 }
6095
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006096 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006097 else if (uri.startsWith("launchFlags=", i)) {
6098 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006099 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6100 intent.mFlags &= ~IMMUTABLE_FLAGS;
6101 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006102 }
6103
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006104 // package
6105 else if (uri.startsWith("package=", i)) {
6106 intent.mPackage = value;
6107 }
6108
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006109 // component
6110 else if (uri.startsWith("component=", i)) {
6111 intent.mComponent = ComponentName.unflattenFromString(value);
6112 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006113
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006114 // scheme
6115 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006116 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006117 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006118 } else {
6119 scheme = value;
6120 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006121 }
6122
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006123 // source bounds
6124 else if (uri.startsWith("sourceBounds=", i)) {
6125 intent.mSourceBounds = Rect.unflattenFromString(value);
6126 }
6127
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006128 // selector
6129 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
6130 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006131 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006132 }
6133
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134 // extra
6135 else {
6136 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006137 // create Bundle if it doesn't already exist
6138 if (intent.mExtras == null) intent.mExtras = new Bundle();
6139 Bundle b = intent.mExtras;
6140 // add EXTRA
6141 if (uri.startsWith("S.", i)) b.putString(key, value);
6142 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
6143 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
6144 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
6145 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
6146 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
6147 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
6148 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
6149 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
6150 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
6151 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006152
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006153 // move to the next item
6154 i = semi + 1;
6155 }
6156
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006157 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006158 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006159 if (baseIntent.mPackage == null) {
6160 baseIntent.setSelector(intent);
6161 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006162 intent = baseIntent;
6163 }
6164
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006165 if (data != null) {
6166 if (data.startsWith("intent:")) {
6167 data = data.substring(7);
6168 if (scheme != null) {
6169 data = scheme + ':' + data;
6170 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006171 } else if (data.startsWith("android-app:")) {
6172 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
6173 // Correctly formed android-app, first part is package name.
6174 int end = data.indexOf('/', 14);
6175 if (end < 0) {
6176 // All we have is a package name.
6177 intent.mPackage = data.substring(14);
6178 if (!explicitAction) {
6179 intent.setAction(ACTION_MAIN);
6180 }
6181 data = "";
6182 } else {
6183 // Target the Intent at the given package name always.
6184 String authority = null;
6185 intent.mPackage = data.substring(14, end);
6186 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006187 if ((end+1) < data.length()) {
6188 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
6189 // Found a scheme, remember it.
6190 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006191 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08006192 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
6193 // Found a authority, remember it.
6194 authority = data.substring(end+1, newEnd);
6195 end = newEnd;
6196 }
6197 } else {
6198 // All we have is a scheme.
6199 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08006200 }
6201 }
6202 if (scheme == null) {
6203 // If there was no scheme, then this just targets the package.
6204 if (!explicitAction) {
6205 intent.setAction(ACTION_MAIN);
6206 }
6207 data = "";
6208 } else if (authority == null) {
6209 data = scheme + ":";
6210 } else {
6211 data = scheme + "://" + authority + data.substring(end);
6212 }
6213 }
6214 } else {
6215 data = "";
6216 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006217 }
Tom Taylord4a47292009-12-21 13:59:18 -08006218
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006219 if (data.length() > 0) {
6220 try {
6221 intent.mData = Uri.parse(data);
6222 } catch (IllegalArgumentException e) {
6223 throw new URISyntaxException(uri, e.getMessage());
6224 }
6225 }
6226 }
Tom Taylord4a47292009-12-21 13:59:18 -08006227
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006228 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07006229
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006230 } catch (IndexOutOfBoundsException e) {
6231 throw new URISyntaxException(uri, "illegal Intent URI format", i);
6232 }
6233 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006234
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006235 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006236 return getIntentOld(uri, 0);
6237 }
6238
6239 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006240 Intent intent;
6241
6242 int i = uri.lastIndexOf('#');
6243 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006244 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006245 final int intentFragmentStart = i;
6246 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006247
6248 i++;
6249
6250 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006251 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006252 i += 7;
6253 int j = uri.indexOf(')', i);
6254 action = uri.substring(i, j);
6255 i = j + 1;
6256 }
6257
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006258 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006259
6260 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006261 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006262 i += 11;
6263 int j = uri.indexOf(')', i);
6264 while (i < j) {
6265 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07006266 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006267 if (i < sep) {
6268 intent.addCategory(uri.substring(i, sep));
6269 }
6270 i = sep + 1;
6271 }
6272 i = j + 1;
6273 }
6274
6275 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006276 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006277 i += 5;
6278 int j = uri.indexOf(')', i);
6279 intent.mType = uri.substring(i, j);
6280 i = j + 1;
6281 }
6282
6283 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006284 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006285 i += 12;
6286 int j = uri.indexOf(')', i);
6287 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08006288 if ((flags& URI_ALLOW_UNSAFE) == 0) {
6289 intent.mFlags &= ~IMMUTABLE_FLAGS;
6290 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006291 i = j + 1;
6292 }
6293
6294 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006295 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006296 i += 10;
6297 int j = uri.indexOf(')', i);
6298 int sep = uri.indexOf('!', i);
6299 if (sep >= 0 && sep < j) {
6300 String pkg = uri.substring(i, sep);
6301 String cls = uri.substring(sep + 1, j);
6302 intent.mComponent = new ComponentName(pkg, cls);
6303 }
6304 i = j + 1;
6305 }
6306
6307 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006308 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006309 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07006310
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006311 final int closeParen = uri.indexOf(')', i);
6312 if (closeParen == -1) throw new URISyntaxException(uri,
6313 "EXTRA missing trailing ')'", i);
6314
6315 while (i < closeParen) {
6316 // fetch the key value
6317 int j = uri.indexOf('=', i);
6318 if (j <= i + 1 || i >= closeParen) {
6319 throw new URISyntaxException(uri, "EXTRA missing '='", i);
6320 }
6321 char type = uri.charAt(i);
6322 i++;
6323 String key = uri.substring(i, j);
6324 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07006325
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006326 // get type-value
6327 j = uri.indexOf('!', i);
6328 if (j == -1 || j >= closeParen) j = closeParen;
6329 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6330 String value = uri.substring(i, j);
6331 i = j;
6332
6333 // create Bundle if it doesn't already exist
6334 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07006335
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006336 // add item to bundle
6337 try {
6338 switch (type) {
6339 case 'S':
6340 intent.mExtras.putString(key, Uri.decode(value));
6341 break;
6342 case 'B':
6343 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
6344 break;
6345 case 'b':
6346 intent.mExtras.putByte(key, Byte.parseByte(value));
6347 break;
6348 case 'c':
6349 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
6350 break;
6351 case 'd':
6352 intent.mExtras.putDouble(key, Double.parseDouble(value));
6353 break;
6354 case 'f':
6355 intent.mExtras.putFloat(key, Float.parseFloat(value));
6356 break;
6357 case 'i':
6358 intent.mExtras.putInt(key, Integer.parseInt(value));
6359 break;
6360 case 'l':
6361 intent.mExtras.putLong(key, Long.parseLong(value));
6362 break;
6363 case 's':
6364 intent.mExtras.putShort(key, Short.parseShort(value));
6365 break;
6366 default:
6367 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
6368 }
6369 } catch (NumberFormatException e) {
6370 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
6371 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006372
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006373 char ch = uri.charAt(i);
6374 if (ch == ')') break;
6375 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
6376 i++;
6377 }
6378 }
6379
Dianne Hackborn6cca1592009-09-20 12:40:03 -07006380 if (isIntentFragment) {
6381 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
6382 } else {
6383 intent.mData = Uri.parse(uri);
6384 }
Tom Taylord4a47292009-12-21 13:59:18 -08006385
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006386 if (intent.mAction == null) {
6387 // By default, if no action is specified, then use VIEW.
6388 intent.mAction = ACTION_VIEW;
6389 }
6390
6391 } else {
6392 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
6393 }
6394
6395 return intent;
6396 }
6397
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006398 /** @hide */
6399 public interface CommandOptionHandler {
6400 boolean handleOption(String opt, ShellCommand cmd);
6401 }
6402
6403 /** @hide */
6404 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
6405 throws URISyntaxException {
6406 Intent intent = new Intent();
6407 Intent baseIntent = intent;
6408 boolean hasIntentInfo = false;
6409
6410 Uri data = null;
6411 String type = null;
6412
6413 String opt;
6414 while ((opt=cmd.getNextOption()) != null) {
6415 switch (opt) {
6416 case "-a":
6417 intent.setAction(cmd.getNextArgRequired());
6418 if (intent == baseIntent) {
6419 hasIntentInfo = true;
6420 }
6421 break;
6422 case "-d":
6423 data = Uri.parse(cmd.getNextArgRequired());
6424 if (intent == baseIntent) {
6425 hasIntentInfo = true;
6426 }
6427 break;
6428 case "-t":
6429 type = cmd.getNextArgRequired();
6430 if (intent == baseIntent) {
6431 hasIntentInfo = true;
6432 }
6433 break;
6434 case "-c":
6435 intent.addCategory(cmd.getNextArgRequired());
6436 if (intent == baseIntent) {
6437 hasIntentInfo = true;
6438 }
6439 break;
6440 case "-e":
6441 case "--es": {
6442 String key = cmd.getNextArgRequired();
6443 String value = cmd.getNextArgRequired();
6444 intent.putExtra(key, value);
6445 }
6446 break;
6447 case "--esn": {
6448 String key = cmd.getNextArgRequired();
6449 intent.putExtra(key, (String) null);
6450 }
6451 break;
6452 case "--ei": {
6453 String key = cmd.getNextArgRequired();
6454 String value = cmd.getNextArgRequired();
6455 intent.putExtra(key, Integer.decode(value));
6456 }
6457 break;
6458 case "--eu": {
6459 String key = cmd.getNextArgRequired();
6460 String value = cmd.getNextArgRequired();
6461 intent.putExtra(key, Uri.parse(value));
6462 }
6463 break;
6464 case "--ecn": {
6465 String key = cmd.getNextArgRequired();
6466 String value = cmd.getNextArgRequired();
6467 ComponentName cn = ComponentName.unflattenFromString(value);
6468 if (cn == null)
6469 throw new IllegalArgumentException("Bad component name: " + value);
6470 intent.putExtra(key, cn);
6471 }
6472 break;
6473 case "--eia": {
6474 String key = cmd.getNextArgRequired();
6475 String value = cmd.getNextArgRequired();
6476 String[] strings = value.split(",");
6477 int[] list = new int[strings.length];
6478 for (int i = 0; i < strings.length; i++) {
6479 list[i] = Integer.decode(strings[i]);
6480 }
6481 intent.putExtra(key, list);
6482 }
6483 break;
6484 case "--eial": {
6485 String key = cmd.getNextArgRequired();
6486 String value = cmd.getNextArgRequired();
6487 String[] strings = value.split(",");
6488 ArrayList<Integer> list = new ArrayList<>(strings.length);
6489 for (int i = 0; i < strings.length; i++) {
6490 list.add(Integer.decode(strings[i]));
6491 }
6492 intent.putExtra(key, list);
6493 }
6494 break;
6495 case "--el": {
6496 String key = cmd.getNextArgRequired();
6497 String value = cmd.getNextArgRequired();
6498 intent.putExtra(key, Long.valueOf(value));
6499 }
6500 break;
6501 case "--ela": {
6502 String key = cmd.getNextArgRequired();
6503 String value = cmd.getNextArgRequired();
6504 String[] strings = value.split(",");
6505 long[] list = new long[strings.length];
6506 for (int i = 0; i < strings.length; i++) {
6507 list[i] = Long.valueOf(strings[i]);
6508 }
6509 intent.putExtra(key, list);
6510 hasIntentInfo = true;
6511 }
6512 break;
6513 case "--elal": {
6514 String key = cmd.getNextArgRequired();
6515 String value = cmd.getNextArgRequired();
6516 String[] strings = value.split(",");
6517 ArrayList<Long> list = new ArrayList<>(strings.length);
6518 for (int i = 0; i < strings.length; i++) {
6519 list.add(Long.valueOf(strings[i]));
6520 }
6521 intent.putExtra(key, list);
6522 hasIntentInfo = true;
6523 }
6524 break;
6525 case "--ef": {
6526 String key = cmd.getNextArgRequired();
6527 String value = cmd.getNextArgRequired();
6528 intent.putExtra(key, Float.valueOf(value));
6529 hasIntentInfo = true;
6530 }
6531 break;
6532 case "--efa": {
6533 String key = cmd.getNextArgRequired();
6534 String value = cmd.getNextArgRequired();
6535 String[] strings = value.split(",");
6536 float[] list = new float[strings.length];
6537 for (int i = 0; i < strings.length; i++) {
6538 list[i] = Float.valueOf(strings[i]);
6539 }
6540 intent.putExtra(key, list);
6541 hasIntentInfo = true;
6542 }
6543 break;
6544 case "--efal": {
6545 String key = cmd.getNextArgRequired();
6546 String value = cmd.getNextArgRequired();
6547 String[] strings = value.split(",");
6548 ArrayList<Float> list = new ArrayList<>(strings.length);
6549 for (int i = 0; i < strings.length; i++) {
6550 list.add(Float.valueOf(strings[i]));
6551 }
6552 intent.putExtra(key, list);
6553 hasIntentInfo = true;
6554 }
6555 break;
6556 case "--esa": {
6557 String key = cmd.getNextArgRequired();
6558 String value = cmd.getNextArgRequired();
6559 // Split on commas unless they are preceeded by an escape.
6560 // The escape character must be escaped for the string and
6561 // again for the regex, thus four escape characters become one.
6562 String[] strings = value.split("(?<!\\\\),");
6563 intent.putExtra(key, strings);
6564 hasIntentInfo = true;
6565 }
6566 break;
6567 case "--esal": {
6568 String key = cmd.getNextArgRequired();
6569 String value = cmd.getNextArgRequired();
6570 // Split on commas unless they are preceeded by an escape.
6571 // The escape character must be escaped for the string and
6572 // again for the regex, thus four escape characters become one.
6573 String[] strings = value.split("(?<!\\\\),");
6574 ArrayList<String> list = new ArrayList<>(strings.length);
6575 for (int i = 0; i < strings.length; i++) {
6576 list.add(strings[i]);
6577 }
6578 intent.putExtra(key, list);
6579 hasIntentInfo = true;
6580 }
6581 break;
6582 case "--ez": {
6583 String key = cmd.getNextArgRequired();
6584 String value = cmd.getNextArgRequired().toLowerCase();
6585 // Boolean.valueOf() results in false for anything that is not "true", which is
6586 // error-prone in shell commands
6587 boolean arg;
6588 if ("true".equals(value) || "t".equals(value)) {
6589 arg = true;
6590 } else if ("false".equals(value) || "f".equals(value)) {
6591 arg = false;
6592 } else {
6593 try {
6594 arg = Integer.decode(value) != 0;
6595 } catch (NumberFormatException ex) {
6596 throw new IllegalArgumentException("Invalid boolean value: " + value);
6597 }
6598 }
6599
6600 intent.putExtra(key, arg);
6601 }
6602 break;
6603 case "-n": {
6604 String str = cmd.getNextArgRequired();
6605 ComponentName cn = ComponentName.unflattenFromString(str);
6606 if (cn == null)
6607 throw new IllegalArgumentException("Bad component name: " + str);
6608 intent.setComponent(cn);
6609 if (intent == baseIntent) {
6610 hasIntentInfo = true;
6611 }
6612 }
6613 break;
6614 case "-p": {
6615 String str = cmd.getNextArgRequired();
6616 intent.setPackage(str);
6617 if (intent == baseIntent) {
6618 hasIntentInfo = true;
6619 }
6620 }
6621 break;
6622 case "-f":
6623 String str = cmd.getNextArgRequired();
6624 intent.setFlags(Integer.decode(str).intValue());
6625 break;
6626 case "--grant-read-uri-permission":
6627 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
6628 break;
6629 case "--grant-write-uri-permission":
6630 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
6631 break;
6632 case "--grant-persistable-uri-permission":
6633 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
6634 break;
6635 case "--grant-prefix-uri-permission":
6636 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
6637 break;
6638 case "--exclude-stopped-packages":
6639 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
6640 break;
6641 case "--include-stopped-packages":
6642 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
6643 break;
6644 case "--debug-log-resolution":
6645 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
6646 break;
6647 case "--activity-brought-to-front":
6648 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
6649 break;
6650 case "--activity-clear-top":
6651 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
6652 break;
6653 case "--activity-clear-when-task-reset":
6654 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
6655 break;
6656 case "--activity-exclude-from-recents":
6657 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
6658 break;
6659 case "--activity-launched-from-history":
6660 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
6661 break;
6662 case "--activity-multiple-task":
6663 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
6664 break;
6665 case "--activity-no-animation":
6666 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
6667 break;
6668 case "--activity-no-history":
6669 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
6670 break;
6671 case "--activity-no-user-action":
6672 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
6673 break;
6674 case "--activity-previous-is-top":
6675 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6676 break;
6677 case "--activity-reorder-to-front":
6678 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6679 break;
6680 case "--activity-reset-task-if-needed":
6681 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6682 break;
6683 case "--activity-single-top":
6684 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6685 break;
6686 case "--activity-clear-task":
6687 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6688 break;
6689 case "--activity-task-on-home":
6690 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6691 break;
6692 case "--receiver-registered-only":
6693 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6694 break;
6695 case "--receiver-replace-pending":
6696 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6697 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006698 case "--receiver-foreground":
6699 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6700 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006701 case "--receiver-no-abort":
6702 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6703 break;
6704 case "--receiver-include-background":
6705 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6706 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006707 case "--selector":
6708 intent.setDataAndType(data, type);
6709 intent = new Intent();
6710 break;
6711 default:
6712 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6713 // Okay, caller handled this option.
6714 } else {
6715 throw new IllegalArgumentException("Unknown option: " + opt);
6716 }
6717 break;
6718 }
6719 }
6720 intent.setDataAndType(data, type);
6721
6722 final boolean hasSelector = intent != baseIntent;
6723 if (hasSelector) {
6724 // A selector was specified; fix up.
6725 baseIntent.setSelector(intent);
6726 intent = baseIntent;
6727 }
6728
6729 String arg = cmd.getNextArg();
6730 baseIntent = null;
6731 if (arg == null) {
6732 if (hasSelector) {
6733 // If a selector has been specified, and no arguments
6734 // have been supplied for the main Intent, then we can
6735 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6736 // need to have a component name specified yet, the
6737 // selector will take care of that.
6738 baseIntent = new Intent(Intent.ACTION_MAIN);
6739 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6740 }
6741 } else if (arg.indexOf(':') >= 0) {
6742 // The argument is a URI. Fully parse it, and use that result
6743 // to fill in any data not specified so far.
6744 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6745 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6746 } else if (arg.indexOf('/') >= 0) {
6747 // The argument is a component name. Build an Intent to launch
6748 // it.
6749 baseIntent = new Intent(Intent.ACTION_MAIN);
6750 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6751 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6752 } else {
6753 // Assume the argument is a package name.
6754 baseIntent = new Intent(Intent.ACTION_MAIN);
6755 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6756 baseIntent.setPackage(arg);
6757 }
6758 if (baseIntent != null) {
6759 Bundle extras = intent.getExtras();
6760 intent.replaceExtras((Bundle)null);
6761 Bundle uriExtras = baseIntent.getExtras();
6762 baseIntent.replaceExtras((Bundle)null);
6763 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6764 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6765 for (String c : cats) {
6766 baseIntent.removeCategory(c);
6767 }
6768 }
6769 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6770 if (extras == null) {
6771 extras = uriExtras;
6772 } else if (uriExtras != null) {
6773 uriExtras.putAll(extras);
6774 extras = uriExtras;
6775 }
6776 intent.replaceExtras(extras);
6777 hasIntentInfo = true;
6778 }
6779
6780 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6781 return intent;
6782 }
6783
6784 /** @hide */
6785 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6786 final String[] lines = new String[] {
6787 "<INTENT> specifications include these flags and arguments:",
6788 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6789 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6790 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6791 " [--esn <EXTRA_KEY> ...]",
6792 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6793 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6794 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6795 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6796 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6797 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6798 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6799 " (mutiple extras passed as Integer[])",
6800 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6801 " (mutiple extras passed as List<Integer>)",
6802 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6803 " (mutiple extras passed as Long[])",
6804 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6805 " (mutiple extras passed as List<Long>)",
6806 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6807 " (mutiple extras passed as Float[])",
6808 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6809 " (mutiple extras passed as List<Float>)",
6810 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6811 " (mutiple extras passed as String[]; to embed a comma into a string,",
6812 " escape it using \"\\,\")",
6813 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6814 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6815 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006816 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006817 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6818 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6819 " [--debug-log-resolution] [--exclude-stopped-packages]",
6820 " [--include-stopped-packages]",
6821 " [--activity-brought-to-front] [--activity-clear-top]",
6822 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6823 " [--activity-launched-from-history] [--activity-multiple-task]",
6824 " [--activity-no-animation] [--activity-no-history]",
6825 " [--activity-no-user-action] [--activity-previous-is-top]",
6826 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6827 " [--activity-single-top] [--activity-clear-task]",
6828 " [--activity-task-on-home]",
6829 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006830 " [--receiver-foreground] [--receiver-no-abort]",
6831 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006832 " [--selector]",
6833 " [<URI> | <PACKAGE> | <COMPONENT>]"
6834 };
6835 for (String line : lines) {
6836 pw.print(prefix);
6837 pw.println(line);
6838 }
6839 }
6840
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006841 /**
6842 * Retrieve the general action to be performed, such as
6843 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6844 * the information in the intent should be interpreted -- most importantly,
6845 * what to do with the data returned by {@link #getData}.
6846 *
6847 * @return The action of this intent or null if none is specified.
6848 *
6849 * @see #setAction
6850 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006851 public @Nullable String getAction() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006852 return mAction;
6853 }
6854
6855 /**
6856 * Retrieve data this intent is operating on. This URI specifies the name
6857 * of the data; often it uses the content: scheme, specifying data in a
6858 * content provider. Other schemes may be handled by specific activities,
6859 * such as http: by the web browser.
6860 *
6861 * @return The URI of the data this intent is targeting or null.
6862 *
6863 * @see #getScheme
6864 * @see #setData
6865 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006866 public @Nullable Uri getData() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006867 return mData;
6868 }
6869
6870 /**
6871 * The same as {@link #getData()}, but returns the URI as an encoded
6872 * String.
6873 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006874 public @Nullable String getDataString() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006875 return mData != null ? mData.toString() : null;
6876 }
6877
6878 /**
6879 * Return the scheme portion of the intent's data. If the data is null or
6880 * does not include a scheme, null is returned. Otherwise, the scheme
6881 * prefix without the final ':' is returned, i.e. "http".
6882 *
6883 * <p>This is the same as calling getData().getScheme() (and checking for
6884 * null data).
6885 *
6886 * @return The scheme of this intent.
6887 *
6888 * @see #getData
6889 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006890 public @Nullable String getScheme() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006891 return mData != null ? mData.getScheme() : null;
6892 }
6893
6894 /**
6895 * Retrieve any explicit MIME type included in the intent. This is usually
6896 * null, as the type is determined by the intent data.
6897 *
6898 * @return If a type was manually set, it is returned; else null is
6899 * returned.
6900 *
6901 * @see #resolveType(ContentResolver)
6902 * @see #setType
6903 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006904 public @Nullable String getType() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006905 return mType;
6906 }
6907
6908 /**
6909 * Return the MIME data type of this intent. If the type field is
6910 * explicitly set, that is simply returned. Otherwise, if the data is set,
6911 * the type of that data is returned. If neither fields are set, a null is
6912 * returned.
6913 *
6914 * @return The MIME type of this intent.
6915 *
6916 * @see #getType
6917 * @see #resolveType(ContentResolver)
6918 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006919 public @Nullable String resolveType(@NonNull Context context) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006920 return resolveType(context.getContentResolver());
6921 }
6922
6923 /**
6924 * Return the MIME data type of this intent. If the type field is
6925 * explicitly set, that is simply returned. Otherwise, if the data is set,
6926 * the type of that data is returned. If neither fields are set, a null is
6927 * returned.
6928 *
6929 * @param resolver A ContentResolver that can be used to determine the MIME
6930 * type of the intent's data.
6931 *
6932 * @return The MIME type of this intent.
6933 *
6934 * @see #getType
6935 * @see #resolveType(Context)
6936 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006937 public @Nullable String resolveType(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006938 if (mType != null) {
6939 return mType;
6940 }
6941 if (mData != null) {
6942 if ("content".equals(mData.getScheme())) {
6943 return resolver.getType(mData);
6944 }
6945 }
6946 return null;
6947 }
6948
6949 /**
6950 * Return the MIME data type of this intent, only if it will be needed for
6951 * intent resolution. This is not generally useful for application code;
6952 * it is used by the frameworks for communicating with back-end system
6953 * services.
6954 *
6955 * @param resolver A ContentResolver that can be used to determine the MIME
6956 * type of the intent's data.
6957 *
6958 * @return The MIME type of this intent, or null if it is unknown or not
6959 * needed.
6960 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06006961 public @Nullable String resolveTypeIfNeeded(@NonNull ContentResolver resolver) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006962 if (mComponent != null) {
6963 return mType;
6964 }
6965 return resolveType(resolver);
6966 }
6967
6968 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006969 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006970 *
6971 * @param category The category to check.
6972 *
6973 * @return boolean True if the intent contains the category, else false.
6974 *
6975 * @see #getCategories
6976 * @see #addCategory
6977 */
6978 public boolean hasCategory(String category) {
6979 return mCategories != null && mCategories.contains(category);
6980 }
6981
6982 /**
6983 * Return the set of all categories in the intent. If there are no categories,
6984 * returns NULL.
6985 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006986 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006987 *
6988 * @see #hasCategory
6989 * @see #addCategory
6990 */
6991 public Set<String> getCategories() {
6992 return mCategories;
6993 }
6994
6995 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006996 * Return the specific selector associated with this Intent. If there is
6997 * none, returns null. See {@link #setSelector} for more information.
6998 *
6999 * @see #setSelector
7000 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007001 public @Nullable Intent getSelector() {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007002 return mSelector;
7003 }
7004
7005 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007006 * Return the {@link ClipData} associated with this Intent. If there is
7007 * none, returns null. See {@link #setClipData} for more information.
7008 *
John Spurlock125d1332013-11-25 11:58:37 -05007009 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007010 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007011 public @Nullable ClipData getClipData() {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007012 return mClipData;
7013 }
7014
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007015 /** @hide */
7016 public int getContentUserHint() {
7017 return mContentUserHint;
7018 }
7019
Todd Kennedyb3b431302017-03-20 16:05:48 -07007020 /** @hide */
7021 public String getLaunchToken() {
7022 return mLaunchToken;
7023 }
7024
7025 /** @hide */
7026 public void setLaunchToken(String launchToken) {
7027 mLaunchToken = launchToken;
7028 }
7029
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007030 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007031 * Sets the ClassLoader that will be used when unmarshalling
7032 * any Parcelable values from the extras of this Intent.
7033 *
7034 * @param loader a ClassLoader, or null to use the default loader
7035 * at the time of unmarshalling.
7036 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007037 public void setExtrasClassLoader(@Nullable ClassLoader loader) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007038 if (mExtras != null) {
7039 mExtras.setClassLoader(loader);
7040 }
7041 }
7042
7043 /**
7044 * Returns true if an extra value is associated with the given name.
7045 * @param name the extra's name
7046 * @return true if the given extra is present.
7047 */
7048 public boolean hasExtra(String name) {
7049 return mExtras != null && mExtras.containsKey(name);
7050 }
7051
7052 /**
7053 * Returns true if the Intent's extras contain a parcelled file descriptor.
7054 * @return true if the Intent contains a parcelled file descriptor.
7055 */
7056 public boolean hasFileDescriptors() {
7057 return mExtras != null && mExtras.hasFileDescriptors();
7058 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007059
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007060 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04007061 public void setAllowFds(boolean allowFds) {
7062 if (mExtras != null) {
7063 mExtras.setAllowFds(allowFds);
7064 }
7065 }
7066
Jeff Sharkeyd136e512016-03-09 22:30:56 -07007067 /** {@hide} */
7068 public void setDefusable(boolean defusable) {
7069 if (mExtras != null) {
7070 mExtras.setDefusable(defusable);
7071 }
7072 }
7073
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007074 /**
7075 * Retrieve extended data from the intent.
7076 *
7077 * @param name The name of the desired item.
7078 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007079 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007080 * or null if none was found.
7081 *
7082 * @deprecated
7083 * @hide
7084 */
7085 @Deprecated
7086 public Object getExtra(String name) {
7087 return getExtra(name, null);
7088 }
7089
7090 /**
7091 * Retrieve extended data from the intent.
7092 *
7093 * @param name The name of the desired item.
7094 * @param defaultValue the value to be returned if no value of the desired
7095 * type is stored with the given name.
7096 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007097 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007098 * or the default value if none was found.
7099 *
7100 * @see #putExtra(String, boolean)
7101 */
7102 public boolean getBooleanExtra(String name, boolean defaultValue) {
7103 return mExtras == null ? defaultValue :
7104 mExtras.getBoolean(name, defaultValue);
7105 }
7106
7107 /**
7108 * Retrieve extended data from the intent.
7109 *
7110 * @param name The name of the desired item.
7111 * @param defaultValue the value to be returned if no value of the desired
7112 * type is stored with the given name.
7113 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007114 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007115 * or the default value if none was found.
7116 *
7117 * @see #putExtra(String, byte)
7118 */
7119 public byte getByteExtra(String name, byte defaultValue) {
7120 return mExtras == null ? defaultValue :
7121 mExtras.getByte(name, defaultValue);
7122 }
7123
7124 /**
7125 * Retrieve extended data from the intent.
7126 *
7127 * @param name The name of the desired item.
7128 * @param defaultValue the value to be returned if no value of the desired
7129 * type is stored with the given name.
7130 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007131 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007132 * or the default value if none was found.
7133 *
7134 * @see #putExtra(String, short)
7135 */
7136 public short getShortExtra(String name, short defaultValue) {
7137 return mExtras == null ? defaultValue :
7138 mExtras.getShort(name, defaultValue);
7139 }
7140
7141 /**
7142 * Retrieve extended data from the intent.
7143 *
7144 * @param name The name of the desired item.
7145 * @param defaultValue the value to be returned if no value of the desired
7146 * type is stored with the given name.
7147 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007148 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007149 * or the default value if none was found.
7150 *
7151 * @see #putExtra(String, char)
7152 */
7153 public char getCharExtra(String name, char defaultValue) {
7154 return mExtras == null ? defaultValue :
7155 mExtras.getChar(name, defaultValue);
7156 }
7157
7158 /**
7159 * Retrieve extended data from the intent.
7160 *
7161 * @param name The name of the desired item.
7162 * @param defaultValue the value to be returned if no value of the desired
7163 * type is stored with the given name.
7164 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007165 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007166 * or the default value if none was found.
7167 *
7168 * @see #putExtra(String, int)
7169 */
7170 public int getIntExtra(String name, int defaultValue) {
7171 return mExtras == null ? defaultValue :
7172 mExtras.getInt(name, defaultValue);
7173 }
7174
7175 /**
7176 * Retrieve extended data from the intent.
7177 *
7178 * @param name The name of the desired item.
7179 * @param defaultValue the value to be returned if no value of the desired
7180 * type is stored with the given name.
7181 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007182 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007183 * or the default value if none was found.
7184 *
7185 * @see #putExtra(String, long)
7186 */
7187 public long getLongExtra(String name, long defaultValue) {
7188 return mExtras == null ? defaultValue :
7189 mExtras.getLong(name, defaultValue);
7190 }
7191
7192 /**
7193 * Retrieve extended data from the intent.
7194 *
7195 * @param name The name of the desired item.
7196 * @param defaultValue the value to be returned if no value of the desired
7197 * type is stored with the given name.
7198 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007199 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007200 * or the default value if no such item is present
7201 *
7202 * @see #putExtra(String, float)
7203 */
7204 public float getFloatExtra(String name, float defaultValue) {
7205 return mExtras == null ? defaultValue :
7206 mExtras.getFloat(name, defaultValue);
7207 }
7208
7209 /**
7210 * Retrieve extended data from the intent.
7211 *
7212 * @param name The name of the desired item.
7213 * @param defaultValue the value to be returned if no value of the desired
7214 * type is stored with the given name.
7215 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007216 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007217 * or the default value if none was found.
7218 *
7219 * @see #putExtra(String, double)
7220 */
7221 public double getDoubleExtra(String name, double defaultValue) {
7222 return mExtras == null ? defaultValue :
7223 mExtras.getDouble(name, defaultValue);
7224 }
7225
7226 /**
7227 * Retrieve extended data from the intent.
7228 *
7229 * @param name The name of the desired item.
7230 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007231 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007232 * or null if no String value was found.
7233 *
7234 * @see #putExtra(String, String)
7235 */
7236 public String getStringExtra(String name) {
7237 return mExtras == null ? null : mExtras.getString(name);
7238 }
7239
7240 /**
7241 * Retrieve extended data from the intent.
7242 *
7243 * @param name The name of the desired item.
7244 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007245 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007246 * or null if no CharSequence value was found.
7247 *
7248 * @see #putExtra(String, CharSequence)
7249 */
7250 public CharSequence getCharSequenceExtra(String name) {
7251 return mExtras == null ? null : mExtras.getCharSequence(name);
7252 }
7253
7254 /**
7255 * Retrieve extended data from the intent.
7256 *
7257 * @param name The name of the desired item.
7258 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007259 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007260 * or null if no Parcelable value was found.
7261 *
7262 * @see #putExtra(String, Parcelable)
7263 */
7264 public <T extends Parcelable> T getParcelableExtra(String name) {
7265 return mExtras == null ? null : mExtras.<T>getParcelable(name);
7266 }
7267
7268 /**
7269 * Retrieve extended data from the intent.
7270 *
7271 * @param name The name of the desired item.
7272 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007273 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007274 * or null if no Parcelable[] value was found.
7275 *
7276 * @see #putExtra(String, Parcelable[])
7277 */
7278 public Parcelable[] getParcelableArrayExtra(String name) {
7279 return mExtras == null ? null : mExtras.getParcelableArray(name);
7280 }
7281
7282 /**
7283 * Retrieve extended data from the intent.
7284 *
7285 * @param name The name of the desired item.
7286 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007287 * @return the value of an item previously added with
7288 * putParcelableArrayListExtra(), or null if no
7289 * ArrayList<Parcelable> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007290 *
7291 * @see #putParcelableArrayListExtra(String, ArrayList)
7292 */
7293 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
7294 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
7295 }
7296
7297 /**
7298 * Retrieve extended data from the intent.
7299 *
7300 * @param name The name of the desired item.
7301 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007302 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007303 * or null if no Serializable value was found.
7304 *
7305 * @see #putExtra(String, Serializable)
7306 */
7307 public Serializable getSerializableExtra(String name) {
7308 return mExtras == null ? null : mExtras.getSerializable(name);
7309 }
7310
7311 /**
7312 * Retrieve extended data from the intent.
7313 *
7314 * @param name The name of the desired item.
7315 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007316 * @return the value of an item previously added with
7317 * putIntegerArrayListExtra(), or null if no
7318 * ArrayList<Integer> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007319 *
7320 * @see #putIntegerArrayListExtra(String, ArrayList)
7321 */
7322 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
7323 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
7324 }
7325
7326 /**
7327 * Retrieve extended data from the intent.
7328 *
7329 * @param name The name of the desired item.
7330 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007331 * @return the value of an item previously added with
7332 * putStringArrayListExtra(), or null if no
7333 * ArrayList<String> value was found.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007334 *
7335 * @see #putStringArrayListExtra(String, ArrayList)
7336 */
7337 public ArrayList<String> getStringArrayListExtra(String name) {
7338 return mExtras == null ? null : mExtras.getStringArrayList(name);
7339 }
7340
7341 /**
7342 * Retrieve extended data from the intent.
7343 *
7344 * @param name The name of the desired item.
7345 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007346 * @return the value of an item previously added with
7347 * putCharSequenceArrayListExtra, or null if no
7348 * ArrayList<CharSequence> value was found.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007349 *
7350 * @see #putCharSequenceArrayListExtra(String, ArrayList)
7351 */
7352 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
7353 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
7354 }
7355
7356 /**
7357 * Retrieve extended data from the intent.
7358 *
7359 * @param name The name of the desired item.
7360 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007361 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007362 * or null if no boolean array value was found.
7363 *
7364 * @see #putExtra(String, boolean[])
7365 */
7366 public boolean[] getBooleanArrayExtra(String name) {
7367 return mExtras == null ? null : mExtras.getBooleanArray(name);
7368 }
7369
7370 /**
7371 * Retrieve extended data from the intent.
7372 *
7373 * @param name The name of the desired item.
7374 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007375 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007376 * or null if no byte array value was found.
7377 *
7378 * @see #putExtra(String, byte[])
7379 */
7380 public byte[] getByteArrayExtra(String name) {
7381 return mExtras == null ? null : mExtras.getByteArray(name);
7382 }
7383
7384 /**
7385 * Retrieve extended data from the intent.
7386 *
7387 * @param name The name of the desired item.
7388 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007389 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007390 * or null if no short array value was found.
7391 *
7392 * @see #putExtra(String, short[])
7393 */
7394 public short[] getShortArrayExtra(String name) {
7395 return mExtras == null ? null : mExtras.getShortArray(name);
7396 }
7397
7398 /**
7399 * Retrieve extended data from the intent.
7400 *
7401 * @param name The name of the desired item.
7402 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007403 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007404 * or null if no char array value was found.
7405 *
7406 * @see #putExtra(String, char[])
7407 */
7408 public char[] getCharArrayExtra(String name) {
7409 return mExtras == null ? null : mExtras.getCharArray(name);
7410 }
7411
7412 /**
7413 * Retrieve extended data from the intent.
7414 *
7415 * @param name The name of the desired item.
7416 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007417 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007418 * or null if no int array value was found.
7419 *
7420 * @see #putExtra(String, int[])
7421 */
7422 public int[] getIntArrayExtra(String name) {
7423 return mExtras == null ? null : mExtras.getIntArray(name);
7424 }
7425
7426 /**
7427 * Retrieve extended data from the intent.
7428 *
7429 * @param name The name of the desired item.
7430 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007431 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007432 * or null if no long array value was found.
7433 *
7434 * @see #putExtra(String, long[])
7435 */
7436 public long[] getLongArrayExtra(String name) {
7437 return mExtras == null ? null : mExtras.getLongArray(name);
7438 }
7439
7440 /**
7441 * Retrieve extended data from the intent.
7442 *
7443 * @param name The name of the desired item.
7444 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007445 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007446 * or null if no float array value was found.
7447 *
7448 * @see #putExtra(String, float[])
7449 */
7450 public float[] getFloatArrayExtra(String name) {
7451 return mExtras == null ? null : mExtras.getFloatArray(name);
7452 }
7453
7454 /**
7455 * Retrieve extended data from the intent.
7456 *
7457 * @param name The name of the desired item.
7458 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007459 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007460 * or null if no double array value was found.
7461 *
7462 * @see #putExtra(String, double[])
7463 */
7464 public double[] getDoubleArrayExtra(String name) {
7465 return mExtras == null ? null : mExtras.getDoubleArray(name);
7466 }
7467
7468 /**
7469 * Retrieve extended data from the intent.
7470 *
7471 * @param name The name of the desired item.
7472 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007473 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007474 * or null if no String array value was found.
7475 *
7476 * @see #putExtra(String, String[])
7477 */
7478 public String[] getStringArrayExtra(String name) {
7479 return mExtras == null ? null : mExtras.getStringArray(name);
7480 }
7481
7482 /**
7483 * Retrieve extended data from the intent.
7484 *
7485 * @param name The name of the desired item.
7486 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007487 * @return the value of an item previously added with putExtra(),
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007488 * or null if no CharSequence array value was found.
7489 *
7490 * @see #putExtra(String, CharSequence[])
7491 */
7492 public CharSequence[] getCharSequenceArrayExtra(String name) {
7493 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
7494 }
7495
7496 /**
7497 * Retrieve extended data from the intent.
7498 *
7499 * @param name The name of the desired item.
7500 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007501 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007502 * or null if no Bundle value was found.
7503 *
7504 * @see #putExtra(String, Bundle)
7505 */
7506 public Bundle getBundleExtra(String name) {
7507 return mExtras == null ? null : mExtras.getBundle(name);
7508 }
7509
7510 /**
7511 * Retrieve extended data from the intent.
7512 *
7513 * @param name The name of the desired item.
7514 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007515 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007516 * or null if no IBinder value was found.
7517 *
7518 * @see #putExtra(String, IBinder)
7519 *
7520 * @deprecated
7521 * @hide
7522 */
7523 @Deprecated
7524 public IBinder getIBinderExtra(String name) {
7525 return mExtras == null ? null : mExtras.getIBinder(name);
7526 }
7527
7528 /**
7529 * Retrieve extended data from the intent.
7530 *
7531 * @param name The name of the desired item.
7532 * @param defaultValue The default value to return in case no item is
7533 * associated with the key 'name'
7534 *
Jonathan Dormodyd07017e2017-11-15 14:10:57 -07007535 * @return the value of an item previously added with putExtra(),
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007536 * or defaultValue if none was found.
7537 *
7538 * @see #putExtra
7539 *
7540 * @deprecated
7541 * @hide
7542 */
7543 @Deprecated
7544 public Object getExtra(String name, Object defaultValue) {
7545 Object result = defaultValue;
7546 if (mExtras != null) {
7547 Object result2 = mExtras.get(name);
7548 if (result2 != null) {
7549 result = result2;
7550 }
7551 }
7552
7553 return result;
7554 }
7555
7556 /**
7557 * Retrieves a map of extended data from the intent.
7558 *
7559 * @return the map of all extras previously added with putExtra(),
7560 * or null if none have been added.
7561 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007562 public @Nullable Bundle getExtras() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007563 return (mExtras != null)
7564 ? new Bundle(mExtras)
7565 : null;
7566 }
7567
7568 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007569 * Filter extras to only basic types.
7570 * @hide
7571 */
7572 public void removeUnsafeExtras() {
7573 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07007574 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07007575 }
7576 }
7577
7578 /**
Makoto Onuki97f82f22017-05-31 16:20:21 -07007579 * @return Whether {@link #maybeStripForHistory} will return an lightened intent or
7580 * return itself as-is.
7581 * @hide
7582 */
7583 public boolean canStripForHistory() {
7584 return ((mExtras != null) && mExtras.isParcelled()) || (mClipData != null);
7585 }
7586
7587 /**
7588 * Call it when the system needs to keep an intent for logging purposes to remove fields
7589 * that are not needed for logging.
7590 * @hide
7591 */
7592 public Intent maybeStripForHistory() {
7593 // TODO Scan and remove possibly heavy instances like Bitmaps from unparcelled extras?
7594
7595 if (!canStripForHistory()) {
7596 return this;
7597 }
7598 return new Intent(this, COPY_MODE_HISTORY);
7599 }
7600
7601 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007602 * Retrieve any special flags associated with this intent. You will
7603 * normally just set them with {@link #setFlags} and let the system
7604 * take the appropriate action with them.
7605 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007606 * @return The currently set flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007607 * @see #setFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007608 * @see #addFlags
7609 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007610 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007611 public @Flags int getFlags() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007612 return mFlags;
7613 }
7614
Dianne Hackborne7f97212011-02-24 14:40:20 -08007615 /** @hide */
7616 public boolean isExcludingStopped() {
7617 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
7618 == FLAG_EXCLUDE_STOPPED_PACKAGES;
7619 }
7620
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007621 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007622 * Retrieve the application package name this Intent is limited to. When
7623 * resolving an Intent, if non-null this limits the resolution to only
7624 * components in the given application package.
7625 *
7626 * @return The name of the application package for the Intent.
7627 *
7628 * @see #resolveActivity
7629 * @see #setPackage
7630 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007631 public @Nullable String getPackage() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007632 return mPackage;
7633 }
7634
7635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007636 * Retrieve the concrete component associated with the intent. When receiving
7637 * an intent, this is the component that was found to best handle it (that is,
7638 * yourself) and will always be non-null; in all other cases it will be
7639 * null unless explicitly set.
7640 *
7641 * @return The name of the application component to handle the intent.
7642 *
7643 * @see #resolveActivity
7644 * @see #setComponent
7645 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007646 public @Nullable ComponentName getComponent() {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007647 return mComponent;
7648 }
7649
7650 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007651 * Get the bounds of the sender of this intent, in screen coordinates. This can be
7652 * used as a hint to the receiver for animations and the like. Null means that there
7653 * is no source bounds.
7654 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007655 public @Nullable Rect getSourceBounds() {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007656 return mSourceBounds;
7657 }
7658
7659 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007660 * Return the Activity component that should be used to handle this intent.
7661 * The appropriate component is determined based on the information in the
7662 * intent, evaluated as follows:
7663 *
7664 * <p>If {@link #getComponent} returns an explicit class, that is returned
7665 * without any further consideration.
7666 *
7667 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
7668 * category to be considered.
7669 *
7670 * <p>If {@link #getAction} is non-NULL, the activity must handle this
7671 * action.
7672 *
7673 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
7674 * this type.
7675 *
7676 * <p>If {@link #addCategory} has added any categories, the activity must
7677 * handle ALL of the categories specified.
7678 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007679 * <p>If {@link #getPackage} is non-NULL, only activity components in
7680 * that application package will be considered.
7681 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007682 * <p>If there are no activities that satisfy all of these conditions, a
7683 * null string is returned.
7684 *
7685 * <p>If multiple activities are found to satisfy the intent, the one with
7686 * the highest priority will be used. If there are multiple activities
7687 * with the same priority, the system will either pick the best activity
7688 * based on user preference, or resolve to a system class that will allow
7689 * the user to pick an activity and forward from there.
7690 *
7691 * <p>This method is implemented simply by calling
7692 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
7693 * true.</p>
7694 * <p> This API is called for you as part of starting an activity from an
7695 * intent. You do not normally need to call it yourself.</p>
7696 *
7697 * @param pm The package manager with which to resolve the Intent.
7698 *
7699 * @return Name of the component implementing an activity that can
7700 * display the intent.
7701 *
7702 * @see #setComponent
7703 * @see #getComponent
7704 * @see #resolveActivityInfo
7705 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007706 public ComponentName resolveActivity(@NonNull PackageManager pm) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007707 if (mComponent != null) {
7708 return mComponent;
7709 }
7710
7711 ResolveInfo info = pm.resolveActivity(
7712 this, PackageManager.MATCH_DEFAULT_ONLY);
7713 if (info != null) {
7714 return new ComponentName(
7715 info.activityInfo.applicationInfo.packageName,
7716 info.activityInfo.name);
7717 }
7718
7719 return null;
7720 }
7721
7722 /**
7723 * Resolve the Intent into an {@link ActivityInfo}
7724 * describing the activity that should execute the intent. Resolution
7725 * follows the same rules as described for {@link #resolveActivity}, but
7726 * you get back the completely information about the resolved activity
7727 * instead of just its class name.
7728 *
7729 * @param pm The package manager with which to resolve the Intent.
7730 * @param flags Addition information to retrieve as per
7731 * {@link PackageManager#getActivityInfo(ComponentName, int)
7732 * PackageManager.getActivityInfo()}.
7733 *
7734 * @return PackageManager.ActivityInfo
7735 *
7736 * @see #resolveActivity
7737 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007738 public ActivityInfo resolveActivityInfo(@NonNull PackageManager pm,
7739 @PackageManager.ComponentInfoFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007740 ActivityInfo ai = null;
7741 if (mComponent != null) {
7742 try {
7743 ai = pm.getActivityInfo(mComponent, flags);
7744 } catch (PackageManager.NameNotFoundException e) {
7745 // ignore
7746 }
7747 } else {
7748 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007749 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007750 if (info != null) {
7751 ai = info.activityInfo;
7752 }
7753 }
7754
7755 return ai;
7756 }
7757
7758 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007759 * Special function for use by the system to resolve service
7760 * intents to system apps. Throws an exception if there are
7761 * multiple potential matches to the Intent. Returns null if
7762 * there are no matches.
7763 * @hide
7764 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007765 public @Nullable ComponentName resolveSystemService(@NonNull PackageManager pm,
7766 @PackageManager.ComponentInfoFlags int flags) {
Dianne Hackborn221ea892013-08-04 16:50:16 -07007767 if (mComponent != null) {
7768 return mComponent;
7769 }
7770
7771 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7772 if (results == null) {
7773 return null;
7774 }
7775 ComponentName comp = null;
7776 for (int i=0; i<results.size(); i++) {
7777 ResolveInfo ri = results.get(i);
7778 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7779 continue;
7780 }
7781 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7782 ri.serviceInfo.name);
7783 if (comp != null) {
7784 throw new IllegalStateException("Multiple system services handle " + this
7785 + ": " + comp + ", " + foundComp);
7786 }
7787 comp = foundComp;
7788 }
7789 return comp;
7790 }
7791
7792 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007793 * Set the general action to be performed.
7794 *
7795 * @param action An action name, such as ACTION_VIEW. Application-specific
7796 * actions should be prefixed with the vendor's package name.
7797 *
7798 * @return Returns the same Intent object, for chaining multiple calls
7799 * into a single statement.
7800 *
7801 * @see #getAction
7802 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007803 public @NonNull Intent setAction(@Nullable String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007804 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007805 return this;
7806 }
7807
7808 /**
7809 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007810 * clears any type that was previously set by {@link #setType} or
7811 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007812 *
Nick Pellyccae4122012-01-09 14:12:58 -08007813 * <p><em>Note: scheme matching in the Android framework is
7814 * case-sensitive, unlike the formal RFC. As a result,
7815 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007816 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007817 * {@link #setDataAndNormalize}
7818 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007819 *
Nick Pellyccae4122012-01-09 14:12:58 -08007820 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007821 *
7822 * @return Returns the same Intent object, for chaining multiple calls
7823 * into a single statement.
7824 *
7825 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007826 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007827 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007828 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007829 public @NonNull Intent setData(@Nullable Uri data) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007830 mData = data;
7831 mType = null;
7832 return this;
7833 }
7834
7835 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007836 * Normalize and set the data this intent is operating on.
7837 *
7838 * <p>This method automatically clears any type that was
7839 * previously set (for example, by {@link #setType}).
7840 *
7841 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007842 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007843 * so really this is just a convenience method for
7844 * <pre>
7845 * setData(data.normalize())
7846 * </pre>
7847 *
7848 * @param data The Uri of the data this intent is now targeting.
7849 *
7850 * @return Returns the same Intent object, for chaining multiple calls
7851 * into a single statement.
7852 *
7853 * @see #getData
7854 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007855 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007856 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007857 public @NonNull Intent setDataAndNormalize(@NonNull Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007858 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007859 }
7860
7861 /**
7862 * Set an explicit MIME data type.
7863 *
7864 * <p>This is used to create intents that only specify a type and not data,
7865 * for example to indicate the type of data to return.
7866 *
7867 * <p>This method automatically clears any data that was
7868 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007869 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007870 * <p><em>Note: MIME type matching in the Android framework is
7871 * case-sensitive, unlike formal RFC MIME types. As a result,
7872 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007873 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7874 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007875 *
7876 * @param type The MIME type of the data being handled by this intent.
7877 *
7878 * @return Returns the same Intent object, for chaining multiple calls
7879 * into a single statement.
7880 *
7881 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007882 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007883 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007884 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007885 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007886 public @NonNull Intent setType(@Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007887 mData = null;
7888 mType = type;
7889 return this;
7890 }
7891
7892 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007893 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007894 *
Nick Pellyccae4122012-01-09 14:12:58 -08007895 * <p>This is used to create intents that only specify a type and not data,
7896 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007897 *
Nick Pellyccae4122012-01-09 14:12:58 -08007898 * <p>This method automatically clears any data that was
7899 * previously set (for example by {@link #setData}).
7900 *
7901 * <p>The MIME type is normalized using
7902 * {@link #normalizeMimeType} before it is set,
7903 * so really this is just a convenience method for
7904 * <pre>
7905 * setType(Intent.normalizeMimeType(type))
7906 * </pre>
7907 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007908 * @param type The MIME type of the data being handled by this intent.
7909 *
7910 * @return Returns the same Intent object, for chaining multiple calls
7911 * into a single statement.
7912 *
Nick Pellyccae4122012-01-09 14:12:58 -08007913 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007914 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007915 * @see #normalizeMimeType
7916 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007917 public @NonNull Intent setTypeAndNormalize(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08007918 return setType(normalizeMimeType(type));
7919 }
7920
7921 /**
7922 * (Usually optional) Set the data for the intent along with an explicit
7923 * MIME data type. This method should very rarely be used -- it allows you
7924 * to override the MIME type that would ordinarily be inferred from the
7925 * data with your own type given here.
7926 *
7927 * <p><em>Note: MIME type and Uri scheme matching in the
7928 * Android framework is case-sensitive, unlike the formal RFC definitions.
7929 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007930 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007931 * {@link #setDataAndTypeAndNormalize}
7932 * to ensure that they are converted to lower case.</em>
7933 *
7934 * @param data The Uri of the data this intent is now targeting.
7935 * @param type The MIME type of the data being handled by this intent.
7936 *
7937 * @return Returns the same Intent object, for chaining multiple calls
7938 * into a single statement.
7939 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007940 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007941 * @see #setData
7942 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007943 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007944 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007945 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007946 public @NonNull Intent setDataAndType(@Nullable Uri data, @Nullable String type) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007947 mData = data;
7948 mType = type;
7949 return this;
7950 }
7951
7952 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007953 * (Usually optional) Normalize and set both the data Uri and an explicit
7954 * MIME data type. This method should very rarely be used -- it allows you
7955 * to override the MIME type that would ordinarily be inferred from the
7956 * data with your own type given here.
7957 *
7958 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007959 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007960 * before they are set, so really this is just a convenience method for
7961 * <pre>
7962 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7963 * </pre>
7964 *
7965 * @param data The Uri of the data this intent is now targeting.
7966 * @param type The MIME type of the data being handled by this intent.
7967 *
7968 * @return Returns the same Intent object, for chaining multiple calls
7969 * into a single statement.
7970 *
7971 * @see #setType
7972 * @see #setData
7973 * @see #setDataAndType
7974 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007975 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007976 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007977 public @NonNull Intent setDataAndTypeAndNormalize(@NonNull Uri data, @Nullable String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007978 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007979 }
7980
7981 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007982 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007983 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007984 * activities that provide <em>all</em> of the requested categories will be
7985 * used.
7986 *
7987 * @param category The desired category. This can be either one of the
7988 * predefined Intent categories, or a custom category in your own
7989 * namespace.
7990 *
7991 * @return Returns the same Intent object, for chaining multiple calls
7992 * into a single statement.
7993 *
7994 * @see #hasCategory
7995 * @see #removeCategory
7996 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06007997 public @NonNull Intent addCategory(String category) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007998 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007999 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008000 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08008001 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008002 return this;
8003 }
8004
8005 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09008006 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008007 *
8008 * @param category The category to remove.
8009 *
8010 * @see #addCategory
8011 */
8012 public void removeCategory(String category) {
8013 if (mCategories != null) {
8014 mCategories.remove(category);
8015 if (mCategories.size() == 0) {
8016 mCategories = null;
8017 }
8018 }
8019 }
8020
8021 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008022 * Set a selector for this Intent. This is a modification to the kinds of
8023 * things the Intent will match. If the selector is set, it will be used
8024 * when trying to find entities that can handle the Intent, instead of the
8025 * main contents of the Intent. This allows you build an Intent containing
8026 * a generic protocol while targeting it more specifically.
8027 *
8028 * <p>An example of where this may be used is with things like
8029 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
8030 * Intent that will launch the Browser application. However, the correct
8031 * main entry point of an application is actually {@link #ACTION_MAIN}
8032 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
8033 * used to specify the actual Activity to launch. If you launch the browser
8034 * with something different, undesired behavior may happen if the user has
8035 * previously or later launches it the normal way, since they do not match.
8036 * Instead, you can build an Intent with the MAIN action (but no ComponentName
8037 * yet specified) and set a selector with {@link #ACTION_MAIN} and
8038 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
8039 *
8040 * <p>Setting a selector does not impact the behavior of
8041 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
8042 * desired behavior of a selector -- it does not impact the base meaning
8043 * of the Intent, just what kinds of things will be matched against it
8044 * when determining who can handle it.</p>
8045 *
8046 * <p>You can not use both a selector and {@link #setPackage(String)} on
8047 * the same base Intent.</p>
8048 *
8049 * @param selector The desired selector Intent; set to null to not use
8050 * a special selector.
8051 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008052 public void setSelector(@Nullable Intent selector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008053 if (selector == this) {
8054 throw new IllegalArgumentException(
8055 "Intent being set as a selector of itself");
8056 }
8057 if (selector != null && mPackage != null) {
8058 throw new IllegalArgumentException(
8059 "Can't set selector when package name is already set");
8060 }
8061 mSelector = selector;
8062 }
8063
8064 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008065 * Set a {@link ClipData} associated with this Intent. This replaces any
8066 * previously set ClipData.
8067 *
8068 * <p>The ClipData in an intent is not used for Intent matching or other
8069 * such operations. Semantically it is like extras, used to transmit
8070 * additional data with the Intent. The main feature of using this over
8071 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
8072 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
8073 * items included in the clip data. This is useful, in particular, if
8074 * you want to transmit an Intent containing multiple <code>content:</code>
8075 * URIs for which the recipient may not have global permission to access the
8076 * content provider.
8077 *
8078 * <p>If the ClipData contains items that are themselves Intents, any
8079 * grant flags in those Intents will be ignored. Only the top-level flags
8080 * of the main Intent are respected, and will be applied to all Uri or
8081 * Intent items in the clip (or sub-items of the clip).
8082 *
8083 * <p>The MIME type, label, and icon in the ClipData object are not
8084 * directly used by Intent. Applications should generally rely on the
8085 * MIME type of the Intent itself, not what it may find in the ClipData.
8086 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05008087 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008088 *
8089 * @param clip The new clip to set. May be null to clear the current clip.
8090 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008091 public void setClipData(@Nullable ClipData clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008092 mClipData = clip;
8093 }
8094
8095 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008096 * This is NOT a secure mechanism to identify the user who sent the intent.
8097 * When the intent is sent to a different user, it is used to fix uris by adding the userId
8098 * who sent the intent.
8099 * @hide
8100 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01008101 public void prepareToLeaveUser(int userId) {
8102 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
8103 // We want mContentUserHint to refer to the original user, so don't do anything.
8104 if (mContentUserHint == UserHandle.USER_CURRENT) {
8105 mContentUserHint = userId;
8106 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008107 }
8108
8109 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 * Add extended data to the intent. The name must include a package
8111 * prefix, for example the app com.android.contacts would use names
8112 * like "com.android.contacts.ShowAll".
8113 *
8114 * @param name The name of the extra data, with package prefix.
8115 * @param value The boolean data value.
8116 *
8117 * @return Returns the same Intent object, for chaining multiple calls
8118 * into a single statement.
8119 *
8120 * @see #putExtras
8121 * @see #removeExtra
8122 * @see #getBooleanExtra(String, boolean)
8123 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008124 public @NonNull Intent putExtra(String name, boolean value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008125 if (mExtras == null) {
8126 mExtras = new Bundle();
8127 }
8128 mExtras.putBoolean(name, value);
8129 return this;
8130 }
8131
8132 /**
8133 * Add extended data to the intent. The name must include a package
8134 * prefix, for example the app com.android.contacts would use names
8135 * like "com.android.contacts.ShowAll".
8136 *
8137 * @param name The name of the extra data, with package prefix.
8138 * @param value The byte data value.
8139 *
8140 * @return Returns the same Intent object, for chaining multiple calls
8141 * into a single statement.
8142 *
8143 * @see #putExtras
8144 * @see #removeExtra
8145 * @see #getByteExtra(String, byte)
8146 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008147 public @NonNull Intent putExtra(String name, byte value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008148 if (mExtras == null) {
8149 mExtras = new Bundle();
8150 }
8151 mExtras.putByte(name, value);
8152 return this;
8153 }
8154
8155 /**
8156 * Add extended data to the intent. The name must include a package
8157 * prefix, for example the app com.android.contacts would use names
8158 * like "com.android.contacts.ShowAll".
8159 *
8160 * @param name The name of the extra data, with package prefix.
8161 * @param value The char data value.
8162 *
8163 * @return Returns the same Intent object, for chaining multiple calls
8164 * into a single statement.
8165 *
8166 * @see #putExtras
8167 * @see #removeExtra
8168 * @see #getCharExtra(String, char)
8169 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008170 public @NonNull Intent putExtra(String name, char value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008171 if (mExtras == null) {
8172 mExtras = new Bundle();
8173 }
8174 mExtras.putChar(name, value);
8175 return this;
8176 }
8177
8178 /**
8179 * Add extended data to the intent. The name must include a package
8180 * prefix, for example the app com.android.contacts would use names
8181 * like "com.android.contacts.ShowAll".
8182 *
8183 * @param name The name of the extra data, with package prefix.
8184 * @param value The short data value.
8185 *
8186 * @return Returns the same Intent object, for chaining multiple calls
8187 * into a single statement.
8188 *
8189 * @see #putExtras
8190 * @see #removeExtra
8191 * @see #getShortExtra(String, short)
8192 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008193 public @NonNull Intent putExtra(String name, short value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008194 if (mExtras == null) {
8195 mExtras = new Bundle();
8196 }
8197 mExtras.putShort(name, value);
8198 return this;
8199 }
8200
8201 /**
8202 * Add extended data to the intent. The name must include a package
8203 * prefix, for example the app com.android.contacts would use names
8204 * like "com.android.contacts.ShowAll".
8205 *
8206 * @param name The name of the extra data, with package prefix.
8207 * @param value The integer data value.
8208 *
8209 * @return Returns the same Intent object, for chaining multiple calls
8210 * into a single statement.
8211 *
8212 * @see #putExtras
8213 * @see #removeExtra
8214 * @see #getIntExtra(String, int)
8215 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008216 public @NonNull Intent putExtra(String name, int value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008217 if (mExtras == null) {
8218 mExtras = new Bundle();
8219 }
8220 mExtras.putInt(name, value);
8221 return this;
8222 }
8223
8224 /**
8225 * Add extended data to the intent. The name must include a package
8226 * prefix, for example the app com.android.contacts would use names
8227 * like "com.android.contacts.ShowAll".
8228 *
8229 * @param name The name of the extra data, with package prefix.
8230 * @param value The long data value.
8231 *
8232 * @return Returns the same Intent object, for chaining multiple calls
8233 * into a single statement.
8234 *
8235 * @see #putExtras
8236 * @see #removeExtra
8237 * @see #getLongExtra(String, long)
8238 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008239 public @NonNull Intent putExtra(String name, long value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008240 if (mExtras == null) {
8241 mExtras = new Bundle();
8242 }
8243 mExtras.putLong(name, value);
8244 return this;
8245 }
8246
8247 /**
8248 * Add extended data to the intent. The name must include a package
8249 * prefix, for example the app com.android.contacts would use names
8250 * like "com.android.contacts.ShowAll".
8251 *
8252 * @param name The name of the extra data, with package prefix.
8253 * @param value The float data value.
8254 *
8255 * @return Returns the same Intent object, for chaining multiple calls
8256 * into a single statement.
8257 *
8258 * @see #putExtras
8259 * @see #removeExtra
8260 * @see #getFloatExtra(String, float)
8261 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008262 public @NonNull Intent putExtra(String name, float value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008263 if (mExtras == null) {
8264 mExtras = new Bundle();
8265 }
8266 mExtras.putFloat(name, value);
8267 return this;
8268 }
8269
8270 /**
8271 * Add extended data to the intent. The name must include a package
8272 * prefix, for example the app com.android.contacts would use names
8273 * like "com.android.contacts.ShowAll".
8274 *
8275 * @param name The name of the extra data, with package prefix.
8276 * @param value The double data value.
8277 *
8278 * @return Returns the same Intent object, for chaining multiple calls
8279 * into a single statement.
8280 *
8281 * @see #putExtras
8282 * @see #removeExtra
8283 * @see #getDoubleExtra(String, double)
8284 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008285 public @NonNull Intent putExtra(String name, double value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008286 if (mExtras == null) {
8287 mExtras = new Bundle();
8288 }
8289 mExtras.putDouble(name, value);
8290 return this;
8291 }
8292
8293 /**
8294 * Add extended data to the intent. The name must include a package
8295 * prefix, for example the app com.android.contacts would use names
8296 * like "com.android.contacts.ShowAll".
8297 *
8298 * @param name The name of the extra data, with package prefix.
8299 * @param value The String data value.
8300 *
8301 * @return Returns the same Intent object, for chaining multiple calls
8302 * into a single statement.
8303 *
8304 * @see #putExtras
8305 * @see #removeExtra
8306 * @see #getStringExtra(String)
8307 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008308 public @NonNull Intent putExtra(String name, String value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008309 if (mExtras == null) {
8310 mExtras = new Bundle();
8311 }
8312 mExtras.putString(name, value);
8313 return this;
8314 }
8315
8316 /**
8317 * Add extended data to the intent. The name must include a package
8318 * prefix, for example the app com.android.contacts would use names
8319 * like "com.android.contacts.ShowAll".
8320 *
8321 * @param name The name of the extra data, with package prefix.
8322 * @param value The CharSequence data value.
8323 *
8324 * @return Returns the same Intent object, for chaining multiple calls
8325 * into a single statement.
8326 *
8327 * @see #putExtras
8328 * @see #removeExtra
8329 * @see #getCharSequenceExtra(String)
8330 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008331 public @NonNull Intent putExtra(String name, CharSequence value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008332 if (mExtras == null) {
8333 mExtras = new Bundle();
8334 }
8335 mExtras.putCharSequence(name, value);
8336 return this;
8337 }
8338
8339 /**
8340 * Add extended data to the intent. The name must include a package
8341 * prefix, for example the app com.android.contacts would use names
8342 * like "com.android.contacts.ShowAll".
8343 *
8344 * @param name The name of the extra data, with package prefix.
8345 * @param value The Parcelable data value.
8346 *
8347 * @return Returns the same Intent object, for chaining multiple calls
8348 * into a single statement.
8349 *
8350 * @see #putExtras
8351 * @see #removeExtra
8352 * @see #getParcelableExtra(String)
8353 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008354 public @NonNull Intent putExtra(String name, Parcelable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008355 if (mExtras == null) {
8356 mExtras = new Bundle();
8357 }
8358 mExtras.putParcelable(name, value);
8359 return this;
8360 }
8361
8362 /**
8363 * Add extended data to the intent. The name must include a package
8364 * prefix, for example the app com.android.contacts would use names
8365 * like "com.android.contacts.ShowAll".
8366 *
8367 * @param name The name of the extra data, with package prefix.
8368 * @param value The Parcelable[] data value.
8369 *
8370 * @return Returns the same Intent object, for chaining multiple calls
8371 * into a single statement.
8372 *
8373 * @see #putExtras
8374 * @see #removeExtra
8375 * @see #getParcelableArrayExtra(String)
8376 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008377 public @NonNull Intent putExtra(String name, Parcelable[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008378 if (mExtras == null) {
8379 mExtras = new Bundle();
8380 }
8381 mExtras.putParcelableArray(name, value);
8382 return this;
8383 }
8384
8385 /**
8386 * Add extended data to the intent. The name must include a package
8387 * prefix, for example the app com.android.contacts would use names
8388 * like "com.android.contacts.ShowAll".
8389 *
8390 * @param name The name of the extra data, with package prefix.
8391 * @param value The ArrayList<Parcelable> data value.
8392 *
8393 * @return Returns the same Intent object, for chaining multiple calls
8394 * into a single statement.
8395 *
8396 * @see #putExtras
8397 * @see #removeExtra
8398 * @see #getParcelableArrayListExtra(String)
8399 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008400 public @NonNull Intent putParcelableArrayListExtra(String name,
8401 ArrayList<? extends Parcelable> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008402 if (mExtras == null) {
8403 mExtras = new Bundle();
8404 }
8405 mExtras.putParcelableArrayList(name, value);
8406 return this;
8407 }
8408
8409 /**
8410 * Add extended data to the intent. The name must include a package
8411 * prefix, for example the app com.android.contacts would use names
8412 * like "com.android.contacts.ShowAll".
8413 *
8414 * @param name The name of the extra data, with package prefix.
8415 * @param value The ArrayList<Integer> data value.
8416 *
8417 * @return Returns the same Intent object, for chaining multiple calls
8418 * into a single statement.
8419 *
8420 * @see #putExtras
8421 * @see #removeExtra
8422 * @see #getIntegerArrayListExtra(String)
8423 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008424 public @NonNull Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008425 if (mExtras == null) {
8426 mExtras = new Bundle();
8427 }
8428 mExtras.putIntegerArrayList(name, value);
8429 return this;
8430 }
8431
8432 /**
8433 * Add extended data to the intent. The name must include a package
8434 * prefix, for example the app com.android.contacts would use names
8435 * like "com.android.contacts.ShowAll".
8436 *
8437 * @param name The name of the extra data, with package prefix.
8438 * @param value The ArrayList<String> data value.
8439 *
8440 * @return Returns the same Intent object, for chaining multiple calls
8441 * into a single statement.
8442 *
8443 * @see #putExtras
8444 * @see #removeExtra
8445 * @see #getStringArrayListExtra(String)
8446 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008447 public @NonNull Intent putStringArrayListExtra(String name, ArrayList<String> value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008448 if (mExtras == null) {
8449 mExtras = new Bundle();
8450 }
8451 mExtras.putStringArrayList(name, value);
8452 return this;
8453 }
8454
8455 /**
8456 * Add extended data to the intent. The name must include a package
8457 * prefix, for example the app com.android.contacts would use names
8458 * like "com.android.contacts.ShowAll".
8459 *
8460 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008461 * @param value The ArrayList<CharSequence> data value.
8462 *
8463 * @return Returns the same Intent object, for chaining multiple calls
8464 * into a single statement.
8465 *
8466 * @see #putExtras
8467 * @see #removeExtra
8468 * @see #getCharSequenceArrayListExtra(String)
8469 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008470 public @NonNull Intent putCharSequenceArrayListExtra(String name,
8471 ArrayList<CharSequence> value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008472 if (mExtras == null) {
8473 mExtras = new Bundle();
8474 }
8475 mExtras.putCharSequenceArrayList(name, value);
8476 return this;
8477 }
8478
8479 /**
8480 * Add extended data to the intent. The name must include a package
8481 * prefix, for example the app com.android.contacts would use names
8482 * like "com.android.contacts.ShowAll".
8483 *
8484 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008485 * @param value The Serializable data value.
8486 *
8487 * @return Returns the same Intent object, for chaining multiple calls
8488 * into a single statement.
8489 *
8490 * @see #putExtras
8491 * @see #removeExtra
8492 * @see #getSerializableExtra(String)
8493 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008494 public @NonNull Intent putExtra(String name, Serializable value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008495 if (mExtras == null) {
8496 mExtras = new Bundle();
8497 }
8498 mExtras.putSerializable(name, value);
8499 return this;
8500 }
8501
8502 /**
8503 * Add extended data to the intent. The name must include a package
8504 * prefix, for example the app com.android.contacts would use names
8505 * like "com.android.contacts.ShowAll".
8506 *
8507 * @param name The name of the extra data, with package prefix.
8508 * @param value The boolean array data value.
8509 *
8510 * @return Returns the same Intent object, for chaining multiple calls
8511 * into a single statement.
8512 *
8513 * @see #putExtras
8514 * @see #removeExtra
8515 * @see #getBooleanArrayExtra(String)
8516 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008517 public @NonNull Intent putExtra(String name, boolean[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008518 if (mExtras == null) {
8519 mExtras = new Bundle();
8520 }
8521 mExtras.putBooleanArray(name, value);
8522 return this;
8523 }
8524
8525 /**
8526 * Add extended data to the intent. The name must include a package
8527 * prefix, for example the app com.android.contacts would use names
8528 * like "com.android.contacts.ShowAll".
8529 *
8530 * @param name The name of the extra data, with package prefix.
8531 * @param value The byte array data value.
8532 *
8533 * @return Returns the same Intent object, for chaining multiple calls
8534 * into a single statement.
8535 *
8536 * @see #putExtras
8537 * @see #removeExtra
8538 * @see #getByteArrayExtra(String)
8539 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008540 public @NonNull Intent putExtra(String name, byte[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008541 if (mExtras == null) {
8542 mExtras = new Bundle();
8543 }
8544 mExtras.putByteArray(name, value);
8545 return this;
8546 }
8547
8548 /**
8549 * Add extended data to the intent. The name must include a package
8550 * prefix, for example the app com.android.contacts would use names
8551 * like "com.android.contacts.ShowAll".
8552 *
8553 * @param name The name of the extra data, with package prefix.
8554 * @param value The short array data value.
8555 *
8556 * @return Returns the same Intent object, for chaining multiple calls
8557 * into a single statement.
8558 *
8559 * @see #putExtras
8560 * @see #removeExtra
8561 * @see #getShortArrayExtra(String)
8562 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008563 public @NonNull Intent putExtra(String name, short[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008564 if (mExtras == null) {
8565 mExtras = new Bundle();
8566 }
8567 mExtras.putShortArray(name, value);
8568 return this;
8569 }
8570
8571 /**
8572 * Add extended data to the intent. The name must include a package
8573 * prefix, for example the app com.android.contacts would use names
8574 * like "com.android.contacts.ShowAll".
8575 *
8576 * @param name The name of the extra data, with package prefix.
8577 * @param value The char array data value.
8578 *
8579 * @return Returns the same Intent object, for chaining multiple calls
8580 * into a single statement.
8581 *
8582 * @see #putExtras
8583 * @see #removeExtra
8584 * @see #getCharArrayExtra(String)
8585 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008586 public @NonNull Intent putExtra(String name, char[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008587 if (mExtras == null) {
8588 mExtras = new Bundle();
8589 }
8590 mExtras.putCharArray(name, value);
8591 return this;
8592 }
8593
8594 /**
8595 * Add extended data to the intent. The name must include a package
8596 * prefix, for example the app com.android.contacts would use names
8597 * like "com.android.contacts.ShowAll".
8598 *
8599 * @param name The name of the extra data, with package prefix.
8600 * @param value The int array data value.
8601 *
8602 * @return Returns the same Intent object, for chaining multiple calls
8603 * into a single statement.
8604 *
8605 * @see #putExtras
8606 * @see #removeExtra
8607 * @see #getIntArrayExtra(String)
8608 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008609 public @NonNull Intent putExtra(String name, int[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008610 if (mExtras == null) {
8611 mExtras = new Bundle();
8612 }
8613 mExtras.putIntArray(name, value);
8614 return this;
8615 }
8616
8617 /**
8618 * Add extended data to the intent. The name must include a package
8619 * prefix, for example the app com.android.contacts would use names
8620 * like "com.android.contacts.ShowAll".
8621 *
8622 * @param name The name of the extra data, with package prefix.
8623 * @param value The byte array data value.
8624 *
8625 * @return Returns the same Intent object, for chaining multiple calls
8626 * into a single statement.
8627 *
8628 * @see #putExtras
8629 * @see #removeExtra
8630 * @see #getLongArrayExtra(String)
8631 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008632 public @NonNull Intent putExtra(String name, long[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008633 if (mExtras == null) {
8634 mExtras = new Bundle();
8635 }
8636 mExtras.putLongArray(name, value);
8637 return this;
8638 }
8639
8640 /**
8641 * Add extended data to the intent. The name must include a package
8642 * prefix, for example the app com.android.contacts would use names
8643 * like "com.android.contacts.ShowAll".
8644 *
8645 * @param name The name of the extra data, with package prefix.
8646 * @param value The float array data value.
8647 *
8648 * @return Returns the same Intent object, for chaining multiple calls
8649 * into a single statement.
8650 *
8651 * @see #putExtras
8652 * @see #removeExtra
8653 * @see #getFloatArrayExtra(String)
8654 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008655 public @NonNull Intent putExtra(String name, float[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008656 if (mExtras == null) {
8657 mExtras = new Bundle();
8658 }
8659 mExtras.putFloatArray(name, value);
8660 return this;
8661 }
8662
8663 /**
8664 * Add extended data to the intent. The name must include a package
8665 * prefix, for example the app com.android.contacts would use names
8666 * like "com.android.contacts.ShowAll".
8667 *
8668 * @param name The name of the extra data, with package prefix.
8669 * @param value The double array data value.
8670 *
8671 * @return Returns the same Intent object, for chaining multiple calls
8672 * into a single statement.
8673 *
8674 * @see #putExtras
8675 * @see #removeExtra
8676 * @see #getDoubleArrayExtra(String)
8677 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008678 public @NonNull Intent putExtra(String name, double[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 if (mExtras == null) {
8680 mExtras = new Bundle();
8681 }
8682 mExtras.putDoubleArray(name, value);
8683 return this;
8684 }
8685
8686 /**
8687 * Add extended data to the intent. The name must include a package
8688 * prefix, for example the app com.android.contacts would use names
8689 * like "com.android.contacts.ShowAll".
8690 *
8691 * @param name The name of the extra data, with package prefix.
8692 * @param value The String array data value.
8693 *
8694 * @return Returns the same Intent object, for chaining multiple calls
8695 * into a single statement.
8696 *
8697 * @see #putExtras
8698 * @see #removeExtra
8699 * @see #getStringArrayExtra(String)
8700 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008701 public @NonNull Intent putExtra(String name, String[] value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008702 if (mExtras == null) {
8703 mExtras = new Bundle();
8704 }
8705 mExtras.putStringArray(name, value);
8706 return this;
8707 }
8708
8709 /**
8710 * Add extended data to the intent. The name must include a package
8711 * prefix, for example the app com.android.contacts would use names
8712 * like "com.android.contacts.ShowAll".
8713 *
8714 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008715 * @param value The CharSequence array data value.
8716 *
8717 * @return Returns the same Intent object, for chaining multiple calls
8718 * into a single statement.
8719 *
8720 * @see #putExtras
8721 * @see #removeExtra
8722 * @see #getCharSequenceArrayExtra(String)
8723 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008724 public @NonNull Intent putExtra(String name, CharSequence[] value) {
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00008725 if (mExtras == null) {
8726 mExtras = new Bundle();
8727 }
8728 mExtras.putCharSequenceArray(name, value);
8729 return this;
8730 }
8731
8732 /**
8733 * Add extended data to the intent. The name must include a package
8734 * prefix, for example the app com.android.contacts would use names
8735 * like "com.android.contacts.ShowAll".
8736 *
8737 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008738 * @param value The Bundle data value.
8739 *
8740 * @return Returns the same Intent object, for chaining multiple calls
8741 * into a single statement.
8742 *
8743 * @see #putExtras
8744 * @see #removeExtra
8745 * @see #getBundleExtra(String)
8746 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008747 public @NonNull Intent putExtra(String name, Bundle value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008748 if (mExtras == null) {
8749 mExtras = new Bundle();
8750 }
8751 mExtras.putBundle(name, value);
8752 return this;
8753 }
8754
8755 /**
8756 * Add extended data to the intent. The name must include a package
8757 * prefix, for example the app com.android.contacts would use names
8758 * like "com.android.contacts.ShowAll".
8759 *
8760 * @param name The name of the extra data, with package prefix.
8761 * @param value The IBinder data value.
8762 *
8763 * @return Returns the same Intent object, for chaining multiple calls
8764 * into a single statement.
8765 *
8766 * @see #putExtras
8767 * @see #removeExtra
8768 * @see #getIBinderExtra(String)
8769 *
8770 * @deprecated
8771 * @hide
8772 */
8773 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008774 public @NonNull Intent putExtra(String name, IBinder value) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008775 if (mExtras == null) {
8776 mExtras = new Bundle();
8777 }
8778 mExtras.putIBinder(name, value);
8779 return this;
8780 }
8781
8782 /**
8783 * Copy all extras in 'src' in to this intent.
8784 *
8785 * @param src Contains the extras to copy.
8786 *
8787 * @see #putExtra
8788 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008789 public @NonNull Intent putExtras(@NonNull Intent src) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008790 if (src.mExtras != null) {
8791 if (mExtras == null) {
8792 mExtras = new Bundle(src.mExtras);
8793 } else {
8794 mExtras.putAll(src.mExtras);
8795 }
8796 }
8797 return this;
8798 }
8799
8800 /**
8801 * Add a set of extended data to the intent. The keys must include a package
8802 * prefix, for example the app com.android.contacts would use names
8803 * like "com.android.contacts.ShowAll".
8804 *
8805 * @param extras The Bundle of extras to add to this intent.
8806 *
8807 * @see #putExtra
8808 * @see #removeExtra
8809 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008810 public @NonNull Intent putExtras(@NonNull Bundle extras) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008811 if (mExtras == null) {
8812 mExtras = new Bundle();
8813 }
8814 mExtras.putAll(extras);
8815 return this;
8816 }
8817
8818 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008819 * Completely replace the extras in the Intent with the extras in the
8820 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008821 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008822 * @param src The exact extras contained in this Intent are copied
8823 * into the target intent, replacing any that were previously there.
8824 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008825 public @NonNull Intent replaceExtras(@NonNull Intent src) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008826 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8827 return this;
8828 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008829
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008830 /**
8831 * Completely replace the extras in the Intent with the given Bundle of
8832 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008833 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008834 * @param extras The new set of extras in the Intent, or null to erase
8835 * all extras.
8836 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008837 public @NonNull Intent replaceExtras(@NonNull Bundle extras) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008838 mExtras = extras != null ? new Bundle(extras) : null;
8839 return this;
8840 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008841
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008842 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008843 * Remove extended data from the intent.
8844 *
8845 * @see #putExtra
8846 */
8847 public void removeExtra(String name) {
8848 if (mExtras != null) {
8849 mExtras.remove(name);
8850 if (mExtras.size() == 0) {
8851 mExtras = null;
8852 }
8853 }
8854 }
8855
8856 /**
8857 * Set special flags controlling how this intent is handled. Most values
8858 * here depend on the type of component being executed by the Intent,
8859 * specifically the FLAG_ACTIVITY_* flags are all for use with
8860 * {@link Context#startActivity Context.startActivity()} and the
8861 * FLAG_RECEIVER_* flags are all for use with
8862 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8863 *
Scott Main7aee61f2011-02-08 11:25:01 -08008864 * <p>See the
8865 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8866 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008867 * the behavior of your application.
8868 *
8869 * @param flags The desired flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008870 * @return Returns the same Intent object, for chaining multiple calls
8871 * into a single statement.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008872 * @see #getFlags
8873 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008874 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008875 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008876 public @NonNull Intent setFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008877 mFlags = flags;
8878 return this;
8879 }
8880
8881 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008882 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008883 *
8884 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008885 * @return Returns the same Intent object, for chaining multiple calls into
8886 * a single statement.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008887 * @see #setFlags
8888 * @see #getFlags
8889 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008890 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008891 public @NonNull Intent addFlags(@Flags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008892 mFlags |= flags;
8893 return this;
8894 }
8895
8896 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008897 * Remove these flags from the intent.
8898 *
8899 * @param flags The flags to remove.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008900 * @see #setFlags
8901 * @see #getFlags
8902 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008903 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008904 public void removeFlags(@Flags int flags) {
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008905 mFlags &= ~flags;
8906 }
8907
8908 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008909 * (Usually optional) Set an explicit application package name that limits
8910 * the components this Intent will resolve to. If left to the default
8911 * value of null, all components in all applications will considered.
8912 * If non-null, the Intent can only match the components in the given
8913 * application package.
8914 *
8915 * @param packageName The name of the application package to handle the
8916 * intent, or null to allow any application package.
8917 *
8918 * @return Returns the same Intent object, for chaining multiple calls
8919 * into a single statement.
8920 *
8921 * @see #getPackage
8922 * @see #resolveActivity
8923 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008924 public @NonNull Intent setPackage(@Nullable String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008925 if (packageName != null && mSelector != null) {
8926 throw new IllegalArgumentException(
8927 "Can't set package name when selector is already set");
8928 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008929 mPackage = packageName;
8930 return this;
8931 }
8932
8933 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008934 * (Usually optional) Explicitly set the component to handle the intent.
8935 * If left with the default value of null, the system will determine the
8936 * appropriate class to use based on the other fields (action, data,
8937 * type, categories) in the Intent. If this class is defined, the
8938 * specified class will always be used regardless of the other fields. You
8939 * should only set this value when you know you absolutely want a specific
8940 * class to be used; otherwise it is better to let the system find the
8941 * appropriate class so that you will respect the installed applications
8942 * and user preferences.
8943 *
8944 * @param component The name of the application component to handle the
8945 * intent, or null to let the system find one for you.
8946 *
8947 * @return Returns the same Intent object, for chaining multiple calls
8948 * into a single statement.
8949 *
8950 * @see #setClass
8951 * @see #setClassName(Context, String)
8952 * @see #setClassName(String, String)
8953 * @see #getComponent
8954 * @see #resolveActivity
8955 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008956 public @NonNull Intent setComponent(@Nullable ComponentName component) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008957 mComponent = component;
8958 return this;
8959 }
8960
8961 /**
8962 * Convenience for calling {@link #setComponent} with an
8963 * explicit class name.
8964 *
8965 * @param packageContext A Context of the application package implementing
8966 * this class.
8967 * @param className The name of a class inside of the application package
8968 * that will be used as the component for this Intent.
8969 *
8970 * @return Returns the same Intent object, for chaining multiple calls
8971 * into a single statement.
8972 *
8973 * @see #setComponent
8974 * @see #setClass
8975 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008976 public @NonNull Intent setClassName(@NonNull Context packageContext,
8977 @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008978 mComponent = new ComponentName(packageContext, className);
8979 return this;
8980 }
8981
8982 /**
8983 * Convenience for calling {@link #setComponent} with an
8984 * explicit application package name and class name.
8985 *
8986 * @param packageName The name of the package implementing the desired
8987 * component.
8988 * @param className The name of a class inside of the application package
8989 * that will be used as the component for this Intent.
8990 *
8991 * @return Returns the same Intent object, for chaining multiple calls
8992 * into a single statement.
8993 *
8994 * @see #setComponent
8995 * @see #setClass
8996 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06008997 public @NonNull Intent setClassName(@NonNull String packageName, @NonNull String className) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008998 mComponent = new ComponentName(packageName, className);
8999 return this;
9000 }
9001
9002 /**
9003 * Convenience for calling {@link #setComponent(ComponentName)} with the
9004 * name returned by a {@link Class} object.
9005 *
9006 * @param packageContext A Context of the application package implementing
9007 * this class.
9008 * @param cls The class name to set, equivalent to
9009 * <code>setClassName(context, cls.getName())</code>.
9010 *
9011 * @return Returns the same Intent object, for chaining multiple calls
9012 * into a single statement.
9013 *
9014 * @see #setComponent
9015 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009016 public @NonNull Intent setClass(@NonNull Context packageContext, @NonNull Class<?> cls) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009017 mComponent = new ComponentName(packageContext, cls);
9018 return this;
9019 }
9020
9021 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009022 * Set the bounds of the sender of this intent, in screen coordinates. This can be
9023 * used as a hint to the receiver for animations and the like. Null means that there
9024 * is no source bounds.
9025 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009026 public void setSourceBounds(@Nullable Rect r) {
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009027 if (r != null) {
9028 mSourceBounds = new Rect(r);
9029 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07009030 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009031 }
9032 }
9033
Tor Norbyed9273d62013-05-30 15:59:53 -07009034 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07009035 @IntDef(flag = true, prefix = { "FILL_IN_" }, value = {
9036 FILL_IN_ACTION,
9037 FILL_IN_DATA,
9038 FILL_IN_CATEGORIES,
9039 FILL_IN_COMPONENT,
9040 FILL_IN_PACKAGE,
9041 FILL_IN_SOURCE_BOUNDS,
9042 FILL_IN_SELECTOR,
9043 FILL_IN_CLIP_DATA
9044 })
Tor Norbyed9273d62013-05-30 15:59:53 -07009045 @Retention(RetentionPolicy.SOURCE)
9046 public @interface FillInFlags {}
9047
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009048 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009049 * Use with {@link #fillIn} to allow the current action value to be
9050 * overwritten, even if it is already set.
9051 */
9052 public static final int FILL_IN_ACTION = 1<<0;
9053
9054 /**
9055 * Use with {@link #fillIn} to allow the current data or type value
9056 * overwritten, even if it is already set.
9057 */
9058 public static final int FILL_IN_DATA = 1<<1;
9059
9060 /**
9061 * Use with {@link #fillIn} to allow the current categories to be
9062 * overwritten, even if they are already set.
9063 */
9064 public static final int FILL_IN_CATEGORIES = 1<<2;
9065
9066 /**
9067 * Use with {@link #fillIn} to allow the current component value to be
9068 * overwritten, even if it is already set.
9069 */
9070 public static final int FILL_IN_COMPONENT = 1<<3;
9071
9072 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009073 * Use with {@link #fillIn} to allow the current package value to be
9074 * overwritten, even if it is already set.
9075 */
9076 public static final int FILL_IN_PACKAGE = 1<<4;
9077
9078 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009079 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009080 * overwritten, even if it is already set.
9081 */
9082 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
9083
9084 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009085 * Use with {@link #fillIn} to allow the current selector to be
9086 * overwritten, even if it is already set.
9087 */
9088 public static final int FILL_IN_SELECTOR = 1<<6;
9089
9090 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009091 * Use with {@link #fillIn} to allow the current ClipData to be
9092 * overwritten, even if it is already set.
9093 */
9094 public static final int FILL_IN_CLIP_DATA = 1<<7;
9095
9096 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009097 * Copy the contents of <var>other</var> in to this object, but only
9098 * where fields are not defined by this object. For purposes of a field
9099 * being defined, the following pieces of data in the Intent are
9100 * considered to be separate fields:
9101 *
9102 * <ul>
9103 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08009104 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009105 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
9106 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009107 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009108 * <li> component, as set by {@link #setComponent(ComponentName)} or
9109 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009110 * <li> source bounds, as set by {@link #setSourceBounds}.
9111 * <li> selector, as set by {@link #setSelector(Intent)}.
9112 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009113 * <li> each top-level name in the associated extras.
9114 * </ul>
9115 *
9116 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009117 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009118 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
9119 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
9120 * the restriction where the corresponding field will not be replaced if
9121 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009122 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009123 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
9124 * is explicitly specified. The selector will only be copied if
9125 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07009126 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009127 * <p>For example, consider Intent A with {data="foo", categories="bar"}
9128 * and Intent B with {action="gotit", data-type="some/thing",
9129 * categories="one","two"}.
9130 *
9131 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
9132 * containing: {action="gotit", data-type="some/thing",
9133 * categories="bar"}.
9134 *
9135 * @param other Another Intent whose values are to be used to fill in
9136 * the current one.
9137 * @param flags Options to control which fields can be filled in.
9138 *
9139 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009140 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07009141 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08009142 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07009143 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009144 */
Tor Norbyed9273d62013-05-30 15:59:53 -07009145 @FillInFlags
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009146 public int fillIn(@NonNull Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009147 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009148 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009149 if (other.mAction != null
9150 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009151 mAction = other.mAction;
9152 changes |= FILL_IN_ACTION;
9153 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009154 if ((other.mData != null || other.mType != null)
9155 && ((mData == null && mType == null)
9156 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009157 mData = other.mData;
9158 mType = other.mType;
9159 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009160 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009161 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009162 if (other.mCategories != null
9163 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009164 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009165 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009166 }
9167 changes |= FILL_IN_CATEGORIES;
9168 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009169 if (other.mPackage != null
9170 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009171 // Only do this if mSelector is not set.
9172 if (mSelector == null) {
9173 mPackage = other.mPackage;
9174 changes |= FILL_IN_PACKAGE;
9175 }
9176 }
9177 // Selector is special: it can only be set if explicitly allowed,
9178 // for the same reason as the component name.
9179 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
9180 if (mPackage == null) {
9181 mSelector = new Intent(other.mSelector);
9182 mPackage = null;
9183 changes |= FILL_IN_SELECTOR;
9184 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009185 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009186 if (other.mClipData != null
9187 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
9188 mClipData = other.mClipData;
9189 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009190 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009191 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009192 // Component is special: it can -only- be set if explicitly allowed,
9193 // since otherwise the sender could force the intent somewhere the
9194 // originator didn't intend.
9195 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009196 mComponent = other.mComponent;
9197 changes |= FILL_IN_COMPONENT;
9198 }
9199 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009200 if (other.mSourceBounds != null
9201 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
9202 mSourceBounds = new Rect(other.mSourceBounds);
9203 changes |= FILL_IN_SOURCE_BOUNDS;
9204 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009205 if (mExtras == null) {
9206 if (other.mExtras != null) {
9207 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009208 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009209 }
9210 } else if (other.mExtras != null) {
9211 try {
9212 Bundle newb = new Bundle(other.mExtras);
9213 newb.putAll(mExtras);
9214 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009215 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009216 } catch (RuntimeException e) {
9217 // Modifying the extras can cause us to unparcel the contents
9218 // of the bundle, and if we do this in the system process that
9219 // may fail. We really should handle this (i.e., the Bundle
9220 // impl shouldn't be on top of a plain map), but for now just
9221 // ignore it and keep the original contents. :(
9222 Log.w("Intent", "Failure filling in extras", e);
9223 }
9224 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009225 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
9226 && other.mContentUserHint != UserHandle.USER_CURRENT) {
9227 mContentUserHint = other.mContentUserHint;
9228 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009229 return changes;
9230 }
9231
9232 /**
9233 * Wrapper class holding an Intent and implementing comparisons on it for
9234 * the purpose of filtering. The class implements its
9235 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
9236 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
9237 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
9238 * on the wrapped Intent.
9239 */
9240 public static final class FilterComparison {
9241 private final Intent mIntent;
9242 private final int mHashCode;
9243
9244 public FilterComparison(Intent intent) {
9245 mIntent = intent;
9246 mHashCode = intent.filterHashCode();
9247 }
9248
9249 /**
9250 * Return the Intent that this FilterComparison represents.
9251 * @return Returns the Intent held by the FilterComparison. Do
9252 * not modify!
9253 */
9254 public Intent getIntent() {
9255 return mIntent;
9256 }
9257
9258 @Override
9259 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009260 if (obj instanceof FilterComparison) {
9261 Intent other = ((FilterComparison)obj).mIntent;
9262 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009263 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009264 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009265 }
9266
9267 @Override
9268 public int hashCode() {
9269 return mHashCode;
9270 }
9271 }
9272
9273 /**
9274 * Determine if two intents are the same for the purposes of intent
9275 * resolution (filtering). That is, if their action, data, type,
9276 * class, and categories are the same. This does <em>not</em> compare
9277 * any extra data included in the intents.
9278 *
9279 * @param other The other Intent to compare against.
9280 *
9281 * @return Returns true if action, data, type, class, and categories
9282 * are the same.
9283 */
9284 public boolean filterEquals(Intent other) {
9285 if (other == null) {
9286 return false;
9287 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07009288 if (!Objects.equals(this.mAction, other.mAction)) return false;
9289 if (!Objects.equals(this.mData, other.mData)) return false;
9290 if (!Objects.equals(this.mType, other.mType)) return false;
9291 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
9292 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
9293 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009294
9295 return true;
9296 }
9297
9298 /**
9299 * Generate hash code that matches semantics of filterEquals().
9300 *
9301 * @return Returns the hash value of the action, data, type, class, and
9302 * categories.
9303 *
9304 * @see #filterEquals
9305 */
9306 public int filterHashCode() {
9307 int code = 0;
9308 if (mAction != null) {
9309 code += mAction.hashCode();
9310 }
9311 if (mData != null) {
9312 code += mData.hashCode();
9313 }
9314 if (mType != null) {
9315 code += mType.hashCode();
9316 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009317 if (mPackage != null) {
9318 code += mPackage.hashCode();
9319 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009320 if (mComponent != null) {
9321 code += mComponent.hashCode();
9322 }
9323 if (mCategories != null) {
9324 code += mCategories.hashCode();
9325 }
9326 return code;
9327 }
9328
9329 @Override
9330 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009331 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009332
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009333 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009334 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009335 b.append(" }");
9336
9337 return b.toString();
9338 }
9339
9340 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009341 public String toInsecureString() {
9342 StringBuilder b = new StringBuilder(128);
9343
9344 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009345 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009346 b.append(" }");
9347
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009348 return b.toString();
9349 }
Romain Guy4969af72009-06-17 10:53:19 -07009350
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009351 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009352 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009353 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009354
9355 b.append("Intent { ");
9356 toShortString(b, false, true, true, true);
9357 b.append(" }");
9358
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009359 return b.toString();
9360 }
9361
9362 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009363 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
9364 StringBuilder b = new StringBuilder(128);
9365 toShortString(b, secure, comp, extras, clip);
9366 return b.toString();
9367 }
9368
9369 /** @hide */
9370 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
9371 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009372 boolean first = true;
9373 if (mAction != null) {
9374 b.append("act=").append(mAction);
9375 first = false;
9376 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009377 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009378 if (!first) {
9379 b.append(' ');
9380 }
9381 first = false;
9382 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009383 for (int i=0; i<mCategories.size(); i++) {
9384 if (i > 0) b.append(',');
9385 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009386 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009387 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009388 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009389 if (mData != null) {
9390 if (!first) {
9391 b.append(' ');
9392 }
9393 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07009394 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07009395 if (secure) {
9396 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07009397 } else {
9398 b.append(mData);
9399 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009400 }
9401 if (mType != null) {
9402 if (!first) {
9403 b.append(' ');
9404 }
9405 first = false;
9406 b.append("typ=").append(mType);
9407 }
9408 if (mFlags != 0) {
9409 if (!first) {
9410 b.append(' ');
9411 }
9412 first = false;
9413 b.append("flg=0x").append(Integer.toHexString(mFlags));
9414 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009415 if (mPackage != null) {
9416 if (!first) {
9417 b.append(' ');
9418 }
9419 first = false;
9420 b.append("pkg=").append(mPackage);
9421 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009422 if (comp && mComponent != null) {
9423 if (!first) {
9424 b.append(' ');
9425 }
9426 first = false;
9427 b.append("cmp=").append(mComponent.flattenToShortString());
9428 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009429 if (mSourceBounds != null) {
9430 if (!first) {
9431 b.append(' ');
9432 }
9433 first = false;
9434 b.append("bnds=").append(mSourceBounds.toShortString());
9435 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009436 if (mClipData != null) {
9437 if (!first) {
9438 b.append(' ');
9439 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009440 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009441 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009442 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009443 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07009444 if (mClipData.getDescription() != null) {
9445 first = !mClipData.getDescription().toShortStringTypesOnly(b);
9446 } else {
9447 first = true;
9448 }
9449 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009450 }
Dianne Hackbornae498722015-08-14 13:29:47 -07009451 first = false;
9452 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009453 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009454 if (extras && mExtras != null) {
9455 if (!first) {
9456 b.append(' ');
9457 }
9458 first = false;
9459 b.append("(has extras)");
9460 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009461 if (mContentUserHint != UserHandle.USER_CURRENT) {
9462 if (!first) {
9463 b.append(' ');
9464 }
9465 first = false;
9466 b.append("u=").append(mContentUserHint);
9467 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009468 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009469 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009470 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009471 b.append("}");
9472 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009473 }
9474
Yi Jin129fc6c2017-09-28 15:48:38 -07009475 /** @hide */
Kweku Adams85f2fbc2017-12-18 12:04:12 -08009476 public void writeToProto(ProtoOutputStream proto, long fieldId) {
9477 // Same input parameters that toString() gives to toShortString().
9478 writeToProto(proto, fieldId, true, true, true, false);
9479 }
9480
9481 /** @hide */
Yi Jin129fc6c2017-09-28 15:48:38 -07009482 public void writeToProto(ProtoOutputStream proto, long fieldId, boolean secure, boolean comp,
9483 boolean extras, boolean clip) {
9484 long token = proto.start(fieldId);
9485 if (mAction != null) {
9486 proto.write(IntentProto.ACTION, mAction);
9487 }
9488 if (mCategories != null) {
9489 for (String category : mCategories) {
9490 proto.write(IntentProto.CATEGORIES, category);
9491 }
9492 }
9493 if (mData != null) {
9494 proto.write(IntentProto.DATA, secure ? mData.toSafeString() : mData.toString());
9495 }
9496 if (mType != null) {
9497 proto.write(IntentProto.TYPE, mType);
9498 }
9499 if (mFlags != 0) {
9500 proto.write(IntentProto.FLAG, "0x" + Integer.toHexString(mFlags));
9501 }
9502 if (mPackage != null) {
9503 proto.write(IntentProto.PACKAGE, mPackage);
9504 }
9505 if (comp && mComponent != null) {
Yi Jin676d1ac2018-01-25 15:40:28 -08009506 mComponent.writeToProto(proto, IntentProto.COMPONENT);
Yi Jin129fc6c2017-09-28 15:48:38 -07009507 }
9508 if (mSourceBounds != null) {
9509 proto.write(IntentProto.SOURCE_BOUNDS, mSourceBounds.toShortString());
9510 }
9511 if (mClipData != null) {
9512 StringBuilder b = new StringBuilder();
9513 if (clip) {
9514 mClipData.toShortString(b);
9515 } else {
9516 mClipData.toShortStringShortItems(b, false);
9517 }
9518 proto.write(IntentProto.CLIP_DATA, b.toString());
9519 }
9520 if (extras && mExtras != null) {
9521 proto.write(IntentProto.EXTRAS, mExtras.toShortString());
9522 }
9523 if (mContentUserHint != 0) {
9524 proto.write(IntentProto.CONTENT_USER_HINT, mContentUserHint);
9525 }
9526 if (mSelector != null) {
9527 proto.write(IntentProto.SELECTOR, mSelector.toShortString(secure, comp, extras, clip));
9528 }
9529 proto.end(token);
9530 }
9531
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009532 /**
9533 * Call {@link #toUri} with 0 flags.
9534 * @deprecated Use {@link #toUri} instead.
9535 */
9536 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009537 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009538 return toUri(0);
9539 }
9540
9541 /**
9542 * Convert this Intent into a String holding a URI representation of it.
9543 * The returned URI string has been properly URI encoded, so it can be
9544 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
9545 * Intent's data as the base URI, with an additional fragment describing
9546 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08009547 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009548 * <p>You can convert the returned string back to an Intent with
9549 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08009550 *
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009551 * @param flags Additional operating flags.
Tom Taylord4a47292009-12-21 13:59:18 -08009552 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009553 * @return Returns a URI encoding URI string describing the entire contents
9554 * of the Intent.
9555 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009556 public String toUri(@UriFlags int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07009557 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009558 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
9559 if (mPackage == null) {
9560 throw new IllegalArgumentException(
9561 "Intent must include an explicit package name to build an android-app: "
9562 + this);
9563 }
9564 uri.append("android-app://");
9565 uri.append(mPackage);
9566 String scheme = null;
9567 if (mData != null) {
9568 scheme = mData.getScheme();
9569 if (scheme != null) {
9570 uri.append('/');
9571 uri.append(scheme);
9572 String authority = mData.getEncodedAuthority();
9573 if (authority != null) {
9574 uri.append('/');
9575 uri.append(authority);
9576 String path = mData.getEncodedPath();
9577 if (path != null) {
9578 uri.append(path);
9579 }
9580 String queryParams = mData.getEncodedQuery();
9581 if (queryParams != null) {
9582 uri.append('?');
9583 uri.append(queryParams);
9584 }
9585 String fragment = mData.getEncodedFragment();
9586 if (fragment != null) {
9587 uri.append('#');
9588 uri.append(fragment);
9589 }
9590 }
9591 }
9592 }
9593 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
9594 mPackage, flags);
9595 return uri.toString();
9596 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009597 String scheme = null;
9598 if (mData != null) {
9599 String data = mData.toString();
9600 if ((flags&URI_INTENT_SCHEME) != 0) {
9601 final int N = data.length();
9602 for (int i=0; i<N; i++) {
9603 char c = data.charAt(i);
9604 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
Christopher Schuster42c3a6e2017-07-21 14:53:52 -07009605 || (c >= '0' && c <= '9') || c == '.' || c == '-' || c == '+') {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009606 continue;
9607 }
9608 if (c == ':' && i > 0) {
9609 // Valid scheme.
9610 scheme = data.substring(0, i);
9611 uri.append("intent:");
9612 data = data.substring(i+1);
9613 break;
9614 }
Tom Taylord4a47292009-12-21 13:59:18 -08009615
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009616 // No scheme.
9617 break;
9618 }
9619 }
9620 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08009621
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009622 } else if ((flags&URI_INTENT_SCHEME) != 0) {
9623 uri.append("intent:");
9624 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009625
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009626 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009627
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009628 return uri.toString();
9629 }
9630
9631 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
9632 String defPackage, int flags) {
9633 StringBuilder frag = new StringBuilder(128);
9634
9635 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009636 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08009637 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009638 // Note that for now we are not going to try to handle the
9639 // data part; not clear how to represent this as a URI, and
9640 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009641 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
9642 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009643 }
9644
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009645 if (frag.length() > 0) {
9646 uri.append("#Intent;");
9647 uri.append(frag);
9648 uri.append("end");
9649 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009650 }
9651
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009652 private void toUriInner(StringBuilder uri, String scheme, String defAction,
9653 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009654 if (scheme != null) {
9655 uri.append("scheme=").append(scheme).append(';');
9656 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009657 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009658 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009659 }
9660 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009661 for (int i=0; i<mCategories.size(); i++) {
9662 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009663 }
9664 }
9665 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009666 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009667 }
9668 if (mFlags != 0) {
9669 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
9670 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08009671 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009672 uri.append("package=").append(Uri.encode(mPackage)).append(';');
9673 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009674 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009675 uri.append("component=").append(Uri.encode(
9676 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009677 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009678 if (mSourceBounds != null) {
9679 uri.append("sourceBounds=")
9680 .append(Uri.encode(mSourceBounds.flattenToString()))
9681 .append(';');
9682 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009683 if (mExtras != null) {
9684 for (String key : mExtras.keySet()) {
9685 final Object value = mExtras.get(key);
9686 char entryType =
9687 value instanceof String ? 'S' :
9688 value instanceof Boolean ? 'B' :
9689 value instanceof Byte ? 'b' :
9690 value instanceof Character ? 'c' :
9691 value instanceof Double ? 'd' :
9692 value instanceof Float ? 'f' :
9693 value instanceof Integer ? 'i' :
9694 value instanceof Long ? 'l' :
9695 value instanceof Short ? 's' :
9696 '\0';
9697
9698 if (entryType != '\0') {
9699 uri.append(entryType);
9700 uri.append('.');
9701 uri.append(Uri.encode(key));
9702 uri.append('=');
9703 uri.append(Uri.encode(value.toString()));
9704 uri.append(';');
9705 }
9706 }
9707 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009708 }
The Android Open Source Project10592532009-03-18 17:39:46 -07009709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009710 public int describeContents() {
9711 return (mExtras != null) ? mExtras.describeContents() : 0;
9712 }
9713
9714 public void writeToParcel(Parcel out, int flags) {
9715 out.writeString(mAction);
9716 Uri.writeToParcel(out, mData);
9717 out.writeString(mType);
9718 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009719 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009720 ComponentName.writeToParcel(mComponent, out);
9721
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009722 if (mSourceBounds != null) {
9723 out.writeInt(1);
9724 mSourceBounds.writeToParcel(out, flags);
9725 } else {
9726 out.writeInt(0);
9727 }
9728
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009729 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009730 final int N = mCategories.size();
9731 out.writeInt(N);
9732 for (int i=0; i<N; i++) {
9733 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009734 }
9735 } else {
9736 out.writeInt(0);
9737 }
9738
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009739 if (mSelector != null) {
9740 out.writeInt(1);
9741 mSelector.writeToParcel(out, flags);
9742 } else {
9743 out.writeInt(0);
9744 }
9745
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009746 if (mClipData != null) {
9747 out.writeInt(1);
9748 mClipData.writeToParcel(out, flags);
9749 } else {
9750 out.writeInt(0);
9751 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009752 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009753 out.writeBundle(mExtras);
9754 }
9755
9756 public static final Parcelable.Creator<Intent> CREATOR
9757 = new Parcelable.Creator<Intent>() {
9758 public Intent createFromParcel(Parcel in) {
9759 return new Intent(in);
9760 }
9761 public Intent[] newArray(int size) {
9762 return new Intent[size];
9763 }
9764 };
9765
Dianne Hackborneb034652009-09-07 00:49:58 -07009766 /** @hide */
9767 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009768 readFromParcel(in);
9769 }
9770
9771 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009772 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009773 mData = Uri.CREATOR.createFromParcel(in);
9774 mType = in.readString();
9775 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009776 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009777 mComponent = ComponentName.readFromParcel(in);
9778
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009779 if (in.readInt() != 0) {
9780 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9781 }
9782
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009783 int N = in.readInt();
9784 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009785 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009786 int i;
9787 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009788 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009789 }
9790 } else {
9791 mCategories = null;
9792 }
9793
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009794 if (in.readInt() != 0) {
9795 mSelector = new Intent(in);
9796 }
9797
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009798 if (in.readInt() != 0) {
9799 mClipData = new ClipData(in);
9800 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009801 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009802 mExtras = in.readBundle();
9803 }
9804
9805 /**
9806 * Parses the "intent" element (and its children) from XML and instantiates
9807 * an Intent object. The given XML parser should be located at the tag
9808 * where parsing should start (often named "intent"), from which the
9809 * basic action, data, type, and package and class name will be
9810 * retrieved. The function will then parse in to any child elements,
9811 * looking for <category android:name="xxx"> tags to add categories and
9812 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9813 * to the intent.
9814 *
9815 * @param resources The Resources to use when inflating resources.
9816 * @param parser The XML parser pointing at an "intent" tag.
9817 * @param attrs The AttributeSet interface for retrieving extended
9818 * attribute data at the current <var>parser</var> location.
9819 * @return An Intent object matching the XML data.
9820 * @throws XmlPullParserException If there was an XML parsing error.
9821 * @throws IOException If there was an I/O error.
9822 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009823 public static @NonNull Intent parseIntent(@NonNull Resources resources,
9824 @NonNull XmlPullParser parser, AttributeSet attrs)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009825 throws XmlPullParserException, IOException {
9826 Intent intent = new Intent();
9827
9828 TypedArray sa = resources.obtainAttributes(attrs,
9829 com.android.internal.R.styleable.Intent);
9830
9831 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9832
9833 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9834 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9835 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9836
9837 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9838 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9839 if (packageName != null && className != null) {
9840 intent.setComponent(new ComponentName(packageName, className));
9841 }
9842
9843 sa.recycle();
9844
9845 int outerDepth = parser.getDepth();
9846 int type;
9847 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9848 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9849 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9850 continue;
9851 }
9852
9853 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009854 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009855 sa = resources.obtainAttributes(attrs,
9856 com.android.internal.R.styleable.IntentCategory);
9857 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9858 sa.recycle();
9859
9860 if (cat != null) {
9861 intent.addCategory(cat);
9862 }
9863 XmlUtils.skipCurrentTag(parser);
9864
Craig Mautner21d24a22014-04-23 11:45:37 -07009865 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009866 if (intent.mExtras == null) {
9867 intent.mExtras = new Bundle();
9868 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009869 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009870 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009871
9872 } else {
9873 XmlUtils.skipCurrentTag(parser);
9874 }
9875 }
9876
9877 return intent;
9878 }
Nick Pellyccae4122012-01-09 14:12:58 -08009879
Craig Mautner21d24a22014-04-23 11:45:37 -07009880 /** @hide */
9881 public void saveToXml(XmlSerializer out) throws IOException {
9882 if (mAction != null) {
9883 out.attribute(null, ATTR_ACTION, mAction);
9884 }
9885 if (mData != null) {
9886 out.attribute(null, ATTR_DATA, mData.toString());
9887 }
9888 if (mType != null) {
9889 out.attribute(null, ATTR_TYPE, mType);
9890 }
9891 if (mComponent != null) {
9892 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9893 }
9894 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9895
9896 if (mCategories != null) {
9897 out.startTag(null, TAG_CATEGORIES);
9898 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9899 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9900 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009901 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009902 }
9903 }
9904
9905 /** @hide */
9906 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9907 XmlPullParserException {
9908 Intent intent = new Intent();
9909 final int outerDepth = in.getDepth();
9910
9911 int attrCount = in.getAttributeCount();
9912 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9913 final String attrName = in.getAttributeName(attrNdx);
9914 final String attrValue = in.getAttributeValue(attrNdx);
9915 if (ATTR_ACTION.equals(attrName)) {
9916 intent.setAction(attrValue);
9917 } else if (ATTR_DATA.equals(attrName)) {
9918 intent.setData(Uri.parse(attrValue));
9919 } else if (ATTR_TYPE.equals(attrName)) {
9920 intent.setType(attrValue);
9921 } else if (ATTR_COMPONENT.equals(attrName)) {
9922 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9923 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009924 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009925 } else {
9926 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9927 }
9928 }
9929
9930 int event;
9931 String name;
9932 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9933 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9934 if (event == XmlPullParser.START_TAG) {
9935 name = in.getName();
9936 if (TAG_CATEGORIES.equals(name)) {
9937 attrCount = in.getAttributeCount();
9938 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9939 intent.addCategory(in.getAttributeValue(attrNdx));
9940 }
9941 } else {
9942 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9943 XmlUtils.skipCurrentTag(in);
9944 }
9945 }
9946 }
9947
9948 return intent;
9949 }
9950
Nick Pellyccae4122012-01-09 14:12:58 -08009951 /**
9952 * Normalize a MIME data type.
9953 *
9954 * <p>A normalized MIME type has white-space trimmed,
9955 * content-type parameters removed, and is lower-case.
9956 * This aligns the type with Android best practices for
9957 * intent filtering.
9958 *
9959 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9960 * "text/x-vCard" becomes "text/x-vcard".
9961 *
9962 * <p>All MIME types received from outside Android (such as user input,
9963 * or external sources like Bluetooth, NFC, or the Internet) should
9964 * be normalized before they are used to create an Intent.
9965 *
9966 * @param type MIME data type to normalize
9967 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009968 * @see #setType
9969 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009970 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06009971 public static @Nullable String normalizeMimeType(@Nullable String type) {
Nick Pellyccae4122012-01-09 14:12:58 -08009972 if (type == null) {
9973 return null;
9974 }
9975
Elliott Hughescb64d432013-08-02 10:00:44 -07009976 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009977
9978 final int semicolonIndex = type.indexOf(';');
9979 if (semicolonIndex != -1) {
9980 type = type.substring(0, semicolonIndex);
9981 }
9982 return type;
9983 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009984
9985 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009986 * Prepare this {@link Intent} to leave an app process.
9987 *
9988 * @hide
9989 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009990 public void prepareToLeaveProcess(Context context) {
9991 final boolean leavingPackage = (mComponent == null)
9992 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9993 prepareToLeaveProcess(leavingPackage);
9994 }
9995
9996 /**
9997 * Prepare this {@link Intent} to leave an app process.
9998 *
9999 * @hide
10000 */
10001 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010002 setAllowFds(false);
10003
10004 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010005 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010006 }
10007 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010008 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010009 }
10010
Jeff Sharkeyc6fe23d2017-02-24 09:39:58 -070010011 if (mExtras != null && !mExtras.isParcelled()) {
10012 final Object intent = mExtras.get(Intent.EXTRA_INTENT);
10013 if (intent instanceof Intent) {
10014 ((Intent) intent).prepareToLeaveProcess(leavingPackage);
10015 }
10016 }
10017
Jeff Sharkeya8b42782016-01-30 17:58:09 -070010018 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
10019 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -070010020 switch (mAction) {
10021 case ACTION_MEDIA_REMOVED:
10022 case ACTION_MEDIA_UNMOUNTED:
10023 case ACTION_MEDIA_CHECKING:
10024 case ACTION_MEDIA_NOFS:
10025 case ACTION_MEDIA_MOUNTED:
10026 case ACTION_MEDIA_SHARED:
10027 case ACTION_MEDIA_UNSHARED:
10028 case ACTION_MEDIA_BAD_REMOVAL:
10029 case ACTION_MEDIA_UNMOUNTABLE:
10030 case ACTION_MEDIA_EJECT:
10031 case ACTION_MEDIA_SCANNER_STARTED:
10032 case ACTION_MEDIA_SCANNER_FINISHED:
10033 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -070010034 case ACTION_PACKAGE_NEEDS_VERIFICATION:
10035 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -070010036 // Ignore legacy actions
10037 break;
10038 default:
10039 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010040 }
10041 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010042
10043 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
10044 && leavingPackage) {
10045 switch (mAction) {
10046 case ACTION_PROVIDER_CHANGED:
Makoto Onuki7d1911f2017-06-09 12:30:09 -070010047 case QuickContact.ACTION_QUICK_CONTACT:
Jeff Sharkeyfb833f32016-12-01 14:59:59 -070010048 // Ignore actions that don't need to grant
10049 break;
10050 default:
10051 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
10052 }
10053 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -070010054 }
10055
10056 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010057 * @hide
10058 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010059 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -070010060 // We just entered destination process, so we should be able to read all
10061 // parcelables inside.
10062 setDefusable(true);
10063
10064 if (mSelector != null) {
10065 mSelector.prepareToEnterProcess();
10066 }
10067 if (mClipData != null) {
10068 mClipData.prepareToEnterProcess();
10069 }
10070
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010071 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000010072 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
10073 fixUris(mContentUserHint);
10074 mContentUserHint = UserHandle.USER_CURRENT;
10075 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010076 }
10077 }
10078
Patrick Baumann577d4022018-01-31 16:55:10 +000010079 /** @hide */
10080 public boolean hasWebURI() {
10081 if (getData() == null) {
10082 return false;
10083 }
10084 final String scheme = getScheme();
10085 if (TextUtils.isEmpty(scheme)) {
10086 return false;
10087 }
10088 return scheme.equals(IntentFilter.SCHEME_HTTP) || scheme.equals(IntentFilter.SCHEME_HTTPS);
10089 }
10090
10091 /** @hide */
10092 public boolean isBrowsableWebIntent() {
10093 return ACTION_VIEW.equals(mAction)
10094 && hasCategory(CATEGORY_BROWSABLE)
10095 && hasWebURI();
10096 }
10097
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010098 /**
10099 * @hide
10100 */
10101 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010102 Uri data = getData();
10103 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010104 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010105 }
10106 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010107 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010108 }
10109 String action = getAction();
10110 if (ACTION_SEND.equals(action)) {
10111 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10112 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010113 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010114 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010115 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010116 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10117 if (streams != null) {
10118 ArrayList<Uri> newStreams = new ArrayList<Uri>();
10119 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010120 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010121 }
10122 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
10123 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010124 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10125 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10126 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10127 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10128 if (output != null) {
10129 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
10130 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010131 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010132 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +010010133
10134 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010135 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010136 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
10137 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010138 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010139 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010140 * @hide
10141 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010142 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010143 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010144 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010145
10146 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010147 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010148
10149 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010150 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010151 // Inspect contained intents to see if we need to migrate extras. We
10152 // don't promote ClipData to the parent, since ChooserActivity will
10153 // already start the picked item as the caller, and we can't combine
10154 // the flags in a safe way.
10155
10156 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -070010157 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010158 final Intent intent = getParcelableExtra(EXTRA_INTENT);
10159 if (intent != null) {
10160 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -070010161 }
10162 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010163 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -070010164 try {
10165 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
10166 if (intents != null) {
10167 for (int i = 0; i < intents.length; i++) {
10168 final Intent intent = (Intent) intents[i];
10169 if (intent != null) {
10170 migrated |= intent.migrateExtraStreamToClipData();
10171 }
10172 }
10173 }
10174 } catch (ClassCastException e) {
10175 }
10176 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010177
10178 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010179 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010180 final Uri stream = getParcelableExtra(EXTRA_STREAM);
10181 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
10182 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
10183 if (stream != null || text != null || htmlText != null) {
10184 final ClipData clipData = new ClipData(
10185 null, new String[] { getType() },
10186 new ClipData.Item(text, htmlText, null, stream));
10187 setClipData(clipData);
10188 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010189 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010190 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010191 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010192 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010193
10194 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010195 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010196 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
10197 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
10198 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
10199 int num = -1;
10200 if (streams != null) {
10201 num = streams.size();
10202 }
10203 if (texts != null) {
10204 if (num >= 0 && num != texts.size()) {
10205 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010206 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010207 }
10208 num = texts.size();
10209 }
10210 if (htmlTexts != null) {
10211 if (num >= 0 && num != htmlTexts.size()) {
10212 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010213 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010214 }
10215 num = htmlTexts.size();
10216 }
10217 if (num > 0) {
10218 final ClipData clipData = new ClipData(
10219 null, new String[] { getType() },
10220 makeClipItem(streams, texts, htmlTexts, 0));
10221
10222 for (int i = 1; i < num; i++) {
10223 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
10224 }
10225
10226 setClipData(clipData);
10227 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010228 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -070010229 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010230 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -070010231 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010010232 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
10233 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
10234 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
10235 final Uri output;
10236 try {
10237 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
10238 } catch (ClassCastException e) {
10239 return false;
10240 }
10241 if (output != null) {
10242 setClipData(ClipData.newRawUri("", output));
10243 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
10244 return true;
10245 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010246 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -070010247
10248 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -070010249 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010250
Michael Wright19859762017-09-18 20:57:58 +010010251 /**
10252 * Convert the dock state to a human readable format.
10253 * @hide
10254 */
10255 public static String dockStateToString(int dock) {
10256 switch (dock) {
10257 case EXTRA_DOCK_STATE_HE_DESK:
10258 return "EXTRA_DOCK_STATE_HE_DESK";
10259 case EXTRA_DOCK_STATE_LE_DESK:
10260 return "EXTRA_DOCK_STATE_LE_DESK";
10261 case EXTRA_DOCK_STATE_CAR:
10262 return "EXTRA_DOCK_STATE_CAR";
10263 case EXTRA_DOCK_STATE_DESK:
10264 return "EXTRA_DOCK_STATE_DESK";
10265 case EXTRA_DOCK_STATE_UNDOCKED:
10266 return "EXTRA_DOCK_STATE_UNDOCKED";
10267 default:
10268 return Integer.toString(dock);
10269 }
10270 }
10271
Dianne Hackbornac4243f2012-04-13 17:32:18 -070010272 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
10273 ArrayList<String> htmlTexts, int which) {
10274 Uri uri = streams != null ? streams.get(which) : null;
10275 CharSequence text = texts != null ? texts.get(which) : null;
10276 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
10277 return new ClipData.Item(text, htmlText, null, uri);
10278 }
Craig Mautnerd00f4742014-03-12 14:17:26 -070010279
10280 /** @hide */
10281 public boolean isDocument() {
10282 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
10283 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070010284}